@opusdns/api 1.45.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 +42 -31
- package/src/helpers/responses.d.ts +2 -2
- package/src/helpers/schemas.d.ts +2 -1
- package/src/openapi.yaml +129 -105
- package/src/schema.d.ts +94 -83
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,
|
|
@@ -5066,6 +5067,46 @@ export const KEYS_USER_CREATE = [
|
|
|
5066
5067
|
KEY_USER_CREATE_USERNAME,
|
|
5067
5068
|
] as const satisfies (keyof UserCreate)[];
|
|
5068
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
|
+
|
|
5069
5110
|
export const KEY_USER_PUBLIC_CREATED_ON = 'created_on' satisfies keyof UserPublic;
|
|
5070
5111
|
export const KEY_USER_PUBLIC_EMAIL = 'email' satisfies keyof UserPublic;
|
|
5071
5112
|
export const KEY_USER_PUBLIC_FIRST_NAME = 'first_name' satisfies keyof UserPublic;
|
|
@@ -5174,36 +5215,6 @@ export const KEYS_USER_UPDATE = [
|
|
|
5174
5215
|
KEY_USER_UPDATE_USERNAME,
|
|
5175
5216
|
] as const satisfies (keyof UserUpdate)[];
|
|
5176
5217
|
|
|
5177
|
-
export const KEY_USER_WITH_AUTHORIZATION_CREATED_ON = 'created_on' satisfies keyof UserWithAuthorization;
|
|
5178
|
-
export const KEY_USER_WITH_AUTHORIZATION_EMAIL = 'email' satisfies keyof UserWithAuthorization;
|
|
5179
|
-
export const KEY_USER_WITH_AUTHORIZATION_FIRST_NAME = 'first_name' satisfies keyof UserWithAuthorization;
|
|
5180
|
-
export const KEY_USER_WITH_AUTHORIZATION_LAST_NAME = 'last_name' satisfies keyof UserWithAuthorization;
|
|
5181
|
-
export const KEY_USER_WITH_AUTHORIZATION_LOCALE = 'locale' satisfies keyof UserWithAuthorization;
|
|
5182
|
-
export const KEY_USER_WITH_AUTHORIZATION_ORGANIZATION_ID = 'organization_id' satisfies keyof UserWithAuthorization;
|
|
5183
|
-
export const KEY_USER_WITH_AUTHORIZATION_PERMISSIONS = 'permissions' satisfies keyof UserWithAuthorization;
|
|
5184
|
-
export const KEY_USER_WITH_AUTHORIZATION_PHONE = 'phone' satisfies keyof UserWithAuthorization;
|
|
5185
|
-
export const KEY_USER_WITH_AUTHORIZATION_ROLE = 'role' satisfies keyof UserWithAuthorization;
|
|
5186
|
-
export const KEY_USER_WITH_AUTHORIZATION_UPDATED_ON = 'updated_on' satisfies keyof UserWithAuthorization;
|
|
5187
|
-
export const KEY_USER_WITH_AUTHORIZATION_USER_ATTRIBUTES = 'user_attributes' satisfies keyof UserWithAuthorization;
|
|
5188
|
-
export const KEY_USER_WITH_AUTHORIZATION_USER_ID = 'user_id' satisfies keyof UserWithAuthorization;
|
|
5189
|
-
export const KEY_USER_WITH_AUTHORIZATION_USERNAME = 'username' satisfies keyof UserWithAuthorization;
|
|
5190
|
-
|
|
5191
|
-
export const KEYS_USER_WITH_AUTHORIZATION = [
|
|
5192
|
-
KEY_USER_WITH_AUTHORIZATION_CREATED_ON,
|
|
5193
|
-
KEY_USER_WITH_AUTHORIZATION_EMAIL,
|
|
5194
|
-
KEY_USER_WITH_AUTHORIZATION_FIRST_NAME,
|
|
5195
|
-
KEY_USER_WITH_AUTHORIZATION_LAST_NAME,
|
|
5196
|
-
KEY_USER_WITH_AUTHORIZATION_LOCALE,
|
|
5197
|
-
KEY_USER_WITH_AUTHORIZATION_ORGANIZATION_ID,
|
|
5198
|
-
KEY_USER_WITH_AUTHORIZATION_PERMISSIONS,
|
|
5199
|
-
KEY_USER_WITH_AUTHORIZATION_PHONE,
|
|
5200
|
-
KEY_USER_WITH_AUTHORIZATION_ROLE,
|
|
5201
|
-
KEY_USER_WITH_AUTHORIZATION_UPDATED_ON,
|
|
5202
|
-
KEY_USER_WITH_AUTHORIZATION_USER_ATTRIBUTES,
|
|
5203
|
-
KEY_USER_WITH_AUTHORIZATION_USER_ID,
|
|
5204
|
-
KEY_USER_WITH_AUTHORIZATION_USERNAME,
|
|
5205
|
-
] as const satisfies (keyof UserWithAuthorization)[];
|
|
5206
|
-
|
|
5207
5218
|
export const KEY_VALIDATION_ERROR_CTX = 'ctx' satisfies keyof ValidationError;
|
|
5208
5219
|
export const KEY_VALIDATION_ERROR_INPUT = 'input' satisfies keyof ValidationError;
|
|
5209
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;
|
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
|
@@ -12659,6 +12659,133 @@ components:
|
|
|
12659
12659
|
- locale
|
|
12660
12660
|
title: UserCreate
|
|
12661
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
|
|
12662
12789
|
UserPublic:
|
|
12663
12790
|
properties:
|
|
12664
12791
|
created_on:
|
|
@@ -13007,109 +13134,6 @@ components:
|
|
|
13007
13134
|
title: Username
|
|
13008
13135
|
title: UserUpdate
|
|
13009
13136
|
type: object
|
|
13010
|
-
UserWithAuthorization:
|
|
13011
|
-
properties:
|
|
13012
|
-
created_on:
|
|
13013
|
-
description: The date/time the entry was created on
|
|
13014
|
-
format: date-time
|
|
13015
|
-
title: Created On
|
|
13016
|
-
type: string
|
|
13017
|
-
email:
|
|
13018
|
-
description: The user's email address
|
|
13019
|
-
format: email
|
|
13020
|
-
title: Email
|
|
13021
|
-
type: string
|
|
13022
|
-
first_name:
|
|
13023
|
-
description: The user's first name
|
|
13024
|
-
maxLength: 255
|
|
13025
|
-
minLength: 1
|
|
13026
|
-
title: First Name
|
|
13027
|
-
type: string
|
|
13028
|
-
last_name:
|
|
13029
|
-
description: The user's last name
|
|
13030
|
-
maxLength: 255
|
|
13031
|
-
minLength: 1
|
|
13032
|
-
title: Last Name
|
|
13033
|
-
type: string
|
|
13034
|
-
locale:
|
|
13035
|
-
examples:
|
|
13036
|
-
- en_US
|
|
13037
|
-
title: Locale
|
|
13038
|
-
type: string
|
|
13039
|
-
organization_id:
|
|
13040
|
-
default: None
|
|
13041
|
-
description: The user's organization id
|
|
13042
|
-
examples:
|
|
13043
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
13044
|
-
format: typeid
|
|
13045
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
13046
|
-
title: Organization Id
|
|
13047
|
-
type: string
|
|
13048
|
-
x-typeid-prefix: organization
|
|
13049
|
-
permissions:
|
|
13050
|
-
anyOf:
|
|
13051
|
-
- items:
|
|
13052
|
-
$ref: '#/components/schemas/PublicPermission'
|
|
13053
|
-
type: array
|
|
13054
|
-
- type: 'null'
|
|
13055
|
-
title: Permissions
|
|
13056
|
-
phone:
|
|
13057
|
-
anyOf:
|
|
13058
|
-
- format: phone
|
|
13059
|
-
type: string
|
|
13060
|
-
- type: 'null'
|
|
13061
|
-
description: The user's phone number
|
|
13062
|
-
examples:
|
|
13063
|
-
- '+1.2125552368'
|
|
13064
|
-
title: Phone
|
|
13065
|
-
role:
|
|
13066
|
-
anyOf:
|
|
13067
|
-
- $ref: '#/components/schemas/PublicRole'
|
|
13068
|
-
- $ref: '#/components/schemas/CustomRoleLabel'
|
|
13069
|
-
- type: 'null'
|
|
13070
|
-
title: Role
|
|
13071
|
-
updated_on:
|
|
13072
|
-
description: The date/time the entry was last updated on
|
|
13073
|
-
format: date-time
|
|
13074
|
-
title: Updated On
|
|
13075
|
-
type: string
|
|
13076
|
-
user_attributes:
|
|
13077
|
-
additionalProperties:
|
|
13078
|
-
$ref: '#/components/schemas/JsonValue'
|
|
13079
|
-
description: All of the user attributes
|
|
13080
|
-
examples:
|
|
13081
|
-
- array:
|
|
13082
|
-
- 1
|
|
13083
|
-
- 2
|
|
13084
|
-
- 3
|
|
13085
|
-
bool: true
|
|
13086
|
-
number: 1
|
|
13087
|
-
string: value2
|
|
13088
|
-
title: User Attributes
|
|
13089
|
-
type: object
|
|
13090
|
-
user_id:
|
|
13091
|
-
examples:
|
|
13092
|
-
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
13093
|
-
format: typeid
|
|
13094
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
13095
|
-
title: User Id
|
|
13096
|
-
type: string
|
|
13097
|
-
x-typeid-prefix: user
|
|
13098
|
-
username:
|
|
13099
|
-
description: The user's unique username
|
|
13100
|
-
maxLength: 128
|
|
13101
|
-
minLength: 3
|
|
13102
|
-
pattern: ^[a-zA-Z0-9\-+_@.]+$
|
|
13103
|
-
title: Username
|
|
13104
|
-
type: string
|
|
13105
|
-
required:
|
|
13106
|
-
- username
|
|
13107
|
-
- first_name
|
|
13108
|
-
- last_name
|
|
13109
|
-
- email
|
|
13110
|
-
- locale
|
|
13111
|
-
title: UserWithAuthorization
|
|
13112
|
-
type: object
|
|
13113
13137
|
ValidationError:
|
|
13114
13138
|
properties:
|
|
13115
13139
|
ctx:
|
|
@@ -13828,7 +13852,7 @@ info:
|
|
|
13828
13852
|
\n\n"
|
|
13829
13853
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
13830
13854
|
title: OpusDNS API
|
|
13831
|
-
version: 2026-06-
|
|
13855
|
+
version: 2026-07-06-082943
|
|
13832
13856
|
x-logo:
|
|
13833
13857
|
altText: OpusDNS API Reference
|
|
13834
13858
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -28693,7 +28717,7 @@ paths:
|
|
|
28693
28717
|
content:
|
|
28694
28718
|
application/json:
|
|
28695
28719
|
schema:
|
|
28696
|
-
$ref: '#/components/schemas/
|
|
28720
|
+
$ref: '#/components/schemas/UserProfile'
|
|
28697
28721
|
description: Successful Response
|
|
28698
28722
|
'422':
|
|
28699
28723
|
content:
|
package/src/schema.d.ts
CHANGED
|
@@ -11078,6 +11078,99 @@ export interface components {
|
|
|
11078
11078
|
*/
|
|
11079
11079
|
username: string;
|
|
11080
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
|
+
};
|
|
11081
11174
|
/** UserPublic */
|
|
11082
11175
|
UserPublic: {
|
|
11083
11176
|
/**
|
|
@@ -11352,88 +11445,6 @@ export interface components {
|
|
|
11352
11445
|
*/
|
|
11353
11446
|
username?: string | null;
|
|
11354
11447
|
};
|
|
11355
|
-
/** UserWithAuthorization */
|
|
11356
|
-
UserWithAuthorization: {
|
|
11357
|
-
/**
|
|
11358
|
-
* Created On
|
|
11359
|
-
* Format: date-time
|
|
11360
|
-
* @description The date/time the entry was created on
|
|
11361
|
-
*/
|
|
11362
|
-
created_on?: Date;
|
|
11363
|
-
/**
|
|
11364
|
-
* Email
|
|
11365
|
-
* Format: email
|
|
11366
|
-
* @description The user's email address
|
|
11367
|
-
*/
|
|
11368
|
-
email: string;
|
|
11369
|
-
/**
|
|
11370
|
-
* First Name
|
|
11371
|
-
* @description The user's first name
|
|
11372
|
-
*/
|
|
11373
|
-
first_name: string;
|
|
11374
|
-
/**
|
|
11375
|
-
* Last Name
|
|
11376
|
-
* @description The user's last name
|
|
11377
|
-
*/
|
|
11378
|
-
last_name: string;
|
|
11379
|
-
/**
|
|
11380
|
-
* Locale
|
|
11381
|
-
* @example en_US
|
|
11382
|
-
*/
|
|
11383
|
-
locale: string;
|
|
11384
|
-
/**
|
|
11385
|
-
* Organization Id
|
|
11386
|
-
* Format: typeid
|
|
11387
|
-
* @description The user's organization id
|
|
11388
|
-
* @default None
|
|
11389
|
-
* @example organization_01h45ytscbebyvny4gc8cr8ma2
|
|
11390
|
-
*/
|
|
11391
|
-
organization_id: TypeId<"organization">;
|
|
11392
|
-
/** Permissions */
|
|
11393
|
-
permissions?: components["schemas"]["PublicPermission"][] | null;
|
|
11394
|
-
/**
|
|
11395
|
-
* Phone
|
|
11396
|
-
* @description The user's phone number
|
|
11397
|
-
* @example +1.2125552368
|
|
11398
|
-
*/
|
|
11399
|
-
phone?: string | null;
|
|
11400
|
-
/** Role */
|
|
11401
|
-
role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
|
|
11402
|
-
/**
|
|
11403
|
-
* Updated On
|
|
11404
|
-
* Format: date-time
|
|
11405
|
-
* @description The date/time the entry was last updated on
|
|
11406
|
-
*/
|
|
11407
|
-
updated_on?: Date;
|
|
11408
|
-
/**
|
|
11409
|
-
* User Attributes
|
|
11410
|
-
* @description All of the user attributes
|
|
11411
|
-
* @example {
|
|
11412
|
-
* "array": [
|
|
11413
|
-
* 1,
|
|
11414
|
-
* 2,
|
|
11415
|
-
* 3
|
|
11416
|
-
* ],
|
|
11417
|
-
* "bool": true,
|
|
11418
|
-
* "number": 1,
|
|
11419
|
-
* "string": "value2"
|
|
11420
|
-
* }
|
|
11421
|
-
*/
|
|
11422
|
-
user_attributes?: {
|
|
11423
|
-
[key: string]: components["schemas"]["JsonValue"];
|
|
11424
|
-
};
|
|
11425
|
-
/**
|
|
11426
|
-
* User Id
|
|
11427
|
-
* Format: typeid
|
|
11428
|
-
* @example user_01h45ytscbebyvny4gc8cr8ma2
|
|
11429
|
-
*/
|
|
11430
|
-
user_id?: TypeId<"user">;
|
|
11431
|
-
/**
|
|
11432
|
-
* Username
|
|
11433
|
-
* @description The user's unique username
|
|
11434
|
-
*/
|
|
11435
|
-
username: string;
|
|
11436
|
-
};
|
|
11437
11448
|
/** ValidationError */
|
|
11438
11449
|
ValidationError: {
|
|
11439
11450
|
/** Context */
|
|
@@ -23138,7 +23149,7 @@ export interface operations {
|
|
|
23138
23149
|
[name: string]: unknown;
|
|
23139
23150
|
};
|
|
23140
23151
|
content: {
|
|
23141
|
-
"application/json": components["schemas"]["
|
|
23152
|
+
"application/json": components["schemas"]["UserProfile"];
|
|
23142
23153
|
};
|
|
23143
23154
|
};
|
|
23144
23155
|
/** @description Validation Error */
|