@opusdns/api 0.137.0 → 0.139.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/constants.ts +38 -2
- package/src/helpers/keys.ts +632 -263
- package/src/helpers/responses.d.ts +9 -9
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +38 -22
- package/src/openapi.yaml +179 -70
- package/src/schema.d.ts +113 -41
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction,
|
|
37
|
+
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
|
|
@@ -8135,9 +8135,9 @@ export type GET_OrganizationsUsers_Response = GET_OrganizationsUsers_Response_20
|
|
|
8135
8135
|
* @path /v1/organizations/users
|
|
8136
8136
|
*
|
|
8137
8137
|
* @see {@link GET_OrganizationsUsers_Response} - The main response type definition
|
|
8138
|
-
* @see {@link
|
|
8138
|
+
* @see {@link Pagination_UserPublic} - The actual schema type definition
|
|
8139
8139
|
*/
|
|
8140
|
-
export type GET_OrganizationsUsers_Response_200 =
|
|
8140
|
+
export type GET_OrganizationsUsers_Response_200 = Pagination_UserPublic
|
|
8141
8141
|
|
|
8142
8142
|
/**
|
|
8143
8143
|
* 401 response for GET OrganizationsUsers endpoint
|
|
@@ -8393,9 +8393,9 @@ export type POST_Users_Response = POST_Users_Response_200 | POST_Users_Response_
|
|
|
8393
8393
|
* @path /v1/users
|
|
8394
8394
|
*
|
|
8395
8395
|
* @see {@link POST_Users_Response} - The main response type definition
|
|
8396
|
-
* @see {@link
|
|
8396
|
+
* @see {@link UserPublic} - The actual schema type definition
|
|
8397
8397
|
*/
|
|
8398
|
-
export type POST_Users_Response_200 =
|
|
8398
|
+
export type POST_Users_Response_200 = UserPublic
|
|
8399
8399
|
|
|
8400
8400
|
/**
|
|
8401
8401
|
* 422 response for POST Users endpoint
|
|
@@ -8505,9 +8505,9 @@ export type GET_UsersByUserId_Response = GET_UsersByUserId_Response_200 | GET_Us
|
|
|
8505
8505
|
* @path /v1/users/{user_id}
|
|
8506
8506
|
*
|
|
8507
8507
|
* @see {@link GET_UsersByUserId_Response} - The main response type definition
|
|
8508
|
-
* @see {@link
|
|
8508
|
+
* @see {@link UserPublicWithAttributes} - The actual schema type definition
|
|
8509
8509
|
*/
|
|
8510
|
-
export type GET_UsersByUserId_Response_200 =
|
|
8510
|
+
export type GET_UsersByUserId_Response_200 = UserPublicWithAttributes
|
|
8511
8511
|
|
|
8512
8512
|
/**
|
|
8513
8513
|
* 422 response for GET UsersByUserId endpoint
|
|
@@ -8561,9 +8561,9 @@ export type PATCH_UsersByUserId_Response = PATCH_UsersByUserId_Response_200 | PA
|
|
|
8561
8561
|
* @path /v1/users/{user_id}
|
|
8562
8562
|
*
|
|
8563
8563
|
* @see {@link PATCH_UsersByUserId_Response} - The main response type definition
|
|
8564
|
-
* @see {@link
|
|
8564
|
+
* @see {@link UserPublicWithAttributes} - The actual schema type definition
|
|
8565
8565
|
*/
|
|
8566
|
-
export type PATCH_UsersByUserId_Response_200 =
|
|
8566
|
+
export type PATCH_UsersByUserId_Response_200 = UserPublicWithAttributes
|
|
8567
8567
|
|
|
8568
8568
|
/**
|
|
8569
8569
|
* 422 response for PATCH UsersByUserId endpoint
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -807,6 +807,20 @@ export type OrganizationArray = Organization[];
|
|
|
807
807
|
* @see {@link RequestHistory} - The individual RequestHistory type definition
|
|
808
808
|
*/
|
|
809
809
|
export type RequestHistoryArray = RequestHistory[];
|
|
810
|
+
/**
|
|
811
|
+
* UserPublic
|
|
812
|
+
*
|
|
813
|
+
* @remarks
|
|
814
|
+
* Array type for UserPublic objects. Used when the API returns a collection of UserPublic instances.
|
|
815
|
+
*
|
|
816
|
+
* @example
|
|
817
|
+
* ```typescript
|
|
818
|
+
* const items: UserPublicArray = await api.getUserPublics();
|
|
819
|
+
* ```
|
|
820
|
+
*
|
|
821
|
+
* @see {@link UserPublic} - The individual UserPublic type definition
|
|
822
|
+
*/
|
|
823
|
+
export type UserPublicArray = UserPublic[];
|
|
810
824
|
/**
|
|
811
825
|
* Period
|
|
812
826
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -2816,21 +2816,21 @@ export type Pagination_Organization = components['schemas']['Pagination_Organiza
|
|
|
2816
2816
|
*/
|
|
2817
2817
|
export type Pagination_RequestHistory = components['schemas']['Pagination_RequestHistory_'];
|
|
2818
2818
|
/**
|
|
2819
|
-
* Pagination[
|
|
2819
|
+
* Pagination[UserPublic]
|
|
2820
2820
|
*
|
|
2821
2821
|
* @remarks
|
|
2822
|
-
* Type alias for the `
|
|
2823
|
-
* This type represents pagination[
|
|
2822
|
+
* Type alias for the `Pagination_UserPublic_` OpenAPI schema.
|
|
2823
|
+
* This type represents pagination[userpublic] data structures used in API requests and responses.
|
|
2824
2824
|
*
|
|
2825
2825
|
* @example
|
|
2826
2826
|
* ```typescript
|
|
2827
|
-
* const response = await api.
|
|
2828
|
-
* const item:
|
|
2827
|
+
* const response = await api.getPagination_UserPublic();
|
|
2828
|
+
* const item: Pagination_UserPublic = response.results;
|
|
2829
2829
|
* ```
|
|
2830
2830
|
*
|
|
2831
2831
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2832
2832
|
*/
|
|
2833
|
-
export type
|
|
2833
|
+
export type Pagination_UserPublic = components['schemas']['Pagination_UserPublic_'];
|
|
2834
2834
|
/**
|
|
2835
2835
|
* PasswordUpdate
|
|
2836
2836
|
*
|
|
@@ -3583,6 +3583,38 @@ export type UserAttribute = components['schemas']['UserAttributeResponse'];
|
|
|
3583
3583
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3584
3584
|
*/
|
|
3585
3585
|
export type UserCreate = components['schemas']['UserCreate'];
|
|
3586
|
+
/**
|
|
3587
|
+
* UserPublic
|
|
3588
|
+
*
|
|
3589
|
+
* @remarks
|
|
3590
|
+
* Type alias for the `UserPublic` OpenAPI schema.
|
|
3591
|
+
* This type represents userpublic data structures used in API requests and responses.
|
|
3592
|
+
*
|
|
3593
|
+
* @example
|
|
3594
|
+
* ```typescript
|
|
3595
|
+
* const response = await api.getUserPublic();
|
|
3596
|
+
* const item: UserPublic = response.results;
|
|
3597
|
+
* ```
|
|
3598
|
+
*
|
|
3599
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3600
|
+
*/
|
|
3601
|
+
export type UserPublic = components['schemas']['UserPublic'];
|
|
3602
|
+
/**
|
|
3603
|
+
* UserPublicWithAttributes
|
|
3604
|
+
*
|
|
3605
|
+
* @remarks
|
|
3606
|
+
* Type alias for the `UserPublicWithAttributes` OpenAPI schema.
|
|
3607
|
+
* This type represents userpublicwithattributes data structures used in API requests and responses.
|
|
3608
|
+
*
|
|
3609
|
+
* @example
|
|
3610
|
+
* ```typescript
|
|
3611
|
+
* const response = await api.getUserPublicWithAttributes();
|
|
3612
|
+
* const item: UserPublicWithAttributes = response.results;
|
|
3613
|
+
* ```
|
|
3614
|
+
*
|
|
3615
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3616
|
+
*/
|
|
3617
|
+
export type UserPublicWithAttributes = components['schemas']['UserPublicWithAttributes'];
|
|
3586
3618
|
/**
|
|
3587
3619
|
* UserStatus
|
|
3588
3620
|
*
|
|
@@ -3631,22 +3663,6 @@ export type UserToken = components['schemas']['UserTokenResponse'];
|
|
|
3631
3663
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3632
3664
|
*/
|
|
3633
3665
|
export type UserUpdate = components['schemas']['UserUpdate'];
|
|
3634
|
-
/**
|
|
3635
|
-
* UserWithAttributes
|
|
3636
|
-
*
|
|
3637
|
-
* @remarks
|
|
3638
|
-
* Type alias for the `UserWithAttributes` OpenAPI schema.
|
|
3639
|
-
* This type represents userwithattributes data structures used in API requests and responses.
|
|
3640
|
-
*
|
|
3641
|
-
* @example
|
|
3642
|
-
* ```typescript
|
|
3643
|
-
* const response = await api.getUserWithAttributes();
|
|
3644
|
-
* const item: UserWithAttributes = response.results;
|
|
3645
|
-
* ```
|
|
3646
|
-
*
|
|
3647
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
3648
|
-
*/
|
|
3649
|
-
export type UserWithAttributes = components['schemas']['UserWithAttributes'];
|
|
3650
3666
|
/**
|
|
3651
3667
|
* UserWithRelationPermissions
|
|
3652
3668
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -29,6 +29,7 @@ components:
|
|
|
29
29
|
- string
|
|
30
30
|
- boolean
|
|
31
31
|
- datetime
|
|
32
|
+
- integer
|
|
32
33
|
title: AttributeType
|
|
33
34
|
type: string
|
|
34
35
|
BillingMetadata:
|
|
@@ -4568,19 +4569,19 @@ components:
|
|
|
4568
4569
|
- pagination
|
|
4569
4570
|
title: Pagination[RequestHistory]
|
|
4570
4571
|
type: object
|
|
4571
|
-
|
|
4572
|
+
Pagination_UserPublic_:
|
|
4572
4573
|
properties:
|
|
4573
4574
|
pagination:
|
|
4574
4575
|
$ref: '#/components/schemas/PaginationMetadata'
|
|
4575
4576
|
results:
|
|
4576
4577
|
items:
|
|
4577
|
-
$ref: '#/components/schemas/
|
|
4578
|
+
$ref: '#/components/schemas/UserPublic'
|
|
4578
4579
|
title: Results
|
|
4579
4580
|
type: array
|
|
4580
4581
|
required:
|
|
4581
4582
|
- results
|
|
4582
4583
|
- pagination
|
|
4583
|
-
title: Pagination[
|
|
4584
|
+
title: Pagination[UserPublic]
|
|
4584
4585
|
type: object
|
|
4585
4586
|
PasswordUpdate:
|
|
4586
4587
|
properties:
|
|
@@ -4858,6 +4859,23 @@ components:
|
|
|
4858
4859
|
- DE_CONTACT_TYPE
|
|
4859
4860
|
- dnsbe:type
|
|
4860
4861
|
- eurid:type
|
|
4862
|
+
- AFNIC_CONTACT_TYPE
|
|
4863
|
+
- AFNIC_PP_FIRST_NAME
|
|
4864
|
+
- AFNIC_PM_LEGAL_STATUS
|
|
4865
|
+
- AFNIC_PM_SIREN
|
|
4866
|
+
- AFNIC_PM_VAT
|
|
4867
|
+
- AFNIC_PM_TRADEMARK
|
|
4868
|
+
- AFNIC_PM_ASSOC_WALDEC
|
|
4869
|
+
- AFNIC_PM_ASSOC_PUBL_DATE
|
|
4870
|
+
- AFNIC_PM_ASSOC_PUBL_ANNOUNCE
|
|
4871
|
+
- AFNIC_PM_ASSOC_PUBL_PAGE
|
|
4872
|
+
- AFNIC_PM_ASSOC_DECL
|
|
4873
|
+
- AFNIC_PM_DUNS
|
|
4874
|
+
- AFNIC_PM_LOCAL
|
|
4875
|
+
- AFNIC_ID_STATUS
|
|
4876
|
+
- AFNIC_REACHABLE_MEDIA
|
|
4877
|
+
- AFNIC_REACHABLE_STATUS
|
|
4878
|
+
- AFNIC_RESTRICTED_PUBLICATION
|
|
4861
4879
|
title: RegistryHandleAttributeType
|
|
4862
4880
|
type: string
|
|
4863
4881
|
RegistryLockBase:
|
|
@@ -5454,6 +5472,12 @@ components:
|
|
|
5454
5472
|
minLength: 1
|
|
5455
5473
|
title: First Name
|
|
5456
5474
|
type: string
|
|
5475
|
+
keycloak_user_id:
|
|
5476
|
+
anyOf:
|
|
5477
|
+
- type: string
|
|
5478
|
+
- type: 'null'
|
|
5479
|
+
description: Keycloak user id
|
|
5480
|
+
title: Keycloak User Id
|
|
5457
5481
|
last_name:
|
|
5458
5482
|
description: The user's last name
|
|
5459
5483
|
minLength: 1
|
|
@@ -5608,93 +5632,92 @@ components:
|
|
|
5608
5632
|
- password
|
|
5609
5633
|
title: UserCreate
|
|
5610
5634
|
type: object
|
|
5611
|
-
|
|
5612
|
-
enum:
|
|
5613
|
-
- active
|
|
5614
|
-
- inactive
|
|
5615
|
-
title: UserStatus
|
|
5616
|
-
type: string
|
|
5617
|
-
UserTokenResponse:
|
|
5635
|
+
UserPublic:
|
|
5618
5636
|
properties:
|
|
5619
|
-
|
|
5620
|
-
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
title: Expires In
|
|
5624
|
-
type: integer
|
|
5625
|
-
refresh_expires_in:
|
|
5626
|
-
title: Refresh Expires In
|
|
5627
|
-
type: integer
|
|
5628
|
-
refresh_token:
|
|
5629
|
-
title: Refresh Token
|
|
5630
|
-
type: string
|
|
5631
|
-
token_type:
|
|
5632
|
-
default: Bearer
|
|
5633
|
-
title: Token Type
|
|
5637
|
+
created_on:
|
|
5638
|
+
description: The date/time the entry was created on
|
|
5639
|
+
format: date-time
|
|
5640
|
+
title: Created On
|
|
5634
5641
|
type: string
|
|
5635
|
-
|
|
5636
|
-
- access_token
|
|
5637
|
-
- expires_in
|
|
5638
|
-
- refresh_token
|
|
5639
|
-
- refresh_expires_in
|
|
5640
|
-
title: UserTokenResponse
|
|
5641
|
-
type: object
|
|
5642
|
-
UserUpdate:
|
|
5643
|
-
properties:
|
|
5644
|
-
email:
|
|
5642
|
+
deleted_on:
|
|
5645
5643
|
anyOf:
|
|
5646
|
-
- format:
|
|
5644
|
+
- format: date-time
|
|
5647
5645
|
type: string
|
|
5648
5646
|
- type: 'null'
|
|
5647
|
+
description: The date/time the entry was deleted on
|
|
5648
|
+
title: Deleted On
|
|
5649
|
+
email:
|
|
5649
5650
|
description: The user's email address
|
|
5651
|
+
format: email
|
|
5650
5652
|
title: Email
|
|
5653
|
+
type: string
|
|
5651
5654
|
first_name:
|
|
5652
|
-
anyOf:
|
|
5653
|
-
- minLength: 1
|
|
5654
|
-
type: string
|
|
5655
|
-
- type: 'null'
|
|
5656
5655
|
description: The user's first name
|
|
5656
|
+
minLength: 1
|
|
5657
5657
|
title: First Name
|
|
5658
|
+
type: string
|
|
5658
5659
|
last_name:
|
|
5659
|
-
anyOf:
|
|
5660
|
-
- minLength: 1
|
|
5661
|
-
type: string
|
|
5662
|
-
- type: 'null'
|
|
5663
5660
|
description: The user's last name
|
|
5661
|
+
minLength: 1
|
|
5664
5662
|
title: Last Name
|
|
5663
|
+
type: string
|
|
5665
5664
|
locale:
|
|
5666
|
-
|
|
5667
|
-
-
|
|
5668
|
-
- en_US
|
|
5669
|
-
type: string
|
|
5670
|
-
- type: 'null'
|
|
5671
|
-
description: The user's locale
|
|
5665
|
+
examples:
|
|
5666
|
+
- en_US
|
|
5672
5667
|
title: Locale
|
|
5668
|
+
type: string
|
|
5669
|
+
organization_id:
|
|
5670
|
+
default: None
|
|
5671
|
+
description: The user's organization id
|
|
5672
|
+
examples:
|
|
5673
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
5674
|
+
format: typeid
|
|
5675
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5676
|
+
title: Organization Id
|
|
5677
|
+
type: string
|
|
5678
|
+
x-typeid-prefix: organization
|
|
5673
5679
|
phone:
|
|
5674
5680
|
anyOf:
|
|
5675
5681
|
- format: phone
|
|
5676
5682
|
type: string
|
|
5677
5683
|
- type: 'null'
|
|
5678
5684
|
description: The user's phone number
|
|
5685
|
+
examples:
|
|
5686
|
+
- '+1.2125552368'
|
|
5679
5687
|
title: Phone
|
|
5680
|
-
|
|
5681
|
-
|
|
5682
|
-
|
|
5683
|
-
|
|
5684
|
-
|
|
5685
|
-
|
|
5686
|
-
|
|
5687
|
-
|
|
5688
|
+
status:
|
|
5689
|
+
$ref: '#/components/schemas/UserStatus'
|
|
5690
|
+
readOnly: true
|
|
5691
|
+
updated_on:
|
|
5692
|
+
description: The date/time the entry was last updated on
|
|
5693
|
+
format: date-time
|
|
5694
|
+
title: Updated On
|
|
5695
|
+
type: string
|
|
5696
|
+
user_id:
|
|
5697
|
+
examples:
|
|
5698
|
+
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
5699
|
+
format: typeid
|
|
5700
|
+
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5701
|
+
title: User Id
|
|
5702
|
+
type: string
|
|
5703
|
+
x-typeid-prefix: user
|
|
5688
5704
|
username:
|
|
5689
|
-
anyOf:
|
|
5690
|
-
- minLength: 1
|
|
5691
|
-
type: string
|
|
5692
|
-
- type: 'null'
|
|
5693
5705
|
description: The user's unique username
|
|
5706
|
+
maxLength: 128
|
|
5707
|
+
minLength: 3
|
|
5708
|
+
pattern: ^[a-zA-Z0-9\-+_@.]+$
|
|
5694
5709
|
title: Username
|
|
5695
|
-
|
|
5710
|
+
type: string
|
|
5711
|
+
required:
|
|
5712
|
+
- username
|
|
5713
|
+
- first_name
|
|
5714
|
+
- last_name
|
|
5715
|
+
- email
|
|
5716
|
+
- locale
|
|
5717
|
+
- status
|
|
5718
|
+
title: UserPublic
|
|
5696
5719
|
type: object
|
|
5697
|
-
|
|
5720
|
+
UserPublicWithAttributes:
|
|
5698
5721
|
properties:
|
|
5699
5722
|
created_on:
|
|
5700
5723
|
description: The date/time the entry was created on
|
|
@@ -5791,7 +5814,93 @@ components:
|
|
|
5791
5814
|
- email
|
|
5792
5815
|
- locale
|
|
5793
5816
|
- status
|
|
5794
|
-
title:
|
|
5817
|
+
title: UserPublicWithAttributes
|
|
5818
|
+
type: object
|
|
5819
|
+
UserStatus:
|
|
5820
|
+
enum:
|
|
5821
|
+
- active
|
|
5822
|
+
- inactive
|
|
5823
|
+
title: UserStatus
|
|
5824
|
+
type: string
|
|
5825
|
+
UserTokenResponse:
|
|
5826
|
+
properties:
|
|
5827
|
+
access_token:
|
|
5828
|
+
title: Access Token
|
|
5829
|
+
type: string
|
|
5830
|
+
expires_in:
|
|
5831
|
+
title: Expires In
|
|
5832
|
+
type: integer
|
|
5833
|
+
refresh_expires_in:
|
|
5834
|
+
title: Refresh Expires In
|
|
5835
|
+
type: integer
|
|
5836
|
+
refresh_token:
|
|
5837
|
+
title: Refresh Token
|
|
5838
|
+
type: string
|
|
5839
|
+
token_type:
|
|
5840
|
+
default: Bearer
|
|
5841
|
+
title: Token Type
|
|
5842
|
+
type: string
|
|
5843
|
+
required:
|
|
5844
|
+
- access_token
|
|
5845
|
+
- expires_in
|
|
5846
|
+
- refresh_token
|
|
5847
|
+
- refresh_expires_in
|
|
5848
|
+
title: UserTokenResponse
|
|
5849
|
+
type: object
|
|
5850
|
+
UserUpdate:
|
|
5851
|
+
properties:
|
|
5852
|
+
email:
|
|
5853
|
+
anyOf:
|
|
5854
|
+
- format: email
|
|
5855
|
+
type: string
|
|
5856
|
+
- type: 'null'
|
|
5857
|
+
description: The user's email address
|
|
5858
|
+
title: Email
|
|
5859
|
+
first_name:
|
|
5860
|
+
anyOf:
|
|
5861
|
+
- minLength: 1
|
|
5862
|
+
type: string
|
|
5863
|
+
- type: 'null'
|
|
5864
|
+
description: The user's first name
|
|
5865
|
+
title: First Name
|
|
5866
|
+
last_name:
|
|
5867
|
+
anyOf:
|
|
5868
|
+
- minLength: 1
|
|
5869
|
+
type: string
|
|
5870
|
+
- type: 'null'
|
|
5871
|
+
description: The user's last name
|
|
5872
|
+
title: Last Name
|
|
5873
|
+
locale:
|
|
5874
|
+
anyOf:
|
|
5875
|
+
- examples:
|
|
5876
|
+
- en_US
|
|
5877
|
+
type: string
|
|
5878
|
+
- type: 'null'
|
|
5879
|
+
description: The user's locale
|
|
5880
|
+
title: Locale
|
|
5881
|
+
phone:
|
|
5882
|
+
anyOf:
|
|
5883
|
+
- format: phone
|
|
5884
|
+
type: string
|
|
5885
|
+
- type: 'null'
|
|
5886
|
+
description: The user's phone number
|
|
5887
|
+
title: Phone
|
|
5888
|
+
user_attributes:
|
|
5889
|
+
anyOf:
|
|
5890
|
+
- items:
|
|
5891
|
+
$ref: '#/components/schemas/UserAttributeBase'
|
|
5892
|
+
type: array
|
|
5893
|
+
- type: 'null'
|
|
5894
|
+
description: User attributes
|
|
5895
|
+
title: User Attributes
|
|
5896
|
+
username:
|
|
5897
|
+
anyOf:
|
|
5898
|
+
- minLength: 1
|
|
5899
|
+
type: string
|
|
5900
|
+
- type: 'null'
|
|
5901
|
+
description: The user's unique username
|
|
5902
|
+
title: Username
|
|
5903
|
+
title: UserUpdate
|
|
5795
5904
|
type: object
|
|
5796
5905
|
UserWithRelationPermissions:
|
|
5797
5906
|
properties:
|
|
@@ -6144,7 +6253,7 @@ info:
|
|
|
6144
6253
|
'
|
|
6145
6254
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
6146
6255
|
title: OpusDNS API
|
|
6147
|
-
version: 2025-12-
|
|
6256
|
+
version: 2025-12-30-205837
|
|
6148
6257
|
x-logo:
|
|
6149
6258
|
altText: OpusDNS API Reference
|
|
6150
6259
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -12944,7 +13053,7 @@ paths:
|
|
|
12944
13053
|
content:
|
|
12945
13054
|
application/json:
|
|
12946
13055
|
schema:
|
|
12947
|
-
$ref: '#/components/schemas/
|
|
13056
|
+
$ref: '#/components/schemas/Pagination_UserPublic_'
|
|
12948
13057
|
description: Successful Response
|
|
12949
13058
|
'401':
|
|
12950
13059
|
content:
|
|
@@ -13637,7 +13746,7 @@ paths:
|
|
|
13637
13746
|
content:
|
|
13638
13747
|
application/json:
|
|
13639
13748
|
schema:
|
|
13640
|
-
$ref: '#/components/schemas/
|
|
13749
|
+
$ref: '#/components/schemas/UserPublic'
|
|
13641
13750
|
description: Successful Response
|
|
13642
13751
|
'422':
|
|
13643
13752
|
content:
|
|
@@ -13790,7 +13899,7 @@ paths:
|
|
|
13790
13899
|
content:
|
|
13791
13900
|
application/json:
|
|
13792
13901
|
schema:
|
|
13793
|
-
$ref: '#/components/schemas/
|
|
13902
|
+
$ref: '#/components/schemas/UserPublicWithAttributes'
|
|
13794
13903
|
description: Successful Response
|
|
13795
13904
|
'422':
|
|
13796
13905
|
content:
|
|
@@ -13829,7 +13938,7 @@ paths:
|
|
|
13829
13938
|
content:
|
|
13830
13939
|
application/json:
|
|
13831
13940
|
schema:
|
|
13832
|
-
$ref: '#/components/schemas/
|
|
13941
|
+
$ref: '#/components/schemas/UserPublicWithAttributes'
|
|
13833
13942
|
description: Successful Response
|
|
13834
13943
|
'422':
|
|
13835
13944
|
content:
|