@opusdns/api 1.115.0 → 1.116.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 CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^1.2.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.115.0",
6
+ "version": "1.116.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -1,4 +1,9 @@
1
1
  import type {
2
+ AggregationResult,
3
+ AggregationRow,
4
+ AggregationsContext,
5
+ AggregationsContextCreate,
6
+ AggregationsContextPayload,
2
7
  AiInferenceUsageBucket,
3
8
  AiInferenceUsageGroup,
4
9
  AiInferenceUsageSeries,
@@ -449,6 +454,68 @@ import type {
449
454
  DomainAvailabilityCheck,
450
455
  } from './schemas';
451
456
 
457
+ export const KEY_AGGREGATION_RESULT_FIELD = 'field' satisfies keyof AggregationResult;
458
+ export const KEY_AGGREGATION_RESULT_NAME = 'name' satisfies keyof AggregationResult;
459
+ export const KEY_AGGREGATION_RESULT_OTHER_COUNT = 'other_count' satisfies keyof AggregationResult;
460
+ export const KEY_AGGREGATION_RESULT_ROWS = 'rows' satisfies keyof AggregationResult;
461
+ export const KEY_AGGREGATION_RESULT_TYPE = 'type' satisfies keyof AggregationResult;
462
+ export const KEY_AGGREGATION_RESULT_VALUE = 'value' satisfies keyof AggregationResult;
463
+ export const KEY_AGGREGATION_RESULT_VALUES = 'values' satisfies keyof AggregationResult;
464
+
465
+ export const KEYS_AGGREGATION_RESULT = [
466
+ KEY_AGGREGATION_RESULT_FIELD,
467
+ KEY_AGGREGATION_RESULT_NAME,
468
+ KEY_AGGREGATION_RESULT_OTHER_COUNT,
469
+ KEY_AGGREGATION_RESULT_ROWS,
470
+ KEY_AGGREGATION_RESULT_TYPE,
471
+ KEY_AGGREGATION_RESULT_VALUE,
472
+ KEY_AGGREGATION_RESULT_VALUES,
473
+ ] as const satisfies (keyof AggregationResult)[];
474
+
475
+ export const KEY_AGGREGATION_ROW_COUNT = 'count' satisfies keyof AggregationRow;
476
+ export const KEY_AGGREGATION_ROW_KEY = 'key' satisfies keyof AggregationRow;
477
+
478
+ export const KEYS_AGGREGATION_ROW = [
479
+ KEY_AGGREGATION_ROW_COUNT,
480
+ KEY_AGGREGATION_ROW_KEY,
481
+ ] as const satisfies (keyof AggregationRow)[];
482
+
483
+ export const KEY_AGGREGATIONS_CONTEXT_CONTEXT_ID = 'context_id' satisfies keyof AggregationsContext;
484
+ export const KEY_AGGREGATIONS_CONTEXT_CONVERSATION_ID = 'conversation_id' satisfies keyof AggregationsContext;
485
+ export const KEY_AGGREGATIONS_CONTEXT_CREATED_AT = 'created_at' satisfies keyof AggregationsContext;
486
+ export const KEY_AGGREGATIONS_CONTEXT_KIND = 'kind' satisfies keyof AggregationsContext;
487
+ export const KEY_AGGREGATIONS_CONTEXT_ORGANIZATION_ID = 'organization_id' satisfies keyof AggregationsContext;
488
+ export const KEY_AGGREGATIONS_CONTEXT_PAYLOAD = 'payload' satisfies keyof AggregationsContext;
489
+ export const KEY_AGGREGATIONS_CONTEXT_USER_ID = 'user_id' satisfies keyof AggregationsContext;
490
+
491
+ export const KEYS_AGGREGATIONS_CONTEXT = [
492
+ KEY_AGGREGATIONS_CONTEXT_CONTEXT_ID,
493
+ KEY_AGGREGATIONS_CONTEXT_CONVERSATION_ID,
494
+ KEY_AGGREGATIONS_CONTEXT_CREATED_AT,
495
+ KEY_AGGREGATIONS_CONTEXT_KIND,
496
+ KEY_AGGREGATIONS_CONTEXT_ORGANIZATION_ID,
497
+ KEY_AGGREGATIONS_CONTEXT_PAYLOAD,
498
+ KEY_AGGREGATIONS_CONTEXT_USER_ID,
499
+ ] as const satisfies (keyof AggregationsContext)[];
500
+
501
+ export const KEY_AGGREGATIONS_CONTEXT_CREATE_KIND = 'kind' satisfies keyof AggregationsContextCreate;
502
+ export const KEY_AGGREGATIONS_CONTEXT_CREATE_PAYLOAD = 'payload' satisfies keyof AggregationsContextCreate;
503
+
504
+ export const KEYS_AGGREGATIONS_CONTEXT_CREATE = [
505
+ KEY_AGGREGATIONS_CONTEXT_CREATE_KIND,
506
+ KEY_AGGREGATIONS_CONTEXT_CREATE_PAYLOAD,
507
+ ] as const satisfies (keyof AggregationsContextCreate)[];
508
+
509
+ export const KEY_AGGREGATIONS_CONTEXT_PAYLOAD_AGGREGATIONS = 'aggregations' satisfies keyof AggregationsContextPayload;
510
+ export const KEY_AGGREGATIONS_CONTEXT_PAYLOAD_QUESTION = 'question' satisfies keyof AggregationsContextPayload;
511
+ export const KEY_AGGREGATIONS_CONTEXT_PAYLOAD_TOTAL = 'total' satisfies keyof AggregationsContextPayload;
512
+
513
+ export const KEYS_AGGREGATIONS_CONTEXT_PAYLOAD = [
514
+ KEY_AGGREGATIONS_CONTEXT_PAYLOAD_AGGREGATIONS,
515
+ KEY_AGGREGATIONS_CONTEXT_PAYLOAD_QUESTION,
516
+ KEY_AGGREGATIONS_CONTEXT_PAYLOAD_TOTAL,
517
+ ] as const satisfies (keyof AggregationsContextPayload)[];
518
+
452
519
  export const KEY_AI_INFERENCE_USAGE_BUCKET_GROUPS = 'groups' satisfies keyof AiInferenceUsageBucket;
453
520
  export const KEY_AI_INFERENCE_USAGE_BUCKET_PERIOD_START = 'period_start' satisfies keyof AiInferenceUsageBucket;
454
521
 
@@ -1,5 +1,10 @@
1
1
  import { components } from '../schema';
2
2
 
3
+ export type AggregationResult = components['schemas']['AggregationResult'];
4
+ export type AggregationRow = components['schemas']['AggregationRow'];
5
+ export type AggregationsContext = components['schemas']['AggregationsContext'];
6
+ export type AggregationsContextCreate = components['schemas']['AggregationsContextCreate'];
7
+ export type AggregationsContextPayload = components['schemas']['AggregationsContextPayload'];
3
8
  export type AiInferenceUsageBucket = components['schemas']['AiInferenceUsageBucket'];
4
9
  export type AiInferenceUsageGroup = components['schemas']['AiInferenceUsageGroup'];
5
10
  export type AiInferenceUsageSeries = components['schemas']['AiInferenceUsageSeriesResponse'];
package/src/openapi.yaml CHANGED
@@ -15,6 +15,143 @@ components:
15
15
  - rfc3339
16
16
  type: string
17
17
  schemas:
18
+ AggregationResult:
19
+ properties:
20
+ field:
21
+ anyOf:
22
+ - type: string
23
+ - type: 'null'
24
+ title: Field
25
+ name:
26
+ title: Name
27
+ type: string
28
+ other_count:
29
+ anyOf:
30
+ - type: integer
31
+ - type: 'null'
32
+ title: Other Count
33
+ rows:
34
+ anyOf:
35
+ - items:
36
+ $ref: '#/components/schemas/AggregationRow'
37
+ type: array
38
+ - type: 'null'
39
+ title: Rows
40
+ type:
41
+ title: Type
42
+ type: string
43
+ value:
44
+ anyOf:
45
+ - type: number
46
+ - type: 'null'
47
+ title: Value
48
+ values:
49
+ anyOf:
50
+ - additionalProperties:
51
+ type: number
52
+ type: object
53
+ - type: 'null'
54
+ title: Values
55
+ required:
56
+ - name
57
+ - type
58
+ title: AggregationResult
59
+ type: object
60
+ AggregationRow:
61
+ properties:
62
+ count:
63
+ title: Count
64
+ type: integer
65
+ key:
66
+ title: Key
67
+ type: string
68
+ required:
69
+ - key
70
+ - count
71
+ title: AggregationRow
72
+ type: object
73
+ AggregationsContext:
74
+ properties:
75
+ context_id:
76
+ examples:
77
+ - ctx_01h45ytscbebyvny4gc8cr8ma2
78
+ format: typeid
79
+ pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$
80
+ title: Context Id
81
+ type: string
82
+ x-typeid-prefix: ctx
83
+ conversation_id:
84
+ examples:
85
+ - conv_01h45ytscbebyvny4gc8cr8ma2
86
+ format: typeid
87
+ pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
88
+ title: Conversation Id
89
+ type: string
90
+ x-typeid-prefix: conv
91
+ created_at:
92
+ format: date-time
93
+ title: Created At
94
+ type: string
95
+ kind:
96
+ const: aggregations
97
+ default: aggregations
98
+ title: Kind
99
+ type: string
100
+ organization_id:
101
+ examples:
102
+ - organization_01h45ytscbebyvny4gc8cr8ma2
103
+ format: typeid
104
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
105
+ title: Organization Id
106
+ type: string
107
+ x-typeid-prefix: organization
108
+ payload:
109
+ $ref: '#/components/schemas/AggregationsContextPayload'
110
+ user_id:
111
+ title: User Id
112
+ type: string
113
+ required:
114
+ - context_id
115
+ - conversation_id
116
+ - organization_id
117
+ - user_id
118
+ - created_at
119
+ - payload
120
+ title: AggregationsContext
121
+ type: object
122
+ AggregationsContextCreate:
123
+ properties:
124
+ kind:
125
+ const: aggregations
126
+ default: aggregations
127
+ title: Kind
128
+ type: string
129
+ payload:
130
+ $ref: '#/components/schemas/AggregationsContextPayload'
131
+ required:
132
+ - payload
133
+ title: AggregationsContextCreate
134
+ type: object
135
+ AggregationsContextPayload:
136
+ properties:
137
+ aggregations:
138
+ items:
139
+ $ref: '#/components/schemas/AggregationResult'
140
+ title: Aggregations
141
+ type: array
142
+ question:
143
+ title: Question
144
+ type: string
145
+ total:
146
+ anyOf:
147
+ - type: integer
148
+ - type: 'null'
149
+ title: Total
150
+ required:
151
+ - question
152
+ - aggregations
153
+ title: AggregationsContextPayload
154
+ type: object
18
155
  AiInferenceUsageBucket:
19
156
  properties:
20
157
  groups:
@@ -2056,6 +2193,7 @@ components:
2056
2193
  items:
2057
2194
  discriminator:
2058
2195
  mapping:
2196
+ aggregations: '#/components/schemas/AggregationsContext'
2059
2197
  contacts: '#/components/schemas/ContactsContext'
2060
2198
  domain_forwards: '#/components/schemas/DomainForwardsContext'
2061
2199
  domain_recommendations: '#/components/schemas/DomainRecommendationsContext'
@@ -2070,6 +2208,7 @@ components:
2070
2208
  - $ref: '#/components/schemas/DomainForwardsContext'
2071
2209
  - $ref: '#/components/schemas/EmailForwardsContext'
2072
2210
  - $ref: '#/components/schemas/DomainRecommendationsContext'
2211
+ - $ref: '#/components/schemas/AggregationsContext'
2073
2212
  title: Results
2074
2213
  type: array
2075
2214
  required:
@@ -15315,7 +15454,7 @@ info:
15315
15454
  \n\n"
15316
15455
  summary: OpusDNS - your gateway to a seamless domain management experience.
15317
15456
  title: OpusDNS API
15318
- version: 2026-08-14-165642
15457
+ version: 2026-08-17-111612
15319
15458
  x-logo:
15320
15459
  altText: OpusDNS API Reference
15321
15460
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -15344,6 +15483,7 @@ paths:
15344
15483
  schema:
15345
15484
  discriminator:
15346
15485
  mapping:
15486
+ aggregations: '#/components/schemas/AggregationsContext'
15347
15487
  contacts: '#/components/schemas/ContactsContext'
15348
15488
  domain_forwards: '#/components/schemas/DomainForwardsContext'
15349
15489
  domain_recommendations: '#/components/schemas/DomainRecommendationsContext'
@@ -15358,6 +15498,7 @@ paths:
15358
15498
  - $ref: '#/components/schemas/DomainForwardsContext'
15359
15499
  - $ref: '#/components/schemas/EmailForwardsContext'
15360
15500
  - $ref: '#/components/schemas/DomainRecommendationsContext'
15501
+ - $ref: '#/components/schemas/AggregationsContext'
15361
15502
  title: Response Get Context V1 Ai Concierge Contexts Context Id Get
15362
15503
  description: Successful Response
15363
15504
  '401':
@@ -15919,6 +16060,7 @@ paths:
15919
16060
  schema:
15920
16061
  discriminator:
15921
16062
  mapping:
16063
+ aggregations: '#/components/schemas/AggregationsContextCreate'
15922
16064
  contacts: '#/components/schemas/ContactsContextCreate'
15923
16065
  domain_forwards: '#/components/schemas/DomainForwardsContextCreate'
15924
16066
  domain_recommendations: '#/components/schemas/DomainRecommendationsContextCreate'
@@ -15933,6 +16075,7 @@ paths:
15933
16075
  - $ref: '#/components/schemas/DomainForwardsContextCreate'
15934
16076
  - $ref: '#/components/schemas/EmailForwardsContextCreate'
15935
16077
  - $ref: '#/components/schemas/DomainRecommendationsContextCreate'
16078
+ - $ref: '#/components/schemas/AggregationsContextCreate'
15936
16079
  title: Request Body
15937
16080
  required: true
15938
16081
  responses:
@@ -15942,6 +16085,7 @@ paths:
15942
16085
  schema:
15943
16086
  discriminator:
15944
16087
  mapping:
16088
+ aggregations: '#/components/schemas/AggregationsContext'
15945
16089
  contacts: '#/components/schemas/ContactsContext'
15946
16090
  domain_forwards: '#/components/schemas/DomainForwardsContext'
15947
16091
  domain_recommendations: '#/components/schemas/DomainRecommendationsContext'
@@ -15956,6 +16100,7 @@ paths:
15956
16100
  - $ref: '#/components/schemas/DomainForwardsContext'
15957
16101
  - $ref: '#/components/schemas/EmailForwardsContext'
15958
16102
  - $ref: '#/components/schemas/DomainRecommendationsContext'
16103
+ - $ref: '#/components/schemas/AggregationsContext'
15959
16104
  title: Response Create Context V1 Ai Concierge Conversations Conversation
15960
16105
  Id Contexts Post
15961
16106
  description: Successful Response
package/src/schema.d.ts CHANGED
@@ -3018,6 +3018,84 @@ export interface paths {
3018
3018
  export type webhooks = Record<string, never>;
3019
3019
  export interface components {
3020
3020
  schemas: {
3021
+ /** AggregationResult */
3022
+ AggregationResult: {
3023
+ /** Field */
3024
+ field?: string | null;
3025
+ /** Name */
3026
+ name: string;
3027
+ /** Other Count */
3028
+ other_count?: number | null;
3029
+ /** Rows */
3030
+ rows?: components["schemas"]["AggregationRow"][] | null;
3031
+ /** Type */
3032
+ type: string;
3033
+ /** Value */
3034
+ value?: number | null;
3035
+ /** Values */
3036
+ values?: {
3037
+ [key: string]: number;
3038
+ } | null;
3039
+ };
3040
+ /** AggregationRow */
3041
+ AggregationRow: {
3042
+ /** Count */
3043
+ count: number;
3044
+ /** Key */
3045
+ key: string;
3046
+ };
3047
+ /** AggregationsContext */
3048
+ AggregationsContext: {
3049
+ /**
3050
+ * Context Id
3051
+ * Format: typeid
3052
+ * @example ctx_01h45ytscbebyvny4gc8cr8ma2
3053
+ */
3054
+ context_id: TypeId<"ctx">;
3055
+ /**
3056
+ * Conversation Id
3057
+ * Format: typeid
3058
+ * @example conv_01h45ytscbebyvny4gc8cr8ma2
3059
+ */
3060
+ conversation_id: TypeId<"conv">;
3061
+ /**
3062
+ * Created At
3063
+ * Format: date-time
3064
+ */
3065
+ created_at: Date;
3066
+ /**
3067
+ * @description discriminator enum property added by openapi-typescript
3068
+ * @enum {string}
3069
+ */
3070
+ kind: "aggregations";
3071
+ /**
3072
+ * Organization Id
3073
+ * Format: typeid
3074
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
3075
+ */
3076
+ organization_id: TypeId<"organization">;
3077
+ payload: components["schemas"]["AggregationsContextPayload"];
3078
+ /** User Id */
3079
+ user_id: string;
3080
+ };
3081
+ /** AggregationsContextCreate */
3082
+ AggregationsContextCreate: {
3083
+ /**
3084
+ * @description discriminator enum property added by openapi-typescript
3085
+ * @enum {string}
3086
+ */
3087
+ kind: "aggregations";
3088
+ payload: components["schemas"]["AggregationsContextPayload"];
3089
+ };
3090
+ /** AggregationsContextPayload */
3091
+ AggregationsContextPayload: {
3092
+ /** Aggregations */
3093
+ aggregations: components["schemas"]["AggregationResult"][];
3094
+ /** Question */
3095
+ question: string;
3096
+ /** Total */
3097
+ total?: number | null;
3098
+ };
3021
3099
  /** AiInferenceUsageBucket */
3022
3100
  AiInferenceUsageBucket: {
3023
3101
  /** Groups */
@@ -4404,7 +4482,7 @@ export interface components {
4404
4482
  ContextListResponse: {
4405
4483
  pagination: components["schemas"]["PaginationMetadata"];
4406
4484
  /** Results */
4407
- results: (components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"])[];
4485
+ results: (components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"] | components["schemas"]["AggregationsContext"])[];
4408
4486
  };
4409
4487
  /** ContextMeta */
4410
4488
  ContextMeta: {
@@ -13104,7 +13182,7 @@ export interface operations {
13104
13182
  [name: string]: unknown;
13105
13183
  };
13106
13184
  content: {
13107
- "application/json": components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"];
13185
+ "application/json": components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"] | components["schemas"]["AggregationsContext"];
13108
13186
  };
13109
13187
  };
13110
13188
  /** @description Unauthorized */
@@ -13706,7 +13784,7 @@ export interface operations {
13706
13784
  };
13707
13785
  requestBody: {
13708
13786
  content: {
13709
- "application/json": components["schemas"]["ZonesContextCreate"] | components["schemas"]["ContactsContextCreate"] | components["schemas"]["DomainsContextCreate"] | components["schemas"]["DomainForwardsContextCreate"] | components["schemas"]["EmailForwardsContextCreate"] | components["schemas"]["DomainRecommendationsContextCreate"];
13787
+ "application/json": components["schemas"]["ZonesContextCreate"] | components["schemas"]["ContactsContextCreate"] | components["schemas"]["DomainsContextCreate"] | components["schemas"]["DomainForwardsContextCreate"] | components["schemas"]["EmailForwardsContextCreate"] | components["schemas"]["DomainRecommendationsContextCreate"] | components["schemas"]["AggregationsContextCreate"];
13710
13788
  };
13711
13789
  };
13712
13790
  responses: {
@@ -13716,7 +13794,7 @@ export interface operations {
13716
13794
  [name: string]: unknown;
13717
13795
  };
13718
13796
  content: {
13719
- "application/json": components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"];
13797
+ "application/json": components["schemas"]["ZonesContext"] | components["schemas"]["ContactsContext"] | components["schemas"]["DomainsContext"] | components["schemas"]["DomainForwardsContext"] | components["schemas"]["EmailForwardsContext"] | components["schemas"]["DomainRecommendationsContext"] | components["schemas"]["AggregationsContext"];
13720
13798
  };
13721
13799
  };
13722
13800
  /** @description Unauthorized */