diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index d1a89249..1e481e50 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: 909ec237af1d3b3dca00dad03e0576bd + docChecksum: 5f0ec54777c11a6c24136f52886e9b22 docVersion: 0.0.1 - speakeasyVersion: 1.581.0 - generationVersion: 2.656.5 - releaseVersion: 1.0.4 - configChecksum: 8b9e0429dec5690c58c082e5dc5ede1f + speakeasyVersion: 1.583.0 + generationVersion: 2.658.3 + releaseVersion: 1.0.5 + configChecksum: 233e2a24d390d2d727e55b10845113f4 repoURL: https://github.com/firehydrant/firehydrant-typescript-sdk.git installationURL: https://github.com/firehydrant/firehydrant-typescript-sdk published: true @@ -149,6 +149,7 @@ generatedFiles: - docs/models/components/createscimuser.md - docs/models/components/createscimuseremail.md - docs/models/components/createscimusername.md + - docs/models/components/createscimuserphonenumber.md - docs/models/components/createscimuserroles.md - docs/models/components/createservice.md - docs/models/components/createservicechecklistresponse.md @@ -338,6 +339,7 @@ generatedFiles: - docs/models/components/lifecyclesphaseentity.md - docs/models/components/lifecyclesphaseentitylist.md - docs/models/components/linksentity.md + - docs/models/components/logic.md - docs/models/components/membershipentity.md - docs/models/components/messagetype.md - docs/models/components/metricsinfrastructurelistentity.md @@ -393,7 +395,6 @@ generatedFiles: - docs/models/components/nullablepostmortemsquestionentity.md - docs/models/components/nullablepublicapiv1incidentssuccinctentity.md - docs/models/components/nullablerulesruleentity.md - - docs/models/components/nullablerulesruleentitylogic.md - docs/models/components/nullablerunbooksactionconfigentity.md - docs/models/components/nullablerunbooksactionsentity.md - docs/models/components/nullablerunbooksactionsentitydefaultlogic.md @@ -592,7 +593,6 @@ generatedFiles: - docs/models/components/ticketingprojectconfigentitydetails.md - docs/models/components/ticketingprojectfieldmapbodyentity.md - docs/models/components/ticketingprojectfieldmapcasesentity.md - - docs/models/components/ticketingprojectfieldmapcasesentitylogic.md - docs/models/components/ticketingprojectfieldmapentity.md - docs/models/components/ticketingprojectinboundfieldmapentity.md - docs/models/components/ticketingprojectinboundmappablefieldentity.md @@ -676,6 +676,7 @@ generatedFiles: - docs/models/components/updatescimuser.md - docs/models/components/updatescimuseremail.md - docs/models/components/updatescimusername.md + - docs/models/components/updatescimuserphonenumber.md - docs/models/components/updatescimuserroles.md - docs/models/components/updateservice.md - docs/models/components/updateservicedependency.md diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 8b76f111..da659dac 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -24,7 +24,7 @@ generation: generateNewTests: false skipResponseBodyAssertions: false typescript: - version: 1.0.4 + version: 1.0.5 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 30769b94..c1a07968 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,12 +1,12 @@ -speakeasyVersion: 1.581.0 +speakeasyVersion: 1.583.0 sources: firehydrant-oas: sourceNamespace: firehydrant-oas - sourceRevisionDigest: sha256:8c12c752b241dc10e331b39cd8ea6c2696786668ca87acf7bf8d26702ade4b1a - sourceBlobDigest: sha256:780c8647ad2ad7441e16770f84736db03ce17ac6e96933f180621b48c1224e64 + sourceRevisionDigest: sha256:fa6c31f30b224a35fe7a012762013c710723e494d22601c441b1a65584ec664a + sourceBlobDigest: sha256:484c7f9b6ce19a105a0794931b98d5f1e1b5fe017ca8a43459a51b5a0d23f1b3 tags: - latest - - speakeasy-sdk-regen-1752278869 + - speakeasy-sdk-regen-1752624505 - 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:8c12c752b241dc10e331b39cd8ea6c2696786668ca87acf7bf8d26702ade4b1a - sourceBlobDigest: sha256:780c8647ad2ad7441e16770f84736db03ce17ac6e96933f180621b48c1224e64 + sourceRevisionDigest: sha256:fa6c31f30b224a35fe7a012762013c710723e494d22601c441b1a65584ec664a + sourceBlobDigest: sha256:484c7f9b6ce19a105a0794931b98d5f1e1b5fe017ca8a43459a51b5a0d23f1b3 codeSamplesNamespace: firehydrant-typescript-sdk-oas-code-samples - codeSamplesRevisionDigest: sha256:94100d783e22f9f19c6f027133d408a1227a49c74022df04db3495c818646609 + codeSamplesRevisionDigest: sha256:7599981dd6b75c7342fb0287f6d315dd8bde2da554ab5ad02ee857ec4c512394 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index 411b1edc..0030c045 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -136,4 +136,14 @@ Based on: ### Generated - [typescript v1.0.4] . ### Releases -- [NPM v1.0.4] https://www.npmjs.com/package/firehydrant-typescript-sdk/v/1.0.4 - . \ No newline at end of file +- [NPM v1.0.4] https://www.npmjs.com/package/firehydrant-typescript-sdk/v/1.0.4 - . + +## 2025-07-21 00:08:33 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.583.0 (2.658.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v1.0.5] . +### Releases +- [NPM v1.0.5] https://www.npmjs.com/package/firehydrant-typescript-sdk/v/1.0.5 - . \ No newline at end of file diff --git a/docs/models/components/createoncallshift.md b/docs/models/components/createoncallshift.md index a16ac43f..ae116b20 100644 --- a/docs/models/components/createoncallshift.md +++ b/docs/models/components/createoncallshift.md @@ -8,8 +8,8 @@ Create a Signals on-call shift in a schedule. import { CreateOnCallShift } from "firehydrant-typescript-sdk/models/components"; let value: CreateOnCallShift = { - startTime: "", - endTime: "", + startTime: new Date("2024-08-17T02:34:49.567Z"), + endTime: new Date("2023-06-01T00:39:49.630Z"), }; ``` @@ -17,7 +17,7 @@ let value: CreateOnCallShift = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `startTime` | *string* | :heavy_check_mark: | The start time of the shift in ISO8601 format. | -| `endTime` | *string* | :heavy_check_mark: | The end time of the shift in ISO8601 format. | +| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The start time of the shift in ISO8601 format. | +| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The end time of the shift in ISO8601 format. | | `userId` | *string* | :heavy_minus_sign: | The ID of the user who is on-call for the shift. If not provided, the shift will be unassigned. | | `rotationId` | *string* | :heavy_minus_sign: | The ID of the on-call rotation you want to create the shift in. This parameter is optional for backwards compatibility but must be provided if the schedule has multiple rotations. | \ No newline at end of file diff --git a/docs/models/components/createscimuser.md b/docs/models/components/createscimuser.md index e774763e..169a707b 100644 --- a/docs/models/components/createscimuser.md +++ b/docs/models/components/createscimuser.md @@ -25,4 +25,5 @@ let value: CreateScimUser = { | `name` | [components.CreateScimUserName](../../models/components/createscimusername.md) | :heavy_check_mark: | The components of the user's name | | `emails` | [components.CreateScimUserEmail](../../models/components/createscimuseremail.md)[] | :heavy_check_mark: | Email addresses for the User | | `roles` | [components.CreateScimUserRoles](../../models/components/createscimuserroles.md) | :heavy_minus_sign: | Roles for the User. Options are owner, member, collaborator, or viewer. Roles may be specified as strings or SCIM role objects. | -| `password` | *string* | :heavy_minus_sign: | This attribute is intended to be used as a means to set, replace, or compare (i.e., filter for equality) a password | \ No newline at end of file +| `password` | *string* | :heavy_minus_sign: | This attribute is intended to be used as a means to set, replace, or compare (i.e., filter for equality) a password | +| `phoneNumbers` | [components.CreateScimUserPhoneNumber](../../models/components/createscimuserphonenumber.md)[] | :heavy_minus_sign: | Phone numbers for the User | \ No newline at end of file diff --git a/docs/models/components/createscimuserphonenumber.md b/docs/models/components/createscimuserphonenumber.md new file mode 100644 index 00000000..f3ed39d1 --- /dev/null +++ b/docs/models/components/createscimuserphonenumber.md @@ -0,0 +1,19 @@ +# CreateScimUserPhoneNumber + +## Example Usage + +```typescript +import { CreateScimUserPhoneNumber } from "firehydrant-typescript-sdk/models/components"; + +let value: CreateScimUserPhoneNumber = { + value: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `value` | *string* | :heavy_check_mark: | String that represents a phone number for the User | +| `type` | *string* | :heavy_minus_sign: | Type of phone number (mobile, work, home, etc.) | +| `primary` | *boolean* | :heavy_minus_sign: | Boolean which signifies if a phone number is intended as the primary phone for the User | \ No newline at end of file diff --git a/docs/models/components/createteammembership.md b/docs/models/components/createteammembership.md index 85efbe0d..355e9059 100644 --- a/docs/models/components/createteammembership.md +++ b/docs/models/components/createteammembership.md @@ -10,8 +10,9 @@ let value: CreateTeamMembership = {}; ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `userId` | *string* | :heavy_minus_sign: | N/A | -| `scheduleId` | *string* | :heavy_minus_sign: | N/A | -| `incidentRoleId` | *string* | :heavy_minus_sign: | An incident role ID that this user will automatically assigned if this team is assigned to an incident | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `userId` | *string* | :heavy_minus_sign: | The ID of a user to add to the team. This parameter is mutually exclusive with schedule_id and signals_on_call_schedule_id. | +| `scheduleId` | *string* | :heavy_minus_sign: | The ID of a third-party on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role. This parameter is mutually exclusive with user_id and signals_on_call_schedule_id. | +| `signalsOnCallScheduleId` | *string* | :heavy_minus_sign: | The ID of a Signals on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role.. This parameter is mutually exclusive with user_id and schedule_id. | +| `incidentRoleId` | *string* | :heavy_minus_sign: | An incident role ID that the user will automatically assigned if this team is assigned to an incident | \ No newline at end of file diff --git a/docs/models/components/nullablerulesruleentitylogic.md b/docs/models/components/logic.md similarity index 59% rename from docs/models/components/nullablerulesruleentitylogic.md rename to docs/models/components/logic.md index a2e0309f..e94f3c6f 100644 --- a/docs/models/components/nullablerulesruleentitylogic.md +++ b/docs/models/components/logic.md @@ -1,13 +1,13 @@ -# NullableRulesRuleEntityLogic +# Logic An unstructured object of key/value pairs describing the logic for applying the rule. ## Example Usage ```typescript -import { NullableRulesRuleEntityLogic } from "firehydrant-typescript-sdk/models/components"; +import { Logic } from "firehydrant-typescript-sdk/models/components"; -let value: NullableRulesRuleEntityLogic = {}; +let value: Logic = {}; ``` ## Fields diff --git a/docs/models/components/nullablerulesruleentity.md b/docs/models/components/nullablerulesruleentity.md index 4270b4bf..9261bea1 100644 --- a/docs/models/components/nullablerulesruleentity.md +++ b/docs/models/components/nullablerulesruleentity.md @@ -12,5 +12,5 @@ let value: NullableRulesRuleEntity = {}; | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `logic` | [components.NullableRulesRuleEntityLogic](../../models/components/nullablerulesruleentitylogic.md) | :heavy_minus_sign: | An unstructured object of key/value pairs describing the logic for applying the rule. | +| `logic` | *string* | :heavy_minus_sign: | JSON stringified object of key/value pairs describing the logic for applying the rule. | | `userData` | [components.NullableFHTypesGenericEntity](../../models/components/nullablefhtypesgenericentity.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/ticketingprojectfieldmapcasesentity.md b/docs/models/components/ticketingprojectfieldmapcasesentity.md index c08222b8..3f39b32e 100644 --- a/docs/models/components/ticketingprojectfieldmapcasesentity.md +++ b/docs/models/components/ticketingprojectfieldmapcasesentity.md @@ -12,5 +12,5 @@ let value: TicketingProjectFieldMapCasesEntity = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `logic` | [components.TicketingProjectFieldMapCasesEntityLogic](../../models/components/ticketingprojectfieldmapcasesentitylogic.md) | :heavy_minus_sign: | An unstructured object of key/value pairs describing the logic for applying the rule. | +| `logic` | [components.Logic](../../models/components/logic.md) | :heavy_minus_sign: | An unstructured object of key/value pairs describing the logic for applying the rule. | | `externalValue` | [components.NullableTicketingProjectFieldMapExternalValueEntity](../../models/components/nullableticketingprojectfieldmapexternalvalueentity.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/ticketingprojectfieldmapcasesentitylogic.md b/docs/models/components/ticketingprojectfieldmapcasesentitylogic.md deleted file mode 100644 index e174977b..00000000 --- a/docs/models/components/ticketingprojectfieldmapcasesentitylogic.md +++ /dev/null @@ -1,16 +0,0 @@ -# TicketingProjectFieldMapCasesEntityLogic - -An unstructured object of key/value pairs describing the logic for applying the rule. - -## Example Usage - -```typescript -import { TicketingProjectFieldMapCasesEntityLogic } from "firehydrant-typescript-sdk/models/components"; - -let value: TicketingProjectFieldMapCasesEntityLogic = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/components/updateoncallshift.md b/docs/models/components/updateoncallshift.md index a24128d2..f67192b6 100644 --- a/docs/models/components/updateoncallshift.md +++ b/docs/models/components/updateoncallshift.md @@ -14,7 +14,7 @@ let value: UpdateOnCallShift = {}; | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `startTime` | *string* | :heavy_minus_sign: | The start time of the shift in ISO8601 format. | -| `endTime` | *string* | :heavy_minus_sign: | The end time of the shift in ISO8601 format. | +| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start time of the shift in ISO8601 format. | +| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end time of the shift in ISO8601 format. | | `userId` | *string* | :heavy_minus_sign: | The ID of the user who is on-call for the shift. If not provided, the shift will be unassigned. | | `coverageRequest` | *string* | :heavy_minus_sign: | A description of why coverage is needed for this shift. If the shift is re-assigned, this will automatically be cleared unless provided again. | \ No newline at end of file diff --git a/docs/models/components/updatescimuser.md b/docs/models/components/updatescimuser.md index 7e34b03c..7857146c 100644 --- a/docs/models/components/updatescimuser.md +++ b/docs/models/components/updatescimuser.md @@ -18,4 +18,5 @@ let value: UpdateScimUser = {}; | `name` | [components.UpdateScimUserName](../../models/components/updatescimusername.md) | :heavy_minus_sign: | The components of the user's name | | `emails` | [components.UpdateScimUserEmail](../../models/components/updatescimuseremail.md)[] | :heavy_minus_sign: | Email addresses for the User | | `roles` | [components.UpdateScimUserRoles](../../models/components/updatescimuserroles.md) | :heavy_minus_sign: | Roles for the User. Options are owner, member, collaborator, or viewer. Roles may be specified as strings or SCIM role objects. | -| `active` | *boolean* | :heavy_minus_sign: | Boolean that represents whether user is active | \ No newline at end of file +| `active` | *boolean* | :heavy_minus_sign: | Boolean that represents whether user is active | +| `phoneNumbers` | [components.UpdateScimUserPhoneNumber](../../models/components/updatescimuserphonenumber.md)[] | :heavy_minus_sign: | Phone numbers for the User | \ No newline at end of file diff --git a/docs/models/components/updatescimuserphonenumber.md b/docs/models/components/updatescimuserphonenumber.md new file mode 100644 index 00000000..2141f0aa --- /dev/null +++ b/docs/models/components/updatescimuserphonenumber.md @@ -0,0 +1,19 @@ +# UpdateScimUserPhoneNumber + +## Example Usage + +```typescript +import { UpdateScimUserPhoneNumber } from "firehydrant-typescript-sdk/models/components"; + +let value: UpdateScimUserPhoneNumber = { + value: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `value` | *string* | :heavy_check_mark: | String that represents a phone number for the User | +| `type` | *string* | :heavy_minus_sign: | Type of phone number (mobile, work, home, etc.) | +| `primary` | *boolean* | :heavy_minus_sign: | Boolean which signifies if a phone number is intended as the primary phone for the User | \ No newline at end of file diff --git a/docs/models/components/updateteammembership.md b/docs/models/components/updateteammembership.md index daf2d135..d4b44ea1 100644 --- a/docs/models/components/updateteammembership.md +++ b/docs/models/components/updateteammembership.md @@ -10,8 +10,9 @@ let value: UpdateTeamMembership = {}; ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `userId` | *string* | :heavy_minus_sign: | N/A | -| `scheduleId` | *string* | :heavy_minus_sign: | N/A | -| `incidentRoleId` | *string* | :heavy_minus_sign: | An incident role ID that this user will automatically assigned if this team is assigned to an incident | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `userId` | *string* | :heavy_minus_sign: | The ID of a user to add to the team. This parameter is mutually exclusive with schedule_id and signals_on_call_schedule_id. | +| `scheduleId` | *string* | :heavy_minus_sign: | The ID of a third-party on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role. This parameter is mutually exclusive with user_id and signals_on_call_schedule_id. | +| `signalsOnCallScheduleId` | *string* | :heavy_minus_sign: | The ID of a Signals on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role.. This parameter is mutually exclusive with user_id and schedule_id. | +| `incidentRoleId` | *string* | :heavy_minus_sign: | An incident role ID that this user will automatically assigned if this team is assigned to an incident | \ No newline at end of file diff --git a/docs/models/operations/createoncallshiftrequest.md b/docs/models/operations/createoncallshiftrequest.md index a585c005..2e26818f 100644 --- a/docs/models/operations/createoncallshiftrequest.md +++ b/docs/models/operations/createoncallshiftrequest.md @@ -9,8 +9,8 @@ let value: CreateOnCallShiftRequest = { teamId: "", scheduleId: "", createOnCallShift: { - startTime: "", - endTime: "", + startTime: new Date("2024-06-15T16:48:29.406Z"), + endTime: new Date("2025-01-24T05:13:18.654Z"), }, }; ``` diff --git a/docs/sdks/signals/README.md b/docs/sdks/signals/README.md index 36514222..d92e5792 100644 --- a/docs/sdks/signals/README.md +++ b/docs/sdks/signals/README.md @@ -827,8 +827,8 @@ async function run() { teamId: "", scheduleId: "", createOnCallShift: { - startTime: "", - endTime: "", + startTime: new Date(""), + endTime: new Date(""), }, }); @@ -857,8 +857,8 @@ async function run() { teamId: "", scheduleId: "", createOnCallShift: { - startTime: "", - endTime: "", + startTime: new Date(""), + endTime: new Date(""), }, }); if (res.ok) { diff --git a/examples/.env.template b/examples/.env.template index dd4f8a1d..e9be78c1 100644 --- a/examples/.env.template +++ b/examples/.env.template @@ -6,11 +6,9 @@ # The SDK supports loading security credentials from environment variables # with the prefix: FIREHYDRANT_ # -# Example security environment variables: -# FIREHYDRANT_API_KEY=your_api_key_here -# FIREHYDRANT_BEARER_TOKEN=your_bearer_token_here -# FIREHYDRANT_USERNAME=your_username_here -# FIREHYDRANT_PASSWORD=your_password_here -# -# Check the SDK documentation for the exact environment variable names -# required for your specific authentication method. +# Security environment variables: +FIREHYDRANT_API_KEY=your_api_key_here + +# Debug Configuration +# Enable HTTP request/response logging for debugging +FIREHYDRANT_DEBUG=false diff --git a/examples/README.md b/examples/README.md index 79a69b47..f6e1c810 100644 --- a/examples/README.md +++ b/examples/README.md @@ -24,3 +24,8 @@ To run an example file from the examples directory: npm run build && npx tsx example.ts ``` +## Creating new examples + +Duplicate an existing example file, they won't be overwritten by the generation process. + + diff --git a/examples/accountSettingsPing.example.ts b/examples/accountSettingsPing.example.ts index 07d79a6b..5d1aed77 100644 --- a/examples/accountSettingsPing.example.ts +++ b/examples/accountSettingsPing.example.ts @@ -2,6 +2,8 @@ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ +import dotenv from "dotenv"; +dotenv.config(); /** * Example usage of the firehydrant-typescript-sdk SDK * diff --git a/examples/package-lock.json b/examples/package-lock.json index 9b07e59c..b50c7133 100644 --- a/examples/package-lock.json +++ b/examples/package-lock.json @@ -18,7 +18,7 @@ }, "..": { "name": "firehydrant-typescript-sdk", - "version": "1.0.4", + "version": "1.0.5", "bin": { "mcp": "bin/mcp-server.js" }, diff --git a/jsr.json b/jsr.json index cc0775d0..b58517b7 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "firehydrant-typescript-sdk", - "version": "1.0.4", + "version": "1.0.5", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 6bacc2a0..8daa6684 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "firehydrant-typescript-sdk", - "version": "1.0.4", + "version": "1.0.5", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "firehydrant-typescript-sdk", - "version": "1.0.4", + "version": "1.0.5", "bin": { "mcp": "bin/mcp-server.js" }, diff --git a/package.json b/package.json index 6ece90d6..816dbc60 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "firehydrant-typescript-sdk", - "version": "1.0.4", + "version": "1.0.5", "author": "Firehydrant", "type": "module", "bin": { diff --git a/src/lib/config.ts b/src/lib/config.ts index 7999b264..ab1dbd03 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.4", - genVersion: "2.656.5", + sdkVersion: "1.0.5", + genVersion: "2.658.3", userAgent: - "speakeasy-sdk/typescript 1.0.4 2.656.5 0.0.1 firehydrant-typescript-sdk", + "speakeasy-sdk/typescript 1.0.5 2.658.3 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 a55f8a1d..4a4242c2 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.4", + currentVersion: "1.0.5", }, }); diff --git a/src/mcp-server/server.ts b/src/mcp-server/server.ts index b69e6c5d..5b677ed7 100644 --- a/src/mcp-server/server.ts +++ b/src/mcp-server/server.ts @@ -456,7 +456,7 @@ export function createMCPServer(deps: { }) { const server = new McpServer({ name: "Firehydrant", - version: "1.0.4", + version: "1.0.5", }); const client = new FirehydrantCore({ diff --git a/src/models/components/createoncallshift.ts b/src/models/components/createoncallshift.ts index e6347b29..b4e424c5 100644 --- a/src/models/components/createoncallshift.ts +++ b/src/models/components/createoncallshift.ts @@ -15,11 +15,11 @@ export type CreateOnCallShift = { /** * The start time of the shift in ISO8601 format. */ - startTime: string; + startTime: Date; /** * The end time of the shift in ISO8601 format. */ - endTime: string; + endTime: Date; /** * The ID of the user who is on-call for the shift. If not provided, the shift will be unassigned. */ @@ -36,8 +36,8 @@ export const CreateOnCallShift$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - start_time: z.string(), - end_time: z.string(), + start_time: z.string().datetime({ offset: true }).transform(v => new Date(v)), + end_time: z.string().datetime({ offset: true }).transform(v => new Date(v)), user_id: z.nullable(z.string()).optional(), rotation_id: z.nullable(z.string()).optional(), }).transform((v) => { @@ -63,8 +63,8 @@ export const CreateOnCallShift$outboundSchema: z.ZodType< z.ZodTypeDef, CreateOnCallShift > = z.object({ - startTime: z.string(), - endTime: z.string(), + startTime: z.date().transform(v => v.toISOString()), + endTime: z.date().transform(v => v.toISOString()), userId: z.nullable(z.string()).optional(), rotationId: z.nullable(z.string()).optional(), }).transform((v) => { diff --git a/src/models/components/createscimuser.ts b/src/models/components/createscimuser.ts index 6324503f..c3879cde 100644 --- a/src/models/components/createscimuser.ts +++ b/src/models/components/createscimuser.ts @@ -37,6 +37,21 @@ export type CreateScimUserEmail = { */ export type CreateScimUserRoles = {}; +export type CreateScimUserPhoneNumber = { + /** + * String that represents a phone number for the User + */ + value: string; + /** + * Type of phone number (mobile, work, home, etc.) + */ + type?: string | null | undefined; + /** + * Boolean which signifies if a phone number is intended as the primary phone for the User + */ + primary?: boolean | null | undefined; +}; + /** * SCIM endpoint to create and provision a new User. This endpoint will provision the User, which allows them to accept their account throught their IDP or via the Forgot Password flow. */ @@ -61,6 +76,10 @@ export type CreateScimUser = { * This attribute is intended to be used as a means to set, replace, or compare (i.e., filter for equality) a password */ password?: string | null | undefined; + /** + * Phone numbers for the User + */ + phoneNumbers?: Array | null | undefined; }; /** @internal */ @@ -225,6 +244,66 @@ export function createScimUserRolesFromJSON( ); } +/** @internal */ +export const CreateScimUserPhoneNumber$inboundSchema: z.ZodType< + CreateScimUserPhoneNumber, + z.ZodTypeDef, + unknown +> = z.object({ + value: z.string(), + type: z.nullable(z.string()).optional(), + primary: z.nullable(z.boolean()).optional(), +}); + +/** @internal */ +export type CreateScimUserPhoneNumber$Outbound = { + value: string; + type?: string | null | undefined; + primary?: boolean | null | undefined; +}; + +/** @internal */ +export const CreateScimUserPhoneNumber$outboundSchema: z.ZodType< + CreateScimUserPhoneNumber$Outbound, + z.ZodTypeDef, + CreateScimUserPhoneNumber +> = z.object({ + value: z.string(), + type: z.nullable(z.string()).optional(), + primary: z.nullable(z.boolean()).optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CreateScimUserPhoneNumber$ { + /** @deprecated use `CreateScimUserPhoneNumber$inboundSchema` instead. */ + export const inboundSchema = CreateScimUserPhoneNumber$inboundSchema; + /** @deprecated use `CreateScimUserPhoneNumber$outboundSchema` instead. */ + export const outboundSchema = CreateScimUserPhoneNumber$outboundSchema; + /** @deprecated use `CreateScimUserPhoneNumber$Outbound` instead. */ + export type Outbound = CreateScimUserPhoneNumber$Outbound; +} + +export function createScimUserPhoneNumberToJSON( + createScimUserPhoneNumber: CreateScimUserPhoneNumber, +): string { + return JSON.stringify( + CreateScimUserPhoneNumber$outboundSchema.parse(createScimUserPhoneNumber), + ); +} + +export function createScimUserPhoneNumberFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => CreateScimUserPhoneNumber$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'CreateScimUserPhoneNumber' from JSON`, + ); +} + /** @internal */ export const CreateScimUser$inboundSchema: z.ZodType< CreateScimUser, @@ -236,6 +315,9 @@ export const CreateScimUser$inboundSchema: z.ZodType< emails: z.array(z.lazy(() => CreateScimUserEmail$inboundSchema)), roles: z.nullable(z.lazy(() => CreateScimUserRoles$inboundSchema)).optional(), password: z.nullable(z.string()).optional(), + phoneNumbers: z.nullable( + z.array(z.lazy(() => CreateScimUserPhoneNumber$inboundSchema)), + ).optional(), }); /** @internal */ @@ -245,6 +327,7 @@ export type CreateScimUser$Outbound = { emails: Array; roles?: CreateScimUserRoles$Outbound | null | undefined; password?: string | null | undefined; + phoneNumbers?: Array | null | undefined; }; /** @internal */ @@ -259,6 +342,9 @@ export const CreateScimUser$outboundSchema: z.ZodType< roles: z.nullable(z.lazy(() => CreateScimUserRoles$outboundSchema)) .optional(), password: z.nullable(z.string()).optional(), + phoneNumbers: z.nullable( + z.array(z.lazy(() => CreateScimUserPhoneNumber$outboundSchema)), + ).optional(), }); /** diff --git a/src/models/components/createteam.ts b/src/models/components/createteam.ts index ec19a4d3..b57657e8 100644 --- a/src/models/components/createteam.ts +++ b/src/models/components/createteam.ts @@ -17,10 +17,20 @@ export type CreateTeamMsTeamsChannel = { }; export type CreateTeamMembership = { + /** + * The ID of a user to add to the team. This parameter is mutually exclusive with schedule_id and signals_on_call_schedule_id. + */ userId?: string | null | undefined; + /** + * The ID of a third-party on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role. This parameter is mutually exclusive with user_id and signals_on_call_schedule_id. + */ scheduleId?: string | null | undefined; /** - * An incident role ID that this user will automatically assigned if this team is assigned to an incident + * The ID of a Signals on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role.. This parameter is mutually exclusive with user_id and schedule_id. + */ + signalsOnCallScheduleId?: string | null | undefined; + /** + * An incident role ID that the user will automatically assigned if this team is assigned to an incident */ incidentRoleId?: string | null | undefined; }; @@ -124,11 +134,13 @@ export const CreateTeamMembership$inboundSchema: z.ZodType< > = z.object({ user_id: z.nullable(z.string()).optional(), schedule_id: z.nullable(z.string()).optional(), + signals_on_call_schedule_id: z.nullable(z.string()).optional(), incident_role_id: z.nullable(z.string()).optional(), }).transform((v) => { return remap$(v, { "user_id": "userId", "schedule_id": "scheduleId", + "signals_on_call_schedule_id": "signalsOnCallScheduleId", "incident_role_id": "incidentRoleId", }); }); @@ -137,6 +149,7 @@ export const CreateTeamMembership$inboundSchema: z.ZodType< export type CreateTeamMembership$Outbound = { user_id?: string | null | undefined; schedule_id?: string | null | undefined; + signals_on_call_schedule_id?: string | null | undefined; incident_role_id?: string | null | undefined; }; @@ -148,11 +161,13 @@ export const CreateTeamMembership$outboundSchema: z.ZodType< > = z.object({ userId: z.nullable(z.string()).optional(), scheduleId: z.nullable(z.string()).optional(), + signalsOnCallScheduleId: z.nullable(z.string()).optional(), incidentRoleId: z.nullable(z.string()).optional(), }).transform((v) => { return remap$(v, { userId: "user_id", scheduleId: "schedule_id", + signalsOnCallScheduleId: "signals_on_call_schedule_id", incidentRoleId: "incident_role_id", }); }); diff --git a/src/models/components/nullablerulesruleentity.ts b/src/models/components/nullablerulesruleentity.ts index 3a004c85..29d183a6 100644 --- a/src/models/components/nullablerulesruleentity.ts +++ b/src/models/components/nullablerulesruleentity.ts @@ -14,77 +14,21 @@ import { NullableFHTypesGenericEntity$outboundSchema, } from "./nullablefhtypesgenericentity.js"; -/** - * An unstructured object of key/value pairs describing the logic for applying the rule. - */ -export type NullableRulesRuleEntityLogic = {}; - export type NullableRulesRuleEntity = { /** - * An unstructured object of key/value pairs describing the logic for applying the rule. + * JSON stringified object of key/value pairs describing the logic for applying the rule. */ - logic?: NullableRulesRuleEntityLogic | null | undefined; + logic?: string | null | undefined; userData?: NullableFHTypesGenericEntity | null | undefined; }; -/** @internal */ -export const NullableRulesRuleEntityLogic$inboundSchema: z.ZodType< - NullableRulesRuleEntityLogic, - z.ZodTypeDef, - unknown -> = z.object({}); - -/** @internal */ -export type NullableRulesRuleEntityLogic$Outbound = {}; - -/** @internal */ -export const NullableRulesRuleEntityLogic$outboundSchema: z.ZodType< - NullableRulesRuleEntityLogic$Outbound, - z.ZodTypeDef, - NullableRulesRuleEntityLogic -> = z.object({}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace NullableRulesRuleEntityLogic$ { - /** @deprecated use `NullableRulesRuleEntityLogic$inboundSchema` instead. */ - export const inboundSchema = NullableRulesRuleEntityLogic$inboundSchema; - /** @deprecated use `NullableRulesRuleEntityLogic$outboundSchema` instead. */ - export const outboundSchema = NullableRulesRuleEntityLogic$outboundSchema; - /** @deprecated use `NullableRulesRuleEntityLogic$Outbound` instead. */ - export type Outbound = NullableRulesRuleEntityLogic$Outbound; -} - -export function nullableRulesRuleEntityLogicToJSON( - nullableRulesRuleEntityLogic: NullableRulesRuleEntityLogic, -): string { - return JSON.stringify( - NullableRulesRuleEntityLogic$outboundSchema.parse( - nullableRulesRuleEntityLogic, - ), - ); -} - -export function nullableRulesRuleEntityLogicFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => NullableRulesRuleEntityLogic$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'NullableRulesRuleEntityLogic' from JSON`, - ); -} - /** @internal */ export const NullableRulesRuleEntity$inboundSchema: z.ZodType< NullableRulesRuleEntity, z.ZodTypeDef, unknown > = z.object({ - logic: z.nullable(z.lazy(() => NullableRulesRuleEntityLogic$inboundSchema)) - .optional(), + logic: z.nullable(z.string()).optional(), user_data: z.nullable(NullableFHTypesGenericEntity$inboundSchema).optional(), }).transform((v) => { return remap$(v, { @@ -94,7 +38,7 @@ export const NullableRulesRuleEntity$inboundSchema: z.ZodType< /** @internal */ export type NullableRulesRuleEntity$Outbound = { - logic?: NullableRulesRuleEntityLogic$Outbound | null | undefined; + logic?: string | null | undefined; user_data?: NullableFHTypesGenericEntity$Outbound | null | undefined; }; @@ -104,8 +48,7 @@ export const NullableRulesRuleEntity$outboundSchema: z.ZodType< z.ZodTypeDef, NullableRulesRuleEntity > = z.object({ - logic: z.nullable(z.lazy(() => NullableRulesRuleEntityLogic$outboundSchema)) - .optional(), + logic: z.nullable(z.string()).optional(), userData: z.nullable(NullableFHTypesGenericEntity$outboundSchema).optional(), }).transform((v) => { return remap$(v, { diff --git a/src/models/components/ticketingprojectfieldmapcasesentity.ts b/src/models/components/ticketingprojectfieldmapcasesentity.ts index d96bd8ad..6b8f574f 100644 --- a/src/models/components/ticketingprojectfieldmapcasesentity.ts +++ b/src/models/components/ticketingprojectfieldmapcasesentity.ts @@ -17,13 +17,13 @@ import { /** * An unstructured object of key/value pairs describing the logic for applying the rule. */ -export type TicketingProjectFieldMapCasesEntityLogic = {}; +export type Logic = {}; export type TicketingProjectFieldMapCasesEntity = { /** * An unstructured object of key/value pairs describing the logic for applying the rule. */ - logic?: TicketingProjectFieldMapCasesEntityLogic | null | undefined; + logic?: Logic | null | undefined; externalValue?: | NullableTicketingProjectFieldMapExternalValueEntity | null @@ -31,61 +31,43 @@ export type TicketingProjectFieldMapCasesEntity = { }; /** @internal */ -export const TicketingProjectFieldMapCasesEntityLogic$inboundSchema: z.ZodType< - TicketingProjectFieldMapCasesEntityLogic, - z.ZodTypeDef, - unknown -> = z.object({}); +export const Logic$inboundSchema: z.ZodType = z + .object({}); /** @internal */ -export type TicketingProjectFieldMapCasesEntityLogic$Outbound = {}; +export type Logic$Outbound = {}; /** @internal */ -export const TicketingProjectFieldMapCasesEntityLogic$outboundSchema: z.ZodType< - TicketingProjectFieldMapCasesEntityLogic$Outbound, +export const Logic$outboundSchema: z.ZodType< + Logic$Outbound, z.ZodTypeDef, - TicketingProjectFieldMapCasesEntityLogic + Logic > = z.object({}); /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace TicketingProjectFieldMapCasesEntityLogic$ { - /** @deprecated use `TicketingProjectFieldMapCasesEntityLogic$inboundSchema` instead. */ - export const inboundSchema = - TicketingProjectFieldMapCasesEntityLogic$inboundSchema; - /** @deprecated use `TicketingProjectFieldMapCasesEntityLogic$outboundSchema` instead. */ - export const outboundSchema = - TicketingProjectFieldMapCasesEntityLogic$outboundSchema; - /** @deprecated use `TicketingProjectFieldMapCasesEntityLogic$Outbound` instead. */ - export type Outbound = TicketingProjectFieldMapCasesEntityLogic$Outbound; +export namespace Logic$ { + /** @deprecated use `Logic$inboundSchema` instead. */ + export const inboundSchema = Logic$inboundSchema; + /** @deprecated use `Logic$outboundSchema` instead. */ + export const outboundSchema = Logic$outboundSchema; + /** @deprecated use `Logic$Outbound` instead. */ + export type Outbound = Logic$Outbound; } -export function ticketingProjectFieldMapCasesEntityLogicToJSON( - ticketingProjectFieldMapCasesEntityLogic: - TicketingProjectFieldMapCasesEntityLogic, -): string { - return JSON.stringify( - TicketingProjectFieldMapCasesEntityLogic$outboundSchema.parse( - ticketingProjectFieldMapCasesEntityLogic, - ), - ); +export function logicToJSON(logic: Logic): string { + return JSON.stringify(Logic$outboundSchema.parse(logic)); } -export function ticketingProjectFieldMapCasesEntityLogicFromJSON( +export function logicFromJSON( jsonString: string, -): SafeParseResult< - TicketingProjectFieldMapCasesEntityLogic, - SDKValidationError -> { +): SafeParseResult { return safeParse( jsonString, - (x) => - TicketingProjectFieldMapCasesEntityLogic$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'TicketingProjectFieldMapCasesEntityLogic' from JSON`, + (x) => Logic$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'Logic' from JSON`, ); } @@ -95,9 +77,7 @@ export const TicketingProjectFieldMapCasesEntity$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - logic: z.nullable( - z.lazy(() => TicketingProjectFieldMapCasesEntityLogic$inboundSchema), - ).optional(), + logic: z.nullable(z.lazy(() => Logic$inboundSchema)).optional(), external_value: z.nullable( NullableTicketingProjectFieldMapExternalValueEntity$inboundSchema, ).optional(), @@ -109,7 +89,7 @@ export const TicketingProjectFieldMapCasesEntity$inboundSchema: z.ZodType< /** @internal */ export type TicketingProjectFieldMapCasesEntity$Outbound = { - logic?: TicketingProjectFieldMapCasesEntityLogic$Outbound | null | undefined; + logic?: Logic$Outbound | null | undefined; external_value?: | NullableTicketingProjectFieldMapExternalValueEntity$Outbound | null @@ -122,9 +102,7 @@ export const TicketingProjectFieldMapCasesEntity$outboundSchema: z.ZodType< z.ZodTypeDef, TicketingProjectFieldMapCasesEntity > = z.object({ - logic: z.nullable( - z.lazy(() => TicketingProjectFieldMapCasesEntityLogic$outboundSchema), - ).optional(), + logic: z.nullable(z.lazy(() => Logic$outboundSchema)).optional(), externalValue: z.nullable( NullableTicketingProjectFieldMapExternalValueEntity$outboundSchema, ).optional(), diff --git a/src/models/components/updateoncallshift.ts b/src/models/components/updateoncallshift.ts index 5f097952..59eb5dd2 100644 --- a/src/models/components/updateoncallshift.ts +++ b/src/models/components/updateoncallshift.ts @@ -15,11 +15,11 @@ export type UpdateOnCallShift = { /** * The start time of the shift in ISO8601 format. */ - startTime?: string | null | undefined; + startTime?: Date | null | undefined; /** * The end time of the shift in ISO8601 format. */ - endTime?: string | null | undefined; + endTime?: Date | null | undefined; /** * The ID of the user who is on-call for the shift. If not provided, the shift will be unassigned. */ @@ -36,8 +36,12 @@ export const UpdateOnCallShift$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - start_time: z.nullable(z.string()).optional(), - end_time: z.nullable(z.string()).optional(), + start_time: z.nullable( + z.string().datetime({ offset: true }).transform(v => new Date(v)), + ).optional(), + end_time: z.nullable( + z.string().datetime({ offset: true }).transform(v => new Date(v)), + ).optional(), user_id: z.nullable(z.string()).optional(), coverage_request: z.nullable(z.string()).optional(), }).transform((v) => { @@ -63,8 +67,8 @@ export const UpdateOnCallShift$outboundSchema: z.ZodType< z.ZodTypeDef, UpdateOnCallShift > = z.object({ - startTime: z.nullable(z.string()).optional(), - endTime: z.nullable(z.string()).optional(), + startTime: z.nullable(z.date().transform(v => v.toISOString())).optional(), + endTime: z.nullable(z.date().transform(v => v.toISOString())).optional(), userId: z.nullable(z.string()).optional(), coverageRequest: z.nullable(z.string()).optional(), }).transform((v) => { diff --git a/src/models/components/updatescimuser.ts b/src/models/components/updatescimuser.ts index e137a585..02542aab 100644 --- a/src/models/components/updatescimuser.ts +++ b/src/models/components/updatescimuser.ts @@ -37,6 +37,21 @@ export type UpdateScimUserEmail = { */ export type UpdateScimUserRoles = {}; +export type UpdateScimUserPhoneNumber = { + /** + * String that represents a phone number for the User + */ + value: string; + /** + * Type of phone number (mobile, work, home, etc.) + */ + type?: string | null | undefined; + /** + * Boolean which signifies if a phone number is intended as the primary phone for the User + */ + primary?: boolean | null | undefined; +}; + /** * PUT SCIM endpoint to update a User. This endpoint is used to replace a resource's attributes. */ @@ -61,6 +76,10 @@ export type UpdateScimUser = { * Boolean that represents whether user is active */ active?: boolean | null | undefined; + /** + * Phone numbers for the User + */ + phoneNumbers?: Array | null | undefined; }; /** @internal */ @@ -225,6 +244,66 @@ export function updateScimUserRolesFromJSON( ); } +/** @internal */ +export const UpdateScimUserPhoneNumber$inboundSchema: z.ZodType< + UpdateScimUserPhoneNumber, + z.ZodTypeDef, + unknown +> = z.object({ + value: z.string(), + type: z.nullable(z.string()).optional(), + primary: z.nullable(z.boolean()).optional(), +}); + +/** @internal */ +export type UpdateScimUserPhoneNumber$Outbound = { + value: string; + type?: string | null | undefined; + primary?: boolean | null | undefined; +}; + +/** @internal */ +export const UpdateScimUserPhoneNumber$outboundSchema: z.ZodType< + UpdateScimUserPhoneNumber$Outbound, + z.ZodTypeDef, + UpdateScimUserPhoneNumber +> = z.object({ + value: z.string(), + type: z.nullable(z.string()).optional(), + primary: z.nullable(z.boolean()).optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UpdateScimUserPhoneNumber$ { + /** @deprecated use `UpdateScimUserPhoneNumber$inboundSchema` instead. */ + export const inboundSchema = UpdateScimUserPhoneNumber$inboundSchema; + /** @deprecated use `UpdateScimUserPhoneNumber$outboundSchema` instead. */ + export const outboundSchema = UpdateScimUserPhoneNumber$outboundSchema; + /** @deprecated use `UpdateScimUserPhoneNumber$Outbound` instead. */ + export type Outbound = UpdateScimUserPhoneNumber$Outbound; +} + +export function updateScimUserPhoneNumberToJSON( + updateScimUserPhoneNumber: UpdateScimUserPhoneNumber, +): string { + return JSON.stringify( + UpdateScimUserPhoneNumber$outboundSchema.parse(updateScimUserPhoneNumber), + ); +} + +export function updateScimUserPhoneNumberFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => UpdateScimUserPhoneNumber$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'UpdateScimUserPhoneNumber' from JSON`, + ); +} + /** @internal */ export const UpdateScimUser$inboundSchema: z.ZodType< UpdateScimUser, @@ -237,6 +316,9 @@ export const UpdateScimUser$inboundSchema: z.ZodType< .optional(), roles: z.nullable(z.lazy(() => UpdateScimUserRoles$inboundSchema)).optional(), active: z.nullable(z.boolean()).optional(), + phoneNumbers: z.nullable( + z.array(z.lazy(() => UpdateScimUserPhoneNumber$inboundSchema)), + ).optional(), }); /** @internal */ @@ -246,6 +328,7 @@ export type UpdateScimUser$Outbound = { emails?: Array | null | undefined; roles?: UpdateScimUserRoles$Outbound | null | undefined; active?: boolean | null | undefined; + phoneNumbers?: Array | null | undefined; }; /** @internal */ @@ -261,6 +344,9 @@ export const UpdateScimUser$outboundSchema: z.ZodType< roles: z.nullable(z.lazy(() => UpdateScimUserRoles$outboundSchema)) .optional(), active: z.nullable(z.boolean()).optional(), + phoneNumbers: z.nullable( + z.array(z.lazy(() => UpdateScimUserPhoneNumber$outboundSchema)), + ).optional(), }); /** diff --git a/src/models/components/updateteam.ts b/src/models/components/updateteam.ts index d67cc7ab..fea9485d 100644 --- a/src/models/components/updateteam.ts +++ b/src/models/components/updateteam.ts @@ -17,8 +17,18 @@ export type UpdateTeamMsTeamsChannel = { }; export type UpdateTeamMembership = { + /** + * The ID of a user to add to the team. This parameter is mutually exclusive with schedule_id and signals_on_call_schedule_id. + */ userId?: string | null | undefined; + /** + * The ID of a third-party on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role. This parameter is mutually exclusive with user_id and signals_on_call_schedule_id. + */ scheduleId?: string | null | undefined; + /** + * The ID of a Signals on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role.. This parameter is mutually exclusive with user_id and schedule_id. + */ + signalsOnCallScheduleId?: string | null | undefined; /** * An incident role ID that this user will automatically assigned if this team is assigned to an incident */ @@ -124,11 +134,13 @@ export const UpdateTeamMembership$inboundSchema: z.ZodType< > = z.object({ user_id: z.nullable(z.string()).optional(), schedule_id: z.nullable(z.string()).optional(), + signals_on_call_schedule_id: z.nullable(z.string()).optional(), incident_role_id: z.nullable(z.string()).optional(), }).transform((v) => { return remap$(v, { "user_id": "userId", "schedule_id": "scheduleId", + "signals_on_call_schedule_id": "signalsOnCallScheduleId", "incident_role_id": "incidentRoleId", }); }); @@ -137,6 +149,7 @@ export const UpdateTeamMembership$inboundSchema: z.ZodType< export type UpdateTeamMembership$Outbound = { user_id?: string | null | undefined; schedule_id?: string | null | undefined; + signals_on_call_schedule_id?: string | null | undefined; incident_role_id?: string | null | undefined; }; @@ -148,11 +161,13 @@ export const UpdateTeamMembership$outboundSchema: z.ZodType< > = z.object({ userId: z.nullable(z.string()).optional(), scheduleId: z.nullable(z.string()).optional(), + signalsOnCallScheduleId: z.nullable(z.string()).optional(), incidentRoleId: z.nullable(z.string()).optional(), }).transform((v) => { return remap$(v, { userId: "user_id", scheduleId: "schedule_id", + signalsOnCallScheduleId: "signals_on_call_schedule_id", incidentRoleId: "incident_role_id", }); });