@opusdns/api 1.159.0 → 1.161.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/schema.d.ts CHANGED
@@ -3032,6 +3032,60 @@ export interface paths {
3032
3032
  patch: operations["patch_whitelabel_branding_v1_whitelabel_branding_patch"];
3033
3033
  trace?: never;
3034
3034
  };
3035
+ "/v1/whitelabel-branding/assets": {
3036
+ parameters: {
3037
+ query?: never;
3038
+ header?: never;
3039
+ path?: never;
3040
+ cookie?: never;
3041
+ };
3042
+ /** List uploaded branding assets */
3043
+ get: operations["list_whitelabel_assets_v1_whitelabel_branding_assets_get"];
3044
+ put?: never;
3045
+ /** Upload a branding asset */
3046
+ post: operations["upload_whitelabel_asset_v1_whitelabel_branding_assets_post"];
3047
+ delete?: never;
3048
+ options?: never;
3049
+ head?: never;
3050
+ patch?: never;
3051
+ trace?: never;
3052
+ };
3053
+ "/v1/whitelabel-branding/assets/{asset_id}": {
3054
+ parameters: {
3055
+ query?: never;
3056
+ header?: never;
3057
+ path?: never;
3058
+ cookie?: never;
3059
+ };
3060
+ get?: never;
3061
+ put?: never;
3062
+ post?: never;
3063
+ /** Delete an uploaded branding asset */
3064
+ delete: operations["delete_whitelabel_asset_v1_whitelabel_branding_assets__asset_id__delete"];
3065
+ options?: never;
3066
+ head?: never;
3067
+ patch?: never;
3068
+ trace?: never;
3069
+ };
3070
+ "/v1/whitelabel-branding/document": {
3071
+ parameters: {
3072
+ query?: never;
3073
+ header?: never;
3074
+ path?: never;
3075
+ cookie?: never;
3076
+ };
3077
+ /** Get the stored branding document */
3078
+ get: operations["get_whitelabel_document_v1_whitelabel_branding_document_get"];
3079
+ /** Upsert the branding document */
3080
+ put: operations["put_whitelabel_document_v1_whitelabel_branding_document_put"];
3081
+ /** Upsert the branding document */
3082
+ post: operations["put_whitelabel_document_v1_whitelabel_branding_document_post"];
3083
+ delete?: never;
3084
+ options?: never;
3085
+ head?: never;
3086
+ patch?: never;
3087
+ trace?: never;
3088
+ };
3035
3089
  "/v1/whitelabel-branding/email/preview": {
3036
3090
  parameters: {
3037
3091
  query?: never;
@@ -3456,12 +3510,49 @@ export interface components {
3456
3510
  * @enum {string}
3457
3511
  */
3458
3512
  BillingTransactionStatus: "pending" | "succeeded" | "failed" | "canceled";
3513
+ /** Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post */
3514
+ Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post: {
3515
+ /**
3516
+ * File
3517
+ * @description Asset file (image/font)
3518
+ */
3519
+ file: string;
3520
+ };
3459
3521
  /** Brand */
3460
3522
  Brand: {
3461
3523
  logo?: components["schemas"]["Logo"] | null;
3462
3524
  /** Name */
3463
3525
  name?: string | null;
3464
3526
  };
3527
+ /** BrandingAsset */
3528
+ BrandingAsset: {
3529
+ /**
3530
+ * Asset Id
3531
+ * @description Opaque handle used to delete or reference the asset
3532
+ */
3533
+ asset_id: string;
3534
+ /**
3535
+ * Asset Url
3536
+ * @description Public URL of the asset
3537
+ */
3538
+ asset_url: string;
3539
+ /**
3540
+ * Content Type
3541
+ * @description MIME type of the asset
3542
+ */
3543
+ content_type?: string | null;
3544
+ /**
3545
+ * Size Bytes
3546
+ * @description Asset size in bytes
3547
+ */
3548
+ size_bytes: number;
3549
+ /**
3550
+ * Updated On
3551
+ * Format: date-time
3552
+ * @description Last-modified timestamp
3553
+ */
3554
+ updated_on: Date;
3555
+ };
3465
3556
  /** BrandingDocument */
3466
3557
  BrandingDocument: {
3467
3558
  auth?: components["schemas"]["Auth"] | null;
@@ -5642,10 +5733,10 @@ export interface components {
5642
5733
  *
5643
5734
  * Customer-settable keys:
5644
5735
  *
5645
- * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
5736
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
5646
5737
  * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
5647
- * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
5648
- * month-unit renewal period.
5738
+ * period added by the transfer. When the TLD has no month-unit renewal period, `monthly` is rejected on update and on
5739
+ * a transfer-in that omits `period`, and ignored at renewal.
5649
5740
  * - `music_registrant_attestation`: `true`. `.music` registration.
5650
5741
  * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
5651
5742
  * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
@@ -5660,11 +5751,16 @@ export interface components {
5660
5751
  * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
5661
5752
  * returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
5662
5753
  *
5663
- * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
5754
+ * Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
5664
5755
  * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
5665
5756
  *
5666
- * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
5667
- * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
5757
+ * On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
5758
+ * store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
5759
+ * `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
5760
+ * `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
5761
+ * registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
5762
+ * `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
5763
+ * `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
5668
5764
  *
5669
5765
  * @example {
5670
5766
  * "auto_renew_period": "monthly"
@@ -5745,10 +5841,10 @@ export interface components {
5745
5841
  *
5746
5842
  * Customer-settable keys:
5747
5843
  *
5748
- * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
5844
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
5749
5845
  * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
5750
- * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
5751
- * month-unit renewal period.
5846
+ * period added by the transfer. When the TLD has no month-unit renewal period, `monthly` is rejected on update and on
5847
+ * a transfer-in that omits `period`, and ignored at renewal.
5752
5848
  * - `music_registrant_attestation`: `true`. `.music` registration.
5753
5849
  * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
5754
5850
  * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
@@ -5763,11 +5859,16 @@ export interface components {
5763
5859
  * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
5764
5860
  * returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
5765
5861
  *
5766
- * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
5862
+ * Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
5767
5863
  * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
5768
5864
  *
5769
- * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
5770
- * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
5865
+ * On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
5866
+ * store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
5867
+ * `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
5868
+ * `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
5869
+ * registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
5870
+ * `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
5871
+ * `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
5771
5872
  *
5772
5873
  */
5773
5874
  attributes?: {
@@ -5820,10 +5921,10 @@ export interface components {
5820
5921
  *
5821
5922
  * Customer-settable keys:
5822
5923
  *
5823
- * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
5924
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
5824
5925
  * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
5825
- * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
5826
- * month-unit renewal period.
5926
+ * period added by the transfer. When the TLD has no month-unit renewal period, `monthly` is rejected on update and on
5927
+ * a transfer-in that omits `period`, and ignored at renewal.
5827
5928
  * - `music_registrant_attestation`: `true`. `.music` registration.
5828
5929
  * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
5829
5930
  * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
@@ -5838,11 +5939,16 @@ export interface components {
5838
5939
  * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
5839
5940
  * returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
5840
5941
  *
5841
- * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
5942
+ * Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
5842
5943
  * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
5843
5944
  *
5844
- * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
5845
- * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
5945
+ * On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
5946
+ * store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
5947
+ * `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
5948
+ * `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
5949
+ * registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
5950
+ * `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
5951
+ * `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
5846
5952
  *
5847
5953
  */
5848
5954
  attributes?: {
@@ -5899,10 +6005,10 @@ export interface components {
5899
6005
  *
5900
6006
  * Customer-settable keys:
5901
6007
  *
5902
- * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
6008
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
5903
6009
  * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
5904
- * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
5905
- * month-unit renewal period.
6010
+ * period added by the transfer. When the TLD has no month-unit renewal period, `monthly` is rejected on update and on
6011
+ * a transfer-in that omits `period`, and ignored at renewal.
5906
6012
  * - `music_registrant_attestation`: `true`. `.music` registration.
5907
6013
  * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
5908
6014
  * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
@@ -5917,11 +6023,16 @@ export interface components {
5917
6023
  * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
5918
6024
  * returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
5919
6025
  *
5920
- * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
6026
+ * Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
5921
6027
  * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
5922
6028
  *
5923
- * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
5924
- * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
6029
+ * On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
6030
+ * store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
6031
+ * `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
6032
+ * `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
6033
+ * registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
6034
+ * `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
6035
+ * `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
5925
6036
  *
5926
6037
  * @example {
5927
6038
  * "auto_renew_period": "monthly"
@@ -7145,10 +7256,10 @@ export interface components {
7145
7256
  *
7146
7257
  * Customer-settable keys:
7147
7258
  *
7148
- * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7259
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
7149
7260
  * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7150
- * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7151
- * month-unit renewal period.
7261
+ * period added by the transfer. When the TLD has no month-unit renewal period, `monthly` is rejected on update and on
7262
+ * a transfer-in that omits `period`, and ignored at renewal.
7152
7263
  * - `music_registrant_attestation`: `true`. `.music` registration.
7153
7264
  * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7154
7265
  * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
@@ -7163,11 +7274,16 @@ export interface components {
7163
7274
  * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
7164
7275
  * returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
7165
7276
  *
7166
- * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7277
+ * Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
7167
7278
  * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7168
7279
  *
7169
- * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7170
- * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7280
+ * On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
7281
+ * store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
7282
+ * `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
7283
+ * `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
7284
+ * registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
7285
+ * `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
7286
+ * `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
7171
7287
  *
7172
7288
  */
7173
7289
  attributes?: {
@@ -7220,10 +7336,10 @@ export interface components {
7220
7336
  *
7221
7337
  * Customer-settable keys:
7222
7338
  *
7223
- * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7339
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
7224
7340
  * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7225
- * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7226
- * month-unit renewal period.
7341
+ * period added by the transfer. When the TLD has no month-unit renewal period, `monthly` is rejected on update and on
7342
+ * a transfer-in that omits `period`, and ignored at renewal.
7227
7343
  * - `music_registrant_attestation`: `true`. `.music` registration.
7228
7344
  * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7229
7345
  * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
@@ -7238,11 +7354,16 @@ export interface components {
7238
7354
  * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
7239
7355
  * returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
7240
7356
  *
7241
- * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7357
+ * Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
7242
7358
  * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7243
7359
  *
7244
- * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7245
- * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7360
+ * On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
7361
+ * store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
7362
+ * `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
7363
+ * `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
7364
+ * registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
7365
+ * `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
7366
+ * `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
7246
7367
  *
7247
7368
  */
7248
7369
  attributes?: {
@@ -7295,10 +7416,10 @@ export interface components {
7295
7416
  *
7296
7417
  * Customer-settable keys:
7297
7418
  *
7298
- * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7419
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
7299
7420
  * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7300
- * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7301
- * month-unit renewal period.
7421
+ * period added by the transfer. When the TLD has no month-unit renewal period, `monthly` is rejected on update and on
7422
+ * a transfer-in that omits `period`, and ignored at renewal.
7302
7423
  * - `music_registrant_attestation`: `true`. `.music` registration.
7303
7424
  * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7304
7425
  * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
@@ -7313,11 +7434,16 @@ export interface components {
7313
7434
  * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
7314
7435
  * returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
7315
7436
  *
7316
- * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7437
+ * Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
7317
7438
  * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7318
7439
  *
7319
- * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7320
- * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7440
+ * On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
7441
+ * store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
7442
+ * `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
7443
+ * `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
7444
+ * registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
7445
+ * `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
7446
+ * `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
7321
7447
  *
7322
7448
  * @example {
7323
7449
  * "auto_renew_period": "monthly"
@@ -7370,10 +7496,10 @@ export interface components {
7370
7496
  *
7371
7497
  * Customer-settable keys:
7372
7498
  *
7373
- * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7499
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
7374
7500
  * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7375
- * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7376
- * month-unit renewal period.
7501
+ * period added by the transfer. When the TLD has no month-unit renewal period, `monthly` is rejected on update and on
7502
+ * a transfer-in that omits `period`, and ignored at renewal.
7377
7503
  * - `music_registrant_attestation`: `true`. `.music` registration.
7378
7504
  * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7379
7505
  * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
@@ -7388,11 +7514,16 @@ export interface components {
7388
7514
  * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
7389
7515
  * returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
7390
7516
  *
7391
- * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7517
+ * Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
7392
7518
  * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7393
7519
  *
7394
- * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7395
- * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7520
+ * On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
7521
+ * store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
7522
+ * `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
7523
+ * `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
7524
+ * registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
7525
+ * `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
7526
+ * `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
7396
7527
  *
7397
7528
  * @example {
7398
7529
  * "auto_renew_period": "monthly"
@@ -7477,10 +7608,10 @@ export interface components {
7477
7608
  *
7478
7609
  * Customer-settable keys:
7479
7610
  *
7480
- * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7611
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
7481
7612
  * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7482
- * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7483
- * month-unit renewal period.
7613
+ * period added by the transfer. When the TLD has no month-unit renewal period, `monthly` is rejected on update and on
7614
+ * a transfer-in that omits `period`, and ignored at renewal.
7484
7615
  * - `music_registrant_attestation`: `true`. `.music` registration.
7485
7616
  * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7486
7617
  * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
@@ -7495,11 +7626,16 @@ export interface components {
7495
7626
  * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
7496
7627
  * returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
7497
7628
  *
7498
- * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7629
+ * Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
7499
7630
  * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7500
7631
  *
7501
- * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7502
- * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7632
+ * On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
7633
+ * store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
7634
+ * `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
7635
+ * `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
7636
+ * registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
7637
+ * `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
7638
+ * `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
7503
7639
  *
7504
7640
  * @example {
7505
7641
  * "auto_renew_period": "monthly"
@@ -7652,10 +7788,10 @@ export interface components {
7652
7788
  *
7653
7789
  * Customer-settable keys:
7654
7790
  *
7655
- * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7791
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
7656
7792
  * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7657
- * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7658
- * month-unit renewal period.
7793
+ * period added by the transfer. When the TLD has no month-unit renewal period, `monthly` is rejected on update and on
7794
+ * a transfer-in that omits `period`, and ignored at renewal.
7659
7795
  * - `music_registrant_attestation`: `true`. `.music` registration.
7660
7796
  * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7661
7797
  * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
@@ -7670,11 +7806,16 @@ export interface components {
7670
7806
  * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
7671
7807
  * returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
7672
7808
  *
7673
- * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7809
+ * Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
7674
7810
  * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7675
7811
  *
7676
- * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7677
- * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7812
+ * On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
7813
+ * store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
7814
+ * `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
7815
+ * `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
7816
+ * registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
7817
+ * `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
7818
+ * `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
7678
7819
  *
7679
7820
  * @example {
7680
7821
  * "auto_renew_period": "monthly"
@@ -9399,6 +9540,14 @@ export interface components {
9399
9540
  * @enum {string}
9400
9541
  */
9401
9542
  LegalRequirementType: "notice" | "confirmation";
9543
+ /** ListBrandingAssetsResponse */
9544
+ ListBrandingAssetsResponse: {
9545
+ /**
9546
+ * Assets
9547
+ * @description Uploaded assets, most recent first
9548
+ */
9549
+ assets?: components["schemas"]["BrandingAsset"][];
9550
+ };
9402
9551
  /** ListVanityNameserverSetsRes */
9403
9552
  ListVanityNameserverSetsRes: {
9404
9553
  /** @description Pagination metadata */
@@ -9462,9 +9611,7 @@ export interface components {
9462
9611
  };
9463
9612
  /**
9464
9613
  * MailTemplate
9465
- * @description One editable transactional email template. This is the public catalog entry:
9466
- * mail-service's operational fields (engine, internal, whitelabel, brand_defaults)
9467
- * are deliberately not declared, so the response model drops them.
9614
+ * @description One editable transactional email template in the catalog.
9468
9615
  */
9469
9616
  MailTemplate: {
9470
9617
  /**
@@ -9548,9 +9695,7 @@ export interface components {
9548
9695
  };
9549
9696
  /**
9550
9697
  * MailTemplateCategory
9551
- * @description Category a template is grouped under in the editor. mail-service owns the set
9552
- * and validates it; a value it adds before this enum is updated decodes to UNKNOWN
9553
- * rather than failing the catalog (see MailTemplate._coerce_category).
9698
+ * @description Category a template is grouped under in the editor. An unrecognised value decodes to `unknown`.
9554
9699
  * @enum {string}
9555
9700
  */
9556
9701
  MailTemplateCategory: "organization" | "billing" | "user_account" | "icann_policy" | "tld_specific" | "unknown";
@@ -11218,10 +11363,17 @@ export interface components {
11218
11363
  PremiumSourceType: "EPP" | "API" | "CSV" | "manual";
11219
11364
  /** PreviewMailReq */
11220
11365
  PreviewMailReq: {
11366
+ /** @description Draft branding document to render the preview with; omit to preview with the default OpusDNS branding. Only the fields the template uses are applied, the rest are ignored. */
11221
11367
  branding_document?: components["schemas"]["BrandingDocument"] | null;
11222
- /** Language Code */
11368
+ /**
11369
+ * Language Code
11370
+ * @description Locale to render in (e.g. en); falls back to the template's default
11371
+ */
11223
11372
  language_code: string;
11224
- /** Template Name */
11373
+ /**
11374
+ * Template Name
11375
+ * @description Template to render, as listed by the template catalog
11376
+ */
11225
11377
  template_name: string;
11226
11378
  };
11227
11379
  /** PreviewMailRes */
@@ -13256,9 +13408,9 @@ export interface components {
13256
13408
  * WhitelabelBrandingPatch
13257
13409
  * @description Public patch body. `label` moves the managed base subdomain to a different label (on plus the
13258
13410
  * custom domain is untouched - it is re-pointed by its hostnames through recheck) and `enabled`
13259
- * starts or stops serving - both applied asynchronously via the reconcile job, neither a purchase.
13260
- * `renewal_mode` sets the subscription's auto-renew intent synchronously (EXPIRE = cancel at period
13261
- * end, RENEW = un-cancel); it is not a purchase either - no price change. At least one must be given.
13411
+ * starts or stops serving - both applied asynchronously, neither a purchase. `renewal_mode` sets the
13412
+ * subscription's auto-renew intent synchronously (EXPIRE = cancel at period end, RENEW = un-cancel);
13413
+ * it is not a purchase either - no price change. At least one must be given.
13262
13414
  */
13263
13415
  WhitelabelBrandingPatch: {
13264
13416
  /**
@@ -13466,11 +13618,10 @@ export interface components {
13466
13618
  WhitelabelRenewalMode: "renew" | "expire";
13467
13619
  /**
13468
13620
  * WhitelabelSubscriptionInfo
13469
- * @description The whitelabel's billing-lifecycle state, a pass-through read from the subscription at the api
13470
- * layer (product-service owns it; the branding row does not). Grouped into its own object so it
13471
- * reads as one all-or-nothing block: the parent's `subscription` is null when the config has no live
13472
- * subscription (still provisioning, or terminated). renewal_mode EXPIRE + expires_on is how a
13473
- * cancelled whitelabel reads: "cancelled, served until expires_on".
13621
+ * @description The whitelabel's billing-lifecycle state, grouped into its own block: the parent's
13622
+ * `subscription` is null when the config has no live subscription (still provisioning, or
13623
+ * terminated). A cancelled whitelabel reads as renewal_mode=expire with expires_on set to when
13624
+ * serving stops.
13474
13625
  */
13475
13626
  WhitelabelSubscriptionInfo: {
13476
13627
  /**
@@ -28452,6 +28603,228 @@ export interface operations {
28452
28603
  };
28453
28604
  };
28454
28605
  };
28606
+ list_whitelabel_assets_v1_whitelabel_branding_assets_get: {
28607
+ parameters: {
28608
+ query?: never;
28609
+ header?: {
28610
+ /**
28611
+ * @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.
28612
+ * @example rfc3339
28613
+ */
28614
+ "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
28615
+ };
28616
+ path?: never;
28617
+ cookie?: never;
28618
+ };
28619
+ requestBody?: never;
28620
+ responses: {
28621
+ /** @description Successful Response */
28622
+ 200: {
28623
+ headers: {
28624
+ [name: string]: unknown;
28625
+ };
28626
+ content: {
28627
+ "application/json": components["schemas"]["ListBrandingAssetsResponse"];
28628
+ };
28629
+ };
28630
+ /** @description Validation Error */
28631
+ 422: {
28632
+ headers: {
28633
+ [name: string]: unknown;
28634
+ };
28635
+ content: {
28636
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
28637
+ };
28638
+ };
28639
+ };
28640
+ };
28641
+ upload_whitelabel_asset_v1_whitelabel_branding_assets_post: {
28642
+ parameters: {
28643
+ query?: never;
28644
+ header?: {
28645
+ /**
28646
+ * @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.
28647
+ * @example rfc3339
28648
+ */
28649
+ "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
28650
+ };
28651
+ path?: never;
28652
+ cookie?: never;
28653
+ };
28654
+ requestBody: {
28655
+ content: {
28656
+ "multipart/form-data": components["schemas"]["Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post"];
28657
+ };
28658
+ };
28659
+ responses: {
28660
+ /** @description Successful Response */
28661
+ 200: {
28662
+ headers: {
28663
+ [name: string]: unknown;
28664
+ };
28665
+ content: {
28666
+ "application/json": components["schemas"]["BrandingAsset"];
28667
+ };
28668
+ };
28669
+ /** @description Validation Error */
28670
+ 422: {
28671
+ headers: {
28672
+ [name: string]: unknown;
28673
+ };
28674
+ content: {
28675
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
28676
+ };
28677
+ };
28678
+ };
28679
+ };
28680
+ delete_whitelabel_asset_v1_whitelabel_branding_assets__asset_id__delete: {
28681
+ parameters: {
28682
+ query?: never;
28683
+ header?: {
28684
+ /**
28685
+ * @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.
28686
+ * @example rfc3339
28687
+ */
28688
+ "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
28689
+ };
28690
+ path: {
28691
+ asset_id: string;
28692
+ };
28693
+ cookie?: never;
28694
+ };
28695
+ requestBody?: never;
28696
+ responses: {
28697
+ /** @description Successful Response */
28698
+ 204: {
28699
+ headers: {
28700
+ [name: string]: unknown;
28701
+ };
28702
+ content?: never;
28703
+ };
28704
+ /** @description Validation Error */
28705
+ 422: {
28706
+ headers: {
28707
+ [name: string]: unknown;
28708
+ };
28709
+ content: {
28710
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
28711
+ };
28712
+ };
28713
+ };
28714
+ };
28715
+ get_whitelabel_document_v1_whitelabel_branding_document_get: {
28716
+ parameters: {
28717
+ query?: never;
28718
+ header?: {
28719
+ /**
28720
+ * @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.
28721
+ * @example rfc3339
28722
+ */
28723
+ "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
28724
+ };
28725
+ path?: never;
28726
+ cookie?: never;
28727
+ };
28728
+ requestBody?: never;
28729
+ responses: {
28730
+ /** @description Successful Response */
28731
+ 200: {
28732
+ headers: {
28733
+ [name: string]: unknown;
28734
+ };
28735
+ content: {
28736
+ "application/json": components["schemas"]["BrandingDocument"];
28737
+ };
28738
+ };
28739
+ /** @description Validation Error */
28740
+ 422: {
28741
+ headers: {
28742
+ [name: string]: unknown;
28743
+ };
28744
+ content: {
28745
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
28746
+ };
28747
+ };
28748
+ };
28749
+ };
28750
+ put_whitelabel_document_v1_whitelabel_branding_document_put: {
28751
+ parameters: {
28752
+ query?: never;
28753
+ header?: {
28754
+ /**
28755
+ * @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.
28756
+ * @example rfc3339
28757
+ */
28758
+ "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
28759
+ };
28760
+ path?: never;
28761
+ cookie?: never;
28762
+ };
28763
+ requestBody: {
28764
+ content: {
28765
+ "application/json": components["schemas"]["BrandingDocument"];
28766
+ };
28767
+ };
28768
+ responses: {
28769
+ /** @description Successful Response */
28770
+ 200: {
28771
+ headers: {
28772
+ [name: string]: unknown;
28773
+ };
28774
+ content: {
28775
+ "application/json": components["schemas"]["BrandingDocument"];
28776
+ };
28777
+ };
28778
+ /** @description Validation Error */
28779
+ 422: {
28780
+ headers: {
28781
+ [name: string]: unknown;
28782
+ };
28783
+ content: {
28784
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
28785
+ };
28786
+ };
28787
+ };
28788
+ };
28789
+ put_whitelabel_document_v1_whitelabel_branding_document_post: {
28790
+ parameters: {
28791
+ query?: never;
28792
+ header?: {
28793
+ /**
28794
+ * @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.
28795
+ * @example rfc3339
28796
+ */
28797
+ "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
28798
+ };
28799
+ path?: never;
28800
+ cookie?: never;
28801
+ };
28802
+ requestBody: {
28803
+ content: {
28804
+ "application/json": components["schemas"]["BrandingDocument"];
28805
+ };
28806
+ };
28807
+ responses: {
28808
+ /** @description Successful Response */
28809
+ 200: {
28810
+ headers: {
28811
+ [name: string]: unknown;
28812
+ };
28813
+ content: {
28814
+ "application/json": components["schemas"]["BrandingDocument"];
28815
+ };
28816
+ };
28817
+ /** @description Validation Error */
28818
+ 422: {
28819
+ headers: {
28820
+ [name: string]: unknown;
28821
+ };
28822
+ content: {
28823
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
28824
+ };
28825
+ };
28826
+ };
28827
+ };
28455
28828
  preview_whitelabel_email_v1_whitelabel_branding_email_preview_post: {
28456
28829
  parameters: {
28457
28830
  query?: never;