@opusdns/api 0.305.0 → 0.306.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 +255 -1
- package/src/helpers/keys.ts +428 -0
- package/src/helpers/requests.d.ts +54 -1
- package/src/helpers/responses.d.ts +111 -1
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +128 -0
- package/src/openapi.yaml +268 -4
- package/src/schema.d.ts +155 -0
package/src/helpers/keys.ts
CHANGED
|
@@ -40,6 +40,9 @@ import { ClaimsNotice } from './schemas';
|
|
|
40
40
|
import { ClaimsNoticesRequest } from './schemas';
|
|
41
41
|
import { ClaimsNotices } from './schemas';
|
|
42
42
|
import { CommandError } from './schemas';
|
|
43
|
+
import { ContactAttestReq } from './schemas';
|
|
44
|
+
import { ContactAttestRes } from './schemas';
|
|
45
|
+
import { ContactAttestVerificationReq } from './schemas';
|
|
43
46
|
import { ContactAttributeDefinition } from './schemas';
|
|
44
47
|
import { ContactAttributeLinkDetail } from './schemas';
|
|
45
48
|
import { ContactAttributeLink } from './schemas';
|
|
@@ -62,6 +65,7 @@ import { ContactSchema } from './schemas';
|
|
|
62
65
|
import { ContactVerificationApi } from './schemas';
|
|
63
66
|
import { ContactVerificationEmail } from './schemas';
|
|
64
67
|
import { ContactVerification } from './schemas';
|
|
68
|
+
import { ContactVerificationStatus } from './schemas';
|
|
65
69
|
import { ContactsBase } from './schemas';
|
|
66
70
|
import { Context } from './schemas';
|
|
67
71
|
import { ContextCreateRequest } from './schemas';
|
|
@@ -2009,6 +2013,231 @@ export const KEYS_COMMAND_ERROR = [
|
|
|
2009
2013
|
KEY_COMMAND_ERROR_TYPE,
|
|
2010
2014
|
] as const satisfies (keyof CommandError)[];
|
|
2011
2015
|
|
|
2016
|
+
/**
|
|
2017
|
+
* Attestations
|
|
2018
|
+
*
|
|
2019
|
+
*
|
|
2020
|
+
* @type {array}
|
|
2021
|
+
*
|
|
2022
|
+
*
|
|
2023
|
+
* @remarks
|
|
2024
|
+
* This key constant provides type-safe access to the `attestations` property of ContactAttestReq objects.
|
|
2025
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2026
|
+
*
|
|
2027
|
+
* @example
|
|
2028
|
+
* ```typescript
|
|
2029
|
+
* // Direct property access
|
|
2030
|
+
* const value = contactattestreq[KEY_CONTACT_ATTEST_REQ_ATTESTATIONS];
|
|
2031
|
+
*
|
|
2032
|
+
* // Dynamic property access
|
|
2033
|
+
* const propertyName = KEY_CONTACT_ATTEST_REQ_ATTESTATIONS;
|
|
2034
|
+
* const value = contactattestreq[propertyName];
|
|
2035
|
+
* ```
|
|
2036
|
+
*
|
|
2037
|
+
* @see {@link ContactAttestReq} - The TypeScript type definition
|
|
2038
|
+
* @see {@link KEYS_CONTACT_ATTEST_REQ} - Array of all keys for this type
|
|
2039
|
+
*/
|
|
2040
|
+
export const KEY_CONTACT_ATTEST_REQ_ATTESTATIONS: keyof ContactAttestReq = 'attestations';
|
|
2041
|
+
|
|
2042
|
+
/**
|
|
2043
|
+
* Array of all ContactAttestReq property keys
|
|
2044
|
+
*
|
|
2045
|
+
* @remarks
|
|
2046
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttestReq objects.
|
|
2047
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2048
|
+
*
|
|
2049
|
+
* @example
|
|
2050
|
+
* ```typescript
|
|
2051
|
+
* // Iterating through all keys
|
|
2052
|
+
* for (const key of KEYS_CONTACT_ATTEST_REQ) {
|
|
2053
|
+
* console.log(`Property: ${key}, Value: ${contactattestreq[key]}`);
|
|
2054
|
+
* }
|
|
2055
|
+
*
|
|
2056
|
+
* // Validation
|
|
2057
|
+
* const isValidKey = KEYS_CONTACT_ATTEST_REQ.includes(someKey);
|
|
2058
|
+
* ```
|
|
2059
|
+
*
|
|
2060
|
+
* @see {@link ContactAttestReq} - The TypeScript type definition
|
|
2061
|
+
*/
|
|
2062
|
+
export const KEYS_CONTACT_ATTEST_REQ = [
|
|
2063
|
+
KEY_CONTACT_ATTEST_REQ_ATTESTATIONS,
|
|
2064
|
+
] as const satisfies (keyof ContactAttestReq)[];
|
|
2065
|
+
|
|
2066
|
+
/**
|
|
2067
|
+
* Verifications
|
|
2068
|
+
*
|
|
2069
|
+
*
|
|
2070
|
+
* @type {array}
|
|
2071
|
+
*
|
|
2072
|
+
*
|
|
2073
|
+
* @remarks
|
|
2074
|
+
* This key constant provides type-safe access to the `verifications` property of ContactAttestRes objects.
|
|
2075
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2076
|
+
*
|
|
2077
|
+
* @example
|
|
2078
|
+
* ```typescript
|
|
2079
|
+
* // Direct property access
|
|
2080
|
+
* const value = contactattestres[KEY_CONTACT_ATTEST_RES_VERIFICATIONS];
|
|
2081
|
+
*
|
|
2082
|
+
* // Dynamic property access
|
|
2083
|
+
* const propertyName = KEY_CONTACT_ATTEST_RES_VERIFICATIONS;
|
|
2084
|
+
* const value = contactattestres[propertyName];
|
|
2085
|
+
* ```
|
|
2086
|
+
*
|
|
2087
|
+
* @see {@link ContactAttestRes} - The TypeScript type definition
|
|
2088
|
+
* @see {@link KEYS_CONTACT_ATTEST_RES} - Array of all keys for this type
|
|
2089
|
+
*/
|
|
2090
|
+
export const KEY_CONTACT_ATTEST_RES_VERIFICATIONS: keyof ContactAttestRes = 'verifications';
|
|
2091
|
+
|
|
2092
|
+
/**
|
|
2093
|
+
* Array of all ContactAttestRes property keys
|
|
2094
|
+
*
|
|
2095
|
+
* @remarks
|
|
2096
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttestRes objects.
|
|
2097
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2098
|
+
*
|
|
2099
|
+
* @example
|
|
2100
|
+
* ```typescript
|
|
2101
|
+
* // Iterating through all keys
|
|
2102
|
+
* for (const key of KEYS_CONTACT_ATTEST_RES) {
|
|
2103
|
+
* console.log(`Property: ${key}, Value: ${contactattestres[key]}`);
|
|
2104
|
+
* }
|
|
2105
|
+
*
|
|
2106
|
+
* // Validation
|
|
2107
|
+
* const isValidKey = KEYS_CONTACT_ATTEST_RES.includes(someKey);
|
|
2108
|
+
* ```
|
|
2109
|
+
*
|
|
2110
|
+
* @see {@link ContactAttestRes} - The TypeScript type definition
|
|
2111
|
+
*/
|
|
2112
|
+
export const KEYS_CONTACT_ATTEST_RES = [
|
|
2113
|
+
KEY_CONTACT_ATTEST_RES_VERIFICATIONS,
|
|
2114
|
+
] as const satisfies (keyof ContactAttestRes)[];
|
|
2115
|
+
|
|
2116
|
+
/**
|
|
2117
|
+
* Attestation Reference
|
|
2118
|
+
*
|
|
2119
|
+
*
|
|
2120
|
+
* @type {string}
|
|
2121
|
+
*
|
|
2122
|
+
*
|
|
2123
|
+
* @remarks
|
|
2124
|
+
* This key constant provides type-safe access to the `attestation_reference` property of ContactAttestVerificationReq objects.
|
|
2125
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2126
|
+
*
|
|
2127
|
+
* @example
|
|
2128
|
+
* ```typescript
|
|
2129
|
+
* // Direct property access
|
|
2130
|
+
* const value = contactattestverificationreq[KEY_CONTACT_ATTEST_VERIFICATION_REQ_ATTESTATION_REFERENCE];
|
|
2131
|
+
*
|
|
2132
|
+
* // Dynamic property access
|
|
2133
|
+
* const propertyName = KEY_CONTACT_ATTEST_VERIFICATION_REQ_ATTESTATION_REFERENCE;
|
|
2134
|
+
* const value = contactattestverificationreq[propertyName];
|
|
2135
|
+
* ```
|
|
2136
|
+
*
|
|
2137
|
+
* @see {@link ContactAttestVerificationReq} - The TypeScript type definition
|
|
2138
|
+
* @see {@link KEYS_CONTACT_ATTEST_VERIFICATION_REQ} - Array of all keys for this type
|
|
2139
|
+
*/
|
|
2140
|
+
export const KEY_CONTACT_ATTEST_VERIFICATION_REQ_ATTESTATION_REFERENCE: keyof ContactAttestVerificationReq = 'attestation_reference';
|
|
2141
|
+
/**
|
|
2142
|
+
* claim property
|
|
2143
|
+
*
|
|
2144
|
+
*
|
|
2145
|
+
*
|
|
2146
|
+
*
|
|
2147
|
+
* @remarks
|
|
2148
|
+
* This key constant provides type-safe access to the `claim` property of ContactAttestVerificationReq objects.
|
|
2149
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2150
|
+
*
|
|
2151
|
+
* @example
|
|
2152
|
+
* ```typescript
|
|
2153
|
+
* // Direct property access
|
|
2154
|
+
* const value = contactattestverificationreq[KEY_CONTACT_ATTEST_VERIFICATION_REQ_CLAIM];
|
|
2155
|
+
*
|
|
2156
|
+
* // Dynamic property access
|
|
2157
|
+
* const propertyName = KEY_CONTACT_ATTEST_VERIFICATION_REQ_CLAIM;
|
|
2158
|
+
* const value = contactattestverificationreq[propertyName];
|
|
2159
|
+
* ```
|
|
2160
|
+
*
|
|
2161
|
+
* @see {@link ContactAttestVerificationReq} - The TypeScript type definition
|
|
2162
|
+
* @see {@link KEYS_CONTACT_ATTEST_VERIFICATION_REQ} - Array of all keys for this type
|
|
2163
|
+
*/
|
|
2164
|
+
export const KEY_CONTACT_ATTEST_VERIFICATION_REQ_CLAIM: keyof ContactAttestVerificationReq = 'claim';
|
|
2165
|
+
/**
|
|
2166
|
+
* method property
|
|
2167
|
+
*
|
|
2168
|
+
*
|
|
2169
|
+
*
|
|
2170
|
+
*
|
|
2171
|
+
* @remarks
|
|
2172
|
+
* This key constant provides type-safe access to the `method` property of ContactAttestVerificationReq objects.
|
|
2173
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2174
|
+
*
|
|
2175
|
+
* @example
|
|
2176
|
+
* ```typescript
|
|
2177
|
+
* // Direct property access
|
|
2178
|
+
* const value = contactattestverificationreq[KEY_CONTACT_ATTEST_VERIFICATION_REQ_METHOD];
|
|
2179
|
+
*
|
|
2180
|
+
* // Dynamic property access
|
|
2181
|
+
* const propertyName = KEY_CONTACT_ATTEST_VERIFICATION_REQ_METHOD;
|
|
2182
|
+
* const value = contactattestverificationreq[propertyName];
|
|
2183
|
+
* ```
|
|
2184
|
+
*
|
|
2185
|
+
* @see {@link ContactAttestVerificationReq} - The TypeScript type definition
|
|
2186
|
+
* @see {@link KEYS_CONTACT_ATTEST_VERIFICATION_REQ} - Array of all keys for this type
|
|
2187
|
+
*/
|
|
2188
|
+
export const KEY_CONTACT_ATTEST_VERIFICATION_REQ_METHOD: keyof ContactAttestVerificationReq = 'method';
|
|
2189
|
+
/**
|
|
2190
|
+
* proof property
|
|
2191
|
+
*
|
|
2192
|
+
*
|
|
2193
|
+
*
|
|
2194
|
+
*
|
|
2195
|
+
* @remarks
|
|
2196
|
+
* This key constant provides type-safe access to the `proof` property of ContactAttestVerificationReq objects.
|
|
2197
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2198
|
+
*
|
|
2199
|
+
* @example
|
|
2200
|
+
* ```typescript
|
|
2201
|
+
* // Direct property access
|
|
2202
|
+
* const value = contactattestverificationreq[KEY_CONTACT_ATTEST_VERIFICATION_REQ_PROOF];
|
|
2203
|
+
*
|
|
2204
|
+
* // Dynamic property access
|
|
2205
|
+
* const propertyName = KEY_CONTACT_ATTEST_VERIFICATION_REQ_PROOF;
|
|
2206
|
+
* const value = contactattestverificationreq[propertyName];
|
|
2207
|
+
* ```
|
|
2208
|
+
*
|
|
2209
|
+
* @see {@link ContactAttestVerificationReq} - The TypeScript type definition
|
|
2210
|
+
* @see {@link KEYS_CONTACT_ATTEST_VERIFICATION_REQ} - Array of all keys for this type
|
|
2211
|
+
*/
|
|
2212
|
+
export const KEY_CONTACT_ATTEST_VERIFICATION_REQ_PROOF: keyof ContactAttestVerificationReq = 'proof';
|
|
2213
|
+
|
|
2214
|
+
/**
|
|
2215
|
+
* Array of all ContactAttestVerificationReq property keys
|
|
2216
|
+
*
|
|
2217
|
+
* @remarks
|
|
2218
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttestVerificationReq objects.
|
|
2219
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2220
|
+
*
|
|
2221
|
+
* @example
|
|
2222
|
+
* ```typescript
|
|
2223
|
+
* // Iterating through all keys
|
|
2224
|
+
* for (const key of KEYS_CONTACT_ATTEST_VERIFICATION_REQ) {
|
|
2225
|
+
* console.log(`Property: ${key}, Value: ${contactattestverificationreq[key]}`);
|
|
2226
|
+
* }
|
|
2227
|
+
*
|
|
2228
|
+
* // Validation
|
|
2229
|
+
* const isValidKey = KEYS_CONTACT_ATTEST_VERIFICATION_REQ.includes(someKey);
|
|
2230
|
+
* ```
|
|
2231
|
+
*
|
|
2232
|
+
* @see {@link ContactAttestVerificationReq} - The TypeScript type definition
|
|
2233
|
+
*/
|
|
2234
|
+
export const KEYS_CONTACT_ATTEST_VERIFICATION_REQ = [
|
|
2235
|
+
KEY_CONTACT_ATTEST_VERIFICATION_REQ_ATTESTATION_REFERENCE,
|
|
2236
|
+
KEY_CONTACT_ATTEST_VERIFICATION_REQ_CLAIM,
|
|
2237
|
+
KEY_CONTACT_ATTEST_VERIFICATION_REQ_METHOD,
|
|
2238
|
+
KEY_CONTACT_ATTEST_VERIFICATION_REQ_PROOF,
|
|
2239
|
+
] as const satisfies (keyof ContactAttestVerificationReq)[];
|
|
2240
|
+
|
|
2012
2241
|
/**
|
|
2013
2242
|
* Conditions
|
|
2014
2243
|
*
|
|
@@ -6549,6 +6778,205 @@ export const KEYS_CONTACT_VERIFICATION = [
|
|
|
6549
6778
|
KEY_CONTACT_VERIFICATION_VERIFIED_ON,
|
|
6550
6779
|
] as const satisfies (keyof ContactVerification)[];
|
|
6551
6780
|
|
|
6781
|
+
/**
|
|
6782
|
+
* Attestation Reference
|
|
6783
|
+
*
|
|
6784
|
+
*
|
|
6785
|
+
*
|
|
6786
|
+
*
|
|
6787
|
+
* @remarks
|
|
6788
|
+
* This key constant provides type-safe access to the `attestation_reference` property of ContactVerificationStatus objects.
|
|
6789
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6790
|
+
*
|
|
6791
|
+
* @example
|
|
6792
|
+
* ```typescript
|
|
6793
|
+
* // Direct property access
|
|
6794
|
+
* const value = contactverificationstatus[KEY_CONTACT_VERIFICATION_STATUS_ATTESTATION_REFERENCE];
|
|
6795
|
+
*
|
|
6796
|
+
* // Dynamic property access
|
|
6797
|
+
* const propertyName = KEY_CONTACT_VERIFICATION_STATUS_ATTESTATION_REFERENCE;
|
|
6798
|
+
* const value = contactverificationstatus[propertyName];
|
|
6799
|
+
* ```
|
|
6800
|
+
*
|
|
6801
|
+
* @see {@link ContactVerificationStatus} - The TypeScript type definition
|
|
6802
|
+
* @see {@link KEYS_CONTACT_VERIFICATION_STATUS} - Array of all keys for this type
|
|
6803
|
+
*/
|
|
6804
|
+
export const KEY_CONTACT_VERIFICATION_STATUS_ATTESTATION_REFERENCE: keyof ContactVerificationStatus = 'attestation_reference';
|
|
6805
|
+
/**
|
|
6806
|
+
* claim property
|
|
6807
|
+
*
|
|
6808
|
+
*
|
|
6809
|
+
*
|
|
6810
|
+
*
|
|
6811
|
+
* @remarks
|
|
6812
|
+
* This key constant provides type-safe access to the `claim` property of ContactVerificationStatus objects.
|
|
6813
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6814
|
+
*
|
|
6815
|
+
* @example
|
|
6816
|
+
* ```typescript
|
|
6817
|
+
* // Direct property access
|
|
6818
|
+
* const value = contactverificationstatus[KEY_CONTACT_VERIFICATION_STATUS_CLAIM];
|
|
6819
|
+
*
|
|
6820
|
+
* // Dynamic property access
|
|
6821
|
+
* const propertyName = KEY_CONTACT_VERIFICATION_STATUS_CLAIM;
|
|
6822
|
+
* const value = contactverificationstatus[propertyName];
|
|
6823
|
+
* ```
|
|
6824
|
+
*
|
|
6825
|
+
* @see {@link ContactVerificationStatus} - The TypeScript type definition
|
|
6826
|
+
* @see {@link KEYS_CONTACT_VERIFICATION_STATUS} - Array of all keys for this type
|
|
6827
|
+
*/
|
|
6828
|
+
export const KEY_CONTACT_VERIFICATION_STATUS_CLAIM: keyof ContactVerificationStatus = 'claim';
|
|
6829
|
+
/**
|
|
6830
|
+
* Expires On
|
|
6831
|
+
*
|
|
6832
|
+
*
|
|
6833
|
+
*
|
|
6834
|
+
*
|
|
6835
|
+
* @remarks
|
|
6836
|
+
* This key constant provides type-safe access to the `expires_on` property of ContactVerificationStatus objects.
|
|
6837
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6838
|
+
*
|
|
6839
|
+
* @example
|
|
6840
|
+
* ```typescript
|
|
6841
|
+
* // Direct property access
|
|
6842
|
+
* const value = contactverificationstatus[KEY_CONTACT_VERIFICATION_STATUS_EXPIRES_ON];
|
|
6843
|
+
*
|
|
6844
|
+
* // Dynamic property access
|
|
6845
|
+
* const propertyName = KEY_CONTACT_VERIFICATION_STATUS_EXPIRES_ON;
|
|
6846
|
+
* const value = contactverificationstatus[propertyName];
|
|
6847
|
+
* ```
|
|
6848
|
+
*
|
|
6849
|
+
* @see {@link ContactVerificationStatus} - The TypeScript type definition
|
|
6850
|
+
* @see {@link KEYS_CONTACT_VERIFICATION_STATUS} - Array of all keys for this type
|
|
6851
|
+
*/
|
|
6852
|
+
export const KEY_CONTACT_VERIFICATION_STATUS_EXPIRES_ON: keyof ContactVerificationStatus = 'expires_on';
|
|
6853
|
+
/**
|
|
6854
|
+
* method property
|
|
6855
|
+
*
|
|
6856
|
+
*
|
|
6857
|
+
*
|
|
6858
|
+
*
|
|
6859
|
+
* @remarks
|
|
6860
|
+
* This key constant provides type-safe access to the `method` property of ContactVerificationStatus objects.
|
|
6861
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6862
|
+
*
|
|
6863
|
+
* @example
|
|
6864
|
+
* ```typescript
|
|
6865
|
+
* // Direct property access
|
|
6866
|
+
* const value = contactverificationstatus[KEY_CONTACT_VERIFICATION_STATUS_METHOD];
|
|
6867
|
+
*
|
|
6868
|
+
* // Dynamic property access
|
|
6869
|
+
* const propertyName = KEY_CONTACT_VERIFICATION_STATUS_METHOD;
|
|
6870
|
+
* const value = contactverificationstatus[propertyName];
|
|
6871
|
+
* ```
|
|
6872
|
+
*
|
|
6873
|
+
* @see {@link ContactVerificationStatus} - The TypeScript type definition
|
|
6874
|
+
* @see {@link KEYS_CONTACT_VERIFICATION_STATUS} - Array of all keys for this type
|
|
6875
|
+
*/
|
|
6876
|
+
export const KEY_CONTACT_VERIFICATION_STATUS_METHOD: keyof ContactVerificationStatus = 'method';
|
|
6877
|
+
/**
|
|
6878
|
+
* proof property
|
|
6879
|
+
*
|
|
6880
|
+
*
|
|
6881
|
+
*
|
|
6882
|
+
*
|
|
6883
|
+
* @remarks
|
|
6884
|
+
* This key constant provides type-safe access to the `proof` property of ContactVerificationStatus objects.
|
|
6885
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6886
|
+
*
|
|
6887
|
+
* @example
|
|
6888
|
+
* ```typescript
|
|
6889
|
+
* // Direct property access
|
|
6890
|
+
* const value = contactverificationstatus[KEY_CONTACT_VERIFICATION_STATUS_PROOF];
|
|
6891
|
+
*
|
|
6892
|
+
* // Dynamic property access
|
|
6893
|
+
* const propertyName = KEY_CONTACT_VERIFICATION_STATUS_PROOF;
|
|
6894
|
+
* const value = contactverificationstatus[propertyName];
|
|
6895
|
+
* ```
|
|
6896
|
+
*
|
|
6897
|
+
* @see {@link ContactVerificationStatus} - The TypeScript type definition
|
|
6898
|
+
* @see {@link KEYS_CONTACT_VERIFICATION_STATUS} - Array of all keys for this type
|
|
6899
|
+
*/
|
|
6900
|
+
export const KEY_CONTACT_VERIFICATION_STATUS_PROOF: keyof ContactVerificationStatus = 'proof';
|
|
6901
|
+
/**
|
|
6902
|
+
* state property
|
|
6903
|
+
*
|
|
6904
|
+
*
|
|
6905
|
+
*
|
|
6906
|
+
*
|
|
6907
|
+
* @remarks
|
|
6908
|
+
* This key constant provides type-safe access to the `state` property of ContactVerificationStatus objects.
|
|
6909
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6910
|
+
*
|
|
6911
|
+
* @example
|
|
6912
|
+
* ```typescript
|
|
6913
|
+
* // Direct property access
|
|
6914
|
+
* const value = contactverificationstatus[KEY_CONTACT_VERIFICATION_STATUS_STATE];
|
|
6915
|
+
*
|
|
6916
|
+
* // Dynamic property access
|
|
6917
|
+
* const propertyName = KEY_CONTACT_VERIFICATION_STATUS_STATE;
|
|
6918
|
+
* const value = contactverificationstatus[propertyName];
|
|
6919
|
+
* ```
|
|
6920
|
+
*
|
|
6921
|
+
* @see {@link ContactVerificationStatus} - The TypeScript type definition
|
|
6922
|
+
* @see {@link KEYS_CONTACT_VERIFICATION_STATUS} - Array of all keys for this type
|
|
6923
|
+
*/
|
|
6924
|
+
export const KEY_CONTACT_VERIFICATION_STATUS_STATE: keyof ContactVerificationStatus = 'state';
|
|
6925
|
+
/**
|
|
6926
|
+
* Verified On
|
|
6927
|
+
*
|
|
6928
|
+
*
|
|
6929
|
+
*
|
|
6930
|
+
*
|
|
6931
|
+
* @remarks
|
|
6932
|
+
* This key constant provides type-safe access to the `verified_on` property of ContactVerificationStatus objects.
|
|
6933
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6934
|
+
*
|
|
6935
|
+
* @example
|
|
6936
|
+
* ```typescript
|
|
6937
|
+
* // Direct property access
|
|
6938
|
+
* const value = contactverificationstatus[KEY_CONTACT_VERIFICATION_STATUS_VERIFIED_ON];
|
|
6939
|
+
*
|
|
6940
|
+
* // Dynamic property access
|
|
6941
|
+
* const propertyName = KEY_CONTACT_VERIFICATION_STATUS_VERIFIED_ON;
|
|
6942
|
+
* const value = contactverificationstatus[propertyName];
|
|
6943
|
+
* ```
|
|
6944
|
+
*
|
|
6945
|
+
* @see {@link ContactVerificationStatus} - The TypeScript type definition
|
|
6946
|
+
* @see {@link KEYS_CONTACT_VERIFICATION_STATUS} - Array of all keys for this type
|
|
6947
|
+
*/
|
|
6948
|
+
export const KEY_CONTACT_VERIFICATION_STATUS_VERIFIED_ON: keyof ContactVerificationStatus = 'verified_on';
|
|
6949
|
+
|
|
6950
|
+
/**
|
|
6951
|
+
* Array of all ContactVerificationStatus property keys
|
|
6952
|
+
*
|
|
6953
|
+
* @remarks
|
|
6954
|
+
* This constant provides a readonly array containing all valid property keys for ContactVerificationStatus objects.
|
|
6955
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
6956
|
+
*
|
|
6957
|
+
* @example
|
|
6958
|
+
* ```typescript
|
|
6959
|
+
* // Iterating through all keys
|
|
6960
|
+
* for (const key of KEYS_CONTACT_VERIFICATION_STATUS) {
|
|
6961
|
+
* console.log(`Property: ${key}, Value: ${contactverificationstatus[key]}`);
|
|
6962
|
+
* }
|
|
6963
|
+
*
|
|
6964
|
+
* // Validation
|
|
6965
|
+
* const isValidKey = KEYS_CONTACT_VERIFICATION_STATUS.includes(someKey);
|
|
6966
|
+
* ```
|
|
6967
|
+
*
|
|
6968
|
+
* @see {@link ContactVerificationStatus} - The TypeScript type definition
|
|
6969
|
+
*/
|
|
6970
|
+
export const KEYS_CONTACT_VERIFICATION_STATUS = [
|
|
6971
|
+
KEY_CONTACT_VERIFICATION_STATUS_ATTESTATION_REFERENCE,
|
|
6972
|
+
KEY_CONTACT_VERIFICATION_STATUS_CLAIM,
|
|
6973
|
+
KEY_CONTACT_VERIFICATION_STATUS_EXPIRES_ON,
|
|
6974
|
+
KEY_CONTACT_VERIFICATION_STATUS_METHOD,
|
|
6975
|
+
KEY_CONTACT_VERIFICATION_STATUS_PROOF,
|
|
6976
|
+
KEY_CONTACT_VERIFICATION_STATUS_STATE,
|
|
6977
|
+
KEY_CONTACT_VERIFICATION_STATUS_VERIFIED_ON,
|
|
6978
|
+
] as const satisfies (keyof ContactVerificationStatus)[];
|
|
6979
|
+
|
|
6552
6980
|
/**
|
|
6553
6981
|
* Authinfo Required
|
|
6554
6982
|
*
|
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { ConversationCreateRequest, ConversationPatchRequest, ContextCreateRequest, MessageCreateRequest, MemoryFactCreateRequest, MemoryFactPatchRequest, PublicAuthRequestForm, DomainAvailabilityRequest, ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, ClaimsNoticesRequest, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, JobBatchRequest, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, TagCreate, BulkObjectTagChanges, TagUpdate, ObjectTagChanges, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
37
|
+
import { ConversationCreateRequest, ConversationPatchRequest, ContextCreateRequest, MessageCreateRequest, MemoryFactCreateRequest, MemoryFactPatchRequest, PublicAuthRequestForm, DomainAvailabilityRequest, ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, ContactAttestReq, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, ClaimsNoticesRequest, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, JobBatchRequest, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, TagCreate, BulkObjectTagChanges, TagUpdate, ObjectTagChanges, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET AiConciergeContextsContextId endpoint
|
|
@@ -1691,6 +1691,59 @@ export type PUT_ContactsContactIdVerification_Request_Query = PUT_ContactsContac
|
|
|
1691
1691
|
*/
|
|
1692
1692
|
export type PUT_ContactsContactIdVerification_Request_Path = PUT_ContactsContactIdVerification_Request['parameters']['path'];
|
|
1693
1693
|
|
|
1694
|
+
/**
|
|
1695
|
+
* Request type for POST ContactsContactIdVerificationsAttest endpoint
|
|
1696
|
+
*
|
|
1697
|
+
* Attest a contact verification
|
|
1698
|
+
* Submit one or more contact-verification attestations. Returns the per-claim verification state.
|
|
1699
|
+
*
|
|
1700
|
+
* @remarks
|
|
1701
|
+
* This type defines the complete request structure for the POST ContactsContactIdVerificationsAttest endpoint.
|
|
1702
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1703
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1704
|
+
*
|
|
1705
|
+
* @example
|
|
1706
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1707
|
+
*
|
|
1708
|
+
* @path /v1/contacts/{contact_id}/verifications/attest
|
|
1709
|
+
*
|
|
1710
|
+
* @see {@link POST_ContactsContactIdVerificationsAttest_Request_Query} - Query parameters type
|
|
1711
|
+
* @see {@link POST_ContactsContactIdVerificationsAttest_Request_Path} - Path parameters type
|
|
1712
|
+
* @see {@link POST_ContactsContactIdVerificationsAttest_Request_Body} - Request body type
|
|
1713
|
+
*/
|
|
1714
|
+
export type POST_ContactsContactIdVerificationsAttest_Request = {
|
|
1715
|
+
parameters: {
|
|
1716
|
+
path: operations['attest_contact_verification_v1_contacts__contact_id__verifications_attest_post']['parameters']['path'];
|
|
1717
|
+
};
|
|
1718
|
+
requestBody: ContactAttestReq;
|
|
1719
|
+
}
|
|
1720
|
+
/**
|
|
1721
|
+
* Path parameters for POST /v1/contacts/{contact_id}/verifications/attest
|
|
1722
|
+
*
|
|
1723
|
+
* @remarks
|
|
1724
|
+
* This type defines the path parameters for the POST /v1/contacts/{contact_id}/verifications/attest endpoint.
|
|
1725
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
1726
|
+
*
|
|
1727
|
+
* @example
|
|
1728
|
+
* Use this type to ensure type safety for path parameters.
|
|
1729
|
+
*
|
|
1730
|
+
* @path /v1/contacts/{contact_id}/verifications/attest
|
|
1731
|
+
*/
|
|
1732
|
+
export type POST_ContactsContactIdVerificationsAttest_Request_Path = POST_ContactsContactIdVerificationsAttest_Request['parameters']['path'];
|
|
1733
|
+
/**
|
|
1734
|
+
* Request body for POST /v1/contacts/{contact_id}/verifications/attest
|
|
1735
|
+
*
|
|
1736
|
+
* @remarks
|
|
1737
|
+
* This type defines the request body structure for the POST /v1/contacts/{contact_id}/verifications/attest endpoint.
|
|
1738
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
1739
|
+
*
|
|
1740
|
+
* @example
|
|
1741
|
+
* Use this type to ensure type safety for request body structure.
|
|
1742
|
+
*
|
|
1743
|
+
* @path /v1/contacts/{contact_id}/verifications/attest
|
|
1744
|
+
*/
|
|
1745
|
+
export type POST_ContactsContactIdVerificationsAttest_Request_Body = POST_ContactsContactIdVerificationsAttest_Request['requestBody'];
|
|
1746
|
+
|
|
1694
1747
|
/**
|
|
1695
1748
|
* Request type for GET ContactsVerification endpoint
|
|
1696
1749
|
*
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Context, Problem, HTTPValidationError, ConversationList, Conversation, ContextList, MessageList, Message, MemoryFactList, MemoryFact, Pagination_EmailForwardLog, Pagination_ObjectLog, Pagination_RequestHistory, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, ClaimsNotices, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventResponse, Job, Pagination_JobBatchMetadata, CreateJobBatch, JobBatchStatus, Pagination_Job, JobBatchRetry, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, PublicReportListRes, PublicReportRes, Pagination_Tag, Tag, ObjectTagChanges2, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Context, Problem, HTTPValidationError, ConversationList, Conversation, ContextList, MessageList, Message, MemoryFactList, MemoryFact, Pagination_EmailForwardLog, Pagination_ObjectLog, Pagination_RequestHistory, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, ContactAttestRes, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, ClaimsNotices, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventResponse, Job, Pagination_JobBatchMetadata, CreateJobBatch, JobBatchStatus, Pagination_Job, JobBatchRetry, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, PublicReportListRes, PublicReportRes, Pagination_Tag, Tag, ObjectTagChanges2, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET AiConciergeContextsByContextId endpoint
|
|
@@ -3257,6 +3257,116 @@ export type PUT_ContactsByContactIdVerification_Response_404 = Problem
|
|
|
3257
3257
|
*/
|
|
3258
3258
|
export type PUT_ContactsByContactIdVerification_Response_422 = HTTPValidationError
|
|
3259
3259
|
|
|
3260
|
+
/**
|
|
3261
|
+
* Response types for POST ContactsByContactIdVerificationsAttest endpoint
|
|
3262
|
+
*
|
|
3263
|
+
* Attest a contact verification
|
|
3264
|
+
* Submit one or more contact-verification attestations. Returns the per-claim verification state.
|
|
3265
|
+
*
|
|
3266
|
+
* @remarks
|
|
3267
|
+
* This type defines all possible response structures for the POST ContactsByContactIdVerificationsAttest endpoint.
|
|
3268
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
3269
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
3270
|
+
*
|
|
3271
|
+
|
|
3272
|
+
*
|
|
3273
|
+
* @path /v1/contacts/{contact_id}/verifications/attest
|
|
3274
|
+
*
|
|
3275
|
+
* @see {@link POST_ContactsByContactIdVerificationsAttest_Response_200} - 200 response type
|
|
3276
|
+
* @see {@link POST_ContactsByContactIdVerificationsAttest_Response_400} - 400 response type
|
|
3277
|
+
* @see {@link POST_ContactsByContactIdVerificationsAttest_Response_401} - 401 response type
|
|
3278
|
+
* @see {@link POST_ContactsByContactIdVerificationsAttest_Response_422} - 422 response type
|
|
3279
|
+
* @see {@link POST_ContactsByContactIdVerificationsAttest_Response_502} - 502 response type
|
|
3280
|
+
*
|
|
3281
|
+
|
|
3282
|
+
*/
|
|
3283
|
+
export type POST_ContactsByContactIdVerificationsAttest_Response = POST_ContactsByContactIdVerificationsAttest_Response_200 | POST_ContactsByContactIdVerificationsAttest_Response_400 | POST_ContactsByContactIdVerificationsAttest_Response_401 | POST_ContactsByContactIdVerificationsAttest_Response_422 | POST_ContactsByContactIdVerificationsAttest_Response_502;
|
|
3284
|
+
|
|
3285
|
+
/**
|
|
3286
|
+
* 200 response for POST ContactsByContactIdVerificationsAttest endpoint
|
|
3287
|
+
*
|
|
3288
|
+
* @remarks
|
|
3289
|
+
* This type defines the response structure for the 200 status code
|
|
3290
|
+
* of the POST ContactsByContactIdVerificationsAttest endpoint.
|
|
3291
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
3292
|
+
*
|
|
3293
|
+
|
|
3294
|
+
*
|
|
3295
|
+
* @path /v1/contacts/{contact_id}/verifications/attest
|
|
3296
|
+
*
|
|
3297
|
+
* @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
|
|
3298
|
+
* @see {@link ContactAttestRes} - The actual schema type definition
|
|
3299
|
+
*/
|
|
3300
|
+
export type POST_ContactsByContactIdVerificationsAttest_Response_200 = ContactAttestRes
|
|
3301
|
+
|
|
3302
|
+
/**
|
|
3303
|
+
* 400 response for POST ContactsByContactIdVerificationsAttest endpoint
|
|
3304
|
+
*
|
|
3305
|
+
* @remarks
|
|
3306
|
+
* This type defines the response structure for the 400 status code
|
|
3307
|
+
* of the POST ContactsByContactIdVerificationsAttest endpoint.
|
|
3308
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
3309
|
+
*
|
|
3310
|
+
|
|
3311
|
+
*
|
|
3312
|
+
* @path /v1/contacts/{contact_id}/verifications/attest
|
|
3313
|
+
*
|
|
3314
|
+
* @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
|
|
3315
|
+
* @see {@link Problem} - The actual schema type definition
|
|
3316
|
+
*/
|
|
3317
|
+
export type POST_ContactsByContactIdVerificationsAttest_Response_400 = Problem
|
|
3318
|
+
|
|
3319
|
+
/**
|
|
3320
|
+
* 401 response for POST ContactsByContactIdVerificationsAttest endpoint
|
|
3321
|
+
*
|
|
3322
|
+
* @remarks
|
|
3323
|
+
* This type defines the response structure for the 401 status code
|
|
3324
|
+
* of the POST ContactsByContactIdVerificationsAttest endpoint.
|
|
3325
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
3326
|
+
*
|
|
3327
|
+
|
|
3328
|
+
*
|
|
3329
|
+
* @path /v1/contacts/{contact_id}/verifications/attest
|
|
3330
|
+
*
|
|
3331
|
+
* @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
|
|
3332
|
+
* @see {@link Problem} - The actual schema type definition
|
|
3333
|
+
*/
|
|
3334
|
+
export type POST_ContactsByContactIdVerificationsAttest_Response_401 = Problem
|
|
3335
|
+
|
|
3336
|
+
/**
|
|
3337
|
+
* 422 response for POST ContactsByContactIdVerificationsAttest endpoint
|
|
3338
|
+
*
|
|
3339
|
+
* @remarks
|
|
3340
|
+
* This type defines the response structure for the 422 status code
|
|
3341
|
+
* of the POST ContactsByContactIdVerificationsAttest endpoint.
|
|
3342
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
3343
|
+
*
|
|
3344
|
+
|
|
3345
|
+
*
|
|
3346
|
+
* @path /v1/contacts/{contact_id}/verifications/attest
|
|
3347
|
+
*
|
|
3348
|
+
* @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
|
|
3349
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
3350
|
+
*/
|
|
3351
|
+
export type POST_ContactsByContactIdVerificationsAttest_Response_422 = HTTPValidationError
|
|
3352
|
+
|
|
3353
|
+
/**
|
|
3354
|
+
* 502 response for POST ContactsByContactIdVerificationsAttest endpoint
|
|
3355
|
+
*
|
|
3356
|
+
* @remarks
|
|
3357
|
+
* This type defines the response structure for the 502 status code
|
|
3358
|
+
* of the POST ContactsByContactIdVerificationsAttest endpoint.
|
|
3359
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
3360
|
+
*
|
|
3361
|
+
|
|
3362
|
+
*
|
|
3363
|
+
* @path /v1/contacts/{contact_id}/verifications/attest
|
|
3364
|
+
*
|
|
3365
|
+
* @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
|
|
3366
|
+
* @see {@link Problem} - The actual schema type definition
|
|
3367
|
+
*/
|
|
3368
|
+
export type POST_ContactsByContactIdVerificationsAttest_Response_502 = Problem
|
|
3369
|
+
|
|
3260
3370
|
/**
|
|
3261
3371
|
* Response types for GET ContactsVerification endpoint
|
|
3262
3372
|
*
|