Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
96 changes: 88 additions & 8 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

16 changes: 14 additions & 2 deletions .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,33 +22,40 @@ generation:
hoistGlobalSecurity: true
schemas:
allOfMergeStrategy: shallowMerge
requestBodyFieldName: ""
tests:
generateTests: true
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 1.1.0
version: 1.2.0
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}
devDependencies: {}
peerDependencies: {}
additionalPackageJSON: {}
additionalScripts: {}
alwaysIncludeInboundAndOutbound: false
author: Firehydrant
baseErrorName: FirehydrantError
clientServerStatusCodesAsErrors: true
constFieldsAlwaysOptional: true
constFieldsAlwaysOptional: false
defaultErrorName: APIError
enableCustomCodeRegions: false
enableMCPServer: true
enableReactQuery: false
enumFormat: union
envVarPrefix: FIREHYDRANT
exportZodModelNamespace: false
flattenGlobalSecurity: true
flattenSdk: true
flattenSpecOptions:
tags: false
flatteningOrder: parameters-first
formStringArrayEncodeMode: encoded-string
forwardCompatibleEnumsByDefault: false
forwardCompatibleUnionsByDefault: "false"
generateExamples: true
imports:
option: openapi
Expand All @@ -58,17 +65,22 @@ typescript:
operations: models/operations
shared: models/components
webhooks: models/webhooks
inferUnionDiscriminators: true
inputModelSuffix: input
jsonpath: legacy
laxMode: strict
maxMethodParams: 0
methodArguments: require-security-and-request
modelPropertyCasing: camel
moduleFormat: dual
multipartArrayFormat: legacy
outputModelSuffix: output
packageName: firehydrant-typescript-sdk
preApplyUnionDiscriminators: true
responseFormat: flat
sseFlatResponse: false
templateVersion: v2
unionStrategy: left-to-right
usageSDKInitImports: []
useIndexModules: true
zodVersion: v3
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
speakeasyVersion: 1.643.3
speakeasyVersion: 1.668.0
sources:
firehydrant-oas:
sourceNamespace: firehydrant-oas
sourceRevisionDigest: sha256:b752499e8d32196d45abad1fbb372568c5a73359bfe2597424b9e71e41073401
sourceBlobDigest: sha256:1f2c8b5b86a50578de204f822cc5803bc639b5033867027dbded522076ff50e1
sourceRevisionDigest: sha256:f6e1a22eb9e9025e0ad1f96d7d593981caf573f1d3ba2ebb1fb7cf9e8357b7bb
sourceBlobDigest: sha256:5c81a3777f4fc704a45774193143832bfb29809a080fc67be188741c93de808f
tags:
- latest
- speakeasy-sdk-regen-1759450051
- speakeasy-sdk-regen-1762214872
- 0.0.1
firehydrant-typescript-sdk-OAS:
sourceNamespace: firehydrant-typescript-sdk-oas
Expand All @@ -19,10 +19,10 @@ targets:
firehydrant-typescript-sdk:
source: firehydrant-oas
sourceNamespace: firehydrant-oas
sourceRevisionDigest: sha256:b752499e8d32196d45abad1fbb372568c5a73359bfe2597424b9e71e41073401
sourceBlobDigest: sha256:1f2c8b5b86a50578de204f822cc5803bc639b5033867027dbded522076ff50e1
sourceRevisionDigest: sha256:f6e1a22eb9e9025e0ad1f96d7d593981caf573f1d3ba2ebb1fb7cf9e8357b7bb
sourceBlobDigest: sha256:5c81a3777f4fc704a45774193143832bfb29809a080fc67be188741c93de808f
codeSamplesNamespace: firehydrant-typescript-sdk-oas-code-samples
codeSamplesRevisionDigest: sha256:ddeb7508f6fcbf8f0619a337f13c4cdcfac5afe13e82c31424daab4c602d31e5
codeSamplesRevisionDigest: sha256:034f379ea37914dfe28b5c3540a321249587df5f7a1595b83ef204e2840265df
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ run();
* [getMemberDefaultAudience](docs/sdks/audiences/README.md#getmemberdefaultaudience) - Get default audience
* [setMemberDefaultAudience](docs/sdks/audiences/README.md#setmemberdefaultaudience) - Set default audience
* [getAudienceSummary](docs/sdks/audiences/README.md#getaudiencesummary) - Get latest summary
* [generateAudienceSummary](docs/sdks/audiences/README.md#generateaudiencesummary) - Generate summary
* [generateAudienceSummary](docs/sdks/audiences/README.md#generateaudiencesummary) - Generate summary (async)
* [listAudienceSummaries](docs/sdks/audiences/README.md#listaudiencesummaries) - List audience summaries

### [auditEvents](docs/sdks/auditevents/README.md)
Expand Down Expand Up @@ -648,6 +648,7 @@ run();
* [getRetrospectiveTemplate](docs/sdks/retrospectives/README.md#getretrospectivetemplate) - Get a retrospective template
* [deleteRetrospectiveTemplate](docs/sdks/retrospectives/README.md#deleteretrospectivetemplate) - Delete a retrospective template
* [updateRetrospectiveTemplate](docs/sdks/retrospectives/README.md#updateretrospectivetemplate) - Update a retrospective template
* [getRetrospectiveReportTemplate](docs/sdks/retrospectives/README.md#getretrospectivereporttemplate) - Get a retrospective report template

### [roles](docs/sdks/roles/README.md)

Expand Down Expand Up @@ -832,6 +833,11 @@ run();
* [deleteTicketingPriority](docs/sdks/ticketing/README.md#deleteticketingpriority) - Delete a ticketing priority
* [updateTicketingPriority](docs/sdks/ticketing/README.md#updateticketingpriority) - Update a ticketing priority
* [listTicketTags](docs/sdks/ticketing/README.md#listtickettags) - List ticket tags
* [getTicketingFormConfiguration](docs/sdks/ticketing/README.md#getticketingformconfiguration) - Get the ticketing form configuration
* [listTicketingCustomDefinitions](docs/sdks/ticketing/README.md#listticketingcustomdefinitions) - List ticketing custom fields
* [createTicketingCustomDefinition](docs/sdks/ticketing/README.md#createticketingcustomdefinition) - Create a ticketing custom field
* [deleteTicketingCustomDefinition](docs/sdks/ticketing/README.md#deleteticketingcustomdefinition) - Delete a ticketing custom field
* [updateTicketingCustomDefinition](docs/sdks/ticketing/README.md#updateticketingcustomdefinition) - Update a ticketing custom field

### [users](docs/sdks/users/README.md)

Expand Down Expand Up @@ -882,7 +888,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`alertsUpdateSignalsAlert`](docs/sdks/alerts/README.md#updatesignalsalert) - Update a Signal alert
- [`audiencesArchiveAudience`](docs/sdks/audiences/README.md#archiveaudience) - Archive audience
- [`audiencesCreateAudience`](docs/sdks/audiences/README.md#createaudience) - Create audience
- [`audiencesGenerateAudienceSummary`](docs/sdks/audiences/README.md#generateaudiencesummary) - Generate summary
- [`audiencesGenerateAudienceSummary`](docs/sdks/audiences/README.md#generateaudiencesummary) - Generate summary (async)
- [`audiencesGetAudience`](docs/sdks/audiences/README.md#getaudience) - Get audience
- [`audiencesGetAudienceSummary`](docs/sdks/audiences/README.md#getaudiencesummary) - Get latest summary
- [`audiencesGetMemberDefaultAudience`](docs/sdks/audiences/README.md#getmemberdefaultaudience) - Get default audience
Expand Down Expand Up @@ -1130,6 +1136,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`retrospectivesGetIncidentRetrospectiveField`](docs/sdks/retrospectives/README.md#getincidentretrospectivefield) - Get a retrospective field
- [`retrospectivesGetPostMortemQuestion`](docs/sdks/retrospectives/README.md#getpostmortemquestion) - Get a retrospective question
- [`retrospectivesGetPostMortemReport`](docs/sdks/retrospectives/README.md#getpostmortemreport) - Get a retrospective report
- [`retrospectivesGetRetrospectiveReportTemplate`](docs/sdks/retrospectives/README.md#getretrospectivereporttemplate) - Get a retrospective report template
- [`retrospectivesGetRetrospectiveTemplate`](docs/sdks/retrospectives/README.md#getretrospectivetemplate) - Get a retrospective template
- [`retrospectivesListIncidentRetrospectives`](docs/sdks/retrospectives/README.md#listincidentretrospectives) - All attached retrospectives for an incident
- [`retrospectivesListPostMortemQuestions`](docs/sdks/retrospectives/README.md#listpostmortemquestions) - List retrospective questions
Expand Down Expand Up @@ -1279,11 +1286,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`teamsUpdateTeam`](docs/sdks/teams/README.md#updateteam) - Update a team
- [`ticketingCreateInboundFieldMap`](docs/sdks/ticketing/README.md#createinboundfieldmap) - Create inbound field map for a ticketing project
- [`ticketingCreateTicket`](docs/sdks/ticketing/README.md#createticket) - Create a ticket
- [`ticketingCreateTicketingCustomDefinition`](docs/sdks/ticketing/README.md#createticketingcustomdefinition) - Create a ticketing custom field
- [`ticketingCreateTicketingFieldMap`](docs/sdks/ticketing/README.md#createticketingfieldmap) - Create a field mapping for a ticketing project
- [`ticketingCreateTicketingPriority`](docs/sdks/ticketing/README.md#createticketingpriority) - Create a ticketing priority
- [`ticketingCreateTicketingProjectConfig`](docs/sdks/ticketing/README.md#createticketingprojectconfig) - Create a ticketing project configuration
- [`ticketingDeleteInboundFieldMap`](docs/sdks/ticketing/README.md#deleteinboundfieldmap) - Archive inbound field map for a ticketing project
- [`ticketingDeleteTicket`](docs/sdks/ticketing/README.md#deleteticket) - Archive a ticket
- [`ticketingDeleteTicketingCustomDefinition`](docs/sdks/ticketing/README.md#deleteticketingcustomdefinition) - Delete a ticketing custom field
- [`ticketingDeleteTicketingFieldMap`](docs/sdks/ticketing/README.md#deleteticketingfieldmap) - Archive a field map for a ticketing project
- [`ticketingDeleteTicketingPriority`](docs/sdks/ticketing/README.md#deleteticketingpriority) - Delete a ticketing priority
- [`ticketingDeleteTicketingProjectConfig`](docs/sdks/ticketing/README.md#deleteticketingprojectconfig) - Archive a ticketing project configuration
Expand All @@ -1292,18 +1301,21 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`ticketingGetOptionsForField`](docs/sdks/ticketing/README.md#getoptionsforfield) - List a field's configuration options for a ticketing project
- [`ticketingGetTicket`](docs/sdks/ticketing/README.md#getticket) - Get a ticket
- [`ticketingGetTicketingFieldMap`](docs/sdks/ticketing/README.md#getticketingfieldmap) - Get a field map for a ticketing project
- [`ticketingGetTicketingFormConfiguration`](docs/sdks/ticketing/README.md#getticketingformconfiguration) - Get the ticketing form configuration
- [`ticketingGetTicketingPriority`](docs/sdks/ticketing/README.md#getticketingpriority) - Get a ticketing priority
- [`ticketingGetTicketingProject`](docs/sdks/ticketing/README.md#getticketingproject) - Get a ticketing project
- [`ticketingGetTicketingProjectConfig`](docs/sdks/ticketing/README.md#getticketingprojectconfig) - Get configuration for a ticketing project
- [`ticketingListAvailableInboundFieldMaps`](docs/sdks/ticketing/README.md#listavailableinboundfieldmaps) - List available fields for ticket field mapping
- [`ticketingListAvailableTicketingFieldMaps`](docs/sdks/ticketing/README.md#listavailableticketingfieldmaps) - List available fields for ticket field mapping
- [`ticketingListInboundFieldMaps`](docs/sdks/ticketing/README.md#listinboundfieldmaps) - List inbound field maps for a ticketing project
- [`ticketingListTicketingCustomDefinitions`](docs/sdks/ticketing/README.md#listticketingcustomdefinitions) - List ticketing custom fields
- [`ticketingListTicketingPriorities`](docs/sdks/ticketing/README.md#listticketingpriorities) - List ticketing priorities
- [`ticketingListTicketingProjects`](docs/sdks/ticketing/README.md#listticketingprojects) - List ticketing projects
- [`ticketingListTickets`](docs/sdks/ticketing/README.md#listtickets) - List tickets
- [`ticketingListTicketTags`](docs/sdks/ticketing/README.md#listtickettags) - List ticket tags
- [`ticketingUpdateInboundFieldMap`](docs/sdks/ticketing/README.md#updateinboundfieldmap) - Update inbound field map for a ticketing project
- [`ticketingUpdateTicket`](docs/sdks/ticketing/README.md#updateticket) - Update a ticket
- [`ticketingUpdateTicketingCustomDefinition`](docs/sdks/ticketing/README.md#updateticketingcustomdefinition) - Update a ticketing custom field
- [`ticketingUpdateTicketingFieldMap`](docs/sdks/ticketing/README.md#updateticketingfieldmap) - Update a field map for a ticketing project
- [`ticketingUpdateTicketingPriority`](docs/sdks/ticketing/README.md#updateticketingpriority) - Update a ticketing priority
- [`ticketingUpdateTicketingProjectConfig`](docs/sdks/ticketing/README.md#updateticketingprojectconfig) - Update configuration for a ticketing project
Expand Down Expand Up @@ -1491,7 +1503,7 @@ run();


**Inherit from [`FirehydrantError`](./src/models/errors/firehydranterror.ts)**:
* [`ErrorEntity`](./src/models/errors/errorentity.ts): ErrorEntity model. Applicable to 12 of 450 methods.*
* [`ErrorEntity`](./src/models/errors/errorentity.ts): ErrorEntity model. Applicable to 12 of 456 methods.*
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.

</details>
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,4 +246,14 @@ Based on:
### Generated
- [typescript v1.1.0] .
### Releases
- [NPM v1.1.0] https://www.npmjs.com/package/firehydrant-typescript-sdk/v/1.1.0 - .
- [NPM v1.1.0] https://www.npmjs.com/package/firehydrant-typescript-sdk/v/1.1.0 - .

## 2025-12-05 00:07:58
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.668.0 (2.770.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v1.2.0] .
### Releases
- [NPM v1.2.0] https://www.npmjs.com/package/firehydrant-typescript-sdk/v/1.2.0 - .
14 changes: 14 additions & 0 deletions docs/models/components/content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Content

## Example Usage

```typescript
import { Content } from "firehydrant-typescript-sdk/models/components";

let value: Content = {};
```

## Fields

| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |
1 change: 1 addition & 0 deletions docs/models/components/createfunctionality.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ let value: CreateFunctionality = {
| `description` | *string* | :heavy_minus_sign: | N/A |
| `services` | [components.CreateFunctionalityService](../../models/components/createfunctionalityservice.md)[] | :heavy_minus_sign: | N/A |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | A hash of label keys and values |
| `serviceTier` | [components.CreateFunctionalityServiceTier](../../models/components/createfunctionalityservicetier.md) | :heavy_minus_sign: | Integer representing functionality tier. Lower values represent higher criticality. Default is 5. |
| `alertOnAdd` | *boolean* | :heavy_minus_sign: | N/A |
| `autoAddRespondingTeam` | *boolean* | :heavy_minus_sign: | N/A |
| `externalResources` | [components.CreateFunctionalityExternalResource](../../models/components/createfunctionalityexternalresource.md)[] | :heavy_minus_sign: | An array of external resources to attach to this service. |
Expand Down
17 changes: 17 additions & 0 deletions docs/models/components/createfunctionalityservicetier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# CreateFunctionalityServiceTier

Integer representing functionality tier. Lower values represent higher criticality. Default is 5.

## Example Usage

```typescript
import { CreateFunctionalityServiceTier } from "firehydrant-typescript-sdk/models/components";

let value: CreateFunctionalityServiceTier = 1;
```

## Values

```typescript
0 | 1 | 2 | 3 | 4 | 5
```
Loading