@orq-ai/node 4.11.0 → 4.11.3

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.
Files changed (181) hide show
  1. package/jsr.json +1 -1
  2. package/lib/config.d.ts +2 -2
  3. package/lib/config.js +2 -2
  4. package/models/components/evaluatorresponsefunction.js +2 -2
  5. package/models/components/evaluatorresponsehttp.js +2 -2
  6. package/models/components/evaluatorresponsejsonschema.js +2 -2
  7. package/models/components/evaluatorresponsellm.js +2 -2
  8. package/models/components/evaluatorresponsepython.js +2 -2
  9. package/models/components/evaluatorresponseragas.js +2 -2
  10. package/models/components/evaluatorresponsetypescript.js +2 -2
  11. package/models/components/reasoningpart.js +1 -1
  12. package/models/operations/createdataset.js +1 -1
  13. package/models/operations/createdatasetitem.js +4 -4
  14. package/models/operations/createdatasource.js +1 -1
  15. package/models/operations/createtool.js +6 -6
  16. package/models/operations/getalltools.js +6 -6
  17. package/models/operations/getv2humanevalsets.js +2 -2
  18. package/models/operations/getv2humanevalsetsid.js +2 -2
  19. package/models/operations/listdatasetdatapoints.js +4 -4
  20. package/models/operations/listdatasets.js +1 -1
  21. package/models/operations/listdatasources.js +1 -1
  22. package/models/operations/patchv2humanevalsetsid.js +2 -2
  23. package/models/operations/postv2feedbackevaluation.js +3 -3
  24. package/models/operations/postv2humanevalsets.js +2 -2
  25. package/models/operations/retrievedatapoint.js +4 -4
  26. package/models/operations/retrievedataset.js +1 -1
  27. package/models/operations/retrievedatasource.js +1 -1
  28. package/models/operations/retrievetool.js +6 -6
  29. package/models/operations/runagent.js +1 -1
  30. package/models/operations/streamrunagent.js +1 -1
  31. package/models/operations/updatedatapoint.js +4 -4
  32. package/models/operations/updatedataset.js +1 -1
  33. package/models/operations/updatedatasource.js +1 -1
  34. package/models/operations/updatetool.js +7 -7
  35. package/package.json +3 -3
  36. package/packages/orq-rc/src/funcs/notifiersCreate.ts +162 -0
  37. package/packages/orq-rc/src/funcs/notifiersDelete.ts +168 -0
  38. package/packages/orq-rc/src/funcs/notifiersGet.ts +168 -0
  39. package/packages/orq-rc/src/funcs/notifiersList.ts +171 -0
  40. package/packages/orq-rc/src/funcs/notifiersUpdate.ts +171 -0
  41. package/packages/orq-rc/src/funcs/tracesAggregate.ts +162 -0
  42. package/packages/orq-rc/src/funcs/tracesGet.ts +168 -0
  43. package/packages/orq-rc/src/funcs/tracesGetSpan.ts +172 -0
  44. package/packages/orq-rc/src/funcs/tracesListFacetValues.ts +177 -0
  45. package/packages/orq-rc/src/funcs/tracesListFacets.ts +144 -0
  46. package/packages/orq-rc/src/funcs/tracesListFields.ts +144 -0
  47. package/packages/orq-rc/src/funcs/tracesListSpans.ts +174 -0
  48. package/packages/orq-rc/src/funcs/tracesQuery.ts +162 -0
  49. package/packages/orq-rc/src/funcs/tracesSearch.ts +162 -0
  50. package/packages/orq-rc/src/lib/config.ts +3 -3
  51. package/packages/orq-rc/src/models/components/actionreviewrequestedstreamingevent.ts +5 -0
  52. package/packages/orq-rc/src/models/components/agentstartedstreamingevent.ts +5 -0
  53. package/packages/orq-rc/src/models/components/aggregatetracesrequest.ts +65 -0
  54. package/packages/orq-rc/src/models/components/aggregatetracesresponse.ts +37 -0
  55. package/packages/orq-rc/src/models/components/createnotifierrequest.ts +433 -0
  56. package/packages/orq-rc/src/models/components/createnotifierresponse.ts +35 -0
  57. package/packages/orq-rc/src/models/components/deletenotifierresponse.ts +27 -0
  58. package/packages/orq-rc/src/models/components/evaluatorresponsefunction.ts +2 -2
  59. package/packages/orq-rc/src/models/components/evaluatorresponsehttp.ts +2 -2
  60. package/packages/orq-rc/src/models/components/evaluatorresponsejsonschema.ts +2 -2
  61. package/packages/orq-rc/src/models/components/evaluatorresponsellm.ts +2 -2
  62. package/packages/orq-rc/src/models/components/evaluatorresponsepython.ts +2 -2
  63. package/packages/orq-rc/src/models/components/evaluatorresponseragas.ts +2 -2
  64. package/packages/orq-rc/src/models/components/evaluatorresponsetypescript.ts +2 -2
  65. package/packages/orq-rc/src/models/components/getnotifierresponse.ts +35 -0
  66. package/packages/orq-rc/src/models/components/gettraceresponse.ts +32 -0
  67. package/packages/orq-rc/src/models/components/gettracespanresponse.ts +32 -0
  68. package/packages/orq-rc/src/models/components/index.ts +36 -0
  69. package/packages/orq-rc/src/models/components/listnotifiersresponse.ts +50 -0
  70. package/packages/orq-rc/src/models/components/listtracefacetsresponse.ts +32 -0
  71. package/packages/orq-rc/src/models/components/listtracefacetvaluesresponse.ts +44 -0
  72. package/packages/orq-rc/src/models/components/listtracefieldsresponse.ts +32 -0
  73. package/packages/orq-rc/src/models/components/listtracespansresponse.ts +44 -0
  74. package/packages/orq-rc/src/models/components/notifier.ts +465 -0
  75. package/packages/orq-rc/src/models/components/notifiertype.ts +21 -0
  76. package/packages/orq-rc/src/models/components/querytracesrequest.ts +48 -0
  77. package/packages/orq-rc/src/models/components/querytracesresponse.ts +37 -0
  78. package/packages/orq-rc/src/models/components/reasoningpart.ts +1 -1
  79. package/packages/orq-rc/src/models/components/searchtracesrequest.ts +68 -0
  80. package/packages/orq-rc/src/models/components/searchtracesresponse.ts +72 -0
  81. package/packages/orq-rc/src/models/components/spandetail.ts +53 -0
  82. package/packages/orq-rc/src/models/components/spansummary.ts +76 -0
  83. package/packages/orq-rc/src/models/components/traceagent.ts +33 -0
  84. package/packages/orq-rc/src/models/components/traceaggregaterow.ts +33 -0
  85. package/packages/orq-rc/src/models/components/tracecompute.ts +30 -0
  86. package/packages/orq-rc/src/models/components/tracecontext.ts +39 -0
  87. package/packages/orq-rc/src/models/components/tracecost.ts +77 -0
  88. package/packages/orq-rc/src/models/components/tracefacet.ts +35 -0
  89. package/packages/orq-rc/src/models/components/tracefacetvalue.ts +33 -0
  90. package/packages/orq-rc/src/models/components/tracefield.ts +56 -0
  91. package/packages/orq-rc/src/models/components/tracefilter.ts +33 -0
  92. package/packages/orq-rc/src/models/components/tracesearchmeta.ts +45 -0
  93. package/packages/orq-rc/src/models/components/tracesort.ts +30 -0
  94. package/packages/orq-rc/src/models/components/tracesummary.ts +152 -0
  95. package/packages/orq-rc/src/models/components/traceusage.ts +62 -0
  96. package/packages/orq-rc/src/models/components/updatenotifierrequest.ts +130 -0
  97. package/packages/orq-rc/src/models/components/updatenotifierresponse.ts +35 -0
  98. package/packages/orq-rc/src/models/operations/createagentrequest.ts +77 -0
  99. package/packages/orq-rc/src/models/operations/createdataset.ts +1 -1
  100. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +4 -4
  101. package/packages/orq-rc/src/models/operations/createdatasource.ts +1 -1
  102. package/packages/orq-rc/src/models/operations/createprompt.ts +2 -0
  103. package/packages/orq-rc/src/models/operations/createtool.ts +6 -6
  104. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +2 -0
  105. package/packages/orq-rc/src/models/operations/deployments.ts +2 -0
  106. package/packages/orq-rc/src/models/operations/deploymentstream.ts +2 -0
  107. package/packages/orq-rc/src/models/operations/getallprompts.ts +2 -0
  108. package/packages/orq-rc/src/models/operations/getalltools.ts +6 -6
  109. package/packages/orq-rc/src/models/operations/getoneprompt.ts +2 -0
  110. package/packages/orq-rc/src/models/operations/getpromptversion.ts +2 -0
  111. package/packages/orq-rc/src/models/operations/getv2humanevalsets.ts +2 -2
  112. package/packages/orq-rc/src/models/operations/getv2humanevalsetsid.ts +2 -2
  113. package/packages/orq-rc/src/models/operations/index.ts +8 -0
  114. package/packages/orq-rc/src/models/operations/listagents.ts +5 -0
  115. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +4 -4
  116. package/packages/orq-rc/src/models/operations/listdatasets.ts +1 -1
  117. package/packages/orq-rc/src/models/operations/listdatasources.ts +1 -1
  118. package/packages/orq-rc/src/models/operations/listpromptversions.ts +2 -0
  119. package/packages/orq-rc/src/models/operations/notifierdelete.ts +36 -0
  120. package/packages/orq-rc/src/models/operations/notifierget.ts +36 -0
  121. package/packages/orq-rc/src/models/operations/notifierlist.ts +59 -0
  122. package/packages/orq-rc/src/models/operations/notifierupdate.ts +41 -0
  123. package/packages/orq-rc/src/models/operations/patchv2humanevalsetsid.ts +2 -2
  124. package/packages/orq-rc/src/models/operations/postv2feedbackevaluation.ts +3 -3
  125. package/packages/orq-rc/src/models/operations/postv2humanevalsets.ts +2 -2
  126. package/packages/orq-rc/src/models/operations/retrieveagentrequest.ts +5 -0
  127. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +4 -4
  128. package/packages/orq-rc/src/models/operations/retrievedataset.ts +1 -1
  129. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +1 -1
  130. package/packages/orq-rc/src/models/operations/retrievetool.ts +6 -6
  131. package/packages/orq-rc/src/models/operations/runagent.ts +67 -1
  132. package/packages/orq-rc/src/models/operations/streamrunagent.ts +67 -1
  133. package/packages/orq-rc/src/models/operations/tracesget.ts +36 -0
  134. package/packages/orq-rc/src/models/operations/tracesgetspan.ts +40 -0
  135. package/packages/orq-rc/src/models/operations/traceslistfacetvalues.ts +50 -0
  136. package/packages/orq-rc/src/models/operations/traceslistspans.ts +43 -0
  137. package/packages/orq-rc/src/models/operations/updateagent.ts +77 -0
  138. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +4 -4
  139. package/packages/orq-rc/src/models/operations/updatedataset.ts +1 -1
  140. package/packages/orq-rc/src/models/operations/updatedatasource.ts +1 -1
  141. package/packages/orq-rc/src/models/operations/updateprompt.ts +2 -0
  142. package/packages/orq-rc/src/models/operations/updatetool.ts +7 -7
  143. package/packages/orq-rc/src/sdk/feedback.ts +2 -2
  144. package/packages/orq-rc/src/sdk/notifiers.ts +100 -0
  145. package/packages/orq-rc/src/sdk/sdk.ts +12 -0
  146. package/packages/orq-rc/src/sdk/traces.ts +168 -0
  147. package/sdk/feedback.d.ts +2 -2
  148. package/sdk/feedback.js +2 -2
  149. package/src/lib/config.ts +2 -2
  150. package/src/models/components/evaluatorresponsefunction.ts +2 -2
  151. package/src/models/components/evaluatorresponsehttp.ts +2 -2
  152. package/src/models/components/evaluatorresponsejsonschema.ts +2 -2
  153. package/src/models/components/evaluatorresponsellm.ts +2 -2
  154. package/src/models/components/evaluatorresponsepython.ts +2 -2
  155. package/src/models/components/evaluatorresponseragas.ts +2 -2
  156. package/src/models/components/evaluatorresponsetypescript.ts +2 -2
  157. package/src/models/components/reasoningpart.ts +1 -1
  158. package/src/models/operations/createdataset.ts +1 -1
  159. package/src/models/operations/createdatasetitem.ts +4 -4
  160. package/src/models/operations/createdatasource.ts +1 -1
  161. package/src/models/operations/createtool.ts +6 -6
  162. package/src/models/operations/getalltools.ts +6 -6
  163. package/src/models/operations/getv2humanevalsets.ts +2 -2
  164. package/src/models/operations/getv2humanevalsetsid.ts +2 -2
  165. package/src/models/operations/listdatasetdatapoints.ts +4 -4
  166. package/src/models/operations/listdatasets.ts +1 -1
  167. package/src/models/operations/listdatasources.ts +1 -1
  168. package/src/models/operations/patchv2humanevalsetsid.ts +2 -2
  169. package/src/models/operations/postv2feedbackevaluation.ts +3 -3
  170. package/src/models/operations/postv2humanevalsets.ts +2 -2
  171. package/src/models/operations/retrievedatapoint.ts +4 -4
  172. package/src/models/operations/retrievedataset.ts +1 -1
  173. package/src/models/operations/retrievedatasource.ts +1 -1
  174. package/src/models/operations/retrievetool.ts +6 -6
  175. package/src/models/operations/runagent.ts +1 -1
  176. package/src/models/operations/streamrunagent.ts +1 -1
  177. package/src/models/operations/updatedatapoint.ts +4 -4
  178. package/src/models/operations/updatedataset.ts +1 -1
  179. package/src/models/operations/updatedatasource.ts +1 -1
  180. package/src/models/operations/updatetool.ts +7 -7
  181. package/src/sdk/feedback.ts +2 -2
@@ -0,0 +1,152 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { ClosedEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+ import { TraceAgent, TraceAgent$inboundSchema } from "./traceagent.js";
12
+ import { TraceContext, TraceContext$inboundSchema } from "./tracecontext.js";
13
+ import { TraceCost, TraceCost$inboundSchema } from "./tracecost.js";
14
+ import { TraceUsage, TraceUsage$inboundSchema } from "./traceusage.js";
15
+
16
+ /**
17
+ * Object discriminator; always `trace`.
18
+ */
19
+ export const TraceSummaryObject = {
20
+ Trace: "trace",
21
+ } as const;
22
+ /**
23
+ * Object discriminator; always `trace`.
24
+ */
25
+ export type TraceSummaryObject = ClosedEnum<typeof TraceSummaryObject>;
26
+
27
+ export type Attributes = {};
28
+
29
+ export type TraceSummary = {
30
+ /**
31
+ * Object discriminator; always `trace`.
32
+ */
33
+ object?: TraceSummaryObject | undefined;
34
+ traceId?: string | undefined;
35
+ rootSpanId?: string | undefined;
36
+ leadingSpanId?: string | undefined;
37
+ name?: string | undefined;
38
+ operation?: string | undefined;
39
+ status?: string | undefined;
40
+ startedAt?: Date | undefined;
41
+ endedAt?: Date | undefined;
42
+ durationMs?: number | undefined;
43
+ projectId?: string | undefined;
44
+ identityId?: string | undefined;
45
+ sessionId?: string | undefined;
46
+ threadId?: string | undefined;
47
+ product?: string | undefined;
48
+ providers?: Array<string> | undefined;
49
+ models?: Array<string> | undefined;
50
+ agent?: TraceAgent | undefined;
51
+ usage?: TraceUsage | undefined;
52
+ cost?: TraceCost | undefined;
53
+ id?: string | undefined;
54
+ spanId?: string | undefined;
55
+ parentId?: string | undefined;
56
+ type?: string | undefined;
57
+ context?: TraceContext | undefined;
58
+ attributes?: Attributes | undefined;
59
+ startTime?: Date | undefined;
60
+ endTime?: Date | undefined;
61
+ duration?: number | undefined;
62
+ };
63
+
64
+ /** @internal */
65
+ export const TraceSummaryObject$inboundSchema: z.ZodNativeEnum<
66
+ typeof TraceSummaryObject
67
+ > = z.nativeEnum(TraceSummaryObject);
68
+
69
+ /** @internal */
70
+ export const Attributes$inboundSchema: z.ZodType<
71
+ Attributes,
72
+ z.ZodTypeDef,
73
+ unknown
74
+ > = z.object({});
75
+
76
+ export function attributesFromJSON(
77
+ jsonString: string,
78
+ ): SafeParseResult<Attributes, SDKValidationError> {
79
+ return safeParse(
80
+ jsonString,
81
+ (x) => Attributes$inboundSchema.parse(JSON.parse(x)),
82
+ `Failed to parse 'Attributes' from JSON`,
83
+ );
84
+ }
85
+
86
+ /** @internal */
87
+ export const TraceSummary$inboundSchema: z.ZodType<
88
+ TraceSummary,
89
+ z.ZodTypeDef,
90
+ unknown
91
+ > = z.object({
92
+ object: TraceSummaryObject$inboundSchema.optional(),
93
+ trace_id: z.string().optional(),
94
+ root_span_id: z.string().optional(),
95
+ leading_span_id: z.string().optional(),
96
+ name: z.string().optional(),
97
+ operation: z.string().optional(),
98
+ status: z.string().optional(),
99
+ started_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
100
+ .optional(),
101
+ ended_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
102
+ .optional(),
103
+ duration_ms: z.number().optional(),
104
+ project_id: z.string().optional(),
105
+ identity_id: z.string().optional(),
106
+ session_id: z.string().optional(),
107
+ thread_id: z.string().optional(),
108
+ product: z.string().optional(),
109
+ providers: z.array(z.string()).optional(),
110
+ models: z.array(z.string()).optional(),
111
+ agent: TraceAgent$inboundSchema.optional(),
112
+ usage: TraceUsage$inboundSchema.optional(),
113
+ cost: TraceCost$inboundSchema.optional(),
114
+ id: z.string().optional(),
115
+ span_id: z.string().optional(),
116
+ parent_id: z.string().optional(),
117
+ type: z.string().optional(),
118
+ context: TraceContext$inboundSchema.optional(),
119
+ attributes: z.lazy(() => Attributes$inboundSchema).optional(),
120
+ start_time: z.string().datetime({ offset: true }).transform(v => new Date(v))
121
+ .optional(),
122
+ end_time: z.string().datetime({ offset: true }).transform(v => new Date(v))
123
+ .optional(),
124
+ duration: z.number().optional(),
125
+ }).transform((v) => {
126
+ return remap$(v, {
127
+ "trace_id": "traceId",
128
+ "root_span_id": "rootSpanId",
129
+ "leading_span_id": "leadingSpanId",
130
+ "started_at": "startedAt",
131
+ "ended_at": "endedAt",
132
+ "duration_ms": "durationMs",
133
+ "project_id": "projectId",
134
+ "identity_id": "identityId",
135
+ "session_id": "sessionId",
136
+ "thread_id": "threadId",
137
+ "span_id": "spanId",
138
+ "parent_id": "parentId",
139
+ "start_time": "startTime",
140
+ "end_time": "endTime",
141
+ });
142
+ });
143
+
144
+ export function traceSummaryFromJSON(
145
+ jsonString: string,
146
+ ): SafeParseResult<TraceSummary, SDKValidationError> {
147
+ return safeParse(
148
+ jsonString,
149
+ (x) => TraceSummary$inboundSchema.parse(JSON.parse(x)),
150
+ `Failed to parse 'TraceSummary' from JSON`,
151
+ );
152
+ }
@@ -0,0 +1,62 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+
11
+ export type TraceUsage = {
12
+ promptTokens?: number | undefined;
13
+ completionTokens?: number | undefined;
14
+ totalTokens?: number | undefined;
15
+ promptCachedTokens?: number | undefined;
16
+ promptAudioTokens?: number | undefined;
17
+ completionReasoningTokens?: number | undefined;
18
+ completionAudioTokens?: number | undefined;
19
+ completionAcceptedPredictionTokens?: number | undefined;
20
+ completionRejectedPredictionTokens?: number | undefined;
21
+ };
22
+
23
+ /** @internal */
24
+ export const TraceUsage$inboundSchema: z.ZodType<
25
+ TraceUsage,
26
+ z.ZodTypeDef,
27
+ unknown
28
+ > = z.object({
29
+ prompt_tokens: z.number().int().optional(),
30
+ completion_tokens: z.number().int().optional(),
31
+ total_tokens: z.number().int().optional(),
32
+ prompt_cached_tokens: z.number().int().optional(),
33
+ prompt_audio_tokens: z.number().int().optional(),
34
+ completion_reasoning_tokens: z.number().int().optional(),
35
+ completion_audio_tokens: z.number().int().optional(),
36
+ completion_accepted_prediction_tokens: z.number().int().optional(),
37
+ completion_rejected_prediction_tokens: z.number().int().optional(),
38
+ }).transform((v) => {
39
+ return remap$(v, {
40
+ "prompt_tokens": "promptTokens",
41
+ "completion_tokens": "completionTokens",
42
+ "total_tokens": "totalTokens",
43
+ "prompt_cached_tokens": "promptCachedTokens",
44
+ "prompt_audio_tokens": "promptAudioTokens",
45
+ "completion_reasoning_tokens": "completionReasoningTokens",
46
+ "completion_audio_tokens": "completionAudioTokens",
47
+ "completion_accepted_prediction_tokens":
48
+ "completionAcceptedPredictionTokens",
49
+ "completion_rejected_prediction_tokens":
50
+ "completionRejectedPredictionTokens",
51
+ });
52
+ });
53
+
54
+ export function traceUsageFromJSON(
55
+ jsonString: string,
56
+ ): SafeParseResult<TraceUsage, SDKValidationError> {
57
+ return safeParse(
58
+ jsonString,
59
+ (x) => TraceUsage$inboundSchema.parse(JSON.parse(x)),
60
+ `Failed to parse 'TraceUsage' from JSON`,
61
+ );
62
+ }
@@ -0,0 +1,130 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { NotifierType, NotifierType$outboundSchema } from "./notifiertype.js";
8
+
9
+ /**
10
+ * Optional. Replacement custom JSON metadata.
11
+ */
12
+ export type UpdateNotifierRequestMetadata = {};
13
+
14
+ /**
15
+ * Optional replacement generic webhook headers. Secret header values returned by GET or LIST are masked as an empty string; omit those entries or replace them with the real value when updating.
16
+ */
17
+ export type Headers = {};
18
+
19
+ /**
20
+ * Partial notifier update. All request body fields are optional individually, but at least one field must be provided. When changing `type`, include the destination field required by the new type. Secret header values returned by GET or LIST are masked as an empty string; omit those entries or replace them with the real value when updating.
21
+ */
22
+ export type UpdateNotifierRequest = {
23
+ /**
24
+ * Optional. New containing project. Workspace-scoped callers may set an empty value to make the notifier workspace-wide. Project-scoped API keys remain pinned to the API key's project.
25
+ */
26
+ projectId?: string | undefined;
27
+ /**
28
+ * Optional. New human-readable notifier name.
29
+ */
30
+ displayName?: string | undefined;
31
+ /**
32
+ * Optional. Replacement custom JSON metadata.
33
+ */
34
+ metadata?: UpdateNotifierRequestMetadata | undefined;
35
+ type?: NotifierType | undefined;
36
+ /**
37
+ * Optional replacement email recipients. Required when changing `type` to `NOTIFIER_TYPE_EMAIL`.
38
+ */
39
+ emails?: Array<string> | undefined;
40
+ /**
41
+ * Optional replacement Slack incoming webhook URL. Required when changing `type` to `NOTIFIER_TYPE_SLACK_WEBHOOK`.
42
+ */
43
+ incomingWebhookUrl?: string | undefined;
44
+ /**
45
+ * Optional replacement generic webhook URL. Required when changing `type` to `NOTIFIER_TYPE_WEBHOOK`.
46
+ */
47
+ webhookUrl?: string | undefined;
48
+ /**
49
+ * Optional replacement generic webhook headers. Secret header values returned by GET or LIST are masked as an empty string; omit those entries or replace them with the real value when updating.
50
+ */
51
+ headers?: Headers | undefined;
52
+ };
53
+
54
+ /** @internal */
55
+ export type UpdateNotifierRequestMetadata$Outbound = {};
56
+
57
+ /** @internal */
58
+ export const UpdateNotifierRequestMetadata$outboundSchema: z.ZodType<
59
+ UpdateNotifierRequestMetadata$Outbound,
60
+ z.ZodTypeDef,
61
+ UpdateNotifierRequestMetadata
62
+ > = z.object({});
63
+
64
+ export function updateNotifierRequestMetadataToJSON(
65
+ updateNotifierRequestMetadata: UpdateNotifierRequestMetadata,
66
+ ): string {
67
+ return JSON.stringify(
68
+ UpdateNotifierRequestMetadata$outboundSchema.parse(
69
+ updateNotifierRequestMetadata,
70
+ ),
71
+ );
72
+ }
73
+
74
+ /** @internal */
75
+ export type Headers$Outbound = {};
76
+
77
+ /** @internal */
78
+ export const Headers$outboundSchema: z.ZodType<
79
+ Headers$Outbound,
80
+ z.ZodTypeDef,
81
+ Headers
82
+ > = z.object({});
83
+
84
+ export function headersToJSON(headers: Headers): string {
85
+ return JSON.stringify(Headers$outboundSchema.parse(headers));
86
+ }
87
+
88
+ /** @internal */
89
+ export type UpdateNotifierRequest$Outbound = {
90
+ project_id?: string | undefined;
91
+ display_name?: string | undefined;
92
+ metadata?: UpdateNotifierRequestMetadata$Outbound | undefined;
93
+ type?: string | undefined;
94
+ emails?: Array<string> | undefined;
95
+ incoming_webhook_url?: string | undefined;
96
+ webhook_url?: string | undefined;
97
+ headers?: Headers$Outbound | undefined;
98
+ };
99
+
100
+ /** @internal */
101
+ export const UpdateNotifierRequest$outboundSchema: z.ZodType<
102
+ UpdateNotifierRequest$Outbound,
103
+ z.ZodTypeDef,
104
+ UpdateNotifierRequest
105
+ > = z.object({
106
+ projectId: z.string().optional(),
107
+ displayName: z.string().optional(),
108
+ metadata: z.lazy(() => UpdateNotifierRequestMetadata$outboundSchema)
109
+ .optional(),
110
+ type: NotifierType$outboundSchema.optional(),
111
+ emails: z.array(z.string()).optional(),
112
+ incomingWebhookUrl: z.string().optional(),
113
+ webhookUrl: z.string().optional(),
114
+ headers: z.lazy(() => Headers$outboundSchema).optional(),
115
+ }).transform((v) => {
116
+ return remap$(v, {
117
+ projectId: "project_id",
118
+ displayName: "display_name",
119
+ incomingWebhookUrl: "incoming_webhook_url",
120
+ webhookUrl: "webhook_url",
121
+ });
122
+ });
123
+
124
+ export function updateNotifierRequestToJSON(
125
+ updateNotifierRequest: UpdateNotifierRequest,
126
+ ): string {
127
+ return JSON.stringify(
128
+ UpdateNotifierRequest$outboundSchema.parse(updateNotifierRequest),
129
+ );
130
+ }
@@ -0,0 +1,35 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+ import { Notifier, Notifier$inboundSchema } from "./notifier.js";
10
+
11
+ export type UpdateNotifierResponse = {
12
+ /**
13
+ * Notifier resource. The destination field present on the resource depends on `type` and is captured in `oneOf`.
14
+ */
15
+ notifier: Notifier;
16
+ };
17
+
18
+ /** @internal */
19
+ export const UpdateNotifierResponse$inboundSchema: z.ZodType<
20
+ UpdateNotifierResponse,
21
+ z.ZodTypeDef,
22
+ unknown
23
+ > = z.object({
24
+ notifier: Notifier$inboundSchema,
25
+ });
26
+
27
+ export function updateNotifierResponseFromJSON(
28
+ jsonString: string,
29
+ ): SafeParseResult<UpdateNotifierResponse, SDKValidationError> {
30
+ return safeParse(
31
+ jsonString,
32
+ (x) => UpdateNotifierResponse$inboundSchema.parse(JSON.parse(x)),
33
+ `Failed to parse 'UpdateNotifierResponse' from JSON`,
34
+ );
35
+ }