@opusdns/api 0.271.0 → 0.273.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.271.0",
6
+ "version": "0.273.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -10943,6 +10943,31 @@ export const KEY_DOMAIN_CREATE_ATTRIBUTES: keyof DomainCreate = 'attributes';
10943
10943
  * @see {@link KEYS_DOMAIN_CREATE} - Array of all keys for this type
10944
10944
  */
10945
10945
  export const KEY_DOMAIN_CREATE_AUTH_CODE: keyof DomainCreate = 'auth_code';
10946
+ /**
10947
+ * The accept_hash of the related claims notice
10948
+ *
10949
+ * During the claims phase domain names that match a trademark registered in the Trademark Clearinghouse require an acceptance by the registrant.
10950
+ *
10951
+ *
10952
+ *
10953
+ * @remarks
10954
+ * This key constant provides type-safe access to the `claims_notice_acceptance_hash` property of DomainCreate objects.
10955
+ * Use this constant when you need to access properties dynamically or ensure type safety.
10956
+ *
10957
+ * @example
10958
+ * ```typescript
10959
+ * // Direct property access
10960
+ * const value = domaincreate[KEY_DOMAIN_CREATE_CLAIMS_NOTICE_ACCEPTANCE_HASH];
10961
+ *
10962
+ * // Dynamic property access
10963
+ * const propertyName = KEY_DOMAIN_CREATE_CLAIMS_NOTICE_ACCEPTANCE_HASH;
10964
+ * const value = domaincreate[propertyName];
10965
+ * ```
10966
+ *
10967
+ * @see {@link DomainCreate} - The TypeScript type definition
10968
+ * @see {@link KEYS_DOMAIN_CREATE} - Array of all keys for this type
10969
+ */
10970
+ export const KEY_DOMAIN_CREATE_CLAIMS_NOTICE_ACCEPTANCE_HASH: keyof DomainCreate = 'claims_notice_acceptance_hash';
10946
10971
  /**
10947
10972
  * Contacts
10948
10973
  *
@@ -11144,6 +11169,7 @@ export const KEY_DOMAIN_CREATE_RENEWAL_MODE: keyof DomainCreate = 'renewal_mode'
11144
11169
  export const KEYS_DOMAIN_CREATE = [
11145
11170
  KEY_DOMAIN_CREATE_ATTRIBUTES,
11146
11171
  KEY_DOMAIN_CREATE_AUTH_CODE,
11172
+ KEY_DOMAIN_CREATE_CLAIMS_NOTICE_ACCEPTANCE_HASH,
11147
11173
  KEY_DOMAIN_CREATE_CONTACTS,
11148
11174
  KEY_DOMAIN_CREATE_CREATE_ZONE,
11149
11175
  KEY_DOMAIN_CREATE_EXPECTED_PRICE,
@@ -11926,6 +11952,31 @@ export const KEY_DOMAIN_CREATE_PAYLOAD_DATA_ATTRIBUTES: keyof DomainCreatePayloa
11926
11952
  * @see {@link KEYS_DOMAIN_CREATE_PAYLOAD_DATA} - Array of all keys for this type
11927
11953
  */
11928
11954
  export const KEY_DOMAIN_CREATE_PAYLOAD_DATA_AUTH_CODE: keyof DomainCreatePayloadData = 'auth_code';
11955
+ /**
11956
+ * The accept_hash of the related claims notice
11957
+ *
11958
+ * During the claims phase domain names that match a trademark registered in the Trademark Clearinghouse require an acceptance by the registrant.
11959
+ *
11960
+ *
11961
+ *
11962
+ * @remarks
11963
+ * This key constant provides type-safe access to the `claims_notice_acceptance_hash` property of DomainCreatePayloadData objects.
11964
+ * Use this constant when you need to access properties dynamically or ensure type safety.
11965
+ *
11966
+ * @example
11967
+ * ```typescript
11968
+ * // Direct property access
11969
+ * const value = domaincreatepayloaddata[KEY_DOMAIN_CREATE_PAYLOAD_DATA_CLAIMS_NOTICE_ACCEPTANCE_HASH];
11970
+ *
11971
+ * // Dynamic property access
11972
+ * const propertyName = KEY_DOMAIN_CREATE_PAYLOAD_DATA_CLAIMS_NOTICE_ACCEPTANCE_HASH;
11973
+ * const value = domaincreatepayloaddata[propertyName];
11974
+ * ```
11975
+ *
11976
+ * @see {@link DomainCreatePayloadData} - The TypeScript type definition
11977
+ * @see {@link KEYS_DOMAIN_CREATE_PAYLOAD_DATA} - Array of all keys for this type
11978
+ */
11979
+ export const KEY_DOMAIN_CREATE_PAYLOAD_DATA_CLAIMS_NOTICE_ACCEPTANCE_HASH: keyof DomainCreatePayloadData = 'claims_notice_acceptance_hash';
11929
11980
  /**
11930
11981
  * Contacts
11931
11982
  *
@@ -12127,6 +12178,7 @@ export const KEY_DOMAIN_CREATE_PAYLOAD_DATA_RENEWAL_MODE: keyof DomainCreatePayl
12127
12178
  export const KEYS_DOMAIN_CREATE_PAYLOAD_DATA = [
12128
12179
  KEY_DOMAIN_CREATE_PAYLOAD_DATA_ATTRIBUTES,
12129
12180
  KEY_DOMAIN_CREATE_PAYLOAD_DATA_AUTH_CODE,
12181
+ KEY_DOMAIN_CREATE_PAYLOAD_DATA_CLAIMS_NOTICE_ACCEPTANCE_HASH,
12130
12182
  KEY_DOMAIN_CREATE_PAYLOAD_DATA_CONTACTS,
12131
12183
  KEY_DOMAIN_CREATE_PAYLOAD_DATA_CREATE_ZONE,
12132
12184
  KEY_DOMAIN_CREATE_PAYLOAD_DATA_EXPECTED_PRICE,
@@ -4689,114 +4689,6 @@ export type PATCH_OrganizationsAttributes_Request_Query = PATCH_OrganizationsAtt
4689
4689
  */
4690
4690
  export type PATCH_OrganizationsAttributes_Request_Body = PATCH_OrganizationsAttributes_Request['requestBody'];
4691
4691
 
4692
- /**
4693
- * Request type for GET OrganizationsAttributesOrganizationId endpoint
4694
- *
4695
- * List organization attributes
4696
- * Retrieves a list of organization attributes for the specified organization
4697
- *
4698
- * @remarks
4699
- * This type defines the complete request structure for the GET OrganizationsAttributesOrganizationId endpoint.
4700
- * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
4701
- * Use this type to ensure type safety when making API requests to this endpoint.
4702
- *
4703
- * @example
4704
- * Use this type to ensure type safety when making API requests to this endpoint.
4705
- *
4706
- * @path /v1/organizations/attributes/{organization_id}
4707
- * @param keys (query) - Optional list of attribute keys to filter
4708
- *
4709
- * @see {@link GET_OrganizationsAttributesOrganizationId_Request_Query} - Query parameters type
4710
- * @see {@link GET_OrganizationsAttributesOrganizationId_Request_Path} - Path parameters type
4711
- * @see {@link GET_OrganizationsAttributesOrganizationId_Request_Body} - Request body type
4712
- */
4713
- export type GET_OrganizationsAttributesOrganizationId_Request = {
4714
- parameters: {
4715
- query: operations['get_attributes_v1_organizations_attributes__organization_id__get']['parameters']['query'];
4716
- path: operations['get_attributes_v1_organizations_attributes__organization_id__get']['parameters']['path'];
4717
- };
4718
- }
4719
- /**
4720
- * Query parameters for GET /v1/organizations/attributes/{organization_id}
4721
- *
4722
- * @remarks
4723
- * This type defines the query parameters for the GET /v1/organizations/attributes/{organization_id} endpoint.
4724
- * It provides type safety for all query parameters as defined in the OpenAPI specification.
4725
- *
4726
- * @example
4727
- * Use this type to ensure type safety for query parameters.
4728
- *
4729
- * @path /v1/organizations/attributes/{organization_id}
4730
- * @param keys (query) - Optional list of attribute keys to filter
4731
- */
4732
- export type GET_OrganizationsAttributesOrganizationId_Request_Query = GET_OrganizationsAttributesOrganizationId_Request['parameters']['query'];
4733
- /**
4734
- * Path parameters for GET /v1/organizations/attributes/{organization_id}
4735
- *
4736
- * @remarks
4737
- * This type defines the path parameters for the GET /v1/organizations/attributes/{organization_id} endpoint.
4738
- * It provides type safety for all path parameters as defined in the OpenAPI specification.
4739
- *
4740
- * @example
4741
- * Use this type to ensure type safety for path parameters.
4742
- *
4743
- * @path /v1/organizations/attributes/{organization_id}
4744
- */
4745
- export type GET_OrganizationsAttributesOrganizationId_Request_Path = GET_OrganizationsAttributesOrganizationId_Request['parameters']['path'];
4746
-
4747
- /**
4748
- * Request type for PATCH OrganizationsAttributesOrganizationId endpoint
4749
- *
4750
- * Update organization attributes
4751
- * Updates one or more organization attributes for the specified organization
4752
- *
4753
- * @remarks
4754
- * This type defines the complete request structure for the PATCH OrganizationsAttributesOrganizationId endpoint.
4755
- * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
4756
- * Use this type to ensure type safety when making API requests to this endpoint.
4757
- *
4758
- * @example
4759
- * Use this type to ensure type safety when making API requests to this endpoint.
4760
- *
4761
- * @path /v1/organizations/attributes/{organization_id}
4762
- *
4763
- * @see {@link PATCH_OrganizationsAttributesOrganizationId_Request_Query} - Query parameters type
4764
- * @see {@link PATCH_OrganizationsAttributesOrganizationId_Request_Path} - Path parameters type
4765
- * @see {@link PATCH_OrganizationsAttributesOrganizationId_Request_Body} - Request body type
4766
- */
4767
- export type PATCH_OrganizationsAttributesOrganizationId_Request = {
4768
- parameters: {
4769
- path: operations['update_attributes_v1_organizations_attributes__organization_id__patch']['parameters']['path'];
4770
- };
4771
- requestBody: OrganizationAttributeUpdateArray;
4772
- }
4773
- /**
4774
- * Path parameters for PATCH /v1/organizations/attributes/{organization_id}
4775
- *
4776
- * @remarks
4777
- * This type defines the path parameters for the PATCH /v1/organizations/attributes/{organization_id} endpoint.
4778
- * It provides type safety for all path parameters as defined in the OpenAPI specification.
4779
- *
4780
- * @example
4781
- * Use this type to ensure type safety for path parameters.
4782
- *
4783
- * @path /v1/organizations/attributes/{organization_id}
4784
- */
4785
- export type PATCH_OrganizationsAttributesOrganizationId_Request_Path = PATCH_OrganizationsAttributesOrganizationId_Request['parameters']['path'];
4786
- /**
4787
- * Request body for PATCH /v1/organizations/attributes/{organization_id}
4788
- *
4789
- * @remarks
4790
- * This type defines the request body structure for the PATCH /v1/organizations/attributes/{organization_id} endpoint.
4791
- * It provides type safety for the request body as defined in the OpenAPI specification.
4792
- *
4793
- * @example
4794
- * Use this type to ensure type safety for request body structure.
4795
- *
4796
- * @path /v1/organizations/attributes/{organization_id}
4797
- */
4798
- export type PATCH_OrganizationsAttributesOrganizationId_Request_Body = PATCH_OrganizationsAttributesOrganizationId_Request['requestBody'];
4799
-
4800
4692
  /**
4801
4693
  * Request type for GET OrganizationsIpRestrictions endpoint
4802
4694
  *
@@ -5133,6 +5025,114 @@ export type PATCH_OrganizationsOrganizationId_Request_Path = PATCH_Organizations
5133
5025
  */
5134
5026
  export type PATCH_OrganizationsOrganizationId_Request_Body = PATCH_OrganizationsOrganizationId_Request['requestBody'];
5135
5027
 
5028
+ /**
5029
+ * Request type for GET OrganizationsOrganizationIdAttributes endpoint
5030
+ *
5031
+ * List organization attributes
5032
+ * Retrieves a list of organization attributes for the specified organization
5033
+ *
5034
+ * @remarks
5035
+ * This type defines the complete request structure for the GET OrganizationsOrganizationIdAttributes endpoint.
5036
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
5037
+ * Use this type to ensure type safety when making API requests to this endpoint.
5038
+ *
5039
+ * @example
5040
+ * Use this type to ensure type safety when making API requests to this endpoint.
5041
+ *
5042
+ * @path /v1/organizations/{organization_id}/attributes
5043
+ * @param keys (query) - Optional list of attribute keys to filter
5044
+ *
5045
+ * @see {@link GET_OrganizationsOrganizationIdAttributes_Request_Query} - Query parameters type
5046
+ * @see {@link GET_OrganizationsOrganizationIdAttributes_Request_Path} - Path parameters type
5047
+ * @see {@link GET_OrganizationsOrganizationIdAttributes_Request_Body} - Request body type
5048
+ */
5049
+ export type GET_OrganizationsOrganizationIdAttributes_Request = {
5050
+ parameters: {
5051
+ query: operations['get_attributes_v1_organizations__organization_id__attributes_get']['parameters']['query'];
5052
+ path: operations['get_attributes_v1_organizations__organization_id__attributes_get']['parameters']['path'];
5053
+ };
5054
+ }
5055
+ /**
5056
+ * Query parameters for GET /v1/organizations/{organization_id}/attributes
5057
+ *
5058
+ * @remarks
5059
+ * This type defines the query parameters for the GET /v1/organizations/{organization_id}/attributes endpoint.
5060
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
5061
+ *
5062
+ * @example
5063
+ * Use this type to ensure type safety for query parameters.
5064
+ *
5065
+ * @path /v1/organizations/{organization_id}/attributes
5066
+ * @param keys (query) - Optional list of attribute keys to filter
5067
+ */
5068
+ export type GET_OrganizationsOrganizationIdAttributes_Request_Query = GET_OrganizationsOrganizationIdAttributes_Request['parameters']['query'];
5069
+ /**
5070
+ * Path parameters for GET /v1/organizations/{organization_id}/attributes
5071
+ *
5072
+ * @remarks
5073
+ * This type defines the path parameters for the GET /v1/organizations/{organization_id}/attributes endpoint.
5074
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
5075
+ *
5076
+ * @example
5077
+ * Use this type to ensure type safety for path parameters.
5078
+ *
5079
+ * @path /v1/organizations/{organization_id}/attributes
5080
+ */
5081
+ export type GET_OrganizationsOrganizationIdAttributes_Request_Path = GET_OrganizationsOrganizationIdAttributes_Request['parameters']['path'];
5082
+
5083
+ /**
5084
+ * Request type for PATCH OrganizationsOrganizationIdAttributes endpoint
5085
+ *
5086
+ * Update organization attributes
5087
+ * Updates one or more organization attributes for the specified organization
5088
+ *
5089
+ * @remarks
5090
+ * This type defines the complete request structure for the PATCH OrganizationsOrganizationIdAttributes endpoint.
5091
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
5092
+ * Use this type to ensure type safety when making API requests to this endpoint.
5093
+ *
5094
+ * @example
5095
+ * Use this type to ensure type safety when making API requests to this endpoint.
5096
+ *
5097
+ * @path /v1/organizations/{organization_id}/attributes
5098
+ *
5099
+ * @see {@link PATCH_OrganizationsOrganizationIdAttributes_Request_Query} - Query parameters type
5100
+ * @see {@link PATCH_OrganizationsOrganizationIdAttributes_Request_Path} - Path parameters type
5101
+ * @see {@link PATCH_OrganizationsOrganizationIdAttributes_Request_Body} - Request body type
5102
+ */
5103
+ export type PATCH_OrganizationsOrganizationIdAttributes_Request = {
5104
+ parameters: {
5105
+ path: operations['update_attributes_v1_organizations__organization_id__attributes_patch']['parameters']['path'];
5106
+ };
5107
+ requestBody: OrganizationAttributeUpdateArray;
5108
+ }
5109
+ /**
5110
+ * Path parameters for PATCH /v1/organizations/{organization_id}/attributes
5111
+ *
5112
+ * @remarks
5113
+ * This type defines the path parameters for the PATCH /v1/organizations/{organization_id}/attributes endpoint.
5114
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
5115
+ *
5116
+ * @example
5117
+ * Use this type to ensure type safety for path parameters.
5118
+ *
5119
+ * @path /v1/organizations/{organization_id}/attributes
5120
+ */
5121
+ export type PATCH_OrganizationsOrganizationIdAttributes_Request_Path = PATCH_OrganizationsOrganizationIdAttributes_Request['parameters']['path'];
5122
+ /**
5123
+ * Request body for PATCH /v1/organizations/{organization_id}/attributes
5124
+ *
5125
+ * @remarks
5126
+ * This type defines the request body structure for the PATCH /v1/organizations/{organization_id}/attributes endpoint.
5127
+ * It provides type safety for the request body as defined in the OpenAPI specification.
5128
+ *
5129
+ * @example
5130
+ * Use this type to ensure type safety for request body structure.
5131
+ *
5132
+ * @path /v1/organizations/{organization_id}/attributes
5133
+ */
5134
+ export type PATCH_OrganizationsOrganizationIdAttributes_Request_Body = PATCH_OrganizationsOrganizationIdAttributes_Request['requestBody'];
5135
+
5136
5136
  /**
5137
5137
  * Request type for GET OrganizationsOrganizationIdBillingInvoices endpoint
5138
5138
  *