@opusdns/api 1.151.0 → 1.153.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
@@ -5625,29 +5625,30 @@ export interface components {
5625
5625
  DomainCreate: {
5626
5626
  /**
5627
5627
  * Attributes
5628
- * @description Additional attributes of the domain, keyed by attribute name; request values are strings.
5629
- * Direction: *input* keys are read from the request; *output* keys are written by the platform, rejected if supplied and
5630
- * never returned under `attributes`; *ignored* keys are dropped from the request because the platform derives them itself.
5628
+ * @description Additional attributes of the domain, keyed by attribute name. Values are strings.
5631
5629
  *
5632
- * | Key | Accepted values | TLDs | Direction |
5633
- * |---|---|---|---|
5634
- * | `auto_renew_period` | `monthly`, `yearly` | all on create and transfer-in, `.de` only on update | both |
5635
- * | `music_registrant_attestation` | `true` (also `1`, `yes`) | .music (registration) | input |
5636
- * | `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration, transfer) | input |
5637
- * | `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel (registration) | input |
5638
- * | `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee (registration) | input |
5639
- * | `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration, registrant change) | input |
5640
- * | `de_general_request_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
5641
- * | `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
5642
- * | `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date` | taken from the signed applicant declaration | .no | ignored |
5643
- * | `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
5644
- * | `punktum_dk_tracking_no` | registry-issued | .dk | output |
5645
- * | `verification_required` | | all | output |
5646
- * | `promotion`, `promotion_eligibility` | | all | output |
5630
+ * Customer-settable keys:
5631
+ *
5632
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
5633
+ * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
5634
+ * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
5635
+ * month-unit renewal period.
5636
+ * - `music_registrant_attestation`: `true`. `.music` registration.
5637
+ * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
5638
+ * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
5639
+ * - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
5640
+ * - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
5641
+ * - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
5642
+ * `REQUEST`. `.de` only.
5643
+ *
5644
+ * Boolean keys also accept `1` and `yes`.
5645
+ *
5646
+ * Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
5647
+ * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never returned under `attributes`.
5648
+ *
5649
+ * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
5650
+ * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
5647
5651
  *
5648
- * `auto_renew_period`: on transfer-in without `period` it also sets the period added by the transfer; on create and update it
5649
- * selects the period of the next renewal only and the current expiry date does not move. `monthly` is rejected on transfer-in
5650
- * and ignored at renewal when the TLD's renewal periods have no month unit.
5651
5652
  * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
5652
5653
  * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
5653
5654
  *
@@ -5726,29 +5727,30 @@ export interface components {
5726
5727
  * Attributes
5727
5728
  * @description Override attributes for this domain.
5728
5729
  *
5729
- * Additional attributes of the domain, keyed by attribute name; request values are strings.
5730
- * Direction: *input* keys are read from the request; *output* keys are written by the platform, rejected if supplied and
5731
- * never returned under `attributes`; *ignored* keys are dropped from the request because the platform derives them itself.
5730
+ * Additional attributes of the domain, keyed by attribute name. Values are strings.
5731
+ *
5732
+ * Customer-settable keys:
5732
5733
  *
5733
- * | Key | Accepted values | TLDs | Direction |
5734
- * |---|---|---|---|
5735
- * | `auto_renew_period` | `monthly`, `yearly` | all on create and transfer-in, `.de` only on update | both |
5736
- * | `music_registrant_attestation` | `true` (also `1`, `yes`) | .music (registration) | input |
5737
- * | `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration, transfer) | input |
5738
- * | `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel (registration) | input |
5739
- * | `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee (registration) | input |
5740
- * | `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration, registrant change) | input |
5741
- * | `de_general_request_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
5742
- * | `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
5743
- * | `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date` | taken from the signed applicant declaration | .no | ignored |
5744
- * | `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
5745
- * | `punktum_dk_tracking_no` | registry-issued | .dk | output |
5746
- * | `verification_required` | | all | output |
5747
- * | `promotion`, `promotion_eligibility` | | all | output |
5734
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
5735
+ * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
5736
+ * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
5737
+ * month-unit renewal period.
5738
+ * - `music_registrant_attestation`: `true`. `.music` registration.
5739
+ * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
5740
+ * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
5741
+ * - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
5742
+ * - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
5743
+ * - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
5744
+ * `REQUEST`. `.de` only.
5745
+ *
5746
+ * Boolean keys also accept `1` and `yes`.
5747
+ *
5748
+ * Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
5749
+ * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never returned under `attributes`.
5750
+ *
5751
+ * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
5752
+ * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
5748
5753
  *
5749
- * `auto_renew_period`: on transfer-in without `period` it also sets the period added by the transfer; on create and update it
5750
- * selects the period of the next renewal only and the current expiry date does not move. `monthly` is rejected on transfer-in
5751
- * and ignored at renewal when the TLD's renewal periods have no month unit.
5752
5754
  * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
5753
5755
  * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
5754
5756
  *
@@ -5799,29 +5801,30 @@ export interface components {
5799
5801
  DomainCreateBulkTemplate: {
5800
5802
  /**
5801
5803
  * Attributes
5802
- * @description Additional attributes of the domain, keyed by attribute name; request values are strings.
5803
- * Direction: *input* keys are read from the request; *output* keys are written by the platform, rejected if supplied and
5804
- * never returned under `attributes`; *ignored* keys are dropped from the request because the platform derives them itself.
5804
+ * @description Additional attributes of the domain, keyed by attribute name. Values are strings.
5805
+ *
5806
+ * Customer-settable keys:
5807
+ *
5808
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
5809
+ * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
5810
+ * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
5811
+ * month-unit renewal period.
5812
+ * - `music_registrant_attestation`: `true`. `.music` registration.
5813
+ * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
5814
+ * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
5815
+ * - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
5816
+ * - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
5817
+ * - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
5818
+ * `REQUEST`. `.de` only.
5805
5819
  *
5806
- * | Key | Accepted values | TLDs | Direction |
5807
- * |---|---|---|---|
5808
- * | `auto_renew_period` | `monthly`, `yearly` | all on create and transfer-in, `.de` only on update | both |
5809
- * | `music_registrant_attestation` | `true` (also `1`, `yes`) | .music (registration) | input |
5810
- * | `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration, transfer) | input |
5811
- * | `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel (registration) | input |
5812
- * | `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee (registration) | input |
5813
- * | `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration, registrant change) | input |
5814
- * | `de_general_request_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
5815
- * | `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
5816
- * | `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date` | taken from the signed applicant declaration | .no | ignored |
5817
- * | `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
5818
- * | `punktum_dk_tracking_no` | registry-issued | .dk | output |
5819
- * | `verification_required` | | all | output |
5820
- * | `promotion`, `promotion_eligibility` | | all | output |
5820
+ * Boolean keys also accept `1` and `yes`.
5821
+ *
5822
+ * Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
5823
+ * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never returned under `attributes`.
5824
+ *
5825
+ * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
5826
+ * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
5821
5827
  *
5822
- * `auto_renew_period`: on transfer-in without `period` it also sets the period added by the transfer; on create and update it
5823
- * selects the period of the next renewal only and the current expiry date does not move. `monthly` is rejected on transfer-in
5824
- * and ignored at renewal when the TLD's renewal periods have no month unit.
5825
5828
  * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
5826
5829
  * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
5827
5830
  *
@@ -5876,29 +5879,30 @@ export interface components {
5876
5879
  DomainCreatePayloadData: {
5877
5880
  /**
5878
5881
  * Attributes
5879
- * @description Additional attributes of the domain, keyed by attribute name; request values are strings.
5880
- * Direction: *input* keys are read from the request; *output* keys are written by the platform, rejected if supplied and
5881
- * never returned under `attributes`; *ignored* keys are dropped from the request because the platform derives them itself.
5882
+ * @description Additional attributes of the domain, keyed by attribute name. Values are strings.
5883
+ *
5884
+ * Customer-settable keys:
5885
+ *
5886
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
5887
+ * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
5888
+ * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
5889
+ * month-unit renewal period.
5890
+ * - `music_registrant_attestation`: `true`. `.music` registration.
5891
+ * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
5892
+ * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
5893
+ * - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
5894
+ * - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
5895
+ * - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
5896
+ * `REQUEST`. `.de` only.
5897
+ *
5898
+ * Boolean keys also accept `1` and `yes`.
5882
5899
  *
5883
- * | Key | Accepted values | TLDs | Direction |
5884
- * |---|---|---|---|
5885
- * | `auto_renew_period` | `monthly`, `yearly` | all on create and transfer-in, `.de` only on update | both |
5886
- * | `music_registrant_attestation` | `true` (also `1`, `yes`) | .music (registration) | input |
5887
- * | `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration, transfer) | input |
5888
- * | `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel (registration) | input |
5889
- * | `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee (registration) | input |
5890
- * | `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration, registrant change) | input |
5891
- * | `de_general_request_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
5892
- * | `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
5893
- * | `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date` | taken from the signed applicant declaration | .no | ignored |
5894
- * | `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
5895
- * | `punktum_dk_tracking_no` | registry-issued | .dk | output |
5896
- * | `verification_required` | | all | output |
5897
- * | `promotion`, `promotion_eligibility` | | all | output |
5900
+ * Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
5901
+ * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never returned under `attributes`.
5902
+ *
5903
+ * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
5904
+ * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
5898
5905
  *
5899
- * `auto_renew_period`: on transfer-in without `period` it also sets the period added by the transfer; on create and update it
5900
- * selects the period of the next renewal only and the current expiry date does not move. `monthly` is rejected on transfer-in
5901
- * and ignored at renewal when the TLD's renewal periods have no month unit.
5902
5906
  * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
5903
5907
  * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
5904
5908
  *
@@ -7120,29 +7124,30 @@ export interface components {
7120
7124
  * Attributes
7121
7125
  * @description Override attributes for this domain.
7122
7126
  *
7123
- * Additional attributes of the domain, keyed by attribute name; request values are strings.
7124
- * Direction: *input* keys are read from the request; *output* keys are written by the platform, rejected if supplied and
7125
- * never returned under `attributes`; *ignored* keys are dropped from the request because the platform derives them itself.
7127
+ * Additional attributes of the domain, keyed by attribute name. Values are strings.
7128
+ *
7129
+ * Customer-settable keys:
7130
+ *
7131
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7132
+ * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7133
+ * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7134
+ * month-unit renewal period.
7135
+ * - `music_registrant_attestation`: `true`. `.music` registration.
7136
+ * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7137
+ * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
7138
+ * - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
7139
+ * - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
7140
+ * - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
7141
+ * `REQUEST`. `.de` only.
7142
+ *
7143
+ * Boolean keys also accept `1` and `yes`.
7144
+ *
7145
+ * Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
7146
+ * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never returned under `attributes`.
7126
7147
  *
7127
- * | Key | Accepted values | TLDs | Direction |
7128
- * |---|---|---|---|
7129
- * | `auto_renew_period` | `monthly`, `yearly` | all on create and transfer-in, `.de` only on update | both |
7130
- * | `music_registrant_attestation` | `true` (also `1`, `yes`) | .music (registration) | input |
7131
- * | `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration, transfer) | input |
7132
- * | `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel (registration) | input |
7133
- * | `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee (registration) | input |
7134
- * | `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration, registrant change) | input |
7135
- * | `de_general_request_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7136
- * | `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7137
- * | `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date` | taken from the signed applicant declaration | .no | ignored |
7138
- * | `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
7139
- * | `punktum_dk_tracking_no` | registry-issued | .dk | output |
7140
- * | `verification_required` | | all | output |
7141
- * | `promotion`, `promotion_eligibility` | | all | output |
7148
+ * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7149
+ * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7142
7150
  *
7143
- * `auto_renew_period`: on transfer-in without `period` it also sets the period added by the transfer; on create and update it
7144
- * selects the period of the next renewal only and the current expiry date does not move. `monthly` is rejected on transfer-in
7145
- * and ignored at renewal when the TLD's renewal periods have no month unit.
7146
7151
  * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7147
7152
  * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7148
7153
  *
@@ -7193,29 +7198,30 @@ export interface components {
7193
7198
  DomainTransferBulkTemplate: {
7194
7199
  /**
7195
7200
  * Attributes
7196
- * @description Additional attributes of the domain, keyed by attribute name; request values are strings.
7197
- * Direction: *input* keys are read from the request; *output* keys are written by the platform, rejected if supplied and
7198
- * never returned under `attributes`; *ignored* keys are dropped from the request because the platform derives them itself.
7201
+ * @description Additional attributes of the domain, keyed by attribute name. Values are strings.
7199
7202
  *
7200
- * | Key | Accepted values | TLDs | Direction |
7201
- * |---|---|---|---|
7202
- * | `auto_renew_period` | `monthly`, `yearly` | all on create and transfer-in, `.de` only on update | both |
7203
- * | `music_registrant_attestation` | `true` (also `1`, `yes`) | .music (registration) | input |
7204
- * | `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration, transfer) | input |
7205
- * | `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel (registration) | input |
7206
- * | `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee (registration) | input |
7207
- * | `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration, registrant change) | input |
7208
- * | `de_general_request_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7209
- * | `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7210
- * | `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date` | taken from the signed applicant declaration | .no | ignored |
7211
- * | `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
7212
- * | `punktum_dk_tracking_no` | registry-issued | .dk | output |
7213
- * | `verification_required` | | all | output |
7214
- * | `promotion`, `promotion_eligibility` | | all | output |
7203
+ * Customer-settable keys:
7204
+ *
7205
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7206
+ * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7207
+ * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7208
+ * month-unit renewal period.
7209
+ * - `music_registrant_attestation`: `true`. `.music` registration.
7210
+ * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7211
+ * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
7212
+ * - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
7213
+ * - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
7214
+ * - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
7215
+ * `REQUEST`. `.de` only.
7216
+ *
7217
+ * Boolean keys also accept `1` and `yes`.
7218
+ *
7219
+ * Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
7220
+ * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never returned under `attributes`.
7221
+ *
7222
+ * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7223
+ * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7215
7224
  *
7216
- * `auto_renew_period`: on transfer-in without `period` it also sets the period added by the transfer; on create and update it
7217
- * selects the period of the next renewal only and the current expiry date does not move. `monthly` is rejected on transfer-in
7218
- * and ignored at renewal when the TLD's renewal periods have no month unit.
7219
7225
  * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7220
7226
  * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7221
7227
  *
@@ -7266,29 +7272,30 @@ export interface components {
7266
7272
  DomainTransferIn: {
7267
7273
  /**
7268
7274
  * Attributes
7269
- * @description Additional attributes of the domain, keyed by attribute name; request values are strings.
7270
- * Direction: *input* keys are read from the request; *output* keys are written by the platform, rejected if supplied and
7271
- * never returned under `attributes`; *ignored* keys are dropped from the request because the platform derives them itself.
7275
+ * @description Additional attributes of the domain, keyed by attribute name. Values are strings.
7276
+ *
7277
+ * Customer-settable keys:
7272
7278
  *
7273
- * | Key | Accepted values | TLDs | Direction |
7274
- * |---|---|---|---|
7275
- * | `auto_renew_period` | `monthly`, `yearly` | all on create and transfer-in, `.de` only on update | both |
7276
- * | `music_registrant_attestation` | `true` (also `1`, `yes`) | .music (registration) | input |
7277
- * | `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration, transfer) | input |
7278
- * | `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel (registration) | input |
7279
- * | `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee (registration) | input |
7280
- * | `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration, registrant change) | input |
7281
- * | `de_general_request_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7282
- * | `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7283
- * | `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date` | taken from the signed applicant declaration | .no | ignored |
7284
- * | `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
7285
- * | `punktum_dk_tracking_no` | registry-issued | .dk | output |
7286
- * | `verification_required` | | all | output |
7287
- * | `promotion`, `promotion_eligibility` | | all | output |
7279
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7280
+ * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7281
+ * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7282
+ * month-unit renewal period.
7283
+ * - `music_registrant_attestation`: `true`. `.music` registration.
7284
+ * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7285
+ * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
7286
+ * - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
7287
+ * - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
7288
+ * - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
7289
+ * `REQUEST`. `.de` only.
7290
+ *
7291
+ * Boolean keys also accept `1` and `yes`.
7292
+ *
7293
+ * Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
7294
+ * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never returned under `attributes`.
7295
+ *
7296
+ * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7297
+ * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7288
7298
  *
7289
- * `auto_renew_period`: on transfer-in without `period` it also sets the period added by the transfer; on create and update it
7290
- * selects the period of the next renewal only and the current expiry date does not move. `monthly` is rejected on transfer-in
7291
- * and ignored at renewal when the TLD's renewal periods have no month unit.
7292
7299
  * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7293
7300
  * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7294
7301
  *
@@ -7339,29 +7346,30 @@ export interface components {
7339
7346
  DomainTransferPayloadData: {
7340
7347
  /**
7341
7348
  * Attributes
7342
- * @description Additional attributes of the domain, keyed by attribute name; request values are strings.
7343
- * Direction: *input* keys are read from the request; *output* keys are written by the platform, rejected if supplied and
7344
- * never returned under `attributes`; *ignored* keys are dropped from the request because the platform derives them itself.
7349
+ * @description Additional attributes of the domain, keyed by attribute name. Values are strings.
7350
+ *
7351
+ * Customer-settable keys:
7352
+ *
7353
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7354
+ * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7355
+ * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7356
+ * month-unit renewal period.
7357
+ * - `music_registrant_attestation`: `true`. `.music` registration.
7358
+ * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7359
+ * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
7360
+ * - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
7361
+ * - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
7362
+ * - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
7363
+ * `REQUEST`. `.de` only.
7345
7364
  *
7346
- * | Key | Accepted values | TLDs | Direction |
7347
- * |---|---|---|---|
7348
- * | `auto_renew_period` | `monthly`, `yearly` | all on create and transfer-in, `.de` only on update | both |
7349
- * | `music_registrant_attestation` | `true` (also `1`, `yes`) | .music (registration) | input |
7350
- * | `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration, transfer) | input |
7351
- * | `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel (registration) | input |
7352
- * | `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee (registration) | input |
7353
- * | `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration, registrant change) | input |
7354
- * | `de_general_request_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7355
- * | `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7356
- * | `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date` | taken from the signed applicant declaration | .no | ignored |
7357
- * | `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
7358
- * | `punktum_dk_tracking_no` | registry-issued | .dk | output |
7359
- * | `verification_required` | | all | output |
7360
- * | `promotion`, `promotion_eligibility` | | all | output |
7365
+ * Boolean keys also accept `1` and `yes`.
7366
+ *
7367
+ * Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
7368
+ * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never returned under `attributes`.
7369
+ *
7370
+ * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7371
+ * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7361
7372
  *
7362
- * `auto_renew_period`: on transfer-in without `period` it also sets the period added by the transfer; on create and update it
7363
- * selects the period of the next renewal only and the current expiry date does not move. `monthly` is rejected on transfer-in
7364
- * and ignored at renewal when the TLD's renewal periods have no month unit.
7365
7373
  * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7366
7374
  * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7367
7375
  *
@@ -7444,29 +7452,30 @@ export interface components {
7444
7452
  DomainUpdate: {
7445
7453
  /**
7446
7454
  * Attributes
7447
- * @description Additional attributes of the domain, keyed by attribute name; request values are strings.
7448
- * Direction: *input* keys are read from the request; *output* keys are written by the platform, rejected if supplied and
7449
- * never returned under `attributes`; *ignored* keys are dropped from the request because the platform derives them itself.
7455
+ * @description Additional attributes of the domain, keyed by attribute name. Values are strings.
7456
+ *
7457
+ * Customer-settable keys:
7458
+ *
7459
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7460
+ * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7461
+ * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7462
+ * month-unit renewal period.
7463
+ * - `music_registrant_attestation`: `true`. `.music` registration.
7464
+ * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7465
+ * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
7466
+ * - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
7467
+ * - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
7468
+ * - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
7469
+ * `REQUEST`. `.de` only.
7470
+ *
7471
+ * Boolean keys also accept `1` and `yes`.
7450
7472
  *
7451
- * | Key | Accepted values | TLDs | Direction |
7452
- * |---|---|---|---|
7453
- * | `auto_renew_period` | `monthly`, `yearly` | all on create and transfer-in, `.de` only on update | both |
7454
- * | `music_registrant_attestation` | `true` (also `1`, `yes`) | .music (registration) | input |
7455
- * | `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration, transfer) | input |
7456
- * | `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel (registration) | input |
7457
- * | `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee (registration) | input |
7458
- * | `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration, registrant change) | input |
7459
- * | `de_general_request_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7460
- * | `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7461
- * | `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date` | taken from the signed applicant declaration | .no | ignored |
7462
- * | `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
7463
- * | `punktum_dk_tracking_no` | registry-issued | .dk | output |
7464
- * | `verification_required` | | all | output |
7465
- * | `promotion`, `promotion_eligibility` | | all | output |
7473
+ * Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
7474
+ * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never returned under `attributes`.
7475
+ *
7476
+ * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7477
+ * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7466
7478
  *
7467
- * `auto_renew_period`: on transfer-in without `period` it also sets the period added by the transfer; on create and update it
7468
- * selects the period of the next renewal only and the current expiry date does not move. `monthly` is rejected on transfer-in
7469
- * and ignored at renewal when the TLD's renewal periods have no month unit.
7470
7479
  * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7471
7480
  * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7472
7481
  *
@@ -7617,29 +7626,30 @@ export interface components {
7617
7626
  DomainUpdatePayloadData: {
7618
7627
  /**
7619
7628
  * Attributes
7620
- * @description Additional attributes of the domain, keyed by attribute name; request values are strings.
7621
- * Direction: *input* keys are read from the request; *output* keys are written by the platform, rejected if supplied and
7622
- * never returned under `attributes`; *ignored* keys are dropped from the request because the platform derives them itself.
7629
+ * @description Additional attributes of the domain, keyed by attribute name. Values are strings.
7630
+ *
7631
+ * Customer-settable keys:
7632
+ *
7633
+ * - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only on update. Selects the
7634
+ * period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
7635
+ * period added by the transfer. `monthly` is rejected on transfer-in and ignored at renewal when the TLD has no
7636
+ * month-unit renewal period.
7637
+ * - `music_registrant_attestation`: `true`. `.music` registration.
7638
+ * - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
7639
+ * - `travel_industry_acknowledgement`: `true`. `.travel` registration.
7640
+ * - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
7641
+ * - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
7642
+ * - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
7643
+ * `REQUEST`. `.de` only.
7644
+ *
7645
+ * Boolean keys also accept `1` and `yes`.
7646
+ *
7647
+ * Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
7648
+ * `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`. They are never returned under `attributes`.
7623
7649
  *
7624
- * | Key | Accepted values | TLDs | Direction |
7625
- * |---|---|---|---|
7626
- * | `auto_renew_period` | `monthly`, `yearly` | all on create and transfer-in, `.de` only on update | both |
7627
- * | `music_registrant_attestation` | `true` (also `1`, `yes`) | .music (registration) | input |
7628
- * | `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration, transfer) | input |
7629
- * | `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel (registration) | input |
7630
- * | `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee (registration) | input |
7631
- * | `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration, registrant change) | input |
7632
- * | `de_general_request_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7633
- * | `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
7634
- * | `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date` | taken from the signed applicant declaration | .no | ignored |
7635
- * | `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
7636
- * | `punktum_dk_tracking_no` | registry-issued | .dk | output |
7637
- * | `verification_required` | | all | output |
7638
- * | `promotion`, `promotion_eligibility` | | all | output |
7650
+ * Derived from the signed `.no` applicant declaration and ignored if supplied: `nor_id_applicant_version`,
7651
+ * `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
7639
7652
  *
7640
- * `auto_renew_period`: on transfer-in without `period` it also sets the period added by the transfer; on create and update it
7641
- * selects the period of the next renewal only and the current expiry date does not move. `monthly` is rejected on transfer-in
7642
- * and ignored at renewal when the TLD's renewal periods have no month unit.
7643
7653
  * On update, only `.de` stores attributes and an empty value removes the stored attribute; `.dk` reads
7644
7654
  * `punktum_dk_terms_acceptance` to confirm a registrant change and other registries ignore attributes.
7645
7655
  *
@@ -11572,7 +11582,7 @@ export interface components {
11572
11582
  * ReportStatus
11573
11583
  * @enum {string}
11574
11584
  */
11575
- ReportStatus: "pending" | "generating" | "completed" | "failed";
11585
+ ReportStatus: "pending" | "generating" | "completed" | "failed" | "empty";
11576
11586
  /**
11577
11587
  * ReportTriggerType
11578
11588
  * @enum {string}