diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index ca8df252..16930556 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 6a2d7b70-1321-499a-8677-a99a42c2e4b6 management: - docChecksum: 1cf21ef1e0362daa534ba0a0c24a7cf8 + docChecksum: d98f0589e147bdaa0eed5cc27427a177 docVersion: 0.0.1 - speakeasyVersion: 1.609.0 - generationVersion: 2.692.0 - releaseVersion: 1.0.11 - configChecksum: 5266f713dc28311d477d2368626e6306 + speakeasyVersion: 1.611.1 + generationVersion: 2.694.1 + releaseVersion: 1.0.12 + configChecksum: 0138ba3c317d3adf0bd1edce3e2ced75 repoURL: https://github.com/firehydrant/firehydrant-typescript-sdk.git installationURL: https://github.com/firehydrant/firehydrant-typescript-sdk published: true @@ -189,6 +189,8 @@ generatedFiles: - docs/models/components/createsignalseventsource.md - docs/models/components/createsignalseventsourcedata.md - docs/models/components/createsignalseventsourceexamplepayload.md + - docs/models/components/createsignalspage.md + - docs/models/components/createsignalspagetargettype.md - docs/models/components/createsignalswebhooktarget.md - docs/models/components/createstatusupdatetemplate.md - docs/models/components/createtasklist.md @@ -869,7 +871,6 @@ generatedFiles: - docs/models/operations/createsavedsearchrequest.md - docs/models/operations/createsavedsearchresourcetype.md - docs/models/operations/createservicechecklistresponserequest.md - - docs/models/operations/createsignalspagerequest.md - docs/models/operations/createslackemojiactionrequest.md - docs/models/operations/createslackemojiactionrequestbody.md - docs/models/operations/createteamcallrouterequest.md @@ -2334,6 +2335,7 @@ generatedFiles: - src/models/components/createsignalsalertgroupingconfiguration.ts - src/models/components/createsignalsemailtarget.ts - src/models/components/createsignalseventsource.ts + - src/models/components/createsignalspage.ts - src/models/components/createsignalswebhooktarget.ts - src/models/components/createstatusupdatetemplate.ts - src/models/components/createtasklist.ts @@ -2753,7 +2755,6 @@ generatedFiles: - src/models/operations/createretrospectivetemplate.ts - src/models/operations/createsavedsearch.ts - src/models/operations/createservicechecklistresponse.ts - - src/models/operations/createsignalspage.ts - src/models/operations/createslackemojiaction.ts - src/models/operations/createteamcallroute.ts - src/models/operations/createteamescalationpolicy.ts @@ -6533,7 +6534,7 @@ examples: create_signals_page: speakeasy-default-create-signals-page: requestBody: - application/json: {"summary": "", "target_type": "", "target_id": ""} + application/json: {"summary": "", "target_type": "Team", "target_id": ""} responses: "201": application/json: {"signal_rule": {"deduplication_expiry": "PT1H"}, "parent_alerts": [{"signal_rule": {"deduplication_expiry": "PT1H"}}], "child_alerts": [{"signal_rule": {"deduplication_expiry": "PT1H"}}]} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 9545e6cd..24454af1 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -24,7 +24,7 @@ generation: generateNewTests: false skipResponseBodyAssertions: false typescript: - version: 1.0.11 + version: 1.0.12 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 6f4449bd..ce454997 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,12 +1,12 @@ -speakeasyVersion: 1.609.0 +speakeasyVersion: 1.611.1 sources: firehydrant-oas: sourceNamespace: firehydrant-oas - sourceRevisionDigest: sha256:cbef1c238eb886da937d1aae09079b8ead60ef48be68c6be2041bac02b4669cc - sourceBlobDigest: sha256:40ca76a505d6c9874d8090f0d7233da5ec156cbece9db3e44bb981476d664adb + sourceRevisionDigest: sha256:9ddb1fbf020580abbc605fc16e26c2812394843829e83e9a4a2351517671b7d1 + sourceBlobDigest: sha256:d5e508b1863ed82d155c14cea424ea4c5d5c1242f3ee0d1304c807405c5c1f6e tags: - latest - - speakeasy-sdk-regen-1756858033 + - speakeasy-sdk-regen-1757117239 - 0.0.1 firehydrant-typescript-sdk-OAS: sourceNamespace: firehydrant-typescript-sdk-oas @@ -19,10 +19,10 @@ targets: firehydrant-typescript-sdk: source: firehydrant-oas sourceNamespace: firehydrant-oas - sourceRevisionDigest: sha256:cbef1c238eb886da937d1aae09079b8ead60ef48be68c6be2041bac02b4669cc - sourceBlobDigest: sha256:40ca76a505d6c9874d8090f0d7233da5ec156cbece9db3e44bb981476d664adb + sourceRevisionDigest: sha256:9ddb1fbf020580abbc605fc16e26c2812394843829e83e9a4a2351517671b7d1 + sourceBlobDigest: sha256:d5e508b1863ed82d155c14cea424ea4c5d5c1242f3ee0d1304c807405c5c1f6e codeSamplesNamespace: firehydrant-typescript-sdk-oas-code-samples - codeSamplesRevisionDigest: sha256:7109c5ce1b1136e7e8119a57f7b858f6a263c0447e2c80056d55a782046589aa + codeSamplesRevisionDigest: sha256:c3074a60391067a6989a710e18e556afad2c83aafc67a64bc520dac9b02c5fb7 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index 40df807a..ce9d9a6c 100644 --- a/README.md +++ b/README.md @@ -612,7 +612,7 @@ run(); ### [pages](docs/sdks/pages/README.md) -* [createSignalsPage](docs/sdks/pages/README.md#createsignalspage) - Pages a target +* [createSignalsPage](docs/sdks/pages/README.md#createsignalspage) - Page a user, team, on-call schedule, or escalation policy ### [permissions](docs/sdks/permissions/README.md) @@ -1116,7 +1116,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). - [`metricsReportingListSavedSearches`](docs/sdks/metricsreporting/README.md#listsavedsearches) - List saved searches - [`metricsReportingListUserInvolvementMetrics`](docs/sdks/metricsreporting/README.md#listuserinvolvementmetrics) - List user metrics - [`metricsReportingUpdateSavedSearch`](docs/sdks/metricsreporting/README.md#updatesavedsearch) - Update a saved search -- [`pagesCreateSignalsPage`](docs/sdks/pages/README.md#createsignalspage) - Pages a target +- [`pagesCreateSignalsPage`](docs/sdks/pages/README.md#createsignalspage) - Page a user, team, on-call schedule, or escalation policy - [`permissionsListCurrentUserPermissions`](docs/sdks/permissions/README.md#listcurrentuserpermissions) - Get all permissions for the current user - [`permissionsListPermissions`](docs/sdks/permissions/README.md#listpermissions) - List permissions - [`permissionsListTeamPermissions`](docs/sdks/permissions/README.md#listteampermissions) - Get all permissions for a team diff --git a/RELEASES.md b/RELEASES.md index e7c71b7b..95477d44 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -206,4 +206,14 @@ Based on: ### Generated - [typescript v1.0.11] . ### Releases -- [NPM v1.0.11] https://www.npmjs.com/package/firehydrant-typescript-sdk/v/1.0.11 - . \ No newline at end of file +- [NPM v1.0.11] https://www.npmjs.com/package/firehydrant-typescript-sdk/v/1.0.11 - . + +## 2025-09-08 00:07:59 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.611.1 (2.694.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v1.0.12] . +### Releases +- [NPM v1.0.12] https://www.npmjs.com/package/firehydrant-typescript-sdk/v/1.0.12 - . \ No newline at end of file diff --git a/docs/models/components/createsignalspage.md b/docs/models/components/createsignalspage.md new file mode 100644 index 00000000..46fbf1a8 --- /dev/null +++ b/docs/models/components/createsignalspage.md @@ -0,0 +1,24 @@ +# CreateSignalsPage + +Used for paging an on-call target within FireHydrant's signals product. This can be used for paging users, teams, on-call schedules, and escalation policies. + +## Example Usage + +```typescript +import { CreateSignalsPage } from "firehydrant-typescript-sdk/models/components"; + +let value: CreateSignalsPage = { + summary: "", + targetType: "OnCallSchedule", + targetId: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `summary` | *string* | :heavy_check_mark: | N/A | +| `targetType` | [components.CreateSignalsPageTargetType](../../models/components/createsignalspagetargettype.md) | :heavy_check_mark: | N/A | +| `targetId` | *string* | :heavy_check_mark: | The ID of the target. Should be a UUID for the target type. | +| `body` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/createsignalspagetargettype.md b/docs/models/components/createsignalspagetargettype.md new file mode 100644 index 00000000..9bd4b504 --- /dev/null +++ b/docs/models/components/createsignalspagetargettype.md @@ -0,0 +1,15 @@ +# CreateSignalsPageTargetType + +## Example Usage + +```typescript +import { CreateSignalsPageTargetType } from "firehydrant-typescript-sdk/models/components"; + +let value: CreateSignalsPageTargetType = "EscalationPolicy"; +``` + +## Values + +```typescript +"EscalationPolicy" | "OnCallSchedule" | "Team" | "User" +``` \ No newline at end of file diff --git a/docs/models/operations/createsignalspagerequest.md b/docs/models/operations/createsignalspagerequest.md deleted file mode 100644 index f8186e1b..00000000 --- a/docs/models/operations/createsignalspagerequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# CreateSignalsPageRequest - -## Example Usage - -```typescript -import { CreateSignalsPageRequest } from "firehydrant-typescript-sdk/models/operations"; - -let value: CreateSignalsPageRequest = { - summary: "", - targetType: "", - targetId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `summary` | *string* | :heavy_check_mark: | N/A | -| `targetType` | *string* | :heavy_check_mark: | N/A | -| `targetId` | *string* | :heavy_check_mark: | N/A | -| `body` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/sdks/pages/README.md b/docs/sdks/pages/README.md index 7d938826..0cf6006a 100644 --- a/docs/sdks/pages/README.md +++ b/docs/sdks/pages/README.md @@ -7,11 +7,11 @@ Operations about Pages ### Available Operations -* [createSignalsPage](#createsignalspage) - Pages a target +* [createSignalsPage](#createsignalspage) - Page a user, team, on-call schedule, or escalation policy ## createSignalsPage -Pages a target +Used for paging an on-call target within FireHydrant's signals product. This can be used for paging users, teams, on-call schedules, and escalation policies. ### Example Usage @@ -26,7 +26,7 @@ const firehydrant = new Firehydrant({ async function run() { const result = await firehydrant.pages.createSignalsPage({ summary: "", - targetType: "", + targetType: "Team", targetId: "", }); @@ -53,7 +53,7 @@ const firehydrant = new FirehydrantCore({ async function run() { const res = await pagesCreateSignalsPage(firehydrant, { summary: "", - targetType: "", + targetType: "Team", targetId: "", }); if (res.ok) { @@ -71,7 +71,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateSignalsPageRequest](../../models/operations/createsignalspagerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [components.CreateSignalsPage](../../models/components/createsignalspage.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | diff --git a/examples/package-lock.json b/examples/package-lock.json index 5f6aa502..7932503b 100644 --- a/examples/package-lock.json +++ b/examples/package-lock.json @@ -18,7 +18,7 @@ }, "..": { "name": "firehydrant-typescript-sdk", - "version": "1.0.11", + "version": "1.0.12", "dependencies": { "zod": "^3.20.0" }, diff --git a/jsr.json b/jsr.json index 063a5b84..47a58572 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "firehydrant-typescript-sdk", - "version": "1.0.11", + "version": "1.0.12", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 1b2e03a0..f968249e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "firehydrant-typescript-sdk", - "version": "1.0.11", + "version": "1.0.12", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "firehydrant-typescript-sdk", - "version": "1.0.11", + "version": "1.0.12", "dependencies": { "zod": "^3.20.0" }, diff --git a/package.json b/package.json index e2480637..a6054483 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "firehydrant-typescript-sdk", - "version": "1.0.11", + "version": "1.0.12", "author": "Firehydrant", "type": "module", "bin": { diff --git a/src/funcs/pagesCreateSignalsPage.ts b/src/funcs/pagesCreateSignalsPage.ts index 6acff8e8..b9a66635 100644 --- a/src/funcs/pagesCreateSignalsPage.ts +++ b/src/funcs/pagesCreateSignalsPage.ts @@ -21,19 +21,18 @@ import { } from "../models/errors/httpclienterrors.js"; import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; import { APICall, APIPromise } from "../types/async.js"; import { Result } from "../types/fp.js"; /** - * Pages a target + * Page a user, team, on-call schedule, or escalation policy * * @remarks - * Pages a target + * Used for paging an on-call target within FireHydrant's signals product. This can be used for paging users, teams, on-call schedules, and escalation policies. */ export function pagesCreateSignalsPage( client: FirehydrantCore, - request: operations.CreateSignalsPageRequest, + request: components.CreateSignalsPage, options?: RequestOptions, ): APIPromise< Result< @@ -57,7 +56,7 @@ export function pagesCreateSignalsPage( async function $do( client: FirehydrantCore, - request: operations.CreateSignalsPageRequest, + request: components.CreateSignalsPage, options?: RequestOptions, ): Promise< [ @@ -77,7 +76,7 @@ async function $do( > { const parsed = safeParse( request, - (value) => operations.CreateSignalsPageRequest$outboundSchema.parse(value), + (value) => components.CreateSignalsPage$outboundSchema.parse(value), "Input validation failed", ); if (!parsed.ok) { diff --git a/src/lib/config.ts b/src/lib/config.ts index 40b654f2..a77803b6 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -58,8 +58,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.0.1", - sdkVersion: "1.0.11", - genVersion: "2.692.0", + sdkVersion: "1.0.12", + genVersion: "2.694.1", userAgent: - "speakeasy-sdk/typescript 1.0.11 2.692.0 0.0.1 firehydrant-typescript-sdk", + "speakeasy-sdk/typescript 1.0.12 2.694.1 0.0.1 firehydrant-typescript-sdk", } as const; diff --git a/src/mcp-server/mcp-server.ts b/src/mcp-server/mcp-server.ts index f1f97974..cda2b189 100644 --- a/src/mcp-server/mcp-server.ts +++ b/src/mcp-server/mcp-server.ts @@ -19,7 +19,7 @@ const routes = buildRouteMap({ export const app = buildApplication(routes, { name: "mcp", versionInfo: { - currentVersion: "1.0.11", + currentVersion: "1.0.12", }, }); diff --git a/src/mcp-server/server.ts b/src/mcp-server/server.ts index f2af10e5..67f86472 100644 --- a/src/mcp-server/server.ts +++ b/src/mcp-server/server.ts @@ -473,7 +473,7 @@ export function createMCPServer(deps: { }) { const server = new McpServer({ name: "Firehydrant", - version: "1.0.11", + version: "1.0.12", }); const client = new FirehydrantCore({ diff --git a/src/mcp-server/tools/pagesCreateSignalsPage.ts b/src/mcp-server/tools/pagesCreateSignalsPage.ts index 25d1fdf2..b7e3e9d1 100644 --- a/src/mcp-server/tools/pagesCreateSignalsPage.ts +++ b/src/mcp-server/tools/pagesCreateSignalsPage.ts @@ -3,18 +3,18 @@ */ import { pagesCreateSignalsPage } from "../../funcs/pagesCreateSignalsPage.js"; -import * as operations from "../../models/operations/index.js"; +import * as components from "../../models/components/index.js"; import { formatResult, ToolDefinition } from "../tools.js"; const args = { - request: operations.CreateSignalsPageRequest$inboundSchema, + request: components.CreateSignalsPage$inboundSchema, }; export const tool$pagesCreateSignalsPage: ToolDefinition = { name: "pages-create-signals-page", - description: `Pages a target + description: `Page a user, team, on-call schedule, or escalation policy -Pages a target`, +Used for paging an on-call target within FireHydrant's signals product. This can be used for paging users, teams, on-call schedules, and escalation policies.`, args, tool: async (client, args, ctx) => { const [result, apiCall] = await pagesCreateSignalsPage( diff --git a/src/models/components/createsignalspage.ts b/src/models/components/createsignalspage.ts new file mode 100644 index 00000000..fb83a409 --- /dev/null +++ b/src/models/components/createsignalspage.ts @@ -0,0 +1,127 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../lib/primitives.js"; +import { safeParse } from "../../lib/schemas.js"; +import { ClosedEnum } from "../../types/enums.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export const CreateSignalsPageTargetType = { + EscalationPolicy: "EscalationPolicy", + OnCallSchedule: "OnCallSchedule", + Team: "Team", + User: "User", +} as const; +export type CreateSignalsPageTargetType = ClosedEnum< + typeof CreateSignalsPageTargetType +>; + +/** + * Used for paging an on-call target within FireHydrant's signals product. This can be used for paging users, teams, on-call schedules, and escalation policies. + */ +export type CreateSignalsPage = { + summary: string; + targetType: CreateSignalsPageTargetType; + /** + * The ID of the target. Should be a UUID for the target type. + */ + targetId: string; + body?: string | null | undefined; +}; + +/** @internal */ +export const CreateSignalsPageTargetType$inboundSchema: z.ZodNativeEnum< + typeof CreateSignalsPageTargetType +> = z.nativeEnum(CreateSignalsPageTargetType); + +/** @internal */ +export const CreateSignalsPageTargetType$outboundSchema: z.ZodNativeEnum< + typeof CreateSignalsPageTargetType +> = CreateSignalsPageTargetType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CreateSignalsPageTargetType$ { + /** @deprecated use `CreateSignalsPageTargetType$inboundSchema` instead. */ + export const inboundSchema = CreateSignalsPageTargetType$inboundSchema; + /** @deprecated use `CreateSignalsPageTargetType$outboundSchema` instead. */ + export const outboundSchema = CreateSignalsPageTargetType$outboundSchema; +} + +/** @internal */ +export const CreateSignalsPage$inboundSchema: z.ZodType< + CreateSignalsPage, + z.ZodTypeDef, + unknown +> = z.object({ + summary: z.string(), + target_type: CreateSignalsPageTargetType$inboundSchema, + target_id: z.string(), + body: z.nullable(z.string()).optional(), +}).transform((v) => { + return remap$(v, { + "target_type": "targetType", + "target_id": "targetId", + }); +}); + +/** @internal */ +export type CreateSignalsPage$Outbound = { + summary: string; + target_type: string; + target_id: string; + body?: string | null | undefined; +}; + +/** @internal */ +export const CreateSignalsPage$outboundSchema: z.ZodType< + CreateSignalsPage$Outbound, + z.ZodTypeDef, + CreateSignalsPage +> = z.object({ + summary: z.string(), + targetType: CreateSignalsPageTargetType$outboundSchema, + targetId: z.string(), + body: z.nullable(z.string()).optional(), +}).transform((v) => { + return remap$(v, { + targetType: "target_type", + targetId: "target_id", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CreateSignalsPage$ { + /** @deprecated use `CreateSignalsPage$inboundSchema` instead. */ + export const inboundSchema = CreateSignalsPage$inboundSchema; + /** @deprecated use `CreateSignalsPage$outboundSchema` instead. */ + export const outboundSchema = CreateSignalsPage$outboundSchema; + /** @deprecated use `CreateSignalsPage$Outbound` instead. */ + export type Outbound = CreateSignalsPage$Outbound; +} + +export function createSignalsPageToJSON( + createSignalsPage: CreateSignalsPage, +): string { + return JSON.stringify( + CreateSignalsPage$outboundSchema.parse(createSignalsPage), + ); +} + +export function createSignalsPageFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => CreateSignalsPage$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'CreateSignalsPage' from JSON`, + ); +} diff --git a/src/models/components/index.ts b/src/models/components/index.ts index 69176167..e57f73a3 100644 --- a/src/models/components/index.ts +++ b/src/models/components/index.ts @@ -79,6 +79,7 @@ export * from "./createseveritymatriximpact.js"; export * from "./createsignalsalertgroupingconfiguration.js"; export * from "./createsignalsemailtarget.js"; export * from "./createsignalseventsource.js"; +export * from "./createsignalspage.js"; export * from "./createsignalswebhooktarget.js"; export * from "./createstatusupdatetemplate.js"; export * from "./createtasklist.js"; diff --git a/src/models/operations/createsignalspage.ts b/src/models/operations/createsignalspage.ts deleted file mode 100644 index 50c64370..00000000 --- a/src/models/operations/createsignalspage.ts +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type CreateSignalsPageRequest = { - summary: string; - targetType: string; - targetId: string; - body?: string | null | undefined; -}; - -/** @internal */ -export const CreateSignalsPageRequest$inboundSchema: z.ZodType< - CreateSignalsPageRequest, - z.ZodTypeDef, - unknown -> = z.object({ - summary: z.string(), - target_type: z.string(), - target_id: z.string(), - body: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "target_type": "targetType", - "target_id": "targetId", - }); -}); - -/** @internal */ -export type CreateSignalsPageRequest$Outbound = { - summary: string; - target_type: string; - target_id: string; - body?: string | null | undefined; -}; - -/** @internal */ -export const CreateSignalsPageRequest$outboundSchema: z.ZodType< - CreateSignalsPageRequest$Outbound, - z.ZodTypeDef, - CreateSignalsPageRequest -> = z.object({ - summary: z.string(), - targetType: z.string(), - targetId: z.string(), - body: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - targetType: "target_type", - targetId: "target_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CreateSignalsPageRequest$ { - /** @deprecated use `CreateSignalsPageRequest$inboundSchema` instead. */ - export const inboundSchema = CreateSignalsPageRequest$inboundSchema; - /** @deprecated use `CreateSignalsPageRequest$outboundSchema` instead. */ - export const outboundSchema = CreateSignalsPageRequest$outboundSchema; - /** @deprecated use `CreateSignalsPageRequest$Outbound` instead. */ - export type Outbound = CreateSignalsPageRequest$Outbound; -} - -export function createSignalsPageRequestToJSON( - createSignalsPageRequest: CreateSignalsPageRequest, -): string { - return JSON.stringify( - CreateSignalsPageRequest$outboundSchema.parse(createSignalsPageRequest), - ); -} - -export function createSignalsPageRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CreateSignalsPageRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CreateSignalsPageRequest' from JSON`, - ); -} diff --git a/src/models/operations/index.ts b/src/models/operations/index.ts index d5f67a3d..aa5053d0 100644 --- a/src/models/operations/index.ts +++ b/src/models/operations/index.ts @@ -42,7 +42,6 @@ export * from "./createpostmortemreason.js"; export * from "./createretrospectivetemplate.js"; export * from "./createsavedsearch.js"; export * from "./createservicechecklistresponse.js"; -export * from "./createsignalspage.js"; export * from "./createslackemojiaction.js"; export * from "./createteamcallroute.js"; export * from "./createteamescalationpolicy.js"; diff --git a/src/sdk/pages.ts b/src/sdk/pages.ts index cc11fda3..93f794b3 100644 --- a/src/sdk/pages.ts +++ b/src/sdk/pages.ts @@ -5,18 +5,17 @@ import { pagesCreateSignalsPage } from "../funcs/pagesCreateSignalsPage.js"; import { ClientSDK, RequestOptions } from "../lib/sdks.js"; import * as components from "../models/components/index.js"; -import * as operations from "../models/operations/index.js"; import { unwrapAsync } from "../types/fp.js"; export class Pages extends ClientSDK { /** - * Pages a target + * Page a user, team, on-call schedule, or escalation policy * * @remarks - * Pages a target + * Used for paging an on-call target within FireHydrant's signals product. This can be used for paging users, teams, on-call schedules, and escalation policies. */ async createSignalsPage( - request: operations.CreateSignalsPageRequest, + request: components.CreateSignalsPage, options?: RequestOptions, ): Promise { return unwrapAsync(pagesCreateSignalsPage(