@opusdns/api 1.170.0 → 1.171.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/keys.ts +4 -0
- package/src/openapi.yaml +92 -1
- package/src/schema.d.ts +84 -0
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -2974,6 +2974,7 @@ export const KEYS_DOMAIN_UPDATE_BULK_COMMAND = [
|
|
|
2974
2974
|
KEY_DOMAIN_UPDATE_BULK_COMMAND_VERSION,
|
|
2975
2975
|
] as const satisfies (keyof DomainUpdateBulkCommand)[];
|
|
2976
2976
|
|
|
2977
|
+
export const KEY_DOMAIN_UPDATE_BULK_INSTANCE_ATTRIBUTES = 'attributes' satisfies keyof DomainUpdateBulkInstance;
|
|
2977
2978
|
export const KEY_DOMAIN_UPDATE_BULK_INSTANCE_AUTH_CODE = 'auth_code' satisfies keyof DomainUpdateBulkInstance;
|
|
2978
2979
|
export const KEY_DOMAIN_UPDATE_BULK_INSTANCE_CONTACTS = 'contacts' satisfies keyof DomainUpdateBulkInstance;
|
|
2979
2980
|
export const KEY_DOMAIN_UPDATE_BULK_INSTANCE_DOMAIN_ID = 'domain_id' satisfies keyof DomainUpdateBulkInstance;
|
|
@@ -2984,6 +2985,7 @@ export const KEY_DOMAIN_UPDATE_BULK_INSTANCE_STATUS_CHANGES = 'status_changes' s
|
|
|
2984
2985
|
export const KEY_DOMAIN_UPDATE_BULK_INSTANCE_STATUSES = 'statuses' satisfies keyof DomainUpdateBulkInstance;
|
|
2985
2986
|
|
|
2986
2987
|
export const KEYS_DOMAIN_UPDATE_BULK_INSTANCE = [
|
|
2988
|
+
KEY_DOMAIN_UPDATE_BULK_INSTANCE_ATTRIBUTES,
|
|
2987
2989
|
KEY_DOMAIN_UPDATE_BULK_INSTANCE_AUTH_CODE,
|
|
2988
2990
|
KEY_DOMAIN_UPDATE_BULK_INSTANCE_CONTACTS,
|
|
2989
2991
|
KEY_DOMAIN_UPDATE_BULK_INSTANCE_DOMAIN_ID,
|
|
@@ -3002,6 +3004,7 @@ export const KEYS_DOMAIN_UPDATE_BULK_PAYLOAD = [
|
|
|
3002
3004
|
KEY_DOMAIN_UPDATE_BULK_PAYLOAD_TEMPLATE,
|
|
3003
3005
|
] as const satisfies (keyof DomainUpdateBulkPayload)[];
|
|
3004
3006
|
|
|
3007
|
+
export const KEY_DOMAIN_UPDATE_BULK_TEMPLATE_ATTRIBUTES = 'attributes' satisfies keyof DomainUpdateBulkTemplate;
|
|
3005
3008
|
export const KEY_DOMAIN_UPDATE_BULK_TEMPLATE_CONTACTS = 'contacts' satisfies keyof DomainUpdateBulkTemplate;
|
|
3006
3009
|
export const KEY_DOMAIN_UPDATE_BULK_TEMPLATE_NAMESERVERS = 'nameservers' satisfies keyof DomainUpdateBulkTemplate;
|
|
3007
3010
|
export const KEY_DOMAIN_UPDATE_BULK_TEMPLATE_RENEWAL_MODE = 'renewal_mode' satisfies keyof DomainUpdateBulkTemplate;
|
|
@@ -3009,6 +3012,7 @@ export const KEY_DOMAIN_UPDATE_BULK_TEMPLATE_STATUS_CHANGES = 'status_changes' s
|
|
|
3009
3012
|
export const KEY_DOMAIN_UPDATE_BULK_TEMPLATE_STATUSES = 'statuses' satisfies keyof DomainUpdateBulkTemplate;
|
|
3010
3013
|
|
|
3011
3014
|
export const KEYS_DOMAIN_UPDATE_BULK_TEMPLATE = [
|
|
3015
|
+
KEY_DOMAIN_UPDATE_BULK_TEMPLATE_ATTRIBUTES,
|
|
3012
3016
|
KEY_DOMAIN_UPDATE_BULK_TEMPLATE_CONTACTS,
|
|
3013
3017
|
KEY_DOMAIN_UPDATE_BULK_TEMPLATE_NAMESERVERS,
|
|
3014
3018
|
KEY_DOMAIN_UPDATE_BULK_TEMPLATE_RENEWAL_MODE,
|
package/src/openapi.yaml
CHANGED
|
@@ -6893,6 +6893,52 @@ components:
|
|
|
6893
6893
|
type: object
|
|
6894
6894
|
DomainUpdateBulkInstance:
|
|
6895
6895
|
properties:
|
|
6896
|
+
attributes:
|
|
6897
|
+
anyOf:
|
|
6898
|
+
- additionalProperties:
|
|
6899
|
+
type: string
|
|
6900
|
+
propertyNames:
|
|
6901
|
+
$ref: '#/components/schemas/DomainAttributeKey'
|
|
6902
|
+
type: object
|
|
6903
|
+
- type: 'null'
|
|
6904
|
+
description: "Override attributes for this domain.\n\nAdditional attributes\
|
|
6905
|
+
\ of the domain, keyed by attribute name. Values are strings.\n\nCustomer-settable\
|
|
6906
|
+
\ keys:\n\n- `auto_renew_period`: `monthly` or `yearly`. All TLDs on create,\
|
|
6907
|
+
\ transfer-in and update. Selects the\n period of the next renewal; the\
|
|
6908
|
+
\ current expiry date does not move. On transfer-in without `period` it\
|
|
6909
|
+
\ also sets the\n period added by the transfer. Omitted on create or\
|
|
6910
|
+
\ transfer-in, it follows the term being bought: a one-month\n `period`\
|
|
6911
|
+
\ renews monthly and anything else yearly, except a longer month-unit\
|
|
6912
|
+
\ term, which leaves it unset so that the\n product's default billing\
|
|
6913
|
+
\ period decides. Supplying `monthly` where the TLD sells no one-month\
|
|
6914
|
+
\ renewal is rejected on\n create, transfer-in and update; a `monthly`\
|
|
6915
|
+
\ stored before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\
|
|
6916
|
+
\ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
6917
|
+
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
6918
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
6919
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
6920
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6921
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6922
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6923
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6924
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6925
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
6926
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
6927
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
6928
|
+
\ applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,\n\
|
|
6929
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
6930
|
+
\ update, every registry stores the supplied attributes, and the update\
|
|
6931
|
+
\ is not sent to the registry unless they\nstore; a registry that rejects\
|
|
6932
|
+
\ the change stores nothing. An empty value removes the stored attribute,\
|
|
6933
|
+
\ except for\n`auto_renew_period`, whose only accepted values are `monthly`\
|
|
6934
|
+
\ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6935
|
+
\ a registrant change. An update cannot change what the registrant accepted\
|
|
6936
|
+
\ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\
|
|
6937
|
+
\ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\
|
|
6938
|
+
\ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\
|
|
6939
|
+
\ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\
|
|
6940
|
+
\ change but cannot be removed with an empty value.\n"
|
|
6941
|
+
title: Attributes
|
|
6896
6942
|
auth_code:
|
|
6897
6943
|
anyOf:
|
|
6898
6944
|
- maxLength: 255
|
|
@@ -6966,6 +7012,51 @@ components:
|
|
|
6966
7012
|
type: object
|
|
6967
7013
|
DomainUpdateBulkTemplate:
|
|
6968
7014
|
properties:
|
|
7015
|
+
attributes:
|
|
7016
|
+
anyOf:
|
|
7017
|
+
- additionalProperties:
|
|
7018
|
+
type: string
|
|
7019
|
+
propertyNames:
|
|
7020
|
+
$ref: '#/components/schemas/DomainAttributeKey'
|
|
7021
|
+
type: object
|
|
7022
|
+
- type: 'null'
|
|
7023
|
+
description: "Additional attributes of the domain, keyed by attribute name.\
|
|
7024
|
+
\ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\
|
|
7025
|
+
\ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\
|
|
7026
|
+
\ the\n period of the next renewal; the current expiry date does not\
|
|
7027
|
+
\ move. On transfer-in without `period` it also sets the\n period added\
|
|
7028
|
+
\ by the transfer. Omitted on create or transfer-in, it follows the term\
|
|
7029
|
+
\ being bought: a one-month\n `period` renews monthly and anything else\
|
|
7030
|
+
\ yearly, except a longer month-unit term, which leaves it unset so that\
|
|
7031
|
+
\ the\n product's default billing period decides. Supplying `monthly`\
|
|
7032
|
+
\ where the TLD sells no one-month renewal is rejected on\n create, transfer-in\
|
|
7033
|
+
\ and update; a `monthly` stored before that rule applied is ignored at\
|
|
7034
|
+
\ renewal.\n- `music_registrant_attestation`: `true`. `.music` registration.\n\
|
|
7035
|
+
- `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.\n\
|
|
7036
|
+
- `travel_industry_acknowledgement`: `true`. `.travel` registration.\n\
|
|
7037
|
+
- `internet_ee_registrant_agreement`: `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`:\
|
|
7038
|
+
\ `true`. `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
7039
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
7040
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
7041
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
7042
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
7043
|
+
\ `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never\n\
|
|
7044
|
+
returned under `attributes`; inline contact attributes surface on the\
|
|
7045
|
+
\ matching `contacts` entry instead.\n\nDerived from the signed `.no`\
|
|
7046
|
+
\ applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,\n\
|
|
7047
|
+
`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\nOn\
|
|
7048
|
+
\ update, every registry stores the supplied attributes, and the update\
|
|
7049
|
+
\ is not sent to the registry unless they\nstore; a registry that rejects\
|
|
7050
|
+
\ the change stores nothing. An empty value removes the stored attribute,\
|
|
7051
|
+
\ except for\n`auto_renew_period`, whose only accepted values are `monthly`\
|
|
7052
|
+
\ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
7053
|
+
\ a registrant change. An update cannot change what the registrant accepted\
|
|
7054
|
+
\ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\
|
|
7055
|
+
\ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\
|
|
7056
|
+
\ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\
|
|
7057
|
+
\ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\
|
|
7058
|
+
\ change but cannot be removed with an empty value.\n"
|
|
7059
|
+
title: Attributes
|
|
6969
7060
|
contacts:
|
|
6970
7061
|
anyOf:
|
|
6971
7062
|
- $ref: '#/components/schemas/DomainContactHandles'
|
|
@@ -16641,7 +16732,7 @@ info:
|
|
|
16641
16732
|
\n\n"
|
|
16642
16733
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
16643
16734
|
title: OpusDNS API
|
|
16644
|
-
version: 2026-09-
|
|
16735
|
+
version: 2026-09-12-024125
|
|
16645
16736
|
x-logo:
|
|
16646
16737
|
altText: OpusDNS API Reference
|
|
16647
16738
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -7729,6 +7729,49 @@ export interface components {
|
|
|
7729
7729
|
};
|
|
7730
7730
|
/** DomainUpdateBulkInstance */
|
|
7731
7731
|
DomainUpdateBulkInstance: {
|
|
7732
|
+
/**
|
|
7733
|
+
* Attributes
|
|
7734
|
+
* @description Override attributes for this domain.
|
|
7735
|
+
*
|
|
7736
|
+
* Additional attributes of the domain, keyed by attribute name. Values are strings.
|
|
7737
|
+
*
|
|
7738
|
+
* Customer-settable keys:
|
|
7739
|
+
*
|
|
7740
|
+
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
7741
|
+
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
7742
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
7743
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
7744
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
7745
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
7746
|
+
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
7747
|
+
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
7748
|
+
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
7749
|
+
* - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
|
|
7750
|
+
* - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
|
|
7751
|
+
* - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
|
|
7752
|
+
* `REQUEST`. `.de` only.
|
|
7753
|
+
*
|
|
7754
|
+
* Boolean keys also accept `1` and `yes`.
|
|
7755
|
+
*
|
|
7756
|
+
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
7757
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
7758
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
7759
|
+
*
|
|
7760
|
+
* Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
|
|
7761
|
+
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
7762
|
+
*
|
|
7763
|
+
* On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
|
|
7764
|
+
* store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
|
|
7765
|
+
* `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
|
|
7766
|
+
* `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
|
|
7767
|
+
* registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
|
|
7768
|
+
* `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
|
|
7769
|
+
* `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
|
|
7770
|
+
*
|
|
7771
|
+
*/
|
|
7772
|
+
attributes?: {
|
|
7773
|
+
[key: string]: string;
|
|
7774
|
+
} | null;
|
|
7732
7775
|
/**
|
|
7733
7776
|
* Auth Code
|
|
7734
7777
|
* @description Override auth code for this domain
|
|
@@ -7773,6 +7816,47 @@ export interface components {
|
|
|
7773
7816
|
};
|
|
7774
7817
|
/** DomainUpdateBulkTemplate */
|
|
7775
7818
|
DomainUpdateBulkTemplate: {
|
|
7819
|
+
/**
|
|
7820
|
+
* Attributes
|
|
7821
|
+
* @description Additional attributes of the domain, keyed by attribute name. Values are strings.
|
|
7822
|
+
*
|
|
7823
|
+
* Customer-settable keys:
|
|
7824
|
+
*
|
|
7825
|
+
* - `auto_renew_period`: `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects the
|
|
7826
|
+
* period of the next renewal; the current expiry date does not move. On transfer-in without `period` it also sets the
|
|
7827
|
+
* period added by the transfer. Omitted on create or transfer-in, it follows the term being bought: a one-month
|
|
7828
|
+
* `period` renews monthly and anything else yearly, except a longer month-unit term, which leaves it unset so that the
|
|
7829
|
+
* product's default billing period decides. Supplying `monthly` where the TLD sells no one-month renewal is rejected on
|
|
7830
|
+
* create, transfer-in and update; a `monthly` stored before that rule applied is ignored at renewal.
|
|
7831
|
+
* - `music_registrant_attestation`: `true`. `.music` registration.
|
|
7832
|
+
* - `nic_it_compliance_confirmation`: `true`. `.it` registration and transfer.
|
|
7833
|
+
* - `travel_industry_acknowledgement`: `true`. `.travel` registration.
|
|
7834
|
+
* - `internet_ee_registrant_agreement`: `true`. `.ee` registration.
|
|
7835
|
+
* - `punktum_dk_terms_acceptance`: `true`. `.dk` registration and registrant change.
|
|
7836
|
+
* - `de_general_request_contact`, `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE` =
|
|
7837
|
+
* `REQUEST`. `.de` only.
|
|
7838
|
+
*
|
|
7839
|
+
* Boolean keys also accept `1` and `yes`.
|
|
7840
|
+
*
|
|
7841
|
+
* Written by the platform and rejected if supplied: `verification_required`, `promotion`, `promotion_eligibility`,
|
|
7842
|
+
* `nor_id_declaration`, `nor_id_declaration_token`, `punktum_dk_tracking_no`, `domain_contact_attributes`. They are never
|
|
7843
|
+
* returned under `attributes`; inline contact attributes surface on the matching `contacts` entry instead.
|
|
7844
|
+
*
|
|
7845
|
+
* Derived from the signed `.no` applicant declaration and ignored if supplied on create: `nor_id_applicant_version`,
|
|
7846
|
+
* `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.
|
|
7847
|
+
*
|
|
7848
|
+
* On update, every registry stores the supplied attributes, and the update is not sent to the registry unless they
|
|
7849
|
+
* store; a registry that rejects the change stores nothing. An empty value removes the stored attribute, except for
|
|
7850
|
+
* `auto_renew_period`, whose only accepted values are `monthly` and `yearly`. `.dk` also reads
|
|
7851
|
+
* `punktum_dk_terms_acceptance` to confirm a registrant change. An update cannot change what the registrant accepted at
|
|
7852
|
+
* registration, so these are rejected on update: `music_registrant_attestation`, `nic_it_compliance_confirmation`,
|
|
7853
|
+
* `travel_industry_acknowledgement`, `internet_ee_registrant_agreement` and the three `nor_id_applicant_*` keys.
|
|
7854
|
+
* `punktum_dk_terms_acceptance` stays settable for a registrant change but cannot be removed with an empty value.
|
|
7855
|
+
*
|
|
7856
|
+
*/
|
|
7857
|
+
attributes?: {
|
|
7858
|
+
[key: string]: string;
|
|
7859
|
+
} | null;
|
|
7776
7860
|
/** @description The new contacts of the domain */
|
|
7777
7861
|
contacts?: components["schemas"]["DomainContactHandles"] | null;
|
|
7778
7862
|
/**
|