@opusdns/api 1.44.0 → 1.46.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 +44 -31
- package/src/helpers/responses.d.ts +3 -3
- package/src/helpers/schemas.d.ts +2 -1
- package/src/openapi.yaml +144 -107
- package/src/schema.d.ts +108 -85
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -375,12 +375,13 @@ import type {
|
|
|
375
375
|
UserAttributeBase,
|
|
376
376
|
UserAttribute,
|
|
377
377
|
UserCreate,
|
|
378
|
+
UserOrganizationMeta,
|
|
379
|
+
UserProfile,
|
|
378
380
|
UserPublic,
|
|
379
381
|
UserPublicWithAttributes,
|
|
380
382
|
UserPublicWithRole,
|
|
381
383
|
UserToken,
|
|
382
384
|
UserUpdate,
|
|
383
|
-
UserWithAuthorization,
|
|
384
385
|
ValidationError,
|
|
385
386
|
VanityNameserverDTO,
|
|
386
387
|
VanityNameserverSetCreate,
|
|
@@ -3903,6 +3904,7 @@ export const KEYS_ORGANIZATION_ATTRIBUTE_UPDATE = [
|
|
|
3903
3904
|
export const KEY_ORGANIZATION_CREATE_ADDRESS_1 = 'address_1' satisfies keyof OrganizationCreate;
|
|
3904
3905
|
export const KEY_ORGANIZATION_CREATE_ADDRESS_2 = 'address_2' satisfies keyof OrganizationCreate;
|
|
3905
3906
|
export const KEY_ORGANIZATION_CREATE_ATTRIBUTES = 'attributes' satisfies keyof OrganizationCreate;
|
|
3907
|
+
export const KEY_ORGANIZATION_CREATE_BILLING_MODE = 'billing_mode' satisfies keyof OrganizationCreate;
|
|
3906
3908
|
export const KEY_ORGANIZATION_CREATE_BUSINESS_NUMBER = 'business_number' satisfies keyof OrganizationCreate;
|
|
3907
3909
|
export const KEY_ORGANIZATION_CREATE_CITY = 'city' satisfies keyof OrganizationCreate;
|
|
3908
3910
|
export const KEY_ORGANIZATION_CREATE_COUNTRY_CODE = 'country_code' satisfies keyof OrganizationCreate;
|
|
@@ -3921,6 +3923,7 @@ export const KEYS_ORGANIZATION_CREATE = [
|
|
|
3921
3923
|
KEY_ORGANIZATION_CREATE_ADDRESS_1,
|
|
3922
3924
|
KEY_ORGANIZATION_CREATE_ADDRESS_2,
|
|
3923
3925
|
KEY_ORGANIZATION_CREATE_ATTRIBUTES,
|
|
3926
|
+
KEY_ORGANIZATION_CREATE_BILLING_MODE,
|
|
3924
3927
|
KEY_ORGANIZATION_CREATE_BUSINESS_NUMBER,
|
|
3925
3928
|
KEY_ORGANIZATION_CREATE_CITY,
|
|
3926
3929
|
KEY_ORGANIZATION_CREATE_COUNTRY_CODE,
|
|
@@ -5064,6 +5067,46 @@ export const KEYS_USER_CREATE = [
|
|
|
5064
5067
|
KEY_USER_CREATE_USERNAME,
|
|
5065
5068
|
] as const satisfies (keyof UserCreate)[];
|
|
5066
5069
|
|
|
5070
|
+
export const KEY_USER_ORGANIZATION_META_CURRENCY = 'currency' satisfies keyof UserOrganizationMeta;
|
|
5071
|
+
export const KEY_USER_ORGANIZATION_META_PARENT_ORGANIZATION_ID = 'parent_organization_id' satisfies keyof UserOrganizationMeta;
|
|
5072
|
+
|
|
5073
|
+
export const KEYS_USER_ORGANIZATION_META = [
|
|
5074
|
+
KEY_USER_ORGANIZATION_META_CURRENCY,
|
|
5075
|
+
KEY_USER_ORGANIZATION_META_PARENT_ORGANIZATION_ID,
|
|
5076
|
+
] as const satisfies (keyof UserOrganizationMeta)[];
|
|
5077
|
+
|
|
5078
|
+
export const KEY_USER_PROFILE_CREATED_ON = 'created_on' satisfies keyof UserProfile;
|
|
5079
|
+
export const KEY_USER_PROFILE_EMAIL = 'email' satisfies keyof UserProfile;
|
|
5080
|
+
export const KEY_USER_PROFILE_FIRST_NAME = 'first_name' satisfies keyof UserProfile;
|
|
5081
|
+
export const KEY_USER_PROFILE_LAST_NAME = 'last_name' satisfies keyof UserProfile;
|
|
5082
|
+
export const KEY_USER_PROFILE_LOCALE = 'locale' satisfies keyof UserProfile;
|
|
5083
|
+
export const KEY_USER_PROFILE_ORGANIZATION = 'organization' satisfies keyof UserProfile;
|
|
5084
|
+
export const KEY_USER_PROFILE_ORGANIZATION_ID = 'organization_id' satisfies keyof UserProfile;
|
|
5085
|
+
export const KEY_USER_PROFILE_PERMISSIONS = 'permissions' satisfies keyof UserProfile;
|
|
5086
|
+
export const KEY_USER_PROFILE_PHONE = 'phone' satisfies keyof UserProfile;
|
|
5087
|
+
export const KEY_USER_PROFILE_ROLE = 'role' satisfies keyof UserProfile;
|
|
5088
|
+
export const KEY_USER_PROFILE_UPDATED_ON = 'updated_on' satisfies keyof UserProfile;
|
|
5089
|
+
export const KEY_USER_PROFILE_USER_ATTRIBUTES = 'user_attributes' satisfies keyof UserProfile;
|
|
5090
|
+
export const KEY_USER_PROFILE_USER_ID = 'user_id' satisfies keyof UserProfile;
|
|
5091
|
+
export const KEY_USER_PROFILE_USERNAME = 'username' satisfies keyof UserProfile;
|
|
5092
|
+
|
|
5093
|
+
export const KEYS_USER_PROFILE = [
|
|
5094
|
+
KEY_USER_PROFILE_CREATED_ON,
|
|
5095
|
+
KEY_USER_PROFILE_EMAIL,
|
|
5096
|
+
KEY_USER_PROFILE_FIRST_NAME,
|
|
5097
|
+
KEY_USER_PROFILE_LAST_NAME,
|
|
5098
|
+
KEY_USER_PROFILE_LOCALE,
|
|
5099
|
+
KEY_USER_PROFILE_ORGANIZATION,
|
|
5100
|
+
KEY_USER_PROFILE_ORGANIZATION_ID,
|
|
5101
|
+
KEY_USER_PROFILE_PERMISSIONS,
|
|
5102
|
+
KEY_USER_PROFILE_PHONE,
|
|
5103
|
+
KEY_USER_PROFILE_ROLE,
|
|
5104
|
+
KEY_USER_PROFILE_UPDATED_ON,
|
|
5105
|
+
KEY_USER_PROFILE_USER_ATTRIBUTES,
|
|
5106
|
+
KEY_USER_PROFILE_USER_ID,
|
|
5107
|
+
KEY_USER_PROFILE_USERNAME,
|
|
5108
|
+
] as const satisfies (keyof UserProfile)[];
|
|
5109
|
+
|
|
5067
5110
|
export const KEY_USER_PUBLIC_CREATED_ON = 'created_on' satisfies keyof UserPublic;
|
|
5068
5111
|
export const KEY_USER_PUBLIC_EMAIL = 'email' satisfies keyof UserPublic;
|
|
5069
5112
|
export const KEY_USER_PUBLIC_FIRST_NAME = 'first_name' satisfies keyof UserPublic;
|
|
@@ -5172,36 +5215,6 @@ export const KEYS_USER_UPDATE = [
|
|
|
5172
5215
|
KEY_USER_UPDATE_USERNAME,
|
|
5173
5216
|
] as const satisfies (keyof UserUpdate)[];
|
|
5174
5217
|
|
|
5175
|
-
export const KEY_USER_WITH_AUTHORIZATION_CREATED_ON = 'created_on' satisfies keyof UserWithAuthorization;
|
|
5176
|
-
export const KEY_USER_WITH_AUTHORIZATION_EMAIL = 'email' satisfies keyof UserWithAuthorization;
|
|
5177
|
-
export const KEY_USER_WITH_AUTHORIZATION_FIRST_NAME = 'first_name' satisfies keyof UserWithAuthorization;
|
|
5178
|
-
export const KEY_USER_WITH_AUTHORIZATION_LAST_NAME = 'last_name' satisfies keyof UserWithAuthorization;
|
|
5179
|
-
export const KEY_USER_WITH_AUTHORIZATION_LOCALE = 'locale' satisfies keyof UserWithAuthorization;
|
|
5180
|
-
export const KEY_USER_WITH_AUTHORIZATION_ORGANIZATION_ID = 'organization_id' satisfies keyof UserWithAuthorization;
|
|
5181
|
-
export const KEY_USER_WITH_AUTHORIZATION_PERMISSIONS = 'permissions' satisfies keyof UserWithAuthorization;
|
|
5182
|
-
export const KEY_USER_WITH_AUTHORIZATION_PHONE = 'phone' satisfies keyof UserWithAuthorization;
|
|
5183
|
-
export const KEY_USER_WITH_AUTHORIZATION_ROLE = 'role' satisfies keyof UserWithAuthorization;
|
|
5184
|
-
export const KEY_USER_WITH_AUTHORIZATION_UPDATED_ON = 'updated_on' satisfies keyof UserWithAuthorization;
|
|
5185
|
-
export const KEY_USER_WITH_AUTHORIZATION_USER_ATTRIBUTES = 'user_attributes' satisfies keyof UserWithAuthorization;
|
|
5186
|
-
export const KEY_USER_WITH_AUTHORIZATION_USER_ID = 'user_id' satisfies keyof UserWithAuthorization;
|
|
5187
|
-
export const KEY_USER_WITH_AUTHORIZATION_USERNAME = 'username' satisfies keyof UserWithAuthorization;
|
|
5188
|
-
|
|
5189
|
-
export const KEYS_USER_WITH_AUTHORIZATION = [
|
|
5190
|
-
KEY_USER_WITH_AUTHORIZATION_CREATED_ON,
|
|
5191
|
-
KEY_USER_WITH_AUTHORIZATION_EMAIL,
|
|
5192
|
-
KEY_USER_WITH_AUTHORIZATION_FIRST_NAME,
|
|
5193
|
-
KEY_USER_WITH_AUTHORIZATION_LAST_NAME,
|
|
5194
|
-
KEY_USER_WITH_AUTHORIZATION_LOCALE,
|
|
5195
|
-
KEY_USER_WITH_AUTHORIZATION_ORGANIZATION_ID,
|
|
5196
|
-
KEY_USER_WITH_AUTHORIZATION_PERMISSIONS,
|
|
5197
|
-
KEY_USER_WITH_AUTHORIZATION_PHONE,
|
|
5198
|
-
KEY_USER_WITH_AUTHORIZATION_ROLE,
|
|
5199
|
-
KEY_USER_WITH_AUTHORIZATION_UPDATED_ON,
|
|
5200
|
-
KEY_USER_WITH_AUTHORIZATION_USER_ATTRIBUTES,
|
|
5201
|
-
KEY_USER_WITH_AUTHORIZATION_USER_ID,
|
|
5202
|
-
KEY_USER_WITH_AUTHORIZATION_USERNAME,
|
|
5203
|
-
] as const satisfies (keyof UserWithAuthorization)[];
|
|
5204
|
-
|
|
5205
5218
|
export const KEY_VALIDATION_ERROR_CTX = 'ctx' satisfies keyof ValidationError;
|
|
5206
5219
|
export const KEY_VALIDATION_ERROR_INPUT = 'input' satisfies keyof ValidationError;
|
|
5207
5220
|
export const KEY_VALIDATION_ERROR_LOC = 'loc' satisfies keyof ValidationError;
|
|
@@ -96,9 +96,9 @@ import type {
|
|
|
96
96
|
Tag,
|
|
97
97
|
TldResponseShort,
|
|
98
98
|
TldSpecification,
|
|
99
|
+
UserProfile,
|
|
99
100
|
UserPublic,
|
|
100
101
|
UserPublicWithAttributes,
|
|
101
|
-
UserWithAuthorization,
|
|
102
102
|
VanityNameserverSetSummaryDTO,
|
|
103
103
|
VanityNsCheckRes,
|
|
104
104
|
} from './schemas';
|
|
@@ -802,7 +802,7 @@ export type GET_UsersByUserIdRole_Response_422 = HTTPValidationError;
|
|
|
802
802
|
|
|
803
803
|
export type GET_UsersMe_Response = GET_UsersMe_Response_200 | GET_UsersMe_Response_422;
|
|
804
804
|
|
|
805
|
-
export type GET_UsersMe_Response_200 =
|
|
805
|
+
export type GET_UsersMe_Response_200 = UserProfile;
|
|
806
806
|
export type GET_UsersMe_Response_422 = HTTPValidationError;
|
|
807
807
|
|
|
808
808
|
export type GET_VanityNameserverSets_Response = GET_VanityNameserverSets_Response_200 | GET_VanityNameserverSets_Response_422;
|
|
@@ -1213,7 +1213,7 @@ export type POST_Organizations_Response = POST_Organizations_Response_200 | POST
|
|
|
1213
1213
|
export type POST_Organizations_Response_200 = Organization;
|
|
1214
1214
|
export type POST_Organizations_Response_401 = Problem;
|
|
1215
1215
|
export type POST_Organizations_Response_403 = Problem;
|
|
1216
|
-
export type POST_Organizations_Response_422 =
|
|
1216
|
+
export type POST_Organizations_Response_422 = Problem;
|
|
1217
1217
|
|
|
1218
1218
|
export type POST_OrganizationsIpRestrictions_Response = POST_OrganizationsIpRestrictions_Response_200 | POST_OrganizationsIpRestrictions_Response_401 | POST_OrganizationsIpRestrictions_Response_403 | POST_OrganizationsIpRestrictions_Response_422;
|
|
1219
1219
|
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -505,13 +505,14 @@ export type UserAgentStatsBucket = components['schemas']['UserAgentStatsBucket']
|
|
|
505
505
|
export type UserAttributeBase = components['schemas']['UserAttributeBase'];
|
|
506
506
|
export type UserAttribute = components['schemas']['UserAttributeResponse'];
|
|
507
507
|
export type UserCreate = components['schemas']['UserCreate'];
|
|
508
|
+
export type UserOrganizationMeta = components['schemas']['UserOrganizationMeta'];
|
|
509
|
+
export type UserProfile = components['schemas']['UserProfile'];
|
|
508
510
|
export type UserPublic = components['schemas']['UserPublic'];
|
|
509
511
|
export type UserPublicWithAttributes = components['schemas']['UserPublicWithAttributes'];
|
|
510
512
|
export type UserPublicWithRole = components['schemas']['UserPublicWithRole'];
|
|
511
513
|
export type UserSortField = components['schemas']['UserSortField'];
|
|
512
514
|
export type UserToken = components['schemas']['UserTokenResponse'];
|
|
513
515
|
export type UserUpdate = components['schemas']['UserUpdate'];
|
|
514
|
-
export type UserWithAuthorization = components['schemas']['UserWithAuthorization'];
|
|
515
516
|
export type ValidationError = components['schemas']['ValidationError'];
|
|
516
517
|
export type VanityNameserverDTO = components['schemas']['VanityNameserverDTO'];
|
|
517
518
|
export type VanityNameserverSetCreate = components['schemas']['VanityNameserverSetCreate'];
|
package/src/openapi.yaml
CHANGED
|
@@ -9272,6 +9272,12 @@ components:
|
|
|
9272
9272
|
$ref: '#/components/schemas/OrganizationAttributeCreate'
|
|
9273
9273
|
title: Attributes
|
|
9274
9274
|
type: array
|
|
9275
|
+
billing_mode:
|
|
9276
|
+
$ref: '#/components/schemas/BillingMode'
|
|
9277
|
+
default: consolidated
|
|
9278
|
+
description: Whether the organization is billed on its own account (INDEPENDENT)
|
|
9279
|
+
or rolled up to its parent (CONSOLIDATED). INDEPENDENT is only permitted
|
|
9280
|
+
for eligible sub-organizations. Cannot be changed after creation.
|
|
9275
9281
|
business_number:
|
|
9276
9282
|
anyOf:
|
|
9277
9283
|
- maxLength: 100
|
|
@@ -12653,6 +12659,133 @@ components:
|
|
|
12653
12659
|
- locale
|
|
12654
12660
|
title: UserCreate
|
|
12655
12661
|
type: object
|
|
12662
|
+
UserOrganizationMeta:
|
|
12663
|
+
properties:
|
|
12664
|
+
currency:
|
|
12665
|
+
anyOf:
|
|
12666
|
+
- $ref: '#/components/schemas/Currency'
|
|
12667
|
+
- type: 'null'
|
|
12668
|
+
description: Currency used by the user's organization.
|
|
12669
|
+
parent_organization_id:
|
|
12670
|
+
anyOf:
|
|
12671
|
+
- examples:
|
|
12672
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
12673
|
+
format: typeid
|
|
12674
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
12675
|
+
type: string
|
|
12676
|
+
x-typeid-prefix: organization
|
|
12677
|
+
- type: 'null'
|
|
12678
|
+
description: ID of the parent organization, if any.
|
|
12679
|
+
title: Parent Organization Id
|
|
12680
|
+
title: UserOrganizationMeta
|
|
12681
|
+
type: object
|
|
12682
|
+
UserProfile:
|
|
12683
|
+
properties:
|
|
12684
|
+
created_on:
|
|
12685
|
+
description: The date/time the entry was created on
|
|
12686
|
+
format: date-time
|
|
12687
|
+
title: Created On
|
|
12688
|
+
type: string
|
|
12689
|
+
email:
|
|
12690
|
+
description: The user's email address
|
|
12691
|
+
format: email
|
|
12692
|
+
title: Email
|
|
12693
|
+
type: string
|
|
12694
|
+
first_name:
|
|
12695
|
+
description: The user's first name
|
|
12696
|
+
maxLength: 255
|
|
12697
|
+
minLength: 1
|
|
12698
|
+
title: First Name
|
|
12699
|
+
type: string
|
|
12700
|
+
last_name:
|
|
12701
|
+
description: The user's last name
|
|
12702
|
+
maxLength: 255
|
|
12703
|
+
minLength: 1
|
|
12704
|
+
title: Last Name
|
|
12705
|
+
type: string
|
|
12706
|
+
locale:
|
|
12707
|
+
examples:
|
|
12708
|
+
- en_US
|
|
12709
|
+
title: Locale
|
|
12710
|
+
type: string
|
|
12711
|
+
organization:
|
|
12712
|
+
anyOf:
|
|
12713
|
+
- $ref: '#/components/schemas/UserOrganizationMeta'
|
|
12714
|
+
- type: 'null'
|
|
12715
|
+
organization_id:
|
|
12716
|
+
default: None
|
|
12717
|
+
description: The user's organization id
|
|
12718
|
+
examples:
|
|
12719
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
12720
|
+
format: typeid
|
|
12721
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
12722
|
+
title: Organization Id
|
|
12723
|
+
type: string
|
|
12724
|
+
x-typeid-prefix: organization
|
|
12725
|
+
permissions:
|
|
12726
|
+
anyOf:
|
|
12727
|
+
- items:
|
|
12728
|
+
$ref: '#/components/schemas/PublicPermission'
|
|
12729
|
+
type: array
|
|
12730
|
+
- type: 'null'
|
|
12731
|
+
title: Permissions
|
|
12732
|
+
phone:
|
|
12733
|
+
anyOf:
|
|
12734
|
+
- format: phone
|
|
12735
|
+
type: string
|
|
12736
|
+
- type: 'null'
|
|
12737
|
+
description: The user's phone number
|
|
12738
|
+
examples:
|
|
12739
|
+
- '+1.2125552368'
|
|
12740
|
+
title: Phone
|
|
12741
|
+
role:
|
|
12742
|
+
anyOf:
|
|
12743
|
+
- $ref: '#/components/schemas/PublicRole'
|
|
12744
|
+
- $ref: '#/components/schemas/CustomRoleLabel'
|
|
12745
|
+
- type: 'null'
|
|
12746
|
+
title: Role
|
|
12747
|
+
updated_on:
|
|
12748
|
+
description: The date/time the entry was last updated on
|
|
12749
|
+
format: date-time
|
|
12750
|
+
title: Updated On
|
|
12751
|
+
type: string
|
|
12752
|
+
user_attributes:
|
|
12753
|
+
additionalProperties:
|
|
12754
|
+
$ref: '#/components/schemas/JsonValue'
|
|
12755
|
+
description: All of the user attributes
|
|
12756
|
+
examples:
|
|
12757
|
+
- array:
|
|
12758
|
+
- 1
|
|
12759
|
+
- 2
|
|
12760
|
+
- 3
|
|
12761
|
+
bool: true
|
|
12762
|
+
number: 1
|
|
12763
|
+
string: value2
|
|
12764
|
+
title: User Attributes
|
|
12765
|
+
type: object
|
|
12766
|
+
user_id:
|
|
12767
|
+
examples:
|
|
12768
|
+
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
12769
|
+
format: typeid
|
|
12770
|
+
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
12771
|
+
title: User Id
|
|
12772
|
+
type: string
|
|
12773
|
+
x-typeid-prefix: user
|
|
12774
|
+
username:
|
|
12775
|
+
description: The user's unique username
|
|
12776
|
+
maxLength: 128
|
|
12777
|
+
minLength: 3
|
|
12778
|
+
pattern: ^[a-zA-Z0-9\-+_@.]+$
|
|
12779
|
+
title: Username
|
|
12780
|
+
type: string
|
|
12781
|
+
required:
|
|
12782
|
+
- username
|
|
12783
|
+
- first_name
|
|
12784
|
+
- last_name
|
|
12785
|
+
- email
|
|
12786
|
+
- locale
|
|
12787
|
+
title: UserProfile
|
|
12788
|
+
type: object
|
|
12656
12789
|
UserPublic:
|
|
12657
12790
|
properties:
|
|
12658
12791
|
created_on:
|
|
@@ -13001,109 +13134,6 @@ components:
|
|
|
13001
13134
|
title: Username
|
|
13002
13135
|
title: UserUpdate
|
|
13003
13136
|
type: object
|
|
13004
|
-
UserWithAuthorization:
|
|
13005
|
-
properties:
|
|
13006
|
-
created_on:
|
|
13007
|
-
description: The date/time the entry was created on
|
|
13008
|
-
format: date-time
|
|
13009
|
-
title: Created On
|
|
13010
|
-
type: string
|
|
13011
|
-
email:
|
|
13012
|
-
description: The user's email address
|
|
13013
|
-
format: email
|
|
13014
|
-
title: Email
|
|
13015
|
-
type: string
|
|
13016
|
-
first_name:
|
|
13017
|
-
description: The user's first name
|
|
13018
|
-
maxLength: 255
|
|
13019
|
-
minLength: 1
|
|
13020
|
-
title: First Name
|
|
13021
|
-
type: string
|
|
13022
|
-
last_name:
|
|
13023
|
-
description: The user's last name
|
|
13024
|
-
maxLength: 255
|
|
13025
|
-
minLength: 1
|
|
13026
|
-
title: Last Name
|
|
13027
|
-
type: string
|
|
13028
|
-
locale:
|
|
13029
|
-
examples:
|
|
13030
|
-
- en_US
|
|
13031
|
-
title: Locale
|
|
13032
|
-
type: string
|
|
13033
|
-
organization_id:
|
|
13034
|
-
default: None
|
|
13035
|
-
description: The user's organization id
|
|
13036
|
-
examples:
|
|
13037
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
13038
|
-
format: typeid
|
|
13039
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
13040
|
-
title: Organization Id
|
|
13041
|
-
type: string
|
|
13042
|
-
x-typeid-prefix: organization
|
|
13043
|
-
permissions:
|
|
13044
|
-
anyOf:
|
|
13045
|
-
- items:
|
|
13046
|
-
$ref: '#/components/schemas/PublicPermission'
|
|
13047
|
-
type: array
|
|
13048
|
-
- type: 'null'
|
|
13049
|
-
title: Permissions
|
|
13050
|
-
phone:
|
|
13051
|
-
anyOf:
|
|
13052
|
-
- format: phone
|
|
13053
|
-
type: string
|
|
13054
|
-
- type: 'null'
|
|
13055
|
-
description: The user's phone number
|
|
13056
|
-
examples:
|
|
13057
|
-
- '+1.2125552368'
|
|
13058
|
-
title: Phone
|
|
13059
|
-
role:
|
|
13060
|
-
anyOf:
|
|
13061
|
-
- $ref: '#/components/schemas/PublicRole'
|
|
13062
|
-
- $ref: '#/components/schemas/CustomRoleLabel'
|
|
13063
|
-
- type: 'null'
|
|
13064
|
-
title: Role
|
|
13065
|
-
updated_on:
|
|
13066
|
-
description: The date/time the entry was last updated on
|
|
13067
|
-
format: date-time
|
|
13068
|
-
title: Updated On
|
|
13069
|
-
type: string
|
|
13070
|
-
user_attributes:
|
|
13071
|
-
additionalProperties:
|
|
13072
|
-
$ref: '#/components/schemas/JsonValue'
|
|
13073
|
-
description: All of the user attributes
|
|
13074
|
-
examples:
|
|
13075
|
-
- array:
|
|
13076
|
-
- 1
|
|
13077
|
-
- 2
|
|
13078
|
-
- 3
|
|
13079
|
-
bool: true
|
|
13080
|
-
number: 1
|
|
13081
|
-
string: value2
|
|
13082
|
-
title: User Attributes
|
|
13083
|
-
type: object
|
|
13084
|
-
user_id:
|
|
13085
|
-
examples:
|
|
13086
|
-
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
13087
|
-
format: typeid
|
|
13088
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
13089
|
-
title: User Id
|
|
13090
|
-
type: string
|
|
13091
|
-
x-typeid-prefix: user
|
|
13092
|
-
username:
|
|
13093
|
-
description: The user's unique username
|
|
13094
|
-
maxLength: 128
|
|
13095
|
-
minLength: 3
|
|
13096
|
-
pattern: ^[a-zA-Z0-9\-+_@.]+$
|
|
13097
|
-
title: Username
|
|
13098
|
-
type: string
|
|
13099
|
-
required:
|
|
13100
|
-
- username
|
|
13101
|
-
- first_name
|
|
13102
|
-
- last_name
|
|
13103
|
-
- email
|
|
13104
|
-
- locale
|
|
13105
|
-
title: UserWithAuthorization
|
|
13106
|
-
type: object
|
|
13107
13137
|
ValidationError:
|
|
13108
13138
|
properties:
|
|
13109
13139
|
ctx:
|
|
@@ -13822,7 +13852,7 @@ info:
|
|
|
13822
13852
|
\n\n"
|
|
13823
13853
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
13824
13854
|
title: OpusDNS API
|
|
13825
|
-
version: 2026-06-
|
|
13855
|
+
version: 2026-07-06-082943
|
|
13826
13856
|
x-logo:
|
|
13827
13857
|
altText: OpusDNS API Reference
|
|
13828
13858
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -25864,9 +25894,16 @@ paths:
|
|
|
25864
25894
|
'422':
|
|
25865
25895
|
content:
|
|
25866
25896
|
application/problem+json:
|
|
25897
|
+
example:
|
|
25898
|
+
code: ERROR_INDEPENDENT_BILLING_NOT_ALLOWED
|
|
25899
|
+
detail: Independent billing mode is only allowed for sub-organizations
|
|
25900
|
+
of a billing organization.
|
|
25901
|
+
status: 422
|
|
25902
|
+
title: Organization Management Error
|
|
25903
|
+
type: independent-billing-not-allowed
|
|
25867
25904
|
schema:
|
|
25868
|
-
$ref: '#/components/schemas/
|
|
25869
|
-
description:
|
|
25905
|
+
$ref: '#/components/schemas/Problem'
|
|
25906
|
+
description: Unprocessable Content
|
|
25870
25907
|
security:
|
|
25871
25908
|
- OAuth2PasswordBearer: []
|
|
25872
25909
|
- APIKeyHeader: []
|
|
@@ -28680,7 +28717,7 @@ paths:
|
|
|
28680
28717
|
content:
|
|
28681
28718
|
application/json:
|
|
28682
28719
|
schema:
|
|
28683
|
-
$ref: '#/components/schemas/
|
|
28720
|
+
$ref: '#/components/schemas/UserProfile'
|
|
28684
28721
|
description: Successful Response
|
|
28685
28722
|
'422':
|
|
28686
28723
|
content:
|
package/src/schema.d.ts
CHANGED
|
@@ -8880,6 +8880,11 @@ export interface components {
|
|
|
8880
8880
|
* @description List of attributes for the organization.
|
|
8881
8881
|
*/
|
|
8882
8882
|
attributes?: components["schemas"]["OrganizationAttributeCreate"][];
|
|
8883
|
+
/**
|
|
8884
|
+
* @description Whether the organization is billed on its own account (INDEPENDENT) or rolled up to its parent (CONSOLIDATED). INDEPENDENT is only permitted for eligible sub-organizations. Cannot be changed after creation.
|
|
8885
|
+
* @default consolidated
|
|
8886
|
+
*/
|
|
8887
|
+
billing_mode: components["schemas"]["BillingMode"];
|
|
8883
8888
|
/**
|
|
8884
8889
|
* Business Number
|
|
8885
8890
|
* @description Government issued business identifier for the organization issued.
|
|
@@ -11073,6 +11078,99 @@ export interface components {
|
|
|
11073
11078
|
*/
|
|
11074
11079
|
username: string;
|
|
11075
11080
|
};
|
|
11081
|
+
/** UserOrganizationMeta */
|
|
11082
|
+
UserOrganizationMeta: {
|
|
11083
|
+
/** @description Currency used by the user's organization. */
|
|
11084
|
+
currency?: components["schemas"]["Currency"] | null;
|
|
11085
|
+
/**
|
|
11086
|
+
* Parent Organization Id
|
|
11087
|
+
* @description ID of the parent organization, if any.
|
|
11088
|
+
*/
|
|
11089
|
+
parent_organization_id?: TypeId<"organization"> | null;
|
|
11090
|
+
};
|
|
11091
|
+
/** UserProfile */
|
|
11092
|
+
UserProfile: {
|
|
11093
|
+
/**
|
|
11094
|
+
* Created On
|
|
11095
|
+
* Format: date-time
|
|
11096
|
+
* @description The date/time the entry was created on
|
|
11097
|
+
*/
|
|
11098
|
+
created_on?: Date;
|
|
11099
|
+
/**
|
|
11100
|
+
* Email
|
|
11101
|
+
* Format: email
|
|
11102
|
+
* @description The user's email address
|
|
11103
|
+
*/
|
|
11104
|
+
email: string;
|
|
11105
|
+
/**
|
|
11106
|
+
* First Name
|
|
11107
|
+
* @description The user's first name
|
|
11108
|
+
*/
|
|
11109
|
+
first_name: string;
|
|
11110
|
+
/**
|
|
11111
|
+
* Last Name
|
|
11112
|
+
* @description The user's last name
|
|
11113
|
+
*/
|
|
11114
|
+
last_name: string;
|
|
11115
|
+
/**
|
|
11116
|
+
* Locale
|
|
11117
|
+
* @example en_US
|
|
11118
|
+
*/
|
|
11119
|
+
locale: string;
|
|
11120
|
+
organization?: components["schemas"]["UserOrganizationMeta"] | null;
|
|
11121
|
+
/**
|
|
11122
|
+
* Organization Id
|
|
11123
|
+
* Format: typeid
|
|
11124
|
+
* @description The user's organization id
|
|
11125
|
+
* @default None
|
|
11126
|
+
* @example organization_01h45ytscbebyvny4gc8cr8ma2
|
|
11127
|
+
*/
|
|
11128
|
+
organization_id: TypeId<"organization">;
|
|
11129
|
+
/** Permissions */
|
|
11130
|
+
permissions?: components["schemas"]["PublicPermission"][] | null;
|
|
11131
|
+
/**
|
|
11132
|
+
* Phone
|
|
11133
|
+
* @description The user's phone number
|
|
11134
|
+
* @example +1.2125552368
|
|
11135
|
+
*/
|
|
11136
|
+
phone?: string | null;
|
|
11137
|
+
/** Role */
|
|
11138
|
+
role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
|
|
11139
|
+
/**
|
|
11140
|
+
* Updated On
|
|
11141
|
+
* Format: date-time
|
|
11142
|
+
* @description The date/time the entry was last updated on
|
|
11143
|
+
*/
|
|
11144
|
+
updated_on?: Date;
|
|
11145
|
+
/**
|
|
11146
|
+
* User Attributes
|
|
11147
|
+
* @description All of the user attributes
|
|
11148
|
+
* @example {
|
|
11149
|
+
* "array": [
|
|
11150
|
+
* 1,
|
|
11151
|
+
* 2,
|
|
11152
|
+
* 3
|
|
11153
|
+
* ],
|
|
11154
|
+
* "bool": true,
|
|
11155
|
+
* "number": 1,
|
|
11156
|
+
* "string": "value2"
|
|
11157
|
+
* }
|
|
11158
|
+
*/
|
|
11159
|
+
user_attributes?: {
|
|
11160
|
+
[key: string]: components["schemas"]["JsonValue"];
|
|
11161
|
+
};
|
|
11162
|
+
/**
|
|
11163
|
+
* User Id
|
|
11164
|
+
* Format: typeid
|
|
11165
|
+
* @example user_01h45ytscbebyvny4gc8cr8ma2
|
|
11166
|
+
*/
|
|
11167
|
+
user_id?: TypeId<"user">;
|
|
11168
|
+
/**
|
|
11169
|
+
* Username
|
|
11170
|
+
* @description The user's unique username
|
|
11171
|
+
*/
|
|
11172
|
+
username: string;
|
|
11173
|
+
};
|
|
11076
11174
|
/** UserPublic */
|
|
11077
11175
|
UserPublic: {
|
|
11078
11176
|
/**
|
|
@@ -11347,88 +11445,6 @@ export interface components {
|
|
|
11347
11445
|
*/
|
|
11348
11446
|
username?: string | null;
|
|
11349
11447
|
};
|
|
11350
|
-
/** UserWithAuthorization */
|
|
11351
|
-
UserWithAuthorization: {
|
|
11352
|
-
/**
|
|
11353
|
-
* Created On
|
|
11354
|
-
* Format: date-time
|
|
11355
|
-
* @description The date/time the entry was created on
|
|
11356
|
-
*/
|
|
11357
|
-
created_on?: Date;
|
|
11358
|
-
/**
|
|
11359
|
-
* Email
|
|
11360
|
-
* Format: email
|
|
11361
|
-
* @description The user's email address
|
|
11362
|
-
*/
|
|
11363
|
-
email: string;
|
|
11364
|
-
/**
|
|
11365
|
-
* First Name
|
|
11366
|
-
* @description The user's first name
|
|
11367
|
-
*/
|
|
11368
|
-
first_name: string;
|
|
11369
|
-
/**
|
|
11370
|
-
* Last Name
|
|
11371
|
-
* @description The user's last name
|
|
11372
|
-
*/
|
|
11373
|
-
last_name: string;
|
|
11374
|
-
/**
|
|
11375
|
-
* Locale
|
|
11376
|
-
* @example en_US
|
|
11377
|
-
*/
|
|
11378
|
-
locale: string;
|
|
11379
|
-
/**
|
|
11380
|
-
* Organization Id
|
|
11381
|
-
* Format: typeid
|
|
11382
|
-
* @description The user's organization id
|
|
11383
|
-
* @default None
|
|
11384
|
-
* @example organization_01h45ytscbebyvny4gc8cr8ma2
|
|
11385
|
-
*/
|
|
11386
|
-
organization_id: TypeId<"organization">;
|
|
11387
|
-
/** Permissions */
|
|
11388
|
-
permissions?: components["schemas"]["PublicPermission"][] | null;
|
|
11389
|
-
/**
|
|
11390
|
-
* Phone
|
|
11391
|
-
* @description The user's phone number
|
|
11392
|
-
* @example +1.2125552368
|
|
11393
|
-
*/
|
|
11394
|
-
phone?: string | null;
|
|
11395
|
-
/** Role */
|
|
11396
|
-
role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
|
|
11397
|
-
/**
|
|
11398
|
-
* Updated On
|
|
11399
|
-
* Format: date-time
|
|
11400
|
-
* @description The date/time the entry was last updated on
|
|
11401
|
-
*/
|
|
11402
|
-
updated_on?: Date;
|
|
11403
|
-
/**
|
|
11404
|
-
* User Attributes
|
|
11405
|
-
* @description All of the user attributes
|
|
11406
|
-
* @example {
|
|
11407
|
-
* "array": [
|
|
11408
|
-
* 1,
|
|
11409
|
-
* 2,
|
|
11410
|
-
* 3
|
|
11411
|
-
* ],
|
|
11412
|
-
* "bool": true,
|
|
11413
|
-
* "number": 1,
|
|
11414
|
-
* "string": "value2"
|
|
11415
|
-
* }
|
|
11416
|
-
*/
|
|
11417
|
-
user_attributes?: {
|
|
11418
|
-
[key: string]: components["schemas"]["JsonValue"];
|
|
11419
|
-
};
|
|
11420
|
-
/**
|
|
11421
|
-
* User Id
|
|
11422
|
-
* Format: typeid
|
|
11423
|
-
* @example user_01h45ytscbebyvny4gc8cr8ma2
|
|
11424
|
-
*/
|
|
11425
|
-
user_id?: TypeId<"user">;
|
|
11426
|
-
/**
|
|
11427
|
-
* Username
|
|
11428
|
-
* @description The user's unique username
|
|
11429
|
-
*/
|
|
11430
|
-
username: string;
|
|
11431
|
-
};
|
|
11432
11448
|
/** ValidationError */
|
|
11433
11449
|
ValidationError: {
|
|
11434
11450
|
/** Context */
|
|
@@ -20441,13 +20457,20 @@ export interface operations {
|
|
|
20441
20457
|
"application/problem+json": components["schemas"]["Problem"];
|
|
20442
20458
|
};
|
|
20443
20459
|
};
|
|
20444
|
-
/** @description
|
|
20460
|
+
/** @description Unprocessable Content */
|
|
20445
20461
|
422: {
|
|
20446
20462
|
headers: {
|
|
20447
20463
|
[name: string]: unknown;
|
|
20448
20464
|
};
|
|
20449
20465
|
content: {
|
|
20450
|
-
|
|
20466
|
+
/** @example {
|
|
20467
|
+
* "code": "ERROR_INDEPENDENT_BILLING_NOT_ALLOWED",
|
|
20468
|
+
* "detail": "Independent billing mode is only allowed for sub-organizations of a billing organization.",
|
|
20469
|
+
* "status": 422,
|
|
20470
|
+
* "title": "Organization Management Error",
|
|
20471
|
+
* "type": "independent-billing-not-allowed"
|
|
20472
|
+
* } */
|
|
20473
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
20451
20474
|
};
|
|
20452
20475
|
};
|
|
20453
20476
|
};
|
|
@@ -23126,7 +23149,7 @@ export interface operations {
|
|
|
23126
23149
|
[name: string]: unknown;
|
|
23127
23150
|
};
|
|
23128
23151
|
content: {
|
|
23129
|
-
"application/json": components["schemas"]["
|
|
23152
|
+
"application/json": components["schemas"]["UserProfile"];
|
|
23130
23153
|
};
|
|
23131
23154
|
};
|
|
23132
23155
|
/** @description Validation Error */
|