@opusdns/api 0.78.0 → 0.79.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/src/schema.d.ts CHANGED
@@ -1,74 +1,5 @@
1
1
  import { TypeId } from "typeid-js";
2
2
  export interface paths {
3
- "/v1/auth/client_credentials": {
4
- parameters: {
5
- query?: never;
6
- header?: never;
7
- path?: never;
8
- cookie?: never;
9
- };
10
- /** List all API keys */
11
- get: operations["list_api_keys_v1_auth_client_credentials_get"];
12
- put?: never;
13
- /** Issue an API key */
14
- post: operations["issue_api_key_v1_auth_client_credentials_post"];
15
- delete?: never;
16
- options?: never;
17
- head?: never;
18
- patch?: never;
19
- trace?: never;
20
- };
21
- "/v1/auth/client_credentials/{api_key_id}": {
22
- parameters: {
23
- query?: never;
24
- header?: never;
25
- path?: never;
26
- cookie?: never;
27
- };
28
- get?: never;
29
- put?: never;
30
- post?: never;
31
- /** Delete an API key */
32
- delete: operations["delete_api_key_v1_auth_client_credentials__api_key_id__delete"];
33
- options?: never;
34
- head?: never;
35
- patch?: never;
36
- trace?: never;
37
- };
38
- "/v1/auth/logout": {
39
- parameters: {
40
- query?: never;
41
- header?: never;
42
- path?: never;
43
- cookie?: never;
44
- };
45
- get?: never;
46
- put?: never;
47
- /** Logout */
48
- post: operations["logout_v1_auth_logout_post"];
49
- delete?: never;
50
- options?: never;
51
- head?: never;
52
- patch?: never;
53
- trace?: never;
54
- };
55
- "/v1/auth/signup": {
56
- parameters: {
57
- query?: never;
58
- header?: never;
59
- path?: never;
60
- cookie?: never;
61
- };
62
- get?: never;
63
- put?: never;
64
- /** Signup */
65
- post: operations["signup_v1_auth_signup_post"];
66
- delete?: never;
67
- options?: never;
68
- head?: never;
69
- patch?: never;
70
- trace?: never;
71
- };
72
3
  "/v1/auth/token": {
73
4
  parameters: {
74
5
  query?: never;
@@ -1300,11 +1231,6 @@ export interface paths {
1300
1231
  export type webhooks = Record<string, never>;
1301
1232
  export interface components {
1302
1233
  schemas: {
1303
- /**
1304
- * AgreementType
1305
- * @enum {string}
1306
- */
1307
- AgreementType: "terms_and_conditions" | "master_service_agreement" | "acting_as_trader";
1308
1234
  /**
1309
1235
  * AllocationMethodType
1310
1236
  * @enum {string}
@@ -1452,31 +1378,6 @@ export interface components {
1452
1378
  * @enum {string}
1453
1379
  */
1454
1380
  BillingTransactionStatus: "pending" | "succeeded" | "failed" | "canceled";
1455
- /** Body_issue_organization_token_v1_auth_token_post */
1456
- Body_issue_organization_token_v1_auth_token_post: {
1457
- /**
1458
- * Client Id
1459
- * @description The organization ID associated with the credentials.
1460
- */
1461
- client_id?: TypeId<"organization"> | null;
1462
- /**
1463
- * Client Secret
1464
- * @description Client secret for authentication.
1465
- */
1466
- client_secret?: string | null;
1467
- /** @description The grant type for the authentication request. */
1468
- grant_type?: components["schemas"]["GrantType"];
1469
- /**
1470
- * Password
1471
- * @description Password for the user.
1472
- */
1473
- password?: string | null;
1474
- /**
1475
- * Username
1476
- * @description Username for authentication.
1477
- */
1478
- username?: string | null;
1479
- };
1480
1381
  /** CheckoutSessionRequest */
1481
1382
  CheckoutSessionRequest: Record<string, never>;
1482
1383
  /** CheckoutSessionResponse */
@@ -3465,120 +3366,6 @@ export interface components {
3465
3366
  */
3466
3367
  users?: components["schemas"]["UserCreate"][];
3467
3368
  };
3468
- /** OrganizationCredential */
3469
- OrganizationCredential: {
3470
- /**
3471
- * Api Key Description
3472
- * @description Description of the organization credential.
3473
- */
3474
- api_key_description?: string | null;
3475
- /**
3476
- * Api Key Id
3477
- * Format: typeid
3478
- * @description Unique identifier of the organization credential.
3479
- */
3480
- api_key_id: TypeId<"api_key">;
3481
- /**
3482
- * Api Key Name
3483
- * @description Name of the organization credential. Only a-z, A-Z, 0-9, underscore, and hyphen are allowed.
3484
- */
3485
- api_key_name?: string | null;
3486
- /**
3487
- * Created On
3488
- * Format: date-time
3489
- * @description The date/time the entry was created on
3490
- */
3491
- created_on?: Date;
3492
- /**
3493
- * Deleted On
3494
- * @description The date/time the entry was deleted on
3495
- */
3496
- deleted_on?: Date | null;
3497
- /**
3498
- * Last Used On
3499
- * @description The date/time the entry was deleted on
3500
- */
3501
- last_used_on?: Date | null;
3502
- /**
3503
- * Organization Id
3504
- * Format: typeid
3505
- * @default None
3506
- */
3507
- organization_id: TypeId<"organization">;
3508
- /** @description The status of the organization credential. */
3509
- readonly status: components["schemas"]["OrganizationCredentialStatus"];
3510
- };
3511
- /** OrganizationCredentialCreated */
3512
- OrganizationCredentialCreated: {
3513
- /**
3514
- * Api Key
3515
- * Format: typeid
3516
- * @description Unique identifier of the organization credential.
3517
- */
3518
- api_key: TypeId<"api_key">;
3519
- /**
3520
- * Api Key Description
3521
- * @description Description of the organization credential.
3522
- */
3523
- api_key_description?: string | null;
3524
- /**
3525
- * Api Key Name
3526
- * @description Name of the organization credential. Only a-z, A-Z, 0-9, underscore, and hyphen are allowed.
3527
- */
3528
- api_key_name?: string | null;
3529
- /**
3530
- * Client Id
3531
- * Format: typeid
3532
- * @default None
3533
- */
3534
- client_id: TypeId<"organization">;
3535
- /**
3536
- * Client Secret
3537
- * @description Plaintext secret to be hashed (not stored directly in the DB).
3538
- */
3539
- client_secret?: string | null;
3540
- /**
3541
- * Created On
3542
- * Format: date-time
3543
- * @description The date/time the entry was created on
3544
- */
3545
- created_on?: Date;
3546
- /**
3547
- * Deleted On
3548
- * @description The date/time the entry was deleted on
3549
- */
3550
- deleted_on?: Date | null;
3551
- /**
3552
- * Last Used On
3553
- * @description The date/time the entry was deleted on
3554
- */
3555
- last_used_on?: Date | null;
3556
- /** @description The status of the organization credential. */
3557
- readonly status: components["schemas"]["OrganizationCredentialStatus"];
3558
- };
3559
- /** OrganizationCredentialExtra */
3560
- OrganizationCredentialExtra: {
3561
- /**
3562
- * Api Key Description
3563
- * @description Description of the organization credential.
3564
- */
3565
- api_key_description?: string | null;
3566
- /**
3567
- * Api Key Name
3568
- * @description Name of the organization credential. Only a-z, A-Z, 0-9, underscore, and hyphen are allowed.
3569
- */
3570
- api_key_name?: string | null;
3571
- /**
3572
- * Expires At
3573
- * @description The date and time the credential expiration.
3574
- */
3575
- expires_at?: Date | null;
3576
- };
3577
- /**
3578
- * OrganizationCredentialStatus
3579
- * @enum {string}
3580
- */
3581
- OrganizationCredentialStatus: "active" | "revoked";
3582
3369
  /**
3583
3370
  * OrganizationStatus
3584
3371
  * @enum {string}
@@ -3807,12 +3594,6 @@ export interface components {
3807
3594
  /** Results */
3808
3595
  results: components["schemas"]["EventResponse"][];
3809
3596
  };
3810
- /** Pagination[OrganizationCredential] */
3811
- Pagination_OrganizationCredential_: {
3812
- pagination: components["schemas"]["PaginationMetadata"];
3813
- /** Results */
3814
- results: components["schemas"]["OrganizationCredential"][];
3815
- };
3816
3597
  /** Pagination[Organization] */
3817
3598
  Pagination_Organization_: {
3818
3599
  pagination: components["schemas"]["PaginationMetadata"];
@@ -3973,6 +3754,25 @@ export interface components {
3973
3754
  /** Problem type */
3974
3755
  type: string;
3975
3756
  };
3757
+ /** PublicAuthRequestForm */
3758
+ PublicAuthRequestForm: {
3759
+ /**
3760
+ * Client Id
3761
+ * Format: typeid
3762
+ * @description The organization ID associated with the credentials.
3763
+ */
3764
+ client_id: TypeId<"organization">;
3765
+ /**
3766
+ * Client Secret
3767
+ * @description Client secret for authentication.
3768
+ */
3769
+ client_secret: string;
3770
+ /**
3771
+ * Grant Type
3772
+ * @description The grant type for the authentication request (should always be 'client_credentials').
3773
+ */
3774
+ grant_type: string;
3775
+ };
3976
3776
  /** RdapBase */
3977
3777
  RdapBase: {
3978
3778
  /**
@@ -4065,25 +3865,6 @@ export interface components {
4065
3865
  */
4066
3866
  request: boolean;
4067
3867
  };
4068
- /** SignupCreate */
4069
- SignupCreate: {
4070
- /**
4071
- * Agreements
4072
- * @description User agreement acceptances.
4073
- */
4074
- agreements?: components["schemas"]["UserAgreementAcceptance"][] | null;
4075
- /** @description Organization signup. */
4076
- organization: components["schemas"]["OrganizationCreate"];
4077
- /** @description Terms of service acceptance (legacy). */
4078
- terms_of_service?: components["schemas"]["TermsOfServiceAccept"] | null;
4079
- /** @description User signup to platform. */
4080
- user: components["schemas"]["UserCreate"];
4081
- };
4082
- /** SignupResponse */
4083
- SignupResponse: {
4084
- organization: components["schemas"]["Organization"];
4085
- user: components["schemas"]["User"];
4086
- };
4087
3868
  /** SldLength */
4088
3869
  SldLength: {
4089
3870
  /**
@@ -4119,14 +3900,6 @@ export interface components {
4119
3900
  * @enum {string}
4120
3901
  */
4121
3902
  TLDType: "gTLD" | "ccTLD";
4122
- /** TermsOfServiceAccept */
4123
- TermsOfServiceAccept: {
4124
- /**
4125
- * Accepted
4126
- * @description The organization accepts Terms of Service.
4127
- */
4128
- accepted: boolean;
4129
- };
4130
3903
  /** TldBase */
4131
3904
  TldBase: {
4132
3905
  /**
@@ -4346,26 +4119,6 @@ export interface components {
4346
4119
  */
4347
4120
  username: string;
4348
4121
  };
4349
- /** UserAgreementAcceptance */
4350
- UserAgreementAcceptance: {
4351
- /**
4352
- * Accepted
4353
- * @description Whether the agreement has been accepted.
4354
- */
4355
- accepted: boolean;
4356
- /** @description Type of agreement being accepted. */
4357
- type: components["schemas"]["AgreementType"];
4358
- /**
4359
- * Url
4360
- * @description URL where the agreement can be found.
4361
- */
4362
- url?: string | null;
4363
- /**
4364
- * Version
4365
- * @description Version of the agreement being accepted.
4366
- */
4367
- version?: string | null;
4368
- };
4369
4122
  /** UserAttributeBase */
4370
4123
  UserAttributeBase: {
4371
4124
  /**
@@ -4718,267 +4471,6 @@ export interface components {
4718
4471
  }
4719
4472
  export type $defs = Record<string, never>;
4720
4473
  export interface operations {
4721
- list_api_keys_v1_auth_client_credentials_get: {
4722
- parameters: {
4723
- query?: {
4724
- /** @description Optional status to filter the results */
4725
- status?: components["schemas"]["OrganizationCredentialStatus"] | null;
4726
- page?: number;
4727
- page_size?: number;
4728
- };
4729
- header?: never;
4730
- path?: never;
4731
- cookie?: never;
4732
- };
4733
- requestBody?: never;
4734
- responses: {
4735
- /** @description Successful Response */
4736
- 200: {
4737
- headers: {
4738
- [name: string]: unknown;
4739
- };
4740
- content: {
4741
- "application/json": components["schemas"]["Pagination_OrganizationCredential_"];
4742
- };
4743
- };
4744
- /** @description Unauthorized */
4745
- 401: {
4746
- headers: {
4747
- [name: string]: unknown;
4748
- };
4749
- content: {
4750
- /** @example {
4751
- * "code": "ERROR_AUTHENTICATION",
4752
- * "detail": "Additional error context.",
4753
- * "status": 401,
4754
- * "title": "Authentication Error",
4755
- * "type": "authentication"
4756
- * } */
4757
- "application/problem+json": components["schemas"]["Problem"];
4758
- };
4759
- };
4760
- /** @description Validation Error */
4761
- 422: {
4762
- headers: {
4763
- [name: string]: unknown;
4764
- };
4765
- content: {
4766
- "application/problem+json": components["schemas"]["HTTPValidationError"];
4767
- };
4768
- };
4769
- };
4770
- };
4771
- issue_api_key_v1_auth_client_credentials_post: {
4772
- parameters: {
4773
- query?: never;
4774
- header?: never;
4775
- path?: never;
4776
- cookie?: never;
4777
- };
4778
- requestBody: {
4779
- content: {
4780
- "application/json": components["schemas"]["OrganizationCredentialExtra"];
4781
- };
4782
- };
4783
- responses: {
4784
- /** @description Successful Response */
4785
- 200: {
4786
- headers: {
4787
- [name: string]: unknown;
4788
- };
4789
- content: {
4790
- "application/json": components["schemas"]["OrganizationCredentialCreated"];
4791
- };
4792
- };
4793
- /** @description Unauthorized */
4794
- 401: {
4795
- headers: {
4796
- [name: string]: unknown;
4797
- };
4798
- content: {
4799
- /** @example {
4800
- * "code": "ERROR_AUTHENTICATION",
4801
- * "detail": "Additional error context.",
4802
- * "status": 401,
4803
- * "title": "Authentication Error",
4804
- * "type": "authentication"
4805
- * } */
4806
- "application/problem+json": components["schemas"]["Problem"];
4807
- };
4808
- };
4809
- /** @description Validation Error */
4810
- 422: {
4811
- headers: {
4812
- [name: string]: unknown;
4813
- };
4814
- content: {
4815
- "application/problem+json": components["schemas"]["HTTPValidationError"];
4816
- };
4817
- };
4818
- };
4819
- };
4820
- delete_api_key_v1_auth_client_credentials__api_key_id__delete: {
4821
- parameters: {
4822
- query?: never;
4823
- header?: never;
4824
- path: {
4825
- api_key_id: TypeId<"api_key">;
4826
- };
4827
- cookie?: never;
4828
- };
4829
- requestBody?: never;
4830
- responses: {
4831
- /** @description Successful Response */
4832
- 204: {
4833
- headers: {
4834
- [name: string]: unknown;
4835
- };
4836
- content?: never;
4837
- };
4838
- /** @description Unauthorized */
4839
- 401: {
4840
- headers: {
4841
- [name: string]: unknown;
4842
- };
4843
- content: {
4844
- /** @example {
4845
- * "code": "ERROR_AUTHENTICATION",
4846
- * "detail": "Additional error context.",
4847
- * "status": 401,
4848
- * "title": "Authentication Error",
4849
- * "type": "authentication"
4850
- * } */
4851
- "application/problem+json": components["schemas"]["Problem"];
4852
- };
4853
- };
4854
- /** @description Not Found */
4855
- 404: {
4856
- headers: {
4857
- [name: string]: unknown;
4858
- };
4859
- content: {
4860
- /** @example {
4861
- * "code": "ERROR_ORGANIZATION_CREDENTIAL_NOT_FOUND",
4862
- * "credential_id": "Additional error context.",
4863
- * "detail": "Organization credential with ID Additional error context. not found",
4864
- * "status": 404,
4865
- * "title": "Organization Management Error",
4866
- * "type": "organization-credential-not-found"
4867
- * } */
4868
- "application/problem+json": components["schemas"]["Problem"];
4869
- };
4870
- };
4871
- /** @description Validation Error */
4872
- 422: {
4873
- headers: {
4874
- [name: string]: unknown;
4875
- };
4876
- content: {
4877
- "application/problem+json": components["schemas"]["HTTPValidationError"];
4878
- };
4879
- };
4880
- };
4881
- };
4882
- logout_v1_auth_logout_post: {
4883
- parameters: {
4884
- query?: never;
4885
- header?: never;
4886
- path?: never;
4887
- cookie?: never;
4888
- };
4889
- requestBody?: never;
4890
- responses: {
4891
- /** @description Successful Response */
4892
- 204: {
4893
- headers: {
4894
- [name: string]: unknown;
4895
- };
4896
- content?: never;
4897
- };
4898
- /** @description Unauthorized */
4899
- 401: {
4900
- headers: {
4901
- [name: string]: unknown;
4902
- };
4903
- content: {
4904
- /** @example {
4905
- * "code": "ERROR_AUTHENTICATION",
4906
- * "detail": "Additional error context.",
4907
- * "status": 401,
4908
- * "title": "Authentication Error",
4909
- * "type": "authentication"
4910
- * } */
4911
- "application/problem+json": components["schemas"]["Problem"];
4912
- };
4913
- };
4914
- };
4915
- };
4916
- signup_v1_auth_signup_post: {
4917
- parameters: {
4918
- query?: never;
4919
- header?: never;
4920
- path?: never;
4921
- cookie?: never;
4922
- };
4923
- requestBody: {
4924
- content: {
4925
- "application/json": components["schemas"]["SignupCreate"];
4926
- };
4927
- };
4928
- responses: {
4929
- /** @description Successful Response */
4930
- 200: {
4931
- headers: {
4932
- [name: string]: unknown;
4933
- };
4934
- content: {
4935
- "application/json": components["schemas"]["SignupResponse"];
4936
- };
4937
- };
4938
- /** @description Forbidden */
4939
- 403: {
4940
- headers: {
4941
- [name: string]: unknown;
4942
- };
4943
- content: {
4944
- /** @example {
4945
- * "code": "ERROR_SIGNUP_NOT_ALLOWED",
4946
- * "detail": "Additional error context.",
4947
- * "status": 403,
4948
- * "title": "Organization Management Error",
4949
- * "type": "signup-not-allowed"
4950
- * } */
4951
- "application/problem+json": components["schemas"]["Problem"];
4952
- };
4953
- };
4954
- /** @description Conflict */
4955
- 409: {
4956
- headers: {
4957
- [name: string]: unknown;
4958
- };
4959
- content: {
4960
- /** @example {
4961
- * "code": "ERROR_USER_EXISTS",
4962
- * "detail": "User with username or email already exists",
4963
- * "status": 409,
4964
- * "title": "User Management Error",
4965
- * "type": "user-already-present",
4966
- * "user": "Additional error context."
4967
- * } */
4968
- "application/problem+json": components["schemas"]["Problem"];
4969
- };
4970
- };
4971
- /** @description Validation Error */
4972
- 422: {
4973
- headers: {
4974
- [name: string]: unknown;
4975
- };
4976
- content: {
4977
- "application/problem+json": components["schemas"]["HTTPValidationError"];
4978
- };
4979
- };
4980
- };
4981
- };
4982
4474
  issue_organization_token_v1_auth_token_post: {
4983
4475
  parameters: {
4984
4476
  query?: never;
@@ -4988,7 +4480,7 @@ export interface operations {
4988
4480
  };
4989
4481
  requestBody?: {
4990
4482
  content: {
4991
- "application/x-www-form-urlencoded": components["schemas"]["Body_issue_organization_token_v1_auth_token_post"];
4483
+ "application/x-www-form-urlencoded": components["schemas"]["PublicAuthRequestForm"];
4992
4484
  };
4993
4485
  };
4994
4486
  responses: {