(tickets)
List all of the tickets that have been added to the organiation
import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});
async function run() {
const result = await firehydrantTypescriptSDK.tickets.list({});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { ticketsList } from "firehydrant-typescript-sdk/funcs/ticketsList.js";
// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});
async function run() {
const res = await ticketsList(firehydrantTypescriptSDK, {});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.ListTicketsRequest | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | 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 | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<components.TicketingTicketEntity>
Error Type | Status Code | Content Type |
---|---|---|
errors.BadRequest | 400, 413, 414, 415, 422, 431, 510 | application/json |
errors.Unauthorized | 401, 403, 407, 511 | application/json |
errors.NotFound | 404, 501, 505 | application/json |
errors.Timeout | 408, 504 | application/json |
errors.RateLimited | 429 | application/json |
errors.InternalServerError | 500, 502, 503, 506, 507, 508 | application/json |
errors.APIError | 4XX, 5XX | */* |
Creates a ticket for a project
import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});
async function run() {
const result = await firehydrantTypescriptSDK.tickets.create({
summary: "<value>",
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { ticketsCreate } from "firehydrant-typescript-sdk/funcs/ticketsCreate.js";
// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});
async function run() {
const res = await ticketsCreate(firehydrantTypescriptSDK, {
summary: "<value>",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.PostV1TicketingTickets | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | 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 | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<components.TicketingTicketEntity>
Error Type | Status Code | Content Type |
---|---|---|
errors.BadRequest | 400, 413, 414, 415, 422, 431, 510 | application/json |
errors.Unauthorized | 401, 403, 407, 511 | application/json |
errors.NotFound | 404, 501, 505 | application/json |
errors.Timeout | 408, 504 | application/json |
errors.RateLimited | 429 | application/json |
errors.InternalServerError | 500, 502, 503, 506, 507, 508 | application/json |
errors.APIError | 4XX, 5XX | */* |
Delete a ticket
import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});
async function run() {
await firehydrantTypescriptSDK.tickets.delete({
ticketId: "<id>",
});
}
run();
The standalone function version of this method:
import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { ticketsDelete } from "firehydrant-typescript-sdk/funcs/ticketsDelete.js";
// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});
async function run() {
const res = await ticketsDelete(firehydrantTypescriptSDK, {
ticketId: "<id>",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.DeleteTicketRequest | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | 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 | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<void>
Error Type | Status Code | Content Type |
---|---|---|
errors.BadRequest | 400, 413, 414, 415, 422, 431, 510 | application/json |
errors.Unauthorized | 401, 403, 407, 511 | application/json |
errors.NotFound | 404, 501, 505 | application/json |
errors.Timeout | 408, 504 | application/json |
errors.RateLimited | 429 | application/json |
errors.InternalServerError | 500, 502, 503, 506, 507, 508 | application/json |
errors.APIError | 4XX, 5XX | */* |
Update a ticket's attributes
import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});
async function run() {
const result = await firehydrantTypescriptSDK.tickets.update({
ticketId: "<id>",
patchV1TicketingTicketsTicketId: {},
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { ticketsUpdate } from "firehydrant-typescript-sdk/funcs/ticketsUpdate.js";
// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});
async function run() {
const res = await ticketsUpdate(firehydrantTypescriptSDK, {
ticketId: "<id>",
patchV1TicketingTicketsTicketId: {},
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.UpdateTicketRequest | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | 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 | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<components.TicketingTicketEntity>
Error Type | Status Code | Content Type |
---|---|---|
errors.BadRequest | 400, 413, 414, 415, 422, 431, 510 | application/json |
errors.Unauthorized | 401, 403, 407, 511 | application/json |
errors.NotFound | 404, 501, 505 | application/json |
errors.Timeout | 408, 504 | application/json |
errors.RateLimited | 429 | application/json |
errors.InternalServerError | 500, 502, 503, 506, 507, 508 | application/json |
errors.APIError | 4XX, 5XX | */* |