@opusdns/api 1.72.0 → 1.74.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 +2 -0
- package/src/helpers/keys.ts +180 -0
- package/src/helpers/requests.d.ts +9 -0
- package/src/helpers/responses.d.ts +10 -0
- package/src/helpers/schemas.d.ts +12 -0
- package/src/openapi.yaml +480 -1
- package/src/schema.d.ts +269 -1
package/src/schema.d.ts
CHANGED
|
@@ -2851,6 +2851,40 @@ export interface paths {
|
|
|
2851
2851
|
patch?: never;
|
|
2852
2852
|
trace?: never;
|
|
2853
2853
|
};
|
|
2854
|
+
"/v1/whitelabel-branding/email/preview": {
|
|
2855
|
+
parameters: {
|
|
2856
|
+
query?: never;
|
|
2857
|
+
header?: never;
|
|
2858
|
+
path?: never;
|
|
2859
|
+
cookie?: never;
|
|
2860
|
+
};
|
|
2861
|
+
get?: never;
|
|
2862
|
+
put?: never;
|
|
2863
|
+
/** Preview a transactional email template with a draft branding document */
|
|
2864
|
+
post: operations["preview_whitelabel_email_v1_whitelabel_branding_email_preview_post"];
|
|
2865
|
+
delete?: never;
|
|
2866
|
+
options?: never;
|
|
2867
|
+
head?: never;
|
|
2868
|
+
patch?: never;
|
|
2869
|
+
trace?: never;
|
|
2870
|
+
};
|
|
2871
|
+
"/v1/whitelabel-branding/email/templates": {
|
|
2872
|
+
parameters: {
|
|
2873
|
+
query?: never;
|
|
2874
|
+
header?: never;
|
|
2875
|
+
path?: never;
|
|
2876
|
+
cookie?: never;
|
|
2877
|
+
};
|
|
2878
|
+
/** List the editable transactional email templates and their content blocks */
|
|
2879
|
+
get: operations["list_whitelabel_email_templates_v1_whitelabel_branding_email_templates_get"];
|
|
2880
|
+
put?: never;
|
|
2881
|
+
post?: never;
|
|
2882
|
+
delete?: never;
|
|
2883
|
+
options?: never;
|
|
2884
|
+
head?: never;
|
|
2885
|
+
patch?: never;
|
|
2886
|
+
trace?: never;
|
|
2887
|
+
};
|
|
2854
2888
|
"/v1/whitelabel-branding/recheck": {
|
|
2855
2889
|
parameters: {
|
|
2856
2890
|
query?: never;
|
|
@@ -2977,6 +3011,21 @@ export interface components {
|
|
|
2977
3011
|
* @enum {string}
|
|
2978
3012
|
*/
|
|
2979
3013
|
AttributeType: "enum" | "string" | "boolean" | "datetime" | "integer" | "country_code" | "uri_template";
|
|
3014
|
+
/**
|
|
3015
|
+
* Auth
|
|
3016
|
+
* @description Pre-login OAuth bootstrap. The SPA resolves this document by hostname before login and uses
|
|
3017
|
+
* `client_id` (the org's `wl-<organization_id>` Keycloak client) + `authority` (the OIDC issuer on
|
|
3018
|
+
* the customer's auth host) to start the flow; absent, it falls back to the default dashboard client.
|
|
3019
|
+
*
|
|
3020
|
+
* System-owned: written only by onboarding (via branding-service's set-auth endpoint), never by a
|
|
3021
|
+
* customer document write - branding-service preserves this block across customer upserts.
|
|
3022
|
+
*/
|
|
3023
|
+
Auth: {
|
|
3024
|
+
/** Authority */
|
|
3025
|
+
authority?: string | null;
|
|
3026
|
+
/** Client Id */
|
|
3027
|
+
client_id?: string | null;
|
|
3028
|
+
};
|
|
2980
3029
|
/**
|
|
2981
3030
|
* BatchSortField
|
|
2982
3031
|
* @enum {string}
|
|
@@ -3102,6 +3151,24 @@ export interface components {
|
|
|
3102
3151
|
* @enum {string}
|
|
3103
3152
|
*/
|
|
3104
3153
|
BillingTransactionStatus: "pending" | "succeeded" | "failed" | "canceled";
|
|
3154
|
+
/** Brand */
|
|
3155
|
+
Brand: {
|
|
3156
|
+
logo?: components["schemas"]["Logo"] | null;
|
|
3157
|
+
/** Name */
|
|
3158
|
+
name?: string | null;
|
|
3159
|
+
};
|
|
3160
|
+
/** BrandingDocument */
|
|
3161
|
+
BrandingDocument: {
|
|
3162
|
+
auth?: components["schemas"]["Auth"] | null;
|
|
3163
|
+
brand?: components["schemas"]["Brand"] | null;
|
|
3164
|
+
content?: components["schemas"]["Content"] | null;
|
|
3165
|
+
theme?: components["schemas"]["Theme"] | null;
|
|
3166
|
+
/**
|
|
3167
|
+
* Version
|
|
3168
|
+
* @default 1
|
|
3169
|
+
*/
|
|
3170
|
+
version: number;
|
|
3171
|
+
};
|
|
3105
3172
|
/** BrowserStatsBucket */
|
|
3106
3173
|
BrowserStatsBucket: {
|
|
3107
3174
|
/** Key */
|
|
@@ -4204,6 +4271,16 @@ export interface components {
|
|
|
4204
4271
|
kind: "contacts";
|
|
4205
4272
|
payload: components["schemas"]["ContextPayload_RegistrarContact_"];
|
|
4206
4273
|
};
|
|
4274
|
+
/** Content */
|
|
4275
|
+
Content: {
|
|
4276
|
+
/** Email Blocks */
|
|
4277
|
+
email_blocks?: Record<string, never> | null;
|
|
4278
|
+
footer?: components["schemas"]["Footer"] | null;
|
|
4279
|
+
legal?: components["schemas"]["Legal"] | null;
|
|
4280
|
+
/** Signature */
|
|
4281
|
+
signature?: string | null;
|
|
4282
|
+
support?: components["schemas"]["Support"] | null;
|
|
4283
|
+
};
|
|
4207
4284
|
/** ContextListResponse */
|
|
4208
4285
|
ContextListResponse: {
|
|
4209
4286
|
pagination: components["schemas"]["PaginationMetadata"];
|
|
@@ -6410,7 +6487,7 @@ export interface components {
|
|
|
6410
6487
|
* DomainSortField
|
|
6411
6488
|
* @enum {string}
|
|
6412
6489
|
*/
|
|
6413
|
-
DomainSortField: "name" | "created_on" | "updated_on" | "expires_on" | "registered_on";
|
|
6490
|
+
DomainSortField: "name" | "created_on" | "updated_on" | "expires_on" | "registered_on" | "transferred_on";
|
|
6414
6491
|
/**
|
|
6415
6492
|
* DomainStatus
|
|
6416
6493
|
* @enum {string}
|
|
@@ -7761,6 +7838,19 @@ export interface components {
|
|
|
7761
7838
|
* @enum {string}
|
|
7762
7839
|
*/
|
|
7763
7840
|
ExecutingEntity: "user" | "organization" | "system";
|
|
7841
|
+
/** Footer */
|
|
7842
|
+
Footer: {
|
|
7843
|
+
/** Contact Email */
|
|
7844
|
+
contact_email?: string | null;
|
|
7845
|
+
/** Disclaimer */
|
|
7846
|
+
disclaimer?: string | null;
|
|
7847
|
+
/** Legal Entity */
|
|
7848
|
+
legal_entity?: string | null;
|
|
7849
|
+
/** Lines */
|
|
7850
|
+
lines?: string[] | null;
|
|
7851
|
+
/** Vat Id */
|
|
7852
|
+
vat_id?: string | null;
|
|
7853
|
+
};
|
|
7764
7854
|
/** GeneralAvailabilityBase */
|
|
7765
7855
|
GeneralAvailabilityBase: {
|
|
7766
7856
|
/**
|
|
@@ -8536,6 +8626,13 @@ export interface components {
|
|
|
8536
8626
|
phases: components["schemas"]["LaunchPhaseBase"][];
|
|
8537
8627
|
trademark_claims?: components["schemas"]["TrademarkClaimsBase"] | null;
|
|
8538
8628
|
};
|
|
8629
|
+
/** Legal */
|
|
8630
|
+
Legal: {
|
|
8631
|
+
/** Privacy Url */
|
|
8632
|
+
privacy_url?: string | null;
|
|
8633
|
+
/** Terms Url */
|
|
8634
|
+
terms_url?: string | null;
|
|
8635
|
+
};
|
|
8539
8636
|
/** LegalRequirementBase */
|
|
8540
8637
|
LegalRequirementBase: {
|
|
8541
8638
|
/**
|
|
@@ -8616,6 +8713,17 @@ export interface components {
|
|
|
8616
8713
|
* @enum {string}
|
|
8617
8714
|
*/
|
|
8618
8715
|
LocalPresenceRequirementType: "physical_address" | "business_entity";
|
|
8716
|
+
/** Logo */
|
|
8717
|
+
Logo: {
|
|
8718
|
+
/** Dark */
|
|
8719
|
+
dark?: string | null;
|
|
8720
|
+
/** Favicon */
|
|
8721
|
+
favicon?: string | null;
|
|
8722
|
+
/** Icon */
|
|
8723
|
+
icon?: string | null;
|
|
8724
|
+
/** Light */
|
|
8725
|
+
light?: string | null;
|
|
8726
|
+
};
|
|
8619
8727
|
/** MemoryFact */
|
|
8620
8728
|
MemoryFact: {
|
|
8621
8729
|
/**
|
|
@@ -9656,6 +9764,53 @@ export interface components {
|
|
|
9656
9764
|
/** Results */
|
|
9657
9765
|
results: components["schemas"]["UserPublicWithRole"][];
|
|
9658
9766
|
};
|
|
9767
|
+
/** Palette */
|
|
9768
|
+
Palette: {
|
|
9769
|
+
/** Accent */
|
|
9770
|
+
accent?: string | null;
|
|
9771
|
+
/** Accent Foreground */
|
|
9772
|
+
accent_foreground?: string | null;
|
|
9773
|
+
/** Background */
|
|
9774
|
+
background?: string | null;
|
|
9775
|
+
/** Border */
|
|
9776
|
+
border?: string | null;
|
|
9777
|
+
/** Card */
|
|
9778
|
+
card?: string | null;
|
|
9779
|
+
/** Card Foreground */
|
|
9780
|
+
card_foreground?: string | null;
|
|
9781
|
+
/** Chart Colors */
|
|
9782
|
+
chart_colors?: string[] | null;
|
|
9783
|
+
/** Danger */
|
|
9784
|
+
danger?: string | null;
|
|
9785
|
+
/** Foreground */
|
|
9786
|
+
foreground?: string | null;
|
|
9787
|
+
/** Info */
|
|
9788
|
+
info?: string | null;
|
|
9789
|
+
/** Input */
|
|
9790
|
+
input?: string | null;
|
|
9791
|
+
/** Muted */
|
|
9792
|
+
muted?: string | null;
|
|
9793
|
+
/** Muted Foreground */
|
|
9794
|
+
muted_foreground?: string | null;
|
|
9795
|
+
/** Primary */
|
|
9796
|
+
primary?: string | null;
|
|
9797
|
+
/** Primary Foreground */
|
|
9798
|
+
primary_foreground?: string | null;
|
|
9799
|
+
/** Secondary */
|
|
9800
|
+
secondary?: string | null;
|
|
9801
|
+
/** Secondary Foreground */
|
|
9802
|
+
secondary_foreground?: string | null;
|
|
9803
|
+
/** Sidebar */
|
|
9804
|
+
sidebar?: string | null;
|
|
9805
|
+
/** Sidebar Foreground */
|
|
9806
|
+
sidebar_foreground?: string | null;
|
|
9807
|
+
/** Success */
|
|
9808
|
+
success?: string | null;
|
|
9809
|
+
/** Tag Colors */
|
|
9810
|
+
tag_colors?: string[] | null;
|
|
9811
|
+
/** Warning */
|
|
9812
|
+
warning?: string | null;
|
|
9813
|
+
};
|
|
9659
9814
|
/** ParkingActionPayloadData */
|
|
9660
9815
|
ParkingActionPayloadData: {
|
|
9661
9816
|
/** Parking Reference */
|
|
@@ -10184,6 +10339,23 @@ export interface components {
|
|
|
10184
10339
|
* @enum {string}
|
|
10185
10340
|
*/
|
|
10186
10341
|
PremiumSourceType: "EPP" | "API" | "CSV" | "manual";
|
|
10342
|
+
/** PreviewMailReq */
|
|
10343
|
+
PreviewMailReq: {
|
|
10344
|
+
branding_document?: components["schemas"]["BrandingDocument"] | null;
|
|
10345
|
+
/** Language Code */
|
|
10346
|
+
language_code: string;
|
|
10347
|
+
/** Template Name */
|
|
10348
|
+
template_name: string;
|
|
10349
|
+
};
|
|
10350
|
+
/** PreviewMailRes */
|
|
10351
|
+
PreviewMailRes: {
|
|
10352
|
+
/** Html */
|
|
10353
|
+
html: string;
|
|
10354
|
+
/** Subject */
|
|
10355
|
+
subject: string;
|
|
10356
|
+
/** Text */
|
|
10357
|
+
text: string;
|
|
10358
|
+
};
|
|
10187
10359
|
/** PriceInfo */
|
|
10188
10360
|
PriceInfo: {
|
|
10189
10361
|
/** Currency */
|
|
@@ -10736,6 +10908,13 @@ export interface components {
|
|
|
10736
10908
|
StatusTagType: "VERIFICATION_REQUIRED" | "CREATE_REQUESTED";
|
|
10737
10909
|
/** @example 12.50 */
|
|
10738
10910
|
StrictMoneyDecimal: string;
|
|
10911
|
+
/** Support */
|
|
10912
|
+
Support: {
|
|
10913
|
+
/** Email */
|
|
10914
|
+
email?: string | null;
|
|
10915
|
+
/** Url */
|
|
10916
|
+
url?: string | null;
|
|
10917
|
+
};
|
|
10739
10918
|
/**
|
|
10740
10919
|
* SyncOperationType
|
|
10741
10920
|
* @enum {string}
|
|
@@ -10860,6 +11039,17 @@ export interface components {
|
|
|
10860
11039
|
*/
|
|
10861
11040
|
label?: string | null;
|
|
10862
11041
|
};
|
|
11042
|
+
/** Theme */
|
|
11043
|
+
Theme: {
|
|
11044
|
+
dark?: components["schemas"]["Palette"] | null;
|
|
11045
|
+
/** Font Family */
|
|
11046
|
+
font_family?: string | null;
|
|
11047
|
+
/** Font Url */
|
|
11048
|
+
font_url?: string | null;
|
|
11049
|
+
light?: components["schemas"]["Palette"] | null;
|
|
11050
|
+
/** Radius */
|
|
11051
|
+
radius?: string | null;
|
|
11052
|
+
};
|
|
10863
11053
|
/**
|
|
10864
11054
|
* TimeRange
|
|
10865
11055
|
* @enum {string}
|
|
@@ -18231,6 +18421,8 @@ export interface operations {
|
|
|
18231
18421
|
expires_in_90_days?: boolean | null;
|
|
18232
18422
|
registered_after?: Date | null;
|
|
18233
18423
|
registered_before?: Date | null;
|
|
18424
|
+
transferred_after?: Date | null;
|
|
18425
|
+
transferred_before?: Date | null;
|
|
18234
18426
|
/** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
|
|
18235
18427
|
registry_statuses?: string[] | null;
|
|
18236
18428
|
/** @description Include additional data in the response. Can be specified multiple times. */
|
|
@@ -26011,6 +26203,82 @@ export interface operations {
|
|
|
26011
26203
|
};
|
|
26012
26204
|
};
|
|
26013
26205
|
};
|
|
26206
|
+
preview_whitelabel_email_v1_whitelabel_branding_email_preview_post: {
|
|
26207
|
+
parameters: {
|
|
26208
|
+
query?: never;
|
|
26209
|
+
header?: {
|
|
26210
|
+
/**
|
|
26211
|
+
* @description Opt in to RFC 3339 datetime serialization. When set to `rfc3339`, response datetimes are normalized to UTC and serialized with a `Z` suffix. This is opt-in until the announced default cutover date, after which RFC 3339 becomes the default and this header is accepted as a no-op. Any other value or omission uses the current default serialization.
|
|
26212
|
+
* @example rfc3339
|
|
26213
|
+
*/
|
|
26214
|
+
"X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
|
|
26215
|
+
};
|
|
26216
|
+
path?: never;
|
|
26217
|
+
cookie?: never;
|
|
26218
|
+
};
|
|
26219
|
+
requestBody: {
|
|
26220
|
+
content: {
|
|
26221
|
+
"application/json": components["schemas"]["PreviewMailReq"];
|
|
26222
|
+
};
|
|
26223
|
+
};
|
|
26224
|
+
responses: {
|
|
26225
|
+
/** @description Successful Response */
|
|
26226
|
+
200: {
|
|
26227
|
+
headers: {
|
|
26228
|
+
[name: string]: unknown;
|
|
26229
|
+
};
|
|
26230
|
+
content: {
|
|
26231
|
+
"application/json": components["schemas"]["PreviewMailRes"];
|
|
26232
|
+
};
|
|
26233
|
+
};
|
|
26234
|
+
/** @description Validation Error */
|
|
26235
|
+
422: {
|
|
26236
|
+
headers: {
|
|
26237
|
+
[name: string]: unknown;
|
|
26238
|
+
};
|
|
26239
|
+
content: {
|
|
26240
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
26241
|
+
};
|
|
26242
|
+
};
|
|
26243
|
+
};
|
|
26244
|
+
};
|
|
26245
|
+
list_whitelabel_email_templates_v1_whitelabel_branding_email_templates_get: {
|
|
26246
|
+
parameters: {
|
|
26247
|
+
query?: never;
|
|
26248
|
+
header?: {
|
|
26249
|
+
/**
|
|
26250
|
+
* @description Opt in to RFC 3339 datetime serialization. When set to `rfc3339`, response datetimes are normalized to UTC and serialized with a `Z` suffix. This is opt-in until the announced default cutover date, after which RFC 3339 becomes the default and this header is accepted as a no-op. Any other value or omission uses the current default serialization.
|
|
26251
|
+
* @example rfc3339
|
|
26252
|
+
*/
|
|
26253
|
+
"X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
|
|
26254
|
+
};
|
|
26255
|
+
path?: never;
|
|
26256
|
+
cookie?: never;
|
|
26257
|
+
};
|
|
26258
|
+
requestBody?: never;
|
|
26259
|
+
responses: {
|
|
26260
|
+
/** @description Successful Response */
|
|
26261
|
+
200: {
|
|
26262
|
+
headers: {
|
|
26263
|
+
[name: string]: unknown;
|
|
26264
|
+
};
|
|
26265
|
+
content: {
|
|
26266
|
+
"application/json": {
|
|
26267
|
+
[key: string]: unknown;
|
|
26268
|
+
};
|
|
26269
|
+
};
|
|
26270
|
+
};
|
|
26271
|
+
/** @description Validation Error */
|
|
26272
|
+
422: {
|
|
26273
|
+
headers: {
|
|
26274
|
+
[name: string]: unknown;
|
|
26275
|
+
};
|
|
26276
|
+
content: {
|
|
26277
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
26278
|
+
};
|
|
26279
|
+
};
|
|
26280
|
+
};
|
|
26281
|
+
};
|
|
26014
26282
|
recheck_whitelabel_branding_v1_whitelabel_branding_recheck_post: {
|
|
26015
26283
|
parameters: {
|
|
26016
26284
|
query?: never;
|