@appwrite.io/console 10.0.0 → 12.0.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/types/models.d.ts CHANGED
@@ -2,6 +2,8 @@ import { DatabaseType } from "./enums/database-type";
2
2
  import { AttributeStatus } from "./enums/attribute-status";
3
3
  import { ColumnStatus } from "./enums/column-status";
4
4
  import { IndexStatus } from "./enums/index-status";
5
+ import { DetectionFrameworkType } from "./enums/detection-framework-type";
6
+ import { DetectionRuntimeType } from "./enums/detection-runtime-type";
5
7
  import { DeploymentStatus } from "./enums/deployment-status";
6
8
  import { ExecutionTrigger } from "./enums/execution-trigger";
7
9
  import { ExecutionStatus } from "./enums/execution-status";
@@ -304,6 +306,10 @@ export declare namespace Models {
304
306
  * List of frameworkProviderRepositories.
305
307
  */
306
308
  frameworkProviderRepositories: ProviderRepositoryFramework[];
309
+ /**
310
+ * Provider repository list type.
311
+ */
312
+ type: string;
307
313
  };
308
314
  /**
309
315
  * Runtime Provider Repositories List
@@ -317,6 +323,10 @@ export declare namespace Models {
317
323
  * List of runtimeProviderRepositories.
318
324
  */
319
325
  runtimeProviderRepositories: ProviderRepositoryRuntime[];
326
+ /**
327
+ * Provider repository list type.
328
+ */
329
+ type: string;
320
330
  };
321
331
  /**
322
332
  * Branches List
@@ -513,6 +523,45 @@ export declare namespace Models {
513
523
  */
514
524
  variables: Variable[];
515
525
  };
526
+ /**
527
+ * Mock Numbers List
528
+ */
529
+ export type MockNumberList = {
530
+ /**
531
+ * Total number of mockNumbers that matched your query.
532
+ */
533
+ total: number;
534
+ /**
535
+ * List of mockNumbers.
536
+ */
537
+ mockNumbers: MockNumber[];
538
+ };
539
+ /**
540
+ * Policies List
541
+ */
542
+ export type PolicyList = {
543
+ /**
544
+ * Total number of policies in the given project.
545
+ */
546
+ total: number;
547
+ /**
548
+ * List of policies.
549
+ */
550
+ policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy)[];
551
+ };
552
+ /**
553
+ * Email Templates List
554
+ */
555
+ export type EmailTemplateList = {
556
+ /**
557
+ * Total number of templates that matched your query.
558
+ */
559
+ total: number;
560
+ /**
561
+ * List of templates.
562
+ */
563
+ templates: EmailTemplate[];
564
+ };
516
565
  /**
517
566
  * Status List
518
567
  */
@@ -3673,6 +3722,10 @@ export declare namespace Models {
3673
3722
  * User email address. Hide this attribute by toggling membership privacy in the Console.
3674
3723
  */
3675
3724
  userEmail: string;
3725
+ /**
3726
+ * User phone number. Hide this attribute by toggling membership privacy in the Console.
3727
+ */
3728
+ userPhone: string;
3676
3729
  /**
3677
3730
  * Team ID.
3678
3731
  */
@@ -4361,6 +4414,10 @@ export declare namespace Models {
4361
4414
  * DetectionFramework
4362
4415
  */
4363
4416
  export type DetectionFramework = {
4417
+ /**
4418
+ * Repository detection type.
4419
+ */
4420
+ type: DetectionFrameworkType;
4364
4421
  /**
4365
4422
  * Environment variables found in .env files
4366
4423
  */
@@ -4386,6 +4443,10 @@ export declare namespace Models {
4386
4443
  * DetectionRuntime
4387
4444
  */
4388
4445
  export type DetectionRuntime = {
4446
+ /**
4447
+ * Repository detection type.
4448
+ */
4449
+ type: DetectionRuntimeType;
4389
4450
  /**
4390
4451
  * Environment variables found in .env files
4391
4452
  */
@@ -4835,6 +4896,14 @@ export declare namespace Models {
4835
4896
  * Whether or not to show user MFA status in the teams membership response.
4836
4897
  */
4837
4898
  authMembershipsMfa: boolean;
4899
+ /**
4900
+ * Whether or not to show user IDs in the teams membership response.
4901
+ */
4902
+ authMembershipsUserId: boolean;
4903
+ /**
4904
+ * Whether or not to show user phone numbers in the teams membership response.
4905
+ */
4906
+ authMembershipsUserPhone: boolean;
4838
4907
  /**
4839
4908
  * Whether or not all existing sessions should be invalidated on password change
4840
4909
  */
@@ -4871,10 +4940,14 @@ export declare namespace Models {
4871
4940
  * SMTP sender email
4872
4941
  */
4873
4942
  smtpSenderEmail: string;
4943
+ /**
4944
+ * SMTP reply to name
4945
+ */
4946
+ smtpReplyToName: string;
4874
4947
  /**
4875
4948
  * SMTP reply to email
4876
4949
  */
4877
- smtpReplyTo: string;
4950
+ smtpReplyToEmail: string;
4878
4951
  /**
4879
4952
  * SMTP server host name
4880
4953
  */
@@ -4888,7 +4961,7 @@ export declare namespace Models {
4888
4961
  */
4889
4962
  smtpUsername: string;
4890
4963
  /**
4891
- * SMTP server password
4964
+ * SMTP server password. This property is write-only and always returned empty.
4892
4965
  */
4893
4966
  smtpPassword: string;
4894
4967
  /**
@@ -5135,9 +5208,9 @@ export declare namespace Models {
5135
5208
  sdks: string[];
5136
5209
  };
5137
5210
  /**
5138
- * DevKey
5211
+ * Ephemeral Key
5139
5212
  */
5140
- export type DevKey = {
5213
+ export type EphemeralKey = {
5141
5214
  /**
5142
5215
  * Key ID.
5143
5216
  */
@@ -5158,6 +5231,10 @@ export declare namespace Models {
5158
5231
  * Key expiration date in ISO 8601 format.
5159
5232
  */
5160
5233
  expire: string;
5234
+ /**
5235
+ * Allowed permission scopes.
5236
+ */
5237
+ scopes: string[];
5161
5238
  /**
5162
5239
  * Secret key.
5163
5240
  */
@@ -5172,272 +5249,1363 @@ export declare namespace Models {
5172
5249
  sdks: string[];
5173
5250
  };
5174
5251
  /**
5175
- * Mock Number
5252
+ * DevKey
5176
5253
  */
5177
- export type MockNumber = {
5254
+ export type DevKey = {
5178
5255
  /**
5179
- * Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.
5256
+ * Key ID.
5180
5257
  */
5181
- phone: string;
5258
+ $id: string;
5182
5259
  /**
5183
- * Mock OTP for the number.
5260
+ * Key creation date in ISO 8601 format.
5184
5261
  */
5185
- otp: string;
5186
- };
5187
- /**
5188
- * AuthProvider
5189
- */
5190
- export type AuthProvider = {
5262
+ $createdAt: string;
5191
5263
  /**
5192
- * Auth Provider.
5264
+ * Key update date in ISO 8601 format.
5193
5265
  */
5194
- key: string;
5266
+ $updatedAt: string;
5195
5267
  /**
5196
- * Auth Provider name.
5268
+ * Key name.
5197
5269
  */
5198
5270
  name: string;
5199
5271
  /**
5200
- * OAuth 2.0 application ID.
5272
+ * Key expiration date in ISO 8601 format.
5201
5273
  */
5202
- appId: string;
5274
+ expire: string;
5203
5275
  /**
5204
- * OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.
5276
+ * Secret key.
5205
5277
  */
5206
5278
  secret: string;
5207
5279
  /**
5208
- * Auth Provider is active and can be used to create session.
5280
+ * Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
5209
5281
  */
5210
- enabled: boolean;
5282
+ accessedAt: string;
5283
+ /**
5284
+ * List of SDK user agents that used this key.
5285
+ */
5286
+ sdks: string[];
5211
5287
  };
5212
5288
  /**
5213
- * Platform Web
5289
+ * Mock Number
5214
5290
  */
5215
- export type PlatformWeb = {
5291
+ export type MockNumber = {
5216
5292
  /**
5217
- * Platform ID.
5293
+ * Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.
5218
5294
  */
5219
- $id: string;
5295
+ number: string;
5220
5296
  /**
5221
- * Platform creation date in ISO 8601 format.
5297
+ * Mock OTP for the number.
5298
+ */
5299
+ otp: string;
5300
+ /**
5301
+ * Attribute creation date in ISO 8601 format.
5222
5302
  */
5223
5303
  $createdAt: string;
5224
5304
  /**
5225
- * Platform update date in ISO 8601 format.
5305
+ * Attribute update date in ISO 8601 format.
5226
5306
  */
5227
5307
  $updatedAt: string;
5308
+ };
5309
+ /**
5310
+ * OAuth2GitHub
5311
+ */
5312
+ export type OAuth2Github = {
5228
5313
  /**
5229
- * Platform name.
5314
+ * OAuth2 provider ID.
5230
5315
  */
5231
- name: string;
5316
+ $id: string;
5232
5317
  /**
5233
- * Platform type. Possible values are: windows, apple, android, linux, web.
5318
+ * OAuth2 provider is active and can be used to create sessions.
5234
5319
  */
5235
- type: PlatformType;
5320
+ enabled: boolean;
5236
5321
  /**
5237
- * Web app hostname. Empty string for other platforms.
5322
+ * GitHub OAuth2 client ID. For GitHub Apps, use the "App ID" when both an App ID and client ID are available.
5238
5323
  */
5239
- hostname: string;
5324
+ clientId: string;
5325
+ /**
5326
+ * GitHub OAuth2 client secret.
5327
+ */
5328
+ clientSecret: string;
5240
5329
  };
5241
5330
  /**
5242
- * Platform Apple
5331
+ * OAuth2Discord
5243
5332
  */
5244
- export type PlatformApple = {
5333
+ export type OAuth2Discord = {
5245
5334
  /**
5246
- * Platform ID.
5335
+ * OAuth2 provider ID.
5247
5336
  */
5248
5337
  $id: string;
5249
5338
  /**
5250
- * Platform creation date in ISO 8601 format.
5251
- */
5252
- $createdAt: string;
5253
- /**
5254
- * Platform update date in ISO 8601 format.
5255
- */
5256
- $updatedAt: string;
5257
- /**
5258
- * Platform name.
5339
+ * OAuth2 provider is active and can be used to create sessions.
5259
5340
  */
5260
- name: string;
5341
+ enabled: boolean;
5261
5342
  /**
5262
- * Platform type. Possible values are: windows, apple, android, linux, web.
5343
+ * Discord OAuth2 client ID.
5263
5344
  */
5264
- type: PlatformType;
5345
+ clientId: string;
5265
5346
  /**
5266
- * Apple bundle identifier.
5347
+ * Discord OAuth2 client secret.
5267
5348
  */
5268
- bundleIdentifier: string;
5349
+ clientSecret: string;
5269
5350
  };
5270
5351
  /**
5271
- * Platform Android
5352
+ * OAuth2Figma
5272
5353
  */
5273
- export type PlatformAndroid = {
5354
+ export type OAuth2Figma = {
5274
5355
  /**
5275
- * Platform ID.
5356
+ * OAuth2 provider ID.
5276
5357
  */
5277
5358
  $id: string;
5278
5359
  /**
5279
- * Platform creation date in ISO 8601 format.
5280
- */
5281
- $createdAt: string;
5282
- /**
5283
- * Platform update date in ISO 8601 format.
5284
- */
5285
- $updatedAt: string;
5286
- /**
5287
- * Platform name.
5360
+ * OAuth2 provider is active and can be used to create sessions.
5288
5361
  */
5289
- name: string;
5362
+ enabled: boolean;
5290
5363
  /**
5291
- * Platform type. Possible values are: windows, apple, android, linux, web.
5364
+ * Figma OAuth2 client ID.
5292
5365
  */
5293
- type: PlatformType;
5366
+ clientId: string;
5294
5367
  /**
5295
- * Android application ID.
5368
+ * Figma OAuth2 client secret.
5296
5369
  */
5297
- applicationId: string;
5370
+ clientSecret: string;
5298
5371
  };
5299
5372
  /**
5300
- * Platform Windows
5373
+ * OAuth2Dropbox
5301
5374
  */
5302
- export type PlatformWindows = {
5375
+ export type OAuth2Dropbox = {
5303
5376
  /**
5304
- * Platform ID.
5377
+ * OAuth2 provider ID.
5305
5378
  */
5306
5379
  $id: string;
5307
5380
  /**
5308
- * Platform creation date in ISO 8601 format.
5381
+ * OAuth2 provider is active and can be used to create sessions.
5309
5382
  */
5310
- $createdAt: string;
5383
+ enabled: boolean;
5311
5384
  /**
5312
- * Platform update date in ISO 8601 format.
5385
+ * Dropbox OAuth2 app key.
5313
5386
  */
5314
- $updatedAt: string;
5387
+ appKey: string;
5315
5388
  /**
5316
- * Platform name.
5389
+ * Dropbox OAuth2 app secret.
5317
5390
  */
5318
- name: string;
5391
+ appSecret: string;
5392
+ };
5393
+ /**
5394
+ * OAuth2Dailymotion
5395
+ */
5396
+ export type OAuth2Dailymotion = {
5319
5397
  /**
5320
- * Platform type. Possible values are: windows, apple, android, linux, web.
5398
+ * OAuth2 provider ID.
5321
5399
  */
5322
- type: PlatformType;
5400
+ $id: string;
5323
5401
  /**
5324
- * Windows package identifier name.
5402
+ * OAuth2 provider is active and can be used to create sessions.
5325
5403
  */
5326
- packageIdentifierName: string;
5404
+ enabled: boolean;
5405
+ /**
5406
+ * Dailymotion OAuth2 API key.
5407
+ */
5408
+ apiKey: string;
5409
+ /**
5410
+ * Dailymotion OAuth2 API secret.
5411
+ */
5412
+ apiSecret: string;
5327
5413
  };
5328
5414
  /**
5329
- * Platform Linux
5415
+ * OAuth2Bitbucket
5330
5416
  */
5331
- export type PlatformLinux = {
5417
+ export type OAuth2Bitbucket = {
5332
5418
  /**
5333
- * Platform ID.
5419
+ * OAuth2 provider ID.
5334
5420
  */
5335
5421
  $id: string;
5336
5422
  /**
5337
- * Platform creation date in ISO 8601 format.
5423
+ * OAuth2 provider is active and can be used to create sessions.
5338
5424
  */
5339
- $createdAt: string;
5425
+ enabled: boolean;
5340
5426
  /**
5341
- * Platform update date in ISO 8601 format.
5427
+ * Bitbucket OAuth2 key.
5342
5428
  */
5343
- $updatedAt: string;
5429
+ key: string;
5344
5430
  /**
5345
- * Platform name.
5431
+ * Bitbucket OAuth2 secret.
5346
5432
  */
5347
- name: string;
5433
+ secret: string;
5434
+ };
5435
+ /**
5436
+ * OAuth2Bitly
5437
+ */
5438
+ export type OAuth2Bitly = {
5348
5439
  /**
5349
- * Platform type. Possible values are: windows, apple, android, linux, web.
5440
+ * OAuth2 provider ID.
5350
5441
  */
5351
- type: PlatformType;
5442
+ $id: string;
5352
5443
  /**
5353
- * Linux package name.
5444
+ * OAuth2 provider is active and can be used to create sessions.
5354
5445
  */
5355
- packageName: string;
5356
- };
5357
- /**
5358
- * Platforms List
5359
- */
5360
- export type PlatformList = {
5446
+ enabled: boolean;
5361
5447
  /**
5362
- * Total number of platforms in the given project.
5448
+ * Bitly OAuth2 client ID.
5363
5449
  */
5364
- total: number;
5450
+ clientId: string;
5365
5451
  /**
5366
- * List of platforms.
5452
+ * Bitly OAuth2 client secret.
5367
5453
  */
5368
- platforms: (Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux)[];
5454
+ clientSecret: string;
5369
5455
  };
5370
5456
  /**
5371
- * Variable
5457
+ * OAuth2Box
5372
5458
  */
5373
- export type Variable = {
5459
+ export type OAuth2Box = {
5374
5460
  /**
5375
- * Variable ID.
5461
+ * OAuth2 provider ID.
5376
5462
  */
5377
5463
  $id: string;
5378
5464
  /**
5379
- * Variable creation date in ISO 8601 format.
5465
+ * OAuth2 provider is active and can be used to create sessions.
5380
5466
  */
5381
- $createdAt: string;
5467
+ enabled: boolean;
5382
5468
  /**
5383
- * Variable creation date in ISO 8601 format.
5469
+ * Box OAuth2 client ID.
5384
5470
  */
5385
- $updatedAt: string;
5471
+ clientId: string;
5386
5472
  /**
5387
- * Variable key.
5473
+ * Box OAuth2 client secret.
5388
5474
  */
5389
- key: string;
5475
+ clientSecret: string;
5476
+ };
5477
+ /**
5478
+ * OAuth2Autodesk
5479
+ */
5480
+ export type OAuth2Autodesk = {
5390
5481
  /**
5391
- * Variable value.
5482
+ * OAuth2 provider ID.
5392
5483
  */
5393
- value: string;
5484
+ $id: string;
5394
5485
  /**
5395
- * Variable secret flag. Secret variables can only be updated or deleted, but never read.
5486
+ * OAuth2 provider is active and can be used to create sessions.
5396
5487
  */
5397
- secret: boolean;
5488
+ enabled: boolean;
5398
5489
  /**
5399
- * Service to which the variable belongs. Possible values are "project", "function"
5490
+ * Autodesk OAuth2 client ID.
5400
5491
  */
5401
- resourceType: string;
5492
+ clientId: string;
5402
5493
  /**
5403
- * ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function.
5494
+ * Autodesk OAuth2 client secret.
5404
5495
  */
5405
- resourceId: string;
5496
+ clientSecret: string;
5406
5497
  };
5407
5498
  /**
5408
- * Country
5499
+ * OAuth2Google
5409
5500
  */
5410
- export type Country = {
5501
+ export type OAuth2Google = {
5411
5502
  /**
5412
- * Country name.
5503
+ * OAuth2 provider ID.
5413
5504
  */
5414
- name: string;
5505
+ $id: string;
5415
5506
  /**
5416
- * Country two-character ISO 3166-1 alpha code.
5507
+ * OAuth2 provider is active and can be used to create sessions.
5417
5508
  */
5418
- code: string;
5419
- };
5420
- /**
5421
- * Continent
5422
- */
5423
- export type Continent = {
5509
+ enabled: boolean;
5424
5510
  /**
5425
- * Continent name.
5511
+ * Google OAuth2 client ID.
5426
5512
  */
5427
- name: string;
5513
+ clientId: string;
5428
5514
  /**
5429
- * Continent two letter code.
5515
+ * Google OAuth2 client secret.
5430
5516
  */
5431
- code: string;
5517
+ clientSecret: string;
5432
5518
  };
5433
5519
  /**
5434
- * Language
5520
+ * OAuth2Zoom
5435
5521
  */
5436
- export type Language = {
5522
+ export type OAuth2Zoom = {
5437
5523
  /**
5438
- * Language name.
5524
+ * OAuth2 provider ID.
5439
5525
  */
5440
- name: string;
5526
+ $id: string;
5527
+ /**
5528
+ * OAuth2 provider is active and can be used to create sessions.
5529
+ */
5530
+ enabled: boolean;
5531
+ /**
5532
+ * Zoom OAuth2 client ID.
5533
+ */
5534
+ clientId: string;
5535
+ /**
5536
+ * Zoom OAuth2 client secret.
5537
+ */
5538
+ clientSecret: string;
5539
+ };
5540
+ /**
5541
+ * OAuth2Zoho
5542
+ */
5543
+ export type OAuth2Zoho = {
5544
+ /**
5545
+ * OAuth2 provider ID.
5546
+ */
5547
+ $id: string;
5548
+ /**
5549
+ * OAuth2 provider is active and can be used to create sessions.
5550
+ */
5551
+ enabled: boolean;
5552
+ /**
5553
+ * Zoho OAuth2 client ID.
5554
+ */
5555
+ clientId: string;
5556
+ /**
5557
+ * Zoho OAuth2 client secret.
5558
+ */
5559
+ clientSecret: string;
5560
+ };
5561
+ /**
5562
+ * OAuth2Yandex
5563
+ */
5564
+ export type OAuth2Yandex = {
5565
+ /**
5566
+ * OAuth2 provider ID.
5567
+ */
5568
+ $id: string;
5569
+ /**
5570
+ * OAuth2 provider is active and can be used to create sessions.
5571
+ */
5572
+ enabled: boolean;
5573
+ /**
5574
+ * Yandex OAuth2 client ID.
5575
+ */
5576
+ clientId: string;
5577
+ /**
5578
+ * Yandex OAuth2 client secret.
5579
+ */
5580
+ clientSecret: string;
5581
+ };
5582
+ /**
5583
+ * OAuth2X
5584
+ */
5585
+ export type OAuth2X = {
5586
+ /**
5587
+ * OAuth2 provider ID.
5588
+ */
5589
+ $id: string;
5590
+ /**
5591
+ * OAuth2 provider is active and can be used to create sessions.
5592
+ */
5593
+ enabled: boolean;
5594
+ /**
5595
+ * X OAuth2 customer key.
5596
+ */
5597
+ customerKey: string;
5598
+ /**
5599
+ * X OAuth2 secret key.
5600
+ */
5601
+ secretKey: string;
5602
+ };
5603
+ /**
5604
+ * OAuth2WordPress
5605
+ */
5606
+ export type OAuth2WordPress = {
5607
+ /**
5608
+ * OAuth2 provider ID.
5609
+ */
5610
+ $id: string;
5611
+ /**
5612
+ * OAuth2 provider is active and can be used to create sessions.
5613
+ */
5614
+ enabled: boolean;
5615
+ /**
5616
+ * WordPress OAuth2 client ID.
5617
+ */
5618
+ clientId: string;
5619
+ /**
5620
+ * WordPress OAuth2 client secret.
5621
+ */
5622
+ clientSecret: string;
5623
+ };
5624
+ /**
5625
+ * OAuth2Twitch
5626
+ */
5627
+ export type OAuth2Twitch = {
5628
+ /**
5629
+ * OAuth2 provider ID.
5630
+ */
5631
+ $id: string;
5632
+ /**
5633
+ * OAuth2 provider is active and can be used to create sessions.
5634
+ */
5635
+ enabled: boolean;
5636
+ /**
5637
+ * Twitch OAuth2 client ID.
5638
+ */
5639
+ clientId: string;
5640
+ /**
5641
+ * Twitch OAuth2 client secret.
5642
+ */
5643
+ clientSecret: string;
5644
+ };
5645
+ /**
5646
+ * OAuth2Stripe
5647
+ */
5648
+ export type OAuth2Stripe = {
5649
+ /**
5650
+ * OAuth2 provider ID.
5651
+ */
5652
+ $id: string;
5653
+ /**
5654
+ * OAuth2 provider is active and can be used to create sessions.
5655
+ */
5656
+ enabled: boolean;
5657
+ /**
5658
+ * Stripe OAuth2 client ID.
5659
+ */
5660
+ clientId: string;
5661
+ /**
5662
+ * Stripe OAuth2 API secret key.
5663
+ */
5664
+ apiSecretKey: string;
5665
+ };
5666
+ /**
5667
+ * OAuth2Spotify
5668
+ */
5669
+ export type OAuth2Spotify = {
5670
+ /**
5671
+ * OAuth2 provider ID.
5672
+ */
5673
+ $id: string;
5674
+ /**
5675
+ * OAuth2 provider is active and can be used to create sessions.
5676
+ */
5677
+ enabled: boolean;
5678
+ /**
5679
+ * Spotify OAuth2 client ID.
5680
+ */
5681
+ clientId: string;
5682
+ /**
5683
+ * Spotify OAuth2 client secret.
5684
+ */
5685
+ clientSecret: string;
5686
+ };
5687
+ /**
5688
+ * OAuth2Slack
5689
+ */
5690
+ export type OAuth2Slack = {
5691
+ /**
5692
+ * OAuth2 provider ID.
5693
+ */
5694
+ $id: string;
5695
+ /**
5696
+ * OAuth2 provider is active and can be used to create sessions.
5697
+ */
5698
+ enabled: boolean;
5699
+ /**
5700
+ * Slack OAuth2 client ID.
5701
+ */
5702
+ clientId: string;
5703
+ /**
5704
+ * Slack OAuth2 client secret.
5705
+ */
5706
+ clientSecret: string;
5707
+ };
5708
+ /**
5709
+ * OAuth2Podio
5710
+ */
5711
+ export type OAuth2Podio = {
5712
+ /**
5713
+ * OAuth2 provider ID.
5714
+ */
5715
+ $id: string;
5716
+ /**
5717
+ * OAuth2 provider is active and can be used to create sessions.
5718
+ */
5719
+ enabled: boolean;
5720
+ /**
5721
+ * Podio OAuth2 client ID.
5722
+ */
5723
+ clientId: string;
5724
+ /**
5725
+ * Podio OAuth2 client secret.
5726
+ */
5727
+ clientSecret: string;
5728
+ };
5729
+ /**
5730
+ * OAuth2Notion
5731
+ */
5732
+ export type OAuth2Notion = {
5733
+ /**
5734
+ * OAuth2 provider ID.
5735
+ */
5736
+ $id: string;
5737
+ /**
5738
+ * OAuth2 provider is active and can be used to create sessions.
5739
+ */
5740
+ enabled: boolean;
5741
+ /**
5742
+ * Notion OAuth2 client ID.
5743
+ */
5744
+ oauthClientId: string;
5745
+ /**
5746
+ * Notion OAuth2 client secret.
5747
+ */
5748
+ oauthClientSecret: string;
5749
+ };
5750
+ /**
5751
+ * OAuth2Salesforce
5752
+ */
5753
+ export type OAuth2Salesforce = {
5754
+ /**
5755
+ * OAuth2 provider ID.
5756
+ */
5757
+ $id: string;
5758
+ /**
5759
+ * OAuth2 provider is active and can be used to create sessions.
5760
+ */
5761
+ enabled: boolean;
5762
+ /**
5763
+ * Salesforce OAuth2 consumer key.
5764
+ */
5765
+ customerKey: string;
5766
+ /**
5767
+ * Salesforce OAuth2 consumer secret.
5768
+ */
5769
+ customerSecret: string;
5770
+ };
5771
+ /**
5772
+ * OAuth2Yahoo
5773
+ */
5774
+ export type OAuth2Yahoo = {
5775
+ /**
5776
+ * OAuth2 provider ID.
5777
+ */
5778
+ $id: string;
5779
+ /**
5780
+ * OAuth2 provider is active and can be used to create sessions.
5781
+ */
5782
+ enabled: boolean;
5783
+ /**
5784
+ * Yahoo OAuth2 client ID.
5785
+ */
5786
+ clientId: string;
5787
+ /**
5788
+ * Yahoo OAuth2 client secret.
5789
+ */
5790
+ clientSecret: string;
5791
+ };
5792
+ /**
5793
+ * OAuth2Linkedin
5794
+ */
5795
+ export type OAuth2Linkedin = {
5796
+ /**
5797
+ * OAuth2 provider ID.
5798
+ */
5799
+ $id: string;
5800
+ /**
5801
+ * OAuth2 provider is active and can be used to create sessions.
5802
+ */
5803
+ enabled: boolean;
5804
+ /**
5805
+ * LinkedIn OAuth2 client ID.
5806
+ */
5807
+ clientId: string;
5808
+ /**
5809
+ * LinkedIn OAuth2 primary client secret.
5810
+ */
5811
+ primaryClientSecret: string;
5812
+ };
5813
+ /**
5814
+ * OAuth2Disqus
5815
+ */
5816
+ export type OAuth2Disqus = {
5817
+ /**
5818
+ * OAuth2 provider ID.
5819
+ */
5820
+ $id: string;
5821
+ /**
5822
+ * OAuth2 provider is active and can be used to create sessions.
5823
+ */
5824
+ enabled: boolean;
5825
+ /**
5826
+ * Disqus OAuth2 public key.
5827
+ */
5828
+ publicKey: string;
5829
+ /**
5830
+ * Disqus OAuth2 secret key.
5831
+ */
5832
+ secretKey: string;
5833
+ };
5834
+ /**
5835
+ * OAuth2Amazon
5836
+ */
5837
+ export type OAuth2Amazon = {
5838
+ /**
5839
+ * OAuth2 provider ID.
5840
+ */
5841
+ $id: string;
5842
+ /**
5843
+ * OAuth2 provider is active and can be used to create sessions.
5844
+ */
5845
+ enabled: boolean;
5846
+ /**
5847
+ * Amazon OAuth2 client ID.
5848
+ */
5849
+ clientId: string;
5850
+ /**
5851
+ * Amazon OAuth2 client secret.
5852
+ */
5853
+ clientSecret: string;
5854
+ };
5855
+ /**
5856
+ * OAuth2Etsy
5857
+ */
5858
+ export type OAuth2Etsy = {
5859
+ /**
5860
+ * OAuth2 provider ID.
5861
+ */
5862
+ $id: string;
5863
+ /**
5864
+ * OAuth2 provider is active and can be used to create sessions.
5865
+ */
5866
+ enabled: boolean;
5867
+ /**
5868
+ * Etsy OAuth2 keystring.
5869
+ */
5870
+ keyString: string;
5871
+ /**
5872
+ * Etsy OAuth2 shared secret.
5873
+ */
5874
+ sharedSecret: string;
5875
+ };
5876
+ /**
5877
+ * OAuth2Facebook
5878
+ */
5879
+ export type OAuth2Facebook = {
5880
+ /**
5881
+ * OAuth2 provider ID.
5882
+ */
5883
+ $id: string;
5884
+ /**
5885
+ * OAuth2 provider is active and can be used to create sessions.
5886
+ */
5887
+ enabled: boolean;
5888
+ /**
5889
+ * Facebook OAuth2 app ID.
5890
+ */
5891
+ appId: string;
5892
+ /**
5893
+ * Facebook OAuth2 app secret.
5894
+ */
5895
+ appSecret: string;
5896
+ };
5897
+ /**
5898
+ * OAuth2Tradeshift
5899
+ */
5900
+ export type OAuth2Tradeshift = {
5901
+ /**
5902
+ * OAuth2 provider ID.
5903
+ */
5904
+ $id: string;
5905
+ /**
5906
+ * OAuth2 provider is active and can be used to create sessions.
5907
+ */
5908
+ enabled: boolean;
5909
+ /**
5910
+ * Tradeshift OAuth2 client ID.
5911
+ */
5912
+ oauth2ClientId: string;
5913
+ /**
5914
+ * Tradeshift OAuth2 client secret.
5915
+ */
5916
+ oauth2ClientSecret: string;
5917
+ };
5918
+ /**
5919
+ * OAuth2Paypal
5920
+ */
5921
+ export type OAuth2Paypal = {
5922
+ /**
5923
+ * OAuth2 provider ID.
5924
+ */
5925
+ $id: string;
5926
+ /**
5927
+ * OAuth2 provider is active and can be used to create sessions.
5928
+ */
5929
+ enabled: boolean;
5930
+ /**
5931
+ * PayPal OAuth2 client ID.
5932
+ */
5933
+ clientId: string;
5934
+ /**
5935
+ * PayPal OAuth2 secret key.
5936
+ */
5937
+ secretKey: string;
5938
+ };
5939
+ /**
5940
+ * OAuth2Gitlab
5941
+ */
5942
+ export type OAuth2Gitlab = {
5943
+ /**
5944
+ * OAuth2 provider ID.
5945
+ */
5946
+ $id: string;
5947
+ /**
5948
+ * OAuth2 provider is active and can be used to create sessions.
5949
+ */
5950
+ enabled: boolean;
5951
+ /**
5952
+ * GitLab OAuth2 application ID.
5953
+ */
5954
+ applicationId: string;
5955
+ /**
5956
+ * GitLab OAuth2 secret.
5957
+ */
5958
+ secret: string;
5959
+ /**
5960
+ * GitLab OAuth2 endpoint URL. Defaults to https://gitlab.com for self-hosted instances.
5961
+ */
5962
+ endpoint: string;
5963
+ };
5964
+ /**
5965
+ * OAuth2Authentik
5966
+ */
5967
+ export type OAuth2Authentik = {
5968
+ /**
5969
+ * OAuth2 provider ID.
5970
+ */
5971
+ $id: string;
5972
+ /**
5973
+ * OAuth2 provider is active and can be used to create sessions.
5974
+ */
5975
+ enabled: boolean;
5976
+ /**
5977
+ * Authentik OAuth2 client ID.
5978
+ */
5979
+ clientId: string;
5980
+ /**
5981
+ * Authentik OAuth2 client secret.
5982
+ */
5983
+ clientSecret: string;
5984
+ /**
5985
+ * Authentik OAuth2 endpoint domain.
5986
+ */
5987
+ endpoint: string;
5988
+ };
5989
+ /**
5990
+ * OAuth2Auth0
5991
+ */
5992
+ export type OAuth2Auth0 = {
5993
+ /**
5994
+ * OAuth2 provider ID.
5995
+ */
5996
+ $id: string;
5997
+ /**
5998
+ * OAuth2 provider is active and can be used to create sessions.
5999
+ */
6000
+ enabled: boolean;
6001
+ /**
6002
+ * Auth0 OAuth2 client ID.
6003
+ */
6004
+ clientId: string;
6005
+ /**
6006
+ * Auth0 OAuth2 client secret.
6007
+ */
6008
+ clientSecret: string;
6009
+ /**
6010
+ * Auth0 OAuth2 endpoint domain.
6011
+ */
6012
+ endpoint: string;
6013
+ };
6014
+ /**
6015
+ * OAuth2FusionAuth
6016
+ */
6017
+ export type OAuth2FusionAuth = {
6018
+ /**
6019
+ * OAuth2 provider ID.
6020
+ */
6021
+ $id: string;
6022
+ /**
6023
+ * OAuth2 provider is active and can be used to create sessions.
6024
+ */
6025
+ enabled: boolean;
6026
+ /**
6027
+ * FusionAuth OAuth2 client ID.
6028
+ */
6029
+ clientId: string;
6030
+ /**
6031
+ * FusionAuth OAuth2 client secret.
6032
+ */
6033
+ clientSecret: string;
6034
+ /**
6035
+ * FusionAuth OAuth2 endpoint domain.
6036
+ */
6037
+ endpoint: string;
6038
+ };
6039
+ /**
6040
+ * OAuth2Keycloak
6041
+ */
6042
+ export type OAuth2Keycloak = {
6043
+ /**
6044
+ * OAuth2 provider ID.
6045
+ */
6046
+ $id: string;
6047
+ /**
6048
+ * OAuth2 provider is active and can be used to create sessions.
6049
+ */
6050
+ enabled: boolean;
6051
+ /**
6052
+ * Keycloak OAuth2 client ID.
6053
+ */
6054
+ clientId: string;
6055
+ /**
6056
+ * Keycloak OAuth2 client secret.
6057
+ */
6058
+ clientSecret: string;
6059
+ /**
6060
+ * Keycloak OAuth2 endpoint domain.
6061
+ */
6062
+ endpoint: string;
6063
+ /**
6064
+ * Keycloak OAuth2 realm name.
6065
+ */
6066
+ realmName: string;
6067
+ };
6068
+ /**
6069
+ * OAuth2Oidc
6070
+ */
6071
+ export type OAuth2Oidc = {
6072
+ /**
6073
+ * OAuth2 provider ID.
6074
+ */
6075
+ $id: string;
6076
+ /**
6077
+ * OAuth2 provider is active and can be used to create sessions.
6078
+ */
6079
+ enabled: boolean;
6080
+ /**
6081
+ * OpenID Connect OAuth2 client ID.
6082
+ */
6083
+ clientId: string;
6084
+ /**
6085
+ * OpenID Connect OAuth2 client secret.
6086
+ */
6087
+ clientSecret: string;
6088
+ /**
6089
+ * OpenID Connect well-known configuration URL. When set, authorization, token, and user info endpoints can be discovered automatically.
6090
+ */
6091
+ wellKnownURL: string;
6092
+ /**
6093
+ * OpenID Connect authorization endpoint URL.
6094
+ */
6095
+ authorizationURL: string;
6096
+ /**
6097
+ * OpenID Connect token endpoint URL.
6098
+ */
6099
+ tokenUrl: string;
6100
+ /**
6101
+ * OpenID Connect user info endpoint URL.
6102
+ */
6103
+ userInfoUrl: string;
6104
+ };
6105
+ /**
6106
+ * OAuth2Okta
6107
+ */
6108
+ export type OAuth2Okta = {
6109
+ /**
6110
+ * OAuth2 provider ID.
6111
+ */
6112
+ $id: string;
6113
+ /**
6114
+ * OAuth2 provider is active and can be used to create sessions.
6115
+ */
6116
+ enabled: boolean;
6117
+ /**
6118
+ * Okta OAuth2 client ID.
6119
+ */
6120
+ clientId: string;
6121
+ /**
6122
+ * Okta OAuth2 client secret.
6123
+ */
6124
+ clientSecret: string;
6125
+ /**
6126
+ * Okta OAuth2 domain.
6127
+ */
6128
+ domain: string;
6129
+ /**
6130
+ * Okta OAuth2 authorization server ID.
6131
+ */
6132
+ authorizationServerId: string;
6133
+ };
6134
+ /**
6135
+ * OAuth2Kick
6136
+ */
6137
+ export type OAuth2Kick = {
6138
+ /**
6139
+ * OAuth2 provider ID.
6140
+ */
6141
+ $id: string;
6142
+ /**
6143
+ * OAuth2 provider is active and can be used to create sessions.
6144
+ */
6145
+ enabled: boolean;
6146
+ /**
6147
+ * Kick OAuth2 client ID.
6148
+ */
6149
+ clientId: string;
6150
+ /**
6151
+ * Kick OAuth2 client secret.
6152
+ */
6153
+ clientSecret: string;
6154
+ };
6155
+ /**
6156
+ * OAuth2Apple
6157
+ */
6158
+ export type OAuth2Apple = {
6159
+ /**
6160
+ * OAuth2 provider ID.
6161
+ */
6162
+ $id: string;
6163
+ /**
6164
+ * OAuth2 provider is active and can be used to create sessions.
6165
+ */
6166
+ enabled: boolean;
6167
+ /**
6168
+ * Apple OAuth2 service ID.
6169
+ */
6170
+ serviceId: string;
6171
+ /**
6172
+ * Apple OAuth2 key ID.
6173
+ */
6174
+ keyId: string;
6175
+ /**
6176
+ * Apple OAuth2 team ID.
6177
+ */
6178
+ teamId: string;
6179
+ /**
6180
+ * Apple OAuth2 .p8 private key file contents. The secret key wrapped by the PEM markers is 200 characters long.
6181
+ */
6182
+ p8File: string;
6183
+ };
6184
+ /**
6185
+ * OAuth2Microsoft
6186
+ */
6187
+ export type OAuth2Microsoft = {
6188
+ /**
6189
+ * OAuth2 provider ID.
6190
+ */
6191
+ $id: string;
6192
+ /**
6193
+ * OAuth2 provider is active and can be used to create sessions.
6194
+ */
6195
+ enabled: boolean;
6196
+ /**
6197
+ * Microsoft OAuth2 application ID.
6198
+ */
6199
+ applicationId: string;
6200
+ /**
6201
+ * Microsoft OAuth2 application secret.
6202
+ */
6203
+ applicationSecret: string;
6204
+ /**
6205
+ * Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID.
6206
+ */
6207
+ tenant: string;
6208
+ };
6209
+ /**
6210
+ * OAuth2 Providers List
6211
+ */
6212
+ export type OAuth2ProviderList = {
6213
+ /**
6214
+ * Total number of OAuth2 providers in the given project.
6215
+ */
6216
+ total: number;
6217
+ /**
6218
+ * List of OAuth2 providers.
6219
+ */
6220
+ providers: (Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft)[];
6221
+ };
6222
+ /**
6223
+ * Policy Password Dictionary
6224
+ */
6225
+ export type PolicyPasswordDictionary = {
6226
+ /**
6227
+ * Policy ID.
6228
+ */
6229
+ $id: string;
6230
+ /**
6231
+ * Whether password dictionary policy is enabled.
6232
+ */
6233
+ enabled: boolean;
6234
+ };
6235
+ /**
6236
+ * Policy Password History
6237
+ */
6238
+ export type PolicyPasswordHistory = {
6239
+ /**
6240
+ * Policy ID.
6241
+ */
6242
+ $id: string;
6243
+ /**
6244
+ * Password history length. A value of 0 means the policy is disabled.
6245
+ */
6246
+ total: number;
6247
+ };
6248
+ /**
6249
+ * Policy Password Personal Data
6250
+ */
6251
+ export type PolicyPasswordPersonalData = {
6252
+ /**
6253
+ * Policy ID.
6254
+ */
6255
+ $id: string;
6256
+ /**
6257
+ * Whether password personal data policy is enabled.
6258
+ */
6259
+ enabled: boolean;
6260
+ };
6261
+ /**
6262
+ * Policy Session Alert
6263
+ */
6264
+ export type PolicySessionAlert = {
6265
+ /**
6266
+ * Policy ID.
6267
+ */
6268
+ $id: string;
6269
+ /**
6270
+ * Whether session alert policy is enabled.
6271
+ */
6272
+ enabled: boolean;
6273
+ };
6274
+ /**
6275
+ * Policy Session Duration
6276
+ */
6277
+ export type PolicySessionDuration = {
6278
+ /**
6279
+ * Policy ID.
6280
+ */
6281
+ $id: string;
6282
+ /**
6283
+ * Session duration in seconds.
6284
+ */
6285
+ duration: number;
6286
+ };
6287
+ /**
6288
+ * Policy Session Invalidation
6289
+ */
6290
+ export type PolicySessionInvalidation = {
6291
+ /**
6292
+ * Policy ID.
6293
+ */
6294
+ $id: string;
6295
+ /**
6296
+ * Whether session invalidation policy is enabled.
6297
+ */
6298
+ enabled: boolean;
6299
+ };
6300
+ /**
6301
+ * Policy Session Limit
6302
+ */
6303
+ export type PolicySessionLimit = {
6304
+ /**
6305
+ * Policy ID.
6306
+ */
6307
+ $id: string;
6308
+ /**
6309
+ * Maximum number of sessions allowed per user. A value of 0 means the policy is disabled.
6310
+ */
6311
+ total: number;
6312
+ };
6313
+ /**
6314
+ * Policy User Limit
6315
+ */
6316
+ export type PolicyUserLimit = {
6317
+ /**
6318
+ * Policy ID.
6319
+ */
6320
+ $id: string;
6321
+ /**
6322
+ * Maximum number of users allowed in the project. A value of 0 means the policy is disabled.
6323
+ */
6324
+ total: number;
6325
+ };
6326
+ /**
6327
+ * Policy Membership Privacy
6328
+ */
6329
+ export type PolicyMembershipPrivacy = {
6330
+ /**
6331
+ * Policy ID.
6332
+ */
6333
+ $id: string;
6334
+ /**
6335
+ * Whether user ID is visible in memberships.
6336
+ */
6337
+ userId: boolean;
6338
+ /**
6339
+ * Whether user email is visible in memberships.
6340
+ */
6341
+ userEmail: boolean;
6342
+ /**
6343
+ * Whether user phone is visible in memberships.
6344
+ */
6345
+ userPhone: boolean;
6346
+ /**
6347
+ * Whether user name is visible in memberships.
6348
+ */
6349
+ userName: boolean;
6350
+ /**
6351
+ * Whether user MFA status is visible in memberships.
6352
+ */
6353
+ userMFA: boolean;
6354
+ };
6355
+ /**
6356
+ * AuthProvider
6357
+ */
6358
+ export type AuthProvider = {
6359
+ /**
6360
+ * Auth Provider.
6361
+ */
6362
+ key: string;
6363
+ /**
6364
+ * Auth Provider name.
6365
+ */
6366
+ name: string;
6367
+ /**
6368
+ * OAuth 2.0 application ID.
6369
+ */
6370
+ appId: string;
6371
+ /**
6372
+ * OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.
6373
+ */
6374
+ secret: string;
6375
+ /**
6376
+ * Auth Provider is active and can be used to create session.
6377
+ */
6378
+ enabled: boolean;
6379
+ };
6380
+ /**
6381
+ * Platform Web
6382
+ */
6383
+ export type PlatformWeb = {
6384
+ /**
6385
+ * Platform ID.
6386
+ */
6387
+ $id: string;
6388
+ /**
6389
+ * Platform creation date in ISO 8601 format.
6390
+ */
6391
+ $createdAt: string;
6392
+ /**
6393
+ * Platform update date in ISO 8601 format.
6394
+ */
6395
+ $updatedAt: string;
6396
+ /**
6397
+ * Platform name.
6398
+ */
6399
+ name: string;
6400
+ /**
6401
+ * Platform type. Possible values are: windows, apple, android, linux, web.
6402
+ */
6403
+ type: PlatformType;
6404
+ /**
6405
+ * Web app hostname. Empty string for other platforms.
6406
+ */
6407
+ hostname: string;
6408
+ };
6409
+ /**
6410
+ * Platform Apple
6411
+ */
6412
+ export type PlatformApple = {
6413
+ /**
6414
+ * Platform ID.
6415
+ */
6416
+ $id: string;
6417
+ /**
6418
+ * Platform creation date in ISO 8601 format.
6419
+ */
6420
+ $createdAt: string;
6421
+ /**
6422
+ * Platform update date in ISO 8601 format.
6423
+ */
6424
+ $updatedAt: string;
6425
+ /**
6426
+ * Platform name.
6427
+ */
6428
+ name: string;
6429
+ /**
6430
+ * Platform type. Possible values are: windows, apple, android, linux, web.
6431
+ */
6432
+ type: PlatformType;
6433
+ /**
6434
+ * Apple bundle identifier.
6435
+ */
6436
+ bundleIdentifier: string;
6437
+ };
6438
+ /**
6439
+ * Platform Android
6440
+ */
6441
+ export type PlatformAndroid = {
6442
+ /**
6443
+ * Platform ID.
6444
+ */
6445
+ $id: string;
6446
+ /**
6447
+ * Platform creation date in ISO 8601 format.
6448
+ */
6449
+ $createdAt: string;
6450
+ /**
6451
+ * Platform update date in ISO 8601 format.
6452
+ */
6453
+ $updatedAt: string;
6454
+ /**
6455
+ * Platform name.
6456
+ */
6457
+ name: string;
6458
+ /**
6459
+ * Platform type. Possible values are: windows, apple, android, linux, web.
6460
+ */
6461
+ type: PlatformType;
6462
+ /**
6463
+ * Android application ID.
6464
+ */
6465
+ applicationId: string;
6466
+ };
6467
+ /**
6468
+ * Platform Windows
6469
+ */
6470
+ export type PlatformWindows = {
6471
+ /**
6472
+ * Platform ID.
6473
+ */
6474
+ $id: string;
6475
+ /**
6476
+ * Platform creation date in ISO 8601 format.
6477
+ */
6478
+ $createdAt: string;
6479
+ /**
6480
+ * Platform update date in ISO 8601 format.
6481
+ */
6482
+ $updatedAt: string;
6483
+ /**
6484
+ * Platform name.
6485
+ */
6486
+ name: string;
6487
+ /**
6488
+ * Platform type. Possible values are: windows, apple, android, linux, web.
6489
+ */
6490
+ type: PlatformType;
6491
+ /**
6492
+ * Windows package identifier name.
6493
+ */
6494
+ packageIdentifierName: string;
6495
+ };
6496
+ /**
6497
+ * Platform Linux
6498
+ */
6499
+ export type PlatformLinux = {
6500
+ /**
6501
+ * Platform ID.
6502
+ */
6503
+ $id: string;
6504
+ /**
6505
+ * Platform creation date in ISO 8601 format.
6506
+ */
6507
+ $createdAt: string;
6508
+ /**
6509
+ * Platform update date in ISO 8601 format.
6510
+ */
6511
+ $updatedAt: string;
6512
+ /**
6513
+ * Platform name.
6514
+ */
6515
+ name: string;
6516
+ /**
6517
+ * Platform type. Possible values are: windows, apple, android, linux, web.
6518
+ */
6519
+ type: PlatformType;
6520
+ /**
6521
+ * Linux package name.
6522
+ */
6523
+ packageName: string;
6524
+ };
6525
+ /**
6526
+ * Platforms List
6527
+ */
6528
+ export type PlatformList = {
6529
+ /**
6530
+ * Total number of platforms in the given project.
6531
+ */
6532
+ total: number;
6533
+ /**
6534
+ * List of platforms.
6535
+ */
6536
+ platforms: (Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux)[];
6537
+ };
6538
+ /**
6539
+ * Variable
6540
+ */
6541
+ export type Variable = {
6542
+ /**
6543
+ * Variable ID.
6544
+ */
6545
+ $id: string;
6546
+ /**
6547
+ * Variable creation date in ISO 8601 format.
6548
+ */
6549
+ $createdAt: string;
6550
+ /**
6551
+ * Variable creation date in ISO 8601 format.
6552
+ */
6553
+ $updatedAt: string;
6554
+ /**
6555
+ * Variable key.
6556
+ */
6557
+ key: string;
6558
+ /**
6559
+ * Variable value.
6560
+ */
6561
+ value: string;
6562
+ /**
6563
+ * Variable secret flag. Secret variables can only be updated or deleted, but never read.
6564
+ */
6565
+ secret: boolean;
6566
+ /**
6567
+ * Service to which the variable belongs. Possible values are "project", "function"
6568
+ */
6569
+ resourceType: string;
6570
+ /**
6571
+ * ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function.
6572
+ */
6573
+ resourceId: string;
6574
+ };
6575
+ /**
6576
+ * Country
6577
+ */
6578
+ export type Country = {
6579
+ /**
6580
+ * Country name.
6581
+ */
6582
+ name: string;
6583
+ /**
6584
+ * Country two-character ISO 3166-1 alpha code.
6585
+ */
6586
+ code: string;
6587
+ };
6588
+ /**
6589
+ * Continent
6590
+ */
6591
+ export type Continent = {
6592
+ /**
6593
+ * Continent name.
6594
+ */
6595
+ name: string;
6596
+ /**
6597
+ * Continent two letter code.
6598
+ */
6599
+ code: string;
6600
+ };
6601
+ /**
6602
+ * Language
6603
+ */
6604
+ export type Language = {
6605
+ /**
6606
+ * Language name.
6607
+ */
6608
+ name: string;
5441
6609
  /**
5442
6610
  * Language two-character ISO 639-1 codes.
5443
6611
  */
@@ -6796,23 +7964,6 @@ export declare namespace Models {
6796
7964
  */
6797
7965
  region: string;
6798
7966
  };
6799
- /**
6800
- * SmsTemplate
6801
- */
6802
- export type SmsTemplate = {
6803
- /**
6804
- * Template type
6805
- */
6806
- type: string;
6807
- /**
6808
- * Template locale
6809
- */
6810
- locale: string;
6811
- /**
6812
- * Template message
6813
- */
6814
- message: string;
6815
- };
6816
7967
  /**
6817
7968
  * EmailTemplate
6818
7969
  */
@@ -6820,7 +7971,7 @@ export declare namespace Models {
6820
7971
  /**
6821
7972
  * Template type
6822
7973
  */
6823
- type: string;
7974
+ templateId: string;
6824
7975
  /**
6825
7976
  * Template locale
6826
7977
  */
@@ -6840,7 +7991,11 @@ export declare namespace Models {
6840
7991
  /**
6841
7992
  * Reply to email address
6842
7993
  */
6843
- replyTo: string;
7994
+ replyToEmail: string;
7995
+ /**
7996
+ * Reply to name
7997
+ */
7998
+ replyToName: string;
6844
7999
  /**
6845
8000
  * Email subject
6846
8001
  */
@@ -6959,6 +8114,87 @@ export declare namespace Models {
6959
8114
  */
6960
8115
  _APP_CONSOLE_EMAIL_VERIFICATION: string;
6961
8116
  };
8117
+ /**
8118
+ * Console OAuth2 Provider Parameter
8119
+ */
8120
+ export type ConsoleOAuth2ProviderParameter = {
8121
+ /**
8122
+ * Parameter ID. Maps to the request body field used by the project OAuth2 update endpoint (e.g. `clientId`, `appKey`, `tenant`).
8123
+ */
8124
+ $id: string;
8125
+ /**
8126
+ * Verbose, user-facing parameter name as shown in the provider's own dashboard. Includes alternate names when the provider exposes more than one.
8127
+ */
8128
+ name: string;
8129
+ /**
8130
+ * Example value for this parameter.
8131
+ */
8132
+ example: string;
8133
+ /**
8134
+ * Optional hint for this parameter, typically calling out a common wrong value. Empty string when no hint is set.
8135
+ */
8136
+ hint: string;
8137
+ };
8138
+ /**
8139
+ * Console OAuth2 Provider
8140
+ */
8141
+ export type ConsoleOAuth2Provider = {
8142
+ /**
8143
+ * OAuth2 provider ID.
8144
+ */
8145
+ $id: string;
8146
+ /**
8147
+ * List of parameters required to configure this OAuth2 provider.
8148
+ */
8149
+ parameters: ConsoleOAuth2ProviderParameter[];
8150
+ };
8151
+ /**
8152
+ * Console OAuth2 Providers List
8153
+ */
8154
+ export type ConsoleOAuth2ProviderList = {
8155
+ /**
8156
+ * Total number of OAuth2 providers exposed by the server.
8157
+ */
8158
+ total: number;
8159
+ /**
8160
+ * List of OAuth2 providers, each with the parameters required to configure it.
8161
+ */
8162
+ oAuth2Providers: ConsoleOAuth2Provider[];
8163
+ };
8164
+ /**
8165
+ * Console Key Scope
8166
+ */
8167
+ export type ConsoleKeyScope = {
8168
+ /**
8169
+ * Scope ID.
8170
+ */
8171
+ $id: string;
8172
+ /**
8173
+ * Scope description.
8174
+ */
8175
+ description: string;
8176
+ /**
8177
+ * Scope category.
8178
+ */
8179
+ category: string;
8180
+ /**
8181
+ * Scope is deprecated.
8182
+ */
8183
+ deprecated: boolean;
8184
+ };
8185
+ /**
8186
+ * Console Key Scopes List
8187
+ */
8188
+ export type ConsoleKeyScopeList = {
8189
+ /**
8190
+ * Total number of key scopes exposed by the server.
8191
+ */
8192
+ total: number;
8193
+ /**
8194
+ * List of key scopes, each with its ID and description.
8195
+ */
8196
+ scopes: ConsoleKeyScope[];
8197
+ };
6962
8198
  /**
6963
8199
  * MFA Challenge
6964
8200
  */
@@ -8175,6 +9411,39 @@ export declare namespace Models {
8175
9411
  * Block expiration date in ISO 8601 format. Can be null if the block does not expire.
8176
9412
  */
8177
9413
  expiredAt?: string;
9414
+ /**
9415
+ * Name of the project this block applies to.
9416
+ */
9417
+ projectName: string;
9418
+ /**
9419
+ * Region of the project this block applies to.
9420
+ */
9421
+ region: string;
9422
+ /**
9423
+ * Name of the organization that owns the project.
9424
+ */
9425
+ organizationName: string;
9426
+ /**
9427
+ * ID of the organization that owns the project.
9428
+ */
9429
+ organizationId: string;
9430
+ /**
9431
+ * Billing plan of the organization that owns the project.
9432
+ */
9433
+ billingPlan: string;
9434
+ };
9435
+ /**
9436
+ * BlockDelete
9437
+ */
9438
+ export type BlockDelete = {
9439
+ /**
9440
+ * Number of blocks deleted
9441
+ */
9442
+ deleted: number;
9443
+ /**
9444
+ * List of deleted blocks
9445
+ */
9446
+ blocks: Block[];
8178
9447
  };
8179
9448
  /**
8180
9449
  * Campaign
@@ -8503,6 +9772,10 @@ export declare namespace Models {
8503
9772
  * Invoice status
8504
9773
  */
8505
9774
  status: string;
9775
+ /**
9776
+ * Invoice type. Can be one of `subscription`, `domain_purchase`, `domain_renewal`, `domain_transfer`, or `addon_*`.
9777
+ */
9778
+ type: string;
8506
9779
  /**
8507
9780
  * Last payment error associated with the invoice
8508
9781
  */
@@ -9469,6 +10742,151 @@ export declare namespace Models {
9469
10742
  */
9470
10743
  organizationCredits: number;
9471
10744
  };
10745
+ /**
10746
+ * EstimationPlanChange
10747
+ */
10748
+ export type EstimationPlanChange = {
10749
+ /**
10750
+ * Current billing plan ID
10751
+ */
10752
+ currentBillingPlanId: string;
10753
+ /**
10754
+ * Target billing plan ID
10755
+ */
10756
+ targetBillingPlanId: string;
10757
+ /**
10758
+ * Direction of plan change: upgrade, downgrade, or same
10759
+ */
10760
+ direction: string;
10761
+ /**
10762
+ * Cost estimation details
10763
+ */
10764
+ estimation: PlanChangeEstimationDetails;
10765
+ /**
10766
+ * Plan limits and compliance information
10767
+ */
10768
+ limits: PlanChangeLimits;
10769
+ };
10770
+ /**
10771
+ * PlanChangeEstimationDetails
10772
+ */
10773
+ export type PlanChangeEstimationDetails = {
10774
+ /**
10775
+ * Currency code
10776
+ */
10777
+ currency: string;
10778
+ /**
10779
+ * Gross amount after all discounts and credits
10780
+ */
10781
+ grossAmount: number;
10782
+ /**
10783
+ * Credits applied from coupon
10784
+ */
10785
+ credits: number;
10786
+ /**
10787
+ * Organization's existing credits applied
10788
+ */
10789
+ organizationCredits: number;
10790
+ /**
10791
+ * Discount amount from prorated invoices
10792
+ */
10793
+ discount: number;
10794
+ /**
10795
+ * Total amount before discounts and credits
10796
+ */
10797
+ amount: number;
10798
+ /**
10799
+ * Next invoice date
10800
+ */
10801
+ nextInvoiceDate: string;
10802
+ /**
10803
+ * Line items breakdown
10804
+ */
10805
+ items: object;
10806
+ /**
10807
+ * Applied discounts breakdown
10808
+ */
10809
+ discounts: object;
10810
+ };
10811
+ /**
10812
+ * PlanChangeLimits
10813
+ */
10814
+ export type PlanChangeLimits = {
10815
+ /**
10816
+ * Total number of projects in the organization
10817
+ */
10818
+ totalProjects: number;
10819
+ /**
10820
+ * Number of projects exceeding target plan limits
10821
+ */
10822
+ nonCompliantProjects: number;
10823
+ /**
10824
+ * Whether the plan change is allowed
10825
+ */
10826
+ canChangePlan: boolean;
10827
+ /**
10828
+ * Project compliance details
10829
+ */
10830
+ projects: PlanChangeProjectCompliance[];
10831
+ /**
10832
+ * Active addon keys that the target plan does not support. When non-empty, `canChangePlan` is false.
10833
+ */
10834
+ unsupportedAddons: string[];
10835
+ };
10836
+ /**
10837
+ * PlanChangeProjectCompliance
10838
+ */
10839
+ export type PlanChangeProjectCompliance = {
10840
+ /**
10841
+ * Project ID
10842
+ */
10843
+ $id: string;
10844
+ /**
10845
+ * Project name
10846
+ */
10847
+ name: string;
10848
+ /**
10849
+ * Whether the project complies with target plan limits
10850
+ */
10851
+ isCompliant: boolean;
10852
+ /**
10853
+ * Resource compliance details
10854
+ */
10855
+ resources: PlanChangeResourceCompliance[];
10856
+ /**
10857
+ * Failure reason when compliance could not be evaluated. Present only when the project DB or Regions API was unreachable; in that case `isCompliant` is false (fail closed) and `resources` is empty.
10858
+ */
10859
+ error?: string;
10860
+ };
10861
+ /**
10862
+ * PlanChangeResourceCompliance
10863
+ */
10864
+ export type PlanChangeResourceCompliance = {
10865
+ /**
10866
+ * Resource type
10867
+ */
10868
+ type: string;
10869
+ /**
10870
+ * Current usage count
10871
+ */
10872
+ currentUsage: number;
10873
+ /**
10874
+ * Allowed limit in target plan
10875
+ */
10876
+ limit: number;
10877
+ /**
10878
+ * Compliance status
10879
+ */
10880
+ status: string;
10881
+ /**
10882
+ * Number of resources exceeding the limit
10883
+ */
10884
+ excess: number;
10885
+ /**
10886
+ * Suggestion for resolving the compliance issue
10887
+ */
10888
+ resolutionHint: string;
10889
+ };
9472
10890
  /**
9473
10891
  * EstimationDeleteOrganization
9474
10892
  */
@@ -9792,6 +11210,19 @@ export declare namespace Models {
9792
11210
  */
9793
11211
  paymentMethods: PaymentMethod[];
9794
11212
  };
11213
+ /**
11214
+ * Blocks list
11215
+ */
11216
+ export type BlockList = {
11217
+ /**
11218
+ * Total number of blocks that matched your query.
11219
+ */
11220
+ total: number;
11221
+ /**
11222
+ * List of blocks.
11223
+ */
11224
+ blocks: Block[];
11225
+ };
9795
11226
  /**
9796
11227
  * Regions list
9797
11228
  */