@opusdns/api 0.215.0 → 0.216.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.215.0",
6
+ "version": "0.216.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -21,7 +21,7 @@
21
21
  * ```
22
22
  */
23
23
 
24
- import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
24
+ import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -2892,6 +2892,58 @@ export const OBJECT_LOG_SORT_FIELD_VALUES = [
2892
2892
  'performed_by_id'
2893
2893
  ] as const satisfies [string, ...string[]] | ObjectLogSortField[];
2894
2894
 
2895
+ /**
2896
+ * OrganizationSortField. Auto-generated enum for OrganizationSortField
2897
+ *
2898
+ * @remarks
2899
+ * This constant provides both object and array forms for the OrganizationSortField enum.
2900
+ * The object form allows key-value access, while the array form enables iteration and validation.
2901
+ *
2902
+ * @example
2903
+ * ```typescript
2904
+ * // Using the object form for key-value access
2905
+ * const status = ORGANIZATION_SORT_FIELD.SUCCESS;
2906
+ *
2907
+ * // Using the array form for iteration
2908
+ * const allStatuses = ORGANIZATION_SORT_FIELD_VALUES;
2909
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
2910
+ * ```
2911
+ *
2912
+ * @see {@link OrganizationSortField} - The TypeScript type definition
2913
+ */
2914
+ export const ORGANIZATION_SORT_FIELD = {
2915
+ CREATED_ON: "created_on",
2916
+ NAME: "name",
2917
+ COUNTRY_CODE: "country_code",
2918
+ } as const satisfies Record<string, OrganizationSortField>;
2919
+
2920
+ /**
2921
+ * Array of all OrganizationSortField enum values
2922
+ *
2923
+ * @remarks
2924
+ * This constant provides a array containing all valid OrganizationSortField enum values.
2925
+ * Useful for iteration, validation, and generating dynamic UI components.
2926
+ *
2927
+ * @example
2928
+ * ```typescript
2929
+ * // Iterating through all values
2930
+ * for (const value of ORGANIZATION_SORT_FIELD_VALUES) {
2931
+ * console.log(`Processing: ${value}`);
2932
+ * }
2933
+ *
2934
+ * // Validation
2935
+ * const isValid = ORGANIZATION_SORT_FIELD_VALUES.includes(someValue);
2936
+ * ```
2937
+ *
2938
+ * @see {@link OrganizationSortField} - The TypeScript type definition
2939
+ * @see {@link ORGANIZATION_SORT_FIELD} - The object form of this enum
2940
+ */
2941
+ export const ORGANIZATION_SORT_FIELD_VALUES = [
2942
+ 'created_on',
2943
+ 'name',
2944
+ 'country_code'
2945
+ ] as const satisfies [string, ...string[]] | OrganizationSortField[];
2946
+
2895
2947
  /**
2896
2948
  * OrganizationStatus. Auto-generated enum for OrganizationStatus
2897
2949
  *
@@ -4177,6 +4229,58 @@ export const TRANSFER_ACK_TYPE_VALUES = [
4177
4229
  'both'
4178
4230
  ] as const satisfies [string, ...string[]] | TransferAckType[];
4179
4231
 
4232
+ /**
4233
+ * UserSortField. Auto-generated enum for UserSortField
4234
+ *
4235
+ * @remarks
4236
+ * This constant provides both object and array forms for the UserSortField enum.
4237
+ * The object form allows key-value access, while the array form enables iteration and validation.
4238
+ *
4239
+ * @example
4240
+ * ```typescript
4241
+ * // Using the object form for key-value access
4242
+ * const status = USER_SORT_FIELD.SUCCESS;
4243
+ *
4244
+ * // Using the array form for iteration
4245
+ * const allStatuses = USER_SORT_FIELD_VALUES;
4246
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
4247
+ * ```
4248
+ *
4249
+ * @see {@link UserSortField} - The TypeScript type definition
4250
+ */
4251
+ export const USER_SORT_FIELD = {
4252
+ CREATED_ON: "created_on",
4253
+ USERNAME: "username",
4254
+ EMAIL: "email",
4255
+ } as const satisfies Record<string, UserSortField>;
4256
+
4257
+ /**
4258
+ * Array of all UserSortField enum values
4259
+ *
4260
+ * @remarks
4261
+ * This constant provides a array containing all valid UserSortField enum values.
4262
+ * Useful for iteration, validation, and generating dynamic UI components.
4263
+ *
4264
+ * @example
4265
+ * ```typescript
4266
+ * // Iterating through all values
4267
+ * for (const value of USER_SORT_FIELD_VALUES) {
4268
+ * console.log(`Processing: ${value}`);
4269
+ * }
4270
+ *
4271
+ * // Validation
4272
+ * const isValid = USER_SORT_FIELD_VALUES.includes(someValue);
4273
+ * ```
4274
+ *
4275
+ * @see {@link UserSortField} - The TypeScript type definition
4276
+ * @see {@link USER_SORT_FIELD} - The object form of this enum
4277
+ */
4278
+ export const USER_SORT_FIELD_VALUES = [
4279
+ 'created_on',
4280
+ 'username',
4281
+ 'email'
4282
+ ] as const satisfies [string, ...string[]] | UserSortField[];
4283
+
4180
4284
  /**
4181
4285
  * UserStatus. Auto-generated enum for UserStatus
4182
4286
  *
@@ -3012,6 +3012,22 @@ export type OrganizationAttributeUpdate = components['schemas']['OrganizationAtt
3012
3012
  * @see {@link components} - The OpenAPI components schema definition
3013
3013
  */
3014
3014
  export type OrganizationCreate = components['schemas']['OrganizationCreate'];
3015
+ /**
3016
+ * OrganizationSortField
3017
+ *
3018
+ * @remarks
3019
+ * Type alias for the `OrganizationSortField` OpenAPI schema.
3020
+ * This type represents organizationsortfield data structures used in API requests and responses.
3021
+ *
3022
+ * @example
3023
+ * ```typescript
3024
+ * const response = await api.getOrganizationSortField();
3025
+ * const item: OrganizationSortField = response.results;
3026
+ * ```
3027
+ *
3028
+ * @see {@link components} - The OpenAPI components schema definition
3029
+ */
3030
+ export type OrganizationSortField = components['schemas']['OrganizationSortField'];
3015
3031
  /**
3016
3032
  * OrganizationStatus
3017
3033
  *
@@ -4420,6 +4436,22 @@ export type UserPublic = components['schemas']['UserPublic'];
4420
4436
  * @see {@link components} - The OpenAPI components schema definition
4421
4437
  */
4422
4438
  export type UserPublicWithAttributes = components['schemas']['UserPublicWithAttributes'];
4439
+ /**
4440
+ * UserSortField
4441
+ *
4442
+ * @remarks
4443
+ * Type alias for the `UserSortField` OpenAPI schema.
4444
+ * This type represents usersortfield data structures used in API requests and responses.
4445
+ *
4446
+ * @example
4447
+ * ```typescript
4448
+ * const response = await api.getUserSortField();
4449
+ * const item: UserSortField = response.results;
4450
+ * ```
4451
+ *
4452
+ * @see {@link components} - The OpenAPI components schema definition
4453
+ */
4454
+ export type UserSortField = components['schemas']['UserSortField'];
4423
4455
  /**
4424
4456
  * UserStatus
4425
4457
  *
package/src/openapi.yaml CHANGED
@@ -4744,6 +4744,13 @@ components:
4744
4744
  - name
4745
4745
  title: OrganizationCreate
4746
4746
  type: object
4747
+ OrganizationSortField:
4748
+ enum:
4749
+ - created_on
4750
+ - name
4751
+ - country_code
4752
+ title: OrganizationSortField
4753
+ type: string
4747
4754
  OrganizationStatus:
4748
4755
  enum:
4749
4756
  - active
@@ -6862,6 +6869,13 @@ components:
6862
6869
  - status
6863
6870
  title: UserPublicWithAttributes
6864
6871
  type: object
6872
+ UserSortField:
6873
+ enum:
6874
+ - created_on
6875
+ - username
6876
+ - email
6877
+ title: UserSortField
6878
+ type: string
6865
6879
  UserStatus:
6866
6880
  enum:
6867
6881
  - active
@@ -7296,7 +7310,7 @@ info:
7296
7310
  '
7297
7311
  summary: OpusDNS - your gateway to a seamless domain management experience.
7298
7312
  title: OpusDNS API
7299
- version: 2026-03-09-100152
7313
+ version: 2026-03-09-181800
7300
7314
  x-logo:
7301
7315
  altText: OpusDNS API Reference
7302
7316
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -15204,6 +15218,36 @@ paths:
15204
15218
  description: Retrieves a paginated list of organizations under the current organization
15205
15219
  operationId: list_organizations_v1_organizations_get
15206
15220
  parameters:
15221
+ - in: query
15222
+ name: sort_by
15223
+ required: false
15224
+ schema:
15225
+ $ref: '#/components/schemas/OrganizationSortField'
15226
+ default: created_on
15227
+ - in: query
15228
+ name: sort_order
15229
+ required: false
15230
+ schema:
15231
+ $ref: '#/components/schemas/SortOrder'
15232
+ default: desc
15233
+ - in: query
15234
+ name: q
15235
+ required: false
15236
+ schema:
15237
+ anyOf:
15238
+ - maxLength: 200
15239
+ type: string
15240
+ - type: 'null'
15241
+ title: Q
15242
+ - in: query
15243
+ name: country_code
15244
+ required: false
15245
+ schema:
15246
+ anyOf:
15247
+ - pattern: ^\w{2}$
15248
+ type: string
15249
+ - type: 'null'
15250
+ title: Country Code
15207
15251
  - in: query
15208
15252
  name: page
15209
15253
  required: false
@@ -15958,6 +16002,27 @@ paths:
15958
16002
  description: Retrieves a paginated list of users under the current organization
15959
16003
  operationId: list_users_v1_organizations_users_get
15960
16004
  parameters:
16005
+ - in: query
16006
+ name: sort_by
16007
+ required: false
16008
+ schema:
16009
+ $ref: '#/components/schemas/UserSortField'
16010
+ default: created_on
16011
+ - in: query
16012
+ name: sort_order
16013
+ required: false
16014
+ schema:
16015
+ $ref: '#/components/schemas/SortOrder'
16016
+ default: desc
16017
+ - in: query
16018
+ name: q
16019
+ required: false
16020
+ schema:
16021
+ anyOf:
16022
+ - maxLength: 200
16023
+ type: string
16024
+ - type: 'null'
16025
+ title: Q
15961
16026
  - in: query
15962
16027
  name: page
15963
16028
  required: false
package/src/schema.d.ts CHANGED
@@ -5138,6 +5138,11 @@ export interface components {
5138
5138
  */
5139
5139
  users?: components["schemas"]["UserCreate"][];
5140
5140
  };
5141
+ /**
5142
+ * OrganizationSortField
5143
+ * @enum {string}
5144
+ */
5145
+ OrganizationSortField: "created_on" | "name" | "country_code";
5141
5146
  /**
5142
5147
  * OrganizationStatus
5143
5148
  * @enum {string}
@@ -6499,6 +6504,11 @@ export interface components {
6499
6504
  */
6500
6505
  username: string;
6501
6506
  };
6507
+ /**
6508
+ * UserSortField
6509
+ * @enum {string}
6510
+ */
6511
+ UserSortField: "created_on" | "username" | "email";
6502
6512
  /**
6503
6513
  * UserStatus
6504
6514
  * @enum {string}
@@ -12518,6 +12528,10 @@ export interface operations {
12518
12528
  list_organizations_v1_organizations_get: {
12519
12529
  parameters: {
12520
12530
  query?: {
12531
+ sort_by?: components["schemas"]["OrganizationSortField"];
12532
+ sort_order?: components["schemas"]["SortOrder"];
12533
+ q?: string | null;
12534
+ country_code?: string | null;
12521
12535
  page?: number;
12522
12536
  page_size?: number;
12523
12537
  };
@@ -13290,6 +13304,9 @@ export interface operations {
13290
13304
  list_users_v1_organizations_users_get: {
13291
13305
  parameters: {
13292
13306
  query?: {
13307
+ sort_by?: components["schemas"]["UserSortField"];
13308
+ sort_order?: components["schemas"]["SortOrder"];
13309
+ q?: string | null;
13293
13310
  page?: number;
13294
13311
  page_size?: number;
13295
13312
  };