@appwrite.io/console 18.3.0-rc.2 → 18.3.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 +2 -2
- package/dist/cjs/sdk.js +344 -3074
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +345 -3071
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +344 -3074
- package/package.json +1 -1
- package/types/enums/project-auth-method-id.d.ts +1 -2
- package/types/enums/project-key-scopes.d.ts +1 -5
- package/types/enums/project-policy-id.d.ts +1 -2
- package/types/enums/proxy-rule-deployment-resource-type.d.ts +1 -2
- package/types/enums/query-suggestion-resource.d.ts +0 -8
- package/types/enums/usage-event-metric.d.ts +0 -3
- package/types/enums/usage-gauge-metric.d.ts +0 -1
- package/types/index.d.ts +0 -11
- package/types/models.d.ts +67 -591
- package/types/service.d.ts +11 -0
- package/types/services/account.d.ts +0 -158
- package/types/services/functions.d.ts +12 -6
- package/types/services/project.d.ts +8 -30
- package/types/services/projects.d.ts +7 -4
- package/types/services/push.d.ts +2 -2
- package/types/services/users.d.ts +0 -69
- package/types/enums/analytics-dimension.d.ts +0 -24
- package/types/enums/analytics-interval.d.ts +0 -6
- package/types/enums/platform-resource-type.d.ts +0 -11
- package/types/enums/project-resource-type.d.ts +0 -13
- package/types/enums/video-output.d.ts +0 -5
- package/types/enums/video-rendition-status.d.ts +0 -9
- package/types/services/admin.d.ts +0 -80
- package/types/services/analytics-tracking.d.ts +0 -211
- package/types/services/analytics.d.ts +0 -254
- package/types/services/videos.d.ts +0 -860
package/types/models.d.ts
CHANGED
|
@@ -229,58 +229,6 @@ export declare namespace Models {
|
|
|
229
229
|
*/
|
|
230
230
|
tokens: ResourceToken[];
|
|
231
231
|
};
|
|
232
|
-
/**
|
|
233
|
-
* Videos List
|
|
234
|
-
*/
|
|
235
|
-
export type VideoList = {
|
|
236
|
-
/**
|
|
237
|
-
* Total number of videos that matched your query.
|
|
238
|
-
*/
|
|
239
|
-
total: number;
|
|
240
|
-
/**
|
|
241
|
-
* List of videos.
|
|
242
|
-
*/
|
|
243
|
-
videos: Video[];
|
|
244
|
-
};
|
|
245
|
-
/**
|
|
246
|
-
* Video Profiles List
|
|
247
|
-
*/
|
|
248
|
-
export type VideoProfileList = {
|
|
249
|
-
/**
|
|
250
|
-
* Total number of profiles that matched your query.
|
|
251
|
-
*/
|
|
252
|
-
total: number;
|
|
253
|
-
/**
|
|
254
|
-
* List of profiles.
|
|
255
|
-
*/
|
|
256
|
-
profiles: VideoProfile[];
|
|
257
|
-
};
|
|
258
|
-
/**
|
|
259
|
-
* Video Renditions List
|
|
260
|
-
*/
|
|
261
|
-
export type VideoRenditionList = {
|
|
262
|
-
/**
|
|
263
|
-
* Total number of renditions that matched your query.
|
|
264
|
-
*/
|
|
265
|
-
total: number;
|
|
266
|
-
/**
|
|
267
|
-
* List of renditions.
|
|
268
|
-
*/
|
|
269
|
-
renditions: VideoRendition[];
|
|
270
|
-
};
|
|
271
|
-
/**
|
|
272
|
-
* Video Subtitles List
|
|
273
|
-
*/
|
|
274
|
-
export type VideoSubtitleList = {
|
|
275
|
-
/**
|
|
276
|
-
* Total number of subtitles that matched your query.
|
|
277
|
-
*/
|
|
278
|
-
total: number;
|
|
279
|
-
/**
|
|
280
|
-
* List of subtitles.
|
|
281
|
-
*/
|
|
282
|
-
subtitles: VideoSubtitle[];
|
|
283
|
-
};
|
|
284
232
|
/**
|
|
285
233
|
* Teams List
|
|
286
234
|
*/
|
|
@@ -650,7 +598,7 @@ export declare namespace Models {
|
|
|
650
598
|
/**
|
|
651
599
|
* List of policies.
|
|
652
600
|
*/
|
|
653
|
-
policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicyPasswordPwned | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail
|
|
601
|
+
policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicyPasswordPwned | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail)[];
|
|
654
602
|
};
|
|
655
603
|
/**
|
|
656
604
|
* Email Templates List
|
|
@@ -4380,6 +4328,10 @@ export declare namespace Models {
|
|
|
4380
4328
|
* Function execution schedule in CRON format.
|
|
4381
4329
|
*/
|
|
4382
4330
|
schedule: string;
|
|
4331
|
+
/**
|
|
4332
|
+
* Minutes between scheduled executions. 0 when the function has no interval.
|
|
4333
|
+
*/
|
|
4334
|
+
interval?: number;
|
|
4383
4335
|
/**
|
|
4384
4336
|
* Function execution timeout in seconds.
|
|
4385
4337
|
*/
|
|
@@ -6834,27 +6786,6 @@ export declare namespace Models {
|
|
|
6834
6786
|
*/
|
|
6835
6787
|
custom: boolean;
|
|
6836
6788
|
};
|
|
6837
|
-
/**
|
|
6838
|
-
* Policy Passkey
|
|
6839
|
-
*/
|
|
6840
|
-
export type PolicyPasskey = {
|
|
6841
|
-
/**
|
|
6842
|
-
* Policy ID.
|
|
6843
|
-
*/
|
|
6844
|
-
$id: string;
|
|
6845
|
-
/**
|
|
6846
|
-
* Whether the passkey auth method is enabled. Toggle it with the update auth method endpoint.
|
|
6847
|
-
*/
|
|
6848
|
-
enabled: boolean;
|
|
6849
|
-
/**
|
|
6850
|
-
* Relying party ID passkeys are bound to. Empty until configured.
|
|
6851
|
-
*/
|
|
6852
|
-
rpId: string;
|
|
6853
|
-
/**
|
|
6854
|
-
* Web origins allowed to register and sign in with passkeys.
|
|
6855
|
-
*/
|
|
6856
|
-
origins: string[];
|
|
6857
|
-
};
|
|
6858
6789
|
/**
|
|
6859
6790
|
* Policy Deny Aliased Email
|
|
6860
6791
|
*/
|
|
@@ -7521,7 +7452,7 @@ export declare namespace Models {
|
|
|
7521
7452
|
*/
|
|
7522
7453
|
deploymentId: string;
|
|
7523
7454
|
/**
|
|
7524
|
-
* Type of deployment
|
|
7455
|
+
* Type of deployment. Possible values are "function", "site". Used if rule's type is "deployment".
|
|
7525
7456
|
*/
|
|
7526
7457
|
deploymentResourceType?: ProxyRuleDeploymentResourceType;
|
|
7527
7458
|
/**
|
|
@@ -7581,6 +7512,10 @@ export declare namespace Models {
|
|
|
7581
7512
|
* The CRON schedule expression.
|
|
7582
7513
|
*/
|
|
7583
7514
|
schedule: string;
|
|
7515
|
+
/**
|
|
7516
|
+
* Minutes between runs. 0 when the schedule has no interval.
|
|
7517
|
+
*/
|
|
7518
|
+
interval?: number;
|
|
7584
7519
|
/**
|
|
7585
7520
|
* Schedule data used to store resource-specific context needed for execution.
|
|
7586
7521
|
*/
|
|
@@ -7908,73 +7843,6 @@ export declare namespace Models {
|
|
|
7908
7843
|
*/
|
|
7909
7844
|
code: string;
|
|
7910
7845
|
};
|
|
7911
|
-
/**
|
|
7912
|
-
* Passkey
|
|
7913
|
-
*/
|
|
7914
|
-
export type Passkey = {
|
|
7915
|
-
/**
|
|
7916
|
-
* Passkey ID.
|
|
7917
|
-
*/
|
|
7918
|
-
$id: string;
|
|
7919
|
-
/**
|
|
7920
|
-
* Passkey creation date in ISO 8601 format.
|
|
7921
|
-
*/
|
|
7922
|
-
$createdAt: string;
|
|
7923
|
-
/**
|
|
7924
|
-
* Passkey update date in ISO 8601 format.
|
|
7925
|
-
*/
|
|
7926
|
-
$updatedAt: string;
|
|
7927
|
-
/**
|
|
7928
|
-
* Passkey name.
|
|
7929
|
-
*/
|
|
7930
|
-
name: string;
|
|
7931
|
-
/**
|
|
7932
|
-
* Most recent sign-in with this passkey in ISO 8601 format. Empty until the passkey is used to sign in.
|
|
7933
|
-
*/
|
|
7934
|
-
accessedAt: string;
|
|
7935
|
-
/**
|
|
7936
|
-
* Whether the passkey is synced to a cloud account, such as iCloud Keychain or Google Password Manager, rather than bound to one device.
|
|
7937
|
-
*/
|
|
7938
|
-
backedUp: boolean;
|
|
7939
|
-
};
|
|
7940
|
-
/**
|
|
7941
|
-
* Passkey Challenge
|
|
7942
|
-
*/
|
|
7943
|
-
export type PasskeyChallenge = {
|
|
7944
|
-
/**
|
|
7945
|
-
* Challenge ID. Pass it back with the credential to complete the ceremony.
|
|
7946
|
-
*/
|
|
7947
|
-
$id: string;
|
|
7948
|
-
/**
|
|
7949
|
-
* Challenge creation date in ISO 8601 format.
|
|
7950
|
-
*/
|
|
7951
|
-
$createdAt: string;
|
|
7952
|
-
/**
|
|
7953
|
-
* ID of the passkey being registered. Empty for sign-in challenges.
|
|
7954
|
-
*/
|
|
7955
|
-
passkeyId: string;
|
|
7956
|
-
/**
|
|
7957
|
-
* Challenge expiration date in ISO 8601 format.
|
|
7958
|
-
*/
|
|
7959
|
-
expire: string;
|
|
7960
|
-
/**
|
|
7961
|
-
* WebAuthn options in JSON form. Pass them to `PublicKeyCredential.parseCreationOptionsFromJSON()` when registering, or `PublicKeyCredential.parseRequestOptionsFromJSON()` when signing in.
|
|
7962
|
-
*/
|
|
7963
|
-
publicKey: object;
|
|
7964
|
-
};
|
|
7965
|
-
/**
|
|
7966
|
-
* Passkeys List
|
|
7967
|
-
*/
|
|
7968
|
-
export type PasskeyList = {
|
|
7969
|
-
/**
|
|
7970
|
-
* Total number of passkeys that matched your query.
|
|
7971
|
-
*/
|
|
7972
|
-
total: number;
|
|
7973
|
-
/**
|
|
7974
|
-
* List of passkeys.
|
|
7975
|
-
*/
|
|
7976
|
-
passkeys: Passkey[];
|
|
7977
|
-
};
|
|
7978
7846
|
/**
|
|
7979
7847
|
* MFA Recovery Codes
|
|
7980
7848
|
*/
|
|
@@ -8629,274 +8497,6 @@ export declare namespace Models {
|
|
|
8629
8497
|
*/
|
|
8630
8498
|
analyzedAt?: string;
|
|
8631
8499
|
};
|
|
8632
|
-
/**
|
|
8633
|
-
* Video
|
|
8634
|
-
*/
|
|
8635
|
-
export type Video = {
|
|
8636
|
-
/**
|
|
8637
|
-
* Video ID.
|
|
8638
|
-
*/
|
|
8639
|
-
$id: string;
|
|
8640
|
-
/**
|
|
8641
|
-
* Video creation time in ISO 8601 format.
|
|
8642
|
-
*/
|
|
8643
|
-
$createdAt: string;
|
|
8644
|
-
/**
|
|
8645
|
-
* Video update date in ISO 8601 format.
|
|
8646
|
-
*/
|
|
8647
|
-
$updatedAt: string;
|
|
8648
|
-
/**
|
|
8649
|
-
* Storage bucket ID holding the source file.
|
|
8650
|
-
*/
|
|
8651
|
-
bucketId: string;
|
|
8652
|
-
/**
|
|
8653
|
-
* Source file ID.
|
|
8654
|
-
*/
|
|
8655
|
-
fileId: string;
|
|
8656
|
-
/**
|
|
8657
|
-
* Video name.
|
|
8658
|
-
*/
|
|
8659
|
-
name: string;
|
|
8660
|
-
/**
|
|
8661
|
-
* Preview image ID, taken from the sprite timeline.
|
|
8662
|
-
*/
|
|
8663
|
-
previewId: string;
|
|
8664
|
-
/**
|
|
8665
|
-
* Source file size in bytes.
|
|
8666
|
-
*/
|
|
8667
|
-
size: number;
|
|
8668
|
-
/**
|
|
8669
|
-
* Source status: one of `pending`, `downloading`, `ready`, `removed`, `error` or `aborted`.
|
|
8670
|
-
*/
|
|
8671
|
-
status: string;
|
|
8672
|
-
/**
|
|
8673
|
-
* Total number of chunks in the source download.
|
|
8674
|
-
*/
|
|
8675
|
-
chunksTotal: number;
|
|
8676
|
-
/**
|
|
8677
|
-
* Number of source chunks downloaded so far.
|
|
8678
|
-
*/
|
|
8679
|
-
chunksUploaded: number;
|
|
8680
|
-
/**
|
|
8681
|
-
* Container format.
|
|
8682
|
-
*/
|
|
8683
|
-
format: string;
|
|
8684
|
-
/**
|
|
8685
|
-
* Video duration in milliseconds.
|
|
8686
|
-
*/
|
|
8687
|
-
duration: number;
|
|
8688
|
-
/**
|
|
8689
|
-
* Video width in pixels.
|
|
8690
|
-
*/
|
|
8691
|
-
width: number;
|
|
8692
|
-
/**
|
|
8693
|
-
* Video height in pixels.
|
|
8694
|
-
*/
|
|
8695
|
-
height: number;
|
|
8696
|
-
/**
|
|
8697
|
-
* Video aspect ratio.
|
|
8698
|
-
*/
|
|
8699
|
-
aspectRatio: string;
|
|
8700
|
-
/**
|
|
8701
|
-
* Video codec.
|
|
8702
|
-
*/
|
|
8703
|
-
videoCodec: string;
|
|
8704
|
-
/**
|
|
8705
|
-
* Video format.
|
|
8706
|
-
*/
|
|
8707
|
-
videoFormat: string;
|
|
8708
|
-
/**
|
|
8709
|
-
* Video format profile.
|
|
8710
|
-
*/
|
|
8711
|
-
videoFormatProfile: string;
|
|
8712
|
-
/**
|
|
8713
|
-
* Video bitrate in bits per second.
|
|
8714
|
-
*/
|
|
8715
|
-
videoBitRate: number;
|
|
8716
|
-
/**
|
|
8717
|
-
* Video frame rate.
|
|
8718
|
-
*/
|
|
8719
|
-
videoFrameRate: string;
|
|
8720
|
-
/**
|
|
8721
|
-
* Video frame rate mode.
|
|
8722
|
-
*/
|
|
8723
|
-
videoFrameRateMode: string;
|
|
8724
|
-
/**
|
|
8725
|
-
* Audio codec.
|
|
8726
|
-
*/
|
|
8727
|
-
audioCodec: string;
|
|
8728
|
-
/**
|
|
8729
|
-
* Audio format.
|
|
8730
|
-
*/
|
|
8731
|
-
audioFormat: string;
|
|
8732
|
-
/**
|
|
8733
|
-
* Audio bitrate in bits per second.
|
|
8734
|
-
*/
|
|
8735
|
-
audioBitRate: number;
|
|
8736
|
-
/**
|
|
8737
|
-
* Audio sample rate.
|
|
8738
|
-
*/
|
|
8739
|
-
audioSampleRate: string;
|
|
8740
|
-
};
|
|
8741
|
-
/**
|
|
8742
|
-
* Video profile
|
|
8743
|
-
*/
|
|
8744
|
-
export type VideoProfile = {
|
|
8745
|
-
/**
|
|
8746
|
-
* Video profile ID.
|
|
8747
|
-
*/
|
|
8748
|
-
$id: string;
|
|
8749
|
-
/**
|
|
8750
|
-
* Video profile creation time in ISO 8601 format.
|
|
8751
|
-
*/
|
|
8752
|
-
$createdAt: string;
|
|
8753
|
-
/**
|
|
8754
|
-
* Video profile update date in ISO 8601 format.
|
|
8755
|
-
*/
|
|
8756
|
-
$updatedAt: string;
|
|
8757
|
-
/**
|
|
8758
|
-
* Video profile name.
|
|
8759
|
-
*/
|
|
8760
|
-
name: string;
|
|
8761
|
-
/**
|
|
8762
|
-
* Target video bitrate in kilobits per second.
|
|
8763
|
-
*/
|
|
8764
|
-
videoBitRate: number;
|
|
8765
|
-
/**
|
|
8766
|
-
* Target audio bitrate in kilobits per second.
|
|
8767
|
-
*/
|
|
8768
|
-
audioBitRate: number;
|
|
8769
|
-
/**
|
|
8770
|
-
* Target video width in pixels.
|
|
8771
|
-
*/
|
|
8772
|
-
width: number;
|
|
8773
|
-
/**
|
|
8774
|
-
* Target video height in pixels.
|
|
8775
|
-
*/
|
|
8776
|
-
height: number;
|
|
8777
|
-
};
|
|
8778
|
-
/**
|
|
8779
|
-
* Video rendition
|
|
8780
|
-
*/
|
|
8781
|
-
export type VideoRendition = {
|
|
8782
|
-
/**
|
|
8783
|
-
* Rendition ID.
|
|
8784
|
-
*/
|
|
8785
|
-
$id: string;
|
|
8786
|
-
/**
|
|
8787
|
-
* Rendition creation time in ISO 8601 format.
|
|
8788
|
-
*/
|
|
8789
|
-
$createdAt: string;
|
|
8790
|
-
/**
|
|
8791
|
-
* Rendition update date in ISO 8601 format.
|
|
8792
|
-
*/
|
|
8793
|
-
$updatedAt: string;
|
|
8794
|
-
/**
|
|
8795
|
-
* Video ID.
|
|
8796
|
-
*/
|
|
8797
|
-
videoId: string;
|
|
8798
|
-
/**
|
|
8799
|
-
* Video profile ID this rendition was encoded against.
|
|
8800
|
-
*/
|
|
8801
|
-
profileId: string;
|
|
8802
|
-
/**
|
|
8803
|
-
* Rendition name, derived from its dimensions and bitrate.
|
|
8804
|
-
*/
|
|
8805
|
-
name: string;
|
|
8806
|
-
/**
|
|
8807
|
-
* Transcoding start time in ISO 8601 format.
|
|
8808
|
-
*/
|
|
8809
|
-
startedAt: string;
|
|
8810
|
-
/**
|
|
8811
|
-
* Transcoding end time in ISO 8601 format.
|
|
8812
|
-
*/
|
|
8813
|
-
endedAt: string;
|
|
8814
|
-
/**
|
|
8815
|
-
* Rendition width in pixels.
|
|
8816
|
-
*/
|
|
8817
|
-
width: number;
|
|
8818
|
-
/**
|
|
8819
|
-
* Rendition height in pixels.
|
|
8820
|
-
*/
|
|
8821
|
-
height: number;
|
|
8822
|
-
/**
|
|
8823
|
-
* Video bitrate in kilobits per second.
|
|
8824
|
-
*/
|
|
8825
|
-
videoBitRate: number;
|
|
8826
|
-
/**
|
|
8827
|
-
* Audio bitrate in kilobits per second.
|
|
8828
|
-
*/
|
|
8829
|
-
audioBitRate: number;
|
|
8830
|
-
/**
|
|
8831
|
-
* Longest segment duration in seconds.
|
|
8832
|
-
*/
|
|
8833
|
-
targetDuration: string;
|
|
8834
|
-
/**
|
|
8835
|
-
* Transcoding status: one of `pending`, `started`, `ended`, `uploading`, `ready`, `error` or `aborted`.
|
|
8836
|
-
*/
|
|
8837
|
-
status: string;
|
|
8838
|
-
/**
|
|
8839
|
-
* Transcoding progress as a percentage.
|
|
8840
|
-
*/
|
|
8841
|
-
progress: string;
|
|
8842
|
-
/**
|
|
8843
|
-
* Streaming output format: `hls`, `dash`, or `cmaf`.
|
|
8844
|
-
*/
|
|
8845
|
-
output: string;
|
|
8846
|
-
};
|
|
8847
|
-
/**
|
|
8848
|
-
* Video subtitle
|
|
8849
|
-
*/
|
|
8850
|
-
export type VideoSubtitle = {
|
|
8851
|
-
/**
|
|
8852
|
-
* Subtitle ID.
|
|
8853
|
-
*/
|
|
8854
|
-
$id: string;
|
|
8855
|
-
/**
|
|
8856
|
-
* Subtitle creation time in ISO 8601 format.
|
|
8857
|
-
*/
|
|
8858
|
-
$createdAt: string;
|
|
8859
|
-
/**
|
|
8860
|
-
* Subtitle update date in ISO 8601 format.
|
|
8861
|
-
*/
|
|
8862
|
-
$updatedAt: string;
|
|
8863
|
-
/**
|
|
8864
|
-
* Video ID.
|
|
8865
|
-
*/
|
|
8866
|
-
videoId: string;
|
|
8867
|
-
/**
|
|
8868
|
-
* Storage bucket ID holding the subtitle file.
|
|
8869
|
-
*/
|
|
8870
|
-
bucketId: string;
|
|
8871
|
-
/**
|
|
8872
|
-
* Subtitle file ID.
|
|
8873
|
-
*/
|
|
8874
|
-
fileId: string;
|
|
8875
|
-
/**
|
|
8876
|
-
* Subtitle display name.
|
|
8877
|
-
*/
|
|
8878
|
-
name: string;
|
|
8879
|
-
/**
|
|
8880
|
-
* Subtitle ISO 639-2 language code.
|
|
8881
|
-
*/
|
|
8882
|
-
code: string;
|
|
8883
|
-
/**
|
|
8884
|
-
* Is this the default subtitle track?
|
|
8885
|
-
*/
|
|
8886
|
-
default: boolean;
|
|
8887
|
-
/**
|
|
8888
|
-
* Was this track auto-extracted from the source container? Extracted tracks have no backing file; extraction runs once per video, so a deleted extracted track is not re-created.
|
|
8889
|
-
*/
|
|
8890
|
-
embedded: boolean;
|
|
8891
|
-
/**
|
|
8892
|
-
* Longest segment duration in seconds.
|
|
8893
|
-
*/
|
|
8894
|
-
targetDuration: string;
|
|
8895
|
-
/**
|
|
8896
|
-
* Packaging status: one of `pending`, `started`, `ready` or `error`.
|
|
8897
|
-
*/
|
|
8898
|
-
status: string;
|
|
8899
|
-
};
|
|
8900
8500
|
/**
|
|
8901
8501
|
* ActivityEvent
|
|
8902
8502
|
*/
|
|
@@ -9312,117 +8912,6 @@ export declare namespace Models {
|
|
|
9312
8912
|
*/
|
|
9313
8913
|
resources: UsageResources[];
|
|
9314
8914
|
};
|
|
9315
|
-
/**
|
|
9316
|
-
* AnalyticsMetric
|
|
9317
|
-
*/
|
|
9318
|
-
export type AnalyticsMetric = {
|
|
9319
|
-
/**
|
|
9320
|
-
* Dimension value this row covers. Null when no dimension was requested, empty when the dimension could not be derived for those events.
|
|
9321
|
-
*/
|
|
9322
|
-
value?: string;
|
|
9323
|
-
/**
|
|
9324
|
-
* Start of the time bucket this row covers, in ISO 8601. Null when no interval was requested.
|
|
9325
|
-
*/
|
|
9326
|
-
date?: string;
|
|
9327
|
-
/**
|
|
9328
|
-
* Unique visitors in the requested range.
|
|
9329
|
-
*/
|
|
9330
|
-
visitors: number;
|
|
9331
|
-
/**
|
|
9332
|
-
* Unique sessions in the requested range.
|
|
9333
|
-
*/
|
|
9334
|
-
sessions: number;
|
|
9335
|
-
/**
|
|
9336
|
-
* Total pageview events (events with name="pageview") in the requested range. Only the flat aggregate computes it; null on breakdown and time-series rows.
|
|
9337
|
-
*/
|
|
9338
|
-
pageviews?: number;
|
|
9339
|
-
/**
|
|
9340
|
-
* Total events in the requested range.
|
|
9341
|
-
*/
|
|
9342
|
-
events: number;
|
|
9343
|
-
/**
|
|
9344
|
-
* Total sessions with activity in the requested range. Only the flat aggregate computes it; null on breakdown and time-series rows.
|
|
9345
|
-
*/
|
|
9346
|
-
visits?: number;
|
|
9347
|
-
/**
|
|
9348
|
-
* Share of single-event sessions, as a percentage. Only the flat aggregate computes it; null on breakdown and time-series rows.
|
|
9349
|
-
*/
|
|
9350
|
-
bounceRate?: number;
|
|
9351
|
-
/**
|
|
9352
|
-
* Average session length in seconds, measured first event to last event. Single-event sessions count as 0. Only the flat aggregate computes it; null on breakdown and time-series rows.
|
|
9353
|
-
*/
|
|
9354
|
-
visitDuration?: number;
|
|
9355
|
-
/**
|
|
9356
|
-
* Average pageviews per session (pageviews divided by visits). Only the flat aggregate computes it; null on breakdown and time-series rows.
|
|
9357
|
-
*/
|
|
9358
|
-
viewsPerVisit?: number;
|
|
9359
|
-
/**
|
|
9360
|
-
* Average scroll depth across events, as a percentage. Only the flat aggregate computes it; null on breakdown and time-series rows.
|
|
9361
|
-
*/
|
|
9362
|
-
scrollDepth?: number;
|
|
9363
|
-
/**
|
|
9364
|
-
* Average engaged time per session in seconds, counting only foreground time. Sessions that reported no engagement are excluded. Only the flat aggregate computes it; null on breakdown and time-series rows.
|
|
9365
|
-
*/
|
|
9366
|
-
engagementTime?: number;
|
|
9367
|
-
};
|
|
9368
|
-
/**
|
|
9369
|
-
* AnalyticsMetricList
|
|
9370
|
-
*/
|
|
9371
|
-
export type AnalyticsMetricList = {
|
|
9372
|
-
/**
|
|
9373
|
-
* Total number of metric rows returned.
|
|
9374
|
-
*/
|
|
9375
|
-
total: number;
|
|
9376
|
-
/**
|
|
9377
|
-
* Metric rows: one per time bucket, one per dimension value, or a single row for the flat aggregate.
|
|
9378
|
-
*/
|
|
9379
|
-
metrics: AnalyticsMetric[];
|
|
9380
|
-
};
|
|
9381
|
-
/**
|
|
9382
|
-
* AnalyticsProperty
|
|
9383
|
-
*/
|
|
9384
|
-
export type AnalyticsProperty = {
|
|
9385
|
-
/**
|
|
9386
|
-
* Analytics property ID.
|
|
9387
|
-
*/
|
|
9388
|
-
$id: string;
|
|
9389
|
-
/**
|
|
9390
|
-
* Property creation date in ISO 8601 format.
|
|
9391
|
-
*/
|
|
9392
|
-
$createdAt: string;
|
|
9393
|
-
/**
|
|
9394
|
-
* Property update date in ISO 8601 format.
|
|
9395
|
-
*/
|
|
9396
|
-
$updatedAt: string;
|
|
9397
|
-
/**
|
|
9398
|
-
* Human-readable name of the tracked website or application.
|
|
9399
|
-
*/
|
|
9400
|
-
name: string;
|
|
9401
|
-
/**
|
|
9402
|
-
* Primary domain being tracked (e.g. example.com). May be empty for native apps.
|
|
9403
|
-
*/
|
|
9404
|
-
domain: string;
|
|
9405
|
-
/**
|
|
9406
|
-
* IANA timezone used to define the daily boundary for stats.
|
|
9407
|
-
*/
|
|
9408
|
-
timezone: string;
|
|
9409
|
-
/**
|
|
9410
|
-
* Whether tracking is currently active.
|
|
9411
|
-
*/
|
|
9412
|
-
enabled: boolean;
|
|
9413
|
-
/**
|
|
9414
|
-
* Whether stats for this property are publicly viewable.
|
|
9415
|
-
*/
|
|
9416
|
-
public: boolean;
|
|
9417
|
-
/**
|
|
9418
|
-
* List of origins allowed to send tracking events. Use ["*"] to allow all.
|
|
9419
|
-
*/
|
|
9420
|
-
allowedOrigins: string[];
|
|
9421
|
-
/**
|
|
9422
|
-
* Unique identifier for the tracking script snippet.
|
|
9423
|
-
*/
|
|
9424
|
-
snippetId: string;
|
|
9425
|
-
};
|
|
9426
8915
|
/**
|
|
9427
8916
|
* Team
|
|
9428
8917
|
*/
|
|
@@ -9573,17 +9062,17 @@ export declare namespace Models {
|
|
|
9573
9062
|
*/
|
|
9574
9063
|
policyId: string;
|
|
9575
9064
|
/**
|
|
9576
|
-
* Archive size in bytes.
|
|
9065
|
+
* Archive size in bytes.
|
|
9577
9066
|
*/
|
|
9578
|
-
size
|
|
9067
|
+
size: number;
|
|
9579
9068
|
/**
|
|
9580
9069
|
* The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.
|
|
9581
9070
|
*/
|
|
9582
9071
|
status: string;
|
|
9583
9072
|
/**
|
|
9584
|
-
* The backup start time.
|
|
9073
|
+
* The backup start time.
|
|
9585
9074
|
*/
|
|
9586
|
-
startedAt
|
|
9075
|
+
startedAt: string;
|
|
9587
9076
|
/**
|
|
9588
9077
|
* Migration ID.
|
|
9589
9078
|
*/
|
|
@@ -9735,7 +9224,7 @@ export declare namespace Models {
|
|
|
9735
9224
|
/**
|
|
9736
9225
|
* Address line 2
|
|
9737
9226
|
*/
|
|
9738
|
-
addressLine2
|
|
9227
|
+
addressLine2: string;
|
|
9739
9228
|
/**
|
|
9740
9229
|
* Address country
|
|
9741
9230
|
*/
|
|
@@ -9747,11 +9236,11 @@ export declare namespace Models {
|
|
|
9747
9236
|
/**
|
|
9748
9237
|
* state
|
|
9749
9238
|
*/
|
|
9750
|
-
state
|
|
9239
|
+
state: string;
|
|
9751
9240
|
/**
|
|
9752
9241
|
* postal code
|
|
9753
9242
|
*/
|
|
9754
|
-
postalCode
|
|
9243
|
+
postalCode: string;
|
|
9755
9244
|
};
|
|
9756
9245
|
/**
|
|
9757
9246
|
* Limits
|
|
@@ -9955,9 +9444,9 @@ export declare namespace Models {
|
|
|
9955
9444
|
*/
|
|
9956
9445
|
alertLimit: number;
|
|
9957
9446
|
/**
|
|
9958
|
-
* Additional resources
|
|
9447
|
+
* Additional resources
|
|
9959
9448
|
*/
|
|
9960
|
-
usage
|
|
9449
|
+
usage: UsageBillingPlan;
|
|
9961
9450
|
/**
|
|
9962
9451
|
* Addons
|
|
9963
9452
|
*/
|
|
@@ -10062,6 +9551,10 @@ export declare namespace Models {
|
|
|
10062
9551
|
* Maximum function and site deployment size in MB
|
|
10063
9552
|
*/
|
|
10064
9553
|
buildSize: number;
|
|
9554
|
+
/**
|
|
9555
|
+
* Shortest function schedule interval allowed, in minutes. 0 allows every interval.
|
|
9556
|
+
*/
|
|
9557
|
+
functionsIntervalMinimum: number;
|
|
10065
9558
|
/**
|
|
10066
9559
|
* Does the plan support encrypted string attributes or not.
|
|
10067
9560
|
*/
|
|
@@ -10300,7 +9793,7 @@ export declare namespace Models {
|
|
|
10300
9793
|
/**
|
|
10301
9794
|
* Branch port. Null until the backing reports one.
|
|
10302
9795
|
*/
|
|
10303
|
-
port
|
|
9796
|
+
port: number;
|
|
10304
9797
|
/**
|
|
10305
9798
|
* Advertised catalog the client connects to. MySQL/MariaDB use default; Postgres uses the routing label.
|
|
10306
9799
|
*/
|
|
@@ -10604,11 +10097,11 @@ export declare namespace Models {
|
|
|
10604
10097
|
/**
|
|
10605
10098
|
* Product API that owns this database: tablesdb, documentsdb, vectorsdb, mysql, postgresql, or mongodb.
|
|
10606
10099
|
*/
|
|
10607
|
-
api
|
|
10100
|
+
api: string;
|
|
10608
10101
|
/**
|
|
10609
10102
|
* Database engine: postgresql, mysql, or mongodb. Null until the backing reports one.
|
|
10610
10103
|
*/
|
|
10611
|
-
engine
|
|
10104
|
+
engine: string;
|
|
10612
10105
|
/**
|
|
10613
10106
|
* Database engine version.
|
|
10614
10107
|
*/
|
|
@@ -10628,7 +10121,7 @@ export declare namespace Models {
|
|
|
10628
10121
|
/**
|
|
10629
10122
|
* Database port for connections. Derived from the engine when the backing has not reported one yet.
|
|
10630
10123
|
*/
|
|
10631
|
-
connectionPort
|
|
10124
|
+
connectionPort: number;
|
|
10632
10125
|
/**
|
|
10633
10126
|
* Database username for connections.
|
|
10634
10127
|
*/
|
|
@@ -10640,7 +10133,7 @@ export declare namespace Models {
|
|
|
10640
10133
|
/**
|
|
10641
10134
|
* Committed generation of the primary connection credentials. Null until the rotation contract has been initialized.
|
|
10642
10135
|
*/
|
|
10643
|
-
credentialGeneration
|
|
10136
|
+
credentialGeneration: number;
|
|
10644
10137
|
/**
|
|
10645
10138
|
* Full database connection string (URI format).
|
|
10646
10139
|
*/
|
|
@@ -10851,7 +10344,7 @@ export declare namespace Models {
|
|
|
10851
10344
|
/**
|
|
10852
10345
|
* Source database ID when restoring a backup into another database.
|
|
10853
10346
|
*/
|
|
10854
|
-
sourceDatabaseId
|
|
10347
|
+
sourceDatabaseId: string;
|
|
10855
10348
|
/**
|
|
10856
10349
|
* Project ID.
|
|
10857
10350
|
*/
|
|
@@ -10859,7 +10352,7 @@ export declare namespace Models {
|
|
|
10859
10352
|
/**
|
|
10860
10353
|
* Backup ID used for restoration (null for PITR).
|
|
10861
10354
|
*/
|
|
10862
|
-
backupId
|
|
10355
|
+
backupId: string;
|
|
10863
10356
|
/**
|
|
10864
10357
|
* Restoration type. Possible values: backup (restore from a specific backup snapshot), pitr (point-in-time recovery to a specific timestamp).
|
|
10865
10358
|
*/
|
|
@@ -10871,15 +10364,15 @@ export declare namespace Models {
|
|
|
10871
10364
|
/**
|
|
10872
10365
|
* Target time for PITR restoration in ISO 8601 format.
|
|
10873
10366
|
*/
|
|
10874
|
-
targetTime
|
|
10367
|
+
targetTime: string;
|
|
10875
10368
|
/**
|
|
10876
10369
|
* Restoration start time in ISO 8601 format.
|
|
10877
10370
|
*/
|
|
10878
|
-
startedAt
|
|
10371
|
+
startedAt: string;
|
|
10879
10372
|
/**
|
|
10880
10373
|
* Restoration completion time in ISO 8601 format.
|
|
10881
10374
|
*/
|
|
10882
|
-
completedAt
|
|
10375
|
+
completedAt: string;
|
|
10883
10376
|
/**
|
|
10884
10377
|
* Error message if restoration failed.
|
|
10885
10378
|
*/
|
|
@@ -10910,9 +10403,9 @@ export declare namespace Models {
|
|
|
10910
10403
|
*/
|
|
10911
10404
|
uptime: number;
|
|
10912
10405
|
/**
|
|
10913
|
-
* Connection statistics.
|
|
10406
|
+
* Connection statistics.
|
|
10914
10407
|
*/
|
|
10915
|
-
connections
|
|
10408
|
+
connections: DatabaseStatusConnections;
|
|
10916
10409
|
/**
|
|
10917
10410
|
* Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.
|
|
10918
10411
|
*/
|
|
@@ -11245,7 +10738,7 @@ export declare namespace Models {
|
|
|
11245
10738
|
/**
|
|
11246
10739
|
* Discount amount
|
|
11247
10740
|
*/
|
|
11248
|
-
discount
|
|
10741
|
+
discount: number;
|
|
11249
10742
|
/**
|
|
11250
10743
|
* Credits amount
|
|
11251
10744
|
*/
|
|
@@ -11329,7 +10822,7 @@ export declare namespace Models {
|
|
|
11329
10822
|
/**
|
|
11330
10823
|
* Discount amount
|
|
11331
10824
|
*/
|
|
11332
|
-
discount
|
|
10825
|
+
discount: number;
|
|
11333
10826
|
/**
|
|
11334
10827
|
* Credits amount
|
|
11335
10828
|
*/
|
|
@@ -11605,7 +11098,7 @@ export declare namespace Models {
|
|
|
11605
11098
|
/**
|
|
11606
11099
|
* Client secret for processing failed payments in front-end
|
|
11607
11100
|
*/
|
|
11608
|
-
clientSecret
|
|
11101
|
+
clientSecret: string;
|
|
11609
11102
|
/**
|
|
11610
11103
|
* Invoice status
|
|
11611
11104
|
*/
|
|
@@ -11617,7 +11110,7 @@ export declare namespace Models {
|
|
|
11617
11110
|
/**
|
|
11618
11111
|
* Last payment error associated with the invoice
|
|
11619
11112
|
*/
|
|
11620
|
-
lastError
|
|
11113
|
+
lastError: string;
|
|
11621
11114
|
/**
|
|
11622
11115
|
* Invoice due date.
|
|
11623
11116
|
*/
|
|
@@ -11748,15 +11241,15 @@ export declare namespace Models {
|
|
|
11748
11241
|
/**
|
|
11749
11242
|
* Billing cycle start date.
|
|
11750
11243
|
*/
|
|
11751
|
-
billingStartDate
|
|
11244
|
+
billingStartDate: string;
|
|
11752
11245
|
/**
|
|
11753
11246
|
* Current invoice cycle start date.
|
|
11754
11247
|
*/
|
|
11755
|
-
billingCurrentInvoiceDate
|
|
11248
|
+
billingCurrentInvoiceDate: string;
|
|
11756
11249
|
/**
|
|
11757
11250
|
* Next invoice cycle start date.
|
|
11758
11251
|
*/
|
|
11759
|
-
billingNextInvoiceDate
|
|
11252
|
+
billingNextInvoiceDate: string;
|
|
11760
11253
|
/**
|
|
11761
11254
|
* Start date of trial.
|
|
11762
11255
|
*/
|
|
@@ -11764,19 +11257,19 @@ export declare namespace Models {
|
|
|
11764
11257
|
/**
|
|
11765
11258
|
* Number of trial days.
|
|
11766
11259
|
*/
|
|
11767
|
-
billingTrialDays
|
|
11260
|
+
billingTrialDays: number;
|
|
11768
11261
|
/**
|
|
11769
11262
|
* Current active aggregation id.
|
|
11770
11263
|
*/
|
|
11771
|
-
billingAggregationId
|
|
11264
|
+
billingAggregationId: string;
|
|
11772
11265
|
/**
|
|
11773
11266
|
* Current active aggregation id.
|
|
11774
11267
|
*/
|
|
11775
|
-
billingInvoiceId
|
|
11268
|
+
billingInvoiceId: string;
|
|
11776
11269
|
/**
|
|
11777
11270
|
* Default payment method.
|
|
11778
11271
|
*/
|
|
11779
|
-
paymentMethodId
|
|
11272
|
+
paymentMethodId: string;
|
|
11780
11273
|
/**
|
|
11781
11274
|
* Default payment method.
|
|
11782
11275
|
*/
|
|
@@ -11906,39 +11399,39 @@ export declare namespace Models {
|
|
|
11906
11399
|
/**
|
|
11907
11400
|
* Expiry month of the payment method.
|
|
11908
11401
|
*/
|
|
11909
|
-
expiryMonth
|
|
11402
|
+
expiryMonth: number;
|
|
11910
11403
|
/**
|
|
11911
11404
|
* Expiry year of the payment method.
|
|
11912
11405
|
*/
|
|
11913
|
-
expiryYear
|
|
11406
|
+
expiryYear: number;
|
|
11914
11407
|
/**
|
|
11915
11408
|
* Last 4 digit of the payment method
|
|
11916
11409
|
*/
|
|
11917
|
-
last4
|
|
11410
|
+
last4: string;
|
|
11918
11411
|
/**
|
|
11919
11412
|
* Payment method brand
|
|
11920
11413
|
*/
|
|
11921
|
-
brand
|
|
11414
|
+
brand: string;
|
|
11922
11415
|
/**
|
|
11923
11416
|
* Name of the owner
|
|
11924
11417
|
*/
|
|
11925
|
-
name
|
|
11418
|
+
name: string;
|
|
11926
11419
|
/**
|
|
11927
11420
|
* Mandate ID of the payment method
|
|
11928
11421
|
*/
|
|
11929
|
-
mandateId
|
|
11422
|
+
mandateId: string;
|
|
11930
11423
|
/**
|
|
11931
11424
|
* Country of the payment method
|
|
11932
11425
|
*/
|
|
11933
|
-
country
|
|
11426
|
+
country: string;
|
|
11934
11427
|
/**
|
|
11935
11428
|
* State of the payment method
|
|
11936
11429
|
*/
|
|
11937
|
-
state
|
|
11430
|
+
state: string;
|
|
11938
11431
|
/**
|
|
11939
11432
|
* Last payment error associated with the payment method.
|
|
11940
11433
|
*/
|
|
11941
|
-
lastError
|
|
11434
|
+
lastError: string;
|
|
11942
11435
|
/**
|
|
11943
11436
|
* True when it's the default payment method.
|
|
11944
11437
|
*/
|
|
@@ -12311,9 +11804,9 @@ export declare namespace Models {
|
|
|
12311
11804
|
*/
|
|
12312
11805
|
status: string;
|
|
12313
11806
|
/**
|
|
12314
|
-
* The
|
|
11807
|
+
* The backup start time.
|
|
12315
11808
|
*/
|
|
12316
|
-
startedAt
|
|
11809
|
+
startedAt: string;
|
|
12317
11810
|
/**
|
|
12318
11811
|
* Migration ID.
|
|
12319
11812
|
*/
|
|
@@ -12327,9 +11820,9 @@ export declare namespace Models {
|
|
|
12327
11820
|
*/
|
|
12328
11821
|
resources: string[];
|
|
12329
11822
|
/**
|
|
12330
|
-
*
|
|
11823
|
+
* Optional data in key-value object.
|
|
12331
11824
|
*/
|
|
12332
|
-
options:
|
|
11825
|
+
options: string;
|
|
12333
11826
|
};
|
|
12334
11827
|
/**
|
|
12335
11828
|
* Dedicated database restorations list
|
|
@@ -12514,11 +12007,11 @@ export declare namespace Models {
|
|
|
12514
12007
|
/**
|
|
12515
12008
|
* Bandwidth additional resources
|
|
12516
12009
|
*/
|
|
12517
|
-
bandwidth
|
|
12010
|
+
bandwidth: AdditionalResource;
|
|
12518
12011
|
/**
|
|
12519
12012
|
* Executions additional resources
|
|
12520
12013
|
*/
|
|
12521
|
-
executions
|
|
12014
|
+
executions: AdditionalResource;
|
|
12522
12015
|
/**
|
|
12523
12016
|
* Member additional resources
|
|
12524
12017
|
*/
|
|
@@ -12526,11 +12019,11 @@ export declare namespace Models {
|
|
|
12526
12019
|
/**
|
|
12527
12020
|
* Realtime additional resources
|
|
12528
12021
|
*/
|
|
12529
|
-
realtime
|
|
12022
|
+
realtime: AdditionalResource;
|
|
12530
12023
|
/**
|
|
12531
12024
|
* Realtime messages additional resources
|
|
12532
12025
|
*/
|
|
12533
|
-
realtimeMessages
|
|
12026
|
+
realtimeMessages: AdditionalResource;
|
|
12534
12027
|
/**
|
|
12535
12028
|
* Realtime bandwidth additional resources
|
|
12536
12029
|
*/
|
|
@@ -12538,19 +12031,19 @@ export declare namespace Models {
|
|
|
12538
12031
|
/**
|
|
12539
12032
|
* Storage additional resources
|
|
12540
12033
|
*/
|
|
12541
|
-
storage
|
|
12034
|
+
storage: AdditionalResource;
|
|
12542
12035
|
/**
|
|
12543
12036
|
* User additional resources
|
|
12544
12037
|
*/
|
|
12545
|
-
users
|
|
12038
|
+
users: AdditionalResource;
|
|
12546
12039
|
/**
|
|
12547
12040
|
* GBHour additional resources
|
|
12548
12041
|
*/
|
|
12549
|
-
GBHours
|
|
12042
|
+
GBHours: AdditionalResource;
|
|
12550
12043
|
/**
|
|
12551
12044
|
* Image transformation additional resources
|
|
12552
12045
|
*/
|
|
12553
|
-
imageTransformations
|
|
12046
|
+
imageTransformations: AdditionalResource;
|
|
12554
12047
|
/**
|
|
12555
12048
|
* Credits additional resources
|
|
12556
12049
|
*/
|
|
@@ -12640,10 +12133,6 @@ export declare namespace Models {
|
|
|
12640
12133
|
* Aggregated stats for total backups storage.
|
|
12641
12134
|
*/
|
|
12642
12135
|
backupsStorageTotal: number;
|
|
12643
|
-
/**
|
|
12644
|
-
* Aggregated stats for total custom user photos storage.
|
|
12645
|
-
*/
|
|
12646
|
-
avatarsStorageTotal: number;
|
|
12647
12136
|
/**
|
|
12648
12137
|
* Aggregated stats for total storage.
|
|
12649
12138
|
*/
|
|
@@ -13885,19 +13374,6 @@ export declare namespace Models {
|
|
|
13885
13374
|
*/
|
|
13886
13375
|
addons: Addon[];
|
|
13887
13376
|
};
|
|
13888
|
-
/**
|
|
13889
|
-
* Analytics properties list
|
|
13890
|
-
*/
|
|
13891
|
-
export type AnalyticsPropertyList = {
|
|
13892
|
-
/**
|
|
13893
|
-
* Total number of properties that matched your query.
|
|
13894
|
-
*/
|
|
13895
|
-
total: number;
|
|
13896
|
-
/**
|
|
13897
|
-
* List of properties.
|
|
13898
|
-
*/
|
|
13899
|
-
properties: AnalyticsProperty[];
|
|
13900
|
-
};
|
|
13901
13377
|
/**
|
|
13902
13378
|
* Aggregation team list
|
|
13903
13379
|
*/
|