Skip to content

Latest commit

 

History

History
909 lines (727 loc) · 48.1 KB

README.md

File metadata and controls

909 lines (727 loc) · 48.1 KB
Raw

Manage incidents from ring to retro

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

Summary

Table of Contents

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/speakeasy-sdks/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"
	"firehydrant"
	"log"
)

func main() {
	s := firehydrant.New(
		firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

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

SDK Example Usage

Example

package main

import (
	"context"
	"firehydrant"
	"log"
)

func main() {
	s := firehydrant.New(
		firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

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

Available Resources and Operations

Available methods

AccountSettings

Alerts

AwsCloudtrailBatchEvents

  • List - List events for an AWS CloudTrail batch

AwsConnections

  • List - List AWS integration connections
  • Get - Get an AWS connection

Changes

ChecklistTemplates

  • Get - Get a checklist template

Communication

Confluence

Conversations

Environments

  • List - List environments
  • Create - Create an environment
  • Get - Get an environment
  • Delete - Archive an environment
  • Update - Update an environment

Functionalities

  • List - List functionalities
  • Create - Create a functionality
  • Get - Get a functionality
  • Delete - Archive a functionality
  • Update - Update a functionality
  • ListServices - List services for a functionality

Incidents

IncidentSettings

Infrastructures

  • List - List catalog entries

Integrations

Integrations.Aws

Integrations.Slack

Integrations.Statuspage

Integrations.Ticketing

Maintenances

  • List - List scheduled maintenance events
  • Create - Create a scheduled maintenance event
  • Delete - Delete a scheduled maintenance event

Metrics

  • GetMttx - Fetch infrastructure metrics based on custom query
  • GetInfrastructure - Get metrics for a specific catalog entry

MetricsReporting

OnCallSchedules

  • Delete - Delete an on-call schedule for a team

ProjectConfigurations

  • Create - Create a ticketing project configuration
  • Get - Get a ticketing project configuration

Retrospectives

Runbooks

Runbooks.Executions

  • Delete - Terminate a runbook execution

Scim

Services

Services.Catalogs

  • Ingest - Ingest service catalog data
  • Refresh - Refresh a service catalog

Signals

Signals.Teams

Slack

Statuspage

StatusPages

StatusUpdateTemplates

  • Create - Create a status update template

System

  • Ping - Check API connectivity

Tasks

Tasks.List

Teams

Ticketing

TicketingPriorities

  • Get - Get a ticketing priority

Tickets

Users

  • GetCurrent - Get the currently authenticated user
  • List - List users
  • Get - Get a user

Webhooks

Zendesk

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"
	"firehydrant"
	"firehydrant/retry"
	"log"
	"models/operations"
)

func main() {
	s := firehydrant.New(
		firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.AccountSettings.GetAiPreferences(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.AIEntitiesPreferencesEntity != 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"
	"firehydrant"
	"firehydrant/retry"
	"log"
)

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

	ctx := context.Background()
	res, err := s.AccountSettings.GetAiPreferences(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.AIEntitiesPreferencesEntity != 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 GetAiPreferences function may return the following errors:

Error Type Status Code Content Type
sdkerrors.BadRequest 400, 413, 414, 415, 422, 431, 510 application/json
sdkerrors.Unauthorized 401, 403, 407, 511 application/json
sdkerrors.NotFound 404, 501, 505 application/json
sdkerrors.Timeout 408, 504 application/json
sdkerrors.RateLimited 429 application/json
sdkerrors.InternalServerError 500, 502, 503, 506, 507, 508 application/json
sdkerrors.SDKError 4XX, 5XX */*

Example

package main

import (
	"context"
	"errors"
	"firehydrant"
	"firehydrant/models/sdkerrors"
	"log"
)

func main() {
	s := firehydrant.New(
		firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.AccountSettings.GetAiPreferences(ctx)
	if err != nil {

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

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

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

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

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

		var e *sdkerrors.InternalServerError
		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 also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	"firehydrant"
	"log"
)

func main() {
	s := firehydrant.New(
		firehydrant.WithServerURL("https://api.firehydrant.io/"),
		firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.AccountSettings.GetAiPreferences(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.AIEntitiesPreferencesEntity != 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/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.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