@opusdns/api 0.100.0 → 0.102.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,5 +1,65 @@
1
1
  import { TypeId } from "typeid-js";
2
2
  export interface paths {
3
+ "/v1/archive/object-logs": {
4
+ parameters: {
5
+ query?: never;
6
+ header?: never;
7
+ path?: never;
8
+ cookie?: never;
9
+ };
10
+ /**
11
+ * Retrieve all object history
12
+ * @description Retrieve all paginated audit logs with optional filtering and sorting
13
+ */
14
+ get: operations["get_object_logs_v1_archive_object_logs_get"];
15
+ put?: never;
16
+ post?: never;
17
+ delete?: never;
18
+ options?: never;
19
+ head?: never;
20
+ patch?: never;
21
+ trace?: never;
22
+ };
23
+ "/v1/archive/object-logs/{object_id}": {
24
+ parameters: {
25
+ query?: never;
26
+ header?: never;
27
+ path?: never;
28
+ cookie?: never;
29
+ };
30
+ /**
31
+ * Retrieve object history
32
+ * @description Retrieve paginated audit logs for a specific object with optional filtering and sorting
33
+ */
34
+ get: operations["get_object_logs_by_object_id_v1_archive_object_logs__object_id__get"];
35
+ put?: never;
36
+ post?: never;
37
+ delete?: never;
38
+ options?: never;
39
+ head?: never;
40
+ patch?: never;
41
+ trace?: never;
42
+ };
43
+ "/v1/archive/request-history": {
44
+ parameters: {
45
+ query?: never;
46
+ header?: never;
47
+ path?: never;
48
+ cookie?: never;
49
+ };
50
+ /**
51
+ * Retrieve request history logs
52
+ * @description Retrieves a paginated list of request history logs
53
+ */
54
+ get: operations["get_request_history_v1_archive_request_history_get"];
55
+ put?: never;
56
+ post?: never;
57
+ delete?: never;
58
+ options?: never;
59
+ head?: never;
60
+ patch?: never;
61
+ trace?: never;
62
+ };
3
63
  "/v1/auth/token": {
4
64
  parameters: {
5
65
  query?: never;
@@ -3405,6 +3465,62 @@ export interface components {
3405
3465
  */
3406
3466
  ip_addresses?: string[];
3407
3467
  };
3468
+ /**
3469
+ * ObjectEventType
3470
+ * @enum {string}
3471
+ */
3472
+ ObjectEventType: "CREATED" | "UPDATED" | "DELETED" | "TRANSFER_STARTED" | "TRANSFER_COMPLETED" | "TRANSFER_OUT_STARTED" | "TRANSFER_OUT_COMPLETED" | "RENEWED" | "RESTORED" | "BILLING_TRANSACTION_RESERVED" | "BILLING_TRANSACTION_SUCCEEDED" | "BILLING_TRANSACTION_FAILED" | "BILLING_TRANSACTION_CANCELLED";
3473
+ /** ObjectLog */
3474
+ ObjectLog: {
3475
+ /** @description Action performed */
3476
+ action: components["schemas"]["ObjectEventType"];
3477
+ /**
3478
+ * Created On
3479
+ * Format: date-time
3480
+ * @description Timestamp when the log was created
3481
+ */
3482
+ created_on: Date;
3483
+ /**
3484
+ * Details
3485
+ * @description Changes made to the object
3486
+ */
3487
+ details?: Record<string, never> | null;
3488
+ /**
3489
+ * Object Id
3490
+ * @description ID of the object
3491
+ */
3492
+ object_id: string;
3493
+ /**
3494
+ * Object Log Id
3495
+ * @description Unique ID of the log
3496
+ */
3497
+ object_log_id: string;
3498
+ /**
3499
+ * Object Type
3500
+ * @description Type of the object
3501
+ */
3502
+ object_type: string;
3503
+ /**
3504
+ * Performed By Id
3505
+ * @description ID of the actor who performed the action
3506
+ */
3507
+ performed_by_id?: string | null;
3508
+ /**
3509
+ * Performed By Type
3510
+ * @description Type of the actor who performed the action
3511
+ */
3512
+ performed_by_type?: string | null;
3513
+ /**
3514
+ * Server Request Id
3515
+ * @description Server request ID
3516
+ */
3517
+ server_request_id?: string | null;
3518
+ };
3519
+ /**
3520
+ * ObjectLogSortField
3521
+ * @enum {string}
3522
+ */
3523
+ ObjectLogSortField: "object_log_id" | "object_id" | "object_type" | "action" | "created_on" | "server_request_id" | "performed_by_type" | "performed_by_id";
3408
3524
  /** Organization */
3409
3525
  Organization: {
3410
3526
  /**
@@ -3939,12 +4055,24 @@ export interface components {
3939
4055
  /** Results */
3940
4056
  results: components["schemas"]["InvoiceResponse"][];
3941
4057
  };
4058
+ /** Pagination[ObjectLog] */
4059
+ Pagination_ObjectLog_: {
4060
+ pagination: components["schemas"]["PaginationMetadata"];
4061
+ /** Results */
4062
+ results: components["schemas"]["ObjectLog"][];
4063
+ };
3942
4064
  /** Pagination[Organization] */
3943
4065
  Pagination_Organization_: {
3944
4066
  pagination: components["schemas"]["PaginationMetadata"];
3945
4067
  /** Results */
3946
4068
  results: components["schemas"]["Organization"][];
3947
4069
  };
4070
+ /** Pagination[RequestHistory] */
4071
+ Pagination_RequestHistory_: {
4072
+ pagination: components["schemas"]["PaginationMetadata"];
4073
+ /** Results */
4074
+ results: components["schemas"]["RequestHistory"][];
4075
+ };
3948
4076
  /** Pagination[User] */
3949
4077
  Pagination_User_: {
3950
4078
  pagination: components["schemas"]["PaginationMetadata"];
@@ -4143,6 +4271,76 @@ export interface components {
4143
4271
  * @enum {string}
4144
4272
  */
4145
4273
  RenewalMode: "renew" | "expire" | "delete";
4274
+ /** RequestHistory */
4275
+ RequestHistory: {
4276
+ /**
4277
+ * Client Ip
4278
+ * @description Client IP address
4279
+ */
4280
+ client_ip: string;
4281
+ /**
4282
+ * Duration
4283
+ * @description Request duration in milliseconds
4284
+ */
4285
+ duration: number;
4286
+ /**
4287
+ * Method
4288
+ * @description HTTP method
4289
+ */
4290
+ method: string;
4291
+ /**
4292
+ * Path
4293
+ * @description Request path
4294
+ */
4295
+ path: string;
4296
+ /**
4297
+ * Performed By Id
4298
+ * @description ID of the actor who performed the request
4299
+ */
4300
+ performed_by_id?: string | null;
4301
+ /**
4302
+ * Performed By Type
4303
+ * @description Type of the actor who performed the request
4304
+ */
4305
+ performed_by_type?: string | null;
4306
+ /**
4307
+ * Request Body
4308
+ * @description Request body
4309
+ */
4310
+ request_body?: Record<string, never> | null;
4311
+ /**
4312
+ * Request Completed At
4313
+ * Format: date-time
4314
+ * @description Timestamp when the request completed
4315
+ */
4316
+ request_completed_at: Date;
4317
+ /**
4318
+ * Request Started At
4319
+ * Format: date-time
4320
+ * @description Timestamp when the request started
4321
+ */
4322
+ request_started_at: Date;
4323
+ /**
4324
+ * Response Body
4325
+ * @description Response body
4326
+ */
4327
+ response_body?: Record<string, never> | null;
4328
+ /**
4329
+ * Server Request Id
4330
+ * @description Unique ID of the request
4331
+ */
4332
+ server_request_id: string;
4333
+ /**
4334
+ * Status Code
4335
+ * @description HTTP status code
4336
+ */
4337
+ status_code: number;
4338
+ };
4339
+ /**
4340
+ * RequestHistorySortField
4341
+ * @enum {string}
4342
+ */
4343
+ RequestHistorySortField: "method" | "path" | "status_code" | "duration" | "server_request_id" | "performed_by_type" | "performed_by_id" | "created_on" | "request_started_at" | "request_completed_at";
4146
4344
  /** ReservedDomainsBase */
4147
4345
  ReservedDomainsBase: {
4148
4346
  /** @description Source of reserved domain information */
@@ -4802,6 +5000,140 @@ export interface components {
4802
5000
  }
4803
5001
  export type $defs = Record<string, never>;
4804
5002
  export interface operations {
5003
+ get_object_logs_v1_archive_object_logs_get: {
5004
+ parameters: {
5005
+ query?: {
5006
+ sort_by?: components["schemas"]["ObjectLogSortField"];
5007
+ sort_order?: components["schemas"]["SortOrder"];
5008
+ page_size?: number;
5009
+ page?: number;
5010
+ object_log_id?: string | null;
5011
+ object_type?: string | null;
5012
+ action?: components["schemas"]["ObjectEventType"] | null;
5013
+ server_request_id?: string | null;
5014
+ performed_by_type?: string | null;
5015
+ performed_by_id?: string | null;
5016
+ start_time?: Date | null;
5017
+ end_time?: Date | null;
5018
+ object_id?: string | null;
5019
+ };
5020
+ header?: never;
5021
+ path?: never;
5022
+ cookie?: never;
5023
+ };
5024
+ requestBody?: never;
5025
+ responses: {
5026
+ /** @description Successful Response */
5027
+ 200: {
5028
+ headers: {
5029
+ [name: string]: unknown;
5030
+ };
5031
+ content: {
5032
+ "application/json": components["schemas"]["Pagination_ObjectLog_"];
5033
+ };
5034
+ };
5035
+ /** @description Validation Error */
5036
+ 422: {
5037
+ headers: {
5038
+ [name: string]: unknown;
5039
+ };
5040
+ content: {
5041
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
5042
+ };
5043
+ };
5044
+ };
5045
+ };
5046
+ get_object_logs_by_object_id_v1_archive_object_logs__object_id__get: {
5047
+ parameters: {
5048
+ query?: {
5049
+ sort_by?: components["schemas"]["ObjectLogSortField"];
5050
+ sort_order?: components["schemas"]["SortOrder"];
5051
+ page_size?: number;
5052
+ page?: number;
5053
+ object_log_id?: string | null;
5054
+ object_type?: string | null;
5055
+ action?: components["schemas"]["ObjectEventType"] | null;
5056
+ server_request_id?: string | null;
5057
+ performed_by_type?: string | null;
5058
+ performed_by_id?: string | null;
5059
+ start_time?: Date | null;
5060
+ end_time?: Date | null;
5061
+ };
5062
+ header?: never;
5063
+ path: {
5064
+ object_id: string;
5065
+ };
5066
+ cookie?: never;
5067
+ };
5068
+ requestBody?: never;
5069
+ responses: {
5070
+ /** @description Successful Response */
5071
+ 200: {
5072
+ headers: {
5073
+ [name: string]: unknown;
5074
+ };
5075
+ content: {
5076
+ "application/json": components["schemas"]["Pagination_ObjectLog_"];
5077
+ };
5078
+ };
5079
+ /** @description Validation Error */
5080
+ 422: {
5081
+ headers: {
5082
+ [name: string]: unknown;
5083
+ };
5084
+ content: {
5085
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
5086
+ };
5087
+ };
5088
+ };
5089
+ };
5090
+ get_request_history_v1_archive_request_history_get: {
5091
+ parameters: {
5092
+ query?: {
5093
+ sort_by?: components["schemas"]["RequestHistorySortField"];
5094
+ sort_order?: components["schemas"]["SortOrder"];
5095
+ page_size?: number;
5096
+ page?: number;
5097
+ method?: string | null;
5098
+ path?: string | null;
5099
+ status_code?: number | null;
5100
+ min_status_code?: number | null;
5101
+ max_status_code?: number | null;
5102
+ min_duration?: number | null;
5103
+ max_duration?: number | null;
5104
+ client_ip?: string | null;
5105
+ server_request_id?: string | null;
5106
+ performed_by_type?: string | null;
5107
+ performed_by_id?: string | null;
5108
+ start_time?: Date | null;
5109
+ end_time?: Date | null;
5110
+ };
5111
+ header?: never;
5112
+ path?: never;
5113
+ cookie?: never;
5114
+ };
5115
+ requestBody?: never;
5116
+ responses: {
5117
+ /** @description Successful Response */
5118
+ 200: {
5119
+ headers: {
5120
+ [name: string]: unknown;
5121
+ };
5122
+ content: {
5123
+ "application/json": components["schemas"]["Pagination_RequestHistory_"];
5124
+ };
5125
+ };
5126
+ /** @description Validation Error */
5127
+ 422: {
5128
+ headers: {
5129
+ [name: string]: unknown;
5130
+ };
5131
+ content: {
5132
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
5133
+ };
5134
+ };
5135
+ };
5136
+ };
4805
5137
  issue_organization_token_v1_auth_token_post: {
4806
5138
  parameters: {
4807
5139
  query?: never;