@opusdns/api 1.73.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 CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^1.2.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.73.0",
6
+ "version": "1.74.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -5,8 +5,11 @@ import type {
5
5
  AiUsageTimeBucket,
6
6
  AllowedNumberOfNameserverBase,
7
7
  AttributeCondition,
8
+ Auth,
8
9
  BillingMetadata,
9
10
  BillingTransaction,
11
+ Brand,
12
+ BrandingDocument,
10
13
  BrowserStatsBucket,
11
14
  BulkObjectTagChanges,
12
15
  ClaimsNotice,
@@ -42,6 +45,7 @@ import type {
42
45
  ContactsBase,
43
46
  ContactsContext,
44
47
  ContactsContextCreate,
48
+ Content,
45
49
  ContextList,
46
50
  ContextMeta,
47
51
  ContextPayload_DomainForward,
@@ -240,6 +244,7 @@ import type {
240
244
  EventData,
241
245
  EventError,
242
246
  EventResponse,
247
+ Footer,
243
248
  GeneralAvailabilityBase,
244
249
  GeoStatsBucket,
245
250
  GetPrices,
@@ -266,10 +271,12 @@ import type {
266
271
  Job,
267
272
  LaunchPhaseBase,
268
273
  LaunchPhasesBase,
274
+ Legal,
269
275
  LegalRequirementBase,
270
276
  ListVanityNameserverSetsRes,
271
277
  ListZonesReferencingSetRes,
272
278
  LocalPresenceBase,
279
+ Logo,
273
280
  MemoryFact,
274
281
  MemoryFactCreateRequest,
275
282
  MemoryFactList,
@@ -302,6 +309,7 @@ import type {
302
309
  PageResponse_RequestHistory,
303
310
  PaginationMetadata,
304
311
  PaginationMetadataDTO,
312
+ Palette,
305
313
  ParkingActionPayloadData,
306
314
  ParkingAgreementAcceptance,
307
315
  ParkingCreateBulkCommand,
@@ -336,6 +344,8 @@ import type {
336
344
  PremiumPricingAction,
337
345
  PremiumPricingRes,
338
346
  PremiumPricing,
347
+ PreviewMailReq,
348
+ PreviewMailRes,
339
349
  PriceInfo,
340
350
  PricingPeriod,
341
351
  Problem,
@@ -364,10 +374,12 @@ import type {
364
374
  StatusChanges,
365
375
  StatusCodeStatsBucket,
366
376
  StatusTag,
377
+ Support,
367
378
  TagCreate,
368
379
  TagEnriched,
369
380
  Tag,
370
381
  TagUpdate,
382
+ Theme,
371
383
  TimeSeriesBucket,
372
384
  TldBase,
373
385
  TldResponseShort,
@@ -486,6 +498,14 @@ export const KEYS_ATTRIBUTE_CONDITION = [
486
498
  KEY_ATTRIBUTE_CONDITION_VALUE,
487
499
  ] as const satisfies (keyof AttributeCondition)[];
488
500
 
501
+ export const KEY_AUTH_AUTHORITY = 'authority' satisfies keyof Auth;
502
+ export const KEY_AUTH_CLIENT_ID = 'client_id' satisfies keyof Auth;
503
+
504
+ export const KEYS_AUTH = [
505
+ KEY_AUTH_AUTHORITY,
506
+ KEY_AUTH_CLIENT_ID,
507
+ ] as const satisfies (keyof Auth)[];
508
+
489
509
  export const KEY_BILLING_METADATA_BILLING_MODEL = 'billing_model' satisfies keyof BillingMetadata;
490
510
  export const KEY_BILLING_METADATA_CREDIT_LIMIT = 'credit_limit' satisfies keyof BillingMetadata;
491
511
  export const KEY_BILLING_METADATA_CUSTOMER_NUMBER = 'customer_number' satisfies keyof BillingMetadata;
@@ -530,6 +550,28 @@ export const KEYS_BILLING_TRANSACTION = [
530
550
  KEY_BILLING_TRANSACTION_VOLUME,
531
551
  ] as const satisfies (keyof BillingTransaction)[];
532
552
 
553
+ export const KEY_BRAND_LOGO = 'logo' satisfies keyof Brand;
554
+ export const KEY_BRAND_NAME = 'name' satisfies keyof Brand;
555
+
556
+ export const KEYS_BRAND = [
557
+ KEY_BRAND_LOGO,
558
+ KEY_BRAND_NAME,
559
+ ] as const satisfies (keyof Brand)[];
560
+
561
+ export const KEY_BRANDING_DOCUMENT_AUTH = 'auth' satisfies keyof BrandingDocument;
562
+ export const KEY_BRANDING_DOCUMENT_BRAND = 'brand' satisfies keyof BrandingDocument;
563
+ export const KEY_BRANDING_DOCUMENT_CONTENT = 'content' satisfies keyof BrandingDocument;
564
+ export const KEY_BRANDING_DOCUMENT_THEME = 'theme' satisfies keyof BrandingDocument;
565
+ export const KEY_BRANDING_DOCUMENT_VERSION = 'version' satisfies keyof BrandingDocument;
566
+
567
+ export const KEYS_BRANDING_DOCUMENT = [
568
+ KEY_BRANDING_DOCUMENT_AUTH,
569
+ KEY_BRANDING_DOCUMENT_BRAND,
570
+ KEY_BRANDING_DOCUMENT_CONTENT,
571
+ KEY_BRANDING_DOCUMENT_THEME,
572
+ KEY_BRANDING_DOCUMENT_VERSION,
573
+ ] as const satisfies (keyof BrandingDocument)[];
574
+
533
575
  export const KEY_BROWSER_STATS_BUCKET_KEY = 'key' satisfies keyof BrowserStatsBucket;
534
576
  export const KEY_BROWSER_STATS_BUCKET_TOTAL = 'total' satisfies keyof BrowserStatsBucket;
535
577
  export const KEY_BROWSER_STATS_BUCKET_UNIQUE = 'unique' satisfies keyof BrowserStatsBucket;
@@ -1062,6 +1104,20 @@ export const KEYS_CONTACTS_CONTEXT_CREATE = [
1062
1104
  KEY_CONTACTS_CONTEXT_CREATE_PAYLOAD,
1063
1105
  ] as const satisfies (keyof ContactsContextCreate)[];
1064
1106
 
1107
+ export const KEY_CONTENT_EMAIL_BLOCKS = 'email_blocks' satisfies keyof Content;
1108
+ export const KEY_CONTENT_FOOTER = 'footer' satisfies keyof Content;
1109
+ export const KEY_CONTENT_LEGAL = 'legal' satisfies keyof Content;
1110
+ export const KEY_CONTENT_SIGNATURE = 'signature' satisfies keyof Content;
1111
+ export const KEY_CONTENT_SUPPORT = 'support' satisfies keyof Content;
1112
+
1113
+ export const KEYS_CONTENT = [
1114
+ KEY_CONTENT_EMAIL_BLOCKS,
1115
+ KEY_CONTENT_FOOTER,
1116
+ KEY_CONTENT_LEGAL,
1117
+ KEY_CONTENT_SIGNATURE,
1118
+ KEY_CONTENT_SUPPORT,
1119
+ ] as const satisfies (keyof Content)[];
1120
+
1065
1121
  export const KEY_CONTEXT_LIST_PAGINATION = 'pagination' satisfies keyof ContextList;
1066
1122
  export const KEY_CONTEXT_LIST_RESULTS = 'results' satisfies keyof ContextList;
1067
1123
 
@@ -3288,6 +3344,20 @@ export const KEYS_EVENT_RESPONSE = [
3288
3344
  KEY_EVENT_RESPONSE_TYPE,
3289
3345
  ] as const satisfies (keyof EventResponse)[];
3290
3346
 
3347
+ export const KEY_FOOTER_CONTACT_EMAIL = 'contact_email' satisfies keyof Footer;
3348
+ export const KEY_FOOTER_DISCLAIMER = 'disclaimer' satisfies keyof Footer;
3349
+ export const KEY_FOOTER_LEGAL_ENTITY = 'legal_entity' satisfies keyof Footer;
3350
+ export const KEY_FOOTER_LINES = 'lines' satisfies keyof Footer;
3351
+ export const KEY_FOOTER_VAT_ID = 'vat_id' satisfies keyof Footer;
3352
+
3353
+ export const KEYS_FOOTER = [
3354
+ KEY_FOOTER_CONTACT_EMAIL,
3355
+ KEY_FOOTER_DISCLAIMER,
3356
+ KEY_FOOTER_LEGAL_ENTITY,
3357
+ KEY_FOOTER_LINES,
3358
+ KEY_FOOTER_VAT_ID,
3359
+ ] as const satisfies (keyof Footer)[];
3360
+
3291
3361
  export const KEY_GENERAL_AVAILABILITY_BASE_START_DATE = 'start_date' satisfies keyof GeneralAvailabilityBase;
3292
3362
 
3293
3363
  export const KEYS_GENERAL_AVAILABILITY_BASE = [
@@ -3676,6 +3746,14 @@ export const KEYS_LAUNCH_PHASES_BASE = [
3676
3746
  KEY_LAUNCH_PHASES_BASE_TRADEMARK_CLAIMS,
3677
3747
  ] as const satisfies (keyof LaunchPhasesBase)[];
3678
3748
 
3749
+ export const KEY_LEGAL_PRIVACY_URL = 'privacy_url' satisfies keyof Legal;
3750
+ export const KEY_LEGAL_TERMS_URL = 'terms_url' satisfies keyof Legal;
3751
+
3752
+ export const KEYS_LEGAL = [
3753
+ KEY_LEGAL_PRIVACY_URL,
3754
+ KEY_LEGAL_TERMS_URL,
3755
+ ] as const satisfies (keyof Legal)[];
3756
+
3679
3757
  export const KEY_LEGAL_REQUIREMENT_BASE_KEY = 'key' satisfies keyof LegalRequirementBase;
3680
3758
  export const KEY_LEGAL_REQUIREMENT_BASE_OPERATIONS = 'operations' satisfies keyof LegalRequirementBase;
3681
3759
  export const KEY_LEGAL_REQUIREMENT_BASE_TYPE = 'type' satisfies keyof LegalRequirementBase;
@@ -3718,6 +3796,18 @@ export const KEYS_LOCAL_PRESENCE_BASE = [
3718
3796
  KEY_LOCAL_PRESENCE_BASE_TYPE,
3719
3797
  ] as const satisfies (keyof LocalPresenceBase)[];
3720
3798
 
3799
+ export const KEY_LOGO_DARK = 'dark' satisfies keyof Logo;
3800
+ export const KEY_LOGO_FAVICON = 'favicon' satisfies keyof Logo;
3801
+ export const KEY_LOGO_ICON = 'icon' satisfies keyof Logo;
3802
+ export const KEY_LOGO_LIGHT = 'light' satisfies keyof Logo;
3803
+
3804
+ export const KEYS_LOGO = [
3805
+ KEY_LOGO_DARK,
3806
+ KEY_LOGO_FAVICON,
3807
+ KEY_LOGO_ICON,
3808
+ KEY_LOGO_LIGHT,
3809
+ ] as const satisfies (keyof Logo)[];
3810
+
3721
3811
  export const KEY_MEMORY_FACT_CREATED_AT = 'created_at' satisfies keyof MemoryFact;
3722
3812
  export const KEY_MEMORY_FACT_EXPIRES_AT = 'expires_at' satisfies keyof MemoryFact;
3723
3813
  export const KEY_MEMORY_FACT_FACT_ID = 'fact_id' satisfies keyof MemoryFact;
@@ -4226,6 +4316,54 @@ export const KEYS_PAGINATION_METADATA_DTO = [
4226
4316
  KEY_PAGINATION_METADATA_DTO_TOTAL_PAGES,
4227
4317
  ] as const satisfies (keyof PaginationMetadataDTO)[];
4228
4318
 
4319
+ export const KEY_PALETTE_ACCENT = 'accent' satisfies keyof Palette;
4320
+ export const KEY_PALETTE_ACCENT_FOREGROUND = 'accent_foreground' satisfies keyof Palette;
4321
+ export const KEY_PALETTE_BACKGROUND = 'background' satisfies keyof Palette;
4322
+ export const KEY_PALETTE_BORDER = 'border' satisfies keyof Palette;
4323
+ export const KEY_PALETTE_CARD = 'card' satisfies keyof Palette;
4324
+ export const KEY_PALETTE_CARD_FOREGROUND = 'card_foreground' satisfies keyof Palette;
4325
+ export const KEY_PALETTE_CHART_COLORS = 'chart_colors' satisfies keyof Palette;
4326
+ export const KEY_PALETTE_DANGER = 'danger' satisfies keyof Palette;
4327
+ export const KEY_PALETTE_FOREGROUND = 'foreground' satisfies keyof Palette;
4328
+ export const KEY_PALETTE_INFO = 'info' satisfies keyof Palette;
4329
+ export const KEY_PALETTE_INPUT = 'input' satisfies keyof Palette;
4330
+ export const KEY_PALETTE_MUTED = 'muted' satisfies keyof Palette;
4331
+ export const KEY_PALETTE_MUTED_FOREGROUND = 'muted_foreground' satisfies keyof Palette;
4332
+ export const KEY_PALETTE_PRIMARY = 'primary' satisfies keyof Palette;
4333
+ export const KEY_PALETTE_PRIMARY_FOREGROUND = 'primary_foreground' satisfies keyof Palette;
4334
+ export const KEY_PALETTE_SECONDARY = 'secondary' satisfies keyof Palette;
4335
+ export const KEY_PALETTE_SECONDARY_FOREGROUND = 'secondary_foreground' satisfies keyof Palette;
4336
+ export const KEY_PALETTE_SIDEBAR = 'sidebar' satisfies keyof Palette;
4337
+ export const KEY_PALETTE_SIDEBAR_FOREGROUND = 'sidebar_foreground' satisfies keyof Palette;
4338
+ export const KEY_PALETTE_SUCCESS = 'success' satisfies keyof Palette;
4339
+ export const KEY_PALETTE_TAG_COLORS = 'tag_colors' satisfies keyof Palette;
4340
+ export const KEY_PALETTE_WARNING = 'warning' satisfies keyof Palette;
4341
+
4342
+ export const KEYS_PALETTE = [
4343
+ KEY_PALETTE_ACCENT,
4344
+ KEY_PALETTE_ACCENT_FOREGROUND,
4345
+ KEY_PALETTE_BACKGROUND,
4346
+ KEY_PALETTE_BORDER,
4347
+ KEY_PALETTE_CARD,
4348
+ KEY_PALETTE_CARD_FOREGROUND,
4349
+ KEY_PALETTE_CHART_COLORS,
4350
+ KEY_PALETTE_DANGER,
4351
+ KEY_PALETTE_FOREGROUND,
4352
+ KEY_PALETTE_INFO,
4353
+ KEY_PALETTE_INPUT,
4354
+ KEY_PALETTE_MUTED,
4355
+ KEY_PALETTE_MUTED_FOREGROUND,
4356
+ KEY_PALETTE_PRIMARY,
4357
+ KEY_PALETTE_PRIMARY_FOREGROUND,
4358
+ KEY_PALETTE_SECONDARY,
4359
+ KEY_PALETTE_SECONDARY_FOREGROUND,
4360
+ KEY_PALETTE_SIDEBAR,
4361
+ KEY_PALETTE_SIDEBAR_FOREGROUND,
4362
+ KEY_PALETTE_SUCCESS,
4363
+ KEY_PALETTE_TAG_COLORS,
4364
+ KEY_PALETTE_WARNING,
4365
+ ] as const satisfies (keyof Palette)[];
4366
+
4229
4367
  export const KEY_PARKING_ACTION_PAYLOAD_DATA_PARKING_REFERENCE = 'parking_reference' satisfies keyof ParkingActionPayloadData;
4230
4368
 
4231
4369
  export const KEYS_PARKING_ACTION_PAYLOAD_DATA = [
@@ -4538,6 +4676,26 @@ export const KEYS_PREMIUM_PRICING = [
4538
4676
  KEY_PREMIUM_PRICING_PRICES,
4539
4677
  ] as const satisfies (keyof PremiumPricing)[];
4540
4678
 
4679
+ export const KEY_PREVIEW_MAIL_REQ_BRANDING_DOCUMENT = 'branding_document' satisfies keyof PreviewMailReq;
4680
+ export const KEY_PREVIEW_MAIL_REQ_LANGUAGE_CODE = 'language_code' satisfies keyof PreviewMailReq;
4681
+ export const KEY_PREVIEW_MAIL_REQ_TEMPLATE_NAME = 'template_name' satisfies keyof PreviewMailReq;
4682
+
4683
+ export const KEYS_PREVIEW_MAIL_REQ = [
4684
+ KEY_PREVIEW_MAIL_REQ_BRANDING_DOCUMENT,
4685
+ KEY_PREVIEW_MAIL_REQ_LANGUAGE_CODE,
4686
+ KEY_PREVIEW_MAIL_REQ_TEMPLATE_NAME,
4687
+ ] as const satisfies (keyof PreviewMailReq)[];
4688
+
4689
+ export const KEY_PREVIEW_MAIL_RES_HTML = 'html' satisfies keyof PreviewMailRes;
4690
+ export const KEY_PREVIEW_MAIL_RES_SUBJECT = 'subject' satisfies keyof PreviewMailRes;
4691
+ export const KEY_PREVIEW_MAIL_RES_TEXT = 'text' satisfies keyof PreviewMailRes;
4692
+
4693
+ export const KEYS_PREVIEW_MAIL_RES = [
4694
+ KEY_PREVIEW_MAIL_RES_HTML,
4695
+ KEY_PREVIEW_MAIL_RES_SUBJECT,
4696
+ KEY_PREVIEW_MAIL_RES_TEXT,
4697
+ ] as const satisfies (keyof PreviewMailRes)[];
4698
+
4541
4699
  export const KEY_PRICE_INFO_CURRENCY = 'currency' satisfies keyof PriceInfo;
4542
4700
  export const KEY_PRICE_INFO_PERIOD = 'period' satisfies keyof PriceInfo;
4543
4701
  export const KEY_PRICE_INFO_PRICE = 'price' satisfies keyof PriceInfo;
@@ -4864,6 +5022,14 @@ export const KEYS_STATUS_TAG = [
4864
5022
  KEY_STATUS_TAG_TAG_TYPE,
4865
5023
  ] as const satisfies (keyof StatusTag)[];
4866
5024
 
5025
+ export const KEY_SUPPORT_EMAIL = 'email' satisfies keyof Support;
5026
+ export const KEY_SUPPORT_URL = 'url' satisfies keyof Support;
5027
+
5028
+ export const KEYS_SUPPORT = [
5029
+ KEY_SUPPORT_EMAIL,
5030
+ KEY_SUPPORT_URL,
5031
+ ] as const satisfies (keyof Support)[];
5032
+
4867
5033
  export const KEY_TAG_CREATE_COLOR = 'color' satisfies keyof TagCreate;
4868
5034
  export const KEY_TAG_CREATE_DESCRIPTION = 'description' satisfies keyof TagCreate;
4869
5035
  export const KEY_TAG_CREATE_LABEL = 'label' satisfies keyof TagCreate;
@@ -4916,6 +5082,20 @@ export const KEYS_TAG_UPDATE = [
4916
5082
  KEY_TAG_UPDATE_LABEL,
4917
5083
  ] as const satisfies (keyof TagUpdate)[];
4918
5084
 
5085
+ export const KEY_THEME_DARK = 'dark' satisfies keyof Theme;
5086
+ export const KEY_THEME_FONT_FAMILY = 'font_family' satisfies keyof Theme;
5087
+ export const KEY_THEME_FONT_URL = 'font_url' satisfies keyof Theme;
5088
+ export const KEY_THEME_LIGHT = 'light' satisfies keyof Theme;
5089
+ export const KEY_THEME_RADIUS = 'radius' satisfies keyof Theme;
5090
+
5091
+ export const KEYS_THEME = [
5092
+ KEY_THEME_DARK,
5093
+ KEY_THEME_FONT_FAMILY,
5094
+ KEY_THEME_FONT_URL,
5095
+ KEY_THEME_LIGHT,
5096
+ KEY_THEME_RADIUS,
5097
+ ] as const satisfies (keyof Theme)[];
5098
+
4919
5099
  export const KEY_TIME_SERIES_BUCKET_TIMESTAMP = 'timestamp' satisfies keyof TimeSeriesBucket;
4920
5100
  export const KEY_TIME_SERIES_BUCKET_TOTAL = 'total' satisfies keyof TimeSeriesBucket;
4921
5101
 
@@ -45,6 +45,7 @@ import type {
45
45
  OrganizationCreate,
46
46
  OrganizationUpdate,
47
47
  ParkingSignupRequest,
48
+ PreviewMailReq,
48
49
  PublicAuthRequestForm,
49
50
  PublicRoleAssignmentRequest,
50
51
  TagCreate,
@@ -1125,5 +1126,13 @@ export type POST_WhitelabelBranding_Request = {
1125
1126
  };
1126
1127
  export type POST_WhitelabelBranding_Request_Body = POST_WhitelabelBranding_Request['requestBody'];
1127
1128
 
1129
+ export type POST_WhitelabelBrandingEmailPreview_Request = {
1130
+ requestBody: PreviewMailReq;
1131
+ };
1132
+ export type POST_WhitelabelBrandingEmailPreview_Request_Body = POST_WhitelabelBrandingEmailPreview_Request['requestBody'];
1133
+
1134
+ export type GET_WhitelabelBrandingEmailTemplates_Request = {
1135
+ };
1136
+
1128
1137
  export type POST_WhitelabelBrandingRecheck_Request = {
1129
1138
  };
@@ -87,6 +87,7 @@ import type {
87
87
  ParkingSignup,
88
88
  ParkingSignupStatus,
89
89
  ParkingTotalMetrics,
90
+ PreviewMailRes,
90
91
  Problem,
91
92
  ProductCreateRes,
92
93
  PublicPermissionSet,
@@ -860,6 +861,10 @@ export type GET_WhitelabelBranding_Response = GET_WhitelabelBranding_Response_20
860
861
  export type GET_WhitelabelBranding_Response_200 = WhitelabelBranding;
861
862
  export type GET_WhitelabelBranding_Response_422 = HTTPValidationError;
862
863
 
864
+ export type GET_WhitelabelBrandingEmailTemplates_Response = GET_WhitelabelBrandingEmailTemplates_Response_422;
865
+
866
+ export type GET_WhitelabelBrandingEmailTemplates_Response_422 = HTTPValidationError;
867
+
863
868
  export type PATCH_AiConciergeConversationsByConversationId_Response = PATCH_AiConciergeConversationsByConversationId_Response_200 | PATCH_AiConciergeConversationsByConversationId_Response_401 | PATCH_AiConciergeConversationsByConversationId_Response_404 | PATCH_AiConciergeConversationsByConversationId_Response_422 | PATCH_AiConciergeConversationsByConversationId_Response_502;
864
869
 
865
870
  export type PATCH_AiConciergeConversationsByConversationId_Response_200 = Conversation;
@@ -1354,6 +1359,11 @@ export type POST_WhitelabelBranding_Response = POST_WhitelabelBranding_Response_
1354
1359
  export type POST_WhitelabelBranding_Response_202 = ProductCreateRes;
1355
1360
  export type POST_WhitelabelBranding_Response_422 = HTTPValidationError;
1356
1361
 
1362
+ export type POST_WhitelabelBrandingEmailPreview_Response = POST_WhitelabelBrandingEmailPreview_Response_200 | POST_WhitelabelBrandingEmailPreview_Response_422;
1363
+
1364
+ export type POST_WhitelabelBrandingEmailPreview_Response_200 = PreviewMailRes;
1365
+ export type POST_WhitelabelBrandingEmailPreview_Response_422 = HTTPValidationError;
1366
+
1357
1367
  export type POST_WhitelabelBrandingRecheck_Response = POST_WhitelabelBrandingRecheck_Response_202 | POST_WhitelabelBrandingRecheck_Response_422;
1358
1368
 
1359
1369
  export type POST_WhitelabelBrandingRecheck_Response_202 = WhitelabelBranding;
@@ -10,6 +10,7 @@ export type AllowedNumberOfNameserverBase = components['schemas']['AllowedNumber
10
10
  export type AssignablePublicRole = components['schemas']['AssignablePublicRole'];
11
11
  export type AttributeCondition = components['schemas']['AttributeCondition'];
12
12
  export type AttributeType = components['schemas']['AttributeType'];
13
+ export type Auth = components['schemas']['Auth'];
13
14
  export type BatchSortField = components['schemas']['BatchSortField'];
14
15
  export type BatchStatus = components['schemas']['BatchStatus'];
15
16
  export type BillingMetadata = components['schemas']['BillingMetadata'];
@@ -19,6 +20,8 @@ export type BillingTransactionProductType = components['schemas']['BillingTransa
19
20
  export type BillingTransaction = components['schemas']['BillingTransactionResponse'];
20
21
  export type BillingTransactionSortField = components['schemas']['BillingTransactionSortField'];
21
22
  export type BillingTransactionStatus = components['schemas']['BillingTransactionStatus'];
23
+ export type Brand = components['schemas']['Brand'];
24
+ export type BrandingDocument = components['schemas']['BrandingDocument'];
22
25
  export type BrowserStatsBucket = components['schemas']['BrowserStatsBucket'];
23
26
  export type BulkObjectTagChanges = components['schemas']['BulkObjectTagChanges'];
24
27
  export type ClaimsNotice = components['schemas']['ClaimsNotice'];
@@ -65,6 +68,7 @@ export type ContactVerificationStatus = components['schemas']['ContactVerificati
65
68
  export type ContactsBase = components['schemas']['ContactsBase'];
66
69
  export type ContactsContext = components['schemas']['ContactsContext'];
67
70
  export type ContactsContextCreate = components['schemas']['ContactsContextCreate'];
71
+ export type Content = components['schemas']['Content'];
68
72
  export type ContextList = components['schemas']['ContextListResponse'];
69
73
  export type ContextMeta = components['schemas']['ContextMeta'];
70
74
  export type ContextPayload_DomainForward = components['schemas']['ContextPayload_DomainForward_'];
@@ -295,6 +299,7 @@ export type EventSubtype = components['schemas']['EventSubtype'];
295
299
  export type EventType = components['schemas']['EventType'];
296
300
  export type EventVersion = components['schemas']['EventVersion'];
297
301
  export type ExecutingEntity = components['schemas']['ExecutingEntity'];
302
+ export type Footer = components['schemas']['Footer'];
298
303
  export type GeneralAvailabilityBase = components['schemas']['GeneralAvailabilityBase'];
299
304
  export type GeoStatsBucket = components['schemas']['GeoStatsBucket'];
300
305
  export type GetPrices = components['schemas']['GetPricesResponse'];
@@ -332,6 +337,7 @@ export type JsonValue = components['schemas']['JsonValue'];
332
337
  export type LaunchPhaseBase = components['schemas']['LaunchPhaseBase'];
333
338
  export type LaunchPhaseType = components['schemas']['LaunchPhaseType'];
334
339
  export type LaunchPhasesBase = components['schemas']['LaunchPhasesBase'];
340
+ export type Legal = components['schemas']['Legal'];
335
341
  export type LegalRequirementBase = components['schemas']['LegalRequirementBase'];
336
342
  export type LegalRequirementOperationType = components['schemas']['LegalRequirementOperationType'];
337
343
  export type LegalRequirementType = components['schemas']['LegalRequirementType'];
@@ -339,6 +345,7 @@ export type ListVanityNameserverSetsRes = components['schemas']['ListVanityNames
339
345
  export type ListZonesReferencingSetRes = components['schemas']['ListZonesReferencingSetRes'];
340
346
  export type LocalPresenceBase = components['schemas']['LocalPresenceBase'];
341
347
  export type LocalPresenceRequirementType = components['schemas']['LocalPresenceRequirementType'];
348
+ export type Logo = components['schemas']['Logo'];
342
349
  export type MemoryFact = components['schemas']['MemoryFact'];
343
350
  export type MemoryFactCreateRequest = components['schemas']['MemoryFactCreateRequest'];
344
351
  export type MemoryFactKind = components['schemas']['MemoryFactKind'];
@@ -394,6 +401,7 @@ export type Pagination_Invoice = components['schemas']['Pagination_InvoiceRespon
394
401
  export type Pagination_Organization = components['schemas']['Pagination_Organization_'];
395
402
  export type Pagination_Tag = components['schemas']['Pagination_TagResponse_'];
396
403
  export type Pagination_UserPublicWithRole = components['schemas']['Pagination_UserPublicWithRole_'];
404
+ export type Palette = components['schemas']['Palette'];
397
405
  export type ParkingActionPayloadData = components['schemas']['ParkingActionPayloadData'];
398
406
  export type ParkingAgreementAcceptance = components['schemas']['ParkingAgreementAcceptance'];
399
407
  export type ParkingCreateBulkCommand = components['schemas']['ParkingCreateBulkCommand'];
@@ -437,6 +445,8 @@ export type PremiumPricingAction = components['schemas']['PremiumPricingAction']
437
445
  export type PremiumPricingRes = components['schemas']['PremiumPricingRes'];
438
446
  export type PremiumPricing = components['schemas']['PremiumPricingResponse'];
439
447
  export type PremiumSourceType = components['schemas']['PremiumSourceType'];
448
+ export type PreviewMailReq = components['schemas']['PreviewMailReq'];
449
+ export type PreviewMailRes = components['schemas']['PreviewMailRes'];
440
450
  export type PriceInfo = components['schemas']['PriceInfo'];
441
451
  export type PricingPeriod = components['schemas']['PricingPeriod'];
442
452
  export type Problem = components['schemas']['Problem'];
@@ -482,6 +492,7 @@ export type StatusCodeStatsBucket = components['schemas']['StatusCodeStatsBucket
482
492
  export type StatusTag = components['schemas']['StatusTagResponse'];
483
493
  export type StatusTagType = components['schemas']['StatusTagType'];
484
494
  export type StrictMoneyDecimal = components['schemas']['StrictMoneyDecimal'];
495
+ export type Support = components['schemas']['Support'];
485
496
  export type SyncOperationType = components['schemas']['SyncOperationType'];
486
497
  export type TLDType = components['schemas']['TLDType'];
487
498
  export type TagColor = components['schemas']['TagColor'];
@@ -492,6 +503,7 @@ export type Tag = components['schemas']['TagResponse'];
492
503
  export type TagSortField = components['schemas']['TagSortField'];
493
504
  export type TagType = components['schemas']['TagType'];
494
505
  export type TagUpdate = components['schemas']['TagUpdate'];
506
+ export type Theme = components['schemas']['Theme'];
495
507
  export type TimeRange = components['schemas']['TimeRange'];
496
508
  export type TimeSeriesBucket = components['schemas']['TimeSeriesBucket'];
497
509
  export type TldBase = components['schemas']['TldBase'];
package/src/openapi.yaml CHANGED
@@ -180,6 +180,36 @@ components:
180
180
  - uri_template
181
181
  title: AttributeType
182
182
  type: string
183
+ Auth:
184
+ description: 'Pre-login OAuth bootstrap. The SPA resolves this document by hostname
185
+ before login and uses
186
+
187
+ `client_id` (the org''s `wl-<organization_id>` Keycloak client) + `authority`
188
+ (the OIDC issuer on
189
+
190
+ the customer''s auth host) to start the flow; absent, it falls back to the
191
+ default dashboard client.
192
+
193
+
194
+ System-owned: written only by onboarding (via branding-service''s set-auth
195
+ endpoint), never by a
196
+
197
+ customer document write - branding-service preserves this block across customer
198
+ upserts.'
199
+ properties:
200
+ authority:
201
+ anyOf:
202
+ - type: string
203
+ - type: 'null'
204
+ title: Authority
205
+ client_id:
206
+ anyOf:
207
+ - pattern: ^[a-zA-Z0-9._-]{1,255}$
208
+ type: string
209
+ - type: 'null'
210
+ title: Client Id
211
+ title: Auth
212
+ type: object
183
213
  BatchSortField:
184
214
  enum:
185
215
  - created_on
@@ -355,6 +385,45 @@ components:
355
385
  - canceled
356
386
  title: BillingTransactionStatus
357
387
  type: string
388
+ Brand:
389
+ properties:
390
+ logo:
391
+ anyOf:
392
+ - $ref: '#/components/schemas/Logo'
393
+ - type: 'null'
394
+ name:
395
+ anyOf:
396
+ - maxLength: 255
397
+ minLength: 1
398
+ type: string
399
+ - type: 'null'
400
+ title: Name
401
+ title: Brand
402
+ type: object
403
+ BrandingDocument:
404
+ properties:
405
+ auth:
406
+ anyOf:
407
+ - $ref: '#/components/schemas/Auth'
408
+ - type: 'null'
409
+ brand:
410
+ anyOf:
411
+ - $ref: '#/components/schemas/Brand'
412
+ - type: 'null'
413
+ content:
414
+ anyOf:
415
+ - $ref: '#/components/schemas/Content'
416
+ - type: 'null'
417
+ theme:
418
+ anyOf:
419
+ - $ref: '#/components/schemas/Theme'
420
+ - type: 'null'
421
+ version:
422
+ default: 1
423
+ title: Version
424
+ type: integer
425
+ title: BrandingDocument
426
+ type: object
358
427
  BrowserStatsBucket:
359
428
  properties:
360
429
  key:
@@ -1938,6 +2007,42 @@ components:
1938
2007
  - payload
1939
2008
  title: ContactsContextCreate
1940
2009
  type: object
2010
+ Content:
2011
+ properties:
2012
+ email_blocks:
2013
+ anyOf:
2014
+ - patternProperties:
2015
+ ^[a-z0-9_]+$:
2016
+ patternProperties:
2017
+ ^[a-z0-9_]+$:
2018
+ patternProperties:
2019
+ ^[a-z]{2}(-[a-z]{2})?$:
2020
+ maxLength: 2000
2021
+ type: string
2022
+ type: object
2023
+ type: object
2024
+ type: object
2025
+ - type: 'null'
2026
+ title: Email Blocks
2027
+ footer:
2028
+ anyOf:
2029
+ - $ref: '#/components/schemas/Footer'
2030
+ - type: 'null'
2031
+ legal:
2032
+ anyOf:
2033
+ - $ref: '#/components/schemas/Legal'
2034
+ - type: 'null'
2035
+ signature:
2036
+ anyOf:
2037
+ - type: string
2038
+ - type: 'null'
2039
+ title: Signature
2040
+ support:
2041
+ anyOf:
2042
+ - $ref: '#/components/schemas/Support'
2043
+ - type: 'null'
2044
+ title: Content
2045
+ type: object
1941
2046
  ContextListResponse:
1942
2047
  properties:
1943
2048
  pagination:
@@ -7420,6 +7525,44 @@ components:
7420
7525
  - system
7421
7526
  title: ExecutingEntity
7422
7527
  type: string
7528
+ Footer:
7529
+ properties:
7530
+ contact_email:
7531
+ anyOf:
7532
+ - pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$
7533
+ type: string
7534
+ - type: 'null'
7535
+ title: Contact Email
7536
+ disclaimer:
7537
+ anyOf:
7538
+ - type: string
7539
+ - type: 'null'
7540
+ title: Disclaimer
7541
+ legal_entity:
7542
+ anyOf:
7543
+ - maxLength: 255
7544
+ minLength: 1
7545
+ type: string
7546
+ - type: 'null'
7547
+ title: Legal Entity
7548
+ lines:
7549
+ anyOf:
7550
+ - items:
7551
+ maxLength: 255
7552
+ minLength: 1
7553
+ type: string
7554
+ type: array
7555
+ - type: 'null'
7556
+ title: Lines
7557
+ vat_id:
7558
+ anyOf:
7559
+ - maxLength: 255
7560
+ minLength: 1
7561
+ type: string
7562
+ - type: 'null'
7563
+ title: Vat Id
7564
+ title: Footer
7565
+ type: object
7423
7566
  GeneralAvailabilityBase:
7424
7567
  properties:
7425
7568
  start_date:
@@ -8578,6 +8721,20 @@ components:
8578
8721
  - general_availability
8579
8722
  title: LaunchPhasesBase
8580
8723
  type: object
8724
+ Legal:
8725
+ properties:
8726
+ privacy_url:
8727
+ anyOf:
8728
+ - type: string
8729
+ - type: 'null'
8730
+ title: Privacy Url
8731
+ terms_url:
8732
+ anyOf:
8733
+ - type: string
8734
+ - type: 'null'
8735
+ title: Terms Url
8736
+ title: Legal
8737
+ type: object
8581
8738
  LegalRequirementBase:
8582
8739
  properties:
8583
8740
  key:
@@ -8702,6 +8859,30 @@ components:
8702
8859
  - business_entity
8703
8860
  title: LocalPresenceRequirementType
8704
8861
  type: string
8862
+ Logo:
8863
+ properties:
8864
+ dark:
8865
+ anyOf:
8866
+ - type: string
8867
+ - type: 'null'
8868
+ title: Dark
8869
+ favicon:
8870
+ anyOf:
8871
+ - type: string
8872
+ - type: 'null'
8873
+ title: Favicon
8874
+ icon:
8875
+ anyOf:
8876
+ - type: string
8877
+ - type: 'null'
8878
+ title: Icon
8879
+ light:
8880
+ anyOf:
8881
+ - type: string
8882
+ - type: 'null'
8883
+ title: Light
8884
+ title: Logo
8885
+ type: object
8705
8886
  MemoryFact:
8706
8887
  properties:
8707
8888
  created_at:
@@ -10334,6 +10515,146 @@ components:
10334
10515
  - pagination
10335
10516
  title: Pagination[UserPublicWithRole]
10336
10517
  type: object
10518
+ Palette:
10519
+ properties:
10520
+ accent:
10521
+ anyOf:
10522
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10523
+ type: string
10524
+ - type: 'null'
10525
+ title: Accent
10526
+ accent_foreground:
10527
+ anyOf:
10528
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10529
+ type: string
10530
+ - type: 'null'
10531
+ title: Accent Foreground
10532
+ background:
10533
+ anyOf:
10534
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10535
+ type: string
10536
+ - type: 'null'
10537
+ title: Background
10538
+ border:
10539
+ anyOf:
10540
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10541
+ type: string
10542
+ - type: 'null'
10543
+ title: Border
10544
+ card:
10545
+ anyOf:
10546
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10547
+ type: string
10548
+ - type: 'null'
10549
+ title: Card
10550
+ card_foreground:
10551
+ anyOf:
10552
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10553
+ type: string
10554
+ - type: 'null'
10555
+ title: Card Foreground
10556
+ chart_colors:
10557
+ anyOf:
10558
+ - items:
10559
+ pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10560
+ type: string
10561
+ type: array
10562
+ - type: 'null'
10563
+ title: Chart Colors
10564
+ danger:
10565
+ anyOf:
10566
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10567
+ type: string
10568
+ - type: 'null'
10569
+ title: Danger
10570
+ foreground:
10571
+ anyOf:
10572
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10573
+ type: string
10574
+ - type: 'null'
10575
+ title: Foreground
10576
+ info:
10577
+ anyOf:
10578
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10579
+ type: string
10580
+ - type: 'null'
10581
+ title: Info
10582
+ input:
10583
+ anyOf:
10584
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10585
+ type: string
10586
+ - type: 'null'
10587
+ title: Input
10588
+ muted:
10589
+ anyOf:
10590
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10591
+ type: string
10592
+ - type: 'null'
10593
+ title: Muted
10594
+ muted_foreground:
10595
+ anyOf:
10596
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10597
+ type: string
10598
+ - type: 'null'
10599
+ title: Muted Foreground
10600
+ primary:
10601
+ anyOf:
10602
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10603
+ type: string
10604
+ - type: 'null'
10605
+ title: Primary
10606
+ primary_foreground:
10607
+ anyOf:
10608
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10609
+ type: string
10610
+ - type: 'null'
10611
+ title: Primary Foreground
10612
+ secondary:
10613
+ anyOf:
10614
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10615
+ type: string
10616
+ - type: 'null'
10617
+ title: Secondary
10618
+ secondary_foreground:
10619
+ anyOf:
10620
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10621
+ type: string
10622
+ - type: 'null'
10623
+ title: Secondary Foreground
10624
+ sidebar:
10625
+ anyOf:
10626
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10627
+ type: string
10628
+ - type: 'null'
10629
+ title: Sidebar
10630
+ sidebar_foreground:
10631
+ anyOf:
10632
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10633
+ type: string
10634
+ - type: 'null'
10635
+ title: Sidebar Foreground
10636
+ success:
10637
+ anyOf:
10638
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10639
+ type: string
10640
+ - type: 'null'
10641
+ title: Success
10642
+ tag_colors:
10643
+ anyOf:
10644
+ - items:
10645
+ pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10646
+ type: string
10647
+ type: array
10648
+ - type: 'null'
10649
+ title: Tag Colors
10650
+ warning:
10651
+ anyOf:
10652
+ - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
10653
+ type: string
10654
+ - type: 'null'
10655
+ title: Warning
10656
+ title: Palette
10657
+ type: object
10337
10658
  ParkingActionPayloadData:
10338
10659
  properties:
10339
10660
  parking_reference:
@@ -11060,6 +11381,40 @@ components:
11060
11381
  - manual
11061
11382
  title: PremiumSourceType
11062
11383
  type: string
11384
+ PreviewMailReq:
11385
+ properties:
11386
+ branding_document:
11387
+ anyOf:
11388
+ - $ref: '#/components/schemas/BrandingDocument'
11389
+ - type: 'null'
11390
+ language_code:
11391
+ title: Language Code
11392
+ type: string
11393
+ template_name:
11394
+ title: Template Name
11395
+ type: string
11396
+ required:
11397
+ - template_name
11398
+ - language_code
11399
+ title: PreviewMailReq
11400
+ type: object
11401
+ PreviewMailRes:
11402
+ properties:
11403
+ html:
11404
+ title: Html
11405
+ type: string
11406
+ subject:
11407
+ title: Subject
11408
+ type: string
11409
+ text:
11410
+ title: Text
11411
+ type: string
11412
+ required:
11413
+ - subject
11414
+ - html
11415
+ - text
11416
+ title: PreviewMailRes
11417
+ type: object
11063
11418
  PriceInfo:
11064
11419
  properties:
11065
11420
  currency:
@@ -11970,6 +12325,21 @@ components:
11970
12325
  - '12.50'
11971
12326
  pattern: ^\d{1,8}\.\d{2}$
11972
12327
  type: string
12328
+ Support:
12329
+ properties:
12330
+ email:
12331
+ anyOf:
12332
+ - pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$
12333
+ type: string
12334
+ - type: 'null'
12335
+ title: Email
12336
+ url:
12337
+ anyOf:
12338
+ - type: string
12339
+ - type: 'null'
12340
+ title: Url
12341
+ title: Support
12342
+ type: object
11973
12343
  SyncOperationType:
11974
12344
  enum:
11975
12345
  - registration
@@ -12150,6 +12520,35 @@ components:
12150
12520
  title: Label
12151
12521
  title: TagUpdate
12152
12522
  type: object
12523
+ Theme:
12524
+ properties:
12525
+ dark:
12526
+ anyOf:
12527
+ - $ref: '#/components/schemas/Palette'
12528
+ - type: 'null'
12529
+ font_family:
12530
+ anyOf:
12531
+ - pattern: ^[0-9a-zA-Z, -]{1,128}$
12532
+ type: string
12533
+ - type: 'null'
12534
+ title: Font Family
12535
+ font_url:
12536
+ anyOf:
12537
+ - type: string
12538
+ - type: 'null'
12539
+ title: Font Url
12540
+ light:
12541
+ anyOf:
12542
+ - $ref: '#/components/schemas/Palette'
12543
+ - type: 'null'
12544
+ radius:
12545
+ anyOf:
12546
+ - pattern: ^[0-9a-zA-Z.% ]{1,32}$
12547
+ type: string
12548
+ - type: 'null'
12549
+ title: Radius
12550
+ title: Theme
12551
+ type: object
12153
12552
  TimeRange:
12154
12553
  enum:
12155
12554
  - 1h
@@ -14256,7 +14655,7 @@ info:
14256
14655
  \n\n"
14257
14656
  summary: OpusDNS - your gateway to a seamless domain management experience.
14258
14657
  title: OpusDNS API
14259
- version: 2026-07-21-195001
14658
+ version: 2026-07-22-134959
14260
14659
  x-logo:
14261
14660
  altText: OpusDNS API Reference
14262
14661
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -30808,6 +31207,67 @@ paths:
30808
31207
  - whitelabel
30809
31208
  x-required-permissions:
30810
31209
  - whitelabel_branding:manage
31210
+ /v1/whitelabel-branding/email/preview:
31211
+ post:
31212
+ operationId: preview_whitelabel_email_v1_whitelabel_branding_email_preview_post
31213
+ parameters:
31214
+ - $ref: '#/components/parameters/DatetimeFormatHeader'
31215
+ requestBody:
31216
+ content:
31217
+ application/json:
31218
+ schema:
31219
+ $ref: '#/components/schemas/PreviewMailReq'
31220
+ required: true
31221
+ responses:
31222
+ '200':
31223
+ content:
31224
+ application/json:
31225
+ schema:
31226
+ $ref: '#/components/schemas/PreviewMailRes'
31227
+ description: Successful Response
31228
+ '422':
31229
+ content:
31230
+ application/problem+json:
31231
+ schema:
31232
+ $ref: '#/components/schemas/HTTPValidationError'
31233
+ description: Validation Error
31234
+ security:
31235
+ - OAuth2PasswordBearer: []
31236
+ - APIKeyHeader: []
31237
+ summary: Preview a transactional email template with a draft branding document
31238
+ tags:
31239
+ - whitelabel
31240
+ x-required-permissions:
31241
+ - whitelabel_branding:manage
31242
+ /v1/whitelabel-branding/email/templates:
31243
+ get:
31244
+ operationId: list_whitelabel_email_templates_v1_whitelabel_branding_email_templates_get
31245
+ parameters:
31246
+ - $ref: '#/components/parameters/DatetimeFormatHeader'
31247
+ responses:
31248
+ '200':
31249
+ content:
31250
+ application/json:
31251
+ schema:
31252
+ additionalProperties: true
31253
+ title: Response List Whitelabel Email Templates V1 Whitelabel Branding
31254
+ Email Templates Get
31255
+ type: object
31256
+ description: Successful Response
31257
+ '422':
31258
+ content:
31259
+ application/problem+json:
31260
+ schema:
31261
+ $ref: '#/components/schemas/HTTPValidationError'
31262
+ description: Validation Error
31263
+ security:
31264
+ - OAuth2PasswordBearer: []
31265
+ - APIKeyHeader: []
31266
+ summary: List the editable transactional email templates and their content blocks
31267
+ tags:
31268
+ - whitelabel
31269
+ x-required-permissions:
31270
+ - whitelabel_branding:read
30811
31271
  /v1/whitelabel-branding/recheck:
30812
31272
  post:
30813
31273
  operationId: recheck_whitelabel_branding_v1_whitelabel_branding_recheck_post
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"];
@@ -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}
@@ -26013,6 +26203,82 @@ export interface operations {
26013
26203
  };
26014
26204
  };
26015
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
+ };
26016
26282
  recheck_whitelabel_branding_v1_whitelabel_branding_recheck_post: {
26017
26283
  parameters: {
26018
26284
  query?: never;