@opusdns/api 0.114.0 → 0.116.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/package.json +1 -1
- package/src/helpers/constants.ts +61 -1
- package/src/helpers/keys.ts +668 -0
- package/src/helpers/requests.d.ts +106 -0
- package/src/helpers/responses.d.ts +113 -1
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +64 -0
- package/src/openapi.yaml +340 -1
- package/src/schema.d.ts +253 -0
package/src/helpers/keys.ts
CHANGED
|
@@ -103,6 +103,8 @@ import { EmailForwardAlias } from './schemas';
|
|
|
103
103
|
import { EmailForwardAliasCreate } from './schemas';
|
|
104
104
|
import { EmailForwardAliasUpdate } from './schemas';
|
|
105
105
|
import { EmailForwardCreate } from './schemas';
|
|
106
|
+
import { EmailForwardLog } from './schemas';
|
|
107
|
+
import { EmailForwardLogEvent } from './schemas';
|
|
106
108
|
import { EmailForward } from './schemas';
|
|
107
109
|
import { EmailForwardZone } from './schemas';
|
|
108
110
|
import { EventResponse } from './schemas';
|
|
@@ -10624,6 +10626,672 @@ export const KEYS_EMAIL_FORWARD_CREATE = [
|
|
|
10624
10626
|
KEY_EMAIL_FORWARD_CREATE_HOSTNAME,
|
|
10625
10627
|
] as const satisfies (keyof EmailForwardCreate)[];
|
|
10626
10628
|
|
|
10629
|
+
/**
|
|
10630
|
+
* Created On
|
|
10631
|
+
*
|
|
10632
|
+
* Timestamp when email was received by ImprovMX
|
|
10633
|
+
*
|
|
10634
|
+
* @type {string}
|
|
10635
|
+
*
|
|
10636
|
+
*
|
|
10637
|
+
* @remarks
|
|
10638
|
+
* This key constant provides type-safe access to the `created_on` property of EmailForwardLog objects.
|
|
10639
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10640
|
+
*
|
|
10641
|
+
* @example
|
|
10642
|
+
* ```typescript
|
|
10643
|
+
* // Direct property access
|
|
10644
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_CREATED_ON];
|
|
10645
|
+
*
|
|
10646
|
+
* // Dynamic property access
|
|
10647
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_CREATED_ON;
|
|
10648
|
+
* const value = emailforwardlog[propertyName];
|
|
10649
|
+
* ```
|
|
10650
|
+
*
|
|
10651
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10652
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10653
|
+
*/
|
|
10654
|
+
export const KEY_EMAIL_FORWARD_LOG_CREATED_ON = 'created_on' as keyof EmailForwardLog;
|
|
10655
|
+
/**
|
|
10656
|
+
* Domain
|
|
10657
|
+
*
|
|
10658
|
+
* Domain name
|
|
10659
|
+
*
|
|
10660
|
+
* @type {string}
|
|
10661
|
+
*
|
|
10662
|
+
*
|
|
10663
|
+
* @remarks
|
|
10664
|
+
* This key constant provides type-safe access to the `domain` property of EmailForwardLog objects.
|
|
10665
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10666
|
+
*
|
|
10667
|
+
* @example
|
|
10668
|
+
* ```typescript
|
|
10669
|
+
* // Direct property access
|
|
10670
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_DOMAIN];
|
|
10671
|
+
*
|
|
10672
|
+
* // Dynamic property access
|
|
10673
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_DOMAIN;
|
|
10674
|
+
* const value = emailforwardlog[propertyName];
|
|
10675
|
+
* ```
|
|
10676
|
+
*
|
|
10677
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10678
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10679
|
+
*/
|
|
10680
|
+
export const KEY_EMAIL_FORWARD_LOG_DOMAIN = 'domain' as keyof EmailForwardLog;
|
|
10681
|
+
/**
|
|
10682
|
+
* Events
|
|
10683
|
+
*
|
|
10684
|
+
* List of processing events
|
|
10685
|
+
*
|
|
10686
|
+
* @type {array}
|
|
10687
|
+
*
|
|
10688
|
+
*
|
|
10689
|
+
* @remarks
|
|
10690
|
+
* This key constant provides type-safe access to the `events` property of EmailForwardLog objects.
|
|
10691
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10692
|
+
*
|
|
10693
|
+
* @example
|
|
10694
|
+
* ```typescript
|
|
10695
|
+
* // Direct property access
|
|
10696
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_EVENTS];
|
|
10697
|
+
*
|
|
10698
|
+
* // Dynamic property access
|
|
10699
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_EVENTS;
|
|
10700
|
+
* const value = emailforwardlog[propertyName];
|
|
10701
|
+
* ```
|
|
10702
|
+
*
|
|
10703
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10704
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10705
|
+
*/
|
|
10706
|
+
export const KEY_EMAIL_FORWARD_LOG_EVENTS = 'events' as keyof EmailForwardLog;
|
|
10707
|
+
/**
|
|
10708
|
+
* Final Status
|
|
10709
|
+
*
|
|
10710
|
+
* Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
|
|
10711
|
+
*
|
|
10712
|
+
* @type {string}
|
|
10713
|
+
*
|
|
10714
|
+
*
|
|
10715
|
+
* @remarks
|
|
10716
|
+
* This key constant provides type-safe access to the `final_status` property of EmailForwardLog objects.
|
|
10717
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10718
|
+
*
|
|
10719
|
+
* @example
|
|
10720
|
+
* ```typescript
|
|
10721
|
+
* // Direct property access
|
|
10722
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_FINAL_STATUS];
|
|
10723
|
+
*
|
|
10724
|
+
* // Dynamic property access
|
|
10725
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_FINAL_STATUS;
|
|
10726
|
+
* const value = emailforwardlog[propertyName];
|
|
10727
|
+
* ```
|
|
10728
|
+
*
|
|
10729
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10730
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10731
|
+
*/
|
|
10732
|
+
export const KEY_EMAIL_FORWARD_LOG_FINAL_STATUS = 'final_status' as keyof EmailForwardLog;
|
|
10733
|
+
/**
|
|
10734
|
+
* Forward Email
|
|
10735
|
+
*
|
|
10736
|
+
* Forward destination email address
|
|
10737
|
+
*
|
|
10738
|
+
* @type {string}
|
|
10739
|
+
*
|
|
10740
|
+
*
|
|
10741
|
+
* @remarks
|
|
10742
|
+
* This key constant provides type-safe access to the `forward_email` property of EmailForwardLog objects.
|
|
10743
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10744
|
+
*
|
|
10745
|
+
* @example
|
|
10746
|
+
* ```typescript
|
|
10747
|
+
* // Direct property access
|
|
10748
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_FORWARD_EMAIL];
|
|
10749
|
+
*
|
|
10750
|
+
* // Dynamic property access
|
|
10751
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_FORWARD_EMAIL;
|
|
10752
|
+
* const value = emailforwardlog[propertyName];
|
|
10753
|
+
* ```
|
|
10754
|
+
*
|
|
10755
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10756
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10757
|
+
*/
|
|
10758
|
+
export const KEY_EMAIL_FORWARD_LOG_FORWARD_EMAIL = 'forward_email' as keyof EmailForwardLog;
|
|
10759
|
+
/**
|
|
10760
|
+
* Forward Name
|
|
10761
|
+
*
|
|
10762
|
+
* Forward destination name
|
|
10763
|
+
*
|
|
10764
|
+
*
|
|
10765
|
+
*
|
|
10766
|
+
* @remarks
|
|
10767
|
+
* This key constant provides type-safe access to the `forward_name` property of EmailForwardLog objects.
|
|
10768
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10769
|
+
*
|
|
10770
|
+
* @example
|
|
10771
|
+
* ```typescript
|
|
10772
|
+
* // Direct property access
|
|
10773
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_FORWARD_NAME];
|
|
10774
|
+
*
|
|
10775
|
+
* // Dynamic property access
|
|
10776
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_FORWARD_NAME;
|
|
10777
|
+
* const value = emailforwardlog[propertyName];
|
|
10778
|
+
* ```
|
|
10779
|
+
*
|
|
10780
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10781
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10782
|
+
*/
|
|
10783
|
+
export const KEY_EMAIL_FORWARD_LOG_FORWARD_NAME = 'forward_name' as keyof EmailForwardLog;
|
|
10784
|
+
/**
|
|
10785
|
+
* Hostname
|
|
10786
|
+
*
|
|
10787
|
+
* Hostname that received the email
|
|
10788
|
+
*
|
|
10789
|
+
* @type {string}
|
|
10790
|
+
*
|
|
10791
|
+
*
|
|
10792
|
+
* @remarks
|
|
10793
|
+
* This key constant provides type-safe access to the `hostname` property of EmailForwardLog objects.
|
|
10794
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10795
|
+
*
|
|
10796
|
+
* @example
|
|
10797
|
+
* ```typescript
|
|
10798
|
+
* // Direct property access
|
|
10799
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_HOSTNAME];
|
|
10800
|
+
*
|
|
10801
|
+
* // Dynamic property access
|
|
10802
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_HOSTNAME;
|
|
10803
|
+
* const value = emailforwardlog[propertyName];
|
|
10804
|
+
* ```
|
|
10805
|
+
*
|
|
10806
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10807
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10808
|
+
*/
|
|
10809
|
+
export const KEY_EMAIL_FORWARD_LOG_HOSTNAME = 'hostname' as keyof EmailForwardLog;
|
|
10810
|
+
/**
|
|
10811
|
+
* Log Id
|
|
10812
|
+
*
|
|
10813
|
+
* Unique ID of the log from ImprovMX
|
|
10814
|
+
*
|
|
10815
|
+
* @type {string}
|
|
10816
|
+
*
|
|
10817
|
+
*
|
|
10818
|
+
* @remarks
|
|
10819
|
+
* This key constant provides type-safe access to the `log_id` property of EmailForwardLog objects.
|
|
10820
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10821
|
+
*
|
|
10822
|
+
* @example
|
|
10823
|
+
* ```typescript
|
|
10824
|
+
* // Direct property access
|
|
10825
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_LOG_ID];
|
|
10826
|
+
*
|
|
10827
|
+
* // Dynamic property access
|
|
10828
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_LOG_ID;
|
|
10829
|
+
* const value = emailforwardlog[propertyName];
|
|
10830
|
+
* ```
|
|
10831
|
+
*
|
|
10832
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10833
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10834
|
+
*/
|
|
10835
|
+
export const KEY_EMAIL_FORWARD_LOG_LOG_ID = 'log_id' as keyof EmailForwardLog;
|
|
10836
|
+
/**
|
|
10837
|
+
* Message Id
|
|
10838
|
+
*
|
|
10839
|
+
* Email message ID
|
|
10840
|
+
*
|
|
10841
|
+
* @type {string}
|
|
10842
|
+
*
|
|
10843
|
+
*
|
|
10844
|
+
* @remarks
|
|
10845
|
+
* This key constant provides type-safe access to the `message_id` property of EmailForwardLog objects.
|
|
10846
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10847
|
+
*
|
|
10848
|
+
* @example
|
|
10849
|
+
* ```typescript
|
|
10850
|
+
* // Direct property access
|
|
10851
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_MESSAGE_ID];
|
|
10852
|
+
*
|
|
10853
|
+
* // Dynamic property access
|
|
10854
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_MESSAGE_ID;
|
|
10855
|
+
* const value = emailforwardlog[propertyName];
|
|
10856
|
+
* ```
|
|
10857
|
+
*
|
|
10858
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10859
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10860
|
+
*/
|
|
10861
|
+
export const KEY_EMAIL_FORWARD_LOG_MESSAGE_ID = 'message_id' as keyof EmailForwardLog;
|
|
10862
|
+
/**
|
|
10863
|
+
* Recipient Email
|
|
10864
|
+
*
|
|
10865
|
+
* Recipient email address (the alias)
|
|
10866
|
+
*
|
|
10867
|
+
* @type {string}
|
|
10868
|
+
*
|
|
10869
|
+
*
|
|
10870
|
+
* @remarks
|
|
10871
|
+
* This key constant provides type-safe access to the `recipient_email` property of EmailForwardLog objects.
|
|
10872
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10873
|
+
*
|
|
10874
|
+
* @example
|
|
10875
|
+
* ```typescript
|
|
10876
|
+
* // Direct property access
|
|
10877
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_RECIPIENT_EMAIL];
|
|
10878
|
+
*
|
|
10879
|
+
* // Dynamic property access
|
|
10880
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_RECIPIENT_EMAIL;
|
|
10881
|
+
* const value = emailforwardlog[propertyName];
|
|
10882
|
+
* ```
|
|
10883
|
+
*
|
|
10884
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10885
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10886
|
+
*/
|
|
10887
|
+
export const KEY_EMAIL_FORWARD_LOG_RECIPIENT_EMAIL = 'recipient_email' as keyof EmailForwardLog;
|
|
10888
|
+
/**
|
|
10889
|
+
* Recipient Name
|
|
10890
|
+
*
|
|
10891
|
+
* Recipient name
|
|
10892
|
+
*
|
|
10893
|
+
*
|
|
10894
|
+
*
|
|
10895
|
+
* @remarks
|
|
10896
|
+
* This key constant provides type-safe access to the `recipient_name` property of EmailForwardLog objects.
|
|
10897
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10898
|
+
*
|
|
10899
|
+
* @example
|
|
10900
|
+
* ```typescript
|
|
10901
|
+
* // Direct property access
|
|
10902
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_RECIPIENT_NAME];
|
|
10903
|
+
*
|
|
10904
|
+
* // Dynamic property access
|
|
10905
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_RECIPIENT_NAME;
|
|
10906
|
+
* const value = emailforwardlog[propertyName];
|
|
10907
|
+
* ```
|
|
10908
|
+
*
|
|
10909
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10910
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10911
|
+
*/
|
|
10912
|
+
export const KEY_EMAIL_FORWARD_LOG_RECIPIENT_NAME = 'recipient_name' as keyof EmailForwardLog;
|
|
10913
|
+
/**
|
|
10914
|
+
* Sender Email
|
|
10915
|
+
*
|
|
10916
|
+
* Sender email address
|
|
10917
|
+
*
|
|
10918
|
+
* @type {string}
|
|
10919
|
+
*
|
|
10920
|
+
*
|
|
10921
|
+
* @remarks
|
|
10922
|
+
* This key constant provides type-safe access to the `sender_email` property of EmailForwardLog objects.
|
|
10923
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10924
|
+
*
|
|
10925
|
+
* @example
|
|
10926
|
+
* ```typescript
|
|
10927
|
+
* // Direct property access
|
|
10928
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_SENDER_EMAIL];
|
|
10929
|
+
*
|
|
10930
|
+
* // Dynamic property access
|
|
10931
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_SENDER_EMAIL;
|
|
10932
|
+
* const value = emailforwardlog[propertyName];
|
|
10933
|
+
* ```
|
|
10934
|
+
*
|
|
10935
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10936
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10937
|
+
*/
|
|
10938
|
+
export const KEY_EMAIL_FORWARD_LOG_SENDER_EMAIL = 'sender_email' as keyof EmailForwardLog;
|
|
10939
|
+
/**
|
|
10940
|
+
* Sender Name
|
|
10941
|
+
*
|
|
10942
|
+
* Sender name
|
|
10943
|
+
*
|
|
10944
|
+
*
|
|
10945
|
+
*
|
|
10946
|
+
* @remarks
|
|
10947
|
+
* This key constant provides type-safe access to the `sender_name` property of EmailForwardLog objects.
|
|
10948
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10949
|
+
*
|
|
10950
|
+
* @example
|
|
10951
|
+
* ```typescript
|
|
10952
|
+
* // Direct property access
|
|
10953
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_SENDER_NAME];
|
|
10954
|
+
*
|
|
10955
|
+
* // Dynamic property access
|
|
10956
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_SENDER_NAME;
|
|
10957
|
+
* const value = emailforwardlog[propertyName];
|
|
10958
|
+
* ```
|
|
10959
|
+
*
|
|
10960
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10961
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10962
|
+
*/
|
|
10963
|
+
export const KEY_EMAIL_FORWARD_LOG_SENDER_NAME = 'sender_name' as keyof EmailForwardLog;
|
|
10964
|
+
/**
|
|
10965
|
+
* Subject
|
|
10966
|
+
*
|
|
10967
|
+
* Email subject
|
|
10968
|
+
*
|
|
10969
|
+
* @type {string}
|
|
10970
|
+
*
|
|
10971
|
+
*
|
|
10972
|
+
* @remarks
|
|
10973
|
+
* This key constant provides type-safe access to the `subject` property of EmailForwardLog objects.
|
|
10974
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10975
|
+
*
|
|
10976
|
+
* @example
|
|
10977
|
+
* ```typescript
|
|
10978
|
+
* // Direct property access
|
|
10979
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_SUBJECT];
|
|
10980
|
+
*
|
|
10981
|
+
* // Dynamic property access
|
|
10982
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_SUBJECT;
|
|
10983
|
+
* const value = emailforwardlog[propertyName];
|
|
10984
|
+
* ```
|
|
10985
|
+
*
|
|
10986
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
10987
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
10988
|
+
*/
|
|
10989
|
+
export const KEY_EMAIL_FORWARD_LOG_SUBJECT = 'subject' as keyof EmailForwardLog;
|
|
10990
|
+
/**
|
|
10991
|
+
* Synced On
|
|
10992
|
+
*
|
|
10993
|
+
* Timestamp when record was synced to ClickHouse
|
|
10994
|
+
*
|
|
10995
|
+
* @type {string}
|
|
10996
|
+
*
|
|
10997
|
+
*
|
|
10998
|
+
* @remarks
|
|
10999
|
+
* This key constant provides type-safe access to the `synced_on` property of EmailForwardLog objects.
|
|
11000
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
11001
|
+
*
|
|
11002
|
+
* @example
|
|
11003
|
+
* ```typescript
|
|
11004
|
+
* // Direct property access
|
|
11005
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_SYNCED_ON];
|
|
11006
|
+
*
|
|
11007
|
+
* // Dynamic property access
|
|
11008
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_SYNCED_ON;
|
|
11009
|
+
* const value = emailforwardlog[propertyName];
|
|
11010
|
+
* ```
|
|
11011
|
+
*
|
|
11012
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
11013
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
11014
|
+
*/
|
|
11015
|
+
export const KEY_EMAIL_FORWARD_LOG_SYNCED_ON = 'synced_on' as keyof EmailForwardLog;
|
|
11016
|
+
/**
|
|
11017
|
+
* Transport
|
|
11018
|
+
*
|
|
11019
|
+
* Transport method (mx or smtp)
|
|
11020
|
+
*
|
|
11021
|
+
* @type {string}
|
|
11022
|
+
*
|
|
11023
|
+
*
|
|
11024
|
+
* @remarks
|
|
11025
|
+
* This key constant provides type-safe access to the `transport` property of EmailForwardLog objects.
|
|
11026
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
11027
|
+
*
|
|
11028
|
+
* @example
|
|
11029
|
+
* ```typescript
|
|
11030
|
+
* // Direct property access
|
|
11031
|
+
* const value = emailforwardlog[KEY_EMAIL_FORWARD_LOG_TRANSPORT];
|
|
11032
|
+
*
|
|
11033
|
+
* // Dynamic property access
|
|
11034
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_TRANSPORT;
|
|
11035
|
+
* const value = emailforwardlog[propertyName];
|
|
11036
|
+
* ```
|
|
11037
|
+
*
|
|
11038
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
11039
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG} - Array of all keys for this type
|
|
11040
|
+
*/
|
|
11041
|
+
export const KEY_EMAIL_FORWARD_LOG_TRANSPORT = 'transport' as keyof EmailForwardLog;
|
|
11042
|
+
|
|
11043
|
+
/**
|
|
11044
|
+
* Array of all EmailForwardLog property keys
|
|
11045
|
+
*
|
|
11046
|
+
* @remarks
|
|
11047
|
+
* This constant provides a readonly array containing all valid property keys for EmailForwardLog objects.
|
|
11048
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
11049
|
+
*
|
|
11050
|
+
* @example
|
|
11051
|
+
* ```typescript
|
|
11052
|
+
* // Iterating through all keys
|
|
11053
|
+
* for (const key of KEYS_EMAIL_FORWARD_LOG) {
|
|
11054
|
+
* console.log(`Property: ${key}, Value: ${emailforwardlog[key]}`);
|
|
11055
|
+
* }
|
|
11056
|
+
*
|
|
11057
|
+
* // Validation
|
|
11058
|
+
* const isValidKey = KEYS_EMAIL_FORWARD_LOG.includes(someKey);
|
|
11059
|
+
* ```
|
|
11060
|
+
*
|
|
11061
|
+
* @see {@link EmailForwardLog} - The TypeScript type definition
|
|
11062
|
+
*/
|
|
11063
|
+
export const KEYS_EMAIL_FORWARD_LOG = [
|
|
11064
|
+
KEY_EMAIL_FORWARD_LOG_CREATED_ON,
|
|
11065
|
+
KEY_EMAIL_FORWARD_LOG_DOMAIN,
|
|
11066
|
+
KEY_EMAIL_FORWARD_LOG_EVENTS,
|
|
11067
|
+
KEY_EMAIL_FORWARD_LOG_FINAL_STATUS,
|
|
11068
|
+
KEY_EMAIL_FORWARD_LOG_FORWARD_EMAIL,
|
|
11069
|
+
KEY_EMAIL_FORWARD_LOG_FORWARD_NAME,
|
|
11070
|
+
KEY_EMAIL_FORWARD_LOG_HOSTNAME,
|
|
11071
|
+
KEY_EMAIL_FORWARD_LOG_LOG_ID,
|
|
11072
|
+
KEY_EMAIL_FORWARD_LOG_MESSAGE_ID,
|
|
11073
|
+
KEY_EMAIL_FORWARD_LOG_RECIPIENT_EMAIL,
|
|
11074
|
+
KEY_EMAIL_FORWARD_LOG_RECIPIENT_NAME,
|
|
11075
|
+
KEY_EMAIL_FORWARD_LOG_SENDER_EMAIL,
|
|
11076
|
+
KEY_EMAIL_FORWARD_LOG_SENDER_NAME,
|
|
11077
|
+
KEY_EMAIL_FORWARD_LOG_SUBJECT,
|
|
11078
|
+
KEY_EMAIL_FORWARD_LOG_SYNCED_ON,
|
|
11079
|
+
KEY_EMAIL_FORWARD_LOG_TRANSPORT,
|
|
11080
|
+
] as const satisfies (keyof EmailForwardLog)[];
|
|
11081
|
+
|
|
11082
|
+
/**
|
|
11083
|
+
* Code
|
|
11084
|
+
*
|
|
11085
|
+
* Event status code
|
|
11086
|
+
*
|
|
11087
|
+
* @type {integer}
|
|
11088
|
+
*
|
|
11089
|
+
*
|
|
11090
|
+
* @remarks
|
|
11091
|
+
* This key constant provides type-safe access to the `code` property of EmailForwardLogEvent objects.
|
|
11092
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
11093
|
+
*
|
|
11094
|
+
* @example
|
|
11095
|
+
* ```typescript
|
|
11096
|
+
* // Direct property access
|
|
11097
|
+
* const value = emailforwardlogevent[KEY_EMAIL_FORWARD_LOG_EVENT_CODE];
|
|
11098
|
+
*
|
|
11099
|
+
* // Dynamic property access
|
|
11100
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_EVENT_CODE;
|
|
11101
|
+
* const value = emailforwardlogevent[propertyName];
|
|
11102
|
+
* ```
|
|
11103
|
+
*
|
|
11104
|
+
* @see {@link EmailForwardLogEvent} - The TypeScript type definition
|
|
11105
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG_EVENT} - Array of all keys for this type
|
|
11106
|
+
*/
|
|
11107
|
+
export const KEY_EMAIL_FORWARD_LOG_EVENT_CODE = 'code' as keyof EmailForwardLogEvent;
|
|
11108
|
+
/**
|
|
11109
|
+
* Created
|
|
11110
|
+
*
|
|
11111
|
+
* Timestamp when the event occurred
|
|
11112
|
+
*
|
|
11113
|
+
* @type {string}
|
|
11114
|
+
*
|
|
11115
|
+
*
|
|
11116
|
+
* @remarks
|
|
11117
|
+
* This key constant provides type-safe access to the `created` property of EmailForwardLogEvent objects.
|
|
11118
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
11119
|
+
*
|
|
11120
|
+
* @example
|
|
11121
|
+
* ```typescript
|
|
11122
|
+
* // Direct property access
|
|
11123
|
+
* const value = emailforwardlogevent[KEY_EMAIL_FORWARD_LOG_EVENT_CREATED];
|
|
11124
|
+
*
|
|
11125
|
+
* // Dynamic property access
|
|
11126
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_EVENT_CREATED;
|
|
11127
|
+
* const value = emailforwardlogevent[propertyName];
|
|
11128
|
+
* ```
|
|
11129
|
+
*
|
|
11130
|
+
* @see {@link EmailForwardLogEvent} - The TypeScript type definition
|
|
11131
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG_EVENT} - Array of all keys for this type
|
|
11132
|
+
*/
|
|
11133
|
+
export const KEY_EMAIL_FORWARD_LOG_EVENT_CREATED = 'created' as keyof EmailForwardLogEvent;
|
|
11134
|
+
/**
|
|
11135
|
+
* Id
|
|
11136
|
+
*
|
|
11137
|
+
* Event ID
|
|
11138
|
+
*
|
|
11139
|
+
* @type {string}
|
|
11140
|
+
*
|
|
11141
|
+
*
|
|
11142
|
+
* @remarks
|
|
11143
|
+
* This key constant provides type-safe access to the `id` property of EmailForwardLogEvent objects.
|
|
11144
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
11145
|
+
*
|
|
11146
|
+
* @example
|
|
11147
|
+
* ```typescript
|
|
11148
|
+
* // Direct property access
|
|
11149
|
+
* const value = emailforwardlogevent[KEY_EMAIL_FORWARD_LOG_EVENT_ID];
|
|
11150
|
+
*
|
|
11151
|
+
* // Dynamic property access
|
|
11152
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_EVENT_ID;
|
|
11153
|
+
* const value = emailforwardlogevent[propertyName];
|
|
11154
|
+
* ```
|
|
11155
|
+
*
|
|
11156
|
+
* @see {@link EmailForwardLogEvent} - The TypeScript type definition
|
|
11157
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG_EVENT} - Array of all keys for this type
|
|
11158
|
+
*/
|
|
11159
|
+
export const KEY_EMAIL_FORWARD_LOG_EVENT_ID = 'id' as keyof EmailForwardLogEvent;
|
|
11160
|
+
/**
|
|
11161
|
+
* Local
|
|
11162
|
+
*
|
|
11163
|
+
* ImprovMX server that processed the event
|
|
11164
|
+
*
|
|
11165
|
+
* @type {string}
|
|
11166
|
+
*
|
|
11167
|
+
*
|
|
11168
|
+
* @remarks
|
|
11169
|
+
* This key constant provides type-safe access to the `local` property of EmailForwardLogEvent objects.
|
|
11170
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
11171
|
+
*
|
|
11172
|
+
* @example
|
|
11173
|
+
* ```typescript
|
|
11174
|
+
* // Direct property access
|
|
11175
|
+
* const value = emailforwardlogevent[KEY_EMAIL_FORWARD_LOG_EVENT_LOCAL];
|
|
11176
|
+
*
|
|
11177
|
+
* // Dynamic property access
|
|
11178
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_EVENT_LOCAL;
|
|
11179
|
+
* const value = emailforwardlogevent[propertyName];
|
|
11180
|
+
* ```
|
|
11181
|
+
*
|
|
11182
|
+
* @see {@link EmailForwardLogEvent} - The TypeScript type definition
|
|
11183
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG_EVENT} - Array of all keys for this type
|
|
11184
|
+
*/
|
|
11185
|
+
export const KEY_EMAIL_FORWARD_LOG_EVENT_LOCAL = 'local' as keyof EmailForwardLogEvent;
|
|
11186
|
+
/**
|
|
11187
|
+
* Message
|
|
11188
|
+
*
|
|
11189
|
+
* Event message
|
|
11190
|
+
*
|
|
11191
|
+
* @type {string}
|
|
11192
|
+
*
|
|
11193
|
+
*
|
|
11194
|
+
* @remarks
|
|
11195
|
+
* This key constant provides type-safe access to the `message` property of EmailForwardLogEvent objects.
|
|
11196
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
11197
|
+
*
|
|
11198
|
+
* @example
|
|
11199
|
+
* ```typescript
|
|
11200
|
+
* // Direct property access
|
|
11201
|
+
* const value = emailforwardlogevent[KEY_EMAIL_FORWARD_LOG_EVENT_MESSAGE];
|
|
11202
|
+
*
|
|
11203
|
+
* // Dynamic property access
|
|
11204
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_EVENT_MESSAGE;
|
|
11205
|
+
* const value = emailforwardlogevent[propertyName];
|
|
11206
|
+
* ```
|
|
11207
|
+
*
|
|
11208
|
+
* @see {@link EmailForwardLogEvent} - The TypeScript type definition
|
|
11209
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG_EVENT} - Array of all keys for this type
|
|
11210
|
+
*/
|
|
11211
|
+
export const KEY_EMAIL_FORWARD_LOG_EVENT_MESSAGE = 'message' as keyof EmailForwardLogEvent;
|
|
11212
|
+
/**
|
|
11213
|
+
* Server
|
|
11214
|
+
*
|
|
11215
|
+
* Server that processed the event
|
|
11216
|
+
*
|
|
11217
|
+
* @type {string}
|
|
11218
|
+
*
|
|
11219
|
+
*
|
|
11220
|
+
* @remarks
|
|
11221
|
+
* This key constant provides type-safe access to the `server` property of EmailForwardLogEvent objects.
|
|
11222
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
11223
|
+
*
|
|
11224
|
+
* @example
|
|
11225
|
+
* ```typescript
|
|
11226
|
+
* // Direct property access
|
|
11227
|
+
* const value = emailforwardlogevent[KEY_EMAIL_FORWARD_LOG_EVENT_SERVER];
|
|
11228
|
+
*
|
|
11229
|
+
* // Dynamic property access
|
|
11230
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_EVENT_SERVER;
|
|
11231
|
+
* const value = emailforwardlogevent[propertyName];
|
|
11232
|
+
* ```
|
|
11233
|
+
*
|
|
11234
|
+
* @see {@link EmailForwardLogEvent} - The TypeScript type definition
|
|
11235
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG_EVENT} - Array of all keys for this type
|
|
11236
|
+
*/
|
|
11237
|
+
export const KEY_EMAIL_FORWARD_LOG_EVENT_SERVER = 'server' as keyof EmailForwardLogEvent;
|
|
11238
|
+
/**
|
|
11239
|
+
* Status
|
|
11240
|
+
*
|
|
11241
|
+
* Event status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
|
|
11242
|
+
*
|
|
11243
|
+
* @type {string}
|
|
11244
|
+
*
|
|
11245
|
+
*
|
|
11246
|
+
* @remarks
|
|
11247
|
+
* This key constant provides type-safe access to the `status` property of EmailForwardLogEvent objects.
|
|
11248
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
11249
|
+
*
|
|
11250
|
+
* @example
|
|
11251
|
+
* ```typescript
|
|
11252
|
+
* // Direct property access
|
|
11253
|
+
* const value = emailforwardlogevent[KEY_EMAIL_FORWARD_LOG_EVENT_STATUS];
|
|
11254
|
+
*
|
|
11255
|
+
* // Dynamic property access
|
|
11256
|
+
* const propertyName = KEY_EMAIL_FORWARD_LOG_EVENT_STATUS;
|
|
11257
|
+
* const value = emailforwardlogevent[propertyName];
|
|
11258
|
+
* ```
|
|
11259
|
+
*
|
|
11260
|
+
* @see {@link EmailForwardLogEvent} - The TypeScript type definition
|
|
11261
|
+
* @see {@link KEYS_EMAIL_FORWARD_LOG_EVENT} - Array of all keys for this type
|
|
11262
|
+
*/
|
|
11263
|
+
export const KEY_EMAIL_FORWARD_LOG_EVENT_STATUS = 'status' as keyof EmailForwardLogEvent;
|
|
11264
|
+
|
|
11265
|
+
/**
|
|
11266
|
+
* Array of all EmailForwardLogEvent property keys
|
|
11267
|
+
*
|
|
11268
|
+
* @remarks
|
|
11269
|
+
* This constant provides a readonly array containing all valid property keys for EmailForwardLogEvent objects.
|
|
11270
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
11271
|
+
*
|
|
11272
|
+
* @example
|
|
11273
|
+
* ```typescript
|
|
11274
|
+
* // Iterating through all keys
|
|
11275
|
+
* for (const key of KEYS_EMAIL_FORWARD_LOG_EVENT) {
|
|
11276
|
+
* console.log(`Property: ${key}, Value: ${emailforwardlogevent[key]}`);
|
|
11277
|
+
* }
|
|
11278
|
+
*
|
|
11279
|
+
* // Validation
|
|
11280
|
+
* const isValidKey = KEYS_EMAIL_FORWARD_LOG_EVENT.includes(someKey);
|
|
11281
|
+
* ```
|
|
11282
|
+
*
|
|
11283
|
+
* @see {@link EmailForwardLogEvent} - The TypeScript type definition
|
|
11284
|
+
*/
|
|
11285
|
+
export const KEYS_EMAIL_FORWARD_LOG_EVENT = [
|
|
11286
|
+
KEY_EMAIL_FORWARD_LOG_EVENT_CODE,
|
|
11287
|
+
KEY_EMAIL_FORWARD_LOG_EVENT_CREATED,
|
|
11288
|
+
KEY_EMAIL_FORWARD_LOG_EVENT_ID,
|
|
11289
|
+
KEY_EMAIL_FORWARD_LOG_EVENT_LOCAL,
|
|
11290
|
+
KEY_EMAIL_FORWARD_LOG_EVENT_MESSAGE,
|
|
11291
|
+
KEY_EMAIL_FORWARD_LOG_EVENT_SERVER,
|
|
11292
|
+
KEY_EMAIL_FORWARD_LOG_EVENT_STATUS,
|
|
11293
|
+
] as const satisfies (keyof EmailForwardLogEvent)[];
|
|
11294
|
+
|
|
10627
11295
|
/**
|
|
10628
11296
|
* Aliases
|
|
10629
11297
|
*
|