# SolarWinds Incident Response Developer Docs (formerly Squadcast)

Build, integrate, and automate your incident response workflows with SolarWinds Incident Response APIs, webhooks, and developer tools.

## Introduction

Welcome to the developer hub for [SolarWinds Incident Response](https://www.solarwinds.com/it-incident-response-software). This documentation provides everything you need to programmatically manage incidents, automate on-call rotations, and integrate SolarWinds Incident Response into your SRE and DevOps workflows.

### Overview

SolarWinds Incident Response is an end-to-end incident management platform that unites on-call scheduling, alert routing, incident response, and post-incident analysis. Our developer tools allow you to:

* **Automate Workflows** — Trigger actions and manage incident lifecycles programmatically.
* **Sync Configuration** — Manage Services, Teams, and Escalation Policies as code.
* **Extend Functionality** — Build custom integrations and data exporters using our REST APIs and SDKs.
* **Route Alerts** — Send alerts from any monitoring tool or internal system via webhooks.
* **Infrastructure as Code** — Manage SolarWinds Incident Response configuration with Terraform.

### Quick Navigation

#### Developer Tools

| Section           | Description                                    |
| ----------------- | ---------------------------------------------- |
| **SDKs**          | Official Go, Python, and TypeScript SDK guides |
| **API Reference** | Complete REST API endpoint documentation       |

#### Integrations & Extensibility

| Section                  | Description                                                                     |
| ------------------------ | ------------------------------------------------------------------------------- |
| **Webhooks**             | Incoming and outgoing webhook configuration & payloads                          |
| **Scripts & Automation** | Pre-built scripts for common automation tasks                                   |
| **Terraform**            | Infrastructure as Code with the SolarWinds Incident Response Terraform provider |

### Official SDKs

We provide high-quality, type-safe SDKs to help you get started quickly. These libraries handle authentication, retries, and data serialization out of the box.

| Language       | Package                                                                                                      | Install                                           |
| -------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- |
| **Go**         | [`squadcast-sdk-go`](https://github.com/solarwinds/squadcast-sdk-go)                                         | `go get github.com/SquadcastHub/squadcast-sdk-go` |
| **Python**     | [`squadcast-sdk`](https://pypi.org/project/squadcast-sdk/)                                                   | `pip install squadcast-sdk`                       |
| **TypeScript** | [`@solarwinds/squadcast-sdk-typescript`](https://www.npmjs.com/package/@solarwinds/squadcast-sdk-typescript) | `npm add @solarwinds/squadcast-sdk-typescript`    |

### Authentication

SolarWinds Incident Response uses Bearer Token authentication for all API requests.

1. **Generate Token:** Log in to your Incident Response account and navigate to **Profile → API Tokens** to create a refresh token.
2. **Get Access Token:** Exchange the refresh token for an access token via the auth endpoint.
3. **Authorize Requests:** Include the access token in the `Authorization` header.

```bash
curl --request GET \
     --url https://auth.squadcast.com/oauth/access-token \
     --header 'X-Refresh-Token: YOUR_REFRESH_TOKEN'
```

{% hint style="info" %}
**Security Best Practice:** Avoid hardcoding tokens. All official SDKs support the `SQUADCASTSDK_REFRESH_TOKEN_AUTH` environment variable instead of `SQUADCAST_BEARER_AUTH`.
{% endhint %}

### Support & Community

* [Support Docs](https://support.squadcast.com/)
* **Support** — Reach out to <support@squadcast.com> for assistance.
* **Status Page** — Monitor our availability at [status.squadcast.com](https://status.squadcast.com/).

### License

All official SolarWinds Incident Response SDKs and documentation are licensed under the [MIT License](https://opensource.org/licenses/MIT).


# README

## Incident Response SDK for Go

Developer-friendly & type-safe Go SDK specifically catered to leverage *Incident Response* API.

[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge\&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=squadcast-sdk\&utm_campaign=go) [![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge\&labelColor=eff6ff)](https://opensource.org/licenses/MIT)

### Summary

Squadcast: ## Overview The Squadcast API provides developers the capability to extend and utilize Squadcast in conjunction with other services. Our API has resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

> **Note:** Customers using the V2 version of the Squadcast API would need to migrate to Squadcast API V3, as the former would be deprecated shortly.

#### Service Regions

Squadcast allows customers to choose the geographic region of the Squadcast data centers that host their account. When signing up, you can choose the service region. Currently, the available options are the United States (US) and Europe (EU).

| Service Region | API Endpoints                                                                                |
| -------------- | -------------------------------------------------------------------------------------------- |
| US             | Authentication: <https://auth.squadcast.com> · Other APIs: <https://api.squadcast.com>       |
| EU             | Authentication: <https://auth.eu.squadcast.com> · Other APIs: <https://api.eu.squadcast.com> |

#### Authentication

In order to access the API programmatically, HTTP bearer authentication needs to be used. HTTP bearer authentication must be constructed using an `access_token`, passed as the `Authorization` header for each request, for example `Authorization: Bearer eyJleHAiOjE2MzU1OTE1OTIsImp0aSI6Im`.

Steps to procure the `access_token`:

1. Generate a `refresh_token` (API Token) from the Squadcast web app. More details on how to get the `refresh_token` can be found in the Squadcast support documentation.
2. Call the authentication API with the `refresh_token` to obtain an `access_token`.
3. Use the `access_token` as a Bearer token in the `Authorization` header for all subsequent API requests.

**Example — Generating an Access Token**

```bash
curl --location --request GET 'https://auth.squadcast.com/oauth/access-token' \
--header 'X-Refresh-Token: 0d2a1a9a454dxxxxxxxxxxxx'
```

The API response will look similar to:

```json
{
  "data": {
    "access_token": "eyJhbGciOiJIUxxxxx.xxxxxxxxxxxxxxx.xxxxxxxxxxxxxxx",
    "expires_at": 1587412870,
    "issued_at": 1587240070,
    "refresh_token": "0d2a1a9a454dxxxxxxxxxxxx",
    "type": "bearer"
  }
}
```

#### Access Control

There are three different types of user roles in Squadcast: `account_owner`, `stakeholder`, and `user`. Refresh tokens upon creation are mapped with one of the mentioned user roles, and access to different resources is dependent on the permissions granted to these roles. For more information, please refer to the Squadcast support documentation.

#### Authorization

The access token authorizes users the ability to access different APIs, based on the user roles described above. Pass the access token as a Bearer token in the `Authorization` header of every request.

### Table of Contents

* [Incident Response SDK for Go](#incident-response-sdk-for-go)
  * [SDK Installation](#sdk-installation)
  * [SDK Example Usage](#sdk-example-usage)
  * [Authentication](#authentication)
  * [Available Resources and Operations](#available-resources-and-operations)
  * [Pagination](#pagination)
  * [Retries](#retries)
  * [Error Handling](#error-handling)
  * [Server Selection](#server-selection)
  * [Custom HTTP Client](#custom-http-client)
  * [Special Types](#special-types)
* [Development](#development)
  * [Maturity](#maturity)
  * [Contributions](#contributions)

### SDK Installation

To add the SDK as a dependency to your project:

```bash
go get github.com/solarwinds/squadcast-sdk-go
```

### SDK Example Usage

#### Example

```go
package main

import (
	"context"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"log"
	"os"
)

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

	s := squadcastsdk.New(
		squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
	)

	res, err := s.Analytics.GetOrganization(ctx, "<value>", "<value>", nil, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

```

### Authentication

#### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name               | Type | Scheme      | Environment Variable              |
| ------------------ | ---- | ----------- | --------------------------------- |
| `RefreshTokenAuth` | http | Custom HTTP | `SQUADCASTSDK_REFRESH_TOKEN_AUTH` |

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

```go
package main

import (
	"context"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"log"
	"os"
)

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

	s := squadcastsdk.New(
		squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
	)

	res, err := s.Analytics.GetOrganization(ctx, "<value>", "<value>", nil, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

```

### Available Resources and Operations

<details open>

<summary>Available methods</summary>

#### [Analytics](/go-sdk/docs/sdks/analytics)

* [GetOrganization](/go-sdk/docs/sdks/analytics#getorganization) - Get Org level analytics
* [GetTeam](/go-sdk/docs/sdks/analytics#getteam) - Get Team level analytics

#### [ApiTokens](/go-sdk/docs/sdks/apitokens)

* [List](/go-sdk/docs/sdks/apitokens#list) - Get All Tokens

#### [AuditLogs](/go-sdk/docs/sdks/auditlogs)

* [List](/go-sdk/docs/sdks/auditlogs#list) - List all Audit Logs
* [Export](/go-sdk/docs/sdks/auditlogs#export) - Initiate an asynchronous export of audit logs based on the provided filters. The export file will be generated and available for download. Use 'Get details of Audit Logs export history by ID' API to retrieve the download URL.
* [ListExportHistory](/go-sdk/docs/sdks/auditlogs#listexporthistory) - List all Audit Logs export history
* [GetExportHistoryByID](/go-sdk/docs/sdks/auditlogs#getexporthistorybyid) - Get details of Audit Logs export history by ID
* [GetByID](/go-sdk/docs/sdks/auditlogs#getbyid) - Get audit log by ID

#### [CommunicationCards](/go-sdk/docs/sdks/communicationcards)

* [CreateSlackChannel](/go-sdk/docs/sdks/communicationcards#createslackchannel) - Create Slack Channel in Communication Card
* [ArchiveSlackChannel](/go-sdk/docs/sdks/communicationcards#archiveslackchannel) - Archive Slack Channel

#### [EscalationPolicies](/go-sdk/docs/sdks/escalationpolicies)

* [GetByTeam](/go-sdk/docs/sdks/escalationpolicies#getbyteam) - Get Escalation Policy By team
* [Create](/go-sdk/docs/sdks/escalationpolicies#create) - Create Escalation Policies
* [Remove](/go-sdk/docs/sdks/escalationpolicies#remove) - Remove Escalation Policy
* [GetByID](/go-sdk/docs/sdks/escalationpolicies#getbyid) - Get Escalation Policy By ID
* [Update](/go-sdk/docs/sdks/escalationpolicies#update) - Update Escalation Policy

#### [Exports](/go-sdk/docs/sdks/exports)

* [GetDetails](/go-sdk/docs/sdks/exports#getdetails) - Get Export Details

#### [Extensions.Msteams](/go-sdk/docs/sdks/extensionsmsteams)

* [UpsertConfig](/go-sdk/docs/sdks/extensionsmsteams#upsertconfig) - Create Or Update MSTeams Configuration

#### [Extensions.Webhooks](/go-sdk/docs/sdks/extensionswebhooks)

* [Delete](/go-sdk/docs/sdks/extensionswebhooks#delete) - Delete Webhook
* [GetByID](/go-sdk/docs/sdks/extensionswebhooks#getbyid) - Get Webhook By ID

#### [GlobalEventRules](/go-sdk/docs/sdks/globaleventrules)

* [List](/go-sdk/docs/sdks/globaleventrules#list) - List Global Event Rules
* [Create](/go-sdk/docs/sdks/globaleventrules#create) - Create Global Event Rule
* [DeleteRule](/go-sdk/docs/sdks/globaleventrules#deleterule) - Delete Global Event Rule by ID
* [GetByID](/go-sdk/docs/sdks/globaleventrules#getbyid) - Get Global Event Rule by ID
* [UpdateByID](/go-sdk/docs/sdks/globaleventrules#updatebyid) - Update Global Event Rule by ID
* [GetRuleset](/go-sdk/docs/sdks/globaleventrules#getruleset) - Get Ruleset
* [UpdateRuleset](/go-sdk/docs/sdks/globaleventrules#updateruleset) - Update Ruleset
* [UpdateRule](/go-sdk/docs/sdks/globaleventrules#updaterule) - Update Rule by ID

[**GlobalEventRules.Rules**](/go-sdk/docs/sdks/rules)

* [ReorderByIndex](/go-sdk/docs/sdks/rules#reorderbyindex) - Reorder Ruleset By Index

[**GlobalEventRules.Rulesets**](/go-sdk/docs/sdks/rulesets)

* [Create](/go-sdk/docs/sdks/rulesets#create) - Create Ruleset
* [Reorder](/go-sdk/docs/sdks/rulesets#reorder) - Reorder Ruleset
* [ListRulesetRules](/go-sdk/docs/sdks/rulesets#listrulesetrules) - List Ruleset Rules

[**GlobalEventRules.Rulesets.Rules**](/go-sdk/docs/sdks/rulesetsrules)

* [Create](/go-sdk/docs/sdks/rulesetsrules#create) - Create Rule
* [GetByID](/go-sdk/docs/sdks/rulesetsrules#getbyid) - Get Rule by ID

#### [GlobalEventRulesRulesets](/go-sdk/docs/sdks/globaleventrulesrulesets)

* [Delete](/go-sdk/docs/sdks/globaleventrulesrulesets#delete) - Delete GER Ruleset

#### [GlobalEventRulesRulesetsRules](/go-sdk/docs/sdks/globaleventrulesrulesetsrules)

* [DeleteByID](/go-sdk/docs/sdks/globaleventrulesrulesetsrules#deletebyid) - Delete Rule by ID

#### [GlobalOncallReminderRules](/go-sdk/docs/sdks/globaloncallreminderrules)

* [Delete](/go-sdk/docs/sdks/globaloncallreminderrules#delete) - Delete Global Oncall Reminder Rules
* [List](/go-sdk/docs/sdks/globaloncallreminderrules#list) - Get Global Oncall Reminder Rules
* [Create](/go-sdk/docs/sdks/globaloncallreminderrules#create) - Create Global Oncall Reminder Rules
* [Update](/go-sdk/docs/sdks/globaloncallreminderrules#update) - Update Global Oncall Reminder Rules

#### [IncidentActions.Circleci](/go-sdk/docs/sdks/circleci)

* [Rebuild](/go-sdk/docs/sdks/circleci#rebuild) - Rebuild a Project In CircleCI

#### [Incidents](/go-sdk/docs/sdks/incidents)

* [BulkAcknowledge](/go-sdk/docs/sdks/incidents#bulkacknowledge) - Bulk Acknowledge Incidents
* [Export](/go-sdk/docs/sdks/incidents#export) - Incident Export
* [ExportAsync](/go-sdk/docs/sdks/incidents#exportasync) - Incident Export Async
* [Merge](/go-sdk/docs/sdks/incidents#merge) - Merge Incidents
* [BulkUpdatePriority](/go-sdk/docs/sdks/incidents#bulkupdatepriority) - Bulk Incidents Priority Update
* [BulkResolve](/go-sdk/docs/sdks/incidents#bulkresolve) - Bulk Resolve Incidents
* [GetByID](/go-sdk/docs/sdks/incidents#getbyid) - Get Incident by ID
* [Acknowledge](/go-sdk/docs/sdks/incidents#acknowledge) - Acknowledge Incident
* [MarkSloFalsePositive](/go-sdk/docs/sdks/incidents#markslofalsepositive) - Mark Incident SLO False Positive
* [UpdatePriority](/go-sdk/docs/sdks/incidents#updatepriority) - Incident Priority Update
* [Reassign](/go-sdk/docs/sdks/incidents#reassign) - Reassign Incident
* [Resolve](/go-sdk/docs/sdks/incidents#resolve) - Resolve Incident
* [Unmerge](/go-sdk/docs/sdks/incidents#unmerge) - Unmerge Incident
* [GetStatusByRequestIds](/go-sdk/docs/sdks/incidents#getstatusbyrequestids) - Get Incidents Status By RequestIDs
* [GetAllPostmortems](/go-sdk/docs/sdks/incidents#getallpostmortems) - Get All Postmortems
* [MarkAsTransient](/go-sdk/docs/sdks/incidents#markastransient) - Mark as Transient
* [UpdatePostmortem](/go-sdk/docs/sdks/incidents#updatepostmortem) - Update Postmortem By Incident
* [UnsnoozeNotifications](/go-sdk/docs/sdks/incidents#unsnoozenotifications) - Unsnooze Incident Notifications

#### [Incidents.Actions](/go-sdk/docs/sdks/incidentsactions)

* [CreateJiraCloudTicket](/go-sdk/docs/sdks/incidentsactions#createjiracloudticket) - Create a Ticket on Jira Cloud
* [CreateJiraServerTicket](/go-sdk/docs/sdks/incidentsactions#createjiraserverticket) - Create a Ticket on Jira Server
* [CreateInServicenow](/go-sdk/docs/sdks/incidentsactions#createinservicenow) - Create an Incident in ServiceNow

[**Incidents.Actions.Webhook**](/go-sdk/docs/sdks/webhook)

* [TriggerManually](/go-sdk/docs/sdks/webhook#triggermanually) - Trigger a Webhook Manually

#### [Incidents.AdditionalResponders](/go-sdk/docs/sdks/additionalresponders)

* [Get](/go-sdk/docs/sdks/additionalresponders#get) - Get Additional Responders
* [Add](/go-sdk/docs/sdks/additionalresponders#add) - Add Additional Responders
* [Delete](/go-sdk/docs/sdks/additionalresponders#delete) - Remove Additional Responders

#### [Incidents.AutoPauseTransientAlerts](/go-sdk/docs/sdks/autopausetransientalerts)

* [MarkAsNotTransient](/go-sdk/docs/sdks/autopausetransientalerts#markasnottransient) - Mark as Not Transient

#### [Incidents.CommunicationCard](/go-sdk/docs/sdks/communicationcard)

* [Update](/go-sdk/docs/sdks/communicationcard#update) - Update Communication Card

#### [Incidents.CommunicationCards](/go-sdk/docs/sdks/incidentscommunicationcards)

* [GetAll](/go-sdk/docs/sdks/incidentscommunicationcards#getall) - Get All Communication Card
* [Create](/go-sdk/docs/sdks/incidentscommunicationcards#create) - Create Communication Card
* [Delete](/go-sdk/docs/sdks/incidentscommunicationcards#delete) - Delete Communication Card

#### [Incidents.Events](/go-sdk/docs/sdks/events)

* [List](/go-sdk/docs/sdks/events#list) - Get Incident Events

#### [Incidents.Notes](/go-sdk/docs/sdks/incidentsnotes)

* [Create](/go-sdk/docs/sdks/incidentsnotes#create) - Create Notes
* [Delete](/go-sdk/docs/sdks/incidentsnotes#delete) - Delete Note
* [Update](/go-sdk/docs/sdks/incidentsnotes#update) - Update Note

#### [Incidents.Postmortems](/go-sdk/docs/sdks/postmortems)

* [DeleteByIncident](/go-sdk/docs/sdks/postmortems#deletebyincident) - Delete Postmortem By Incident
* [GetByIncident](/go-sdk/docs/sdks/postmortems#getbyincident) - Get Postmortem By Incident
* [Create](/go-sdk/docs/sdks/postmortems#create) - Create Postmortem

#### [Incidents.Runbooks](/go-sdk/docs/sdks/incidentsrunbooks)

* [Attach](/go-sdk/docs/sdks/incidentsrunbooks#attach) - Attach Runbooks

#### [Incidents.SnoozeNotifications](/go-sdk/docs/sdks/snoozenotifications)

* [Snooze](/go-sdk/docs/sdks/snoozenotifications#snooze) - Snooze Incident Notifications

#### [Incidents.Tags](/go-sdk/docs/sdks/tags)

* [Update](/go-sdk/docs/sdks/tags#update) - Update Tag
* [Append](/go-sdk/docs/sdks/tags#append) - Append Tag

#### [Msteams](/go-sdk/docs/sdks/msteams)

* [GetConfig](/go-sdk/docs/sdks/msteams#getconfig) - Get MSTeams Config

#### [Notes](/go-sdk/docs/sdks/notes)

* [List](/go-sdk/docs/sdks/notes#list) - Get All Notes

#### [Overlays](/go-sdk/docs/sdks/overlays)

* [DeleteNotificationTemplate](/go-sdk/docs/sdks/overlays#deletenotificationtemplate) - Delete Notification Template Overlay

#### [Overrides](/go-sdk/docs/sdks/overrides)

* [GetByID](/go-sdk/docs/sdks/overrides#getbyid) - Get Override by ID
* [Update](/go-sdk/docs/sdks/overrides#update) - Update Schedule Override

#### [Rotations](/go-sdk/docs/sdks/rotations)

* [Create](/go-sdk/docs/sdks/rotations#create) - Create Rotation
* [GetByID](/go-sdk/docs/sdks/rotations#getbyid) - Get Schedule Rotation by ID
* [Update](/go-sdk/docs/sdks/rotations#update) - Update Rotation
* [GetParticipants](/go-sdk/docs/sdks/rotations#getparticipants) - Get Rotation Participants
* [UpdateParticipants](/go-sdk/docs/sdks/rotations#updateparticipants) - Update Rotation Participants

#### [Runbooks](/go-sdk/docs/sdks/runbooks)

* [ListByTeam](/go-sdk/docs/sdks/runbooks#listbyteam) - Get All Runbooks By Team
* [Create](/go-sdk/docs/sdks/runbooks#create) - Create Runbook
* [Remove](/go-sdk/docs/sdks/runbooks#remove) - Remove Runbook
* [GetByID](/go-sdk/docs/sdks/runbooks#getbyid) - Get Runbook By ID
* [Update](/go-sdk/docs/sdks/runbooks#update) - Update Runbook

#### [Schedules](/go-sdk/docs/sdks/schedules)

* [List](/go-sdk/docs/sdks/schedules#list) - List Schedules
* [Create](/go-sdk/docs/sdks/schedules#create) - Create Schedule
* [Delete](/go-sdk/docs/sdks/schedules#delete) - Delete Schedule
* [GetByID](/go-sdk/docs/sdks/schedules#getbyid) - Get Schedule by ID
* [Update](/go-sdk/docs/sdks/schedules#update) - Update Schedule
* [PauseResume](/go-sdk/docs/sdks/schedules#pauseresume) - Pause/Resume Schedule
* [ChangeTimezone](/go-sdk/docs/sdks/schedules#changetimezone) - Change Timezone
* [Clone](/go-sdk/docs/sdks/schedules#clone) - Clone Schedule
* [GetIcalLink](/go-sdk/docs/sdks/schedules#geticallink) - Get Schedule ICal Link
* [RefreshIcalLink](/go-sdk/docs/sdks/schedules#refreshicallink) - Refresh Schedule ICal Link
* [CreateIcalLink](/go-sdk/docs/sdks/schedules#createicallink) - Create Schedule ICal Link
* [CreateScheduleOverride](/go-sdk/docs/sdks/schedules#createscheduleoverride) - Create Schedule Override
* [DeleteRotation](/go-sdk/docs/sdks/schedules#deleterotation) - Delete Rotation

[**Schedules.Export**](/go-sdk/docs/sdks/export)

* [DeleteIcalLink](/go-sdk/docs/sdks/export#deleteicallink) - Delete ICal Link

[**Schedules.Overrides**](/go-sdk/docs/sdks/schedulesoverrides)

* [List](/go-sdk/docs/sdks/schedulesoverrides#list) - List Overrides
* [Delete](/go-sdk/docs/sdks/schedulesoverrides#delete) - Delete Schedule Override

[**Schedules.Rotations**](/go-sdk/docs/sdks/schedulesrotations)

* [List](/go-sdk/docs/sdks/schedulesrotations#list) - List Schedule Rotations

#### [Services](/go-sdk/docs/sdks/services)

* [List](/go-sdk/docs/sdks/services#list) - Get All Services
* [Create](/go-sdk/docs/sdks/services#create) - Create Service
* [GetByName](/go-sdk/docs/sdks/services#getbyname) - Get Services By Name
* [GetByID](/go-sdk/docs/sdks/services#getbyid) - Get Service By ID
* [Update](/go-sdk/docs/sdks/services#update) - Update Service
* [Delete](/go-sdk/docs/sdks/services#delete) - Delete Service
* [CreateOrUpdateAptaConfig](/go-sdk/docs/sdks/services#createorupdateaptaconfig) - Auto Pause Transient Alerts (APTA)
* [UpsertIagConfig](/go-sdk/docs/sdks/services#upsertiagconfig) - Intelligent Alert Grouping (IAG)
* [UpdateNotificationDelayConfig](/go-sdk/docs/sdks/services#updatenotificationdelayconfig) - Delayed Notification Config
* [CreateOrUpdateDependencies](/go-sdk/docs/sdks/services#createorupdatedependencies) - Create or Update Dependencies
* [CreateOrUpdateNotificationTemplateOverlay](/go-sdk/docs/sdks/services#createorupdatenotificationtemplateoverlay) - Create or Update Notification Template Overlay
* [GetAllDedupKeyOverlays](/go-sdk/docs/sdks/services#getalldedupkeyoverlays) - Get All Dedup Key Overlay by Service
* [UpdateDedupKeyOverlay](/go-sdk/docs/sdks/services#updatededupkeyoverlay) - Update Dedup Key Overlay
* [GetRoutingRules](/go-sdk/docs/sdks/services#getroutingrules) - Get Routing Rules
* [CreateOrUpdateSuppressionRules](/go-sdk/docs/sdks/services#createorupdatesuppressionrules) - Create or Update Suppression Rules
* [CreateOrUpdateTaggingRules](/go-sdk/docs/sdks/services#createorupdatetaggingrules) - Create or Update Tagging Rules

#### [Services.DeduplicationRules](/go-sdk/docs/sdks/deduplicationrules)

* [Get](/go-sdk/docs/sdks/deduplicationrules#get) - Get Deduplication Rules
* [CreateOrUpdate](/go-sdk/docs/sdks/deduplicationrules#createorupdate) - Create or Update Deduplication Rules

#### [Services.Extensions](/go-sdk/docs/sdks/servicesextensions)

* [UpdateSlack](/go-sdk/docs/sdks/servicesextensions#updateslack) - Update Slack Extension

#### [Services.MaintenanceMode](/go-sdk/docs/sdks/maintenancemode)

* [Get](/go-sdk/docs/sdks/maintenancemode#get) - Get Maintenance Mode
* [CreateOrUpdate](/go-sdk/docs/sdks/maintenancemode#createorupdate) - Create or Update Maintenance Mode

#### [Services.Overlay](/go-sdk/docs/sdks/overlay)

* [GetKeyBasedDeduplicationOptin](/go-sdk/docs/sdks/overlay#getkeybaseddeduplicationoptin) - Get Opt-in for Key Based Deduplication for a service
* [OptInForKeyBasedDeduplication](/go-sdk/docs/sdks/overlay#optinforkeybaseddeduplication) - Opt-in for Key Based Deduplication for a service

#### [Services.Overlays](/go-sdk/docs/sdks/servicesoverlays)

* [GetCustomContentTemplates](/go-sdk/docs/sdks/servicesoverlays#getcustomcontenttemplates) - Get All Custom Content Template Overlay by Service
* [GetCustomContent](/go-sdk/docs/sdks/servicesoverlays#getcustomcontent) - Get Custom Content Template Overlay
* [GetDedupKey](/go-sdk/docs/sdks/servicesoverlays#getdedupkey) - Get Dedup Key Overlay for Alert Source

[**Services.Overlays.CustomContent**](/go-sdk/docs/sdks/customcontent)

* [Render](/go-sdk/docs/sdks/customcontent#render) - Render Custom Content Overlay

[**Services.Overlays.DedupKey**](/go-sdk/docs/sdks/dedupkey)

* [Render](/go-sdk/docs/sdks/dedupkey#render) - Render Dedup Key template
* [Delete](/go-sdk/docs/sdks/dedupkey#delete) - Delete Dedup Key Overlay

#### [Services.RoutingRules](/go-sdk/docs/sdks/routingrules)

* [CreateOrUpdate](/go-sdk/docs/sdks/routingrules#createorupdate) - Create or Update Routing Rules

#### [Services.SuppressionRules](/go-sdk/docs/sdks/suppressionrules)

* [Get](/go-sdk/docs/sdks/suppressionrules#get) - Get Suppression Rules

#### [Services.TaggingRules](/go-sdk/docs/sdks/taggingrules)

* [Get](/go-sdk/docs/sdks/taggingrules#get) - Get Tagging Rules

#### [Slos](/go-sdk/docs/sdks/slos)

* [ListAll](/go-sdk/docs/sdks/slos#listall) - Get All SLOs
* [Create](/go-sdk/docs/sdks/slos#create) - Create SLO
* [Update](/go-sdk/docs/sdks/slos#update) - Update SLO
* [Remove](/go-sdk/docs/sdks/slos#remove) - Remove SLO
* [GetByID](/go-sdk/docs/sdks/slos#getbyid) - Get SLO By ID
* [MarkAffected](/go-sdk/docs/sdks/slos#markaffected) - Mark SLO Affected
* [MarkFalsePositive](/go-sdk/docs/sdks/slos#markfalsepositive) - Mark SLO False Positive

#### [Squads](/go-sdk/docs/sdks/squads)

* [List](/go-sdk/docs/sdks/squads#list) - Get All Squads
* [RemoveMember](/go-sdk/docs/sdks/squads#removemember) - Remove Squad Member
* [UpdateMemberRole](/go-sdk/docs/sdks/squads#updatememberrole) - Update Squad Member
* [UpdateName](/go-sdk/docs/sdks/squads#updatename) - Update Squad Name
* [Delete](/go-sdk/docs/sdks/squads#delete) - Delete Squad

[**Squads.V4**](/go-sdk/docs/sdks/squadsv4)

* [Create](/go-sdk/docs/sdks/squadsv4#create) - Create Squad
* [GetByID](/go-sdk/docs/sdks/squadsv4#getbyid) - Get Squad By ID

#### [StatusPages](/go-sdk/docs/sdks/statuspages)

* [List](/go-sdk/docs/sdks/statuspages#list) - List Status Pages
* [Create](/go-sdk/docs/sdks/statuspages#create) - Create Status Page
* [DeleteByID](/go-sdk/docs/sdks/statuspages#deletebyid) - Delete Status Page By ID
* [GetByID](/go-sdk/docs/sdks/statuspages#getbyid) - Get Status Page By ID
* [UpdateByID](/go-sdk/docs/sdks/statuspages#updatebyid) - Update Status Page By ID
* [CreateIssue](/go-sdk/docs/sdks/statuspages#createissue) - Create Issue
* [UpdateIssue](/go-sdk/docs/sdks/statuspages#updateissue) - Update Issue
* [ListMaintenances](/go-sdk/docs/sdks/statuspages#listmaintenances) - List Maintenances
* [GetMaintenanceByID](/go-sdk/docs/sdks/statuspages#getmaintenancebyid) - Get Maintenance By ID
* [GetStatuses](/go-sdk/docs/sdks/statuspages#getstatuses) - List Status Page Statuses

[**StatusPages.ComponentGroups**](/go-sdk/docs/sdks/componentgroups)

* [List](/go-sdk/docs/sdks/componentgroups#list) - List Component Groups
* [Create](/go-sdk/docs/sdks/componentgroups#create) - Create Component Group
* [DeleteByID](/go-sdk/docs/sdks/componentgroups#deletebyid) - Delete Component Group By ID
* [GetByID](/go-sdk/docs/sdks/componentgroups#getbyid) - Get Component Group By ID

[**StatusPages.Components**](/go-sdk/docs/sdks/components)

* [List](/go-sdk/docs/sdks/components#list) - List Components
* [Create](/go-sdk/docs/sdks/components#create) - Create Component
* [DeleteByID](/go-sdk/docs/sdks/components#deletebyid) - Delete Component By ID
* [GetByID](/go-sdk/docs/sdks/components#getbyid) - Get Component By ID
* [UpdateByID](/go-sdk/docs/sdks/components#updatebyid) - Update Component By ID

[**StatusPages.Issues**](/go-sdk/docs/sdks/issues)

* [List](/go-sdk/docs/sdks/issues#list) - List Issues
* [Delete](/go-sdk/docs/sdks/issues#delete) - Delete Issue By ID
* [GetByID](/go-sdk/docs/sdks/issues#getbyid) - Get Issue By ID
* [ListStates](/go-sdk/docs/sdks/issues#liststates) - List Status Page Issue States

[**StatusPages.Maintenances**](/go-sdk/docs/sdks/maintenances)

* [Create](/go-sdk/docs/sdks/maintenances#create) - Create Maintenance
* [DeleteByID](/go-sdk/docs/sdks/maintenances#deletebyid) - Delete Maintenance By ID
* [UpdateByID](/go-sdk/docs/sdks/maintenances#updatebyid) - Update Maintenance By ID

[**StatusPages.Subscribers**](/go-sdk/docs/sdks/subscribers)

* [List](/go-sdk/docs/sdks/subscribers#list) - List Subscribers
* [DeleteByID](/go-sdk/docs/sdks/subscribers#deletebyid) - Delete Subscriber By ID

#### [Teams](/go-sdk/docs/sdks/teams)

* [GetAll](/go-sdk/docs/sdks/teams#getall) - Get All Teams
* [Create](/go-sdk/docs/sdks/teams#create) - Create Team
* [GetByID](/go-sdk/docs/sdks/teams#getbyid) - Get Team By ID
* [Update](/go-sdk/docs/sdks/teams#update) - Update Team
* [Delete](/go-sdk/docs/sdks/teams#delete) - Remove Team
* [AddMember](/go-sdk/docs/sdks/teams#addmember) - Add Team Member
* [AddBulkMember](/go-sdk/docs/sdks/teams#addbulkmember) - Add Bulk Team Member
* [RemoveMember](/go-sdk/docs/sdks/teams#removemember) - Remove Team Member
* [UpdateMember](/go-sdk/docs/sdks/teams#updatemember) - Update Team Member
* [GetAllRoles](/go-sdk/docs/sdks/teams#getallroles) - Get All Team Roles
* [CreateRole](/go-sdk/docs/sdks/teams#createrole) - Create Team Role
* [RemoveRole](/go-sdk/docs/sdks/teams#removerole) - Remove Team Role
* [UpdateRole](/go-sdk/docs/sdks/teams#updaterole) - Update Team Role

#### [Teams.Members](/go-sdk/docs/sdks/members)

* [GetAll](/go-sdk/docs/sdks/members#getall) - Get All Team Members

#### [Tokens](/go-sdk/docs/sdks/tokens)

* [CreateUserToken](/go-sdk/docs/sdks/tokens#createusertoken) - Create Token

#### [Users](/go-sdk/docs/sdks/users)

* [GetAll](/go-sdk/docs/sdks/users#getall) - Get All Users
* [Add](/go-sdk/docs/sdks/users#add) - Add User
* [UpdateOrgLevelPermissions](/go-sdk/docs/sdks/users#updateorglevelpermissions) - Update Org Level Permissions
* [Delete](/go-sdk/docs/sdks/users#delete) - Delete User
* [GetRoles](/go-sdk/docs/sdks/users#getroles) - Get User Roles
* [RemoveFromOrg](/go-sdk/docs/sdks/users#removefromorg) - Remove User From Org
* [GetByID](/go-sdk/docs/sdks/users#getbyid) - Get User By ID
* [Update](/go-sdk/docs/sdks/users#update) - Update User by userID

[**Users.ApiToken**](/go-sdk/docs/sdks/apitoken)

* [Remove](/go-sdk/docs/sdks/apitoken#remove) - Remove Token

#### [V4.Squads](/go-sdk/docs/sdks/v4squads)

* [Update](/go-sdk/docs/sdks/v4squads#update) - Update Squad

#### [Webforms](/go-sdk/docs/sdks/webforms)

* [GetAll](/go-sdk/docs/sdks/webforms#getall) - Get All Webforms
* [Create](/go-sdk/docs/sdks/webforms#create) - Create Webform
* [Update](/go-sdk/docs/sdks/webforms#update) - Update Webform
* [Remove](/go-sdk/docs/sdks/webforms#remove) - Remove Webform
* [Get](/go-sdk/docs/sdks/webforms#get) - Get Webform By ID

#### [Webhooks](/go-sdk/docs/sdks/webhooks)

* [GetAll](/go-sdk/docs/sdks/webhooks#getall) - Get All Webhooks
* [Create](/go-sdk/docs/sdks/webhooks#create) - Create Webhook
* [Update](/go-sdk/docs/sdks/webhooks#update) - Update Webhook

#### [Workflows](/go-sdk/docs/sdks/workflows)

* [List](/go-sdk/docs/sdks/workflows#list) - List Workflows
* [Create](/go-sdk/docs/sdks/workflows#create) - Create Workflow
* [BulkEnableDisable](/go-sdk/docs/sdks/workflows#bulkenabledisable) - Bulk Enable/Disable Workflows
* [Delete](/go-sdk/docs/sdks/workflows#delete) - Delete Workflow
* [GetByID](/go-sdk/docs/sdks/workflows#getbyid) - Get Workflow By ID
* [Update](/go-sdk/docs/sdks/workflows#update) - Update Workflow
* [UpdateActionsOrder](/go-sdk/docs/sdks/workflows#updateactionsorder) - Update Actions Order
* [DeleteAction](/go-sdk/docs/sdks/workflows#deleteaction) - Delete Workflow Action
* [GetAction](/go-sdk/docs/sdks/workflows#getaction) - Get Workflow Action By ID
* [UpdateAction](/go-sdk/docs/sdks/workflows#updateaction) - Update Workflow Action
* [ToggleEnable](/go-sdk/docs/sdks/workflows#toggleenable) - Enable/Disable Workflow
* [GetLogs](/go-sdk/docs/sdks/workflows#getlogs) - Get Workflow Logs

#### [Workflows.Actions](/go-sdk/docs/sdks/workflowsactions)

* [Create](/go-sdk/docs/sdks/workflowsactions#create) - Create Action

</details>

### Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a `Next` method that can be called to pull down the next group of results. If the return value of `Next` is `nil`, then there are no more pages to be fetched.

Here's an example of one such pagination call:

```go
package main

import (
	"context"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/squadcast-sdk-go/models/operations"
	"github.com/solarwinds/squadcast-sdk-go/types"
	"log"
	"os"
)

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

	s := squadcastsdk.New(
		squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
	)

	res, err := s.AuditLogs.List(ctx, operations.AuditLogsListAuditLogsRequest{
		PageSize:   832442,
		PageNumber: 555332,
		StartDate:  types.MustDateFromString("2023-03-04"),
		EndDate:    types.MustDateFromString("2024-08-07"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.V3AuditLogsListAuditLogsResponse != nil {
		for {
			// handle items

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}
	}
}

```

### 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:

```go
package main

import (
	"context"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/squadcast-sdk-go/retry"
	"log"
	"models/operations"
	"os"
)

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

	s := squadcastsdk.New(
		squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
	)

	res, err := s.Analytics.GetOrganization(ctx, "<value>", "<value>", nil, nil, 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.Object != 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:

```go
package main

import (
	"context"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/squadcast-sdk-go/retry"
	"log"
	"os"
)

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

	s := squadcastsdk.New(
		squadcastsdk.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
	)

	res, err := s.Analytics.GetOrganization(ctx, "<value>", "<value>", nil, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != 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 `apierrors.APIError`. 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 `GetOrganization` function may return the following errors:

| Error Type                         | Status Code | Content Type     |
| ---------------------------------- | ----------- | ---------------- |
| apierrors.BadRequestError          | 400         | application/json |
| apierrors.UnauthorizedError        | 401         | application/json |
| apierrors.PaymentRequiredError     | 402         | application/json |
| apierrors.ForbiddenError           | 403         | application/json |
| apierrors.NotFoundError            | 404         | application/json |
| apierrors.ConflictError            | 409         | application/json |
| apierrors.UnprocessableEntityError | 422         | application/json |
| apierrors.InternalServerError      | 500         | application/json |
| apierrors.BadGatewayError          | 502         | application/json |
| apierrors.ServiceUnavailableError  | 503         | application/json |
| apierrors.GatewayTimeoutError      | 504         | application/json |
| apierrors.APIError                 | 4XX, 5XX    | \*/\*            |

#### Example

```go
package main

import (
	"context"
	"errors"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/squadcast-sdk-go/models/apierrors"
	"log"
	"os"
)

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

	s := squadcastsdk.New(
		squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
	)

	res, err := s.Analytics.GetOrganization(ctx, "<value>", "<value>", nil, nil)
	if err != nil {

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

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

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

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

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

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

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

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

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

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

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

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

```

### Server Selection

#### Select Server by Index

You can override the default server globally using the `WithServerIndex(serverIndex int)` option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server                         | Description       |
| - | ------------------------------ | ----------------- |
| 0 | `https://api.squadcast.com`    | production US env |
| 1 | `https://api.eu.squadcast.com` | production EU env |

**Example**

```go
package main

import (
	"context"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"log"
	"os"
)

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

	s := squadcastsdk.New(
		squadcastsdk.WithServerIndex(0),
		squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
	)

	res, err := s.Analytics.GetOrganization(ctx, "<value>", "<value>", nil, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

```

#### 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:

```go
package main

import (
	"context"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"log"
	"os"
)

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

	s := squadcastsdk.New(
		squadcastsdk.WithServerURL("https://api.eu.squadcast.com"),
		squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
	)

	res, err := s.Analytics.GetOrganization(ctx, "<value>", "<value>", nil, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != 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:

```go
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.

```go
import (
	"net/http"
	"time"

	"github.com/solarwinds/squadcast-sdk-go"
)

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

```go
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](https://www.speakeasy.com/?utm_source=squadcast-sdk\&utm_campaign=go)


# Contributing to This Repository

Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.

## How to Report Issues

If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:

* A clear and descriptive title
* Steps to reproduce the issue
* Expected and actual behavior
* Any relevant logs, screenshots, or error messages
* Information about your environment (e.g., operating system, software versions)
  * For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed

## Issue Triage and Upstream Fixes

We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.

## Contact

If you have any questions or need further assistance, please feel free to reach out by opening an issue.

Thank you for your understanding and cooperation!

The Maintainers


# RELEASES

### 2025-10-24 11:22:19

#### Changes

Based on:

* OpenAPI Doc
* Speakeasy CLI 1.639.2 (2.730.5) <https://github.com/speakeasy-api/speakeasy>

#### Generated

* \[go v1.3.4] .

#### Releases

* \[Go v1.3.4] <https://github.com/SquadcastHub/squadcast-sdk-go/releases/tag/v1.3.4> - .

### 2025-11-12 00:29:04

#### Changes

Based on:

* OpenAPI Doc
* Speakeasy CLI 1.653.2 (2.748.4) <https://github.com/speakeasy-api/speakeasy>

#### Generated

* \[go v1.4.1] .

#### Releases

* \[Go v1.4.1] <https://github.com/solarwinds/squadcast-sdk-go/releases/tag/v1.4.1> - .

### 2025-12-13 00:29:12

#### Changes

Based on:

* OpenAPI Doc
* Speakeasy CLI 1.676.1 (2.781.2) <https://github.com/speakeasy-api/speakeasy>

#### Generated

* \[go v1.5.0] .

#### Releases

* \[Go v1.5.0] <https://github.com/solarwinds/squadcast-sdk-go/releases/tag/v1.5.0> - .

### 2026-02-26 00:36:43

#### Changes

Based on:

* OpenAPI Doc
* Speakeasy CLI 1.730.1 (2.844.3) <https://github.com/speakeasy-api/speakeasy>

#### Generated

* \[go v1.5.1] .

#### Releases

* \[Go v1.5.1] <https://github.com/solarwinds/squadcast-sdk-go/releases/tag/v1.5.1> - .

### 2026-03-14 00:36:33

#### Changes

Based on:

* OpenAPI Doc
* Speakeasy CLI 1.755.0 (2.865.2) <https://github.com/speakeasy-api/speakeasy>

#### Generated

* \[go v1.6.0] .

#### Releases

* \[Go v1.6.0] <https://github.com/solarwinds/squadcast-sdk-go/releases/tag/v1.6.0> - .

### 2026-03-23 10:48:28

#### Changes

Based on:

* OpenAPI Doc
* Speakeasy CLI 1.759.1 (2.869.10) <https://github.com/speakeasy-api/speakeasy>

#### Generated

* \[go v1.7.1] .

#### Releases

* \[Go v1.7.1] <https://github.com/solarwinds/squadcast-sdk-go/releases/tag/v1.7.1> - .

### 2026-08-06 05:00:26

#### Changes

Based on:

* OpenAPI Doc
* Speakeasy CLI 1.791.4 (2.926.8) <https://github.com/speakeasy-api/speakeasy>

#### Generated

* \[go v1.7.2] .

#### Releases

* \[Go v1.7.2] <https://github.com/solarwinds/squadcast-sdk-go/releases/tag/v1.7.2> - .


# USAGE

```go
package main

import (
	"context"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"log"
	"os"
)

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

	s := squadcastsdk.New(
		squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
	)

	res, err := s.Analytics.GetOrganization(ctx, "<value>", "<value>", nil, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

```


# .devcontainer

[![](https://github.com/codespaces/badge.svg)](https://codespaces.new/solarwinds/squadcast-sdk-go.git/tree/main)<br>

> **Remember to shutdown a GitHub Codespace when it is not in use!**

## Dev Containers Quick Start

The default location for usage snippets is the `samples` directory.

### Running a Usage Sample

A sample usage example has been provided in a `root.go` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.

```
go run root.go
```

### Generating Additional Usage Samples

The speakeasy CLI allows you to generate more usage snippets. Here's how:

* To generate a sample for a specific operation by providing an operation ID, use:

```
speakeasy generate usage -s .speakeasy/out.openapi.yaml -l go -i {INPUT_OPERATION_ID} -o ./samples
```

* To generate samples for an entire namespace (like a tag or group name), use:

```
speakeasy generate usage -s .speakeasy/out.openapi.yaml -l go -n {INPUT_TAG_NAME} -o ./samples
```


# docs


# types


# Date

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

## Usage

```go
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
```


# models


# apierrors


# BadGatewayError

Server error

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# BadRequest

Represents a CircleCI error response for a 400 status code.

## Supported Types

### ResponseBodyError1

```go
badRequest := apierrors.CreateBadRequestResponseBodyError1(apierrors.ResponseBodyError1{/* values here */})
```

### ResponseBodyError2

```go
badRequest := apierrors.CreateBadRequestResponseBodyError2(apierrors.ResponseBodyError2{/* values here */})
```

## Union Discrimination

Use the `Type` field to determine which variant is active, then access the corresponding field:

```go
switch badRequest.Type {
	case apierrors.BadRequestTypeResponseBodyError1:
		// badRequest.ResponseBodyError1 is populated
	case apierrors.BadRequestTypeResponseBodyError2:
		// badRequest.ResponseBodyError2 is populated
}
```


# BadRequestError

The server could not understand the request due to invalid syntax.

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# CommonV4Error

## Fields

| Field      | Type                                                                   | Required             | Description |
| ---------- | ---------------------------------------------------------------------- | -------------------- | ----------- |
| `Error`    | [components.Error](/go-sdk/docs/models/components/error)               | :heavy\_check\_mark: | N/A         |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata) | :heavy\_check\_mark: | N/A         |


# ConflictError

The request conflicts with the current state of the server.

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# ForbiddenError

Access is forbidden.

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# GatewayTimeoutError

Server error

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# InternalServerError

Server error

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# NotFoundError

The server cannot find the requested resource.

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# PaymentRequiredError

Client error

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# ResponseBodyError1

## Fields

| Field      | Type                                                                                                                                 | Required             | Description                                            |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------ | -------------------- | ------------------------------------------------------ |
| `Meta`     | [components.V3IncidentsIncidentActionsCircleCIErrorMeta](/go-sdk/docs/models/components/v3incidentsincidentactionscirclecierrormeta) | :heavy\_check\_mark: | Represents the metadata for a CircleCI error response. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)                                                               | :heavy\_check\_mark: | N/A                                                    |


# ResponseBodyError2

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# ServiceUnavailableError

Service unavailable.

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# UnauthorizedError

Access is unauthorized.

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# UnprocessableEntityError

Client error

## Fields

| Field      | Type                                                                             | Required             | Description                                             |
| ---------- | -------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Meta`     | [components.CommonV3ErrorMeta](/go-sdk/docs/models/components/commonv3errormeta) | :heavy\_check\_mark: | Represents a single response containing data of type T. |
| `HTTPMeta` | [components.HTTPMetadata](/go-sdk/docs/models/components/httpmetadata)           | :heavy\_check\_mark: | N/A                                                     |


# components


# Abilities

A map of abilities granted to the user.

## Fields

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |


# ACL

## Fields

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |


# AdditionalResponder

## Fields

| Field  | Type     | Required             | Description |
| ------ | -------- | -------------------- | ----------- |
| `ID`   | `string` | :heavy\_check\_mark: | N/A         |
| `Type` | `string` | :heavy\_check\_mark: | N/A         |


# BuildParameters

## Fields

| Field       | Type     | Required             | Description |
| ----------- | -------- | -------------------- | ----------- |
| `CircleJob` | `string` | :heavy\_check\_mark: | N/A         |


# CircleciResponse

## Fields

| Field                     | Type                                                                                         | Required             | Description |
| ------------------------- | -------------------------------------------------------------------------------------------- | -------------------- | ----------- |
| `Username`                | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `Reponame`                | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `BuildNum`                | `int64`                                                                                      | :heavy\_check\_mark: | N/A         |
| `BuildURL`                | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `BuildParameters`         | [components.BuildParameters](/go-sdk/docs/models/components/buildparameters)                 | :heavy\_check\_mark: | N/A         |
| `Previous`                | [components.Previous](/go-sdk/docs/models/components/previous)                               | :heavy\_check\_mark: | N/A         |
| `PreviousSuccessfulBuild` | [components.PreviousSuccessfulBuild](/go-sdk/docs/models/components/previoussuccessfulbuild) | :heavy\_check\_mark: | N/A         |
| `RetryOf`                 | `int64`                                                                                      | :heavy\_check\_mark: | N/A         |
| `Body`                    | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `Subject`                 | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `Status`                  | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `Lifecycle`               | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `Outcome`                 | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `CommitterDate`           | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `CommitterEmail`          | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `CommitterName`           | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `AuthorDate`              | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `AuthorEmail`             | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `AuthorName`              | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `Branch`                  | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `VcsType`                 | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `VcsURL`                  | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `StartTime`               | `string`                                                                                     | :heavy\_check\_mark: | N/A         |
| `StopTime`                | `string`                                                                                     | :heavy\_check\_mark: | N/A         |


# CommonV3EntityOwner

Represents the owner of an entity.

## Fields

| Field  | Type     | Required             | Description                               |
| ------ | -------- | -------------------- | ----------------------------------------- |
| `ID`   | `string` | :heavy\_check\_mark: | The ID of the owner.                      |
| `Type` | `string` | :heavy\_check\_mark: | The type of the owner ( "user", "squad"). |


# CommonV3ErrorMeta

Represents a single response containing data of type T.

## Fields

| Field          | Type                                                       | Required             | Description |
| -------------- | ---------------------------------------------------------- | -------------------- | ----------- |
| `Status`       | [components.Status](/go-sdk/docs/models/components/status) | :heavy\_check\_mark: | N/A         |
| `ErrorMessage` | `string`                                                   | :heavy\_check\_mark: | N/A         |


# CommonV3RBACEntityPermission

Represents a permission granted to a user for a specific entity.

## Fields

| Field       | Type                                                             | Required             | Description                                  |
| ----------- | ---------------------------------------------------------------- | -------------------- | -------------------------------------------- |
| `UserID`    | `string`                                                         | :heavy\_check\_mark: | The ID of the user receiving the permission. |
| `Abilities` | [components.Abilities](/go-sdk/docs/models/components/abilities) | :heavy\_check\_mark: | A map of abilities granted to the user.      |


# CommonV3RBACOwner

Represents the RBAC owner of an entity.

## Fields

| Field  | Type                                                                                     | Required             | Description            |
| ------ | ---------------------------------------------------------------------------------------- | -------------------- | ---------------------- |
| `ID`   | `string`                                                                                 | :heavy\_check\_mark: | The ID of the owner.   |
| `Type` | [components.CommonV3RBACOwnerType](/go-sdk/docs/models/components/commonv3rbacownertype) | :heavy\_check\_mark: | The type of the owner. |


# CommonV3RBACOwnerType

The type of the owner.

## Example Usage

```go
import (
	"github.com/solarwinds/squadcast-sdk-go/models/components"
)

value := components.CommonV3RBACOwnerTypeTeam
```

## Values

| Name                        | Value |
| --------------------------- | ----- |
| `CommonV3RBACOwnerTypeTeam` | team  |


# CommonV4PageInfo

## Fields

| Field        | Type      | Required             | Description |
| ------------ | --------- | -------------------- | ----------- |
| `PageSize`   | `int`     | :heavy\_check\_mark: | N/A         |
| `HasNext`    | `bool`    | :heavy\_check\_mark: | N/A         |
| `HasPrev`    | `bool`    | :heavy\_check\_mark: | N/A         |
| `NextCursor` | `*string` | :heavy\_minus\_sign: | N/A         |
| `PrevCursor` | `*string` | :heavy\_minus\_sign: | N/A         |


# Condition

## Example Usage

```go
import (
	"github.com/solarwinds/squadcast-sdk-go/models/components"
)

value := components.ConditionAnd
```

## Values

| Name           | Value |
| -------------- | ----- |
| `ConditionAnd` | and   |
| `ConditionOr`  | or    |


# Config

## Fields

| Field             | Type   | Required             | Description |
| ----------------- | ------ | -------------------- | ----------- |
| `DedupKeyEnabled` | `bool` | :heavy\_check\_mark: | N/A         |


# DedupKeyOverlay

## Fields

| Field      | Type     | Required             | Description |
| ---------- | -------- | -------------------- | ----------- |
| `Template` | `string` | :heavy\_check\_mark: | N/A         |
| `Duration` | `int64`  | :heavy\_check\_mark: | N/A         |


# DeduplicationReason

## Fields

| Field                 | Type     | Required             | Description |
| --------------------- | -------- | -------------------- | ----------- |
| `MatchedEventID`      | `string` | :heavy\_check\_mark: | N/A         |
| `EvaluatedExpression` | `string` | :heavy\_check\_mark: | N/A         |
| `TimeWindow`          | `int64`  | :heavy\_check\_mark: | N/A         |


# DescriptionOverlay

## Fields

| Field      | Type     | Required             | Description |
| ---------- | -------- | -------------------- | ----------- |
| `Template` | `string` | :heavy\_check\_mark: | N/A         |


# Detail

## Fields

| Field     | Type     | Required             | Description |
| --------- | -------- | -------------------- | ----------- |
| `Field`   | `string` | :heavy\_check\_mark: | N/A         |
| `Message` | `string` | :heavy\_check\_mark: | N/A         |


# Entity

## Fields

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |


# Error

## Fields

| Field     | Type                                                          | Required             | Description |
| --------- | ------------------------------------------------------------- | -------------------- | ----------- |
| `Code`    | `string`                                                      | :heavy\_check\_mark: | N/A         |
| `Message` | `string`                                                      | :heavy\_check\_mark: | N/A         |
| `Details` | \[][components.Detail](/go-sdk/docs/models/components/detail) | :heavy\_minus\_sign: | N/A         |


# EscalationPolicies

## Fields

| Field                      | Type    | Required             | Description |
| -------------------------- | ------- | -------------------- | ----------- |
| `CreateEscalationPolicies` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadEscalationPolicies`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateEscalationPolicies` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteEscalationPolicies` | `*bool` | :heavy\_minus\_sign: | N/A         |


# ExportType

## Example Usage

```go
import (
	"github.com/solarwinds/squadcast-sdk-go/models/components"
)

value := components.ExportTypeCsv
```

## Values

| Name             | Value |
| ---------------- | ----- |
| `ExportTypeCsv`  | csv   |
| `ExportTypeJSON` | json  |


# Filters

## Fields

| Field       | Type                                  | Required             | Description |
| ----------- | ------------------------------------- | -------------------- | ----------- |
| `StartDate` | [types.Date](/go-sdk/docs/types/date) | :heavy\_check\_mark: | N/A         |
| `EndDate`   | [types.Date](/go-sdk/docs/types/date) | :heavy\_check\_mark: | N/A         |
| `Resource`  | \[]`string`                           | :heavy\_minus\_sign: | N/A         |
| `Action`    | \[]`string`                           | :heavy\_minus\_sign: | N/A         |
| `Actor`     | \[]`string`                           | :heavy\_minus\_sign: | N/A         |
| `Team`      | \[]`string`                           | :heavy\_minus\_sign: | N/A         |
| `Client`    | \[]`string`                           | :heavy\_minus\_sign: | N/A         |


# Ger

## Fields

| Field       | Type    | Required             | Description |
| ----------- | ------- | -------------------- | ----------- |
| `CreateGer` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadGer`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateGer` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteGer` | `*bool` | :heavy\_minus\_sign: | N/A         |


# GlobalOncallReminderRules

## Fields

| Field                             | Type    | Required             | Description |
| --------------------------------- | ------- | -------------------- | ----------- |
| `CreateGlobalOncallReminderRules` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadGlobalOncallReminderRules`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateGlobalOncallReminderRules` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteGlobalOncallReminderRules` | `*bool` | :heavy\_minus\_sign: | N/A         |


# HTTPMetadata

## Fields

| Field      | Type                                                    | Required             | Description                                             |
| ---------- | ------------------------------------------------------- | -------------------- | ------------------------------------------------------- |
| `Response` | [\*http.Response](https://pkg.go.dev/net/http#Response) | :heavy\_check\_mark: | Raw HTTP response; suitable for custom response parsing |
| `Request`  | [\*http.Request](https://pkg.go.dev/net/http#Request)   | :heavy\_check\_mark: | Raw HTTP request; suitable for debugging                |


# Insights

## Fields

| Field                                 | Type    | Required             | Description |
| ------------------------------------- | ------- | -------------------- | ----------- |
| `ErrorBudgetConsumptionForPast30days` | `int64` | :heavy\_check\_mark: | N/A         |


# MessageOverlay

## Fields

| Field      | Type     | Required             | Description |
| ---------- | -------- | -------------------- | ----------- |
| `Template` | `string` | :heavy\_check\_mark: | N/A         |


# Organization

## Fields

| Field  | Type     | Required             | Description |
| ------ | -------- | -------------------- | ----------- |
| `ID`   | `string` | :heavy\_check\_mark: | N/A         |
| `Name` | `string` | :heavy\_check\_mark: | N/A         |
| `Slug` | `string` | :heavy\_check\_mark: | N/A         |


# Payload

## Fields

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |


# Postmortems

## Fields

| Field               | Type    | Required             | Description |
| ------------------- | ------- | -------------------- | ----------- |
| `CreatePostmortems` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadPostmortems`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdatePostmortems` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeletePostmortems` | `*bool` | :heavy\_minus\_sign: | N/A         |


# Previous

## Fields

| Field             | Type     | Required             | Description |
| ----------------- | -------- | -------------------- | ----------- |
| `BuildNum`        | `int64`  | :heavy\_check\_mark: | N/A         |
| `BuildTimeMillis` | `int64`  | :heavy\_check\_mark: | N/A         |
| `Status`          | `string` | :heavy\_check\_mark: | N/A         |


# PreviousSuccessfulBuild

## Fields

| Field             | Type     | Required             | Description |
| ----------------- | -------- | -------------------- | ----------- |
| `BuildNum`        | `int64`  | :heavy\_check\_mark: | N/A         |
| `BuildTimeMillis` | `int64`  | :heavy\_check\_mark: | N/A         |
| `Status`          | `string` | :heavy\_check\_mark: | N/A         |


# ResolutionReason

## Fields

| Field     | Type     | Required             | Description |
| --------- | -------- | -------------------- | ----------- |
| `Message` | `string` | :heavy\_check\_mark: | N/A         |


# RoutingNumbers

## Fields

| Field                  | Type    | Required             | Description |
| ---------------------- | ------- | -------------------- | ----------- |
| `CreateRoutingNumbers` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadRoutingNumbers`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateRoutingNumbers` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteRoutingNumbers` | `*bool` | :heavy\_minus\_sign: | N/A         |


# Runbooks

## Fields

| Field            | Type    | Required             | Description |
| ---------------- | ------- | -------------------- | ----------- |
| `CreateRunbooks` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadRunbooks`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateRunbooks` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteRunbooks` | `*bool` | :heavy\_minus\_sign: | N/A         |


# Schedules

## Fields

| Field             | Type    | Required             | Description |
| ----------------- | ------- | -------------------- | ----------- |
| `CreateSchedules` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadSchedules`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateSchedules` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteSchedules` | `*bool` | :heavy\_minus\_sign: | N/A         |


# Security

## Fields

| Field              | Type      | Required             | Description                                                       |
| ------------------ | --------- | -------------------- | ----------------------------------------------------------------- |
| `RefreshTokenAuth` | `*string` | :heavy\_minus\_sign: | Squadcast refresh token used to obtain short-lived bearer tokens. |


# Services

## Fields

| Field            | Type    | Required             | Description |
| ---------------- | ------- | -------------------- | ----------- |
| `CreateServices` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadServices`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateServices` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteServices` | `*bool` | :heavy\_minus\_sign: | N/A         |


# Slos

## Fields

| Field        | Type    | Required             | Description |
| ------------ | ------- | -------------------- | ----------- |
| `CreateSlos` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadSlos`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateSlos` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteSlos` | `*bool` | :heavy\_minus\_sign: | N/A         |


# Squads

## Fields

| Field          | Type    | Required             | Description |
| -------------- | ------- | -------------------- | ----------- |
| `CreateSquads` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadSquads`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateSquads` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteSquads` | `*bool` | :heavy\_minus\_sign: | N/A         |


# StakeholderGroups

## Fields

| Field                     | Type    | Required             | Description |
| ------------------------- | ------- | -------------------- | ----------- |
| `CreateStakeholderGroups` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadStakeholderGroups`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateStakeholderGroups` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteStakeholderGroups` | `*bool` | :heavy\_minus\_sign: | N/A         |


# Status

## Supported Types

###

```go
status := components.CreateStatusStr(string{/* values here */})
```

###

```go
status := components.CreateStatusInteger(int64{/* values here */})
```

## Union Discrimination

Use the `Type` field to determine which variant is active, then access the corresponding field:

```go
switch status.Type {
	case components.StatusTypeStr:
		// status.Str is populated
	case components.StatusTypeInteger:
		// status.Integer is populated
}
```


# StatusEnum

## Example Usage

```go
import (
	"github.com/solarwinds/squadcast-sdk-go/models/components"
)

value := components.StatusEnumQueued
```

## Values

| Name                   | Value      |
| ---------------------- | ---------- |
| `StatusEnumQueued`     | queued     |
| `StatusEnumRunning`    | running    |
| `StatusEnumSuccessful` | successful |
| `StatusEnumPartial`    | partial    |
| `StatusEnumFailed`     | failed     |


# StatusMaintenance

## Fields

| Field   | Type     | Required             | Description |
| ------- | -------- | -------------------- | ----------- |
| `ID`    | `int64`  | :heavy\_check\_mark: | N/A         |
| `Name`  | `string` | :heavy\_check\_mark: | N/A         |
| `Color` | `string` | :heavy\_check\_mark: | N/A         |
| `Slug`  | `string` | :heavy\_check\_mark: | N/A         |


# StatusPages

## Fields

| Field               | Type    | Required             | Description |
| ------------------- | ------- | -------------------- | ----------- |
| `CreateStatusPages` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `ReadStatusPages`   | `*bool` | :heavy\_minus\_sign: | N/A         |
| `UpdateStatusPages` | `*bool` | :heavy\_minus\_sign: | N/A         |
| `DeleteStatusPages` | `*bool` | :heavy\_minus\_sign: | N/A         |


# Step

## Fields

| Field         | Type                                        | Required             | Description |
| ------------- | ------------------------------------------- | -------------------- | ----------- |
| `Content`     | `string`                                    | :heavy\_check\_mark: | N/A         |
| `Completed`   | `bool`                                      | :heavy\_check\_mark: | N/A         |
| `CompletedAt` | [\*time.Time](https://pkg.go.dev/time#Time) | :heavy\_minus\_sign: | N/A         |


# TeamAnalytics

## Fields

| Field               | Type    | Required             | Description |
| ------------------- | ------- | -------------------- | ----------- |
| `ReadTeamAnalytics` | `*bool` | :heavy\_minus\_sign: | N/A         |


# URLObj

## Fields

| Field    | Type      | Required             | Description |
| -------- | --------- | -------------------- | ----------- |
| `URL`    | `*string` | :heavy\_minus\_sign: | N/A         |
| `Method` | `*string` | :heavy\_minus\_sign: | N/A         |


# User

## Fields

| Field       | Type     | Required             | Description |
| ----------- | -------- | -------------------- | ----------- |
| `ID`        | `string` | :heavy\_check\_mark: | N/A         |
| `FirstName` | `string` | :heavy\_check\_mark: | N/A         |
| `LastName`  | `string` | :heavy\_check\_mark: | N/A         |
| `Deleted`   | `bool`   | :heavy\_check\_mark: | N/A         |


# V3AnalyticsAnalyticsResponse

## Fields

| Field  | Type      | Required             | Description |
| ------ | --------- | -------------------- | ----------- |
| `Mtta` | `float64` | :heavy\_check\_mark: | N/A         |
| `Mttr` | `float64` | :heavy\_check\_mark: | N/A         |


# V3AuditLogsActor

Represents an actor (user) in audit logs

## Fields

| Field       | Type     | Required             | Description |
| ----------- | -------- | -------------------- | ----------- |
| `UserID`    | `string` | :heavy\_check\_mark: | N/A         |
| `UserName`  | `string` | :heavy\_check\_mark: | N/A         |
| `UserEmail` | `string` | :heavy\_check\_mark: | N/A         |
| `FullName`  | `string` | :heavy\_check\_mark: | N/A         |


# V3AuditLogsAuditLogIDResponse

Represents detailed audit log entry response

## Fields

| Field            | Type                                                                                                               | Required             | Description                              |
| ---------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------- | ---------------------------------------- |
| `ID`             | `int`                                                                                                              | :heavy\_check\_mark: | N/A                                      |
| `Resource`       | `string`                                                                                                           | :heavy\_check\_mark: | N/A                                      |
| `Action`         | `string`                                                                                                           | :heavy\_check\_mark: | N/A                                      |
| `Actor`          | [components.V3AuditLogsActor](/go-sdk/docs/models/components/v3auditlogsactor)                                     | :heavy\_check\_mark: | Represents an actor (user) in audit logs |
| `Client`         | `string`                                                                                                           | :heavy\_check\_mark: | N/A                                      |
| `Timestamp`      | `string`                                                                                                           | :heavy\_check\_mark: | N/A                                      |
| `Timezone`       | `string`                                                                                                           | :heavy\_check\_mark: | N/A                                      |
| `Team`           | [components.V3AuditLogsTeam](/go-sdk/docs/models/components/v3auditlogsteam)                                       | :heavy\_check\_mark: | Represents a team in audit logs          |
| `TokenType`      | `string`                                                                                                           | :heavy\_check\_mark: | N/A                                      |
| `IPAddress`      | `string`                                                                                                           | :heavy\_check\_mark: | N/A                                      |
| `AdditionalInfo` | `string`                                                                                                           | :heavy\_check\_mark: | N/A                                      |
| `Meta`           | [\*components.V3AuditLogsAuditLogIDResponseMeta](/go-sdk/docs/models/components/v3auditlogsauditlogidresponsemeta) | :heavy\_minus\_sign: | N/A                                      |
| `UserAgent`      | `string`                                                                                                           | :heavy\_check\_mark: | N/A                                      |


# V3AuditLogsAuditLogIDResponseMeta

## Fields

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |


# V3AuditLogsAuditLogResponse

Represents an audit log entry response

## Fields

| Field       | Type                                                                           | Required             | Description                              |
| ----------- | ------------------------------------------------------------------------------ | -------------------- | ---------------------------------------- |
| `ID`        | `int`                                                                          | :heavy\_check\_mark: | N/A                                      |
| `Resource`  | `string`                                                                       | :heavy\_check\_mark: | N/A                                      |
| `Action`    | `string`                                                                       | :heavy\_check\_mark: | N/A                                      |
| `Actor`     | [components.V3AuditLogsActor](/go-sdk/docs/models/components/v3auditlogsactor) | :heavy\_check\_mark: | Represents an actor (user) in audit logs |
| `Client`    | `string`                                                                       | :heavy\_check\_mark: | N/A                                      |
| `Timestamp` | `string`                                                                       | :heavy\_check\_mark: | N/A                                      |
| `Team`      | [components.V3AuditLogsTeam](/go-sdk/docs/models/components/v3auditlogsteam)   | :heavy\_check\_mark: | Represents a team in audit logs          |


# V3AuditLogsAuditLogsExportHistoryResponse

Response model for audit logs export history

## Fields

| Field          | Type                                                                               | Required             | Description                                  |
| -------------- | ---------------------------------------------------------------------------------- | -------------------- | -------------------------------------------- |
| `ID`           | `string`                                                                           | :heavy\_check\_mark: | N/A                                          |
| `Name`         | `string`                                                                           | :heavy\_check\_mark: | N/A                                          |
| `Description`  | `string`                                                                           | :heavy\_check\_mark: | N/A                                          |
| `ExportedAt`   | `string`                                                                           | :heavy\_check\_mark: | N/A                                          |
| `RequestedBy`  | [components.V3AuditLogsActor](/go-sdk/docs/models/components/v3auditlogsactor)     | :heavy\_check\_mark: | Represents an actor (user) in audit logs     |
| `DownloadLink` | `string`                                                                           | :heavy\_check\_mark: | N/A                                          |
| `Status`       | `string`                                                                           | :heavy\_check\_mark: | N/A                                          |
| `Filters`      | [components.V3AuditLogsFilters](/go-sdk/docs/models/components/v3auditlogsfilters) | :heavy\_check\_mark: | Represents filters used in audit log queries |


# V3AuditLogsExportAuditLogsRequest

Request model for exporting audit logs

## Fields

| Field         | Type                                                               | Required             | Description |
| ------------- | ------------------------------------------------------------------ | -------------------- | ----------- |
| `Filters`     | [components.Filters](/go-sdk/docs/models/components/filters)       | :heavy\_check\_mark: | N/A         |
| `Name`        | `string`                                                           | :heavy\_check\_mark: | N/A         |
| `Description` | `*string`                                                          | :heavy\_minus\_sign: | N/A         |
| `ExportType`  | [components.ExportType](/go-sdk/docs/models/components/exporttype) | :heavy\_check\_mark: | N/A         |


# V3AuditLogsExportAuditLogsResponse

Response model for exporting audit logs

## Fields

| Field  | Type                                                                                                                       | Required             | Description |
| ------ | -------------------------------------------------------------------------------------------------------------------------- | -------------------- | ----------- |
| `Data` | [components.V3AuditLogsExportAuditLogsResponseData](/go-sdk/docs/models/components/v3auditlogsexportauditlogsresponsedata) | :heavy\_check\_mark: | N/A         |


# V3AuditLogsExportAuditLogsResponseData

## Fields

| Field     | Type     | Required             | Description |
| --------- | -------- | -------------------- | ----------- |
| `ID`      | `string` | :heavy\_check\_mark: | N/A         |
| `Message` | `string` | :heavy\_check\_mark: | N/A         |


# V3AuditLogsFilters

Represents filters used in audit log queries

## Fields

| Field       | Type                                                                              | Required             | Description |
| ----------- | --------------------------------------------------------------------------------- | -------------------- | ----------- |
| `StartDate` | [types.Date](/go-sdk/docs/types/date)                                             | :heavy\_check\_mark: | N/A         |
| `EndDate`   | [types.Date](/go-sdk/docs/types/date)                                             | :heavy\_check\_mark: | N/A         |
| `Resource`  | \[]`string`                                                                       | :heavy\_minus\_sign: | N/A         |
| `Action`    | \[]`string`                                                                       | :heavy\_minus\_sign: | N/A         |
| `Actor`     | \[][components.V3AuditLogsActor](/go-sdk/docs/models/components/v3auditlogsactor) | :heavy\_minus\_sign: | N/A         |
| `Team`      | \[][components.V3AuditLogsTeam](/go-sdk/docs/models/components/v3auditlogsteam)   | :heavy\_minus\_sign: | N/A         |
| `Client`    | \[]`string`                                                                       | :heavy\_minus\_sign: | N/A         |


# V3AuditLogsGetAuditLogByIDResponse

Response model for getting audit log by ID

## Fields

| Field  | Type                                                                                                     | Required             | Description                                  |
| ------ | -------------------------------------------------------------------------------------------------------- | -------------------- | -------------------------------------------- |
| `Data` | [components.V3AuditLogsAuditLogIDResponse](/go-sdk/docs/models/components/v3auditlogsauditlogidresponse) | :heavy\_check\_mark: | Represents detailed audit log entry response |


# V3AuditLogsGetAuditLogExportHistoryByIDResponse

Response model for getting audit log export history by ID

## Fields

| Field  | Type                                                                                                                             | Required             | Description                                  |
| ------ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------- | -------------------------------------------- |
| `Data` | [components.V3AuditLogsAuditLogsExportHistoryResponse](/go-sdk/docs/models/components/v3auditlogsauditlogsexporthistoryresponse) | :heavy\_check\_mark: | Response model for audit logs export history |


# V3AuditLogsListAuditLogsExportHistoryResponse

Response model for listing audit logs export history

## Fields

| Field      | Type                                                                                                                                                     | Required             | Description |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ----------- |
| `Data`     | \[][components.V3AuditLogsAuditLogsExportHistoryResponse](/go-sdk/docs/models/components/v3auditlogsauditlogsexporthistoryresponse)                      | :heavy\_check\_mark: | N/A         |
| `Metadata` | [components.V3AuditLogsListAuditLogsExportHistoryResponseMetadata](/go-sdk/docs/models/components/v3auditlogslistauditlogsexporthistoryresponsemetadata) | :heavy\_check\_mark: | N/A         |


# V3AuditLogsListAuditLogsExportHistoryResponseMetadata

## Fields

| Field        | Type    | Required             | Description |
| ------------ | ------- | -------------------- | ----------- |
| `TotalCount` | `int64` | :heavy\_check\_mark: | N/A         |


# V3AuditLogsListAuditLogsResponse

Response model for listing audit logs

## Fields

| Field      | Type                                                                                                                           | Required             | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------- | ----------- |
| `Data`     | \[][components.V3AuditLogsAuditLogResponse](/go-sdk/docs/models/components/v3auditlogsauditlogresponse)                        | :heavy\_check\_mark: | N/A         |
| `Metadata` | [components.V3AuditLogsListAuditLogsResponseMetadata](/go-sdk/docs/models/components/v3auditlogslistauditlogsresponsemetadata) | :heavy\_check\_mark: | N/A         |


# V3AuditLogsListAuditLogsResponseMetadata

## Fields

| Field        | Type    | Required             | Description |
| ------------ | ------- | -------------------- | ----------- |
| `TotalCount` | `int64` | :heavy\_check\_mark: | N/A         |


# V3AuditLogsTeam

Represents a team in audit logs

## Fields

| Field       | Type     | Required             | Description |
| ----------- | -------- | -------------------- | ----------- |
| `ID`        | `string` | :heavy\_check\_mark: | N/A         |
| `Name`      | `string` | :heavy\_check\_mark: | N/A         |
| `IsDeleted` | `bool`   | :heavy\_check\_mark: | N/A         |


# V3EscalationPoliciesCreateEscalationPolicyRequest

## Fields

| Field                     | Type                                                                                                                              | Required             | Description                                                       |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ----------------------------------------------------------------- |
| `OwnerID`                 | `string`                                                                                                                          | :heavy\_check\_mark: | The ID of the team that owns this escalation policy.              |
| `Name`                    | `string`                                                                                                                          | :heavy\_check\_mark: | The name of the escalation policy.                                |
| `Description`             | `string`                                                                                                                          | :heavy\_check\_mark: | A description of the escalation policy.                           |
| `Repetition`              | `int`                                                                                                                             | :heavy\_check\_mark: | The number of times the entire policy should be repeated.         |
| `RepeatAfter`             | `int`                                                                                                                             | :heavy\_check\_mark: | The time in minutes after which the policy should be repeated.    |
| `Rules`                   | \[][components.V3EscalationPoliciesEscalationPolicyRule](/go-sdk/docs/models/components/v3escalationpoliciesescalationpolicyrule) | :heavy\_check\_mark: | The rules that define the escalation steps.                       |
| `EnableIncidentReminders` | `bool`                                                                                                                            | :heavy\_check\_mark: | Enable or disable incident reminders.                             |
| `IncidentReminderRules`   | \[][components.V3EscalationPoliciesIncidentReminderRule](/go-sdk/docs/models/components/v3escalationpoliciesincidentreminderrule) | :heavy\_check\_mark: | The rules for incident reminders.                                 |
| `EnableIncidentRetrigger` | `bool`                                                                                                                            | :heavy\_check\_mark: | Enable or disable automatic incident re-triggering.               |
| `RetriggerAfter`          | `int`                                                                                                                             | :heavy\_check\_mark: | The time in hours after which an incident should be re-triggered. |
| `EntityOwner`             | [\*components.CommonV3EntityOwner](/go-sdk/docs/models/components/commonv3entityowner)                                            | :heavy\_minus\_sign: | The owner of the entity.                                          |


# V3EscalationPoliciesEscalationEntity

Represents an entity to be notified in an escalation rule.

## Fields

| Field  | Type                                                                                                                           | Required             | Description                                                        |
| ------ | ------------------------------------------------------------------------------------------------------------------------------ | -------------------- | ------------------------------------------------------------------ |
| `ID`   | `*string`                                                                                                                      | :heavy\_minus\_sign: | The unique identifier of the entity (user, squad, or schedule v1). |
| `Pid`  | `*int`                                                                                                                         | :heavy\_minus\_sign: | The unique identifier of the entity (schedule v2).                 |
| `Type` | [components.V3EscalationPoliciesEscalationEntityType](/go-sdk/docs/models/components/v3escalationpoliciesescalationentitytype) | :heavy\_check\_mark: | The type of the entity.                                            |


# V3EscalationPoliciesEscalationEntityType

The type of the entity.

## Example Usage

```go
import (
	"github.com/solarwinds/squadcast-sdk-go/models/components"
)

value := components.V3EscalationPoliciesEscalationEntityTypeUser
```

## Values

| Name                                                 | Value      |
| ---------------------------------------------------- | ---------- |
| `V3EscalationPoliciesEscalationEntityTypeUser`       | user       |
| `V3EscalationPoliciesEscalationEntityTypeSquad`      | squad      |
| `V3EscalationPoliciesEscalationEntityTypeSchedule`   | schedule   |
| `V3EscalationPoliciesEscalationEntityTypeSchedulev2` | schedulev2 |


# V3EscalationPoliciesEscalationPolicyResponse

Represents an Escalation Policy in the system.

## Fields

| Field                     | Type                                                                                                                              | Required             | Description                                                       |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ----------------------------------------------------------------- |
| `ID`                      | `string`                                                                                                                          | :heavy\_check\_mark: | The unique identifier for the escalation policy.                  |
| `Name`                    | `string`                                                                                                                          | :heavy\_check\_mark: | The name of the escalation policy.                                |
| `Description`             | `string`                                                                                                                          | :heavy\_check\_mark: | A description of the escalation policy.                           |
| `OrganizationID`          | `string`                                                                                                                          | :heavy\_check\_mark: | The ID of the organization this policy belongs to.                |
| `Repetition`              | `int`                                                                                                                             | :heavy\_check\_mark: | The number of times the entire policy should be repeated.         |
| `RepeatAfter`             | `int`                                                                                                                             | :heavy\_check\_mark: | The time in minutes after which the policy should be repeated.    |
| `Rules`                   | \[][components.V3EscalationPoliciesEscalationPolicyRule](/go-sdk/docs/models/components/v3escalationpoliciesescalationpolicyrule) | :heavy\_check\_mark: | The rules that define the escalation steps.                       |
| `Slug`                    | `string`                                                                                                                          | :heavy\_check\_mark: | The URL-friendly slug for the policy name.                        |
| `EnableIncidentReminders` | `bool`                                                                                                                            | :heavy\_check\_mark: | Enable or disable incident reminders.                             |
| `IncidentReminderRules`   | \[][components.V3EscalationPoliciesIncidentReminderRule](/go-sdk/docs/models/components/v3escalationpoliciesincidentreminderrule) | :heavy\_check\_mark: | The rules for incident reminders.                                 |
| `EnableIncidentRetrigger` | `bool`                                                                                                                            | :heavy\_check\_mark: | Enable or disable automatic incident re-triggering.               |
| `RetriggerAfter`          | `int`                                                                                                                             | :heavy\_check\_mark: | The time in hours after which an incident should be re-triggered. |
| `EntityOwner`             | [components.CommonV3EntityOwner](/go-sdk/docs/models/components/commonv3entityowner)                                              | :heavy\_check\_mark: | The owner of the entity.                                          |
| `Owner`                   | [components.CommonV3RBACOwner](/go-sdk/docs/models/components/commonv3rbacowner)                                                  | :heavy\_check\_mark: | The RBAC owner of the policy (typically a team).                  |
| `AccessControl`           | \[][components.CommonV3RBACEntityPermission](/go-sdk/docs/models/components/commonv3rbacentitypermission)                         | :heavy\_check\_mark: | Access control list for this policy.                              |


# V3EscalationPoliciesEscalationPolicyRule

Represents a rule within an escalation policy.

## Fields

| Field                      | Type                                                                                                                      | Required             | Description                                                            |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------- | ---------------------------------------------------------------------- |
| `EscalationTime`           | `int`                                                                                                                     | :heavy\_check\_mark: | The time in minutes to wait before this rule is triggered.             |
| `Via`                      | \[]`string`                                                                                                               | :heavy\_check\_mark: | The notification methods to use for this rule.                         |
| `RoundrobinEnabled`        | `bool`                                                                                                                    | :heavy\_check\_mark: | Indicates if round-robin is enabled for the entities in this rule.     |
| `RoundrobinNextIndex`      | `int`                                                                                                                     | :heavy\_check\_mark: | The index of the next entity to be notified in a round-robin setup.    |
| `Entities`                 | \[][components.V3EscalationPoliciesEscalationEntity](/go-sdk/docs/models/components/v3escalationpoliciesescalationentity) | :heavy\_check\_mark: | The entities to be notified in this rule.                              |
| `EscalateWithinRoundrobin` | `bool`                                                                                                                    | :heavy\_check\_mark: | Indicates if escalation should happen within the round-robin rotation. |
| `Repetition`               | `int`                                                                                                                     | :heavy\_check\_mark: | The number of times this specific rule should be repeated.             |
| `RepeatAfter`              | `int`                                                                                                                     | :heavy\_check\_mark: | The time in minutes after which this rule should be repeated.          |


# V3EscalationPoliciesIncidentReminderRule

Represents a rule for sending incident reminders.

## Fields

| Field          | Type        | Required             | Description                                            |
| -------------- | ----------- | -------------------- | ------------------------------------------------------ |
| `Via`          | \[]`string` | :heavy\_check\_mark: | The notification methods to use for the reminder.      |
| `TimeInterval` | `int`       | :heavy\_check\_mark: | The interval in minutes at which to send the reminder. |
| `Till`         | `int`       | :heavy\_check\_mark: | The duration in minutes for which to send reminders.   |


# V3ExportExportResponse

## Fields

| Field                  | Type      | Required             | Description |
| ---------------------- | --------- | -------------------- | ----------- |
| `ID`                   | `string`  | :heavy\_check\_mark: | N/A         |
| `Type`                 | `string`  | :heavy\_check\_mark: | N/A         |
| `Status`               | `string`  | :heavy\_check\_mark: | N/A         |
| `DownloadURL`          | `*string` | :heavy\_minus\_sign: | N/A         |
| `DownloadURLExpiresAt` | `*string` | :heavy\_minus\_sign: | N/A         |
| `Format`               | `string`  | :heavy\_check\_mark: | N/A         |
| `ErrorMessage`         | `*string` | :heavy\_minus\_sign: | N/A         |




---

[Next Page](/llms-full.txt/1)