firehydrantgosdk

package module
v1.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 3, 2025 License: MIT Imports: 14 Imported by: 1

README

Manage incidents from ring to retro

Developer-friendly & type-safe Go SDK specifically catered to leverage FireHydrant API.

Summary

FireHydrant API: The FireHydrant API is based around REST. It uses Bearer token authentication and returns JSON responses. You can use the FireHydrant API to configure integrations, define incidents, and set up webhooks--anything you can do on the FireHydrant UI.

Base API endpoint

https://api.firehydrant.io/v1

Current version

v1

Authentication

All requests to the FireHydrant API require an Authorization header with the value set to Bearer {token}. FireHydrant supports bot tokens to act on behalf of a computer instead of a user's account. This prevents integrations from breaking when people leave your organization or their token is revoked. See the Bot tokens section (below) for more information on this.

An example of a header to authenticate against FireHydrant would look like:

Authorization: Bearer fhb-thisismytoken

Bot tokens

To access the FireHydrant API, you must authenticate with a bot token. (You must have owner permissions on your organization to see bot tokens.) Bot users allow you to interact with the FireHydrant API by using token-based authentication. To create bot tokens, log in to your organization and refer to the Bot users page.

Bot tokens enable you to create a bot that has no ties to any user. Normally, all actions associated with an API token are associated with the user who created it. Bot tokens attribute all actions to the bot user itself. This way, all data associated with the token actions can be performed against the FireHydrant API without a user.

Every request to the API is authenticated unless specified otherwise.

Rate Limiting

Currently, requests made with bot tokens are rate limited on a per-account level. If your account has multiple bot token then the rate limit is shared across all of them. As of February 7th, 2023, the rate limit is at least 50 requests per account every 10 seconds, or 300 requests per minute.

Rate limited responses will be served with a 429 status code and a JSON body of:

{"error": "rate limit exceeded"}

and headers of:

"RateLimit-Limit" -> the maximum number of requests in the rate limit pool
"Retry-After" -> the number of seconds to wait before trying again

How lists are returned

API lists are returned as arrays. A paginated entity in FireHydrant will return two top-level keys in the response object: a data key and a pagination key.

Paginated requests

The data key is returned as an array. Each item in the array includes all of the entity data specified in the API endpoint. (The per-page default for the array is 20 items.)

Pagination is the second key (pagination) returned in the overall response body. It includes medtadata around the current page, total count of items, and options to go to the next and previous page. All of the specifications returned in the pagination object are available as URL parameters. So if you want to specify, for example, going to the second page of a response, you can send a request to the same endpoint but pass the URL parameter page=2.

For example, you might request https://api.firehydrant.io/v1/environments/ to retrieve environments data. The JSON returned contains the above-mentioned data section and pagination section. The data section includes various details about an incident, such as the environment name, description, and when it was created.

{
  "data": [
    {
      "id": "f8125cf4-b3a7-4f88-b5ab-57a60b9ed89b",
      "name": "Production - GCP",
      "description": "",
      "created_at": "2021-02-17T20:02:10.679Z"
    },
    {
      "id": "a69f1f58-af77-4708-802d-7e73c0bf261c",
      "name": "Staging",
      "description": "",
      "created_at": "2021-04-16T13:41:59.418Z"
    }
  ],
  "pagination": {
    "count": 2,
    "page": 1,
    "items": 2,
    "pages": 1,
    "last": 1,
    "prev": null,
    "next": null
  }
}

To request the second page, you'd request the same endpoint with the additional query parameter of page in the URL:

GET https://api.firehydrant.io/v1/environments?page=2

If you need to modify the number of records coming back from FireHydrant, you can use the per_page parameter (max is 200):

GET https://api.firehydrant.io/v1/environments?per_page=50

Table of Contents

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/firehydrant/firehydrant-go-sdk

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
APIKey apiKey API key

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	firehydrantgosdk "github.com/firehydrant/firehydrant-go-sdk"
	"github.com/firehydrant/firehydrant-go-sdk/models/components"
	"log"
)

func main() {
	ctx := context.Background()

	s := firehydrantgosdk.New(
		firehydrantgosdk.WithSecurity(components.Security{
			APIKey: "<YOUR_API_KEY_HERE>",
		}),
	)

	res, err := s.AccountSettings.Ping(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

SDK Example Usage

Example

package main

import (
	"context"
	firehydrantgosdk "github.com/firehydrant/firehydrant-go-sdk"
	"github.com/firehydrant/firehydrant-go-sdk/models/components"
	"log"
)

func main() {
	ctx := context.Background()

	s := firehydrantgosdk.New(
		firehydrantgosdk.WithSecurity(components.Security{
			APIKey: "<YOUR_API_KEY_HERE>",
		}),
	)

	res, err := s.AccountSettings.Ping(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

AccountSettings

Alerts

Audiences

AuditEvents

CallRoutes

CatalogEntries

Changes

Communication

Conversations

Incidents

IncidentSettings

Integrations

MetricsReporting

Pages

Permissions

Retrospectives

Roles

Runbooks

Scim

Signals

StatusPages

Tasks

Teams

Ticketing

Users

Webhooks

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	firehydrantgosdk "github.com/firehydrant/firehydrant-go-sdk"
	"github.com/firehydrant/firehydrant-go-sdk/models/components"
	"github.com/firehydrant/firehydrant-go-sdk/retry"
	"log"
	"models/operations"
)

func main() {
	ctx := context.Background()

	s := firehydrantgosdk.New(
		firehydrantgosdk.WithSecurity(components.Security{
			APIKey: "<YOUR_API_KEY_HERE>",
		}),
	)

	res, err := s.AccountSettings.Ping(ctx, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	firehydrantgosdk "github.com/firehydrant/firehydrant-go-sdk"
	"github.com/firehydrant/firehydrant-go-sdk/models/components"
	"github.com/firehydrant/firehydrant-go-sdk/retry"
	"log"
)

func main() {
	ctx := context.Background()

	s := firehydrantgosdk.New(
		firehydrantgosdk.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		firehydrantgosdk.WithSecurity(components.Security{
			APIKey: "<YOUR_API_KEY_HERE>",
		}),
	)

	res, err := s.AccountSettings.Ping(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return sdkerrors.SDKError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the CreateService function may return the following errors:

Error Type Status Code Content Type
sdkerrors.ErrorEntity 400 application/json
sdkerrors.SDKError 4XX, 5XX */*

Example

package main

import (
	"context"
	"errors"
	firehydrantgosdk "github.com/firehydrant/firehydrant-go-sdk"
	"github.com/firehydrant/firehydrant-go-sdk/models/components"
	"github.com/firehydrant/firehydrant-go-sdk/models/sdkerrors"
	"log"
)

func main() {
	ctx := context.Background()

	s := firehydrantgosdk.New(
		firehydrantgosdk.WithSecurity(components.Security{
			APIKey: "<YOUR_API_KEY_HERE>",
		}),
	)

	res, err := s.CatalogEntries.CreateService(ctx, components.CreateService{
		Name: "<value>",
	})
	if err != nil {

		var e *sdkerrors.ErrorEntity
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Override Server URL Per-Client

The default server can be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	firehydrantgosdk "github.com/firehydrant/firehydrant-go-sdk"
	"github.com/firehydrant/firehydrant-go-sdk/models/components"
	"log"
)

func main() {
	ctx := context.Background()

	s := firehydrantgosdk.New(
		firehydrantgosdk.WithServerURL("https://api.firehydrant.io/"),
		firehydrantgosdk.WithSecurity(components.Security{
			APIKey: "<YOUR_API_KEY_HERE>",
		}),
	)

	res, err := s.AccountSettings.Ping(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"

	"github.com/firehydrant/firehydrant-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = firehydrantgosdk.New(firehydrantgosdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Special Types

This SDK defines the following custom types to assist with marshalling and unmarshalling data.

Date

types.Date is a wrapper around time.Time that allows for JSON marshaling a date string formatted as "2006-01-02".

Usage
d1 := types.NewDate(time.Now()) // returns *types.Date

d2 := types.DateFromTime(time.Now()) // returns types.Date

d3, err := types.NewDateFromString("2019-01-01") // returns *types.Date, error

d4, err := types.DateFromString("2019-01-01") // returns types.Date, error

d5 := types.MustNewDateFromString("2019-01-01") // returns *types.Date and panics on error

d6 := types.MustDateFromString("2019-01-01") // returns types.Date and panics on error

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ServerList = []string{
	"https://api.firehydrant.io/",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool 

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32 

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64 

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int 

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64 

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func Pointer 

func Pointer[T any](v T) *T

Pointer provides a helper function to return a pointer to a type

func String 

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type AccountSettings 

type AccountSettings struct {
	// contains filtered or unexported fields
}

AccountSettings - Operations related to Account Settings

func (*AccountSettings) GetAiPreferences 

func (s *AccountSettings) GetAiPreferences(ctx context.Context, opts ...operations.Option) (*components.AIEntitiesPreferencesEntity, error)

GetAiPreferences - Get AI preferences Retrieves the current AI preferences

func (*AccountSettings) GetBootstrap 

func (s *AccountSettings) GetBootstrap(ctx context.Context, opts ...operations.Option) (*components.PublicAPIV1BootstrapEntity, error)

GetBootstrap - Get initial application configuration Get initial application configuration

func (*AccountSettings) ListEntitlements 

func (s *AccountSettings) ListEntitlements(ctx context.Context, name *string, type_ *operations.ListEntitlementsType, opts ...operations.Option) (*components.EntitlementEntityPaginated, error)

ListEntitlements - List entitlements List the organization's entitlements

func (*AccountSettings) Ping 

func (s *AccountSettings) Ping(ctx context.Context, opts ...operations.Option) (*components.PongEntity, error)

Ping - Check API connectivity Simple endpoint to verify your API connection is working

func (*AccountSettings) PingNoauth 

func (s *AccountSettings) PingNoauth(ctx context.Context, opts ...operations.Option) (*components.PongEntity, error)

PingNoauth - Check API connectivity Simple endpoint to verify your API connection is working

func (*AccountSettings) UpdateAiPreferences 

func (s *AccountSettings) UpdateAiPreferences(ctx context.Context, request *operations.UpdateAiPreferencesRequest, opts ...operations.Option) (*components.AIEntitiesPreferencesEntity, error)

UpdateAiPreferences - Update AI preferences Updates the AI preferences

type Alerts 

type Alerts struct {
	// contains filtered or unexported fields
}

Alerts - Operations related to Alerts

func (*Alerts) CreateIncidentAlert 

func (s *Alerts) CreateIncidentAlert(ctx context.Context, incidentID string, requestBody []string, opts ...operations.Option) error

CreateIncidentAlert - Attach an alert to an incident Add an alert to an incident. FireHydrant needs to have ingested the alert from a third party system in order to attach it to the incident.

func (*Alerts) DeleteIncidentAlert 

func (s *Alerts) DeleteIncidentAlert(ctx context.Context, incidentAlertID string, incidentID string, opts ...operations.Option) error

DeleteIncidentAlert - Remove an alert from an incident Remove an alert from an incident

func (*Alerts) GetAlert 

func (s *Alerts) GetAlert(ctx context.Context, alertID string, opts ...operations.Option) (*components.AlertsAlertEntity, error)

GetAlert - Get an alert Retrieve a single alert

func (*Alerts) ListAlerts 

func (s *Alerts) ListAlerts(ctx context.Context, request operations.ListAlertsRequest, opts ...operations.Option) (*components.AlertsAlertEntityPaginated, error)

ListAlerts - List alerts Retrieve all alerts, including Signals alerts and third-party

func (*Alerts) ListIncidentAlerts 

func (s *Alerts) ListIncidentAlerts(ctx context.Context, incidentID string, opts ...operations.Option) (*components.IncidentsAlertEntityPaginated, error)

ListIncidentAlerts - List alerts for an incident List alerts that have been attached to an incident

func (*Alerts) ListProcessingLogEntries 

func (s *Alerts) ListProcessingLogEntries(ctx context.Context, request operations.ListProcessingLogEntriesRequest, opts ...operations.Option) (*components.AlertsProcessingLogEntryEntityPaginated, error)

ListProcessingLogEntries - List alert processing log entries Processing Log Entries for a specific alert

func (*Alerts) UpdateIncidentAlertPrimary 

func (s *Alerts) UpdateIncidentAlertPrimary(ctx context.Context, incidentAlertID string, incidentID string, updateIncidentAlertPrimary components.UpdateIncidentAlertPrimary, opts ...operations.Option) (*components.IncidentsAlertEntity, error)

UpdateIncidentAlertPrimary - Set an alert as primary for an incident Setting an alert as primary will overwrite milestone times in the FireHydrant incident with times included in the primary alert. Services attached to the primary alert will also be automatically added to the incident.

func (*Alerts) UpdateSignalsAlert 

func (s *Alerts) UpdateSignalsAlert(ctx context.Context, id string, updateSignalsAlert components.UpdateSignalsAlert, opts ...operations.Option) (*components.AlertsSignalAlertEntity, error)

UpdateSignalsAlert - Update a Signal alert Update a Signal alert

type Audiences 

type Audiences struct {
	// contains filtered or unexported fields
}

Audiences - Operations related to Audiences

func (*Audiences) ArchiveAudience 

func (s *Audiences) ArchiveAudience(ctx context.Context, audienceID string, opts ...operations.Option) error

ArchiveAudience - Archive audience Archive an audience

func (*Audiences) CreateAudience 

func (s *Audiences) CreateAudience(ctx context.Context, request components.CreateAudience, opts ...operations.Option) (*components.AudiencesEntitiesAudienceEntity, error)

CreateAudience - Create audience Create a new audience

func (*Audiences) GenerateAudienceSummary 

func (s *Audiences) GenerateAudienceSummary(ctx context.Context, audienceID string, incidentID string, requestBody *operations.GenerateAudienceSummaryRequestBody, opts ...operations.Option) (*components.AIEntitiesIncidentSummaryEntity, error)

GenerateAudienceSummary - Generate summary Generate a new audience-specific summary for an incident

func (*Audiences) GetAudience 

func (s *Audiences) GetAudience(ctx context.Context, audienceID string, opts ...operations.Option) (*components.AudiencesEntitiesAudienceEntity, error)

GetAudience - Get audience Get audience details

func (*Audiences) GetAudienceSummary 

func (s *Audiences) GetAudienceSummary(ctx context.Context, audienceID string, incidentID string, opts ...operations.Option) (*components.AIEntitiesIncidentSummaryEntity, error)

GetAudienceSummary - Get latest summary Get the latest audience-specific summary for an incident

func (*Audiences) GetMemberDefaultAudience 

func (s *Audiences) GetMemberDefaultAudience(ctx context.Context, memberID int, opts ...operations.Option) (*components.AudiencesEntitiesAudienceEntity, error)

GetMemberDefaultAudience - Get default audience Get member's default audience

func (*Audiences) ListAudienceSummaries 

func (s *Audiences) ListAudienceSummaries(ctx context.Context, incidentID string, opts ...operations.Option) (*components.AudiencesEntitiesAudienceSummariesEntity, error)

ListAudienceSummaries - List audience summaries List all audience summaries for an incident

func (*Audiences) ListAudiences 

func (s *Audiences) ListAudiences(ctx context.Context, includeArchived *bool, opts ...operations.Option) (*components.AudiencesEntitiesAudienceEntity, error)

ListAudiences - List audiences List all audiences

func (*Audiences) RestoreAudience 

func (s *Audiences) RestoreAudience(ctx context.Context, audienceID string, opts ...operations.Option) (*components.AudiencesEntitiesAudienceEntity, error)

RestoreAudience - Restore audience Restore a previously archived audience

func (*Audiences) SetMemberDefaultAudience 

func (s *Audiences) SetMemberDefaultAudience(ctx context.Context, memberID int, requestBody operations.SetMemberDefaultAudienceRequestBody, opts ...operations.Option) (*components.AudiencesEntitiesAudienceEntity, error)

SetMemberDefaultAudience - Set default audience Set member's default audience

func (*Audiences) UpdateAudience 

func (s *Audiences) UpdateAudience(ctx context.Context, audienceID string, requestBody *operations.UpdateAudienceRequestBody, opts ...operations.Option) (*components.AudiencesEntitiesAudienceEntity, error)

UpdateAudience - Update audience Update an existing audience

type AuditEvents 

type AuditEvents struct {
	// contains filtered or unexported fields
}

AuditEvents - Operations about Audit Events

func (*AuditEvents) GetAuditEvent 

func (s *AuditEvents) GetAuditEvent(ctx context.Context, id string, opts ...operations.Option) error

GetAuditEvent - Get a single audit event Get a single audit event

func (*AuditEvents) ListAuditEvents 

func (s *AuditEvents) ListAuditEvents(ctx context.Context, cursor *string, filter *string, limit *int, opts ...operations.Option) error

ListAuditEvents - List audit events List audit events

type CallRoutes 

type CallRoutes struct {
	// contains filtered or unexported fields
}

CallRoutes - Operations about Call Routes

func (*CallRoutes) CreateTeamCallRoute 

func (s *CallRoutes) CreateTeamCallRoute(ctx context.Context, teamID string, createTeamCallRoute components.CreateTeamCallRoute, opts ...operations.Option) (*components.SignalsAPICallRouteEntity, error)

CreateTeamCallRoute - Create a call route for a team Create a call route for a team

func (*CallRoutes) DeleteCallRoute 

func (s *CallRoutes) DeleteCallRoute(ctx context.Context, id string, opts ...operations.Option) error

DeleteCallRoute - Delete a call route Delete a call route by ID

func (*CallRoutes) GetCallRoute 

func (s *CallRoutes) GetCallRoute(ctx context.Context, id string, opts ...operations.Option) (*components.SignalsAPICallRouteEntity, error)

GetCallRoute - Retrieve a call route Retrieve a call route by ID

func (*CallRoutes) ListCallRoutes 

func (s *CallRoutes) ListCallRoutes(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.SignalsAPICallRouteEntityPaginated, error)

ListCallRoutes - List call routes List call routes for the organization

func (*CallRoutes) ListTeamCallRoutes 

func (s *CallRoutes) ListTeamCallRoutes(ctx context.Context, teamID string, opts ...operations.Option) (*components.SignalsAPICallRouteEntityPaginated, error)

ListTeamCallRoutes - List call routes for a team List call routes for a team

func (*CallRoutes) UpdateCallRoute 

func (s *CallRoutes) UpdateCallRoute(ctx context.Context, id string, updateCallRoute components.UpdateCallRoute, opts ...operations.Option) (*components.SignalsAPICallRouteEntity, error)

UpdateCallRoute - Update a call route Update a call route by ID

type CatalogEntries 

type CatalogEntries struct {
	// contains filtered or unexported fields
}

CatalogEntries - Operations related to Catalog Entries

func (*CatalogEntries) CreateEnvironment 

func (s *CatalogEntries) CreateEnvironment(ctx context.Context, request components.CreateEnvironment, opts ...operations.Option) (*components.EnvironmentEntryEntity, error)

CreateEnvironment - Create an environment Creates an environment for the organization

func (*CatalogEntries) CreateFunctionality 

func (s *CatalogEntries) CreateFunctionality(ctx context.Context, request components.CreateFunctionality, opts ...operations.Option) (*components.FunctionalityEntity, error)

CreateFunctionality - Create a functionality Creates a functionality for the organization

func (*CatalogEntries) CreateService 

func (s *CatalogEntries) CreateService(ctx context.Context, request components.CreateService, opts ...operations.Option) (*components.ServiceEntity, error)

CreateService - Create a service Creates a service for the organization, you may also create or attach functionalities to the service on create.

func (*CatalogEntries) CreateServiceChecklistResponse 

func (s *CatalogEntries) CreateServiceChecklistResponse(ctx context.Context, serviceID string, checklistID string, createServiceChecklistResponse components.CreateServiceChecklistResponse, opts ...operations.Option) error

CreateServiceChecklistResponse - Record a response for a checklist item Creates a response for a checklist item

func (*CatalogEntries) CreateServiceDependency 

func (s *CatalogEntries) CreateServiceDependency(ctx context.Context, request components.CreateServiceDependency, opts ...operations.Option) (*components.ServiceDependencyEntity, error)

CreateServiceDependency - Create a service dependency Creates a service dependency relationship between two services 

func (s *CatalogEntries) CreateServiceLinks(ctx context.Context, request components.CreateServiceLinks, opts ...operations.Option) ([]components.ServiceLinkEntity, error)

CreateServiceLinks - Create multiple services linked to external services Creates a service with the appropriate integration for each external service ID passed

func (*CatalogEntries) DeleteEnvironment 

func (s *CatalogEntries) DeleteEnvironment(ctx context.Context, environmentID string, opts ...operations.Option) error

DeleteEnvironment - Archive an environment Archive an environment

func (*CatalogEntries) DeleteFunctionality 

func (s *CatalogEntries) DeleteFunctionality(ctx context.Context, functionalityID string, opts ...operations.Option) error

DeleteFunctionality - Archive a functionality Archive a functionality

func (*CatalogEntries) DeleteService 

func (s *CatalogEntries) DeleteService(ctx context.Context, serviceID string, opts ...operations.Option) error

DeleteService - Delete a service Deletes the service from FireHydrant.

func (*CatalogEntries) DeleteServiceDependency 

func (s *CatalogEntries) DeleteServiceDependency(ctx context.Context, serviceDependencyID string, opts ...operations.Option) error

DeleteServiceDependency - Delete a service dependency Deletes a single service dependency 

func (s *CatalogEntries) DeleteServiceLink(ctx context.Context, serviceID string, remoteID string, opts ...operations.Option) error

DeleteServiceLink - Delete a service link Deletes a service link from FireHydrant.

func (*CatalogEntries) GetEnvironment 

func (s *CatalogEntries) GetEnvironment(ctx context.Context, environmentID string, opts ...operations.Option) (*components.EnvironmentEntryEntity, error)

GetEnvironment - Get an environment Retrieves a single environment by ID

func (*CatalogEntries) GetFunctionality 

func (s *CatalogEntries) GetFunctionality(ctx context.Context, functionalityID string, opts ...operations.Option) (*components.FunctionalityEntity, error)

GetFunctionality - Get a functionality Retrieves a single functionality by ID

func (*CatalogEntries) GetService 

func (s *CatalogEntries) GetService(ctx context.Context, serviceID string, opts ...operations.Option) (*components.ServiceEntity, error)

GetService - Get a service Retrieves a single service by ID

func (*CatalogEntries) GetServiceDependencies 

func (s *CatalogEntries) GetServiceDependencies(ctx context.Context, serviceID string, flatten *bool, opts ...operations.Option) (*components.ServiceWithAllDependenciesEntity, error)

GetServiceDependencies - List dependencies for a service Retrieves a service's dependencies

func (*CatalogEntries) GetServiceDependency 

func (s *CatalogEntries) GetServiceDependency(ctx context.Context, serviceDependencyID string, opts ...operations.Option) (*components.ServiceDependencyEntity, error)

GetServiceDependency - Get a service dependency Retrieves a single service dependency by ID

func (*CatalogEntries) IngestCatalogData 

func (s *CatalogEntries) IngestCatalogData(ctx context.Context, catalogID string, ingestCatalogData components.IngestCatalogData, opts ...operations.Option) (*components.ImportsImportEntity, error)

IngestCatalogData - Ingest service catalog data Accepts catalog data in the configured format and asyncronously processes the data to incorporate changes into service catalog.

func (*CatalogEntries) ListEnvironments 

func (s *CatalogEntries) ListEnvironments(ctx context.Context, page *int, perPage *int, query *string, name *string, opts ...operations.Option) (*components.EnvironmentEntryEntityPaginated, error)

ListEnvironments - List environments List all of the environments that have been added to the organiation

func (*CatalogEntries) ListFunctionalities 

func (s *CatalogEntries) ListFunctionalities(ctx context.Context, request operations.ListFunctionalitiesRequest, opts ...operations.Option) (*components.FunctionalityEntityPaginated, error)

ListFunctionalities - List functionalities List all of the functionalities that have been added to the organiation

func (*CatalogEntries) ListFunctionalityServices 

func (s *CatalogEntries) ListFunctionalityServices(ctx context.Context, functionalityID string, opts ...operations.Option) (*components.FunctionalityWithAllServicesEntity, error)

ListFunctionalityServices - List services for a functionality List services for a functionality

func (*CatalogEntries) ListInfrastructures 

func (s *CatalogEntries) ListInfrastructures(ctx context.Context, request operations.ListInfrastructuresRequest, opts ...operations.Option) (*components.InfrastructureSearchEntity, error)

ListInfrastructures - Lists functionality, service and environment objects Lists functionality, service and environment objects

func (*CatalogEntries) ListServiceAvailableDownstreamDependencies 

func (s *CatalogEntries) ListServiceAvailableDownstreamDependencies(ctx context.Context, serviceID string, opts ...operations.Option) (*components.ServiceEntityLite, error)

ListServiceAvailableDownstreamDependencies - List available downstream service dependencies Retrieves all services that are available to be downstream dependencies

func (*CatalogEntries) ListServiceAvailableUpstreamDependencies 

func (s *CatalogEntries) ListServiceAvailableUpstreamDependencies(ctx context.Context, serviceID string, opts ...operations.Option) (*components.ServiceEntityLite, error)

ListServiceAvailableUpstreamDependencies - List available upstream service dependencies Retrieves all services that are available to be upstream dependencies

func (*CatalogEntries) ListServices 

func (s *CatalogEntries) ListServices(ctx context.Context, request operations.ListServicesRequest, opts ...operations.Option) (*components.ServiceEntityPaginated, error)

ListServices - List services List all of the services that have been added to the organization.

func (*CatalogEntries) ListUserOwnedServices 

func (s *CatalogEntries) ListUserOwnedServices(ctx context.Context, id string, page *int, perPage *int, opts ...operations.Option) ([]components.TeamEntityPaginated, error)

ListUserOwnedServices - List services owned by a user's teams Retrieves a list of services owned by the teams a user is on

func (*CatalogEntries) RefreshCatalog 

func (s *CatalogEntries) RefreshCatalog(ctx context.Context, catalogID string, opts ...operations.Option) error

RefreshCatalog - Refresh a service catalog Schedules an async task to re-import catalog info and update catalog data accordingly.

func (*CatalogEntries) UpdateEnvironment 

func (s *CatalogEntries) UpdateEnvironment(ctx context.Context, environmentID string, updateEnvironment components.UpdateEnvironment, opts ...operations.Option) (*components.EnvironmentEntryEntity, error)

UpdateEnvironment - Update an environment Update a environments attributes

func (*CatalogEntries) UpdateFunctionality 

func (s *CatalogEntries) UpdateFunctionality(ctx context.Context, functionalityID string, updateFunctionality components.UpdateFunctionality, opts ...operations.Option) (*components.FunctionalityEntity, error)

UpdateFunctionality - Update a functionality Update a functionalities attributes

func (*CatalogEntries) UpdateService 

func (s *CatalogEntries) UpdateService(ctx context.Context, serviceID string, updateService components.UpdateService, opts ...operations.Option) (*components.ServiceEntity, error)

UpdateService - Update a service Update a services attributes, you may also add or remove functionalities from the service as well. Note: You may not remove or add individual label key/value pairs. You must include the entire object to override label values.

func (*CatalogEntries) UpdateServiceDependency 

func (s *CatalogEntries) UpdateServiceDependency(ctx context.Context, serviceDependencyID string, updateServiceDependency components.UpdateServiceDependency, opts ...operations.Option) (*components.ServiceDependencyEntity, error)

UpdateServiceDependency - Update a service dependency Update the notes of the service dependency

type Changes 

type Changes struct {
	// contains filtered or unexported fields
}

Changes - Operations related to Changes

func (*Changes) CreateChange 

func (s *Changes) CreateChange(ctx context.Context, request components.CreateChange, opts ...operations.Option) (*components.ChangeEntity, error)

CreateChange - Create a new change entry Create a new change entry

func (*Changes) CreateChangeEvent 

func (s *Changes) CreateChangeEvent(ctx context.Context, request components.CreateChangeEvent, opts ...operations.Option) (*components.ChangeEventEntity, error)

CreateChangeEvent - Create a change event Create a change event

func (*Changes) CreateChangeIdentity 

func (s *Changes) CreateChangeIdentity(ctx context.Context, changeID string, createChangeIdentity components.CreateChangeIdentity, opts ...operations.Option) (*components.ChangeIdentityEntity, error)

CreateChangeIdentity - Create an identity for a change entry Create an identity for the change entry

func (*Changes) DeleteChange 

func (s *Changes) DeleteChange(ctx context.Context, changeID string, opts ...operations.Option) error

DeleteChange - Archive a change entry Archive a change entry

func (*Changes) DeleteChangeEvent 

func (s *Changes) DeleteChangeEvent(ctx context.Context, changeEventID string, opts ...operations.Option) error

DeleteChangeEvent - Delete a change event Delete a change event

func (*Changes) DeleteChangeIdentity 

func (s *Changes) DeleteChangeIdentity(ctx context.Context, identityID string, changeID string, opts ...operations.Option) error

DeleteChangeIdentity - Delete an identity from a change entry Delete an identity from the change entry

func (*Changes) GetChangeEvent 

func (s *Changes) GetChangeEvent(ctx context.Context, changeEventID string, opts ...operations.Option) (*components.ChangeEventEntity, error)

GetChangeEvent - Get a change event Retrieve a change event

func (*Changes) ListChangeEvents 

func (s *Changes) ListChangeEvents(ctx context.Context, request operations.ListChangeEventsRequest, opts ...operations.Option) (*components.ChangeEventSlimEntityPaginated, error)

ListChangeEvents - List change events List change events for the organization. Note: Not all information is included on a change event like attachments and related changes. You must fetch a change event separately to retrieve all of the information about it

func (*Changes) ListChangeIdentities 

func (s *Changes) ListChangeIdentities(ctx context.Context, changeID string, page *int, perPage *int, opts ...operations.Option) (*components.ChangeIdentityEntityPaginated, error)

ListChangeIdentities - List identities for a change entry Retrieve all identities for the change entry

func (*Changes) ListChangeTypes 

func (s *Changes) ListChangeTypes(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.ChangeTypeEntityPaginated, error)

ListChangeTypes - List change types List change types for the organization

func (*Changes) ListChanges 

func (s *Changes) ListChanges(ctx context.Context, page *int, perPage *int, query *string, opts ...operations.Option) error

ListChanges - List changes List changes for the organization

func (*Changes) UpdateChange 

func (s *Changes) UpdateChange(ctx context.Context, changeID string, updateChange components.UpdateChange, opts ...operations.Option) (*components.ChangeEntity, error)

UpdateChange - Update a change entry Update a change entry

func (*Changes) UpdateChangeEvent 

func (s *Changes) UpdateChangeEvent(ctx context.Context, changeEventID string, updateChangeEvent components.UpdateChangeEvent, opts ...operations.Option) (*components.ChangeEventEntity, error)

UpdateChangeEvent - Update a change event Update a change event

func (*Changes) UpdateChangeIdentity 

func (s *Changes) UpdateChangeIdentity(ctx context.Context, identityID string, changeID string, updateChangeIdentity components.UpdateChangeIdentity, opts ...operations.Option) (*components.ChangeIdentityEntity, error)

UpdateChangeIdentity - Update an identity for a change entry Update an identity for the change entry

type Communication 

type Communication struct {
	// contains filtered or unexported fields
}

Communication - Operations related to Communication

func (*Communication) CreateStatusUpdateTemplate 

func (s *Communication) CreateStatusUpdateTemplate(ctx context.Context, request components.CreateStatusUpdateTemplate, opts ...operations.Option) (*components.StatusUpdateTemplateEntity, error)

CreateStatusUpdateTemplate - Create a status update template Create a status update template for your organization

func (*Communication) DeleteStatusUpdateTemplate 

func (s *Communication) DeleteStatusUpdateTemplate(ctx context.Context, statusUpdateTemplateID string, opts ...operations.Option) error

DeleteStatusUpdateTemplate - Delete a status update template Delete a single status update template

func (*Communication) GetStatusUpdateTemplate 

func (s *Communication) GetStatusUpdateTemplate(ctx context.Context, statusUpdateTemplateID string, opts ...operations.Option) (*components.StatusUpdateTemplateEntity, error)

GetStatusUpdateTemplate - Get a status update template Get a single status update template by ID

func (*Communication) ListStatusUpdateTemplates 

func (s *Communication) ListStatusUpdateTemplates(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.StatusUpdateTemplateEntity, error)

ListStatusUpdateTemplates - List status update templates List all status update templates for your organization

func (*Communication) UpdateStatusUpdateTemplate 

func (s *Communication) UpdateStatusUpdateTemplate(ctx context.Context, statusUpdateTemplateID string, updateStatusUpdateTemplate components.UpdateStatusUpdateTemplate, opts ...operations.Option) (*components.StatusUpdateTemplateEntity, error)

UpdateStatusUpdateTemplate - Update a status update template Update a single status update template

type Conversations 

type Conversations struct {
	// contains filtered or unexported fields
}

Conversations - Operations related to Conversations

func (*Conversations) CreateComment 

func (s *Conversations) CreateComment(ctx context.Context, conversationID string, createComment components.CreateComment, opts ...operations.Option) error

CreateComment - Create a conversation comment Creates a comment for a project

func (*Conversations) CreateCommentReaction 

func (s *Conversations) CreateCommentReaction(ctx context.Context, conversationID string, commentID string, createCommentReaction components.CreateCommentReaction, opts ...operations.Option) error

CreateCommentReaction - Create a reaction for a conversation comment Create a reaction on a comment

func (*Conversations) DeleteComment 

func (s *Conversations) DeleteComment(ctx context.Context, commentID string, conversationID string, opts ...operations.Option) error

DeleteComment - Archive a conversation comment Archive a comment

func (*Conversations) DeleteCommentReaction 

func (s *Conversations) DeleteCommentReaction(ctx context.Context, reactionID string, conversationID string, commentID string, opts ...operations.Option) error

DeleteCommentReaction - Delete a reaction from a conversation comment Archive a reaction

func (*Conversations) GetComment 

func (s *Conversations) GetComment(ctx context.Context, commentID string, conversationID string, opts ...operations.Option) error

GetComment - Get a conversation comment Retrieves a single comment by ID

func (*Conversations) GetVoteStatus 

func (s *Conversations) GetVoteStatus(ctx context.Context, incidentID string, eventID string, opts ...operations.Option) (*components.VotesEntity, error)

GetVoteStatus - Get votes Get an object's current vote counts

func (*Conversations) ListCommentReactions 

func (s *Conversations) ListCommentReactions(ctx context.Context, conversationID string, commentID string, opts ...operations.Option) error

ListCommentReactions - List reactions for a conversation comment List all of the reactions that have been added to a comment

func (*Conversations) ListComments 

func (s *Conversations) ListComments(ctx context.Context, conversationID string, before *time.Time, after *time.Time, sort *operations.ListCommentsSort, opts ...operations.Option) error

ListComments - List comments for a conversation List all of the comments that have been added to the organization

func (*Conversations) UpdateComment 

func (s *Conversations) UpdateComment(ctx context.Context, commentID string, conversationID string, updateComment components.UpdateComment, opts ...operations.Option) error

UpdateComment - Update a conversation comment Update a comment's attributes

func (*Conversations) UpdateVote 

func (s *Conversations) UpdateVote(ctx context.Context, incidentID string, eventID string, updateVote components.UpdateVote, opts ...operations.Option) (*components.VotesEntity, error)

UpdateVote - Update votes Upvote or downvote an object

type FireHydrant 

type FireHydrant struct {
	SDKVersion string
	// Operations related to Account Settings
	AccountSettings *AccountSettings
	// Operations related to Catalog Entries
	CatalogEntries *CatalogEntries
	// Operations related to Teams
	Teams *Teams
	// Operations about Call Routes
	CallRoutes *CallRoutes
	// Operations related to Signals
	Signals *Signals
	// Operations related to Changes
	Changes *Changes
	// Operations related to Incidents
	Incidents *Incidents
	// Operations related to Alerts
	Alerts *Alerts
	// Operations related to Status Pages
	StatusPages *StatusPages
	// Operations related to Tasks
	Tasks *Tasks
	// Operations related to Conversations
	Conversations *Conversations
	// Operations related to Retrospectives
	Retrospectives *Retrospectives
	// Operations related to Incident Settings
	IncidentSettings *IncidentSettings
	// Operations related to Integrations
	Integrations *Integrations
	// Operations related to Users
	Users *Users
	// Operations about Permissions
	Permissions *Permissions
	// Operations related to Metrics & Reporting
	MetricsReporting *MetricsReporting
	// Operations about Roles
	Roles *Roles
	// Operations related to Runbooks
	Runbooks *Runbooks
	// Operations about Audit Events
	AuditEvents *AuditEvents
	// Operations related to Communication
	Communication *Communication
	// Operations about Pages
	Pages *Pages
	// Operations related to Ticketing
	Ticketing *Ticketing
	// Operations related to SCIM
	Scim *Scim
	// Operations related to Webhooks
	Webhooks *Webhooks
	// Operations related to Audiences
	Audiences *Audiences
	// contains filtered or unexported fields
}

FireHydrant API: The FireHydrant API is based around REST. It uses Bearer token authentication and returns JSON responses. You can use the FireHydrant API to configure integrations, define incidents, and set up webhooks--anything you can do on the FireHydrant UI.

* [Dig into our API endpoints](https://developers.firehydrant.io/docs/api) * [View your bot users](https://app.firehydrant.io/organizations/bots)

## Base API endpoint

[https://api.firehydrant.io/v1](https://api.firehydrant.io/v1)

## Current version

v1

## Authentication

All requests to the FireHydrant API require an `Authorization` header with the value set to `Bearer {token}`. FireHydrant supports bot tokens to act on behalf of a computer instead of a user's account. This prevents integrations from breaking when people leave your organization or their token is revoked. See the Bot tokens section (below) for more information on this.

An example of a header to authenticate against FireHydrant would look like:

``` Authorization: Bearer fhb-thisismytoken ```

## Bot tokens

To access the FireHydrant API, you must authenticate with a bot token. (You must have owner permissions on your organization to see bot tokens.) Bot users allow you to interact with the FireHydrant API by using token-based authentication. To create bot tokens, log in to your organization and refer to the **Bot users** [page](https://app.firehydrant.io/organizations/bots).

Bot tokens enable you to create a bot that has no ties to any user. Normally, all actions associated with an API token are associated with the user who created it. Bot tokens attribute all actions to the bot user itself. This way, all data associated with the token actions can be performed against the FireHydrant API without a user.

Every request to the API is authenticated unless specified otherwise.

### Rate Limiting

Currently, requests made with bot tokens are rate limited on a per-account level. If your account has multiple bot token then the rate limit is shared across all of them. As of February 7th, 2023, the rate limit is at least 50 requests per account every 10 seconds, or 300 requests per minute.

Rate limited responses will be served with a `429` status code and a JSON body of:

```json {"error": "rate limit exceeded"} ``` and headers of: ``` "RateLimit-Limit" -> the maximum number of requests in the rate limit pool "Retry-After" -> the number of seconds to wait before trying again ```

## How lists are returned

API lists are returned as arrays. A paginated entity in FireHydrant will return two top-level keys in the response object: a data key and a pagination key.

### Paginated requests

The `data` key is returned as an array. Each item in the array includes all of the entity data specified in the API endpoint. (The per-page default for the array is 20 items.)

Pagination is the second key (`pagination`) returned in the overall response body. It includes medtadata around the current page, total count of items, and options to go to the next and previous page. All of the specifications returned in the pagination object are available as URL parameters. So if you want to specify, for example, going to the second page of a response, you can send a request to the same endpoint but pass the URL parameter **page=2**.

For example, you might request **https://api.firehydrant.io/v1/environments/** to retrieve environments data. The JSON returned contains the above-mentioned data section and pagination section. The data section includes various details about an incident, such as the environment name, description, and when it was created.

``` 

{
  "data": [
    {
      "id": "f8125cf4-b3a7-4f88-b5ab-57a60b9ed89b",
      "name": "Production - GCP",
      "description": "",
      "created_at": "2021-02-17T20:02:10.679Z"
    },
    {
      "id": "a69f1f58-af77-4708-802d-7e73c0bf261c",
      "name": "Staging",
      "description": "",
      "created_at": "2021-04-16T13:41:59.418Z"
    }
  ],
  "pagination": {
    "count": 2,
    "page": 1,
    "items": 2,
    "pages": 1,
    "last": 1,
    "prev": null,
    "next": null
  }
}

```

To request the second page, you'd request the same endpoint with the additional query parameter of `page` in the URL:

``` GET https://api.firehydrant.io/v1/environments?page=2 ```

If you need to modify the number of records coming back from FireHydrant, you can use the `per_page` parameter (max is 200):

``` GET https://api.firehydrant.io/v1/environments?per_page=50 ```

func New 

func New(opts ...SDKOption) *FireHydrant

New creates a new instance of the SDK with the provided options

type HTTPClient 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient provides an interface for supplying the SDK with a custom HTTP client

type IncidentSettings 

type IncidentSettings struct {
	// contains filtered or unexported fields
}

IncidentSettings - Operations related to Incident Settings

func (*IncidentSettings) AppendFormDataOnSelectedValueGet 

func (s *IncidentSettings) AppendFormDataOnSelectedValueGet(ctx context.Context, slug string, fieldID string, selectedValue string, opts ...operations.Option) (*components.PublicAPIV1FormConfigurationsSelectedValueEntity, error)

AppendFormDataOnSelectedValueGet - Get data for a form field on select Get data for a form field on select that should be appended to a form by using a template

func (*IncidentSettings) CreateCustomFieldDefinition 

func (s *IncidentSettings) CreateCustomFieldDefinition(ctx context.Context, request components.CreateCustomFieldDefinition, opts ...operations.Option) (*components.OrganizationsCustomFieldDefinitionEntity, error)

CreateCustomFieldDefinition - Create a custom field definition Create a new custom field definition

func (*IncidentSettings) CreateIncidentRole 

func (s *IncidentSettings) CreateIncidentRole(ctx context.Context, request components.CreateIncidentRole, opts ...operations.Option) (*components.IncidentRoleEntity, error)

CreateIncidentRole - Create an incident role Create a new incident role

func (*IncidentSettings) CreateIncidentType 

func (s *IncidentSettings) CreateIncidentType(ctx context.Context, request components.CreateIncidentType, opts ...operations.Option) (*components.IncidentTypeEntity, error)

CreateIncidentType - Create an incident type Create a new incident type

func (*IncidentSettings) CreateLifecycleMeasurementDefinition 

func (s *IncidentSettings) CreateLifecycleMeasurementDefinition(ctx context.Context, request operations.CreateLifecycleMeasurementDefinitionRequest, opts ...operations.Option) error

CreateLifecycleMeasurementDefinition - Create a measurement definition Create a new measurement definition

func (*IncidentSettings) CreateLifecycleMilestone 

func (s *IncidentSettings) CreateLifecycleMilestone(ctx context.Context, request operations.CreateLifecycleMilestoneRequest, opts ...operations.Option) (*components.LifecyclesMilestoneEntity, error)

CreateLifecycleMilestone - Create a milestone Create a new milestone

func (*IncidentSettings) CreatePriority 

func (s *IncidentSettings) CreatePriority(ctx context.Context, request components.CreatePriority, opts ...operations.Option) (*components.PriorityEntity, error)

CreatePriority - Create a priority Create a new priority

func (*IncidentSettings) CreateSeverity 

func (s *IncidentSettings) CreateSeverity(ctx context.Context, request components.CreateSeverity, opts ...operations.Option) (*components.SeverityEntity, error)

CreateSeverity - Create a severity Create a new severity

func (*IncidentSettings) CreateSeverityMatrixCondition 

func (s *IncidentSettings) CreateSeverityMatrixCondition(ctx context.Context, request components.CreateSeverityMatrixCondition, opts ...operations.Option) (*components.SeverityMatrixConditionEntity, error)

CreateSeverityMatrixCondition - Create a severity matrix condition Create a new condition

func (*IncidentSettings) CreateSeverityMatrixImpact 

func (s *IncidentSettings) CreateSeverityMatrixImpact(ctx context.Context, request components.CreateSeverityMatrixImpact, opts ...operations.Option) (*components.SeverityMatrixImpactEntity, error)

CreateSeverityMatrixImpact - Create a severity matrix impact Create a new impact

func (*IncidentSettings) DeleteCustomFieldDefinition 

func (s *IncidentSettings) DeleteCustomFieldDefinition(ctx context.Context, fieldID string, opts ...operations.Option) error

DeleteCustomFieldDefinition - Delete a custom field definition Delete a custom field definition

func (*IncidentSettings) DeleteIncidentRole 

func (s *IncidentSettings) DeleteIncidentRole(ctx context.Context, incidentRoleID string, opts ...operations.Option) error

DeleteIncidentRole - Archive an incident role Archives an incident role which will hide it from lists and metrics

func (*IncidentSettings) DeleteIncidentType 

func (s *IncidentSettings) DeleteIncidentType(ctx context.Context, id string, opts ...operations.Option) error

DeleteIncidentType - Archive an incident type Archives an incident type which will hide it from lists and metrics

func (*IncidentSettings) DeleteLifecycleMeasurementDefinition 

func (s *IncidentSettings) DeleteLifecycleMeasurementDefinition(ctx context.Context, measurementDefinitionID string, opts ...operations.Option) error

DeleteLifecycleMeasurementDefinition - Archive a measurement definition Archives a measurement definition which will hide it from lists and metrics

func (*IncidentSettings) DeleteLifecycleMilestone 

func (s *IncidentSettings) DeleteLifecycleMilestone(ctx context.Context, milestoneID string, opts ...operations.Option) error

DeleteLifecycleMilestone - Delete a milestone Delete a milestone

func (*IncidentSettings) DeletePriority 

func (s *IncidentSettings) DeletePriority(ctx context.Context, prioritySlug string, opts ...operations.Option) error

DeletePriority - Delete a priority Delete a specific priority

func (*IncidentSettings) DeleteSeverity 

func (s *IncidentSettings) DeleteSeverity(ctx context.Context, severitySlug string, opts ...operations.Option) error

DeleteSeverity - Delete a severity Delete a specific severity

func (*IncidentSettings) DeleteSeverityMatrixCondition 

func (s *IncidentSettings) DeleteSeverityMatrixCondition(ctx context.Context, conditionID string, opts ...operations.Option) error

DeleteSeverityMatrixCondition - Delete a severity matrix condition Delete a specific condition

func (*IncidentSettings) DeleteSeverityMatrixImpact 

func (s *IncidentSettings) DeleteSeverityMatrixImpact(ctx context.Context, impactID string, opts ...operations.Option) error

DeleteSeverityMatrixImpact - Delete a severity matrix impact Delete a specific impact

func (*IncidentSettings) GetFormConfiguration 

func (s *IncidentSettings) GetFormConfiguration(ctx context.Context, slug string, opts ...operations.Option) (*components.FormConfigurationEntity, error)

GetFormConfiguration - Get a form configuration Get a form configuration

func (*IncidentSettings) GetIncidentRole 

func (s *IncidentSettings) GetIncidentRole(ctx context.Context, incidentRoleID string, opts ...operations.Option) (*components.IncidentRoleEntity, error)

GetIncidentRole - Get an incident role Retrieve a single incident role from its ID

func (*IncidentSettings) GetIncidentType 

func (s *IncidentSettings) GetIncidentType(ctx context.Context, id string, opts ...operations.Option) (*components.IncidentTypeEntity, error)

GetIncidentType - Get an incident type Retrieve a single incident type from its ID

func (*IncidentSettings) GetLifecycleMeasurementDefinition 

func (s *IncidentSettings) GetLifecycleMeasurementDefinition(ctx context.Context, measurementDefinitionID string, opts ...operations.Option) error

GetLifecycleMeasurementDefinition - Get a measurement definition Retrieve a single measurement definition from its ID

func (*IncidentSettings) GetPriority 

func (s *IncidentSettings) GetPriority(ctx context.Context, prioritySlug string, opts ...operations.Option) (*components.PriorityEntity, error)

GetPriority - Get a priority Retrieve a specific priority

func (*IncidentSettings) GetSeverity 

func (s *IncidentSettings) GetSeverity(ctx context.Context, severitySlug string, opts ...operations.Option) (*components.SeverityEntity, error)

GetSeverity - Get a severity Retrieve a specific severity

func (*IncidentSettings) GetSeverityMatrix 

func (s *IncidentSettings) GetSeverityMatrix(ctx context.Context, opts ...operations.Option) (*components.SeverityMatrixSeverityMatrixEntity, error)

GetSeverityMatrix - Get severity matrix Retrieve the Severity matrix for your organization and its components and configured severities.

func (*IncidentSettings) GetSeverityMatrixCondition 

func (s *IncidentSettings) GetSeverityMatrixCondition(ctx context.Context, conditionID string, opts ...operations.Option) (*components.SeverityMatrixConditionEntity, error)

GetSeverityMatrixCondition - Get a severity matrix condition Retrieve a specific condition

func (*IncidentSettings) ListCustomFieldDefinitions 

func (s *IncidentSettings) ListCustomFieldDefinitions(ctx context.Context, opts ...operations.Option) (*components.OrganizationsCustomFieldDefinitionEntity, error)

ListCustomFieldDefinitions - List custom field definitions List all custom field definitions

func (*IncidentSettings) ListCustomFieldSelectOptions 

func (s *IncidentSettings) ListCustomFieldSelectOptions(ctx context.Context, fieldID string, query *string, allVersions *bool, opts ...operations.Option) (*components.OrganizationsCustomFieldDefinitionEntity, error)

ListCustomFieldSelectOptions - Get available values for a custom field Get the permissible values for the a currently active custom select or multi-select field.

func (*IncidentSettings) ListIncidentRoles 

func (s *IncidentSettings) ListIncidentRoles(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.IncidentRoleEntityPaginated, error)

ListIncidentRoles - List incident roles List all of the incident roles in the organization

func (*IncidentSettings) ListIncidentTags 

func (s *IncidentSettings) ListIncidentTags(ctx context.Context, prefix *string, opts ...operations.Option) (*components.TagEntityPaginated, error)

ListIncidentTags - List incident tags List all of the incident tags in the organization

func (*IncidentSettings) ListIncidentTypes 

func (s *IncidentSettings) ListIncidentTypes(ctx context.Context, query *string, page *int, perPage *int, opts ...operations.Option) (*components.IncidentTypeEntityPaginated, error)

ListIncidentTypes - List incident types List all of the incident types in the organization

func (*IncidentSettings) ListLifecycleMeasurementDefinitions 

func (s *IncidentSettings) ListLifecycleMeasurementDefinitions(ctx context.Context, page *int, perPage *int, opts ...operations.Option) error

ListLifecycleMeasurementDefinitions - List measurement definitions List all of the measurement definitions in the organization

func (*IncidentSettings) ListLifecyclePhases 

func (s *IncidentSettings) ListLifecyclePhases(ctx context.Context, opts ...operations.Option) (*components.LifecyclesPhaseEntityList, error)

ListLifecyclePhases - List phases and milestones List all of the lifecycle phases and milestones in the organization

func (*IncidentSettings) ListPriorities 

func (s *IncidentSettings) ListPriorities(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.PriorityEntity, error)

ListPriorities - List priorities Lists priorities

func (*IncidentSettings) ListSeverities 

func (s *IncidentSettings) ListSeverities(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.SeverityEntityPaginated, error)

ListSeverities - List severities Lists severities

func (*IncidentSettings) ListSeverityMatrixConditions 

func (s *IncidentSettings) ListSeverityMatrixConditions(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.SeverityMatrixConditionEntity, error)

ListSeverityMatrixConditions - List severity matrix conditions Lists conditions

func (*IncidentSettings) ListSeverityMatrixImpacts 

func (s *IncidentSettings) ListSeverityMatrixImpacts(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.SeverityMatrixImpactEntity, error)

ListSeverityMatrixImpacts - List severity matrix impacts Lists impacts

func (*IncidentSettings) UpdateCustomFieldDefinition 

func (s *IncidentSettings) UpdateCustomFieldDefinition(ctx context.Context, fieldID string, updateCustomFieldDefinition components.UpdateCustomFieldDefinition, opts ...operations.Option) (*components.OrganizationsCustomFieldDefinitionEntity, error)

UpdateCustomFieldDefinition - Update a custom field definition Update a single custom field definition

func (*IncidentSettings) UpdateIncidentRole 

func (s *IncidentSettings) UpdateIncidentRole(ctx context.Context, incidentRoleID string, updateIncidentRole components.UpdateIncidentRole, opts ...operations.Option) (*components.IncidentRoleEntity, error)

UpdateIncidentRole - Update an incident role Update a single incident role from its ID

func (*IncidentSettings) UpdateIncidentType 

func (s *IncidentSettings) UpdateIncidentType(ctx context.Context, id string, updateIncidentType components.UpdateIncidentType, opts ...operations.Option) (*components.IncidentTypeEntity, error)

UpdateIncidentType - Update an incident type Update a single incident type from its ID

func (*IncidentSettings) UpdateLifecycleMeasurementDefinition 

func (s *IncidentSettings) UpdateLifecycleMeasurementDefinition(ctx context.Context, measurementDefinitionID string, requestBody *operations.UpdateLifecycleMeasurementDefinitionRequestBody, opts ...operations.Option) error

UpdateLifecycleMeasurementDefinition - Update a measurement definition Update a single measurement definition from its ID

func (*IncidentSettings) UpdateLifecycleMilestone 

func (s *IncidentSettings) UpdateLifecycleMilestone(ctx context.Context, milestoneID string, requestBody *operations.UpdateLifecycleMilestoneRequestBody, opts ...operations.Option) (*components.LifecyclesMilestoneEntity, error)

UpdateLifecycleMilestone - Update a milestone Update a milestone

func (*IncidentSettings) UpdatePriority 

func (s *IncidentSettings) UpdatePriority(ctx context.Context, prioritySlug string, updatePriority components.UpdatePriority, opts ...operations.Option) (*components.PriorityEntity, error)

UpdatePriority - Update a priority Update a specific priority

func (*IncidentSettings) UpdateSeverity 

func (s *IncidentSettings) UpdateSeverity(ctx context.Context, severitySlug string, updateSeverity components.UpdateSeverity, opts ...operations.Option) (*components.SeverityEntity, error)

UpdateSeverity - Update a severity Update a specific severity

func (*IncidentSettings) UpdateSeverityMatrix 

func (s *IncidentSettings) UpdateSeverityMatrix(ctx context.Context, request components.UpdateSeverityMatrix, opts ...operations.Option) (*components.SeverityMatrixSeverityMatrixEntity, error)

UpdateSeverityMatrix - Update severity matrix Update available severities and impacts in your organization's severity matrix.

func (*IncidentSettings) UpdateSeverityMatrixCondition 

func (s *IncidentSettings) UpdateSeverityMatrixCondition(ctx context.Context, conditionID string, updateSeverityMatrixCondition components.UpdateSeverityMatrixCondition, opts ...operations.Option) (*components.SeverityMatrixConditionEntity, error)

UpdateSeverityMatrixCondition - Update a severity matrix condition Update a severity matrix condition

func (*IncidentSettings) UpdateSeverityMatrixImpact 

func (s *IncidentSettings) UpdateSeverityMatrixImpact(ctx context.Context, impactID string, updateSeverityMatrixImpact components.UpdateSeverityMatrixImpact, opts ...operations.Option) (*components.SeverityMatrixImpactEntity, error)

UpdateSeverityMatrixImpact - Update a severity matrix impact Update a severity matrix impact

func (*IncidentSettings) ValidateIncidentTags 

func (s *IncidentSettings) ValidateIncidentTags(ctx context.Context, request []string, opts ...operations.Option) (*components.TagEntity, error)

ValidateIncidentTags - Validate incident tags Validate the format of a list of tags

type Incidents 

type Incidents struct {
	// contains filtered or unexported fields
}

Incidents - Operations related to Incidents

func (*Incidents) BulkUpdateIncidentMilestones 

func (s *Incidents) BulkUpdateIncidentMilestones(ctx context.Context, incidentID string, bulkUpdateIncidentMilestones components.BulkUpdateIncidentMilestones, opts ...operations.Option) (*components.IncidentsMilestoneEntityPaginated, error)

BulkUpdateIncidentMilestones - Update milestone times Update milestone times in bulk for a given incident. All milestone times for an incident must occur in chronological order corresponding to the configured order of milestones. If the result of this request would cause any milestone(s) to appear out of place, a 422 response will instead be returned. This includes milestones not explicitly submitted or updated in this request.

func (*Incidents) CloseIncident 

func (s *Incidents) CloseIncident(ctx context.Context, incidentID string, opts ...operations.Option) (*components.IncidentEntity, error)

CloseIncident - Close an incident Closes an incident and optionally close all children

func (*Incidents) CreateIncident 

func (s *Incidents) CreateIncident(ctx context.Context, request components.CreateIncident, opts ...operations.Option) (*components.IncidentEntity, error)

CreateIncident - Create an incident Create a new incident

func (*Incidents) CreateIncidentAttachment 

func (s *Incidents) CreateIncidentAttachment(ctx context.Context, incidentID string, requestBody operations.CreateIncidentAttachmentRequestBody, opts ...operations.Option) (*components.IncidentAttachmentEntity, error)

CreateIncidentAttachment - Add an attachment to the incident timeline Allows adding image attachments to an incident

func (*Incidents) CreateIncidentChangeEvent 

func (s *Incidents) CreateIncidentChangeEvent(ctx context.Context, incidentID string, createIncidentChangeEvent components.CreateIncidentChangeEvent, opts ...operations.Option) (*components.IncidentsRelatedChangeEventEntity, error)

CreateIncidentChangeEvent - Add a related change to an incident Add a related change to an incident. Changes added to an incident can be causes, fixes, or suspects. To remove a change from an incident, the type field should be set to dismissed.

func (*Incidents) CreateIncidentChatMessage 

func (s *Incidents) CreateIncidentChatMessage(ctx context.Context, incidentID string, createIncidentChatMessage components.CreateIncidentChatMessage, opts ...operations.Option) (*components.EventGenericChatMessageEntity, error)

CreateIncidentChatMessage - Add a chat message to an incident Create a new generic chat message on an incident timeline. These are independent of any specific chat provider.

func (*Incidents) CreateIncidentImpact 

func (s *Incidents) CreateIncidentImpact(ctx context.Context, incidentID string, type_ operations.CreateIncidentImpactType, createIncidentImpact components.CreateIncidentImpact, opts ...operations.Option) (*components.IncidentImpactEntity, error)

CreateIncidentImpact - Add impacted infrastructure to an incident Add impacted infrastructure to an incident 

func (s *Incidents) CreateIncidentLink(ctx context.Context, incidentID string, createIncidentLink components.CreateIncidentLink, opts ...operations.Option) (*components.AttachmentsLinkEntity, error)

CreateIncidentLink - Add a link to an incident Allows adding adhoc links to an incident as an attachment

func (*Incidents) CreateIncidentNote 

func (s *Incidents) CreateIncidentNote(ctx context.Context, incidentID string, createIncidentNote components.CreateIncidentNote, opts ...operations.Option) (*components.EventNoteEntity, error)

CreateIncidentNote - Add a note to an incident Create a new note on for an incident. The visibility field on a note determines where it gets posted.

func (*Incidents) CreateIncidentRoleAssignment 

func (s *Incidents) CreateIncidentRoleAssignment(ctx context.Context, incidentID string, createIncidentRoleAssignment components.CreateIncidentRoleAssignment, opts ...operations.Option) (*components.IncidentsRoleAssignmentEntity, error)

CreateIncidentRoleAssignment - Assign a user to an incident Assign a role to a user for this incident

func (*Incidents) CreateIncidentStatusPage 

func (s *Incidents) CreateIncidentStatusPage(ctx context.Context, incidentID string, createIncidentStatusPage components.CreateIncidentStatusPage, opts ...operations.Option) (*components.IncidentsStatusPageEntity, error)

CreateIncidentStatusPage - Add a status page to an incident Add a status page to an incident.

func (*Incidents) CreateIncidentTeamAssignment 

func (s *Incidents) CreateIncidentTeamAssignment(ctx context.Context, incidentID string, createIncidentTeamAssignment components.CreateIncidentTeamAssignment, opts ...operations.Option) error

CreateIncidentTeamAssignment - Assign a team to an incident Assign a team for this incident

func (*Incidents) CreateScheduledMaintenance 

func (s *Incidents) CreateScheduledMaintenance(ctx context.Context, request components.CreateScheduledMaintenance, opts ...operations.Option) (*components.ScheduledMaintenanceEntity, error)

CreateScheduledMaintenance - Create a scheduled maintenance event Create a new scheduled maintenance event

func (*Incidents) DeleteIncident 

func (s *Incidents) DeleteIncident(ctx context.Context, incidentID string, opts ...operations.Option) error

DeleteIncident - Archive an incident Archives an incident which will hide it from lists and metrics

func (*Incidents) DeleteIncidentChatMessage 

func (s *Incidents) DeleteIncidentChatMessage(ctx context.Context, messageID string, incidentID string, opts ...operations.Option) error

DeleteIncidentChatMessage - Delete a chat message from an incident Delete an existing generic chat message on an incident.

func (*Incidents) DeleteIncidentEvent 

func (s *Incidents) DeleteIncidentEvent(ctx context.Context, incidentID string, eventID string, opts ...operations.Option) error

DeleteIncidentEvent - Delete an incident event Delete an event for an incident

func (*Incidents) DeleteIncidentImpact 

func (s *Incidents) DeleteIncidentImpact(ctx context.Context, incidentID string, type_ operations.DeleteIncidentImpactType, id string, opts ...operations.Option) error

DeleteIncidentImpact - Remove impacted infrastructure from an incident Remove impacted infrastructure from an incident 

func (s *Incidents) DeleteIncidentLink(ctx context.Context, linkID string, incidentID string, opts ...operations.Option) error

DeleteIncidentLink - Remove a link from an incident Remove a link from an incident

func (*Incidents) DeleteIncidentRoleAssignment 

func (s *Incidents) DeleteIncidentRoleAssignment(ctx context.Context, incidentID string, roleAssignmentID string, opts ...operations.Option) error

DeleteIncidentRoleAssignment - Unassign a user from an incident Unassign a role from a user

func (*Incidents) DeleteIncidentTeamAssignment 

func (s *Incidents) DeleteIncidentTeamAssignment(ctx context.Context, incidentID string, teamAssignmentID string, requestBody *operations.DeleteIncidentTeamAssignmentRequestBody, opts ...operations.Option) error

DeleteIncidentTeamAssignment - Unassign a team from an incident Unassign a team from an incident

func (*Incidents) DeleteScheduledMaintenance 

func (s *Incidents) DeleteScheduledMaintenance(ctx context.Context, scheduledMaintenanceID string, opts ...operations.Option) error

DeleteScheduledMaintenance - Delete a scheduled maintenance event Delete a scheduled maintenance event, preventing it from taking place.

func (*Incidents) DeleteTranscriptEntry 

func (s *Incidents) DeleteTranscriptEntry(ctx context.Context, transcriptID string, incidentID string, opts ...operations.Option) error

DeleteTranscriptEntry - Delete a transcript from an incident Delete a transcript from an incident

func (*Incidents) GetAiIncidentSummaryVoteStatus 

func (s *Incidents) GetAiIncidentSummaryVoteStatus(ctx context.Context, incidentID string, generatedSummaryID string, opts ...operations.Option) error

GetAiIncidentSummaryVoteStatus - Get the current user's vote status for an AI-generated incident summary Get the current user's vote status for an AI-generated incident summary

func (*Incidents) GetConferenceBridgeTranslation 

func (s *Incidents) GetConferenceBridgeTranslation(ctx context.Context, id string, languageCode string, incidentID string, opts ...operations.Option) (*components.IncidentsConferenceBridgeEntity, error)

GetConferenceBridgeTranslation - Retrieve the translations for a specific conference bridge Retrieve the translations for a specific conference bridge

func (*Incidents) GetIncident 

func (s *Incidents) GetIncident(ctx context.Context, incidentID string, opts ...operations.Option) (*components.IncidentEntity, error)

GetIncident - Get an incident Retrieve a single incident from its ID

func (*Incidents) GetIncidentChannel 

func (s *Incidents) GetIncidentChannel(ctx context.Context, incidentID string, opts ...operations.Option) (*components.IncidentsChannelEntity, error)

GetIncidentChannel - Get chat channel information for an incident Gives chat channel information for the specified incident

func (*Incidents) GetIncidentEvent 

func (s *Incidents) GetIncidentEvent(ctx context.Context, incidentID string, eventID string, opts ...operations.Option) (*components.IncidentEventEntity, error)

GetIncidentEvent - Get an incident event Retrieve a single event for an incident

func (*Incidents) GetIncidentRelationships 

func (s *Incidents) GetIncidentRelationships(ctx context.Context, incidentID string, opts ...operations.Option) (*components.IncidentsRelationshipsEntity, error)

GetIncidentRelationships - List incident relationships List any parent/child relationships for an incident

func (*Incidents) GetIncidentUser 

func (s *Incidents) GetIncidentUser(ctx context.Context, incidentID string, userID string, opts ...operations.Option) (*components.IncidentsRoleAssignmentEntity, error)

GetIncidentUser - Get the current user's incident role Retrieve a user with current roles for an incident

func (*Incidents) GetScheduledMaintenance 

func (s *Incidents) GetScheduledMaintenance(ctx context.Context, scheduledMaintenanceID string, opts ...operations.Option) (*components.ScheduledMaintenanceEntity, error)

GetScheduledMaintenance - Get a scheduled maintenance event Fetch the details of a scheduled maintenance event.

func (*Incidents) ListIncidentAttachments 

func (s *Incidents) ListIncidentAttachments(ctx context.Context, incidentID string, attachableType *string, page *int, perPage *int, opts ...operations.Option) (*components.AttachmentsTypedAttachmentEntityPaginated, error)

ListIncidentAttachments - List attachments for an incident List attachments for an incident

func (*Incidents) ListIncidentChangeEvents 

func (s *Incidents) ListIncidentChangeEvents(ctx context.Context, incidentID string, page *int, perPage *int, type_ *operations.ListIncidentChangeEventsType, opts ...operations.Option) (*components.IncidentsRelatedChangeEventEntityPaginated, error)

ListIncidentChangeEvents - List related changes on an incident List related changes that have been attached to an incident

func (*Incidents) ListIncidentConferenceBridges 

func (s *Incidents) ListIncidentConferenceBridges(ctx context.Context, incidentID string, opts ...operations.Option) (*components.IncidentsConferenceBridgeEntity, error)

ListIncidentConferenceBridges - Retrieve all conference bridges for an incident Retrieve all conference bridges for an incident

func (*Incidents) ListIncidentEvents 

func (s *Incidents) ListIncidentEvents(ctx context.Context, incidentID string, types *string, page *int, perPage *int, opts ...operations.Option) (*components.IncidentEventEntityPaginated, error)

ListIncidentEvents - List events for an incident List all events for an incident. An event is a timeline entry. This can be filtered with params to retrieve events of a certain type.

func (*Incidents) ListIncidentImpacts 

func (s *Incidents) ListIncidentImpacts(ctx context.Context, incidentID string, type_ operations.ListIncidentImpactsType, opts ...operations.Option) (*components.IncidentImpactEntityPaginated, error)

ListIncidentImpacts - List impacted infrastructure for an incident List impacted infrastructure on an incident by specifying type 

func (s *Incidents) ListIncidentLinks(ctx context.Context, incidentID string, page *int, perPage *int, opts ...operations.Option) (*components.AttachmentsLinkEntityPaginated, error)

ListIncidentLinks - List links on an incident List all the editable, external incident links attached to an incident

func (*Incidents) ListIncidentMilestones 

func (s *Incidents) ListIncidentMilestones(ctx context.Context, incidentID string, opts ...operations.Option) (*components.IncidentsMilestoneEntityPaginated, error)

ListIncidentMilestones - List incident milestones List times and durations for each milestone on an incident

func (*Incidents) ListIncidentRoleAssignments 

func (s *Incidents) ListIncidentRoleAssignments(ctx context.Context, incidentID string, status *operations.Status, opts ...operations.Option) (*components.IncidentsRoleAssignmentEntityPaginated, error)

ListIncidentRoleAssignments - List incident assignees Retrieve a list of all of the current role assignments for the incident

func (*Incidents) ListIncidentStatusPages 

func (s *Incidents) ListIncidentStatusPages(ctx context.Context, incidentID string, opts ...operations.Option) (*components.IncidentsStatusPageEntityPaginated, error)

ListIncidentStatusPages - List status pages for an incident List status pages that are attached to an incident

func (*Incidents) ListIncidents 

func (s *Incidents) ListIncidents(ctx context.Context, request operations.ListIncidentsRequest, opts ...operations.Option) (*components.IncidentEntityPaginated, error)

ListIncidents - List incidents List all of the incidents in the organization

func (*Incidents) ListScheduledMaintenances 

func (s *Incidents) ListScheduledMaintenances(ctx context.Context, query *string, page *int, perPage *int, opts ...operations.Option) (*components.ScheduledMaintenanceEntity, error)

ListScheduledMaintenances - List scheduled maintenance events Lists all scheduled maintenance events

func (*Incidents) ListSimilarIncidents 

func (s *Incidents) ListSimilarIncidents(ctx context.Context, incidentID string, threshold *float32, limit *int, opts ...operations.Option) (*components.SimilarIncidentEntityPaginated, error)

ListSimilarIncidents - List similar incidents Retrieve a list of similar incidents

func (*Incidents) ListTranscriptEntries 

func (s *Incidents) ListTranscriptEntries(ctx context.Context, incidentID string, after *string, before *string, sort *operations.ListTranscriptEntriesSort, opts ...operations.Option) (*components.PublicAPIV1IncidentsTranscriptEntity, error)

ListTranscriptEntries - Lists all of the messages in the incident's transcript Retrieve the transcript for a specific incident

func (*Incidents) ResolveIncident 

func (s *Incidents) ResolveIncident(ctx context.Context, incidentID string, requestBody *operations.ResolveIncidentRequestBody, opts ...operations.Option) (*components.IncidentEntity, error)

ResolveIncident - Resolve an incident Resolves a currently active incident

func (*Incidents) UnarchiveIncident 

func (s *Incidents) UnarchiveIncident(ctx context.Context, incidentID string, opts ...operations.Option) (*components.IncidentEntity, error)

UnarchiveIncident - Unarchive an incident Unarchive an incident

func (*Incidents) UpdateIncident 

func (s *Incidents) UpdateIncident(ctx context.Context, incidentID string, updateIncident components.UpdateIncident, opts ...operations.Option) (*components.IncidentEntity, error)

UpdateIncident - Update an incident Updates an incident with provided parameters

func (*Incidents) UpdateIncidentChangeEvent 

func (s *Incidents) UpdateIncidentChangeEvent(ctx context.Context, relatedChangeEventID string, incidentID string, updateIncidentChangeEvent components.UpdateIncidentChangeEvent, opts ...operations.Option) (*components.IncidentsRelatedChangeEventEntity, error)

UpdateIncidentChangeEvent - Update a change attached to an incident Update a change attached to an incident

func (*Incidents) UpdateIncidentChatMessage 

func (s *Incidents) UpdateIncidentChatMessage(ctx context.Context, messageID string, incidentID string, updateIncidentChatMessage components.UpdateIncidentChatMessage, opts ...operations.Option) (*components.EventGenericChatMessageEntity, error)

UpdateIncidentChatMessage - Update a chat message on an incident Update an existing generic chat message on an incident.

func (*Incidents) UpdateIncidentEvent 

func (s *Incidents) UpdateIncidentEvent(ctx context.Context, incidentID string, eventID string, opts ...operations.Option) (*components.IncidentEventEntity, error)

UpdateIncidentEvent - Update an incident event Update a single event for an incident

func (*Incidents) UpdateIncidentImpactPatch 

func (s *Incidents) UpdateIncidentImpactPatch(ctx context.Context, incidentID string, updateIncidentImpactPatch components.UpdateIncidentImpactPatch, opts ...operations.Option) (*components.IncidentEntity, error)

UpdateIncidentImpactPatch - Update impacts for an incident Allows updating an incident's impacted infrastructure, with the option to move the incident into a different milestone and provide a note to update the incident timeline and any attached status pages. If this method is requested with the PUT verb, impacts will be completely replaced with the information in the request body, even if not provided (effectively clearing all impacts). If this method is requested with the PATCH verb, the provided impacts will be added or updated, but no impacts will be removed.

func (*Incidents) UpdateIncidentImpactPut 

func (s *Incidents) UpdateIncidentImpactPut(ctx context.Context, incidentID string, updateIncidentImpactPut components.UpdateIncidentImpactPut, opts ...operations.Option) (*components.IncidentEntity, error)

UpdateIncidentImpactPut - Update impacts for an incident Allows updating an incident's impacted infrastructure, with the option to move the incident into a different milestone and provide a note to update the incident timeline and any attached status pages. If this method is requested with the PUT verb, impacts will be completely replaced with the information in the request body, even if not provided (effectively clearing all impacts). If this method is requested with the PATCH verb, the provided impacts will be added or updated, but no impacts will be removed. 

func (s *Incidents) UpdateIncidentLink(ctx context.Context, linkID string, incidentID string, updateIncidentLink components.UpdateIncidentLink, opts ...operations.Option) error

UpdateIncidentLink - Update the external incident link Update the external incident link attributes

func (*Incidents) UpdateIncidentNote 

func (s *Incidents) UpdateIncidentNote(ctx context.Context, noteID string, incidentID string, updateIncidentNote components.UpdateIncidentNote, opts ...operations.Option) (*components.EventNoteEntity, error)

UpdateIncidentNote - Update a note Updates the body of a note

func (*Incidents) UpdateScheduledMaintenance 

func (s *Incidents) UpdateScheduledMaintenance(ctx context.Context, scheduledMaintenanceID string, updateScheduledMaintenance components.UpdateScheduledMaintenance, opts ...operations.Option) (*components.ScheduledMaintenanceEntity, error)

UpdateScheduledMaintenance - Update a scheduled maintenance event Change the conditions of a scheduled maintenance event, including updating any status page announcements of changes.

func (*Incidents) UpdateTranscriptAttribution 

func (s *Incidents) UpdateTranscriptAttribution(ctx context.Context, incidentID string, requestBody operations.UpdateTranscriptAttributionRequestBody, opts ...operations.Option) error

UpdateTranscriptAttribution - Update the attribution of a transcript Update the attribution of a transcript

func (*Incidents) VoteAiIncidentSummary 

func (s *Incidents) VoteAiIncidentSummary(ctx context.Context, incidentID string, generatedSummaryID string, requestBody operations.VoteAiIncidentSummaryRequestBody, opts ...operations.Option) (*components.AIEntitiesIncidentSummaryEntity, error)

VoteAiIncidentSummary - Vote on an AI-generated incident summary Vote on an AI-generated incident summary for the current user

type Integrations 

type Integrations struct {
	// contains filtered or unexported fields
}

Integrations - Operations related to Integrations

func (*Integrations) CreateConnection 

func (s *Integrations) CreateConnection(ctx context.Context, slug string, opts ...operations.Option) (*components.IntegrationsConnectionEntity, error)

CreateConnection - Create a new integration connection Create a new integration connection

func (*Integrations) CreateSlackEmojiAction 

func (s *Integrations) CreateSlackEmojiAction(ctx context.Context, connectionID string, requestBody operations.CreateSlackEmojiActionRequestBody, opts ...operations.Option) error

CreateSlackEmojiAction - Create a new Slack emoji action Creates a new Slack emoji action

func (*Integrations) DeleteSlackEmojiAction 

func (s *Integrations) DeleteSlackEmojiAction(ctx context.Context, connectionID string, emojiActionID string, opts ...operations.Option) error

DeleteSlackEmojiAction - Delete a Slack emoji action Deletes a Slack emoji action

func (*Integrations) DeleteStatuspageConnection 

func (s *Integrations) DeleteStatuspageConnection(ctx context.Context, connectionID string, opts ...operations.Option) error

DeleteStatuspageConnection - Delete a Statuspage connection Deletes the given Statuspage integration connection.

func (*Integrations) GetAwsCloudtrailBatch 

func (s *Integrations) GetAwsCloudtrailBatch(ctx context.Context, id string, opts ...operations.Option) (*components.IntegrationsAwsCloudtrailBatchEntity, error)

GetAwsCloudtrailBatch - Get a CloudTrail batch Retrieve a single CloudTrail batch.

func (*Integrations) GetAwsConnection 

func (s *Integrations) GetAwsConnection(ctx context.Context, id string, opts ...operations.Option) (*components.IntegrationsAwsConnectionEntity, error)

GetAwsConnection - Get an AWS connection Retrieves the information about the AWS connection.

func (*Integrations) GetIntegration 

func (s *Integrations) GetIntegration(ctx context.Context, integrationID string, opts ...operations.Option) (*components.IntegrationsIntegrationEntity, error)

GetIntegration - Get an integration Retrieve a single integration

func (*Integrations) GetSlackEmojiAction 

func (s *Integrations) GetSlackEmojiAction(ctx context.Context, connectionID string, emojiActionID string, opts ...operations.Option) error

GetSlackEmojiAction - Get a Slack emoji action Retrieves a Slack emoji action

func (*Integrations) GetStatuspageConnection 

func (s *Integrations) GetStatuspageConnection(ctx context.Context, connectionID string, opts ...operations.Option) (*components.IntegrationsStatuspageConnectionEntity, error)

GetStatuspageConnection - Get a Statuspage connection Retrieve the information about the Statuspage connection.

func (*Integrations) GetZendeskCustomerSupportIssue 

func (s *Integrations) GetZendeskCustomerSupportIssue(ctx context.Context, ticketID string, include *string, opts ...operations.Option) error

GetZendeskCustomerSupportIssue - Search for Zendesk tickets Search for Zendesk tickets

func (*Integrations) ListAuthedProviders 

func (s *Integrations) ListAuthedProviders(ctx context.Context, integrationSlug string, connectionID string, query *string, opts ...operations.Option) (*components.IntegrationsAuthedProviderEntityPaginated, error)

ListAuthedProviders - Lists the available and configured integrations Lists the available and configured integrations

func (*Integrations) ListAwsCloudtrailBatchEvents 

func (s *Integrations) ListAwsCloudtrailBatchEvents(ctx context.Context, id string, opts ...operations.Option) (*components.ChangeEventEntity, error)

ListAwsCloudtrailBatchEvents - List events for an AWS CloudTrail batch List events for an AWS CloudTrail batch

func (*Integrations) ListAwsCloudtrailBatches 

func (s *Integrations) ListAwsCloudtrailBatches(ctx context.Context, page *int, perPage *int, connectionID *string, opts ...operations.Option) (*components.IntegrationsAwsCloudtrailBatchEntityPaginated, error)

ListAwsCloudtrailBatches - List CloudTrail batches Lists CloudTrail batches for the authenticated organization.

func (*Integrations) ListAwsConnections 

func (s *Integrations) ListAwsConnections(ctx context.Context, request operations.ListAwsConnectionsRequest, opts ...operations.Option) (*components.IntegrationsAwsConnectionEntityPaginated, error)

ListAwsConnections - List AWS connections Lists the available and configured AWS integration connections for the authenticated organization.

func (*Integrations) ListConnectionStatuses 

func (s *Integrations) ListConnectionStatuses(ctx context.Context, opts ...operations.Option) (*components.IntegrationsConnectionStatusEntity, error)

ListConnectionStatuses - Get integration connection status Retrieve overall integration connection status

func (*Integrations) ListConnectionStatusesBySlug 

func (s *Integrations) ListConnectionStatusesBySlug(ctx context.Context, slug string, opts ...operations.Option) (*components.IntegrationsConnectionStatusEntity, error)

ListConnectionStatusesBySlug - Get an integration connection status Retrieve a single integration connection status

func (*Integrations) ListConnectionStatusesBySlugAndID 

func (s *Integrations) ListConnectionStatusesBySlugAndID(ctx context.Context, slug string, byConnectionID string, opts ...operations.Option) (*components.IntegrationsConnectionStatusEntity, error)

ListConnectionStatusesBySlugAndID - Get an integration connection status Retrieve a single integration connection status

func (*Integrations) ListConnections 

func (s *Integrations) ListConnections(ctx context.Context, integrationSlug *string, opts ...operations.Option) (*components.IntegrationsConnectionEntityPaginated, error)

ListConnections - List integration connections List available integration connections

func (*Integrations) ListFieldMapAvailableFields 

func (s *Integrations) ListFieldMapAvailableFields(ctx context.Context, fieldMapID string, opts ...operations.Option) (*components.FieldMappingMappableFieldEntity, error)

ListFieldMapAvailableFields - List available fields for field mapping Get a description of the fields to which data can be mapped

func (*Integrations) ListIntegrations 

func (s *Integrations) ListIntegrations(ctx context.Context, opts ...operations.Option) (*components.IntegrationsIntegrationEntityPaginated, error)

ListIntegrations - List integrations Lists the available and configured integrations

func (*Integrations) ListSlackEmojiActions 

func (s *Integrations) ListSlackEmojiActions(ctx context.Context, connectionID string, page *int, perPage *int, opts ...operations.Option) error

ListSlackEmojiActions - List Slack emoji actions Lists Slack emoji actions

func (*Integrations) ListSlackUsergroups 

func (s *Integrations) ListSlackUsergroups(ctx context.Context, opts ...operations.Option) (*components.IntegrationsSlackUsergroupEntity, error)

ListSlackUsergroups - List Slack user groups Lists all Slack user groups

func (*Integrations) ListSlackWorkspaces 

func (s *Integrations) ListSlackWorkspaces(ctx context.Context, connectionID string, opts ...operations.Option) (*components.IntegrationsSlackWorkspaceEntity, error)

ListSlackWorkspaces - List Slack workspaces Lists all Slack workspaces

func (*Integrations) ListStatuspageConnectionPages 

func (s *Integrations) ListStatuspageConnectionPages(ctx context.Context, connectionID string, opts ...operations.Option) (*components.IntegrationsStatuspagePageEntity, error)

ListStatuspageConnectionPages - List StatusPage pages for a connection Lists available page IDs for the Statuspage integration connection.

func (*Integrations) ListStatuspageConnections 

func (s *Integrations) ListStatuspageConnections(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.IntegrationsStatuspageConnectionEntityPaginated, error)

ListStatuspageConnections - List Statuspage connections Lists the available and configured Statuspage integrations connections for the authenticated organization.

func (*Integrations) RefreshConnection 

func (s *Integrations) RefreshConnection(ctx context.Context, slug string, connectionID string, opts ...operations.Option) (*components.IntegrationsConnectionEntity, error)

RefreshConnection - Refresh an integration connection Refresh the integration connection with the provided data

func (*Integrations) SearchConfluenceSpaces 

func (s *Integrations) SearchConfluenceSpaces(ctx context.Context, id string, keyword *string, opts ...operations.Option) (*components.IntegrationsConfluenceCloudSpaceKeyEntity, error)

SearchConfluenceSpaces - List Confluence spaces Lists available space keys for the Confluence integration connection.

func (*Integrations) SearchZendeskTickets 

func (s *Integrations) SearchZendeskTickets(ctx context.Context, connectionID string, query string, page *int, perPage *int, opts ...operations.Option) (*components.IntegrationsZendeskSearchTicketsPaginatedEntity, error)

SearchZendeskTickets - Search for Zendesk tickets Search for Zendesk tickets

func (*Integrations) UpdateAuthedProvider 

func (s *Integrations) UpdateAuthedProvider(ctx context.Context, integrationSlug string, connectionID string, authedProviderID string, requestBody *operations.UpdateAuthedProviderRequestBody, opts ...operations.Option) (*components.PublicAPIV1IntegrationsAuthedProviderEntity, error)

UpdateAuthedProvider - Get an authed provider Retrieve a single authed provider

func (*Integrations) UpdateAwsCloudtrailBatch 

func (s *Integrations) UpdateAwsCloudtrailBatch(ctx context.Context, id string, updateAwsCloudtrailBatch components.UpdateAwsCloudtrailBatch, opts ...operations.Option) (*components.IntegrationsAwsCloudtrailBatchEntity, error)

UpdateAwsCloudtrailBatch - Update a CloudTrail batch Update a CloudTrail batch with new information.

func (*Integrations) UpdateAwsConnection 

func (s *Integrations) UpdateAwsConnection(ctx context.Context, id string, updateAwsConnection components.UpdateAwsConnection, opts ...operations.Option) (*components.IntegrationsAwsConnectionEntity, error)

UpdateAwsConnection - Update an AWS connection Update the AWS connection with the provided data.

func (*Integrations) UpdateConnection 

func (s *Integrations) UpdateConnection(ctx context.Context, slug string, connectionID string, opts ...operations.Option) (*components.IntegrationsConnectionEntity, error)

UpdateConnection - Update an integration connection Update the integration connection with the provided data

func (*Integrations) UpdateFieldMap 

func (s *Integrations) UpdateFieldMap(ctx context.Context, fieldMapID string, opts ...operations.Option) (*components.FieldMappingFieldMapEntity, error)

UpdateFieldMap - Update field mapping Update field mapping

func (*Integrations) UpdateSlackEmojiAction 

func (s *Integrations) UpdateSlackEmojiAction(ctx context.Context, connectionID string, emojiActionID string, requestBody *operations.UpdateSlackEmojiActionRequestBody, opts ...operations.Option) error

UpdateSlackEmojiAction - Update a Slack emoji action Updates a Slack emoji action

func (*Integrations) UpdateStatuspageConnection 

func (s *Integrations) UpdateStatuspageConnection(ctx context.Context, connectionID string, updateStatuspageConnection components.UpdateStatuspageConnection, opts ...operations.Option) (*components.IntegrationsStatuspageConnectionEntity, error)

UpdateStatuspageConnection - Update a Statuspage connection Update the given Statuspage integration connection.

type MetricsReporting 

type MetricsReporting struct {
	// contains filtered or unexported fields
}

MetricsReporting - Operations related to Metrics & Reporting

func (*MetricsReporting) CreateSavedSearch 

func (s *MetricsReporting) CreateSavedSearch(ctx context.Context, resourceType operations.CreateSavedSearchResourceType, createSavedSearch components.CreateSavedSearch, opts ...operations.Option) (*components.SavedSearchEntity, error)

CreateSavedSearch - Create a saved search Create a new saved search for a particular resource type

func (*MetricsReporting) DeleteSavedSearch 

func (s *MetricsReporting) DeleteSavedSearch(ctx context.Context, resourceType operations.DeleteSavedSearchResourceType, savedSearchID string, opts ...operations.Option) error

DeleteSavedSearch - Delete a saved search Delete a specific saved search

func (*MetricsReporting) ExportSignalsShiftAnalytics 

func (s *MetricsReporting) ExportSignalsShiftAnalytics(ctx context.Context, periodStart time.Time, periodEnd time.Time, requestBody *operations.ExportSignalsShiftAnalyticsRequestBody, opts ...operations.Option) error

ExportSignalsShiftAnalytics - Export on-call hours report Export on-call hours report for users/teams during a time period

func (*MetricsReporting) GetMeanTimeReport 

func (s *MetricsReporting) GetMeanTimeReport(ctx context.Context, request operations.GetMeanTimeReportRequest, opts ...operations.Option) (*components.ReportEntity, error)

GetMeanTimeReport - Get mean time metrics for incidents Returns a report with time bucketed analytics data

func (*MetricsReporting) GetSavedSearch 

func (s *MetricsReporting) GetSavedSearch(ctx context.Context, resourceType operations.GetSavedSearchResourceType, savedSearchID string, opts ...operations.Option) (*components.SavedSearchEntity, error)

GetSavedSearch - Get a saved search Retrieve a specific save search

func (*MetricsReporting) GetSignalsGroupedMetrics 

func (s *MetricsReporting) GetSignalsGroupedMetrics(ctx context.Context, request operations.GetSignalsGroupedMetricsRequest, opts ...operations.Option) (*components.SignalsAPIAnalyticsGroupedMetricsEntity, error)

GetSignalsGroupedMetrics - Generate grouped alert metrics Generate a report of grouped metrics for Signals alerts

func (*MetricsReporting) GetSignalsMttxAnalytics 

func (s *MetricsReporting) GetSignalsMttxAnalytics(ctx context.Context, request operations.GetSignalsMttxAnalyticsRequest, opts ...operations.Option) (*components.SignalsAPIAnalyticsMttxMetricsEntity, error)

GetSignalsMttxAnalytics - Get MTTX analytics for signals Get mean-time-to-acknowledged (MTTA) and mean-time-to-resolved (MTTR) metrics for Signals alerts

func (*MetricsReporting) GetSignalsNoiseAnalytics 

func (s *MetricsReporting) GetSignalsNoiseAnalytics(ctx context.Context, request operations.GetSignalsNoiseAnalyticsRequest, opts ...operations.Option) (*components.SignalsAPIAnalyticsNoiseMetricsEntity, error)

GetSignalsNoiseAnalytics - Get noise analytics for signals Get noise metrics for Signals alerts

func (*MetricsReporting) GetSignalsTimeseriesAnalytics 

func (s *MetricsReporting) GetSignalsTimeseriesAnalytics(ctx context.Context, request operations.GetSignalsTimeseriesAnalyticsRequest, opts ...operations.Option) (*components.SignalsAPIAnalyticsTimeseriesPointEntity, error)

GetSignalsTimeseriesAnalytics - Generate timeseries alert metrics Generate a timeseries-based report of metrics for Signals alerts

func (*MetricsReporting) ListIncidentMetrics 

func (s *MetricsReporting) ListIncidentMetrics(ctx context.Context, request operations.ListIncidentMetricsRequest, opts ...operations.Option) (*components.MetricsMetricsEntity, error)

ListIncidentMetrics - List incident metrics and analytics Returns a report with time bucketed analytics data

func (*MetricsReporting) ListInfrastructureMetrics 

func (s *MetricsReporting) ListInfrastructureMetrics(ctx context.Context, infraType operations.ListInfrastructureMetricsInfraType, infraID string, startDate *types.Date, endDate *types.Date, opts ...operations.Option) (*components.MetricsInfrastructureMetricsEntity, error)

ListInfrastructureMetrics - Get metrics for a component Return metrics for a specific component

func (*MetricsReporting) ListInfrastructureTypeMetrics 

func (s *MetricsReporting) ListInfrastructureTypeMetrics(ctx context.Context, infraType operations.ListInfrastructureTypeMetricsInfraType, startDate *types.Date, endDate *types.Date, opts ...operations.Option) (*components.MetricsInfrastructureListEntity, error)

ListInfrastructureTypeMetrics - List metrics for a component type Returns metrics for all components of a given type

func (*MetricsReporting) ListMilestoneFunnelMetrics 

func (s *MetricsReporting) ListMilestoneFunnelMetrics(ctx context.Context, request operations.ListMilestoneFunnelMetricsRequest, opts ...operations.Option) (*components.MetricsMilestonesFunnelEntity, error)

ListMilestoneFunnelMetrics - List milestone funnel metrics Returns a report with time bucketed milestone data

func (*MetricsReporting) ListMttxMetrics 

func (s *MetricsReporting) ListMttxMetrics(ctx context.Context, request operations.ListMttxMetricsRequest, opts ...operations.Option) (*components.MetricsMttxDataEntity, error)

ListMttxMetrics - Get infrastructure metrics Fetch infrastructure metrics based on custom query

func (*MetricsReporting) ListRetrospectiveMetrics 

func (s *MetricsReporting) ListRetrospectiveMetrics(ctx context.Context, startDate *types.Date, endDate *types.Date, opts ...operations.Option) (*components.MetricsRetrospectiveEntity, error)

ListRetrospectiveMetrics - List retrospective metrics Returns a report with retrospective analytics data

func (*MetricsReporting) ListSavedSearches 

func (s *MetricsReporting) ListSavedSearches(ctx context.Context, request operations.ListSavedSearchesRequest, opts ...operations.Option) (*components.SavedSearchEntity, error)

ListSavedSearches - List saved searches Lists saved searches

func (*MetricsReporting) ListTicketFunnelMetrics 

func (s *MetricsReporting) ListTicketFunnelMetrics(ctx context.Context, request operations.ListTicketFunnelMetricsRequest, opts ...operations.Option) (*components.MetricsTicketFunnelMetricsEntity, error)

ListTicketFunnelMetrics - List ticket task and follow up creation and completion metrics Returns a report with task and follow up creation and completion data

func (*MetricsReporting) ListUserInvolvementMetrics 

func (s *MetricsReporting) ListUserInvolvementMetrics(ctx context.Context, request operations.ListUserInvolvementMetricsRequest, opts ...operations.Option) (*components.MetricsMetricsEntity, error)

ListUserInvolvementMetrics - List user metrics Returns a report with time bucketed analytics data

func (*MetricsReporting) UpdateSavedSearch 

func (s *MetricsReporting) UpdateSavedSearch(ctx context.Context, resourceType operations.UpdateSavedSearchResourceType, savedSearchID string, updateSavedSearch components.UpdateSavedSearch, opts ...operations.Option) (*components.SavedSearchEntity, error)

UpdateSavedSearch - Update a saved search Update a specific saved search

type Pages 

type Pages struct {
	// contains filtered or unexported fields
}

Pages - Operations about Pages

func (*Pages) CreateSignalsPage 

func (s *Pages) CreateSignalsPage(ctx context.Context, request components.CreateSignalsPage, opts ...operations.Option) (*components.AlertsAlertEntity, error)

CreateSignalsPage - Page a user, team, on-call schedule, or escalation policy 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.

type Permissions 

type Permissions struct {
	// contains filtered or unexported fields
}

Permissions - Operations about Permissions

func (*Permissions) ListCurrentUserPermissions 

func (s *Permissions) ListCurrentUserPermissions(ctx context.Context, opts ...operations.Option) (*components.PermissionEntityList, error)

ListCurrentUserPermissions - Get all permissions for the current user Get all permissions for the current user

func (*Permissions) ListPermissions 

func (s *Permissions) ListPermissions(ctx context.Context, opts ...operations.Option) (*components.PermissionEntityList, error)

ListPermissions - List permissions List all permissions in the organization

func (*Permissions) ListTeamPermissions 

func (s *Permissions) ListTeamPermissions(ctx context.Context, opts ...operations.Option) (*components.PermissionEntityList, error)

ListTeamPermissions - Get all permissions for a team Get all permissions for a team

type Retrospectives 

type Retrospectives struct {
	// contains filtered or unexported fields
}

Retrospectives - Operations related to Retrospectives

func (*Retrospectives) CreateIncidentRetrospective 

func (s *Retrospectives) CreateIncidentRetrospective(ctx context.Context, incidentID string, requestBody operations.CreateIncidentRetrospectiveRequestBody, opts ...operations.Option) (*components.IncidentsRetrospectiveEntity, error)

CreateIncidentRetrospective - Create a new retrospective on the incident using the template Create a new retrospective for an incident

func (*Retrospectives) CreateIncidentRetrospectiveDynamicInput 

func (s *Retrospectives) CreateIncidentRetrospectiveDynamicInput(ctx context.Context, retrospectiveID string, fieldID string, incidentID string, opts ...operations.Option) (*components.IncidentsRetrospectiveFieldEntity, error)

CreateIncidentRetrospectiveDynamicInput - Add a new dynamic input field to a retrospective's dynamic input group field Add a new dynamic input field to a dynamic input group

func (*Retrospectives) CreateIncidentRetrospectiveField 

func (s *Retrospectives) CreateIncidentRetrospectiveField(ctx context.Context, retrospectiveID string, incidentID string, requestBody operations.CreateIncidentRetrospectiveFieldRequestBody, opts ...operations.Option) (*components.IncidentsRetrospectiveFieldEntity, error)

CreateIncidentRetrospectiveField - Appends a new incident retrospective field to an incident retrospective Add a new field to an incident retrospective

func (*Retrospectives) CreatePostMortemReason 

func (s *Retrospectives) CreatePostMortemReason(ctx context.Context, reportID string, createPostMortemReason components.CreatePostMortemReason, opts ...operations.Option) (*components.PostMortemsReasonEntity, error)

CreatePostMortemReason - Create a contributing factor for a retrospective report Add a new contributing factor to an incident

func (*Retrospectives) CreatePostMortemReport 

func (s *Retrospectives) CreatePostMortemReport(ctx context.Context, request components.CreatePostMortemReport, opts ...operations.Option) (*components.PostMortemsPostMortemReportEntity, error)

CreatePostMortemReport - Create a retrospective report Create a report

func (*Retrospectives) CreateRetrospectiveTemplate 

func (s *Retrospectives) CreateRetrospectiveTemplate(ctx context.Context, request operations.CreateRetrospectiveTemplateRequest, opts ...operations.Option) (*components.RetrospectivesTemplateEntity, error)

CreateRetrospectiveTemplate - Create a retrospective template Create a new retrospective template

func (*Retrospectives) DeleteIncidentRetrospectiveDynamicInput 

func (s *Retrospectives) DeleteIncidentRetrospectiveDynamicInput(ctx context.Context, retrospectiveID string, fieldID string, dynamicInputFieldID string, incidentID string, opts ...operations.Option) error

DeleteIncidentRetrospectiveDynamicInput - Removes a dynamic input from a retrospective's dynamic input group field Delete a dynamic input on a dynamic input group

func (*Retrospectives) DeletePostMortemReason 

func (s *Retrospectives) DeletePostMortemReason(ctx context.Context, reportID string, reasonID string, opts ...operations.Option) error

DeletePostMortemReason - Delete a contributing factor from a retrospective report Delete a contributing factor

func (*Retrospectives) DeleteRetrospectiveTemplate 

func (s *Retrospectives) DeleteRetrospectiveTemplate(ctx context.Context, retrospectiveTemplateID string, opts ...operations.Option) error

DeleteRetrospectiveTemplate - Delete a retrospective template Delete a single retrospective template

func (*Retrospectives) ExportIncidentRetrospectives 

func (s *Retrospectives) ExportIncidentRetrospectives(ctx context.Context, incidentID string, requestBody operations.ExportIncidentRetrospectivesRequestBody, opts ...operations.Option) (*components.IncidentsExportRetrospectivesResultEntity, error)

ExportIncidentRetrospectives - Export an incident's retrospective(s) Export incident's retrospective(s) using their templates

func (*Retrospectives) GetIncidentRetrospectiveField 

func (s *Retrospectives) GetIncidentRetrospectiveField(ctx context.Context, retrospectiveID string, fieldID string, incidentID string, opts ...operations.Option) (*components.IncidentsRetrospectiveFieldEntity, error)

GetIncidentRetrospectiveField - Get a retrospective field Retrieve a field on an incident retrospective

func (*Retrospectives) GetPostMortemQuestion 

func (s *Retrospectives) GetPostMortemQuestion(ctx context.Context, questionID string, opts ...operations.Option) error

GetPostMortemQuestion - Get a retrospective question Get an incident retrospective question configured to be provided and filled out on each retrospective report.

func (*Retrospectives) GetPostMortemReport 

func (s *Retrospectives) GetPostMortemReport(ctx context.Context, reportID string, opts ...operations.Option) (*components.PostMortemsPostMortemReportEntity, error)

GetPostMortemReport - Get a retrospective report Get a report

func (*Retrospectives) GetRetrospectiveTemplate 

func (s *Retrospectives) GetRetrospectiveTemplate(ctx context.Context, retrospectiveTemplateID string, opts ...operations.Option) (*components.RetrospectivesTemplateEntity, error)

GetRetrospectiveTemplate - Get a retrospective template Retrieve a single retrospective template by ID

func (*Retrospectives) ListIncidentRetrospectives 

func (s *Retrospectives) ListIncidentRetrospectives(ctx context.Context, incidentID string, page *int, perPage *int, isHidden *bool, opts ...operations.Option) (*components.IncidentsRetrospectiveEntityPaginated, error)

ListIncidentRetrospectives - All attached retrospectives for an incident Retrieve retrospectives attached to an incident

func (*Retrospectives) ListPostMortemQuestions 

func (s *Retrospectives) ListPostMortemQuestions(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.PostMortemsQuestionTypeEntityPaginated, error)

ListPostMortemQuestions - List retrospective questions List the questions configured to be provided and filled out on each retrospective report.

func (*Retrospectives) ListPostMortemReasons 

func (s *Retrospectives) ListPostMortemReasons(ctx context.Context, reportID string, page *int, perPage *int, opts ...operations.Option) (*components.PostMortemsReasonEntityPaginated, error)

ListPostMortemReasons - List contributing factors for a retrospective report List all contributing factors to an incident

func (*Retrospectives) ListPostMortemReports 

func (s *Retrospectives) ListPostMortemReports(ctx context.Context, page *int, perPage *int, incidentID *string, updatedSince *time.Time, opts ...operations.Option) (*components.PostMortemsPostMortemReportEntityPaginated, error)

ListPostMortemReports - List retrospective reports List all reports

func (*Retrospectives) ListRetrospectiveTemplates 

func (s *Retrospectives) ListRetrospectiveTemplates(ctx context.Context, page *int, perPage *int, forIncident *string, opts ...operations.Option) (*components.RetrospectivesIndexTemplateEntityPaginated, error)

ListRetrospectiveTemplates - List retrospective templates List all retrospective templates

func (*Retrospectives) ListRetrospectives 

func (s *Retrospectives) ListRetrospectives(ctx context.Context, page *int, perPage *int, incidentID *string, updatedSince *time.Time, opts ...operations.Option) (*components.IncidentsRetrospectiveEntityPaginated, error)

ListRetrospectives - List retrospective reports List all retrospective reports

func (*Retrospectives) PublishPostMortemReport 

func (s *Retrospectives) PublishPostMortemReport(ctx context.Context, reportID string, publishPostMortemReport components.PublishPostMortemReport, opts ...operations.Option) (*components.PostMortemsPostMortemReportEntity, error)

PublishPostMortemReport - Publish a retrospective report Marks an incident retrospective as published and emails all of the participants in the report the summary

func (*Retrospectives) ReorderPostMortemReasons 

func (s *Retrospectives) ReorderPostMortemReasons(ctx context.Context, reportID string, reorderPostMortemReasons components.ReorderPostMortemReasons, opts ...operations.Option) (*components.PostMortemsReasonEntity, error)

ReorderPostMortemReasons - Reorder a contributing factor for a retrospective report Update the order of contributing factors in a retrospective report

func (*Retrospectives) ShareIncidentRetrospectives 

func (s *Retrospectives) ShareIncidentRetrospectives(ctx context.Context, incidentID string, requestBody operations.ShareIncidentRetrospectivesRequestBody, opts ...operations.Option) (*components.IncidentsShareRetrospectivesResultEntity, error)

ShareIncidentRetrospectives - Share an incident's retrospective Share incident retrospectives with users or teams

func (*Retrospectives) UpdateIncidentRetrospective 

func (s *Retrospectives) UpdateIncidentRetrospective(ctx context.Context, retrospectiveID string, incidentID string, updateIncidentRetrospective components.UpdateIncidentRetrospective, opts ...operations.Option) (*components.IncidentsRetrospectiveEntity, error)

UpdateIncidentRetrospective - Update a retrospective on the incident Update a retrospective attached to an incident

func (*Retrospectives) UpdateIncidentRetrospectiveField 

func (s *Retrospectives) UpdateIncidentRetrospectiveField(ctx context.Context, retrospectiveID string, fieldID string, incidentID string, updateIncidentRetrospectiveField components.UpdateIncidentRetrospectiveField, opts ...operations.Option) (*components.IncidentsRetrospectiveFieldEntity, error)

UpdateIncidentRetrospectiveField - Update the value on a retrospective field Update retrospective field value

func (*Retrospectives) UpdatePostMortemField 

func (s *Retrospectives) UpdatePostMortemField(ctx context.Context, fieldID string, reportID string, updatePostMortemField components.UpdatePostMortemField, opts ...operations.Option) (*components.PostMortemsSectionFieldEntity, error)

UpdatePostMortemField - Update a retrospective field Update a field value on a post mortem report

func (*Retrospectives) UpdatePostMortemQuestions 

func (s *Retrospectives) UpdatePostMortemQuestions(ctx context.Context, request components.UpdatePostMortemQuestions, opts ...operations.Option) (*components.PostMortemsQuestionTypeEntity, error)

UpdatePostMortemQuestions - Update retrospective questions Update the questions configured to be provided and filled out on future retrospective reports.

func (*Retrospectives) UpdatePostMortemReason 

func (s *Retrospectives) UpdatePostMortemReason(ctx context.Context, reportID string, reasonID string, updatePostMortemReason components.UpdatePostMortemReason, opts ...operations.Option) (*components.PostMortemsReasonEntity, error)

UpdatePostMortemReason - Update a contributing factor in a retrospective report Update a contributing factor

func (*Retrospectives) UpdatePostMortemReport 

func (s *Retrospectives) UpdatePostMortemReport(ctx context.Context, reportID string, updatePostMortemReport components.UpdatePostMortemReport, opts ...operations.Option) (*components.PostMortemsPostMortemReportEntity, error)

UpdatePostMortemReport - Update a retrospective report Update a report

func (*Retrospectives) UpdateRetrospectiveTemplate 

func (s *Retrospectives) UpdateRetrospectiveTemplate(ctx context.Context, retrospectiveTemplateID string, requestBody operations.UpdateRetrospectiveTemplateRequestBody, opts ...operations.Option) (*components.RetrospectivesTemplateEntity, error)

UpdateRetrospectiveTemplate - Update a retrospective template Update a single retrospective template

type Roles 

type Roles struct {
	// contains filtered or unexported fields
}

Roles - Operations about Roles

func (*Roles) CreateRole 

func (s *Roles) CreateRole(ctx context.Context, request components.CreateRole, opts ...operations.Option) (*components.PublicAPIV1RoleEntity, error)

CreateRole - Create a role Create a new role

func (*Roles) DeleteRole 

func (s *Roles) DeleteRole(ctx context.Context, id string, opts ...operations.Option) error

DeleteRole - Delete a role Delete a role

func (*Roles) GetRole 

func (s *Roles) GetRole(ctx context.Context, id string, opts ...operations.Option) (*components.PublicAPIV1RoleEntity, error)

GetRole - Get a role Get a role

func (*Roles) ListRoles 

func (s *Roles) ListRoles(ctx context.Context, query *string, page *int, perPage *int, opts ...operations.Option) (*components.RoleEntityPaginated, error)

ListRoles - Get all roles Get all roles in the organization

func (*Roles) UpdateRole 

func (s *Roles) UpdateRole(ctx context.Context, id string, updateRole components.UpdateRole, opts ...operations.Option) (*components.PublicAPIV1RoleEntity, error)

UpdateRole - Update a role Update a role

type Runbooks 

type Runbooks struct {
	// contains filtered or unexported fields
}

Runbooks - Operations related to Runbooks

func (*Runbooks) CreateRunbook 

func (s *Runbooks) CreateRunbook(ctx context.Context, request components.CreateRunbook, opts ...operations.Option) (*components.RunbookEntity, error)

CreateRunbook - Create a runbook Create a new runbook for use with incidents.

func (*Runbooks) CreateRunbookExecution 

func (s *Runbooks) CreateRunbookExecution(ctx context.Context, request components.CreateRunbookExecution, opts ...operations.Option) (*components.RunbooksExecutionEntity, error)

CreateRunbookExecution - Create a runbook execution Attaches a runbook to an incident and executes it

func (*Runbooks) DeleteRunbook 

func (s *Runbooks) DeleteRunbook(ctx context.Context, runbookID string, opts ...operations.Option) error

DeleteRunbook - Delete a runbook Delete a runbook and make it unavailable for any future incidents.

func (*Runbooks) DeleteRunbookExecution 

func (s *Runbooks) DeleteRunbookExecution(ctx context.Context, executionID string, reason string, opts ...operations.Option) error

DeleteRunbookExecution - Terminate a runbook execution Terminates a runbook execution, preventing any further steps from being executed

func (*Runbooks) GetRunbook 

func (s *Runbooks) GetRunbook(ctx context.Context, runbookID string, opts ...operations.Option) (*components.RunbookEntity, error)

GetRunbook - Get a runbook Get a runbook and all its configuration

func (*Runbooks) GetRunbookActionFieldOptions 

func (s *Runbooks) GetRunbookActionFieldOptions(ctx context.Context, request operations.GetRunbookActionFieldOptionsRequest, opts ...operations.Option) error

GetRunbookActionFieldOptions - List select options for a runbook integration action field List select options for a runbook integration action field

func (*Runbooks) GetRunbookExecution 

func (s *Runbooks) GetRunbookExecution(ctx context.Context, executionID string, opts ...operations.Option) (*components.RunbooksExecutionEntity, error)

GetRunbookExecution - Get a runbook execution Retrieve a runbook execution by ID

func (*Runbooks) GetRunbookExecutionStepScript 

func (s *Runbooks) GetRunbookExecutionStepScript(ctx context.Context, executionID string, stepID string, opts ...operations.Option) (*components.RunbooksExecutionEntity, error)

GetRunbookExecutionStepScript - Get a step's bash script Retrieves the bash script from a "script" step.

func (*Runbooks) ListRunbookActions 

func (s *Runbooks) ListRunbookActions(ctx context.Context, page *int, perPage *int, type_ *string, lite *bool, opts ...operations.Option) (*components.RunbooksActionsEntityPaginated, error)

ListRunbookActions - List runbook actions List all runbook actions available through your connected integrations

func (*Runbooks) ListRunbookAudits 

func (s *Runbooks) ListRunbookAudits(ctx context.Context, page *int, perPage *int, auditableType *operations.AuditableType, sort *string, opts ...operations.Option) error

ListRunbookAudits - List runbook audits This endpoint is deprecated.

func (*Runbooks) ListRunbookExecutions 

func (s *Runbooks) ListRunbookExecutions(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.RunbooksExecutionEntityPaginated, error)

ListRunbookExecutions - List runbook executions List all runbook executions across all runbooks

func (*Runbooks) ListRunbooks 

func (s *Runbooks) ListRunbooks(ctx context.Context, request operations.ListRunbooksRequest, opts ...operations.Option) (*components.RunbookEntity, error)

ListRunbooks - List runbooks Lists all available runbooks.

func (*Runbooks) UpdateRunbook 

func (s *Runbooks) UpdateRunbook(ctx context.Context, runbookID string, updateRunbook components.UpdateRunbook, opts ...operations.Option) (*components.RunbookEntity, error)

UpdateRunbook - Update a runbook Update a runbook and any attachment rules associated with it. This endpoint is used to configure nearly everything about a runbook, including but not limited to the steps, environments, attachment rules, and severities.

func (*Runbooks) UpdateRunbookExecutionStep 

func (s *Runbooks) UpdateRunbookExecutionStep(ctx context.Context, executionID string, stepID string, updateRunbookExecutionStep components.UpdateRunbookExecutionStep, opts ...operations.Option) (*components.RunbooksExecutionEntity, error)

UpdateRunbookExecutionStep - Update a runbook step execution Updates a runbook step execution, especially for changing the state of a step execution.

func (*Runbooks) UpdateRunbookExecutionStepScript 

func (s *Runbooks) UpdateRunbookExecutionStepScript(ctx context.Context, executionID string, stepID string, state string, opts ...operations.Option) (*components.RunbooksExecutionEntity, error)

UpdateRunbookExecutionStepScript - Update a script step's execution status Updates the execution's step.

type SDKOption 

type SDKOption func(*FireHydrant)

func WithClient 

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithRetryConfig 

func WithRetryConfig(retryConfig retry.Config) SDKOption

func WithSecurity 

func WithSecurity(security components.Security) SDKOption

WithSecurity configures the SDK to use the provided security details

func WithSecuritySource 

func WithSecuritySource(security func(context.Context) (components.Security, error)) SDKOption

WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication

func WithServerIndex 

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL 

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL 

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters

func WithTimeout 

func WithTimeout(timeout time.Duration) SDKOption

WithTimeout Optional request timeout applied to each operation

type Scim 

type Scim struct {
	// contains filtered or unexported fields
}

Scim - Operations related to SCIM

func (*Scim) CreateScimGroup 

func (s *Scim) CreateScimGroup(ctx context.Context, request components.CreateScimGroup, opts ...operations.Option) error

CreateScimGroup - Create a SCIM group and assign members SCIM endpoint to create a new Team (Colloquial for Group in the SCIM protocol). Any members defined in the payload will be assigned to the team with no defined role.

func (*Scim) CreateScimUser 

func (s *Scim) CreateScimUser(ctx context.Context, request components.CreateScimUser, opts ...operations.Option) error

CreateScimUser - Create a User from SCIM data 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.

func (*Scim) DeleteScimGroup 

func (s *Scim) DeleteScimGroup(ctx context.Context, id string, opts ...operations.Option) error

DeleteScimGroup - Delete a SCIM group SCIM endpoint to delete a Team (Colloquial for Group in the SCIM protocol).

func (*Scim) DeleteScimUser 

func (s *Scim) DeleteScimUser(ctx context.Context, id string, opts ...operations.Option) error

DeleteScimUser - Delete a User matching SCIM data SCIM endpoint to delete a User. This endpoint will deactivate a confirmed User record in our system.

func (*Scim) GetScimGroup 

func (s *Scim) GetScimGroup(ctx context.Context, id string, opts ...operations.Option) error

GetScimGroup - Get a SCIM group SCIM endpoint that lists a Team (Colloquial for Group in the SCIM protocol)

func (*Scim) GetScimUser 

func (s *Scim) GetScimUser(ctx context.Context, id string, opts ...operations.Option) error

GetScimUser - Get a SCIM user SCIM endpoint that lists a User

func (*Scim) ListScimGroups 

func (s *Scim) ListScimGroups(ctx context.Context, startIndex *int, count *int, filter *string, opts ...operations.Option) error

ListScimGroups - List SCIM groups SCIM endpoint that lists all Teams (Colloquial for Group in the SCIM protocol)

func (*Scim) ListScimUsers 

func (s *Scim) ListScimUsers(ctx context.Context, filter *string, startIndex *int, count *int, opts ...operations.Option) error

ListScimUsers - List SCIM users SCIM endpoint that lists users. This endpoint will display a list of Users currently in the system.

func (*Scim) PatchScimGroup 

func (s *Scim) PatchScimGroup(ctx context.Context, id string, patchScimGroup components.PatchScimGroup, opts ...operations.Option) error

PatchScimGroup - Partially update a SCIM group SCIM endpoint to partially update a Team (Colloquial for Group in the SCIM protocol). Supports adding, removing, or replacing members using SCIM PATCH operations.

func (*Scim) PatchScimUser 

func (s *Scim) PatchScimUser(ctx context.Context, id string, patchScimUser components.PatchScimUser, opts ...operations.Option) error

PatchScimUser - Update a User from SCIM data PATCH SCIM endpoint to update a User. This endpoint is used to update a resource's attributes.

func (*Scim) UpdateScimGroup 

func (s *Scim) UpdateScimGroup(ctx context.Context, id string, updateScimGroup components.UpdateScimGroup, opts ...operations.Option) error

UpdateScimGroup - Update a SCIM group and assign members SCIM endpoint to update a Team (Colloquial for Group in the SCIM protocol). Any members defined in the payload will be assigned to the team with no defined role, any missing members will be removed from the team.

func (*Scim) UpdateScimUser 

func (s *Scim) UpdateScimUser(ctx context.Context, id string, updateScimUser components.UpdateScimUser, opts ...operations.Option) error

UpdateScimUser - Update a User from SCIM data PUT SCIM endpoint to update a User. This endpoint is used to replace a resource's attributes.

type Signals 

type Signals struct {
	// contains filtered or unexported fields
}

Signals - Operations related to Signals

func (*Signals) CopyOnCallScheduleRotation 

func (s *Signals) CopyOnCallScheduleRotation(ctx context.Context, rotationID string, teamID string, scheduleID string, copyOnCallScheduleRotation components.CopyOnCallScheduleRotation, opts ...operations.Option) (*components.SignalsAPIOnCallRotationEntity, error)

CopyOnCallScheduleRotation - Copy an on-call schedule's rotation Copy an on-call rotation into a different schedule, allowing you to merge them together safely.

func (*Signals) CreateNotificationPolicy 

func (s *Signals) CreateNotificationPolicy(ctx context.Context, request operations.CreateNotificationPolicyRequest, opts ...operations.Option) (*components.SignalsAPINotificationPolicyItemEntity, error)

CreateNotificationPolicy - Create a notification policy Create a Signals notification policy.

func (*Signals) CreateOnCallScheduleRotation 

func (s *Signals) CreateOnCallScheduleRotation(ctx context.Context, teamID string, scheduleID string, createOnCallScheduleRotation components.CreateOnCallScheduleRotation, opts ...operations.Option) (*components.SignalsAPIOnCallRotationEntity, error)

CreateOnCallScheduleRotation - Create a new on-call rotation Add a new rotation to an existing on-call schedule

func (*Signals) CreateOnCallShift 

func (s *Signals) CreateOnCallShift(ctx context.Context, teamID string, scheduleID string, createOnCallShift components.CreateOnCallShift, opts ...operations.Option) (*components.SignalsAPIOnCallShiftEntity, error)

CreateOnCallShift - Create a shift for an on-call schedule Create a Signals on-call shift in a schedule.

func (*Signals) CreateSignalsAlertGroupingConfiguration 

func (s *Signals) CreateSignalsAlertGroupingConfiguration(ctx context.Context, request components.CreateSignalsAlertGroupingConfiguration, opts ...operations.Option) (*components.SignalsAPIGroupingEntity, error)

CreateSignalsAlertGroupingConfiguration - Create an alert grouping configuration. Create a Signals alert grouping rule for the organization.

func (*Signals) CreateSignalsEmailTarget 

func (s *Signals) CreateSignalsEmailTarget(ctx context.Context, request components.CreateSignalsEmailTarget, opts ...operations.Option) (*components.SignalsAPIEmailTargetEntity, error)

CreateSignalsEmailTarget - Create an email target for signals Create a Signals email target for a team.

func (*Signals) CreateSignalsEventSource 

func (s *Signals) CreateSignalsEventSource(ctx context.Context, request components.CreateSignalsEventSource, opts ...operations.Option) (*components.SignalsAPITransposerEntity, error)

CreateSignalsEventSource - Create an event source for Signals Create a Signals event source for the authenticated user.

func (*Signals) CreateSignalsWebhookTarget 

func (s *Signals) CreateSignalsWebhookTarget(ctx context.Context, request components.CreateSignalsWebhookTarget, opts ...operations.Option) (*components.SignalsAPIWebhookTargetEntity, error)

CreateSignalsWebhookTarget - Create a webhook target Create a Signals webhook target.

func (*Signals) CreateTeamEscalationPolicy 

func (s *Signals) CreateTeamEscalationPolicy(ctx context.Context, teamID string, createTeamEscalationPolicy components.CreateTeamEscalationPolicy, opts ...operations.Option) (*components.SignalsAPIEscalationPolicyEntity, error)

CreateTeamEscalationPolicy - Create an escalation policy for a team Create a Signals escalation policy for a team.

func (*Signals) CreateTeamOnCallSchedule 

func (s *Signals) CreateTeamOnCallSchedule(ctx context.Context, teamID string, createTeamOnCallSchedule components.CreateTeamOnCallSchedule, opts ...operations.Option) (*components.SignalsAPIOnCallScheduleEntity, error)

CreateTeamOnCallSchedule - Create an on-call schedule for a team Create a Signals on-call schedule for a team with a single rotation. More rotations can be created later.

func (*Signals) CreateTeamSignalRule 

func (s *Signals) CreateTeamSignalRule(ctx context.Context, teamID string, createTeamSignalRule components.CreateTeamSignalRule, opts ...operations.Option) (*components.SignalsAPIRuleEntity, error)

CreateTeamSignalRule - Create a Signals rule Create a Signals rule for a team.

func (*Signals) DebugSignalsExpression 

func (s *Signals) DebugSignalsExpression(ctx context.Context, request components.DebugSignalsExpression, opts ...operations.Option) error

DebugSignalsExpression - Debug Signals expressions Debug Signals expressions

func (*Signals) DeleteNotificationPolicy 

func (s *Signals) DeleteNotificationPolicy(ctx context.Context, id string, opts ...operations.Option) error

DeleteNotificationPolicy - Delete a notification policy Delete a Signals notification policy by ID

func (*Signals) DeleteOnCallScheduleRotation 

func (s *Signals) DeleteOnCallScheduleRotation(ctx context.Context, rotationID string, teamID string, scheduleID string, opts ...operations.Option) error

DeleteOnCallScheduleRotation - Delete an on-call schedule's rotation Delete an on-call schedule's rotation by ID

func (*Signals) DeleteOnCallShift 

func (s *Signals) DeleteOnCallShift(ctx context.Context, id string, teamID string, scheduleID string, opts ...operations.Option) error

DeleteOnCallShift - Delete an on-call shift from a team schedule Delete a Signals on-call shift by ID

func (*Signals) DeleteSignalsAlertGroupingConfiguration 

func (s *Signals) DeleteSignalsAlertGroupingConfiguration(ctx context.Context, id string, opts ...operations.Option) error

DeleteSignalsAlertGroupingConfiguration - Delete an alert grouping configuration. Delete a Signals alert grouping rule by ID.

func (*Signals) DeleteSignalsEmailTarget 

func (s *Signals) DeleteSignalsEmailTarget(ctx context.Context, id string, opts ...operations.Option) error

DeleteSignalsEmailTarget - Delete a signal email target Delete a Signals email target by ID

func (*Signals) DeleteSignalsEventSource 

func (s *Signals) DeleteSignalsEventSource(ctx context.Context, transposerSlug string, opts ...operations.Option) error

DeleteSignalsEventSource - Delete an event source for Signals Delete a Signals event source by slug

func (*Signals) DeleteSignalsWebhookTarget 

func (s *Signals) DeleteSignalsWebhookTarget(ctx context.Context, id string, opts ...operations.Option) error

DeleteSignalsWebhookTarget - Delete a webhook target Delete a Signals webhook target by ID

func (*Signals) DeleteTeamEscalationPolicy 

func (s *Signals) DeleteTeamEscalationPolicy(ctx context.Context, teamID string, id string, opts ...operations.Option) error

DeleteTeamEscalationPolicy - Delete an escalation policy for a team Delete a Signals escalation policy by ID

func (*Signals) DeleteTeamOnCallSchedule 

func (s *Signals) DeleteTeamOnCallSchedule(ctx context.Context, teamID string, scheduleID string, opts ...operations.Option) error

DeleteTeamOnCallSchedule - Delete an on-call schedule for a team Delete a Signals on-call schedule by ID

func (*Signals) DeleteTeamSignalRule 

func (s *Signals) DeleteTeamSignalRule(ctx context.Context, teamID string, id string, opts ...operations.Option) error

DeleteTeamSignalRule - Delete a Signals rule Delete a Signals rule by ID

func (*Signals) GetNotificationPolicy 

func (s *Signals) GetNotificationPolicy(ctx context.Context, id string, opts ...operations.Option) (*components.SignalsAPINotificationPolicyItemEntity, error)

GetNotificationPolicy - Get a notification policy Get a Signals notification policy by ID

func (*Signals) GetOnCallScheduleRotation 

func (s *Signals) GetOnCallScheduleRotation(ctx context.Context, rotationID string, teamID string, scheduleID string, opts ...operations.Option) (*components.SignalsAPIOnCallRotationEntity, error)

GetOnCallScheduleRotation - Get an on-call rotation Get an on-call rotation by ID

func (*Signals) GetOnCallShift 

func (s *Signals) GetOnCallShift(ctx context.Context, id string, teamID string, scheduleID string, opts ...operations.Option) (*components.SignalsAPIOnCallShiftEntity, error)

GetOnCallShift - Get an on-call shift for a team schedule Get a Signals on-call shift by ID

func (*Signals) GetSignalsAlertGroupingConfiguration 

func (s *Signals) GetSignalsAlertGroupingConfiguration(ctx context.Context, id string, opts ...operations.Option) (*components.SignalsAPIGroupingEntity, error)

GetSignalsAlertGroupingConfiguration - Get an alert grouping configuration. Get a Signals alert grouping rule by ID.

func (*Signals) GetSignalsEmailTarget 

func (s *Signals) GetSignalsEmailTarget(ctx context.Context, id string, opts ...operations.Option) (*components.SignalsAPIEmailTargetEntity, error)

GetSignalsEmailTarget - Get a signal email target Get a Signals email target by ID

func (*Signals) GetSignalsEventSource 

func (s *Signals) GetSignalsEventSource(ctx context.Context, transposerSlug string, opts ...operations.Option) (*components.SignalsAPITransposerEntity, error)

GetSignalsEventSource - Get an event source for Signals Get a Signals event source by slug

func (*Signals) GetSignalsHackerMode 

func (s *Signals) GetSignalsHackerMode(ctx context.Context, opts ...operations.Option) (*components.SignalsAPIHackerModeEntity, error)

GetSignalsHackerMode - Get hacker mode status Get the status of the hacker mode for the current user

func (*Signals) GetSignalsIngestURL 

func (s *Signals) GetSignalsIngestURL(ctx context.Context, teamID *string, escalationPolicyID *string, onCallScheduleID *string, userID *string, opts ...operations.Option) (*components.SignalsAPIIngestKeyEntity, error)

GetSignalsIngestURL - Get the signals ingestion URL Retrieve the url for ingesting signals for your organization

func (*Signals) GetSignalsWebhookTarget 

func (s *Signals) GetSignalsWebhookTarget(ctx context.Context, id string, opts ...operations.Option) (*components.SignalsAPIWebhookTargetEntity, error)

GetSignalsWebhookTarget - Get a webhook target Get a Signals webhook target by ID

func (*Signals) GetTeamEscalationPolicy 

func (s *Signals) GetTeamEscalationPolicy(ctx context.Context, teamID string, id string, opts ...operations.Option) (*components.SignalsAPIEscalationPolicyEntity, error)

GetTeamEscalationPolicy - Get an escalation policy for a team Get a Signals escalation policy by ID

func (*Signals) GetTeamOnCallSchedule 

func (s *Signals) GetTeamOnCallSchedule(ctx context.Context, teamID string, scheduleID string, shiftTimeWindowStart *string, shiftTimeWindowEnd *string, opts ...operations.Option) (*components.SignalsAPIOnCallScheduleEntity, error)

GetTeamOnCallSchedule - Get an on-call schedule for a team Get a Signals on-call schedule by ID

func (*Signals) GetTeamSignalRule 

func (s *Signals) GetTeamSignalRule(ctx context.Context, teamID string, id string, opts ...operations.Option) (*components.SignalsAPIRuleEntity, error)

GetTeamSignalRule - Get a Signals rule Get a Signals rule by ID.

func (*Signals) ListNotificationPolicySettings 

func (s *Signals) ListNotificationPolicySettings(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.SignalsAPINotificationPolicyItemEntityPaginated, error)

ListNotificationPolicySettings - List notification policies List all Signals notification policies.

func (*Signals) ListOrganizationOnCallSchedules 

func (s *Signals) ListOrganizationOnCallSchedules(ctx context.Context, teamID *string, opts ...operations.Option) (*components.SignalsAPIOrganizationOnCallScheduleEntityPaginated, error)

ListOrganizationOnCallSchedules - List who's on call for the organization List all users who are currently on-call across the entire organization.

func (*Signals) ListSignalsAlertGroupingConfigurations 

func (s *Signals) ListSignalsAlertGroupingConfigurations(ctx context.Context, opts ...operations.Option) (*components.SignalsAPIGroupingEntityPaginated, error)

ListSignalsAlertGroupingConfigurations - List alert grouping configurations. List all Signals alert grouping rules for the organization.

func (*Signals) ListSignalsEmailTargets 

func (s *Signals) ListSignalsEmailTargets(ctx context.Context, query *string, opts ...operations.Option) (*components.SignalsAPIEmailTargetEntityPaginated, error)

ListSignalsEmailTargets - List email targets for signals List all Signals email targets for a team.

func (*Signals) ListSignalsEventSources 

func (s *Signals) ListSignalsEventSources(ctx context.Context, teamID *string, escalationPolicyID *string, onCallScheduleID *string, userID *string, opts ...operations.Option) (*components.SignalsAPITransposerListEntity, error)

ListSignalsEventSources - List event sources for Signals List all Signals event sources for the authenticated user.

func (*Signals) ListSignalsTransposers 

func (s *Signals) ListSignalsTransposers(ctx context.Context, opts ...operations.Option) (*components.SignalsAPITransposerListEntity, error)

ListSignalsTransposers - List signal transposers List all transposers for your organization

func (*Signals) ListSignalsWebhookTargets 

func (s *Signals) ListSignalsWebhookTargets(ctx context.Context, query *string, page *int, perPage *int, opts ...operations.Option) (*components.SignalsAPIWebhookTargetEntityPaginated, error)

ListSignalsWebhookTargets - List webhook targets List all Signals webhook targets.

func (*Signals) ListTeamEscalationPolicies 

func (s *Signals) ListTeamEscalationPolicies(ctx context.Context, teamID string, query *string, page *int, perPage *int, opts ...operations.Option) (*components.SignalsAPIEscalationPolicyEntityPaginated, error)

ListTeamEscalationPolicies - List escalation policies for a team List all Signals escalation policies for a team.

func (*Signals) ListTeamOnCallSchedules 

func (s *Signals) ListTeamOnCallSchedules(ctx context.Context, request operations.ListTeamOnCallSchedulesRequest, opts ...operations.Option) (*components.SignalsAPIOnCallScheduleEntityPaginated, error)

ListTeamOnCallSchedules - List on-call schedules for a team List all Signals on-call schedules for a team.

func (*Signals) ListTeamSignalRules 

func (s *Signals) ListTeamSignalRules(ctx context.Context, teamID string, query *string, page *int, perPage *int, opts ...operations.Option) (*components.SignalsAPIRuleEntityPaginated, error)

ListTeamSignalRules - List Signals rules List all Signals rules for a team.

func (*Signals) OverrideOnCallScheduleRotationShifts 

func (s *Signals) OverrideOnCallScheduleRotationShifts(ctx context.Context, rotationID string, teamID string, scheduleID string, overrideOnCallScheduleRotationShifts components.OverrideOnCallScheduleRotationShifts, opts ...operations.Option) (*components.SignalsAPIOnCallShiftEntity, error)

OverrideOnCallScheduleRotationShifts - Override one or more shifts in an on-call rotation Create an override covering a specific time period in an on-call rotation, re-assigning that period to a specific user.

func (*Signals) PreviewOnCallScheduleRotation 

func (s *Signals) PreviewOnCallScheduleRotation(ctx context.Context, teamID string, scheduleID string, previewOnCallScheduleRotation components.PreviewOnCallScheduleRotation, opts ...operations.Option) (*components.SignalsAPIOnCallSchedulePreviewEntityRotationPreviewEntity, error)

PreviewOnCallScheduleRotation - Preview an on-call rotation Preview a new on-call rotation orchanges to an existing on-call rotation

func (*Signals) PreviewTeamOnCallSchedule 

func (s *Signals) PreviewTeamOnCallSchedule(ctx context.Context, teamID string, previewTeamOnCallSchedule components.PreviewTeamOnCallSchedule, opts ...operations.Option) (*components.SignalsAPIOnCallSchedulePreviewEntity, error)

PreviewTeamOnCallSchedule - Preview a new on-call schedule for a team Preview a new on-call schedule based on the provided rotations, allowing you to see how the schedule will look before saving it.

func (*Signals) UpdateNotificationPolicy 

func (s *Signals) UpdateNotificationPolicy(ctx context.Context, id string, requestBody *operations.UpdateNotificationPolicyRequestBody, opts ...operations.Option) error

UpdateNotificationPolicy - Update a notification policy Update a Signals notification policy by ID

func (*Signals) UpdateOnCallScheduleRotation 

func (s *Signals) UpdateOnCallScheduleRotation(ctx context.Context, rotationID string, teamID string, scheduleID string, updateOnCallScheduleRotation components.UpdateOnCallScheduleRotation, opts ...operations.Option) (*components.SignalsAPIOnCallRotationEntity, error)

UpdateOnCallScheduleRotation - Update an on-call schedule's rotation Update an on-call schedule's rotation by ID

func (*Signals) UpdateOnCallShift 

func (s *Signals) UpdateOnCallShift(ctx context.Context, id string, teamID string, scheduleID string, updateOnCallShift components.UpdateOnCallShift, opts ...operations.Option) (*components.SignalsAPIOnCallShiftEntity, error)

UpdateOnCallShift - Update an on-call shift for a team schedule Update a Signals on-call shift by ID

func (*Signals) UpdateSignalsAlertGroupingConfiguration 

func (s *Signals) UpdateSignalsAlertGroupingConfiguration(ctx context.Context, id string, updateSignalsAlertGroupingConfiguration components.UpdateSignalsAlertGroupingConfiguration, opts ...operations.Option) (*components.SignalsAPIGroupingEntity, error)

UpdateSignalsAlertGroupingConfiguration - Update an alert grouping configuration. Update a Signals alert grouping rule for the organization.

func (*Signals) UpdateSignalsEmailTarget 

func (s *Signals) UpdateSignalsEmailTarget(ctx context.Context, id string, updateSignalsEmailTarget components.UpdateSignalsEmailTarget, opts ...operations.Option) (*components.SignalsAPIEmailTargetEntity, error)

UpdateSignalsEmailTarget - Update an email target Update a Signals email target by ID

func (*Signals) UpdateSignalsWebhookTarget 

func (s *Signals) UpdateSignalsWebhookTarget(ctx context.Context, id string, updateSignalsWebhookTarget components.UpdateSignalsWebhookTarget, opts ...operations.Option) (*components.SignalsAPIWebhookTargetEntity, error)

UpdateSignalsWebhookTarget - Update a webhook target Update a Signals webhook target by ID

func (*Signals) UpdateTeamEscalationPolicy 

func (s *Signals) UpdateTeamEscalationPolicy(ctx context.Context, teamID string, id string, updateTeamEscalationPolicy components.UpdateTeamEscalationPolicy, opts ...operations.Option) (*components.SignalsAPIEscalationPolicyEntity, error)

UpdateTeamEscalationPolicy - Update an escalation policy for a team Update a Signals escalation policy by ID

func (*Signals) UpdateTeamOnCallSchedule 

func (s *Signals) UpdateTeamOnCallSchedule(ctx context.Context, teamID string, scheduleID string, updateTeamOnCallSchedule components.UpdateTeamOnCallSchedule, opts ...operations.Option) (*components.SignalsAPIOnCallScheduleEntity, error)

UpdateTeamOnCallSchedule - Update an on-call schedule for a team Update a Signals on-call schedule by ID. For backwards compatibility, all parameters except for `name` and `description` will be ignored if the schedule has more than one rotation. If the schedule has only one rotation, you can continue to update that rotation using the rotation-specific parameters.

func (*Signals) UpdateTeamSignalRule 

func (s *Signals) UpdateTeamSignalRule(ctx context.Context, teamID string, id string, updateTeamSignalRule components.UpdateTeamSignalRule, opts ...operations.Option) (*components.SignalsAPIRuleEntity, error)

UpdateTeamSignalRule - Update a Signals rule Update a Signals rule by ID

type StatusPages 

type StatusPages struct {
	// contains filtered or unexported fields
}

StatusPages - Operations related to Status Pages

func (*StatusPages) CreateEmailSubscriber 

func (s *StatusPages) CreateEmailSubscriber(ctx context.Context, nuncConnectionID string, requestBody operations.CreateEmailSubscriberRequestBody, opts ...operations.Option) (*components.NuncEmailSubscribersEntity, error)

CreateEmailSubscriber - Add subscribers to a status page Subscribes a comma-separated string of emails to status page updates

func (*StatusPages) CreateNuncComponentGroup 

func (s *StatusPages) CreateNuncComponentGroup(ctx context.Context, nuncConnectionID string, requestBody operations.CreateNuncComponentGroupRequestBody, opts ...operations.Option) (*components.NuncConnectionEntity, error)

CreateNuncComponentGroup - Create a component group for a status page Add a component group to be displayed on a FireHydrant status page

func (*StatusPages) CreateNuncConnection 

func (s *StatusPages) CreateNuncConnection(ctx context.Context, request operations.CreateNuncConnectionRequest, opts ...operations.Option) (*components.NuncConnectionEntity, error)

CreateNuncConnection - Create a status page Create a new FireHydrant hosted status page for customer facing statuses. 

func (s *StatusPages) CreateNuncLink(ctx context.Context, nuncConnectionID string, opts ...operations.Option) (*components.NuncConnectionEntity, error)

CreateNuncLink - Add link to a status page Add a link to be displayed on a FireHydrant status page

func (*StatusPages) CreateNuncSubscription 

func (s *StatusPages) CreateNuncSubscription(ctx context.Context, request components.CreateNuncSubscription, opts ...operations.Option) (*components.NuncNuncSubscription, error)

CreateNuncSubscription - Create a status page subscription Subscribe to status page updates

func (*StatusPages) DeleteEmailSubscriber 

func (s *StatusPages) DeleteEmailSubscriber(ctx context.Context, nuncConnectionID string, subscriberIds string, opts ...operations.Option) error

DeleteEmailSubscriber - Remove subscribers from a status page Unsubscribes one or more status page subscribers.

func (*StatusPages) DeleteIncidentStatusPage 

func (s *StatusPages) DeleteIncidentStatusPage(ctx context.Context, statusPageID string, incidentID string, opts ...operations.Option) error

DeleteIncidentStatusPage - Remove a status page from an incident Remove a status page incident attached to an incident

func (*StatusPages) DeleteNuncComponentGroup 

func (s *StatusPages) DeleteNuncComponentGroup(ctx context.Context, nuncConnectionID string, groupID string, opts ...operations.Option) error

DeleteNuncComponentGroup - Delete a status page component group Delete a component group displayed on a FireHydrant status page

func (*StatusPages) DeleteNuncConnection 

func (s *StatusPages) DeleteNuncConnection(ctx context.Context, nuncConnectionID string, opts ...operations.Option) error

DeleteNuncConnection - Delete a status page Delete a FireHydrant hosted status page, stopping updates of your incidents to it.

func (*StatusPages) DeleteNuncImage 

func (s *StatusPages) DeleteNuncImage(ctx context.Context, nuncConnectionID string, type_ string, opts ...operations.Option) error

DeleteNuncImage - Delete an image from a status page Delete an image attached to a FireHydrant status page 

func (s *StatusPages) DeleteNuncLink(ctx context.Context, nuncConnectionID string, linkID string, opts ...operations.Option) error

DeleteNuncLink - Delete a status page link Delete a link displayed on a FireHydrant status page

func (*StatusPages) DeleteNuncSubscription 

func (s *StatusPages) DeleteNuncSubscription(ctx context.Context, unsubscribeToken string, opts ...operations.Option) error

DeleteNuncSubscription - Unsubscribe from status page notifications Unsubscribe from status page updates

func (*StatusPages) GetNuncConnection 

func (s *StatusPages) GetNuncConnection(ctx context.Context, nuncConnectionID string, opts ...operations.Option) (*components.NuncConnectionEntity, error)

GetNuncConnection - Get a status page Retrieve the information displayed as part of your FireHydrant hosted status page.

func (*StatusPages) ListEmailSubscribers 

func (s *StatusPages) ListEmailSubscribers(ctx context.Context, nuncConnectionID string, opts ...operations.Option) (*components.NuncEmailSubscribersEntity, error)

ListEmailSubscribers - List status page subscribers Retrieves the list of subscribers for a status page.

func (*StatusPages) ListNuncConnections 

func (s *StatusPages) ListNuncConnections(ctx context.Context, opts ...operations.Option) (*components.NuncConnectionEntityPaginated, error)

ListNuncConnections - List status pages Lists the information displayed as part of your FireHydrant hosted status pages.

func (*StatusPages) UpdateNuncComponentGroup 

func (s *StatusPages) UpdateNuncComponentGroup(ctx context.Context, nuncConnectionID string, groupID string, requestBody *operations.UpdateNuncComponentGroupRequestBody, opts ...operations.Option) error

UpdateNuncComponentGroup - Update a status page component group Update a component group to be displayed on a FireHydrant status page

func (*StatusPages) UpdateNuncConnection 

func (s *StatusPages) UpdateNuncConnection(ctx context.Context, nuncConnectionID string, requestBody operations.UpdateNuncConnectionRequestBody, opts ...operations.Option) (*components.NuncConnectionEntity, error)

UpdateNuncConnection - Update a status page Update your company's information and other components in the specified FireHydrant hosted status page.

func (*StatusPages) UpdateNuncImage 

func (s *StatusPages) UpdateNuncImage(ctx context.Context, nuncConnectionID string, type_ string, requestBody *operations.UpdateNuncImageRequestBody, opts ...operations.Option) (*components.NuncConnectionEntity, error)

UpdateNuncImage - Upload an image for a status page Add or replace an image attached to a FireHydrant status page 

func (s *StatusPages) UpdateNuncLink(ctx context.Context, nuncConnectionID string, linkID string, updateNuncLink components.UpdateNuncLink, opts ...operations.Option) error

UpdateNuncLink - Update a status page link Update a link to be displayed on a FireHydrant status page

type Tasks 

type Tasks struct {
	// contains filtered or unexported fields
}

Tasks - Operations related to Tasks

func (*Tasks) ConvertIncidentTask 

func (s *Tasks) ConvertIncidentTask(ctx context.Context, taskID string, incidentID string, convertIncidentTask components.ConvertIncidentTask, opts ...operations.Option) (*components.TaskEntityPaginated, error)

ConvertIncidentTask - Convert a task to a follow-up Convert a task to a follow-up

func (*Tasks) CreateChecklistTemplate 

func (s *Tasks) CreateChecklistTemplate(ctx context.Context, request components.CreateChecklistTemplate, opts ...operations.Option) (*components.ChecklistTemplateEntity, error)

CreateChecklistTemplate - Create a checklist template Creates a checklist template for the organization

func (*Tasks) CreateIncidentTask 

func (s *Tasks) CreateIncidentTask(ctx context.Context, incidentID string, createIncidentTask components.CreateIncidentTask, opts ...operations.Option) (*components.TaskEntity, error)

CreateIncidentTask - Create an incident task Create a task

func (*Tasks) CreateIncidentTaskList 

func (s *Tasks) CreateIncidentTaskList(ctx context.Context, incidentID string, createIncidentTaskList components.CreateIncidentTaskList, opts ...operations.Option) (*components.TaskEntity, error)

CreateIncidentTaskList - Add tasks from a task list to an incident Add all tasks from list to incident

func (*Tasks) CreateTaskList 

func (s *Tasks) CreateTaskList(ctx context.Context, request components.CreateTaskList, opts ...operations.Option) (*components.TaskListEntity, error)

CreateTaskList - Create a task list Creates a new task list

func (*Tasks) DeleteChecklistTemplate 

func (s *Tasks) DeleteChecklistTemplate(ctx context.Context, id string, opts ...operations.Option) error

DeleteChecklistTemplate - Archive a checklist template Archive a checklist template

func (*Tasks) DeleteIncidentTask 

func (s *Tasks) DeleteIncidentTask(ctx context.Context, taskID string, incidentID string, opts ...operations.Option) error

DeleteIncidentTask - Delete an incident task Delete a task

func (*Tasks) DeleteTaskList 

func (s *Tasks) DeleteTaskList(ctx context.Context, taskListID string, opts ...operations.Option) error

DeleteTaskList - Delete a task list Delete a task list

func (*Tasks) GetChecklistTemplate 

func (s *Tasks) GetChecklistTemplate(ctx context.Context, id string, opts ...operations.Option) (*components.ChecklistTemplateEntity, error)

GetChecklistTemplate - Get a checklist template Retrieves a single checklist template by ID

func (*Tasks) GetIncidentTask 

func (s *Tasks) GetIncidentTask(ctx context.Context, taskID string, incidentID string, opts ...operations.Option) error

GetIncidentTask - Get an incident task Retrieve a single task for an incident

func (*Tasks) GetTaskList 

func (s *Tasks) GetTaskList(ctx context.Context, taskListID string, opts ...operations.Option) (*components.TaskListEntity, error)

GetTaskList - Get a task list Retrieves a single task list by ID

func (*Tasks) ListChecklistTemplates 

func (s *Tasks) ListChecklistTemplates(ctx context.Context, page *int, perPage *int, query *string, opts ...operations.Option) (*components.ChecklistTemplateEntityPaginated, error)

ListChecklistTemplates - List checklist templates List all of the checklist templates that have been added to the organization

func (*Tasks) ListIncidentTasks 

func (s *Tasks) ListIncidentTasks(ctx context.Context, incidentID string, page *int, perPage *int, opts ...operations.Option) (*components.TaskEntityPaginated, error)

ListIncidentTasks - List tasks for an incident Retrieve a list of all tasks for a specific incident

func (*Tasks) ListTaskLists 

func (s *Tasks) ListTaskLists(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.TaskListEntity, error)

ListTaskLists - List task lists Lists all task lists for your organization

func (*Tasks) UpdateChecklistTemplate 

func (s *Tasks) UpdateChecklistTemplate(ctx context.Context, id string, updateChecklistTemplate components.UpdateChecklistTemplate, opts ...operations.Option) (*components.ChecklistTemplateEntity, error)

UpdateChecklistTemplate - Update a checklist template Update a checklist templates attributes

func (*Tasks) UpdateIncidentTask 

func (s *Tasks) UpdateIncidentTask(ctx context.Context, taskID string, incidentID string, updateIncidentTask components.UpdateIncidentTask, opts ...operations.Option) (*components.TaskEntity, error)

UpdateIncidentTask - Update an incident task Update a task's attributes

func (*Tasks) UpdateTaskList 

func (s *Tasks) UpdateTaskList(ctx context.Context, taskListID string, updateTaskList components.UpdateTaskList, opts ...operations.Option) (*components.TaskListEntity, error)

UpdateTaskList - Update a task list Updates a task list's attributes and task list items

type Teams 

type Teams struct {
	// contains filtered or unexported fields
}

Teams - Operations related to Teams

func (*Teams) CreateTeam 

func (s *Teams) CreateTeam(ctx context.Context, request components.CreateTeam, opts ...operations.Option) (*components.TeamEntity, error)

CreateTeam - Create a team Create a new team

func (*Teams) DeleteTeam 

func (s *Teams) DeleteTeam(ctx context.Context, teamID string, opts ...operations.Option) error

DeleteTeam - Archive a team Archives an team which will hide it from lists and metrics

func (*Teams) GetTeam 

func (s *Teams) GetTeam(ctx context.Context, teamID string, lite *bool, opts ...operations.Option) (*components.TeamEntity, error)

GetTeam - Get a team Retrieve a single team from its ID

func (*Teams) ListSchedules 

func (s *Teams) ListSchedules(ctx context.Context, query *string, page *int, perPage *int, opts ...operations.Option) (*components.ScheduleEntityPaginated, error)

ListSchedules - List schedules List all known schedules in FireHydrant as pulled from external sources

func (*Teams) ListTeams 

func (s *Teams) ListTeams(ctx context.Context, request operations.ListTeamsRequest, opts ...operations.Option) (*components.TeamEntityPaginated, error)

ListTeams - List teams List all of the teams in the organization

func (*Teams) UpdateTeam 

func (s *Teams) UpdateTeam(ctx context.Context, teamID string, updateTeam components.UpdateTeam, opts ...operations.Option) (*components.TeamEntity, error)

UpdateTeam - Update a team Update a single team from its ID

type Ticketing 

type Ticketing struct {
	// contains filtered or unexported fields
}

Ticketing - Operations related to Ticketing

func (*Ticketing) CreateInboundFieldMap 

func (s *Ticketing) CreateInboundFieldMap(ctx context.Context, ticketingProjectID string, opts ...operations.Option) (*components.TicketingProjectInboundFieldMapEntity, error)

CreateInboundFieldMap - Create inbound field map for a ticketing project Creates inbound field map for a ticketing project

func (*Ticketing) CreateTicket 

func (s *Ticketing) CreateTicket(ctx context.Context, request components.CreateTicket, opts ...operations.Option) (*components.TicketingTicketEntity, error)

CreateTicket - Create a ticket Creates a ticket for a project

func (*Ticketing) CreateTicketingFieldMap 

func (s *Ticketing) CreateTicketingFieldMap(ctx context.Context, ticketingProjectID string, opts ...operations.Option) (*components.TicketingProjectFieldMapEntity, error)

CreateTicketingFieldMap - Create a field mapping for a ticketing project Creates field map for a ticketing project

func (*Ticketing) CreateTicketingPriority 

func (s *Ticketing) CreateTicketingPriority(ctx context.Context, request components.CreateTicketingPriority, opts ...operations.Option) (*components.TicketingPriorityEntity, error)

CreateTicketingPriority - Create a ticketing priority Create a single ticketing priority

func (*Ticketing) CreateTicketingProjectConfig 

func (s *Ticketing) CreateTicketingProjectConfig(ctx context.Context, ticketingProjectID string, opts ...operations.Option) (*components.TicketingProjectConfigEntity, error)

CreateTicketingProjectConfig - Create a ticketing project configuration Creates configuration for a ticketing project

func (*Ticketing) DeleteInboundFieldMap 

func (s *Ticketing) DeleteInboundFieldMap(ctx context.Context, mapID string, ticketingProjectID string, opts ...operations.Option) error

DeleteInboundFieldMap - Archive inbound field map for a ticketing project Archive inbound field map for a ticketing project

func (*Ticketing) DeleteTicket 

func (s *Ticketing) DeleteTicket(ctx context.Context, ticketID string, opts ...operations.Option) error

DeleteTicket - Archive a ticket Archive a ticket

func (*Ticketing) DeleteTicketingFieldMap 

func (s *Ticketing) DeleteTicketingFieldMap(ctx context.Context, mapID string, ticketingProjectID string, opts ...operations.Option) error

DeleteTicketingFieldMap - Archive a field map for a ticketing project Archive field map for a ticketing project

func (*Ticketing) DeleteTicketingPriority 

func (s *Ticketing) DeleteTicketingPriority(ctx context.Context, id string, opts ...operations.Option) error

DeleteTicketingPriority - Delete a ticketing priority Delete a single ticketing priority by ID

func (*Ticketing) DeleteTicketingProjectConfig 

func (s *Ticketing) DeleteTicketingProjectConfig(ctx context.Context, ticketingProjectID string, configID string, opts ...operations.Option) error

DeleteTicketingProjectConfig - Archive a ticketing project configuration Archive configuration for a ticketing project

func (*Ticketing) GetConfigurationOptions 

func (s *Ticketing) GetConfigurationOptions(ctx context.Context, ticketingProjectID string, opts ...operations.Option) error

GetConfigurationOptions - List configuration options for a ticketing project List all configuration options for a ticketing project

func (*Ticketing) GetInboundFieldMap 

func (s *Ticketing) GetInboundFieldMap(ctx context.Context, mapID string, ticketingProjectID string, opts ...operations.Option) (*components.TicketingProjectInboundFieldMapEntity, error)

GetInboundFieldMap - Get inbound field map for a ticketing project Retrieve inbound field map for a ticketing project

func (*Ticketing) GetOptionsForField 

func (s *Ticketing) GetOptionsForField(ctx context.Context, fieldID string, ticketingProjectID string, opts ...operations.Option) error

GetOptionsForField - List a field's configuration options for a ticketing project List a field's configuration options for a ticketing project

func (*Ticketing) GetTicket 

func (s *Ticketing) GetTicket(ctx context.Context, ticketID string, opts ...operations.Option) (*components.TicketingTicketEntity, error)

GetTicket - Get a ticket Retrieves a single ticket by ID

func (*Ticketing) GetTicketingFieldMap 

func (s *Ticketing) GetTicketingFieldMap(ctx context.Context, mapID string, ticketingProjectID string, opts ...operations.Option) (*components.TicketingProjectFieldMapEntity, error)

GetTicketingFieldMap - Get a field map for a ticketing project Retrieve field map for a ticketing project

func (*Ticketing) GetTicketingPriority 

func (s *Ticketing) GetTicketingPriority(ctx context.Context, id string, opts ...operations.Option) (*components.TicketingPriorityEntity, error)

GetTicketingPriority - Get a ticketing priority Retrieve a single ticketing priority by ID

func (*Ticketing) GetTicketingProject 

func (s *Ticketing) GetTicketingProject(ctx context.Context, ticketingProjectID string, opts ...operations.Option) (*components.TicketingProjectsProjectListItemEntity, error)

GetTicketingProject - Get a ticketing project Retrieve a single ticketing project by ID

func (*Ticketing) GetTicketingProjectConfig 

func (s *Ticketing) GetTicketingProjectConfig(ctx context.Context, ticketingProjectID string, configID string, opts ...operations.Option) (*components.TicketingProjectConfigEntity, error)

GetTicketingProjectConfig - Get configuration for a ticketing project Retrieve configuration for a ticketing project

func (*Ticketing) ListAvailableInboundFieldMaps 

func (s *Ticketing) ListAvailableInboundFieldMaps(ctx context.Context, ticketingProjectID string, opts ...operations.Option) (*components.TicketingProjectInboundMappableFieldEntity, error)

ListAvailableInboundFieldMaps - List available fields for ticket field mapping Returns metadata for the fields that are available for inbound field mapping.

func (*Ticketing) ListAvailableTicketingFieldMaps 

func (s *Ticketing) ListAvailableTicketingFieldMaps(ctx context.Context, ticketingProjectID string, opts ...operations.Option) (*components.TicketingFieldMapsMappableFieldEntity, error)

ListAvailableTicketingFieldMaps - List available fields for ticket field mapping Returns metadata for the fields that are available for field mapping.

func (*Ticketing) ListInboundFieldMaps 

func (s *Ticketing) ListInboundFieldMaps(ctx context.Context, ticketingProjectID string, page *int, perPage *int, ticketType *operations.TicketType, opts ...operations.Option) (*components.TicketingProjectInboundFieldMapEntity, error)

ListInboundFieldMaps - List inbound field maps for a ticketing project List all inbound field maps for a ticketing project

func (*Ticketing) ListTicketTags 

func (s *Ticketing) ListTicketTags(ctx context.Context, prefix *string, opts ...operations.Option) (*components.TagEntityPaginated, error)

ListTicketTags - List ticket tags List all of the ticket tags in the organization

func (*Ticketing) ListTicketingPriorities 

func (s *Ticketing) ListTicketingPriorities(ctx context.Context, opts ...operations.Option) (*components.TicketingPriorityEntity, error)

ListTicketingPriorities - List ticketing priorities List all ticketing priorities available to the organization

func (*Ticketing) ListTicketingProjects 

func (s *Ticketing) ListTicketingProjects(ctx context.Context, request operations.ListTicketingProjectsRequest, opts ...operations.Option) (*components.TicketingProjectsProjectListItemEntity, error)

ListTicketingProjects - List ticketing projects List all ticketing projects available to the organization

func (*Ticketing) ListTickets 

func (s *Ticketing) ListTickets(ctx context.Context, request operations.ListTicketsRequest, opts ...operations.Option) (*components.TicketingTicketEntity, error)

ListTickets - List tickets List all of the tickets that have been added to the organiation

func (*Ticketing) UpdateInboundFieldMap 

func (s *Ticketing) UpdateInboundFieldMap(ctx context.Context, mapID string, ticketingProjectID string, opts ...operations.Option) (*components.TicketingProjectInboundFieldMapEntity, error)

UpdateInboundFieldMap - Update inbound field map for a ticketing project Update inbound field map for a ticketing project

func (*Ticketing) UpdateTicket 

func (s *Ticketing) UpdateTicket(ctx context.Context, ticketID string, updateTicket components.UpdateTicket, opts ...operations.Option) (*components.TicketingTicketEntity, error)

UpdateTicket - Update a ticket Update a ticket's attributes

func (*Ticketing) UpdateTicketingFieldMap 

func (s *Ticketing) UpdateTicketingFieldMap(ctx context.Context, mapID string, ticketingProjectID string, opts ...operations.Option) (*components.TicketingProjectFieldMapEntity, error)

UpdateTicketingFieldMap - Update a field map for a ticketing project Update field map for a ticketing project

func (*Ticketing) UpdateTicketingPriority 

func (s *Ticketing) UpdateTicketingPriority(ctx context.Context, id string, updateTicketingPriority components.UpdateTicketingPriority, opts ...operations.Option) (*components.TicketingPriorityEntity, error)

UpdateTicketingPriority - Update a ticketing priority Update a single ticketing priority's attributes

func (*Ticketing) UpdateTicketingProjectConfig 

func (s *Ticketing) UpdateTicketingProjectConfig(ctx context.Context, ticketingProjectID string, configID string, opts ...operations.Option) (*components.TicketingProjectConfigEntity, error)

UpdateTicketingProjectConfig - Update configuration for a ticketing project Update configuration for a ticketing project

type Users 

type Users struct {
	// contains filtered or unexported fields
}

Users - Operations related to Users

func (*Users) GetCurrentUser 

func (s *Users) GetCurrentUser(ctx context.Context, opts ...operations.Option) (*components.CurrentUserEntity, error)

GetCurrentUser - Get the currently authenticated user Retrieve the current user

func (*Users) GetUser 

func (s *Users) GetUser(ctx context.Context, id string, opts ...operations.Option) (*components.UserEntity, error)

GetUser - Get a user Retrieve a single user by ID

func (*Users) ListUsers 

func (s *Users) ListUsers(ctx context.Context, page *int, perPage *int, query *string, name *string, opts ...operations.Option) (*components.UserEntityPaginated, error)

ListUsers - List users Retrieve a list of all users in an organization

type Webhooks 

type Webhooks struct {
	// contains filtered or unexported fields
}

Webhooks - Operations related to Webhooks

func (*Webhooks) CreateWebhook 

func (s *Webhooks) CreateWebhook(ctx context.Context, request components.CreateWebhook, opts ...operations.Option) (*components.WebhooksEntitiesWebhookEntity, error)

CreateWebhook - Create a webhook Create a new webhook

func (*Webhooks) DeleteWebhook 

func (s *Webhooks) DeleteWebhook(ctx context.Context, webhookID string, opts ...operations.Option) error

DeleteWebhook - Delete a webhook Delete a specific webhook

func (*Webhooks) GetWebhook 

func (s *Webhooks) GetWebhook(ctx context.Context, webhookID string, opts ...operations.Option) (*components.WebhooksEntitiesWebhookEntity, error)

GetWebhook - Get a webhook Retrieve a specific webhook

func (*Webhooks) ListWebhookDeliveries 

func (s *Webhooks) ListWebhookDeliveries(ctx context.Context, webhookID string, opts ...operations.Option) error

ListWebhookDeliveries - List webhook deliveries Get webhook deliveries

func (*Webhooks) ListWebhooks 

func (s *Webhooks) ListWebhooks(ctx context.Context, page *int, perPage *int, opts ...operations.Option) (*components.WebhooksEntitiesWebhookEntity, error)

ListWebhooks - List webhooks Lists webhooks

func (*Webhooks) UpdateWebhook 

func (s *Webhooks) UpdateWebhook(ctx context.Context, webhookID string, updateWebhook components.UpdateWebhook, opts ...operations.Option) (*components.WebhooksEntitiesWebhookEntity, error)

UpdateWebhook - Update a webhook Update a specific webhook

Source Files

View all Source files

Directories

Path Synopsis
internal
config
hooks
utils
models
components
operations
sdkerrors

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.