@opusdns/api 0.14.1 → 0.16.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/src/schema.d.ts CHANGED
@@ -586,42 +586,45 @@ export interface paths {
586
586
  patch?: never;
587
587
  trace?: never;
588
588
  };
589
- "/v1/email-forwards": {
589
+ "/v1/email-forwards/{zone_name}/aliases": {
590
590
  parameters: {
591
591
  query?: never;
592
592
  header?: never;
593
593
  path?: never;
594
594
  cookie?: never;
595
595
  };
596
- /** List Email Forwards */
597
- get: operations["list_email_forwards_v1_email_forwards_get"];
596
+ /** Get Email Forward Aliases */
597
+ get: operations["get_email_forward_aliases_v1_email_forwards__zone_name__aliases_get"];
598
598
  put?: never;
599
- /** Create Email Forward */
600
- post: operations["create_email_forward_v1_email_forwards_post"];
601
- delete?: never;
599
+ /** Create Email Forward Alias */
600
+ post: operations["create_email_forward_alias_v1_email_forwards__zone_name__aliases_post"];
601
+ /** Delete Email Forward Aliases */
602
+ delete: operations["delete_email_forward_aliases_v1_email_forwards__zone_name__aliases_delete"];
602
603
  options?: never;
603
604
  head?: never;
604
605
  patch?: never;
605
606
  trace?: never;
606
607
  };
607
- "/v1/email-forwards/bulk-delete": {
608
+ "/v1/email-forwards/{zone_name}/aliases/{alias}": {
608
609
  parameters: {
609
610
  query?: never;
610
611
  header?: never;
611
612
  path?: never;
612
613
  cookie?: never;
613
614
  };
614
- get?: never;
615
- put?: never;
616
- /** Bulk Delete Email Forwards */
617
- post: operations["bulk_delete_email_forwards_v1_email_forwards_bulk_delete_post"];
618
- delete?: never;
615
+ /** Get Email Forward Alias */
616
+ get: operations["get_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__get"];
617
+ /** Update Email Forward Alias */
618
+ put: operations["update_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__put"];
619
+ post?: never;
620
+ /** Delete Email Forward Alias */
621
+ delete: operations["delete_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__delete"];
619
622
  options?: never;
620
623
  head?: never;
621
624
  patch?: never;
622
625
  trace?: never;
623
626
  };
624
- "/v1/email-forwards/bulk-update": {
627
+ "/v1/email-forwards/{zone_name}/disable": {
625
628
  parameters: {
626
629
  query?: never;
627
630
  header?: never;
@@ -634,27 +637,25 @@ export interface paths {
634
637
  delete?: never;
635
638
  options?: never;
636
639
  head?: never;
637
- /** Bulk Update Email Forwards */
638
- patch: operations["bulk_update_email_forwards_v1_email_forwards_bulk_update_patch"];
640
+ /** Disable Email Forward */
641
+ patch: operations["disable_email_forward_v1_email_forwards__zone_name__disable_patch"];
639
642
  trace?: never;
640
643
  };
641
- "/v1/email-forwards/{email_forward_id}": {
644
+ "/v1/email-forwards/{zone_name}/enable": {
642
645
  parameters: {
643
646
  query?: never;
644
647
  header?: never;
645
648
  path?: never;
646
649
  cookie?: never;
647
650
  };
648
- /** Get Email Forward */
649
- get: operations["get_email_forward_v1_email_forwards__email_forward_id__get"];
651
+ get?: never;
650
652
  put?: never;
651
653
  post?: never;
652
- /** Delete Email Forward */
653
- delete: operations["delete_email_forward_v1_email_forwards__email_forward_id__delete"];
654
+ delete?: never;
654
655
  options?: never;
655
656
  head?: never;
656
- /** Update Email Forward */
657
- patch: operations["update_email_forward_v1_email_forwards__email_forward_id__patch"];
657
+ /** Enable Email Forward */
658
+ patch: operations["enable_email_forward_v1_email_forwards__zone_name__enable_patch"];
658
659
  trace?: never;
659
660
  };
660
661
  "/v1/event": {
@@ -1108,31 +1109,6 @@ export interface components {
1108
1109
  */
1109
1110
  username?: string | null;
1110
1111
  };
1111
- /** BulkOperationResponse[EmailForwardBulkDeleteResult] */
1112
- BulkOperationResponse_EmailForwardBulkDeleteResult_: {
1113
- /** Results */
1114
- results: components["schemas"]["BulkOperationResult"][];
1115
- };
1116
- /** BulkOperationResponse[EmailForwardBulkUpdateResult] */
1117
- BulkOperationResponse_EmailForwardBulkUpdateResult_: {
1118
- /** Results */
1119
- results: components["schemas"]["BulkOperationResult"][];
1120
- };
1121
- /** BulkOperationResult */
1122
- BulkOperationResult: {
1123
- /**
1124
- * Error Message
1125
- * @description Error message if operation failed
1126
- */
1127
- error_message?: string | null;
1128
- /** @description Status of performed operation */
1129
- status: components["schemas"]["BulkOperationStatus"];
1130
- };
1131
- /**
1132
- * BulkOperationStatus
1133
- * @enum {string}
1134
- */
1135
- BulkOperationStatus: "success" | "failed";
1136
1112
  /** ContactConfigBase */
1137
1113
  ContactConfigBase: {
1138
1114
  /**
@@ -2312,119 +2288,23 @@ export interface components {
2312
2288
  */
2313
2289
  next_90_days: number;
2314
2290
  };
2315
- /** EmailForward */
2316
- EmailForward: {
2317
- /**
2318
- * Created On
2319
- * Format: date-time
2320
- * @description The date/time the entry was created on
2321
- */
2322
- created_on?: Date;
2323
- /**
2324
- * Email Forward Id
2325
- * Format: typeid
2326
- */
2327
- email_forward_id?: TypeID<"email_forward">;
2328
- /**
2329
- * Source Address
2330
- * Format: email
2331
- * @description The source email address to forward from
2332
- */
2333
- source_address: string;
2334
- /**
2335
- * @description Current status of the email forward rule
2336
- * @default active
2337
- */
2338
- status: components["schemas"]["EmailForwardStatus"];
2291
+ /** EmailForwardAlias */
2292
+ EmailForwardAlias: {
2293
+ /** Alias */
2294
+ alias: string;
2339
2295
  /**
2340
- * Target Address
2296
+ * Forward To
2341
2297
  * Format: email
2342
- * @description The target email address to forward to
2343
- */
2344
- target_address: string;
2345
- /**
2346
- * Updated On
2347
- * Format: date-time
2348
- * @description The date/time the entry was last updated on
2349
2298
  */
2350
- updated_on?: Date;
2299
+ forward_to: string;
2351
2300
  };
2352
- /** EmailForwardBulkDelete */
2353
- EmailForwardBulkDelete: {
2301
+ /** EmailForwardAliasUpdate */
2302
+ EmailForwardAliasUpdate: {
2354
2303
  /**
2355
- * Email Forward Ids
2356
- * @description List of email forward ids to delete
2357
- */
2358
- email_forward_ids: TypeID<"email_forward">[];
2359
- };
2360
- /** EmailForwardBulkUpdate */
2361
- EmailForwardBulkUpdate: {
2362
- /**
2363
- * Email Forwards
2364
- * @description List of email forwards data to update
2365
- */
2366
- email_forwards: components["schemas"]["EmailForwardBulkUpdateItem"][];
2367
- };
2368
- /** EmailForwardBulkUpdateItem */
2369
- EmailForwardBulkUpdateItem: {
2370
- /**
2371
- * Email Forward Id
2372
- * Format: typeid
2373
- * @description Unique identifier for the email forward
2374
- */
2375
- email_forward_id: TypeID<"email_forward">;
2376
- /**
2377
- * Source Address
2378
- * @description The source email address to forward from
2379
- */
2380
- source_address?: string | null;
2381
- /** @description Current status of the email forward rule */
2382
- status?: components["schemas"]["EmailForwardStatus"] | null;
2383
- /**
2384
- * Target Address
2385
- * @description The target email address to forward to
2386
- */
2387
- target_address?: string | null;
2388
- };
2389
- /** EmailForwardCreate */
2390
- EmailForwardCreate: {
2391
- /**
2392
- * Source Address
2393
- * Format: email
2394
- * @description The source email address to forward from
2395
- */
2396
- source_address: string;
2397
- /**
2398
- * @description Current status of the email forward rule
2399
- * @default active
2400
- */
2401
- status: components["schemas"]["EmailForwardStatus"];
2402
- /**
2403
- * Target Address
2304
+ * Forward To
2404
2305
  * Format: email
2405
- * @description The target email address to forward to
2406
2306
  */
2407
- target_address: string;
2408
- };
2409
- /**
2410
- * EmailForwardStatus
2411
- * @enum {string}
2412
- */
2413
- EmailForwardStatus: "active" | "inactive";
2414
- /** EmailForwardUpdate */
2415
- EmailForwardUpdate: {
2416
- /**
2417
- * Source Address
2418
- * @description The source email address to forward from
2419
- */
2420
- source_address?: string | null;
2421
- /** @description Current status of the email forward rule */
2422
- status?: components["schemas"]["EmailForwardStatus"] | null;
2423
- /**
2424
- * Target Address
2425
- * @description The target email address to forward to
2426
- */
2427
- target_address?: string | null;
2307
+ forward_to: string;
2428
2308
  };
2429
2309
  /**
2430
2310
  * EmailVerificationStatus
@@ -3483,11 +3363,11 @@ export interface components {
3483
3363
  /** Results */
3484
3364
  results: components["schemas"]["DomainResponse"][];
3485
3365
  };
3486
- /** Pagination[EmailForward] */
3487
- Pagination_EmailForward_: {
3366
+ /** Pagination[EmailForwardAlias] */
3367
+ Pagination_EmailForwardAlias_: {
3488
3368
  pagination: components["schemas"]["PaginationMetadata"];
3489
3369
  /** Results */
3490
- results: components["schemas"]["EmailForward"][];
3370
+ results: components["schemas"]["EmailForwardAlias"][];
3491
3371
  };
3492
3372
  /** Pagination[EventResponse] */
3493
3373
  Pagination_EventResponse_: {
@@ -3950,6 +3830,16 @@ export interface components {
3950
3830
  */
3951
3831
  username: string;
3952
3832
  };
3833
+ /** UserAttributeBase */
3834
+ UserAttributeBase: {
3835
+ /**
3836
+ * Key
3837
+ * @description Key of the attribute.
3838
+ */
3839
+ key: string;
3840
+ /** @description Value of the attribute. */
3841
+ value?: components["schemas"]["JsonValue"] | null;
3842
+ };
3953
3843
  /** UserAttributeUpdate */
3954
3844
  UserAttributeUpdate: {
3955
3845
  /**
@@ -3990,6 +3880,11 @@ export interface components {
3990
3880
  * @description The user's phone number
3991
3881
  */
3992
3882
  phone?: string | null;
3883
+ /**
3884
+ * User Attributes
3885
+ * @description User attributes
3886
+ */
3887
+ user_attributes?: components["schemas"]["UserAttributeBase"][] | null;
3993
3888
  /**
3994
3889
  * Username
3995
3890
  * @description The user's unique username
@@ -6506,20 +6401,17 @@ export interface operations {
6506
6401
  };
6507
6402
  };
6508
6403
  };
6509
- list_email_forwards_v1_email_forwards_get: {
6404
+ get_email_forward_aliases_v1_email_forwards__zone_name__aliases_get: {
6510
6405
  parameters: {
6511
6406
  query?: {
6512
- /** @description Optional status to filter the results */
6513
- status?: components["schemas"]["EmailForwardStatus"] | null;
6514
- /** @description Optional source address to filter the results */
6515
- source_address?: string | null;
6516
- /** @description Optional target address to filter the results */
6517
- target_address?: string | null;
6518
6407
  page?: number;
6519
6408
  page_size?: number;
6520
6409
  };
6521
6410
  header?: never;
6522
- path?: never;
6411
+ path: {
6412
+ /** @description DNS zone name (trailing dot optional) */
6413
+ zone_name: string;
6414
+ };
6523
6415
  cookie?: never;
6524
6416
  };
6525
6417
  requestBody?: never;
@@ -6530,7 +6422,7 @@ export interface operations {
6530
6422
  [name: string]: unknown;
6531
6423
  };
6532
6424
  content: {
6533
- "application/json": components["schemas"]["Pagination_EmailForward_"];
6425
+ "application/json": components["schemas"]["Pagination_EmailForwardAlias_"];
6534
6426
  };
6535
6427
  };
6536
6428
  /** @description Validation Error */
@@ -6544,16 +6436,19 @@ export interface operations {
6544
6436
  };
6545
6437
  };
6546
6438
  };
6547
- create_email_forward_v1_email_forwards_post: {
6439
+ create_email_forward_alias_v1_email_forwards__zone_name__aliases_post: {
6548
6440
  parameters: {
6549
6441
  query?: never;
6550
6442
  header?: never;
6551
- path?: never;
6443
+ path: {
6444
+ /** @description DNS zone name (trailing dot optional) */
6445
+ zone_name: string;
6446
+ };
6552
6447
  cookie?: never;
6553
6448
  };
6554
6449
  requestBody: {
6555
6450
  content: {
6556
- "application/json": components["schemas"]["EmailForwardCreate"];
6451
+ "application/json": components["schemas"]["EmailForwardAlias"];
6557
6452
  };
6558
6453
  };
6559
6454
  responses: {
@@ -6562,9 +6457,7 @@ export interface operations {
6562
6457
  headers: {
6563
6458
  [name: string]: unknown;
6564
6459
  };
6565
- content: {
6566
- "application/json": components["schemas"]["EmailForward"];
6567
- };
6460
+ content?: never;
6568
6461
  };
6569
6462
  /** @description Validation Error */
6570
6463
  422: {
@@ -6577,18 +6470,48 @@ export interface operations {
6577
6470
  };
6578
6471
  };
6579
6472
  };
6580
- bulk_delete_email_forwards_v1_email_forwards_bulk_delete_post: {
6473
+ delete_email_forward_aliases_v1_email_forwards__zone_name__aliases_delete: {
6581
6474
  parameters: {
6582
6475
  query?: never;
6583
6476
  header?: never;
6584
- path?: never;
6477
+ path: {
6478
+ /** @description DNS zone name (trailing dot optional) */
6479
+ zone_name: string;
6480
+ };
6585
6481
  cookie?: never;
6586
6482
  };
6587
- requestBody: {
6588
- content: {
6589
- "application/json": components["schemas"]["EmailForwardBulkDelete"];
6483
+ requestBody?: never;
6484
+ responses: {
6485
+ /** @description Successful Response */
6486
+ 204: {
6487
+ headers: {
6488
+ [name: string]: unknown;
6489
+ };
6490
+ content?: never;
6491
+ };
6492
+ /** @description Validation Error */
6493
+ 422: {
6494
+ headers: {
6495
+ [name: string]: unknown;
6496
+ };
6497
+ content: {
6498
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
6499
+ };
6590
6500
  };
6591
6501
  };
6502
+ };
6503
+ get_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__get: {
6504
+ parameters: {
6505
+ query?: never;
6506
+ header?: never;
6507
+ path: {
6508
+ alias: string;
6509
+ /** @description DNS zone name (trailing dot optional) */
6510
+ zone_name: string;
6511
+ };
6512
+ cookie?: never;
6513
+ };
6514
+ requestBody?: never;
6592
6515
  responses: {
6593
6516
  /** @description Successful Response */
6594
6517
  200: {
@@ -6596,7 +6519,7 @@ export interface operations {
6596
6519
  [name: string]: unknown;
6597
6520
  };
6598
6521
  content: {
6599
- "application/json": components["schemas"]["BulkOperationResponse_EmailForwardBulkDeleteResult_"];
6522
+ "application/json": components["schemas"]["EmailForwardAlias"];
6600
6523
  };
6601
6524
  };
6602
6525
  /** @description Validation Error */
@@ -6610,27 +6533,29 @@ export interface operations {
6610
6533
  };
6611
6534
  };
6612
6535
  };
6613
- bulk_update_email_forwards_v1_email_forwards_bulk_update_patch: {
6536
+ update_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__put: {
6614
6537
  parameters: {
6615
6538
  query?: never;
6616
6539
  header?: never;
6617
- path?: never;
6540
+ path: {
6541
+ alias: string;
6542
+ /** @description DNS zone name (trailing dot optional) */
6543
+ zone_name: string;
6544
+ };
6618
6545
  cookie?: never;
6619
6546
  };
6620
6547
  requestBody: {
6621
6548
  content: {
6622
- "application/json": components["schemas"]["EmailForwardBulkUpdate"];
6549
+ "application/json": components["schemas"]["EmailForwardAliasUpdate"];
6623
6550
  };
6624
6551
  };
6625
6552
  responses: {
6626
6553
  /** @description Successful Response */
6627
- 200: {
6554
+ 201: {
6628
6555
  headers: {
6629
6556
  [name: string]: unknown;
6630
6557
  };
6631
- content: {
6632
- "application/json": components["schemas"]["BulkOperationResponse_EmailForwardBulkUpdateResult_"];
6633
- };
6558
+ content?: never;
6634
6559
  };
6635
6560
  /** @description Validation Error */
6636
6561
  422: {
@@ -6643,25 +6568,25 @@ export interface operations {
6643
6568
  };
6644
6569
  };
6645
6570
  };
6646
- get_email_forward_v1_email_forwards__email_forward_id__get: {
6571
+ delete_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__delete: {
6647
6572
  parameters: {
6648
6573
  query?: never;
6649
6574
  header?: never;
6650
6575
  path: {
6651
- email_forward_id: TypeID<"email_forward">;
6576
+ alias: string;
6577
+ /** @description DNS zone name (trailing dot optional) */
6578
+ zone_name: string;
6652
6579
  };
6653
6580
  cookie?: never;
6654
6581
  };
6655
6582
  requestBody?: never;
6656
6583
  responses: {
6657
6584
  /** @description Successful Response */
6658
- 200: {
6585
+ 204: {
6659
6586
  headers: {
6660
6587
  [name: string]: unknown;
6661
6588
  };
6662
- content: {
6663
- "application/json": components["schemas"]["EmailForward"];
6664
- };
6589
+ content?: never;
6665
6590
  };
6666
6591
  /** @description Validation Error */
6667
6592
  422: {
@@ -6674,12 +6599,13 @@ export interface operations {
6674
6599
  };
6675
6600
  };
6676
6601
  };
6677
- delete_email_forward_v1_email_forwards__email_forward_id__delete: {
6602
+ disable_email_forward_v1_email_forwards__zone_name__disable_patch: {
6678
6603
  parameters: {
6679
6604
  query?: never;
6680
6605
  header?: never;
6681
6606
  path: {
6682
- email_forward_id: TypeID<"email_forward">;
6607
+ /** @description DNS zone name (trailing dot optional) */
6608
+ zone_name: string;
6683
6609
  };
6684
6610
  cookie?: never;
6685
6611
  };
@@ -6703,29 +6629,24 @@ export interface operations {
6703
6629
  };
6704
6630
  };
6705
6631
  };
6706
- update_email_forward_v1_email_forwards__email_forward_id__patch: {
6632
+ enable_email_forward_v1_email_forwards__zone_name__enable_patch: {
6707
6633
  parameters: {
6708
6634
  query?: never;
6709
6635
  header?: never;
6710
6636
  path: {
6711
- email_forward_id: TypeID<"email_forward">;
6637
+ /** @description DNS zone name (trailing dot optional) */
6638
+ zone_name: string;
6712
6639
  };
6713
6640
  cookie?: never;
6714
6641
  };
6715
- requestBody: {
6716
- content: {
6717
- "application/json": components["schemas"]["EmailForwardUpdate"];
6718
- };
6719
- };
6642
+ requestBody?: never;
6720
6643
  responses: {
6721
6644
  /** @description Successful Response */
6722
- 200: {
6645
+ 204: {
6723
6646
  headers: {
6724
6647
  [name: string]: unknown;
6725
6648
  };
6726
- content: {
6727
- "application/json": components["schemas"]["EmailForward"];
6728
- };
6649
+ content?: never;
6729
6650
  };
6730
6651
  /** @description Validation Error */
6731
6652
  422: {