openapi: "3.1.0" info: title: "Squadcast" version: "1.0.0" description: "## Overview\nThe 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.\n\n> **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.\n\n### Service Regions\n\nSquadcast 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).\n\n| Service Region | API Endpoints |\n|---|---|\n| US | Authentication: https://auth.squadcast.com · Other APIs: https://api.squadcast.com |\n| EU | Authentication: https://auth.eu.squadcast.com · Other APIs: https://api.eu.squadcast.com |\n\n### Authentication\n\nIn 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`.\n\nSteps to procure the `access_token`:\n\n1. 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.\n2. Call the authentication API with the `refresh_token` to obtain an `access_token`.\n3. Use the `access_token` as a Bearer token in the `Authorization` header for all subsequent API requests.\n\n#### Example — Generating an Access Token\n\n```bash\ncurl --location --request GET 'https://auth.squadcast.com/oauth/access-token' \\\n--header 'X-Refresh-Token: 0d2a1a9a454dxxxxxxxxxxxx'\n```\n\nThe API response will look similar to:\n\n```json\n{\n \"data\": {\n \"access_token\": \"eyJhbGciOiJIUxxxxx.xxxxxxxxxxxxxxx.xxxxxxxxxxxxxxx\",\n \"expires_at\": 1587412870,\n \"issued_at\": 1587240070,\n \"refresh_token\": \"0d2a1a9a454dxxxxxxxxxxxx\",\n \"type\": \"bearer\"\n }\n}\n```\n\n### Access Control\n\nThere 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.\n\n### Authorization\n\nThe 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." tags: - name: "Auth" - name: "Analytics" - name: "Audit Logs" - name: "Escalation Policies" - name: "Export" - name: "Extensions/Webhooks" - name: "Extensions/MSTeams" - name: "Global Event Rules/Rulesets/Rules" - name: "Global Event Rules/Rulesets" - name: "Global Event Rules" - name: "Global Oncall Reminder Rules" - name: "Incidents" - name: "Incidents/Postmortems" - name: "Incidents/Runbooks" - name: "Incidents/Notes" - name: "Incidents/Communication Card" - name: "Incidents/Tags" - name: "Incidents/Auto Pause Transient Alerts (APTA)" - name: "Incidents/Snooze Notifications" - name: "Incidents/Additional Responders" - name: "Incidents/Incident Actions" - name: "Runbooks" - name: "Services" - name: "Services/Tagging Rules" - name: "Services/Maintenance Mode" - name: "Services/Dependencies" - name: "Services/Routing Rules" - name: "Services/Deduplication Rules" - name: "Services/Suppression Rules" - name: "Services/Extensions" - name: "Services/Overlay" - name: "Services/Overlay/Dedup Key Overlay" - name: "Services/Overlay/Custom Content Templates" - name: "SLOs" - name: "Teams" - name: "Users/Api Token" - name: "Users" - name: "Webforms" - name: "Workflows" - name: "Schedule" - name: "Schedule/Export Schedule" - name: "Rotation" - name: "Overrides" - name: "Squads" - name: "Status Pages/Subscribers" - name: "Status Pages" - name: "Status Pages/Issues" - name: "Status Pages/Maintenances" - name: "Status Pages/Components" - name: "Status Pages/Component groups" paths: /oauth/access-token: get: operationId: "Auth_getAccessToken" summary: "Get Access Token" description: "Get access token to make authenticated HTTP requests to the Squadcast API.\nSend your refresh token (obtained from the Squadcast web application) in the\n`X-Refresh-Token` header." parameters: - name: "X-Refresh-Token" in: "header" required: true description: "(Required) Send your refresh token obtained from Squadcast web application." schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Auth.AccessTokenData" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Auth" security: - {} servers: - url: "https://auth.squadcast.com" description: "US Authentication" - url: "https://auth.eu.squadcast.com" description: "EU Authentication" x-codeSamples: - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK() as ss_client: res = ss_client.auth.auth_get_access_token(x_refresh_token="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK(); async function run() { const result = await squadcastSDK.auth.authGetAccessToken({ xRefreshToken: "", }); console.log(result); } run(); /v3/analyticsv2/organization: get: operationId: "Analytics_getOrgAnalytics" summary: "Get Org level analytics" description: "Get Org level analytics" parameters: - name: "from" in: "query" required: true schema: type: "string" explode: false - name: "to" in: "query" required: true schema: type: "string" explode: false - name: "team_id" in: "query" required: false schema: type: "string" explode: false - name: "user_id" in: "query" required: false schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Analytics.AnalyticsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Analytics" x-speakeasy-name-override: getOrgAnalytics x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Analytics.GetOrganization(ctx, "", "", nil, nil) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.analytics.get_org_analytics(from_="", to="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.analytics.getOrganization({ from: "", to: "", }); console.log(result); } run(); /v3/analyticsv2/team: get: operationId: "Analytics_getTeamAnalytics" summary: "Get Team level analytics" description: "Get Team level analytics" parameters: - name: "owner_id" in: "query" required: true schema: type: "string" explode: false - name: "from" in: "query" required: true schema: type: "string" explode: false - name: "to" in: "query" required: true schema: type: "string" explode: false - name: "user_id" in: "query" required: false schema: type: "string" explode: false - name: "service_id" in: "query" required: false schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Analytics.AnalyticsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Analytics" x-speakeasy-name-override: getTeam x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Analytics.GetTeam(ctx, operations.AnalyticsGetTeamAnalyticsRequest{ OwnerID: "", From: "", To: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.analytics.get_team(owner_id="", from_="", to="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.analytics.getTeam({ ownerId: "", from: "", to: "", }); console.log(result); } run(); /v3/audit-logs: get: operationId: "AuditLogs_listAuditLogs" summary: "List all Audit Logs" description: "List all Audit Logs\nReturns array of audit logs for given team and filters" parameters: - name: "pageSize" in: "query" required: true schema: type: "integer" explode: false - name: "pageNumber" in: "query" required: true schema: type: "integer" explode: false - name: "startDate" in: "query" required: true schema: type: "string" format: "date" explode: false - name: "endDate" in: "query" required: true schema: type: "string" format: "date" explode: false - name: "action[]" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "resource[]" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "actor[]" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "team[]" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "client[]" in: "query" required: false schema: type: "array" items: type: "string" enum: - "web" - "mobile" - "terraform" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V3.AuditLogs.ListAuditLogsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Audit Logs" x-speakeasy-pagination: type: "offsetLimit" inputs: - name: "pageNumber" in: "parameters" type: "page" - name: "pageSize" in: "parameters" type: "limit" outputs: results: "$.data" x-speakeasy-group: auditLogs x-speakeasy-name-override: list x-codeSamples: - lang: python label: Python (SDK) source: |- from datetime import date from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.audit_logs.list(page_size=832442, page_number=555332, start_date=date.fromisoformat("2023-03-04"), end_date=date.fromisoformat("2024-08-07")) while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; import { RFCDate } from "@solarwinds/squadcast-sdk-typescript/types"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.auditLogs.list({ pageSize: 832442, pageNumber: 555332, startDate: new RFCDate("2023-03-04"), endDate: new RFCDate("2024-08-07"), }); for await (const page of result) { console.log(page); } } run(); /v3/audit-logs/export: post: operationId: "AuditLogs_exportAuditLogs" summary: "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." description: "Export Audit logs\nInitiates export of audit logs based on provided filters" parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V3.AuditLogs.ExportAuditLogsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Audit Logs" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.AuditLogs.ExportAuditLogsRequest" x-speakeasy-group: auditLogs x-speakeasy-name-override: export x-codeSamples: - lang: python label: Python (SDK) source: |- from datetime import date from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.audit_logs.export(filters={ "start_date": date.fromisoformat("2025-07-29"), "end_date": date.fromisoformat("2023-09-09"), }, name="", export_type="json") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; import { RFCDate } from "@solarwinds/squadcast-sdk-typescript/types"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.auditLogs.export({ filters: { startDate: new RFCDate("2025-07-29"), endDate: new RFCDate("2023-09-09"), }, name: "", exportType: "json", }); console.log(result); } run(); /v3/audit-logs/export/history: get: operationId: "AuditLogs_listAuditLogsExportHistory" summary: "List all Audit Logs export history" description: "List all Audit Logs export history\nReturns array of audit logs export history" parameters: - name: "pageSize" in: "query" required: true schema: type: "integer" explode: false - name: "pageNumber" in: "query" required: true schema: type: "integer" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V3.AuditLogs.ListAuditLogsExportHistoryResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Audit Logs" x-speakeasy-pagination: type: "offsetLimit" inputs: - name: "pageNumber" in: "parameters" type: "page" - name: "pageSize" in: "parameters" type: "limit" outputs: results: "$.data" x-speakeasy-group: auditLogs x-speakeasy-name-override: listExportHistory x-codeSamples: - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.audit_logs.list_export_history(page_size=159672, page_number=351281) while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.auditLogs.listExportHistory({ pageSize: 159672, pageNumber: 351281, }); for await (const page of result) { console.log(page); } } run(); /v3/audit-logs/export/history/{id}: get: operationId: "AuditLogs_getAuditLogsExportHistoryById" summary: "Get details of Audit Logs export history by ID" description: "Get details of Audit Logs export history by ID\nReturns audit log export history details for the specified ID" parameters: - name: "id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V3.AuditLogs.GetAuditLogExportHistoryByIDResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Audit Logs" x-speakeasy-group: auditLogs x-speakeasy-name-override: getExportHistoryById x-codeSamples: - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.audit_logs.get_export_history_by_id(id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.auditLogs.exportHistory.get({ id: "", }); console.log(result); } run(); /v3/audit-logs/{id}: get: operationId: "AuditLogs_getAuditLogById" summary: "Get audit log by ID" description: "Get audit log by ID\nReturns audit log details for the specified ID" parameters: - name: "id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V3.AuditLogs.GetAuditLogByIDResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Audit Logs" x-speakeasy-group: auditLogs x-speakeasy-name-override: getById x-codeSamples: - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.audit_logs.get_by_id(id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.auditLogs.getById({ id: "", }); console.log(result); } run(); /v3/escalation-policies: get: operationId: "EscalationPolicies_getEscalationPolicyByTeam" summary: "Get Escalation Policy By team" description: "Returns all escalation policy details of the given `ownerID` (teamId) in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "owner_id" in: "query" required: true description: "here owner_id represents team_id, if team_id is not provided, it will return escalation policies of all teams." schema: type: "string" - name: "page_number" in: "query" required: false schema: type: "integer" - name: "page_size" in: "query" required: false schema: type: "integer" - name: "authorization" in: "header" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "array" items: $ref: "#/components/schemas/V3.EscalationPolicies.EscalationPolicyResponse" meta: type: "object" properties: total_count: type: "integer" format: "int32" required: - "total_count" required: - "data" - "meta" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Escalation Policies" x-speakeasy-pagination: type: "offsetLimit" inputs: - name: "page_number" in: "parameters" type: "page" - name: "page_size" in: "parameters" type: "limit" outputs: results: "$.data" x-speakeasy-group: escalationPolicies x-speakeasy-name-override: getByTeam x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.EscalationPolicies.GetByTeam(ctx, "", nil, nil) if err != nil { log.Fatal(err) } if res.Object != nil { for { // handle items res, err = res.Next() if err != nil { // handle error } if res == nil { break } } } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.escalation_policies.get_by_team(owner_id="") while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.escalationPolicies.listByTeam({ ownerId: "", }); for await (const page of result) { console.log(page); } } run(); post: operationId: "EscalationPolicies_createEscalationPolicies" summary: "Create Escalation Policies" description: "Add escalation policy to the organization. Returns the escalation policy object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.EscalationPolicies.EscalationPolicyResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Escalation Policies" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.EscalationPolicies.CreateEscalationPolicyRequest" x-speakeasy-group: escalationPolicies x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.EscalationPolicies.Create(ctx, components.V3EscalationPoliciesCreateEscalationPolicyRequest{ OwnerID: "", Name: "", Description: "properly aw gerbil address co-producer guzzle delight difficult", Repetition: 549305, RepeatAfter: 226311, Rules: []components.V3EscalationPoliciesEscalationPolicyRule{ components.V3EscalationPoliciesEscalationPolicyRule{ EscalationTime: 646220, Via: []string{ "", "", }, RoundrobinEnabled: true, RoundrobinNextIndex: 685302, Entities: []components.V3EscalationPoliciesEscalationEntity{}, EscalateWithinRoundrobin: true, Repetition: 149319, RepeatAfter: 619552, }, }, EnableIncidentReminders: false, IncidentReminderRules: []components.V3EscalationPoliciesIncidentReminderRule{}, EnableIncidentRetrigger: false, RetriggerAfter: 660610, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.escalation_policies.create(owner_id="", name="", description="properly aw gerbil address co-producer guzzle delight difficult", repetition=549305, repeat_after=226311, rules=[ { "escalation_time": 646220, "via": [ "", "", ], "roundrobin_enabled": True, "roundrobin_next_index": 685302, "entities": [], "escalate_within_roundrobin": True, "repetition": 149319, "repeat_after": 619552, }, ], enable_incident_reminders=False, incident_reminder_rules=[], enable_incident_retrigger=False, retrigger_after=660610) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.escalationPolicies.create({ ownerId: "", name: "", description: "properly aw gerbil address co-producer guzzle delight difficult", repetition: 549305, repeatAfter: 226311, rules: [ { escalationTime: 646220, via: [ "", "", ], roundrobinEnabled: true, roundrobinNextIndex: 685302, entities: [], escalateWithinRoundrobin: true, repetition: 149319, repeatAfter: 619552, }, ], enableIncidentReminders: false, incidentReminderRules: [], enableIncidentRetrigger: false, retriggerAfter: 660610, }); console.log(result); } run(); /v3/escalation-policies/{escalationPolicyID}: delete: operationId: "EscalationPolicies_removeEscalationPolicy" summary: "Remove Escalation Policy" description: "Remove escalation policy from the organization. Upon success, the escalation policy will be removed from the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "escalationPolicyID" in: "path" required: true description: "(Required) escalation policy ID" schema: type: "string" - name: "authorization" in: "header" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Escalation Policies" x-speakeasy-group: escalationPolicies x-speakeasy-name-override: remove x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.EscalationPolicies.Remove(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.escalation_policies.remove(escalation_policy_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.escalationPolicies.remove({ escalationPolicyID: "", }); console.log(result); } run(); get: operationId: "EscalationPolicies_getEscalationPolicyById" summary: "Get Escalation Policy By ID" description: "Returns an escalation policy details of the given `escalationPolicyID` in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "escalationPolicyID" in: "path" required: true description: "(Required) escalation policy ID" schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.EscalationPolicies.EscalationPolicyResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Escalation Policies" x-speakeasy-group: escalationPolicies x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.EscalationPolicies.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.escalation_policies.get_by_id(escalation_policy_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.escalationPolicies.getById({ escalationPolicyID: "", }); console.log(result); } run(); post: operationId: "EscalationPolicies_updateEscalationPolicy" summary: "Update Escalation Policy" description: "Update organization escalation policy details.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "escalationPolicyID" in: "path" required: true description: "(Required) escalation policy ID" schema: type: "string" - name: "authorization" in: "header" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.EscalationPolicies.EscalationPolicyResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Escalation Policies" requestBody: required: true content: text/plain: schema: $ref: "#/components/schemas/V3.EscalationPolicies.UpdateEscalationPolicyRequest" x-speakeasy-group: escalationPolicies x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) example, fileErr := os.Open("example.file") if fileErr != nil { panic(fileErr) } res, err := s.EscalationPolicies.Update(ctx, "", example) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.escalation_policies.update(escalation_policy_id="", v3_escalation_policies_update_escalation_policy_request=open("example.file", "rb")) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; import { openAsBlob } from "node:fs"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.escalationPolicies.update({ escalationPolicyID: "", v3EscalationPoliciesUpdateEscalationPolicyRequest: await openAsBlob("example.file"), }); console.log(result); } run(); /v3/exports/{export_id}: get: operationId: "Export_getExportDetails" summary: "Get Export Details" description: "Get Export Details" parameters: - name: "export_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Export.ExportResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Export" x-speakeasy-group: exports x-speakeasy-name-override: getDetails x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Exports.GetDetails(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.exports.get_details(export_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.exports.getDetails({ exportId: "", }); console.log(result); } run(); /v3/extensions/event-webhooks: get: operationId: "Webhooks_getAllWebhooks" summary: "Get All Webhooks" description: "Returns all the webhooks of the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "page-limit" in: "query" required: false schema: type: "string" - name: "offset" in: "query" required: false schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V3.Extensions.Webhooks.GetAllWebhooksResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Extensions/Webhooks" x-speakeasy-group: extensions.webhooks x-speakeasy-name-override: getAll x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Webhooks.GetAll(ctx, nil, nil) if err != nil { log.Fatal(err) } if res.V3ExtensionsWebhooksGetAllWebhooksResponse != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.extensions.webhooks.get_all() # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.webhooks.getAll(); console.log(result); } run(); post: operationId: "Webhooks_createWebhook" summary: "Create Webhook" description: "Add webhook to the organization. Returns the webhook object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "body" properties: body: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Extensions.Webhooks.WebhookResponse" description: "The body type of the operation request or response." description: "" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Extensions/Webhooks" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Extensions.Webhooks.Webhook" x-speakeasy-group: webhooks x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Webhooks.Create(ctx, components.V3ExtensionsWebhooksWebhook{ Name: "", Triggers: []components.V3ExtensionsWebhooksWebhookTrigger{}, Urls: []components.V3ExtensionsWebhooksWebhookURL{ components.V3ExtensionsWebhooksWebhookURL{}, }, TriggerType: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.webhooks.create(name="", triggers=[], urls=[ {}, ], trigger_type="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.extensions.webhooks.create({ name: "", triggers: [], urls: [ {}, ], triggerType: "", }); console.log(result); } run(); /v3/extensions/event-webhooks/{eventWebhookID}: delete: operationId: "Webhooks_deleteWebhook" summary: "Delete Webhook" description: "Remove webhook from the organization. Upon success, the webhook will be removed from the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "eventWebhookID" in: "path" required: true description: "(Required) event webhook ID" schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Extensions/Webhooks" x-speakeasy-group: webhooks x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Extensions.Webhooks.Delete(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.webhooks.delete(event_webhook_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.webhooks.delete({ eventWebhookID: "", }); console.log(result); } run(); get: operationId: "Webhooks_getWebhookById" summary: "Get Webhook By ID" description: "Returns a webhooks details of the given `eventWebhookID` in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "eventWebhookID" in: "path" required: true description: "(Required) event webhook ID" schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Extensions.Webhooks.WebhookResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Extensions/Webhooks" x-speakeasy-group: webhooks x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Extensions.Webhooks.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.webhooks.get_by_id(event_webhook_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.webhooks.getById({ eventWebhookID: "", }); console.log(result); } run(); put: operationId: "Webhooks_updateWebhook" summary: "Update Webhook" description: "Update organization webhook details.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "eventWebhookID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Extensions.Webhooks.WebhookResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Extensions/Webhooks" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Extensions.Webhooks.Webhook" x-speakeasy-group: webhooks x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Webhooks.Update(ctx, "", components.V3ExtensionsWebhooksWebhook{ Name: "", Triggers: []components.V3ExtensionsWebhooksWebhookTrigger{ components.V3ExtensionsWebhooksWebhookTrigger{ EventClass: "", EventType: "", }, }, Urls: []components.V3ExtensionsWebhooksWebhookURL{ components.V3ExtensionsWebhooksWebhookURL{}, }, TriggerType: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.webhooks.update(event_webhook_id="", name="", triggers=[ { "event_class": "", "event_type": "", }, ], urls=[ {}, ], trigger_type="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.extensions.webhooks.update({ eventWebhookID: "", v3ExtensionsWebhooksWebhook: { name: "", triggers: [ { eventClass: "", eventType: "", }, ], urls: [ {}, ], triggerType: "", }, }); console.log(result); } run(); /v3/extensions/msteams/config: get: operationId: "MSTeams_getMsteamsConfig" summary: "Get MSTeams Config" description: "Returns MSTeams config of the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "authorization" in: "header" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Extensions.MSTeams.MSTeamsConfigResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Extensions/MSTeams" x-speakeasy-group: extensions.msTeams x-speakeasy-name-override: getConfig x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Msteams.GetConfig(ctx) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.extensions.ms_teams.get_config() # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.extensions.msteams.getConfig(); console.log(result); } run(); post: operationId: "MSTeams_createOrUpdateMsteamsConfiguration" summary: "Create Or Update MSTeams Configuration" description: "Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "authorization" in: "header" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Extensions.MSTeams.MSTeamsConfigResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Extensions/MSTeams" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Extensions.MSTeams.CreateOrUpdateMSTeamsConfigRequest" x-speakeasy-group: extensions.msteams x-speakeasy-name-override: createOrUpdateConfig x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Extensions.Msteams.UpsertConfig(ctx, components.V3ExtensionsMSTeamsCreateOrUpdateMSTeamsConfigRequest{ DefaultConversationName: "", DefaultConversationID: "", IsActive: false, IsDefaultActive: false, IsCustomChannelsActive: true, Triggers: components.V3ExtensionsMSTeamsTriggers{ AllActive: false, Custom: []components.V3ExtensionsMSTeamsEventClass{}, }, TenantID: "", FromID: "", ConnectedTeams: []components.V3ExtensionsMSTeamsConnectedTeams{ components.V3ExtensionsMSTeamsConnectedTeams{ TeamID: "", TeamName: "", ChannelConfigurations: []components.V3ExtensionsMSTeamsChannelConfiguration{ components.V3ExtensionsMSTeamsChannelConfiguration{ SquadcastTeamID: "", SquadcastTeamName: "", IsAllServices: true, Services: []components.V3ExtensionsMSTeamsSquadCastServiceMapping{ components.V3ExtensionsMSTeamsSquadCastServiceMapping{ SquadcastServiceID: "", SquadcastServiceName: "", }, }, MsteamsChannelID: "", MsteamsChannelName: "", }, }, }, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.extensions.msteams.create_or_update_config(default_conversation_name="", default_conversation_id="", is_active=False, is_default_active=False, is_custom_channels_active=True, triggers={ "all_active": False, "custom": [], }, tenant_id="", from_id="", connected_teams=[ { "team_id": "", "team_name": "", "channel_configurations": [ { "squadcast_team_id": "", "squadcast_team_name": "", "is_all_services": True, "services": [ { "squadcast_service_id": "", "squadcast_service_name": "", }, ], "msteams_channel_id": "", "msteams_channel_name": "", }, ], }, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.msteams.createOrUpdateConfiguration({ defaultConversationName: "", defaultConversationId: "", isActive: false, isDefaultActive: false, isCustomChannelsActive: true, triggers: { allActive: false, custom: [], }, tenantId: "", fromId: "", connectedTeams: [ { teamId: "", teamName: "", channelConfigurations: [ { squadcastTeamId: "", squadcastTeamName: "", isAllServices: true, services: [ { squadcastServiceId: "", squadcastServiceName: "", }, ], msteamsChannelId: "", msteamsChannelName: "", }, ], }, ], }); console.log(result); } run(); /v3/extensions/slack_v2/channel: post: operationId: "CommunicationCards_createSlackChannelInCommunicationCard" summary: "Create Slack Channel in Communication Card" parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.CommunicationCards.CommunicationCardResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Communication Card" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.CommunicationCards.CreateSlackChannelRequest" x-speakeasy-group: incidents.communicationCard x-speakeasy-name-override: createSlackChannel x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.CommunicationCards.CreateSlackChannel(ctx, components.V3IncidentsCommunicationCardsCreateSlackChannelRequest{ ChannelName: "", IncidentID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.communication_card.create_slack_channel(channel_name="", incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.communicationCards.createSlackChannel({ channelName: "", incidentId: "", }); console.log(result); } run(); /v3/extensions/slack_v2/channel/archive: post: operationId: "CommunicationCards_archiveSlackChannel" summary: "Archive Slack Channel" parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.CommunicationCards.CommunicationCardResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Communication Card" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.CommunicationCards.ArchiveSlackChannelRequest" x-speakeasy-group: incidents.communicationCard x-speakeasy-name-override: archiveSlackChannel x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.CommunicationCards.ArchiveSlackChannel(ctx, components.V3IncidentsCommunicationCardsArchiveSlackChannelRequest{ SlackChannelID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.communication_card.archive_slack_channel(slack_channel_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.archiveSlackChannel({ slackChannelId: "", }); console.log(result); } run(); /v3/global-event-rules: get: operationId: "GlobalEventRules_listGlobalEventRules" summary: "List Global Event Rules" description: "Get a list of all GERs" parameters: - name: "owner_id" in: "query" required: true schema: type: "string" - name: "page_size" in: "query" required: false schema: type: "integer" - name: "page_number" in: "query" required: false schema: type: "integer" - name: "filters.owner_id[]" in: "query" required: false schema: type: "array" items: type: "string" - name: "filters.search" in: "query" required: false schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "array" items: $ref: "#/components/schemas/V3.GlobalEventRules.GlobalEventRuleInList" meta: type: "object" properties: total_count: type: "integer" required: - "total_count" required: - "data" - "meta" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules" x-speakeasy-pagination: type: "offsetLimit" inputs: - name: "page_number" in: "parameters" type: "page" - name: "page_size" in: "parameters" type: "limit" outputs: results: "$.data" x-speakeasy-group: globalEventRules x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.List(ctx, operations.GlobalEventRulesListGlobalEventRulesRequest{ OwnerID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { for { // handle items res, err = res.Next() if err != nil { // handle error } if res == nil { break } } } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.list(owner_id="") while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.list({ ownerId: "", }); for await (const page of result) { console.log(page); } } run(); post: operationId: "GlobalEventRules_createGlobalEventRule" summary: "Create Global Event Rule" description: "Create a GER" parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.CreatedGlobalEventRuleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.GlobalEventRules.CreateGlobalEventRuleRequest" x-speakeasy-group: globalEventRules x-speakeasy-name-override: createRule x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.Create(ctx, components.V3GlobalEventRulesCreateGlobalEventRuleRequest{ Name: "", Description: "majestically effector headline dampen eek middle like shrill", OwnerID: "", EntityOwner: components.V3GlobalEventRulesEntityOwner{ ID: "", Type: components.V3GlobalEventRulesEntityOwnerTypeUser, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.create_rule(name="", description="majestically effector headline dampen eek middle like shrill", owner_id="", entity_owner={ "id": "", "type": "user", }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.create({ name: "", description: "majestically effector headline dampen eek middle like shrill", ownerId: "", entityOwner: { id: "", type: "user", }, }); console.log(result); } run(); /v3/global-event-rules/{ger_id}: delete: operationId: "GlobalEventRules_deleteGlobalEventRuleById" summary: "Delete Global Event Rule by ID" description: "Delete a GER by its ID" parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules" x-speakeasy-group: globalEventRules x-speakeasy-name-override: deleteById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.DeleteRule(ctx, 491102) if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.delete_by_id(ger_id=491102) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.deleteById({ gerId: 491102, }); console.log(result); } run(); get: operationId: "GlobalEventRules_getGlobalEventRuleById" summary: "Get Global Event Rule by ID" description: "Get a GER by its ID" parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.GlobalEventRuleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules" x-speakeasy-group: globalEventRules x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.GetByID(ctx, 292040) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.get_by_id(ger_id=292040) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.getById({ gerId: 292040, }); console.log(result); } run(); patch: operationId: "GlobalEventRules_updateGlobalEventRuleById" summary: "Update Global Event Rule by ID" description: "Update a GER by its ID" parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.GlobalEventRuleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.GlobalEventRules.UpdateGlobalEventRuleRequest" x-speakeasy-group: globalEventRules x-speakeasy-name-override: updateById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.UpdateByID(ctx, 885894, components.V3GlobalEventRulesUpdateGlobalEventRuleRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.update_by_id(ger_id=885894) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.updateById({ gerId: 885894, v3GlobalEventRulesUpdateGlobalEventRuleRequest: {}, }); console.log(result); } run(); /v3/global-event-rules/{ger_id}/rulesets: post: operationId: "GlobalEventRules_createRuleset" summary: "Create Ruleset" description: "Create a GER Ruleset." parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.RulesetResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules/Rulesets" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.GlobalEventRules.CreateRulesetRequest" x-speakeasy-group: globalEventRules.rulesets x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.Rulesets.Create(ctx, 216762, components.V3GlobalEventRulesCreateRulesetRequest{ AlertSourceShortname: "", AlertSourceVersion: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.rulesets.create(ger_id=216762, alert_source_shortname="", alert_source_version="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.rulesets.create({ gerId: 216762, v3GlobalEventRulesCreateRulesetRequest: { alertSourceShortname: "", alertSourceVersion: "", }, }); console.log(result); } run(); /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}: delete: operationId: "GlobalEventRules_deleteGerRuleset" summary: "Delete GER Ruleset" description: "Delete a GER Ruleset" parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" - name: "alert_source_version" in: "path" required: true schema: type: "string" - name: "alert_source_shortname" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules/Rulesets" x-speakeasy-group: globalEventRules.rulesets x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRulesRulesets.Delete(ctx, 198518, "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.rulesets.delete(ger_id=198518, alert_source_version="", alert_source_shortname="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.rulesets.deleteById({ gerId: 198518, alertSourceVersion: "", alertSourceShortname: "", }); console.log(result); } run(); get: operationId: "GlobalEventRules_getRuleset" summary: "Get Ruleset" description: "Get a GER Ruleset" parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" - name: "alert_source_version" in: "path" required: true schema: type: "string" - name: "alert_source_shortname" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.RulesetResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules/Rulesets" x-speakeasy-group: globalEventRules.rulesets x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.GetRuleset(ctx, 294223, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.rulesets.get(ger_id=294223, alert_source_version="", alert_source_shortname="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.rulesets.get({ gerId: 294223, alertSourceVersion: "", alertSourceShortname: "", }); console.log(result); } run(); patch: operationId: "GlobalEventRules_updateRuleset" summary: "Update Ruleset" description: "Update a GER Ruleset" parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" - name: "alert_source_version" in: "path" required: true schema: type: "string" - name: "alert_source_shortname" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.RulesetResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules/Rulesets" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.GlobalEventRules.UpdateRulesetRequest" x-speakeasy-group: globalEventRules.rulesets x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.UpdateRuleset(ctx, 489958, "", "", components.V3GlobalEventRulesUpdateRulesetRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.rulesets.update(ger_id=489958, alert_source_version="", alert_source_shortname="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.rulesets.update({ gerId: 489958, alertSourceVersion: "", alertSourceShortname: "", v3GlobalEventRulesUpdateRulesetRequest: {}, }); console.log(result); } run(); /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/priority: patch: operationId: "GlobalEventRules_reorderRuleset" summary: "Reorder Ruleset" description: "Reorder rules of a GER Ruleset" parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" - name: "alert_source_version" in: "path" required: true schema: type: "string" - name: "alert_source_shortname" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.OrderingResponse" tags: - "Global Event Rules/Rulesets" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.GlobalEventRules.ReorderRulesetRequest" x-speakeasy-group: rulesets x-speakeasy-name-override: reorder x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.Rulesets.Reorder(ctx, 572014, "", "", components.V3GlobalEventRulesReorderRulesetRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.rulesets.reorder(ger_id=572014, alert_source_version="", alert_source_shortname="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.rulesets.reorder({ gerId: 572014, alertSourceVersion: "", alertSourceShortname: "", v3GlobalEventRulesReorderRulesetRequest: {}, }); console.log(result); } run(); /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules: get: operationId: "GlobalEventRules_listRulesetRules" summary: "List Ruleset Rules" description: "Get all rules of a GER Ruleset." parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" - name: "alert_source_version" in: "path" required: true schema: type: "string" - name: "alert_source_shortname" in: "path" required: true schema: type: "string" - name: "page_size" in: "query" required: false schema: type: "integer" - name: "page_number" in: "query" required: false schema: type: "integer" - name: "filters.search" in: "query" required: false schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "array" items: $ref: "#/components/schemas/V3.GlobalEventRules.RulesetRuleResponse" meta: type: "object" properties: total_count: type: "integer" required: - "total_count" required: - "data" - "meta" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules/Rulesets/Rules" x-speakeasy-pagination: type: "offsetLimit" inputs: - name: "page_number" in: "parameters" type: "page" - name: "page_size" in: "parameters" type: "limit" outputs: results: "$.data" x-speakeasy-group: globalEventRules.rulesets.rules x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.Rulesets.ListRulesetRules(ctx, operations.GlobalEventRulesListRulesetRulesRequest{ GerID: 894010, AlertSourceVersion: "", AlertSourceShortname: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { for { // handle items res, err = res.Next() if err != nil { // handle error } if res == nil { break } } } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.rulesets.rules.list(ger_id=894010, alert_source_version="", alert_source_shortname="") while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.rulesets.listRules({ gerId: 894010, alertSourceVersion: "", alertSourceShortname: "", }); for await (const page of result) { console.log(page); } } run(); post: operationId: "GlobalEventRules_createRule" summary: "Create Rule" description: "Create a GER Ruleset Rule." parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" - name: "alert_source_version" in: "path" required: true schema: type: "string" - name: "alert_source_shortname" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.RulesetRuleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules/Rulesets/Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.GlobalEventRules.CreateOrUpdateRuleRequest" x-speakeasy-group: globalEventRules.rulesets.rules x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.Rulesets.Rules.Create(ctx, 934313, "", "", components.V3GlobalEventRulesCreateOrUpdateRuleRequest{ Description: "ha newsprint within beside scientific", Expression: "", Action: components.V3GlobalEventRulesRuleAction{ RouteTo: "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.rulesets.rules.create(ger_id=934313, alert_source_version="", alert_source_shortname="", description="ha newsprint within beside scientific", expression="", action={ "route_to": "", }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.rulesets.createRule({ gerId: 934313, alertSourceVersion: "", alertSourceShortname: "", v3GlobalEventRulesCreateOrUpdateRuleRequest: { description: "ha newsprint within beside scientific", expression: "", action: { routeTo: "", }, }, }); console.log(result); } run(); /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}: get: operationId: "GlobalEventRules_getRuleById" summary: "Get Rule by ID" description: "Get a GER Ruleset Rule by its ID." parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" - name: "alert_source_version" in: "path" required: true schema: type: "string" - name: "alert_source_shortname" in: "path" required: true schema: type: "string" - name: "rule_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.RulesetRuleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules/Rulesets/Rules" x-speakeasy-group: globalEventRules.rulesets.rules x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.Rulesets.Rules.GetByID(ctx, 518804, "", "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.rulesets.rules.get_by_id(ger_id=518804, alert_source_version="", alert_source_shortname="", rule_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.rulesets.rules.get({ gerId: 518804, alertSourceVersion: "", alertSourceShortname: "", ruleId: "", }); console.log(result); } run(); delete: operationId: "GlobalEventRules_deleteRuleById" summary: "Delete Rule by ID" description: "Delete a GER Ruleset Rule by its ID." parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" - name: "alert_source_version" in: "path" required: true schema: type: "string" - name: "alert_source_shortname" in: "path" required: true schema: type: "string" - name: "rule_id" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules/Rulesets/Rules" x-speakeasy-group: rules x-speakeasy-name-override: deleteById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRulesRulesetsRules.DeleteByID(ctx, 921538, "", "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.rules.delete_by_id(ger_id=921538, alert_source_version="", alert_source_shortname="", rule_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.rules.deleteById({ gerId: 921538, alertSourceVersion: "", alertSourceShortname: "", ruleId: "", }); console.log(result); } run(); patch: operationId: "GlobalEventRules_updateRuleById" summary: "Update Rule by ID" description: "Update a GER Ruleset Rule by its ID." parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" - name: "alert_source_version" in: "path" required: true schema: type: "string" - name: "alert_source_shortname" in: "path" required: true schema: type: "string" - name: "rule_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.RulesetRuleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules/Rulesets/Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.GlobalEventRules.UpdateRuleRequest" x-speakeasy-group: globalEventRules.rulesets.rules x-speakeasy-name-override: updateById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.UpdateRule(ctx, operations.GlobalEventRulesUpdateRuleByIDRequest{ GerID: 140241, AlertSourceVersion: "", AlertSourceShortname: "", RuleID: "", V3GlobalEventRulesUpdateRuleRequest: components.V3GlobalEventRulesUpdateRuleRequest{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.rulesets.rules.update_by_id(ger_id=140241, alert_source_version="", alert_source_shortname="", rule_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.rulesets.updateRule({ gerId: 140241, alertSourceVersion: "", alertSourceShortname: "", ruleId: "", v3GlobalEventRulesUpdateRuleRequest: {}, }); console.log(result); } run(); /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}/priority: patch: operationId: "GlobalEventRules_reorderRulesetByIndex" summary: "Reorder Ruleset By Index" description: "Reorder a GER Ruleset Rule by its index in the ruleset." parameters: - name: "ger_id" in: "path" required: true schema: type: "integer" - name: "alert_source_version" in: "path" required: true schema: type: "string" - name: "alert_source_shortname" in: "path" required: true schema: type: "string" - name: "rule_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalEventRules.OrderingResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Event Rules/Rulesets/Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.GlobalEventRules.ReorderRuleRequest" x-speakeasy-group: globalEventRules.rulesets.rules x-speakeasy-name-override: reorder x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalEventRules.Rules.ReorderByIndex(ctx, operations.GlobalEventRulesReorderRulesetByIndexRequest{ GerID: 281260, AlertSourceVersion: "", AlertSourceShortname: "", RuleID: "", V3GlobalEventRulesReorderRuleRequest: components.V3GlobalEventRulesReorderRuleRequest{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_event_rules.rulesets.rules.reorder(ger_id=281260, alert_source_version="", alert_source_shortname="", rule_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalEventRules.rulesets.rules.reorderByIndex({ gerId: 281260, alertSourceVersion: "", alertSourceShortname: "", ruleId: "", v3GlobalEventRulesReorderRuleRequest: {}, }); console.log(result); } run(); /v3/global-oncall-reminder-rules: delete: operationId: "GlobalOncallReminderRules_deleteGlobalOncallReminderRules" summary: "Delete Global Oncall Reminder Rules" description: "Delete Global Oncall Reminder Rules" parameters: - name: "owner_id" in: "query" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Oncall Reminder Rules" x-speakeasy-group: globalOncallReminderRules x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalOncallReminderRules.Delete(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_oncall_reminder_rules.delete(owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalOncallReminderRules.delete({ ownerId: "", }); console.log(result); } run(); get: operationId: "GlobalOncallReminderRules_getGlobalOncallReminderRules" summary: "Get Global Oncall Reminder Rules" description: "Get Global Oncall Reminder Rules" parameters: - name: "owner_id" in: "query" required: true description: "required *" schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalOncallReminderRules.GlobalOncallReminderRuleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Oncall Reminder Rules" x-speakeasy-group: globalOncallReminderRules x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalOncallReminderRules.List(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_oncall_reminder_rules.get(owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalOncallReminderRules.get({ ownerId: "", }); console.log(result); } run(); post: operationId: "GlobalOncallReminderRules_createGlobalOncallReminderRules" summary: "Create Global Oncall Reminder Rules" parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalOncallReminderRules.GlobalOncallReminderRuleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Oncall Reminder Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.GlobalOncallReminderRules.CreateGlobalOncallReminderRulesRequest" x-speakeasy-group: globalOncallReminderRules x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalOncallReminderRules.Create(ctx, components.V3GlobalOncallReminderRulesCreateGlobalOncallReminderRulesRequest{ IsEnabled: true, OwnerID: "", Rules: []components.V3GlobalOncallReminderRulesRule{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_oncall_reminder_rules.create(is_enabled=True, owner_id="", rules=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalOncallReminderRules.create({ isEnabled: true, ownerId: "", rules: [], }); console.log(result); } run(); put: operationId: "GlobalOncallReminderRules_updateGlobalOncallReminderRules" summary: "Update Global Oncall Reminder Rules" description: "Update Global Oncall Reminder Rules" parameters: - name: "owner_id" in: "query" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.GlobalOncallReminderRules.GlobalOncallReminderRuleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Global Oncall Reminder Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.GlobalOncallReminderRules.UpdateGlobalOncallReminderRulesRequest" x-speakeasy-group: globalOncallReminderRules x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.GlobalOncallReminderRules.Update(ctx, "", components.V3GlobalOncallReminderRulesUpdateGlobalOncallReminderRulesRequest{ IsEnabled: true, Rules: []components.V3GlobalOncallReminderRulesRule{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.global_oncall_reminder_rules.update(owner_id="", is_enabled=True, rules=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.globalOncallReminderRules.update({ ownerId: "", v3GlobalOncallReminderRulesUpdateGlobalOncallReminderRulesRequest: { isEnabled: true, rules: [], }, }); console.log(result); } run(); /v3/incidents/acknowledge: post: operationId: "Incidents_bulkAcknowledgeIncidents" summary: "Bulk Acknowledge Incidents" description: "- This endpoint is used to bulk acknowledge the incident by IDs. The API can handle a maximum of 100 incident IDs in a single request with 10 such calls per minute.\"\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.BulkIncidentIDsRequest" x-speakeasy-name-override: bulkAcknowledge x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.BulkAcknowledge(ctx, components.V3IncidentsBulkIncidentIDsRequest{ IncidentIds: []string{ "", "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.bulk_acknowledge(incident_ids=[ "", "", ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidentsV3.bulkAcknowledge({ incidentIds: [ "", "", ], }); console.log(result); } run(); /v3/incidents/export: get: operationId: "Incidents_incidentExport" summary: "Incident Export" description: "- This endpoint is used to export the incident details into a `csv` or `json` file.\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header.\n- Header field/value: `Content-Type`: `text/csv`\n\n\nQuery Params:\n\n```\ntype: csv or json\nstart_time: filter by date range\nend_time: filter by date range\nservices: filter by services\nsources: filter by alert sources\nassigned_to: filter by assignee\nstatus: filter by incident status\nslo_affecting: filetr by slo affected\nslos: filter by slos\ntags: filter by tags key=value\n\n ```" parameters: - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.start_time" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.end_time" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.type" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.owner_id" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.status" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.services" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.sources" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.assigned_to" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.assignedToUserIDsAndTheirSquads" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.service_owner" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.priority" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.tags" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.slo_affecting" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.slos" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.is_starred" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.textFilter" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.notes" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.retrospectives" - $ref: "#/components/parameters/V3.Incidents.IncidentExportRequest.sort_by" responses: "400": description: "The server could not understand the request due to invalid syntax." content: '*/*': schema: type: "object" application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: '*/*': schema: type: "object" application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" x-speakeasy-name-override: export_incidents x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/types" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Export(ctx, operations.IncidentsIncidentExportRequest{ StartTime: types.MustTimeFromString("2023-02-02T07:53:59.590Z"), EndTime: types.MustTimeFromString("2023-02-03T13:28:22.839Z"), Type: components.V3IncidentsExportFormatCsv, OwnerID: "", }) if err != nil { log.Fatal(err) } if res != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK from squadcast_sdk.utils import parse_datetime with SquadcastSDK( bearer_auth="", ) as ss_client: ss_client.incidents.export_incidents(start_time=parse_datetime("2023-02-02T07:53:59.590Z"), end_time=parse_datetime("2023-02-03T13:28:22.839Z"), type_="csv", owner_id="") # Use the SDK ... - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { await squadcastSDK.incidents.export({ startTime: new Date("2023-02-02T07:53:59.590Z"), endTime: new Date("2023-02-03T13:28:22.839Z"), type: "csv", ownerId: "", }); } run(); /v3/incidents/export/async: post: operationId: "Incidents_incidentExportAsync" summary: "Incident Export Async" description: "* This is an async API, once the request is made the export will start in our workers. You will get a download link to your registered Email ID once the export is completed\n\n\n### Payload\n\n| Key | Value | Example |\n| --- | --- | --- |\n| type | csv / json | “csv” |\n| start_time | Date in ISO Format | “2020-01-01T00:00:00.000Z” |\n| end_time | Date in ISO Format | “2020-04-01T00:00:00.000Z” |\n| owner_id | Team ID | “611262a9d5b4ea846b534a3f” |\n\n### Incident Filters\n\n| Key | Value | Example |\n| --- | --- | --- |\n| statuses | Array of triggered / resolved / acknowledged / suppressed | \\[“triggered”, “acknowleged”\\] |\n| tags | Array of tags in format “KEY=VALUE” | \\[“severity=high”, “severity=low”\\] |\n| sources | Array of Alert Source IDs | \\[“6077f7225fdc7075e371685f”\\] |\n| services | Array of Service IDs | \\[\"62385fb309bc474014180828\"\\] |\n| assigned_to | Array of Assigned to user IDs | \\[\"625e40c9a9bd76370bf9f7fb\"\\] |" parameters: [] responses: "202": description: "The request has been accepted for processing, but processing has not yet completed." content: '*/*': schema: type: "object" required: - "body" properties: body: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.IncidentExportAsyncResponse" description: "The body type of the operation request or response." description: "" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.IncidentExportAsyncRequest" x-speakeasy-group: incidents.export x-speakeasy-name-override: export_async x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "github.com/SquadcastHub/squadcast-sdk-go/types" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.ExportAsync(ctx, components.V3IncidentsIncidentExportAsyncRequest{ OwnerID: "", Type: components.V3IncidentsExportFormatCsv, StartTime: types.MustTimeFromString("2024-12-29T12:56:54.559Z"), EndTime: types.MustTimeFromString("2025-08-25T17:31:33.747Z"), IncidentFilters: components.V3IncidentsExportIncidentsFilter{ Services: []string{}, Sources: []string{}, ServiceOwner: components.V3IncidentsServiceOwnerFilter{ UserIDs: []string{ "", }, SquadIDs: []string{ "", "", "", }, }, AssignedTo: []string{ "", "", "", }, AssignedToUserIDsAndTheirSquads: []string{ "", "", }, Statuses: []string{ "", "", "", }, Priority: []components.V3IncidentsIncidentPriority{ components.V3IncidentsIncidentPriorityP5, }, Tags: []string{}, Notes: "", }, }) if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK from squadcast_sdk.utils import parse_datetime with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.export.export_async(owner_id="", type_="csv", start_time=parse_datetime("2024-12-29T12:56:54.559Z"), end_time=parse_datetime("2025-08-25T17:31:33.747Z"), incident_filters={ "services": [], "sources": [], "service_owner": { "user_i_ds": [ "", ], "squad_i_ds": [ "", "", "", ], }, "assigned_to": [ "", "", "", ], "assigned_to_user_i_ds_and_their_squads": [ "", "", ], "statuses": [ "", "", "", ], "priority": [ "P5", ], "tags": [], "notes": "", }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.exportAsync({ ownerId: "", type: "csv", startTime: new Date("2024-12-29T12:56:54.559Z"), endTime: new Date("2025-08-25T17:31:33.747Z"), incidentFilters: { services: [], sources: [], serviceOwner: { userIDs: [ "", ], squadIDs: [ "", "", "", ], }, assignedTo: [ "", "", "", ], assignedToUserIDsAndTheirSquads: [ "", "", ], statuses: [ "", "", "", ], priority: [ "P5", ], tags: [], notes: "", }, }); console.log(result); } run(); /v3/incidents/postmortem: get: operationId: "Postmortems_getAllPostmortems" summary: "Get All Postmortems" description: "* This endpoint is used to get all postmortems.\n* Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "fromDate" in: "query" required: true description: "Provide date in RFC3339 format" schema: type: "string" - name: "toDate" in: "query" required: true description: "Provide date in RFC3339 format" schema: type: "string" - name: "owner_id" in: "query" required: true description: "Here owner_id represents team_id" schema: type: "string" - name: "limit" in: "query" required: true schema: type: "integer" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "array" items: type: "object" properties: result: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemListResult" total_count: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Postmortems.TotalPostmortemCount" required: - "result" - "total_count" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Postmortems" x-speakeasy-group: postmortems x-speakeasy-name-override: getAll x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.GetAllPostmortems(ctx, "", "", "", 221553) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.postmortems.get_all(from_date="", to_date="", owner_id="", limit=221553) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.postmortems.getAll({ fromDate: "", toDate: "", ownerId: "", limit: 221553, }); console.log(result); } run(); /v3/incidents/priority: put: operationId: "Incidents_bulkIncidentsPriorityUpdate" summary: "Bulk Incidents Priority Update" description: "- This endpoint is used to bulk update incident priority.\n\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: [] responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.BulkIncidentsPriorityUpdateRequest" x-speakeasy-name-override: bulkUpdatePriority x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.BulkUpdatePriority(ctx, components.V3IncidentsBulkIncidentsPriorityUpdateRequest{ IncidentIds: []string{}, Priority: "", }) if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.bulk_update_priority(incident_ids=[], priority="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.bulkUpdatePriority({ incidentIds: [], priority: "", }); console.log(result); } run(); /v3/incidents/resolve: post: operationId: "Incidents_bulkResolveIncidents" summary: "Bulk Resolve Incidents" description: "- This endpoint is used to bulk resolve the incident by IDs. The API can handle a maximum of 100 incident IDs in a single request with 10 such calls per minute.\"\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.BulkIncidentIDsRequest" x-speakeasy-name-override: bulkResolve x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.BulkResolve(ctx, components.V3IncidentsBulkIncidentIDsRequest{ IncidentIds: []string{ "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.bulk_resolve(incident_ids=[ "", ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.bulkResolve({ incidentIds: [ "", ], }); console.log(result); } run(); /v3/incidents/{IncidentId}/communication_cards: get: operationId: "CommunicationCards_getAllCommunicationCard" summary: "Get All Communication Card" description: "* This endpoint is used to get all the communication card details for incidentId metioned in params.\n* Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "IncidentId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Incidents.CommunicationCards.CommunicationCardResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Communication Card" x-speakeasy-group: communicationCards x-speakeasy-name-override: getAll x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.CommunicationCards.GetAll(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.communication_cards.get_all(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.getAllCommunicationCards({ incidentId: "", }); console.log(result); } run(); post: operationId: "CommunicationCards_createCommunicationCard" summary: "Create Communication Card" parameters: - name: "IncidentId" in: "path" required: true description: "Required" schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.CommunicationCards.CommunicationCardResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Communication Card" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.CommunicationCards.CreateCommunicationCardRequest" x-speakeasy-group: incidents.communicationCards x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.CommunicationCards.Create(ctx, "", components.V3IncidentsCommunicationCardsCreateCommunicationCardRequest{ Type: "", URL: "https://oily-injunction.info", Title: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.communication_cards.create(incident_id="", type_="", url="https://oily-injunction.info", title="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.communicationCards.create({ incidentId: "", v3IncidentsCommunicationCardsCreateCommunicationCardRequest: { type: "", url: "https://oily-injunction.info", title: "", }, }); console.log(result); } run(); /v3/incidents/{IncidentId}/communication_cards/{communicationCardId}: delete: operationId: "CommunicationCards_deleteCommunicationCard" summary: "Delete Communication Card" description: "Delete communication card by providing communicationCardId for incidentId mentioned in params\n\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `service-write` scope." parameters: - name: "IncidentId" in: "path" required: true description: "Required" schema: type: "string" - name: "communicationCardId" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Communication Card" x-speakeasy-group: incidents.communicationCards x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.CommunicationCards.Delete(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.communication_cards.delete(incident_id="", communication_card_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.communicationCards.delete({ incidentId: "", communicationCardId: "", }); console.log(result); } run(); put: operationId: "CommunicationCards_updateCommunicationCard" summary: "Update Communication Card" parameters: - name: "IncidentId" in: "path" required: true description: "Required" schema: type: "string" - name: "communicationCardId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.CommunicationCards.CommunicationCardResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Communication Card" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.CommunicationCards.UpdateCommunicationCardRequest" x-speakeasy-group: incidents.communicationCards x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.CommunicationCard.Update(ctx, "", "", components.V3IncidentsCommunicationCardsUpdateCommunicationCardRequest{ Title: "", Type: "", URL: "https://major-cantaloupe.com/", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.communication_cards.update(incident_id="", communication_card_id="", title="", type_="", url="https://major-cantaloupe.com/") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.updateCommunicationCard({ incidentId: "", communicationCardId: "", v3IncidentsCommunicationCardsUpdateCommunicationCardRequest: { title: "", type: "", url: "https://major-cantaloupe.com/", }, }); console.log(result); } run(); /v3/incidents/{IncidentId}/runbooks: post: operationId: "Runbooks_attachRunbooks" summary: "Attach Runbooks" parameters: - name: "IncidentId" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Runbooks.RunbookResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Runbooks" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.Runbooks.AttachRunbooksRequest" x-speakeasy-group: runbooks x-speakeasy-name-override: attach x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Runbooks.Attach(ctx, "", components.V3IncidentsRunbooksAttachRunbooksRequest{ Runbooks: []string{ "", "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.runbooks.attach(incident_id="", runbooks=[ "", "", ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.attachRunbooks({ incidentId: "", v3IncidentsRunbooksAttachRunbooksRequest: { runbooks: [ "", "", ], }, }); console.log(result); } run(); /v3/incidents/{IncidentId}/tags: put: operationId: "Tags_updateTag" summary: "Update Tag" parameters: - name: "IncidentId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.Tags.IncidentForTagsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Tags" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.Tags.UpdateTagRequest" x-speakeasy-group: incidents.tags x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Tags.Update(ctx, "", components.V3IncidentsTagsUpdateTagRequest{ Tags: components.V3IncidentsTagsUpdateTagRequestTags{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.tags.update(incident_id="", tags={}) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.tags.update({ incidentId: "", v3IncidentsTagsUpdateTagRequest: { tags: {}, }, }); console.log(result); } run(); patch: operationId: "Tags_appendTag" summary: "Append Tag" parameters: - name: "IncidentId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.Tags.IncidentForTagsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Tags" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.Tags.AppendTagRequest" x-speakeasy-group: incidents.tags x-speakeasy-name-override: append x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Tags.Append(ctx, "", components.V3IncidentsTagsAppendTagRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.tags.append(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.tags.append({ incidentId: "", v3IncidentsTagsAppendTagRequest: {}, }); console.log(result); } run(); /v3/incidents/{IncidentId}/warroom: post: operationId: "Notes_createNotes" summary: "Create Notes" parameters: - name: "IncidentId" in: "path" required: true description: "Required" schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "body" properties: body: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.Notes.NoteResponse" description: "The body type of the operation request or response." description: "" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Notes" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.Notes.CreateNoteRequest" x-speakeasy-group: incidents.notes x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Notes.Create(ctx, "", components.V3IncidentsNotesCreateNoteRequest{ Message: "", Attachments: []string{ "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.notes.create(incident_id="", message="", attachments=[ "", ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.notes.create({ incidentId: "", v3IncidentsNotesCreateNoteRequest: { message: "", attachments: [ "", ], }, }); console.log(result); } run(); get: operationId: "Notes_getAllNotes" summary: "Get All Notes" description: "* This endpoint is used to get all the note details of incidentID mentioned params.\n* Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "IncidentId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Notes.NoteResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Notes" x-speakeasy-group: incidents.notes x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Notes.List(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.notes.list(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.notes.list({ incidentId: "", }); console.log(result); } run(); /v3/incidents/{IncidentId}/warroom/{NoteId}: delete: operationId: "Notes_deleteNote" summary: "Delete Note" description: "delete note from incidentId mentioned in params.\n\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `service-write` scope." parameters: - name: "IncidentId" in: "path" required: true description: "Required" schema: type: "string" - name: "NoteId" in: "path" required: true description: "Required" schema: type: "string" - name: "authorization" in: "header" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Notes" x-speakeasy-group: incidents.notes x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Notes.Delete(ctx, "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.notes.delete(incident_id="", note_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.notes.delete({ incidentId: "", noteId: "", }); console.log(result); } run(); put: operationId: "Notes_updateNote" summary: "Update Note" description: "This API can be used to update a Note or a Resolution reason associated with an incident" parameters: - name: "IncidentId" in: "path" required: true description: "Required" schema: type: "string" - name: "NoteId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.Notes.NoteResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Notes" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.Notes.UpdateNoteRequest" x-speakeasy-group: incidents.notes x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Notes.Update(ctx, "", "", components.V3IncidentsNotesUpdateNoteRequest{ Message: "", Attachments: []string{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.notes.update(incident_id="", note_id="", message="", attachments=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.notes.update({ incidentId: "", noteId: "", v3IncidentsNotesUpdateNoteRequest: { message: "", attachments: [], }, }); console.log(result); } run(); /v3/incidents/{incidentID}: get: operationId: "Incidents_getIncidentById" summary: "Get Incident by ID" description: "- This endpoint is used to get the incident details by ID.\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.IncidentResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.get_by_id(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.getById({ incidentID: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/acknowledge: post: operationId: "Incidents_acknowledgeIncident" summary: "Acknowledge Incident" description: "- This endpoint is used to acknowledge the incident by ID.\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" x-speakeasy-name-override: acknowledge x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Acknowledge(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.acknowledge(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.acknowledge({ incidentID: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/actions/circleci/rebuild/{buildNumber}: post: operationId: "IncidentActions_rebuildAProjectInCircleci" summary: "Rebuild a Project In CircleCI" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" - name: "buildNumber" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: $ref: "#/components/schemas/V3.Incidents.IncidentActions.CircleCIRebuildResponse" meta: type: "object" properties: status_code: type: "integer" required: - "status_code" required: - "data" "400": description: "Represents a CircleCI error response for a 400 status code." content: application/json: schema: anyOf: - type: "object" properties: meta: $ref: "#/components/schemas/V3.Incidents.IncidentActions.CircleCIErrorMeta" required: - "meta" - type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Incident Actions" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.IncidentActions.RebuildCircleCIProjectRequest" x-speakeasy-group: incidents.actions x-speakeasy-name-override: rebuildCircleciProject x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.IncidentActions.Circleci.Rebuild(ctx, "", "", components.V3IncidentsIncidentActionsRebuildCircleCIProjectRequest{ VcsType: "", Username: "Dora.Waelchi", Reponame: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.actions.rebuild_circleci_project(incident_id="", build_number="", vcs_type="", username="Dora.Waelchi", reponame="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidentActions.circleci.rebuild({ incidentID: "", buildNumber: "", v3IncidentsIncidentActionsRebuildCircleCIProjectRequest: { vcsType: "", username: "Dora.Waelchi", reponame: "", }, }); console.log(result); } run(); /v3/incidents/{incidentID}/actions/jira/new/jira-cloud: post: operationId: "IncidentActions_createATicketOnJiraCloud" summary: "Create a Ticket on Jira Cloud" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Incident Actions" x-speakeasy-group: incidents.actions.jira x-speakeasy-name-override: createTicket x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Actions.CreateJiraCloudTicket(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.actions.jira.create_ticket(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.actions.jiraCloud.createTicket({ incidentID: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/actions/jira/new/jira-server: post: operationId: "IncidentActions_createATicketOnJiraServer" summary: "Create a Ticket on Jira Server" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Incident Actions" x-speakeasy-group: incidents.incidentActions x-speakeasy-name-override: createJiraTicket x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Actions.CreateJiraServerTicket(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.incident_actions.create_jira_ticket(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.createJiraServerTicket({ incidentID: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/actions/servicenow/new: post: operationId: "IncidentActions_createAnIncidentInServicenow" summary: "Create an Incident in ServiceNow" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Incident Actions" x-speakeasy-group: incidents.actions.serviceNow x-speakeasy-name-override: createIncident x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Actions.CreateInServicenow(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.actions.service_now.create_incident(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.createInServiceNow({ incidentID: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/actions/webhook/{eventWebhookID}: post: operationId: "IncidentActions_triggerAWebhookManually" summary: "Trigger a Webhook Manually" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" - name: "eventWebhookID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.IncidentActions.WebhookActionResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Incident Actions" x-speakeasy-group: incidents.actions.webhook x-speakeasy-name-override: trigger x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Actions.Webhook.TriggerManually(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.actions.webhook.trigger(incident_id="", event_webhook_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.triggerWebhook({ incidentID: "", eventWebhookID: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/additional-responders: get: operationId: "AdditionalResponders_getAdditionalResponders" summary: "Get Additional Responders" description: "- This endpoint is used to get the incident additional responders.\n\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.AdditionalResponders.AdditionalResponderResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Additional Responders" x-speakeasy-group: incidents.additionalResponders x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.AdditionalResponders.Get(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.additional_responders.list(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.getAdditionalResponders({ incidentID: "", }); console.log(result); } run(); put: operationId: "AdditionalResponders_addAdditionalResponders" summary: "Add Additional Responders" description: "- This endpoint is used to add additional responders to an Incident.\n\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.AdditionalResponders.AdditionalResponderResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Additional Responders" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.AdditionalResponders.AddAdditionalRespondersRequest" x-speakeasy-group: incidents.additionalResponders x-speakeasy-name-override: add x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.AdditionalResponders.Add(ctx, "", components.V3IncidentsAdditionalRespondersAddAdditionalRespondersRequest{ AdditionalResponders: []components.AdditionalResponder{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.additional_responders.add(incident_id="", additional_responders=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.additionalResponders.add({ incidentID: "", v3IncidentsAdditionalRespondersAddAdditionalRespondersRequest: { additionalResponders: [], }, }); console.log(result); } run(); /v3/incidents/{incidentID}/additional-responders/{responderID}: delete: operationId: "AdditionalResponders_removeAdditionalResponders" summary: "Remove Additional Responders" description: "- This endpoint is used to remove an additional responder from an Incident.\n\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" - name: "responderID" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Additional Responders" x-speakeasy-group: additionalResponders x-speakeasy-name-override: remove x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.AdditionalResponders.Delete(ctx, "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.additional_responders.remove(incident_id="", responder_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.removeAdditionalResponder({ incidentID: "", responderID: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/events: get: operationId: "Incidents_getIncidentEvents" summary: "Get Incident Events" description: "- This endpoint is used to get all the deduped incident events details by either ID or number.\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header.\n\nQuery Params:\n```\noffset - non zero value\nlimit - non zero value, maximum is 10\nsort - sort it by either asc or desc\ndeduped - if set to true, it will return only the deduplicated events. if set to false, it will return only the non-deduplicated event, otherwise it will return all the events\n```" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" - name: "offset" in: "query" required: true description: "non zero value" schema: type: "string" - name: "limit" in: "query" required: true description: "non zero value, maximum is 10" schema: type: "string" - name: "sort" in: "query" required: true description: "sort it by either asc or desc" schema: type: "string" - name: "deduped" in: "query" required: true description: "if set to true, it will return only the deduped events.\n\nif set to false, it will return only the non-deduped event.\n\notherwise it will return all the events" schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: events: type: "array" items: $ref: "#/components/schemas/V3.Incidents.IncidentEventResponse" required: - "events" meta: type: "object" properties: total: type: "integer" count: type: "integer" current: type: "string" next: type: "string" required: - "total" - "count" - "current" required: - "data" - "meta" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" x-speakeasy-group: incidents.events x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Events.List(ctx, operations.IncidentsGetIncidentEventsRequest{ IncidentID: "", Offset: "", Limit: "", Sort: "", Deduped: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.events.get(incident_id="", offset="", limit="", sort="", deduped="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.events.list({ incidentID: "", offset: "", limit: "", sort: "", deduped: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/mark-as-non-transient: put: operationId: "Apta_markAsNotTransient" summary: "Mark as Not Transient" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.Apta.MessageResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Auto Pause Transient Alerts (APTA)" x-speakeasy-group: incidents.autoPauseTransientAlerts x-speakeasy-name-override: markAsNotTransient x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.AutoPauseTransientAlerts.MarkAsNotTransient(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.auto_pause_transient_alerts.mark_as_not_transient(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.autoPauseTransientAlerts.markAsNotTransient({ incidentID: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/mark-as-transient: put: operationId: "Apta_markAsTransient" summary: "Mark as Transient" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.Apta.MessageResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Auto Pause Transient Alerts (APTA)" x-speakeasy-group: incidents.autoPauseTransientAlerts x-speakeasy-name-override: markAsTransient x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.MarkAsTransient(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.auto_pause_transient_alerts.mark_as_transient(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.markAsTransient({ incidentID: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/mark-slo-incident-false-postive/{value}: patch: operationId: "Incidents_markIncidentSloFalsePositive" summary: "Mark Incident SLO False Positive" description: "- This endpoint is used to mark incident slo false positive.\n\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" - name: "value" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" x-speakeasy-name-override: markSloFalsePositive x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.MarkSloFalsePositive(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.mark_slo_false_positive(incident_id="", value="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.markSloFalsePositive({ incidentID: "", value: "", }); console.log(result); } run(); /v3/incidents/{incidentID}/postmortem: delete: operationId: "Postmortems_deletePostmortemByIncident" summary: "Delete Postmortem By Incident" description: "* This endpoint is used to delete a postmortem by incident.\n* Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Postmortems" x-speakeasy-group: incidents.postmortems x-speakeasy-name-override: remove x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Postmortems.DeleteByIncident(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.postmortems.remove(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.postmortems.deleteByIncident({ incidentID: "", }); console.log(result); } run(); get: operationId: "Postmortems_getPostmortemByIncident" summary: "Get Postmortem By Incident" description: "* This endpoint is used to get a postmortem by incident.\n* Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Postmortems" x-speakeasy-group: incidents.postmortems x-speakeasy-name-override: getByIncident x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Postmortems.GetByIncident(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.postmortems.get_by_incident(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.postmortems.getByIncident({ incidentID: "", }); console.log(result); } run(); post: operationId: "Postmortems_createPostmortem" summary: "Create Postmortem" description: "* This endpoint is used to create a postmortem.\n* Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "body" properties: body: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemResponse" description: "The body type of the operation request or response." description: "" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Postmortems" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.Postmortems.CreatePostmortemRequest" x-speakeasy-group: postmortems x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Postmortems.Create(ctx, "", components.V3IncidentsPostmortemsCreatePostmortemRequest{ OwnerID: "", Title: "", Postmortem: "", Status: components.V3IncidentsPostmortemsPostmortemStatusPublished, FollowUps: []components.V3IncidentsPostmortemsPostmortemFollowUp{}, Attachments: []components.V3IncidentsPostmortemsPostmortemAttachmentRequest{ components.V3IncidentsPostmortemsPostmortemAttachmentRequest{}, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.postmortems.create(incident_id="", owner_id="", title="", postmortem="", status="published", follow_ups=[], attachments=[ {}, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.postmortems.create({ incidentID: "", v3IncidentsPostmortemsCreatePostmortemRequest: { ownerId: "", title: "", postmortem: "", status: "published", followUps: [], attachments: [ {}, ], }, }); console.log(result); } run(); put: operationId: "Postmortems_updatePostmortemByIncident" summary: "Update Postmortem By Incident" description: "- This endpoint is used to update a postmortem by incident.\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Postmortems" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.Postmortems.UpdatePostmortemRequest" x-speakeasy-group: incidents.postmortems x-speakeasy-name-override: updateByIncident x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.UpdatePostmortem(ctx, "", components.V3IncidentsPostmortemsUpdatePostmortemRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.postmortems.update_by_incident(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.updatePostmortem({ incidentID: "", v3IncidentsPostmortemsUpdatePostmortemRequest: {}, }); console.log(result); } run(); /v3/incidents/{incidentID}/priority: patch: operationId: "Incidents_incidentPriorityUpdate" summary: "Incident Priority Update" description: "- This endpoint is used to update incident priority by ID.\n\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header." parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.IncidentPriorityUpdateResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.IncidentPriorityUpdateRequest" x-speakeasy-name-override: updatePriority x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.UpdatePriority(ctx, "", components.V3IncidentsIncidentPriorityUpdateRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.update_priority(incident_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.updatePriority({ incidentID: "", v3IncidentsIncidentPriorityUpdateRequest: {}, }); console.log(result); } run(); /v3/incidents/{incidentID}/reassign: post: operationId: "Incidents_reassignIncident" summary: "Reassign Incident" description: "- This endpoint is used to reassign the unresolved incident to any user or escalation policy or squads by ID.\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header.\n- `type` can be either `user` or `escalationpolicy` or `squad`" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.ReassignIncidentRequest" x-speakeasy-name-override: reassign x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Reassign(ctx, "", components.V3IncidentsReassignIncidentRequest{ ReassignTo: components.ReassignTo{ ID: "", Type: "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.reassign(incident_id="", reassign_to={ "id": "", "type": "", }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.reassign({ incidentID: "", v3IncidentsReassignIncidentRequest: { reassignTo: { id: "", type: "", }, }, }); console.log(result); } run(); /v3/incidents/{incidentID}/resolve: post: operationId: "Incidents_resolveIncident" summary: "Resolve Incident" description: "- This endpoint is used to resolve the incident by ID.\n\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header.\n\n- Resolution Reason is mandatory / optional based on the organization feature settings (Only for Premium and Enterprise Orgs) [Read more](https://support.squadcast.com/incidents-page/incidents-details#understanding-resolution-reason)" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.ResolveIncidentRequest" x-speakeasy-name-override: resolve x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.Resolve(ctx, "", components.V3IncidentsResolveIncidentRequest{ ResolutionReason: components.ResolutionReason{ Message: "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.resolve(incident_id="", resolution_reason={ "message": "", }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.resolve({ incidentID: "", v3IncidentsResolveIncidentRequest: { resolutionReason: { message: "", }, }, }); console.log(result); } run(); /v3/incidents/{incidentID}/snooze: put: operationId: "SnoozeNotifications_snoozeIncidentNotifications" summary: "Snooze Incident Notifications" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.SnoozeNotifications.SnoozeIncidentResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Snooze Notifications" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.SnoozeNotifications.SnoozeIncidentRequest" x-speakeasy-group: snoozeNotifications x-speakeasy-name-override: snooze x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.SnoozeNotifications.Snooze(ctx, "", components.V3IncidentsSnoozeNotificationsSnoozeIncidentRequest{ SnoozeDurationInMins: 42279, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.snooze_notifications.snooze(incident_id="", snooze_duration_in_mins=42279) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.snooze.set({ incidentID: "", v3IncidentsSnoozeNotificationsSnoozeIncidentRequest: { snoozeDurationInMins: 42279, }, }); console.log(result); } run(); /v3/incidents/{incidentID}/unsnooze: put: operationId: "SnoozeNotifications_unsnoozeIncidentNotifications" summary: "Unsnooze Incident Notifications" parameters: - name: "incidentID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Incidents.SnoozeNotifications.UnsnoozeIncidentResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents/Snooze Notifications" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.SnoozeNotifications.UnsnoozeIncidentRequest" x-speakeasy-group: incidents.snoozeNotifications x-speakeasy-name-override: unsnooze x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.UnsnoozeNotifications(ctx, "", components.V3IncidentsSnoozeNotificationsUnsnoozeIncidentRequest{ ReassignTo: components.V3IncidentsSnoozeNotificationsReassignTo{ ID: "", Type: "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.snooze_notifications.unsnooze(incident_id="", reassign_to={ "id": "", "type": "", }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.unsnoozeNotifications({ incidentID: "", v3IncidentsSnoozeNotificationsUnsnoozeIncidentRequest: { reassignTo: { id: "", type: "", }, }, }); console.log(result); } run(); /v3/refresh-token: get: operationId: "Users_getAllTokens" summary: "Get All Tokens" description: "Returns generated api tokens of all the users of the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Users.ApiTokenResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users/Api Token" x-speakeasy-group: users.apiTokens x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.APITokens.List(ctx) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.api_tokens.list() # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.users.getAllTokens(); console.log(result); } run(); post: operationId: "Users_createToken" summary: "Create Token" description: "Generates refresh token for a user of the organization. Returns the refresh token object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Users.ApiTokenResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users/Api Token" requestBody: required: true content: application/json: schema: type: "object" properties: user_id: type: "string" required: - "user_id" x-speakeasy-group: users.apiTokens x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Tokens.CreateUserToken(ctx, operations.UsersCreateTokenRequest{ UserID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.api_tokens.create(user_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.tokens.create({ userId: "", }); console.log(result); } run(); /v3/refresh-token/{refreshTokenID}: delete: operationId: "Users_removeToken" summary: "Remove Token" description: "Removes refresh token of a user from organization. Upon success the refresh token of a user will be removed from the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "refreshTokenID" in: "path" required: true description: "(Required) refresh token id" schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users/Api Token" x-speakeasy-group: users.apiToken x-speakeasy-name-override: remove x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Users.APIToken.Remove(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.api_token.remove(refresh_token_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.users.removeToken({ refreshTokenID: "", }); console.log(result); } run(); /v3/requests/status: post: operationId: "Incidents_getIncidentsStatusByRequestids" summary: "Get Incidents Status By RequestIDs" description: "- This endpoint is used to get the status of incidents given list of request_ids\n- Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header.\n\n# Response\n- The response contains the mapping from `request_ids` to incident status.\n- `status` field can be one of - `suppressed`, `discarded`, `deduplicated`, `created`, `error`.\n- status is `error` if the `request_id` is invalid. Both `incident_id` and `event_id` field won't be present if `status` is `error`\n- status is `suppressed` if the incident was suppressed due to suppression rules.\n- status is `deduplicated` if the incident was deduplicated due to deduplication rules.\n- status is `discarded` if the incident was discarded due to some deduplication rule. `incident_id` field won't be present if `status` is `discarded`.\n- otherwise, the status is `created`" parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: requests_status: type: "object" unevaluatedProperties: $ref: "#/components/schemas/V3.Incidents.IndividualRequestStatusResponse" meta: type: "object" properties: error_count: type: "integer" success_count: type: "integer" required: - "error_count" - "success_count" required: - "requests_status" - "meta" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Incidents" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Incidents.IngestionStatusRequest" x-speakeasy-name-override: getStatusByRequestIds x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Incidents.GetStatusByRequestIds(ctx, components.V3IncidentsIngestionStatusRequest{ RequestIds: []string{ "", "", "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.incidents.get_status_by_request_ids(request_ids=[ "", "", "", ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.incidents.getStatusByRequestIds({ requestIds: [ "", "", "", ], }); console.log(result); } run(); /v3/runbooks: get: operationId: "Runbooks_getAllRunbooksByTeam" summary: "Get All Runbooks By Team" description: "Returns all the runbooks of the team.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Runbooks.RunbookResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Runbooks" x-speakeasy-name-override: getAllByTeam x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Runbooks.ListByTeam(ctx) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.runbooks.get_all_by_team() # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.runbooks.listByTeam(); console.log(result); } run(); post: operationId: "Runbooks_createRunbook" summary: "Create Runbook" description: "Add runbook to the team. Returns the runbook object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Runbooks.RunbookResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Runbooks" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Runbooks.CreateRunbookRequest" x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Runbooks.Create(ctx, components.V3RunbooksCreateRunbookRequest{ Name: "", Steps: []components.V3RunbooksStep{ components.V3RunbooksStep{ Content: "", }, }, OwnerID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.runbooks.create(name="", steps=[ { "content": "", }, ], owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.runbooks.create({ name: "", steps: [ { content: "", }, ], ownerId: "", }); console.log(result); } run(); /v3/runbooks/{runbookID}: delete: operationId: "Runbooks_removeRunbook" summary: "Remove Runbook" description: "Remove runbook from team.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "runbookID" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Runbooks" x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Runbooks.Remove(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.runbooks.delete(runbook_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.runbooks.remove({ runbookID: "", }); console.log(result); } run(); get: operationId: "Runbooks_getRunbookById" summary: "Get Runbook By ID" description: "Returns a runbook details of the given `runbookID` in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "runbookID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Runbooks.RunbookResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Runbooks" x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Runbooks.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.runbooks.get_by_id(runbook_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.runbooks.getById({ runbookID: "", }); console.log(result); } run(); put: operationId: "Runbooks_updateRunbook" summary: "Update Runbook" description: "Update runbook details.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "runbookID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Runbooks.RunbookResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Runbooks" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Runbooks.UpdateRunbookRequest" x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Runbooks.Update(ctx, "", components.V3RunbooksUpdateRunbookRequest{ Name: "", Steps: []components.V3RunbooksStep{ components.V3RunbooksStep{ Content: "", }, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.runbooks.update(runbook_id="", name="", steps=[ { "content": "", }, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.runbooks.update({ runbookID: "", v3RunbooksUpdateRunbookRequest: { name: "", steps: [ { content: "", }, ], }, }); console.log(result); } run(); /v3/services: get: operationId: "Services_getServices" summary: "Get All Services" parameters: - name: "owner_id" in: "query" required: true schema: type: "string" explode: false - name: "entity_owner" in: "query" required: false schema: type: "string" explode: false - name: "name" in: "query" required: false schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Services.ServiceResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services" x-speakeasy-name-override: getAll x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.List(ctx, "", nil, nil) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.get_all(owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.list({ ownerId: "", }); console.log(result); } run(); post: operationId: "Services_createService" summary: "Create Service" parameters: - name: "owner_id" in: "query" required: true schema: type: "string" explode: false responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "body" properties: body: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.ServiceResponse" description: "The body type of the operation request or response." description: "" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.CreateServiceRequest" x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Create(ctx, "", components.V3ServicesCreateServiceRequest{ Name: "", EscalationPolicyID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.create(owner_id="", name="", escalation_policy_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.create({ ownerId: "", v3ServicesCreateServiceRequest: { name: "", escalationPolicyId: "", }, }); console.log(result); } run(); /v3/services/by-name: get: operationId: "Services_getServicesByName" summary: "Get Services By Name" parameters: - name: "name" in: "query" required: true schema: type: "string" explode: false - name: "owner_id" in: "query" required: true schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.ServiceResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services" x-speakeasy-name-override: getByName x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.GetByName(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.get_by_name(name="", owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.listByName({ name: "", ownerId: "", }); console.log(result); } run(); /v3/services/{serviceID}: get: operationId: "Services_getServiceById" summary: "Get Service By ID" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.ServiceResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services" x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.get_by_id(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.getById({ serviceID: "", }); console.log(result); } run(); put: operationId: "Services_updateService" summary: "Update Service" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.ServiceResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.UpdateServiceRequest" x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Update(ctx, "", components.V3ServicesUpdateServiceRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.update(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.update({ serviceID: "", v3ServicesUpdateServiceRequest: {}, }); console.log(result); } run(); delete: operationId: "Services_deleteService" summary: "Delete Service" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services" x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Delete(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.delete(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.delete({ serviceID: "", }); console.log(result); } run(); /v3/services/{serviceID}/apta-config: put: operationId: "Services_createOrUpdateAPTAConfig" summary: "Auto Pause Transient Alerts (APTA)" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: msg: type: "string" required: - "msg" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.APTAConfigRequest" x-speakeasy-name-override: updateAptaConfig x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.CreateOrUpdateAptaConfig(ctx, "", components.V3ServicesAPTAConfigRequest{ IsEnabled: false, TimeoutInMins: 680029, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.update_apta_config(service_id="", is_enabled=False, timeout_in_mins=680029) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.aptaConfig.createOrUpdate({ serviceID: "", v3ServicesAPTAConfigRequest: { isEnabled: false, timeoutInMins: 680029, }, }); console.log(result); } run(); /v3/services/{serviceID}/config: get: operationId: "Overlay_getOptinForKeyBasedDeduplicationForAService" summary: "Get Opt-in for Key Based Deduplication for a service" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "object" properties: dedup_key_enabled: type: "boolean" required: - "dedup_key_enabled" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay" x-speakeasy-group: services.overlay x-speakeasy-name-override: getOptinForKeyBasedDeduplication x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Overlay.GetKeyBasedDeduplicationOptin(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.overlay.get_optin_for_key_based_deduplication(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.overlay.getOptinForKeyBasedDeduplication({ serviceID: "", }); console.log(result); } run(); patch: operationId: "Overlay_optinForKeyBasedDeduplicationForAService" summary: "Opt-in for Key Based Deduplication for a service" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.Overlay.OptInForKeyBasedDeduplicationRequest" x-speakeasy-group: services.overlay x-speakeasy-name-override: optinForKeyBasedDeduplication x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Overlay.OptInForKeyBasedDeduplication(ctx, "", components.V3ServicesOverlayOptInForKeyBasedDeduplicationRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.overlay.optin_for_key_based_deduplication(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.overlays.optinKeyBasedDeduplication({ serviceID: "", v3ServicesOverlayOptInForKeyBasedDeduplicationRequest: {}, }); console.log(result); } run(); /v3/services/{serviceID}/deduplication-rules: get: operationId: "DeduplicationRules_getDeduplicationRules" summary: "Get Deduplication Rules" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.DeduplicationRules.DeduplicationRuleResponse" required: - "rules" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Deduplication Rules" x-speakeasy-group: services.deduplicationRules x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.DeduplicationRules.Get(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.deduplication_rules.get(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.deduplicationRules.getRules({ serviceID: "", }); console.log(result); } run(); post: operationId: "DeduplicationRules_createOrUpdateDeduplicationRules" summary: "Create or Update Deduplication Rules" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" properties: data: type: "object" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.DeduplicationRules.DeduplicationRuleResponse" required: - "rules" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Deduplication Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.DeduplicationRules.CreateDeduplicationRulesRequest" x-speakeasy-group: services.deduplicationRules x-speakeasy-name-override: createOrUpdate x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.DeduplicationRules.CreateOrUpdate(ctx, "", components.V3ServicesDeduplicationRulesCreateDeduplicationRulesRequest{ Rules: []components.V3ServicesDeduplicationRulesDeduplicationRule{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.deduplication_rules.create_or_update(service_id="", rules=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.deduplicationRules.createOrUpdate({ serviceID: "", v3ServicesDeduplicationRulesCreateDeduplicationRulesRequest: { rules: [], }, }); console.log(result); } run(); /v3/services/{serviceID}/dependencies: post: operationId: "Dependencies_createOrUpdateDependencies" summary: "Create or Update Dependencies" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" properties: data: type: "object" properties: ok: type: "boolean" required: - "ok" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Dependencies" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.Dependencies.CreateOrUpdateDependenciesRequest" x-speakeasy-group: services.dependencies x-speakeasy-name-override: createOrUpdate x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.CreateOrUpdateDependencies(ctx, "", components.V3ServicesDependenciesCreateOrUpdateDependenciesRequest{ Dependencies: []string{ "", "", "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.dependencies.create_or_update(service_id="", dependencies=[ "", "", "", ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.dependencies.createOrUpdate({ serviceID: "", v3ServicesDependenciesCreateOrUpdateDependenciesRequest: { dependencies: [ "", "", "", ], }, }); console.log(result); } run(); /v3/services/{serviceID}/extensions: put: operationId: "Extensions_updateSlackExtension" summary: "Update Slack Extension" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.Extensions.SlackExtensionResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Extensions" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.Extensions.UpdateSlackExtensionRequest" x-speakeasy-group: services.extensions x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Extensions.UpdateSlack(ctx, "", components.V3ServicesExtensionsUpdateSlackExtensionRequest{ ChannelID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.extensions.update(service_id="", channel_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.updateSlackExtension({ serviceID: "", v3ServicesExtensionsUpdateSlackExtensionRequest: { channelId: "", }, }); console.log(result); } run(); /v3/services/{serviceID}/iag-config: put: operationId: "Services_createOrUpdateIAGConfig" summary: "Intelligent Alert Grouping (IAG)" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: msg: type: "string" required: - "msg" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.IAGConfigRequest" x-speakeasy-name-override: createOrUpdateIagConfig x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.UpsertIagConfig(ctx, "", components.V3ServicesIAGConfigRequest{ IsEnabled: true, RollingWindowInMins: 246036, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.create_or_update_iag_config(service_id="", is_enabled=True, rolling_window_in_mins=246036) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.createOrUpdateIAGConfig({ serviceID: "", v3ServicesIAGConfigRequest: { isEnabled: true, rollingWindowInMins: 246036, }, }); console.log(result); } run(); /v3/services/{serviceID}/maintenance: get: operationId: "MaintenanceMode_getMaintenanceMode" summary: "Get Maintenance Mode" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Services.MaintenanceMode.MaintenanceModeResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Maintenance Mode" x-speakeasy-group: services.maintenanceMode x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.MaintenanceMode.Get(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.maintenance_mode.get(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.maintenance.get({ serviceID: "", }); console.log(result); } run(); post: operationId: "MaintenanceMode_createOrUpdateMaintenanceMode" summary: "Create or Update Maintenance Mode" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Maintenance Mode" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.MaintenanceMode.CreateOrUpdateMaintenanceModeRequest" x-speakeasy-group: services.maintenance x-speakeasy-name-override: createOrUpdate x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.MaintenanceMode.CreateOrUpdate(ctx, "", components.V3ServicesMaintenanceModeCreateOrUpdateMaintenanceModeRequest{ OnMaintenance: true, ServiceMaintenance: []components.V3ServicesMaintenanceModeServiceMaintenance{ components.V3ServicesMaintenanceModeServiceMaintenance{ MaintenanceStartDate: "", Daily: false, Weekly: true, TwoWeekly: false, ThreeWeekly: true, Monthly: true, Deleted: false, RepeatTill: "", }, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.maintenance.create_or_update(service_id="", on_maintenance=True, service_maintenance=[ { "maintenance_start_date": "", "daily": False, "weekly": True, "two_weekly": False, "three_weekly": True, "monthly": True, "deleted": False, "repeat_till": "", }, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.maintenance.createOrUpdate({ serviceID: "", v3ServicesMaintenanceModeCreateOrUpdateMaintenanceModeRequest: { onMaintenance: true, serviceMaintenance: [ { maintenanceStartDate: "", daily: false, weekly: true, twoWeekly: false, threeWeekly: true, monthly: true, deleted: false, repeatTill: "", }, ], }, }); console.log(result); } run(); /v3/services/{serviceID}/notification-delay-config: put: operationId: "Services_delayedNotificationConfig" summary: "Delayed Notification Config" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.ServiceResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.NotificationDelayConfigRequest" x-speakeasy-name-override: updateNotificationDelayConfig x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.UpdateNotificationDelayConfig(ctx, "", components.V3ServicesNotificationDelayConfigRequest{ IsEnabled: false, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.update_notification_delay_config(service_id="", is_enabled=False) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.updateNotificationDelayConfig({ serviceID: "", v3ServicesNotificationDelayConfigRequest: { isEnabled: false, }, }); console.log(result); } run(); /v3/services/{serviceID}/overlays/custom-content: get: operationId: "Overlay_getAllCustomContentTemplateOverlayByService" summary: "Get All Custom Content Template Overlay by Service" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: false schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Services.Overlay.CustomContentOverlayResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay/Custom Content Templates" x-speakeasy-group: services.overlay.customContentTemplates x-speakeasy-name-override: getAll x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Overlays.GetCustomContentTemplates(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.overlay.custom_content_templates.get_all(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.getCustomContentTemplates({ serviceID: "", }); console.log(result); } run(); /v3/services/{serviceID}/overlays/custom-content/render: post: operationId: "Overlay_renderCustomContentOverlay" summary: "Render Custom Content Overlay" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay/Custom Content Templates" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.Overlay.RenderCustomContentOverlayRequest" x-speakeasy-group: services.overlays.customContentTemplates x-speakeasy-name-override: render x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Overlays.CustomContent.Render(ctx, "", components.V3ServicesOverlayRenderCustomContentOverlayRequest{ OverlayTemplateType: "", Template: "", Payload: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.overlays.custom_content_templates.render(service_id="", overlay_template_type="", template="", payload="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.overlays.renderCustomContent({ serviceID: "", v3ServicesOverlayRenderCustomContentOverlayRequest: { overlayTemplateType: "", template: "", payload: "", }, }); console.log(result); } run(); /v3/services/{serviceID}/overlays/custom-content/{alertSource}: delete: operationId: "Overlay_deleteNotificationTemplateOverlay" summary: "Delete Notification Template Overlay" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "alertSource" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: false schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay/Custom Content Templates" x-speakeasy-group: services.overlays.customContentTemplates x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Overlays.DeleteNotificationTemplate(ctx, "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.overlays.custom_content_templates.delete(service_id="", alert_source="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.overlays.deleteCustomContent({ serviceID: "", alertSource: "", }); console.log(result); } run(); get: operationId: "Overlay_getCustomContentTemplateOverlay" summary: "Get Custom Content Template Overlay" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "alertSource" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: false schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.Overlay.CustomContentOverlayResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay/Custom Content Templates" x-speakeasy-group: services.overlays.customContentTemplates x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Overlays.GetCustomContent(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.overlays.custom_content_templates.get(service_id="", alert_source="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.overlays.getCustomContentTemplate({ serviceID: "", alertSource: "", }); console.log(result); } run(); put: operationId: "Overlay_createOrUpdateNotificationTemplateOverlay" summary: "Create or Update Notification Template Overlay" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "alertSource" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.Overlay.CustomContentOverlayResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay/Custom Content Templates" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.Overlay.UpdateCustomContentTemplateOverlayRequest" x-speakeasy-group: services.overlay.customContentTemplates x-speakeasy-name-override: createOrUpdate x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.CreateOrUpdateNotificationTemplateOverlay(ctx, "", "", components.V3ServicesOverlayUpdateCustomContentTemplateOverlayRequest{ OverlayTemplateType: "", MessageOverlay: components.MessageOverlay{ Template: "", }, DescriptionOverlay: components.DescriptionOverlay{ Template: "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.overlay.custom_content_templates.create_or_update(service_id="", alert_source="", overlay_template_type="", message_overlay={ "template": "", }, description_overlay={ "template": "", }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.overlays.customContent.createOrUpdate({ serviceID: "", alertSource: "", v3ServicesOverlayUpdateCustomContentTemplateOverlayRequest: { overlayTemplateType: "", messageOverlay: { template: "", }, descriptionOverlay: { template: "", }, }, }); console.log(result); } run(); /v3/services/{serviceID}/overlays/dedup-key: get: operationId: "Overlay_getAllDedupKeyOverlayByService" summary: "Get All Dedup Key Overlay by Service" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: false schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Services.Overlay.OverlayResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay/Dedup Key Overlay" x-speakeasy-group: dedupKeys x-speakeasy-name-override: listByService x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.GetAllDedupKeyOverlays(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.dedup_keys.list_by_service(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.overlays.getAllDedupKeysByService({ serviceID: "", }); console.log(result); } run(); /v3/services/{serviceID}/overlays/dedup-key/render: post: operationId: "Overlay_renderDedupKeyTemplate" summary: "Render Dedup Key template" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay/Dedup Key Overlay" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.Overlay.RenderDedupKeyTemplateRequest" x-speakeasy-group: services.overlays x-speakeasy-name-override: renderDedupKey x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Overlays.DedupKey.Render(ctx, "", components.V3ServicesOverlayRenderDedupKeyTemplateRequest{ OverlayTemplateType: "", Template: "", Payload: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.overlays.render_dedup_key(service_id="", overlay_template_type="", template="", payload="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.dedupKeyOverlays.renderTemplate({ serviceID: "", v3ServicesOverlayRenderDedupKeyTemplateRequest: { overlayTemplateType: "", template: "", payload: "", }, }); console.log(result); } run(); /v3/services/{serviceID}/overlays/dedup-key/{alertSource}: delete: operationId: "Overlay_deleteDedupKeyOverlay" summary: "Delete Dedup Key Overlay" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "alertSource" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: false schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay/Dedup Key Overlay" x-speakeasy-group: dedupKeys x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Overlays.DedupKey.Delete(ctx, "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.dedup_keys.delete(service_id="", alert_source="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.overlays.dedupKey.delete({ serviceID: "", alertSource: "", }); console.log(result); } run(); get: operationId: "Overlay_getDedupKeyOverlayForAlertSource" summary: "Get Dedup Key Overlay for Alert Source" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "alertSource" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: false schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.Overlay.OverlayResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay/Dedup Key Overlay" x-speakeasy-group: overlays.dedupKey x-speakeasy-name-override: getForAlertSource x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.Overlays.GetDedupKey(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.overlays.dedup_key.get_for_alert_source(service_id="", alert_source="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.dedupKeyOverlays.getForAlertSource({ serviceID: "", alertSource: "", }); console.log(result); } run(); put: operationId: "Overlay_updateDedupKeyOverlay" summary: "Update Dedup Key Overlay" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "alertSource" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: anyOf: - type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.Overlay.OverlayResponse" - type: "object" properties: data: $ref: "#/components/schemas/V3.Services.Overlay.OverlayResponse" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Overlay/Dedup Key Overlay" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.Overlay.UpdateDedupKeyOverlayRequest" x-speakeasy-group: services.overlays.dedupKey x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.UpdateDedupKeyOverlay(ctx, "", "", components.V3ServicesOverlayUpdateDedupKeyOverlayRequest{ OverlayTemplateType: "", DedupKeyOverlay: components.DedupKeyOverlay{ Template: "", Duration: 360400, }, }) if err != nil { log.Fatal(err) } if res.OneOf != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.overlays.dedup_key.update(service_id="", alert_source="", overlay_template_type="", dedup_key_overlay={ "template": "", "duration": 360400, }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.dedupKeyOverlays.update({ serviceID: "", alertSource: "", v3ServicesOverlayUpdateDedupKeyOverlayRequest: { overlayTemplateType: "", dedupKeyOverlay: { template: "", duration: 360400, }, }, }); console.log(result); } run(); /v3/services/{serviceID}/routing-rules: get: operationId: "RoutingRules_getRoutingRules" summary: "Get Routing Rules" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" - name: "authorization" in: "header" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.RoutingRules.RoutingRuleResponse" required: - "rules" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Routing Rules" x-speakeasy-group: services.routingRules x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.GetRoutingRules(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.routing_rules.get(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.routingRules.get({ serviceID: "", }); console.log(result); } run(); post: operationId: "RoutingRules_createOrUpdateRoutingRules" summary: "Create or Update Routing Rules" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" properties: data: type: "object" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.RoutingRules.RoutingRuleResponse" required: - "rules" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Routing Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.RoutingRules.CreateOrUpdateRoutingRulesRequest" x-speakeasy-group: services.routingRules x-speakeasy-name-override: createOrUpdate x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.RoutingRules.CreateOrUpdate(ctx, "", components.V3ServicesRoutingRulesCreateOrUpdateRoutingRulesRequest{ Rules: []components.V3ServicesRoutingRulesRoutingRule{ components.V3ServicesRoutingRulesRoutingRule{ Expression: "", RouteTo: components.V3ServicesRoutingRulesRoutingRuleRouteTo{ EntityType: components.V3ServicesRoutingRulesRoutingRuleEntityTypeEscalationPolicy, EntityID: "", }, IsBasic: false, }, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.routing_rules.create_or_update(service_id="", rules=[ { "expression": "", "route_to": { "entity_type": "escalation_policy", "entity_id": "", }, "is_basic": False, }, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.routingRules.createOrUpdate({ serviceID: "", v3ServicesRoutingRulesCreateOrUpdateRoutingRulesRequest: { rules: [ { expression: "", routeTo: { entityType: "escalation_policy", entityId: "", }, isBasic: false, }, ], }, }); console.log(result); } run(); /v3/services/{serviceID}/suppression-rules: get: operationId: "SuppressionRules_getSuppressionRules" summary: "Get Suppression Rules" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.SuppressionRules.SuppressionRuleResponse" required: - "rules" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Suppression Rules" x-speakeasy-group: services.suppressionRules x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.SuppressionRules.Get(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.suppression_rules.get(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.suppressionRules.list({ serviceID: "", }); console.log(result); } run(); post: operationId: "SuppressionRules_createOrUpdateSuppressionRules" summary: "Create or Update Suppression Rules" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Services.SuppressionRules.SuppressionRulesContainerResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Suppression Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.SuppressionRules.CreateOrUpdateSuppressionRulesRequest" x-speakeasy-group: services.suppressionRules x-speakeasy-name-override: createOrUpdate x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.CreateOrUpdateSuppressionRules(ctx, "", components.V3ServicesSuppressionRulesCreateOrUpdateSuppressionRulesRequest{ Rules: []components.V3ServicesSuppressionRulesSuppressionRule{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.suppression_rules.create_or_update(service_id="", rules=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.suppressionRules.createOrUpdate({ serviceID: "", v3ServicesSuppressionRulesCreateOrUpdateSuppressionRulesRequest: { rules: [], }, }); console.log(result); } run(); /v3/services/{serviceID}/tagging-rules: get: operationId: "TaggingRules_getTaggingRules" summary: "Get Tagging Rules" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.TaggingRules.TaggingRuleResponse" required: - "rules" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Tagging Rules" x-speakeasy-group: services.taggingRules x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.TaggingRules.Get(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.tagging_rules.get(service_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.taggingRules.list({ serviceID: "", }); console.log(result); } run(); post: operationId: "TaggingRules_createOrUpdateTaggingRules" summary: "Create or Update Tagging Rules" parameters: - name: "serviceID" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" properties: data: type: "object" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.TaggingRules.TaggingRuleResponse" required: - "rules" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Services/Tagging Rules" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Services.TaggingRules.CreateOrUpdateTaggingRulesRequest" x-speakeasy-group: services.taggingRules x-speakeasy-name-override: createOrUpdate x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Services.CreateOrUpdateTaggingRules(ctx, "", components.V3ServicesTaggingRulesCreateOrUpdateTaggingRulesRequest{ Rules: []components.V3ServicesTaggingRulesTagRule{ components.V3ServicesTaggingRulesTagRule{}, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.services.tagging_rules.create_or_update(service_id="", rules=[ {}, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.services.taggingRules.createOrUpdate({ serviceID: "", v3ServicesTaggingRulesCreateOrUpdateTaggingRulesRequest: { rules: [ {}, ], }, }); console.log(result); } run(); /v3/slo: get: operationId: "SLO_getAllSLOs" summary: "Get All SLOs" description: "Returns all the SLOs of the passed owner_id in the params.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "owner_id" in: "query" required: true schema: type: "string" - name: "offset" in: "query" required: true schema: type: "string" - name: "limit" in: "query" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: meta: type: "object" properties: total: type: "integer" offset: type: "integer" limit: type: "integer" required: - "total" - "offset" - "limit" slos: type: "array" items: $ref: "#/components/schemas/V3.SLO.SLO" required: - "meta" - "slos" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "SLOs" x-speakeasy-group: slos x-speakeasy-name-override: listAll x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Slos.ListAll(ctx, "", "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.slos.list_all(owner_id="", offset="", limit="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.slos.list({ ownerId: "", offset: "", limit: "", }); console.log(result); } run(); post: operationId: "SLO_createSLO" summary: "Create SLO" description: "- This API will create SLO.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" properties: data: type: "object" properties: slo: $ref: "#/components/schemas/V3.SLO.SLODetailedResponse" required: - "slo" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "SLOs" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.SLO.CreateSLORequest" x-speakeasy-group: slos x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "github.com/SquadcastHub/squadcast-sdk-go/types" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Slos.Create(ctx, components.V3SLOCreateSLORequest{ Name: "", TimeIntervalType: components.V3SLOTimeIntervalTypeRolling, ServiceIds: []string{ "", }, Slis: []string{}, TargetSlo: 6924.37, StartTime: types.MustTimeFromString("2023-06-03T10:41:05.981Z"), EndTime: types.MustTimeFromString("2023-11-20T07:09:22.422Z"), DurationInDays: 574042, OwnerType: "", OwnerID: "", SloOwnerID: "", SloOwnerType: components.V3SLOSLOOwnerTypeSquad, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK from squadcast_sdk.utils import parse_datetime with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.slos.create(name="", time_interval_type="rolling", service_ids=[ "", ], slis=[], target_slo=6924.37, start_time=parse_datetime("2023-06-03T10:41:05.981Z"), end_time=parse_datetime("2023-11-20T07:09:22.422Z"), duration_in_days=574042, owner_type="", owner_id="", slo_owner_id="", slo_owner_type="squad") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.slos.create({ name: "", timeIntervalType: "rolling", serviceIds: [ "", ], slis: [], targetSlo: 6924.37, startTime: new Date("2023-06-03T10:41:05.981Z"), endTime: new Date("2023-11-20T07:09:22.422Z"), durationInDays: 574042, ownerType: "", ownerId: "", sloOwnerId: "", sloOwnerType: "squad", }); console.log(result); } run(); /v3/slo/{sloID}: put: operationId: "SLO_updateSLO" summary: "Update SLO" description: "- This API will update SLO.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "sloID" in: "path" required: true schema: type: "integer" - name: "owner_id" in: "query" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: slo: $ref: "#/components/schemas/V3.SLO.SLODetailedResponse" required: - "slo" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "SLOs" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.SLO.CreateSLORequest" x-speakeasy-group: slos x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "github.com/SquadcastHub/squadcast-sdk-go/types" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Slos.Update(ctx, 16112, "", components.V3SLOCreateSLORequest{ Name: "", TimeIntervalType: components.V3SLOTimeIntervalTypeRolling, ServiceIds: []string{ "", "", "", }, Slis: []string{ "", }, TargetSlo: 2464.03, StartTime: types.MustTimeFromString("2025-10-31T03:29:37.701Z"), EndTime: types.MustTimeFromString("2024-03-30T19:04:36.297Z"), DurationInDays: 271064, OwnerType: "", OwnerID: "", SloOwnerID: "", SloOwnerType: components.V3SLOSLOOwnerTypeUser, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK from squadcast_sdk.utils import parse_datetime with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.slos.update(slo_id=16112, owner_id_param="", name="", time_interval_type="rolling", service_ids=[ "", "", "", ], slis=[ "", ], target_slo=2464.03, start_time=parse_datetime("2025-10-31T03:29:37.701Z"), end_time=parse_datetime("2024-03-30T19:04:36.297Z"), duration_in_days=271064, owner_type="", owner_id="", slo_owner_id="", slo_owner_type="user") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.slos.update({ sloID: 16112, ownerId: "", v3SLOCreateSLORequest: { name: "", timeIntervalType: "rolling", serviceIds: [ "", "", "", ], slis: [ "", ], targetSlo: 2464.03, startTime: new Date("2025-10-31T03:29:37.701Z"), endTime: new Date("2024-03-30T19:04:36.297Z"), durationInDays: 271064, ownerType: "", ownerId: "", sloOwnerId: "", sloOwnerType: "user", }, }); console.log(result); } run(); delete: operationId: "SLO_removeSLO" summary: "Remove SLO" description: "Remove SLO from passed owner_id (team_id) in the params . Upon sccess the slo will be removed.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "sloID" in: "path" required: true schema: type: "integer" - name: "owner_id" in: "query" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.SLO.SLOResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "SLOs" x-speakeasy-group: slos x-speakeasy-name-override: remove x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Slos.Remove(ctx, 938544, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.slos.remove(slo_id=938544, owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.slos.remove({ sloID: 938544, ownerId: "", }); console.log(result); } run(); get: operationId: "SLO_getSLOById" summary: "Get SLO By ID" description: "Returns a SLO details of the given `sloID` in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "sloID" in: "path" required: true schema: type: "integer" - name: "owner_id" in: "query" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.SLO.SLOWithInsightsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "SLOs" x-speakeasy-group: slos x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Slos.GetByID(ctx, 586718, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.slos.get(slo_id=586718, owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.slos.getById({ sloID: 586718, ownerId: "", }); console.log(result); } run(); /v3/slo/{sloID}/incident: post: operationId: "SLO_markSLOAffected" summary: "Mark SLO Affected" description: "This endpoint is used for mark slo affected.\n\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "sloID" in: "path" required: true schema: type: "integer" - name: "owner_id" in: "query" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" properties: data: type: "object" properties: slo_violating_incident: $ref: "#/components/schemas/V3.SLO.SLOViolatingIncidentResponse" required: - "slo_violating_incident" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "SLOs" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.SLO.MarkSLOAffectedRequest" x-speakeasy-group: slos x-speakeasy-name-override: markAffected x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Slos.MarkAffected(ctx, 294670, "", components.V3SLOMarkSLOAffectedRequest{ IncidentID: "", Slis: []string{ "", "", }, ErrorBudgetSpent: 3480.26, OwnerType: "", OwnerID: "", OrgID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.slos.mark_affected(slo_id=294670, owner_id_param="", incident_id="", slis=[ "", "", ], error_budget_spent=3480.26, owner_type="", owner_id="", org_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.slo.markAffected({ sloID: 294670, ownerId: "", v3SLOMarkSLOAffectedRequest: { incidentId: "", slis: [ "", "", ], errorBudgetSpent: 3480.26, ownerType: "", ownerId: "", orgId: "", }, }); console.log(result); } run(); /v3/slo/{sloID}/incident/{incidentID}/false-positive/{value}: patch: operationId: "SLO_markSLOFalsePositive" summary: "Mark SLO False Positive" description: "Value is a boolean (true or false)" parameters: - name: "sloID" in: "path" required: true schema: type: "integer" - name: "incidentID" in: "path" required: true schema: type: "integer" - name: "value" in: "path" required: true schema: type: "boolean" - name: "owner_id" in: "query" required: true schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: slo_violating_incident: $ref: "#/components/schemas/V3.SLO.SLOViolatingIncidentResponse" required: - "slo_violating_incident" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "SLOs" requestBody: required: true content: application/json: schema: type: "object" x-speakeasy-group: slos.falsePositive x-speakeasy-name-override: mark x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Slos.MarkFalsePositive(ctx, operations.SLOMarkSLOFalsePositiveRequest{ SloID: 825843, IncidentID: 505067, Value: true, OwnerID: "", RequestBody: operations.SLOMarkSLOFalsePositiveRequestBody{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.slos.false_positive.mark(slo_id=825843, incident_id=505067, value=True, owner_id="", request_body={}) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.slos.markFalsePositive({ sloID: 825843, incidentID: 505067, value: true, ownerId: "", requestBody: {}, }); console.log(result); } run(); /v3/teams: get: operationId: "Teams_getAllTeams" summary: "Get All Teams" description: "Returns all the teams of the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Teams.TeamResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" x-speakeasy-name-override: getAll x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.GetAll(ctx) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.get_all() # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.list(); console.log(result); } run(); post: operationId: "Teams_createTeam" summary: "Create Team" description: "Add team to the organization. Returns the team object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Teams.TeamResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Teams.CreateTeamRequest" x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.Create(ctx, components.V3TeamsCreateTeamRequest{ Name: "", MemberIds: []string{ "", "", }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.create(name="", member_ids=[ "", "", ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.create({ name: "", memberIds: [ "", "", ], }); console.log(result); } run(); /v3/teams/{teamId}: get: operationId: "Teams_getTeamById" summary: "Get Team By ID" description: "Returns a team details of the given `teamID` in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Teams.TeamResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.get(team_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.getById({ teamId: "", }); console.log(result); } run(); put: operationId: "Teams_updateTeam" summary: "Update Team" description: "Update organization team details.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Teams.TeamResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Teams.UpdateTeamRequest" x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.Update(ctx, "", components.V3TeamsUpdateTeamRequest{ Members: []components.V3TeamsUpdateTeamRequestMember{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.update(team_id="", members=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.update({ teamId: "", v3TeamsUpdateTeamRequest: { members: [], }, }); console.log(result); } run(); delete: operationId: "Teams_removeTeam" summary: "Remove Team" description: "Remove team from the organization. Upon success, the team will be removed from the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" x-speakeasy-name-override: remove x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.Delete(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.remove(team_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.remove({ teamId: "", }); console.log(result); } run(); /v3/teams/{teamId}/members: get: operationId: "Teams_getAllTeamMembers" summary: "Get All Team Members" description: "Returns all the team members of the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Teams.TeamMemberResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" x-speakeasy-group: teams.members x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.Members.GetAll(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.members.list(team_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.listMembers({ teamId: "", }); console.log(result); } run(); post: operationId: "Teams_addTeamMember" summary: "Add Team Member" description: "Add team member to the team.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Teams.TeamMemberResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Teams.AddTeamMemberRequest" x-speakeasy-group: teams.members x-speakeasy-name-override: add x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.AddMember(ctx, "", components.V3TeamsAddTeamMemberRequest{ UserID: "", RoleIds: []string{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.members.add(team_id="", user_id="", role_ids=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.members.add({ teamId: "", v3TeamsAddTeamMemberRequest: { userId: "", roleIds: [], }, }); console.log(result); } run(); /v3/teams/{teamId}/members/bulk: post: operationId: "Teams_addBulkTeamMember" summary: "Add Bulk Team Member" description: "Add team member to the team.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "object" properties: team_id: type: "string" members: type: "array" items: type: "object" properties: user_id: type: "string" role_ids: type: "array" items: type: "string" required: - "team_id" - "members" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Teams.AddBulkTeamMemberRequest" x-speakeasy-name-override: addBulkMember x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.AddBulkMember(ctx, "", components.V3TeamsAddBulkTeamMemberRequest{ Members: []components.V3TeamsAddBulkTeamMemberRequestMember{ components.V3TeamsAddBulkTeamMemberRequestMember{ UserID: "", RoleIds: []string{ "", "", }, }, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.add_bulk_member(team_id="", members=[ { "user_id": "", "role_ids": [ "", "", ], }, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.members.bulkAdd({ teamId: "", v3TeamsAddBulkTeamMemberRequest: { members: [ { userId: "", roleIds: [ "", "", ], }, ], }, }); console.log(result); } run(); /v3/teams/{teamId}/members/{memberId}: delete: operationId: "Teams_removeTeamMember" summary: "Remove Team Member" description: "Remove team member from the team. Upon success, the team member will be removed from the team.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" - name: "memberId" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" x-speakeasy-name-override: removeMember x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.RemoveMember(ctx, "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.remove_member(team_id="", member_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.members.remove({ teamId: "", memberId: "", }); console.log(result); } run(); patch: operationId: "Teams_updateTeamMember" summary: "Update Team Member" description: "Update team member.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" - name: "memberId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Teams.TeamMemberResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Teams.UpdateTeamMemberRequest" x-speakeasy-name-override: updateMember x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.UpdateMember(ctx, "", "", components.V3TeamsUpdateTeamMemberRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.update_member(team_id="", member_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.members.update({ teamId: "", memberId: "", v3TeamsUpdateTeamMemberRequest: {}, }); console.log(result); } run(); /v3/teams/{teamId}/roles: get: operationId: "Teams_getAllTeamRoles" summary: "Get All Team Roles" description: "Returns all the roles of the teamId mentioned in params.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Teams.TeamRoleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" x-speakeasy-group: teams.roles x-speakeasy-name-override: getAll x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.GetAllRoles(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.roles.get_all(team_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.getRoles({ teamId: "", }); console.log(result); } run(); post: operationId: "Teams_createTeamRole" summary: "Create Team Role" description: "Add team's role to the team with given ability if not exists. Returns the role object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Teams.TeamBaseResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Teams.CreateTeamRoleRequest" x-speakeasy-group: teams.roles x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.CreateRole(ctx, "", components.V3TeamsCreateTeamRoleRequest{ Name: "", Abilities: components.V3TeamsAbilities{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.roles.create(team_id="", name="", abilities={}) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.roles.create({ teamId: "", v3TeamsCreateTeamRoleRequest: { name: "", abilities: {}, }, }); console.log(result); } run(); /v3/teams/{teamId}/roles/{roleId}: delete: operationId: "Teams_removeTeamRole" summary: "Remove Team Role" description: "Remove team's role from the team. Upon success, the team's role will be removed from the team.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" - name: "roleId" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" x-speakeasy-name-override: removeRole x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.RemoveRole(ctx, "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.remove_role(team_id="", role_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.roles.remove({ teamId: "", roleId: "", }); console.log(result); } run(); put: operationId: "Teams_updateTeamRole" summary: "Update Team Role" description: "Update team's role abilities and name.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "teamId" in: "path" required: true schema: type: "string" - name: "roleId" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Teams.TeamBaseResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Teams" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Teams.UpdateTeamRoleRequest" x-speakeasy-group: teams.roles x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Teams.UpdateRole(ctx, "", "", components.V3TeamsUpdateTeamRoleRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.teams.roles.update(team_id="", role_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.teams.roles.update({ teamId: "", roleId: "", v3TeamsUpdateTeamRoleRequest: {}, }); console.log(result); } run(); /v3/users: get: operationId: "Users_getAllUsers" summary: "Get All Users" description: "Returns all the users of the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Users.UserResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users" x-speakeasy-name-override: getAll x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Users.GetAll(ctx) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.get_all() # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.users.list(); console.log(result); } run(); post: operationId: "Users_addUser" summary: "Add User" description: "Add user to the organization with given role if not exists. Returns the user object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Users.UserResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Users.AddUserRequest" x-speakeasy-name-override: add x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Users.Add(ctx, components.V3UsersAddUserRequest{ Email: "Clovis_Reynolds@hotmail.com", Role: components.V3UsersAddUserRequestRoleAccountOwner, FirstName: "Yvonne", LastName: "Kozey", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.add(email="Clovis_Reynolds@hotmail.com", role="account_owner", first_name="Yvonne", last_name="Kozey") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.users.add({ email: "Clovis_Reynolds@hotmail.com", role: "account_owner", firstName: "Yvonne", lastName: "Kozey", }); console.log(result); } run(); /v3/users/abilities: put: operationId: "Users_updateOrgLevelPermissions" summary: "Update Org Level Permissions" parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "string" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Users.UpdateUserAbilitiesRequest" x-speakeasy-name-override: updateOrgLevelPermissions x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Users.UpdateOrgLevelPermissions(ctx, components.V3UsersUpdateUserAbilitiesRequest{ Data: []components.V3UsersUpdateUserAbilitiesRequestData{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.update_org_level_permissions(data=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.users.updateOrgLevelPermissions({ data: [], }); console.log(result); } run(); /v3/users/delete-user: put: operationId: "Users_deleteUser" summary: "Delete User" description: "This API replaces the swap_user for all the entities in Squadcast with user_id provided and deletes the user." parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users" requestBody: required: true content: application/json: schema: type: "object" properties: user_id: type: "string" swap_user_id: type: "string" suppress_incidents: type: "boolean" reassign_incidents: type: "boolean" required: - "user_id" - "swap_user_id" - "suppress_incidents" - "reassign_incidents" x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Users.Delete(ctx, operations.UsersDeleteUserRequest{ UserID: "", SwapUserID: "", SuppressIncidents: true, ReassignIncidents: true, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.delete(user_id="", swap_user_id="", suppress_incidents=True, reassign_incidents=True) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.users.delete({ userId: "", swapUserId: "", suppressIncidents: true, reassignIncidents: true, }); console.log(result); } run(); /v3/users/roles: get: operationId: "Users_getUserRoles" summary: "Get User Roles" description: "Returns all available user roles.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Users.UserRoleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users" x-speakeasy-name-override: getRoles x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Users.GetRoles(ctx) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.get_roles() # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.users.getRoles(); console.log(result); } run(); /v3/users/{userID}: delete: operationId: "Users_removeUserFromOrg" summary: "Remove User From Org" description: "Remove user from organization. Upon sccess the user will be removed from the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "userID" in: "path" required: true description: "(Required) user id" schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users" x-speakeasy-name-override: removeFromOrg x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Users.RemoveFromOrg(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.remove_from_org(user_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.users.removeFromOrg({ userID: "", }); console.log(result); } run(); get: operationId: "Users_getUserById" summary: "Get User By ID" description: "Returns a users details of the given `userID` in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "userID" in: "path" required: true description: "(Required) user id" schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Users.UserResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users" x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Users.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.get_by_id(user_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.users.getById({ userID: "", }); console.log(result); } run(); put: operationId: "Users_updateUserByID" summary: "Update User by userID" description: "Update User by userID.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "userID" in: "path" required: true description: "(Required) user id" schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Users.UserResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Users" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Users.UpdateUserRequest" x-speakeasy-name-override: updateById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Users.Update(ctx, "", components.V3UsersUpdateUserRequest{ Role: components.V3UsersUpdateUserRequestRoleUser, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.users.update_by_id(user_id="", role="user") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.users.updateById({ userID: "", v3UsersUpdateUserRequest: { role: "user", }, }); console.log(result); } run(); /v3/webform: get: operationId: "Webforms_getAllWebforms" summary: "Get All Webforms" description: "Returns all webforms of the given `owner_id` (teamId) in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "owner_id" in: "query" required: true schema: type: "string" explode: false - name: "page_number" in: "query" required: false schema: type: "integer" - name: "page_size" in: "query" required: false schema: type: "integer" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Webforms.WebformResponse" meta: type: "object" properties: total_count: type: "integer" format: "int32" required: - "total_count" required: - "data" - "meta" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Webforms" x-speakeasy-pagination: type: "offsetLimit" inputs: - name: "page_number" in: "parameters" type: "page" - name: "page_size" in: "parameters" type: "limit" outputs: results: "$.data" x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Webforms.GetAll(ctx, "", nil, nil) if err != nil { log.Fatal(err) } if res.Object != nil { for { // handle items res, err = res.Next() if err != nil { // handle error } if res == nil { break } } } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.webforms.list(owner_id="") while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.webforms.getAll({ ownerId: "", }); for await (const page of result) { console.log(page); } } run(); post: operationId: "Webforms_createWebform" summary: "Create Webform" description: "Add a webform to the organization. Returns the webform object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" properties: data: type: "object" properties: webform: $ref: "#/components/schemas/V3.Webforms.WebformResponse" required: - "webform" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Webforms" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Webforms.CreateOrUpdateWebformRequest" x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Webforms.Create(ctx, components.V3WebformsCreateOrUpdateWebformRequest{ OwnerID: "", Name: "", IsCname: false, IsCaptchaEnabled: false, CaptchaSecret: components.V3WebformsRecaptchaSecrets{ SiteKey: "", Secret: "", }, FormOwnerType: "", FormOwnerID: "", Services: []components.V3WebformsWFService{}, Header: "", Title: "", FooterText: "", FooterLink: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.webforms.create(owner_id="", name="", is_cname=False, is_captcha_enabled=False, captcha_secret={ "site_key": "", "secret": "", }, form_owner_type="", form_owner_id="", services=[], header="", title="", footer_text="", footer_link="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.webforms.create({ ownerId: "", name: "", isCname: false, isCaptchaEnabled: false, captchaSecret: { siteKey: "", secret: "", }, formOwnerType: "", formOwnerId: "", services: [], header: "", title: "", footerText: "", footerLink: "", }); console.log(result); } run(); /v3/webform/{webformId}: put: operationId: "Webforms_updateWebform" summary: "Update Webform" description: "Update a webform to the organization. Returns the webform object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "webformId" in: "path" required: true schema: type: "integer" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Webforms.WebformResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Webforms" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Webforms.CreateOrUpdateWebformRequest" x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Webforms.Update(ctx, 926692, components.V3WebformsCreateOrUpdateWebformRequest{ OwnerID: "", Name: "", IsCname: true, IsCaptchaEnabled: true, CaptchaSecret: components.V3WebformsRecaptchaSecrets{ SiteKey: "", Secret: "", }, FormOwnerType: "", FormOwnerID: "", Services: []components.V3WebformsWFService{ components.V3WebformsWFService{ ServiceID: "", Name: "", Alias: "", }, }, Header: "", Title: "", FooterText: "", FooterLink: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.webforms.update(webform_id=926692, owner_id="", name="", is_cname=True, is_captcha_enabled=True, captcha_secret={ "site_key": "", "secret": "", }, form_owner_type="", form_owner_id="", services=[ { "service_id": "", "name": "", "alias": "", }, ], header="", title="", footer_text="", footer_link="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.webforms.update({ webformId: 926692, v3WebformsCreateOrUpdateWebformRequest: { ownerId: "", name: "", isCname: true, isCaptchaEnabled: true, captchaSecret: { siteKey: "", secret: "", }, formOwnerType: "", formOwnerId: "", services: [ { serviceId: "", name: "", alias: "", }, ], header: "", title: "", footerText: "", footerLink: "", }, }); console.log(result); } run(); delete: operationId: "Webforms_removeWebform" summary: "Remove Webform" description: "Remove a webform from the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope." parameters: - name: "webformId" in: "path" required: true schema: type: "integer" - name: "owner_id" in: "query" required: true schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "string" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Webforms" x-speakeasy-name-override: remove x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Webforms.Remove(ctx, 842504, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.webforms.remove(webform_id=842504, owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.webforms.remove({ webformId: 842504, ownerId: "", }); console.log(result); } run(); get: operationId: "Webforms_getWebformById" summary: "Get Webform By ID" description: "Returns a webform details of the given `webformId` in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope." parameters: - name: "webformId" in: "path" required: true schema: type: "integer" - name: "owner_id" in: "query" required: true schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Webforms.WebformResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Webforms" x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Webforms.Get(ctx, 831002, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.webforms.get_by_id(webform_id=831002, owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.webforms.getById({ webformId: 831002, ownerId: "", }); console.log(result); } run(); /v3/workflows: get: operationId: "Workflows_listWorkflows" summary: "List Workflows" description: "Get a list of all Workflows" parameters: - name: "owner_id" in: "query" required: true schema: type: "string" explode: false - name: "page_size" in: "query" required: false schema: type: "integer" explode: false - name: "page_number" in: "query" required: false schema: type: "integer" explode: false - name: "search" in: "query" required: false schema: type: "string" explode: false - name: "event" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "actions" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "tags" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "owner" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "created_by" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "updated_by" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "enabled" in: "query" required: false schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.ListWorkflowAPIResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" x-speakeasy-pagination: type: "offsetLimit" inputs: - name: "page_number" in: "parameters" type: "page" - name: "page_size" in: "parameters" type: "limit" outputs: results: "$.data" x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.List(ctx, operations.WorkflowsListWorkflowsRequest{ OwnerID: "", }) if err != nil { log.Fatal(err) } if res.V3WorkflowsListWorkflowAPIResponse != nil { for { // handle items res, err = res.Next() if err != nil { // handle error } if res == nil { break } } } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.list(owner_id="") while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.list({ ownerId: "", }); for await (const page of result) { console.log(page); } } run(); post: operationId: "Workflows_createWorkflow" summary: "Create Workflow" description: "Create a Workflow" parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Workflows.WorkflowAPIResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.CreateWorkflowRequest" x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.Create(ctx, components.V3WorkflowsCreateWorkflowRequest{ Title: "", OwnerID: "", Trigger: components.V3WorkflowsWorkflowTriggerIncidentAcknowledged, Filters: components.V3WorkflowsCreateWorkflowFilter{}, Actions: []components.V3WorkflowsActionRequest{ components.CreateV3WorkflowsActionRequestV3WorkflowsSqTriggerManualWebhook( components.V3WorkflowsSqTriggerManualWebhook{ Name: components.V3WorkflowsSqTriggerManualWebhookNameSqTriggerManualWebhook, Data: components.V3WorkflowsSqTriggerManualWebhookData{ ID: "", }, }, ), }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK, models with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.create(title="", owner_id="", trigger="incident_acknowledged", filters=models.V3WorkflowsCreateWorkflowFilter(), actions=[ { "name": "sq_trigger_manual_webhook", "data": { "id": "", }, }, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.create({ title: "", ownerId: "", trigger: "incident_acknowledged", filters: {}, actions: [ { name: "sq_trigger_manual_webhook", data: { id: "", }, }, ], }); console.log(result); } run(); /v3/workflows/enable: put: operationId: "Workflows_bulkEnabledisableWorkflows" summary: "Bulk Enable/Disable Workflows" description: "Bulk enable or disable workflows" parameters: [] responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.BulkEnableDisableWorkflowsRequest" x-speakeasy-name-override: bulkEnableDisable x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.BulkEnableDisable(ctx, components.V3WorkflowsBulkEnableDisableWorkflowsRequest{ OwnerID: "", Enabled: false, WorkflowIds: []int{ 124939, }, }) if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.bulk_enable_disable(owner_id="", enabled=False, workflow_ids=[ 124939, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.bulkEnableDisable({ ownerId: "", enabled: false, workflowIds: [ 124939, ], }); console.log(result); } run(); /v3/workflows/{workflowID}: delete: operationId: "Workflows_deleteWorkflow" summary: "Delete Workflow" description: "Delete a workflow by ID" parameters: - name: "workflowID" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.Delete(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.delete(workflow_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.delete({ workflowID: "", }); console.log(result); } run(); get: operationId: "Workflows_getWorkflowById" summary: "Get Workflow By ID" description: "Get a workflow by ID" parameters: - name: "workflowID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.GetWorkflowByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.V3WorkflowsGetWorkflowByIDResponse != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.get_by_id(workflow_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.getById({ workflowID: "", }); console.log(result); } run(); patch: operationId: "Workflows_updateWorkflow" summary: "Update Workflow" description: "Update a Workflow" parameters: - name: "workflowID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Workflows.UpdateWorkflowAPIResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.CreateWorkflowRequestUpdate" x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.Update(ctx, "", components.V3WorkflowsCreateWorkflowRequestUpdate{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.update(workflow_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.update({ workflowID: "", v3WorkflowsCreateWorkflowRequestUpdate: {}, }); console.log(result); } run(); /v3/workflows/{workflowID}/actions: post: operationId: "Workflows_createAction" summary: "Create Action" description: "Create an Action for a workflow" parameters: - name: "workflowID" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Workflows.ActionResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.ActionRequest" x-speakeasy-group: workflows.actions x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.Actions.Create(ctx, "", components.CreateV3WorkflowsActionRequestV3WorkflowsSqCreateStatusPageIssue( components.V3WorkflowsSqCreateStatusPageIssue{ Name: components.V3WorkflowsSqCreateStatusPageIssueNameSqAddStatusPageIssue, Data: components.V3WorkflowsSqCreateStatusPageIssueData{ ComponentAndImpact: []components.V3WorkflowsComponentAndImpact{}, IssueTitle: "", PageStatusID: 179034, StatusAndMessage: []components.V3WorkflowsIssueStatusAndMessage{ components.V3WorkflowsIssueStatusAndMessage{ Messages: []string{ "", "", "", }, StatusID: 692068, }, }, StatusPageID: 368871, }, }, )) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.actions.create(workflow_id="", v3_workflows_action_request={ "name": "sq_add_status_page_issue", "data": { "component_and_impact": [], "issue_title": "", "page_status_id": 179034, "status_and_message": [ { "messages": [ "", "", "", ], "status_id": 692068, }, ], "status_page_id": 368871, }, }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.actions.create({ workflowID: "", v3WorkflowsActionRequest: { name: "sq_add_status_page_issue", data: { componentAndImpact: [], issueTitle: "", pageStatusId: 179034, statusAndMessage: [ { messages: [ "", "", "", ], statusId: 692068, }, ], statusPageId: 368871, }, }, }); console.log(result); } run(); /v3/workflows/{workflowID}/actions/reorder: patch: operationId: "Workflows_updateActionsOrder" summary: "Update Actions Order" description: "Update action order in a workflow" parameters: - name: "workflowID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.UpdateActionsOrderResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.UpdateActionsOrderRequest" x-speakeasy-name-override: updateActionsOrder x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.UpdateActionsOrder(ctx, "", components.V3WorkflowsUpdateActionsOrderRequest{}) if err != nil { log.Fatal(err) } if res.V3WorkflowsUpdateActionsOrderResponse != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.update_actions_order(workflow_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.updateActionsOrder({ workflowID: "", v3WorkflowsUpdateActionsOrderRequest: {}, }); console.log(result); } run(); /v3/workflows/{workflowID}/actions/{actionID}: delete: operationId: "Workflows_deleteWorkflowAction" summary: "Delete Workflow Action" description: "Delete an action by action ID" parameters: - name: "workflowID" in: "path" required: true schema: type: "string" - name: "actionID" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" x-speakeasy-name-override: deleteAction x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.DeleteAction(ctx, "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.delete_action(workflow_id="", action_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.deleteAction({ workflowID: "", actionID: "", }); console.log(result); } run(); get: operationId: "Workflows_getWorkflowActionById" summary: "Get Workflow Action By ID" description: "Get workflow action by ID" parameters: - name: "workflowID" in: "path" required: true schema: type: "string" - name: "actionID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Workflows.GetWorkflowActionByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" x-speakeasy-group: workflows.actions x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.GetAction(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.actions.get_by_id(workflow_id="", action_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflowActions.getById({ workflowID: "", actionID: "", }); console.log(result); } run(); patch: operationId: "Workflows_updateWorkflowAction" summary: "Update Workflow Action" description: "Update an action by action ID" parameters: - name: "workflowID" in: "path" required: true schema: type: "string" - name: "actionID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: anyOf: - type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_attach_runbooks" data: type: "object" properties: runbooks: type: "array" items: $ref: "#/components/schemas/V3.Workflows.RunbookResponse" required: - "runbooks" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" - $ref: "#/components/schemas/V3.Workflows.SqMarkIncidentSLOAffecting" - $ref: "#/components/schemas/V3.Workflows.SqTriggerManualWebhook" - $ref: "#/components/schemas/V3.Workflows.UpdateIncidentPriority" - $ref: "#/components/schemas/V3.Workflows.SqCreateStatusPageIssue" - $ref: "#/components/schemas/V3.Workflows.SqAddIncidentNote" - $ref: "#/components/schemas/V3.Workflows.SlackArchiveChannel" - $ref: "#/components/schemas/V3.Workflows.SqAddCommunicationChannel" - $ref: "#/components/schemas/V3.Workflows.SlackMessageChannel" - $ref: "#/components/schemas/V3.Workflows.SlackMessageUser" - $ref: "#/components/schemas/V3.Workflows.SqMakeHTTPCall" - $ref: "#/components/schemas/V3.Workflows.SlackCreateIncidentChannel" - $ref: "#/components/schemas/V3.Workflows.JiraCreateTicket" - $ref: "#/components/schemas/V3.Workflows.MsTeamsMessageChannel" - $ref: "#/components/schemas/V3.Workflows.MsTeamsMessageUser" - $ref: "#/components/schemas/V3.Workflows.SqSendEmail" - $ref: "#/components/schemas/V3.Workflows.MsTeamsCreateMeetingLink" - {} "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.ActionRequestUpdate" x-speakeasy-name-override: updateAction x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.UpdateAction(ctx, "", "", components.CreateV3WorkflowsActionRequestUpdateAny( map[string]any{ "name": "slack_message_channel", }, )) if err != nil { log.Fatal(err) } if res.V3WorkflowsActionResponse != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.update_action(workflow_id="", action_id="", v3_workflows_action_request_update={ "name": "slack_message_channel", }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.updateAction({ workflowID: "", actionID: "", v3WorkflowsActionRequestUpdate: { "name": "slack_message_channel", }, }); console.log(result); } run(); /v3/workflows/{workflowID}/enable: patch: operationId: "Workflows_enabledisableWorkflow" summary: "Enable/Disable Workflow" description: "Enable or disable workflow by ID" parameters: - name: "workflowID" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.EnableDisableWorkflowRequest" x-speakeasy-name-override: enableDisable x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.ToggleEnable(ctx, "", components.V3WorkflowsEnableDisableWorkflowRequest{}) if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.enable_disable(workflow_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflows.enableDisable({ workflowID: "", v3WorkflowsEnableDisableWorkflowRequest: {}, }); console.log(result); } run(); /v3/workflows/{workflowID}/logs: get: operationId: "Workflows_getWorkflowLogs" summary: "Get Workflow Logs" description: "Get workflow logs" parameters: - name: "workflowID" in: "path" required: true schema: type: "string" - name: "page_size" in: "query" required: false schema: type: "integer" explode: false - name: "page_number" in: "query" required: false schema: type: "integer" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V3.Workflows.GetWorkflowLogsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Workflows" x-speakeasy-pagination: type: "offsetLimit" inputs: - name: "page_number" in: "parameters" type: "page" - name: "page_size" in: "parameters" type: "limit" outputs: results: "$.data" x-speakeasy-group: workflows.logs x-speakeasy-name-override: get x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Workflows.GetLogs(ctx, "", nil, nil) if err != nil { log.Fatal(err) } if res.V3WorkflowsGetWorkflowLogsResponse != nil { for { // handle items res, err = res.Next() if err != nil { // handle error } if res == nil { break } } } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.workflows.logs.get(workflow_id="") while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.workflowLogs.get({ workflowID: "", }); for await (const page of result) { console.log(page); } } run(); /v4/schedules: get: operationId: "Schedules_listSchedules" summary: "List Schedules" parameters: - name: "teamID" in: "query" required: true schema: type: "string" explode: false - name: "scheduleIDs" in: "query" required: false schema: type: "array" items: type: "integer" explode: false - name: "participants" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "scheduleName" in: "query" required: false schema: type: "string" explode: false - name: "myOnCall" in: "query" required: false schema: type: "boolean" explode: false - name: "youAndYourSquads" in: "query" required: false schema: type: "boolean" explode: false - name: "search" in: "query" required: false schema: type: "string" explode: false - name: "hidePaused" in: "query" required: false schema: type: "boolean" explode: false - name: "ownerID" in: "query" required: false schema: type: "string" explode: false - name: "escalationPolicies" in: "query" required: false schema: type: "array" items: type: "string" explode: false - name: "withoutEscalationPolicy" in: "query" required: false schema: type: "boolean" explode: false - name: "pageSize" in: "query" required: false schema: type: "integer" explode: false - name: "cursor" in: "query" required: false schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" - "pageInfo" properties: data: type: "array" items: $ref: "#/components/schemas/V4.ScheduleResponse" pageInfo: $ref: "#/components/schemas/Common.V4.PageInfo" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule" x-speakeasy-pagination: type: "cursor" inputs: - name: "cursor" in: "parameters" type: "cursor" - name: "pageSize" in: "parameters" type: "limit" outputs: results: "$.data" nextCursor: "$.pageInfo.nextCursor" x-speakeasy-group: schedules x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.List(ctx, operations.SchedulesListSchedulesRequest{ TeamID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { for { // handle items res, err = res.Next() if err != nil { // handle error } if res == nil { break } } } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.list(team_id="") while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.list({ teamID: "", }); for await (const page of result) { console.log(page); } } run(); post: operationId: "Schedules_createSchedule" summary: "Create Schedule" parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.ScheduleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.CreateScheduleRequest" x-speakeasy-group: schedules x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.Create(ctx, components.V4CreateScheduleRequest{ Name: "", Description: "fumigate pfft kooky whoa but lighthearted popularity", TeamID: "", OwnerID: "", OwnerType: components.V4CreateScheduleRequestOwnerTypeUser, TimeZone: "Pacific/Easter", Tags: []components.V4Tag{ components.V4Tag{ Key: "", Value: "", Color: "pink", }, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.create(name="", description="fumigate pfft kooky whoa but lighthearted popularity", team_id="", owner_id="", owner_type="user", time_zone="Pacific/Easter", tags=[ { "key": "", "value": "", "color": "pink", }, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.create({ name: "", description: "fumigate pfft kooky whoa but lighthearted popularity", teamID: "", ownerID: "", ownerType: "user", timeZone: "Pacific/Easter", tags: [ { key: "", value: "", color: "pink", }, ], }); console.log(result); } run(); /v4/schedules/{scheduleID}: delete: operationId: "Schedules_deleteSchedule" summary: "Delete Schedule" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule" x-speakeasy-group: schedules x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.Delete(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.delete(schedule_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.delete({ scheduleID: "", }); console.log(result); } run(); get: operationId: "Schedules_getScheduleById" summary: "Get Schedule by ID" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.ScheduleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule" x-speakeasy-group: schedules x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.get_by_id(schedule_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.getById({ scheduleID: "", }); console.log(result); } run(); put: operationId: "Schedules_updateSchedule" summary: "Update Schedule" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.ScheduleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.UpdateScheduleRequest" x-speakeasy-group: schedules x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.Update(ctx, "", components.V4UpdateScheduleRequest{ Name: "", Description: "smoothly festival unruly alert now far provided absentmindedly", OwnerID: "", OwnerType: components.V4UpdateScheduleRequestOwnerTypeSquad, Tags: []components.V4Tag{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.update(schedule_id="", name="", description="smoothly festival unruly alert now far provided absentmindedly", owner_id="", owner_type="squad", tags=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.update({ scheduleID: "", v4UpdateScheduleRequest: { name: "", description: "smoothly festival unruly alert now far provided absentmindedly", ownerID: "", ownerType: "squad", tags: [], }, }); console.log(result); } run(); /v4/schedules/{scheduleID}/actions: patch: operationId: "Schedules_pauseresumeSchedule" summary: "Pause/Resume Schedule" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.PauseResumeScheduleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule" requestBody: required: true content: application/json: schema: type: "object" properties: action: type: "string" enum: - "pause" - "resume" x-speakeasy-group: schedules x-speakeasy-name-override: pauseResume x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.PauseResume(ctx, "", operations.SchedulesPauseresumeScheduleRequestBody{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.pause_resume(schedule_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.actions.pauseResume({ scheduleID: "", requestBody: {}, }); console.log(result); } run(); /v4/schedules/{scheduleID}/change-timezone: patch: operationId: "Schedules_changeTimezone" summary: "Change Timezone" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.ChangeTimezoneResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule" requestBody: required: true content: application/json: schema: type: "object" properties: timeZone: type: "string" x-speakeasy-group: schedules x-speakeasy-name-override: changeTimezone x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.ChangeTimezone(ctx, "", operations.SchedulesChangeTimezoneRequestBody{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.change_timezone(schedule_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.changeTimezone({ scheduleID: "", requestBody: {}, }); console.log(result); } run(); /v4/schedules/{scheduleID}/clone: post: operationId: "Schedules_cloneSchedule" summary: "Clone Schedule" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.ScheduleResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule" requestBody: required: true content: application/json: schema: type: "object" x-speakeasy-group: schedules x-speakeasy-name-override: clone x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.Clone(ctx, "", operations.SchedulesCloneScheduleRequestBody{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.clone(schedule_id="", request_body={}) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.clone({ scheduleID: "", requestBody: {}, }); console.log(result); } run(); /v4/schedules/{scheduleID}/ical-link: delete: operationId: "Export_deleteIcalLink" summary: "Delete ICal Link" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "myOnCall" in: "query" required: true schema: type: "boolean" explode: false responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule/Export Schedule" x-speakeasy-group: schedules.export x-speakeasy-name-override: deleteIcalLink x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.Export.DeleteIcalLink(ctx, "", true) if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.export.delete_ical_link(schedule_id="", my_on_call=True) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedule.export.deleteICalLink({ scheduleID: "", myOnCall: true, }); console.log(result); } run(); get: operationId: "Export_getScheduleIcalLink" summary: "Get Schedule ICal Link" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "myOnCall" in: "query" required: true schema: type: "boolean" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.ICalLinkResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule/Export Schedule" x-speakeasy-group: schedules x-speakeasy-name-override: getIcalLink x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.GetIcalLink(ctx, "", false) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.get_ical_link(schedule_id="", my_on_call=False) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.export.getIcalLink({ scheduleID: "", myOnCall: false, }); console.log(result); } run(); patch: operationId: "Export_refreshScheduleIcalLink" summary: "Refresh Schedule ICal Link" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "myOnCall" in: "query" required: true schema: type: "boolean" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.ICalLinkResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule/Export Schedule" requestBody: required: true content: application/json: schema: type: "object" x-speakeasy-group: exportSchedule x-speakeasy-name-override: refreshIcalLink x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.RefreshIcalLink(ctx, "", true, operations.ExportRefreshScheduleIcalLinkRequestBody{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.export_schedule.refresh_ical_link(schedule_id="", my_on_call=True, request_body={}) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.exportSchedule.refreshIcalLink({ scheduleID: "", myOnCall: true, requestBody: {}, }); console.log(result); } run(); post: operationId: "Export_createScheduleIcalLink" summary: "Create Schedule ICal Link" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "myOnCall" in: "query" required: true schema: type: "boolean" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.ICalLinkResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Schedule/Export Schedule" requestBody: required: true content: application/json: schema: type: "object" x-speakeasy-group: schedules x-speakeasy-name-override: createIcalLink x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.CreateIcalLink(ctx, "", true, operations.ExportCreateScheduleIcalLinkRequestBody{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.create_ical_link(schedule_id="", my_on_call=True, request_body={}) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.createIcalLink({ scheduleID: "", myOnCall: true, requestBody: {}, }); console.log(result); } run(); /v4/schedules/{scheduleID}/overrides: get: operationId: "Overrides_listOverrides" summary: "List Overrides" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "startTime" in: "query" required: true schema: type: "string" explode: false - name: "endTime" in: "query" required: true schema: type: "string" explode: false - name: "participantID" in: "query" required: false schema: type: "string" explode: false - name: "pageSize" in: "query" required: false schema: type: "integer" format: "int32" explode: false - name: "cursor" in: "query" required: false schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" - "pageInfo" properties: data: type: "array" items: $ref: "#/components/schemas/V4.OverrideResponse" pageInfo: $ref: "#/components/schemas/Common.V4.PageInfo" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Overrides" x-speakeasy-group: schedules.overrides x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/operations" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.Overrides.List(ctx, operations.OverridesListOverridesRequest{ ScheduleID: "", StartTime: "", EndTime: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.overrides.list(schedule_id="", start_time="", end_time="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.overrides.list({ scheduleID: "", startTime: "", endTime: "", }); console.log(result); } run(); post: operationId: "Overrides_createScheduleOverride" summary: "Create Schedule Override" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.OverrideResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Overrides" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.CreateScheduleOverrideRequest" x-speakeasy-group: schedules.overrides x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.CreateScheduleOverride(ctx, "", components.V4CreateScheduleOverrideRequest{ StartTime: "", EndTime: "", Reason: "", OverriddenParticipant: components.V4OverrideParticipantGroup{ Group: []components.V4Participant{ components.V4Participant{ ID: "", Type: "", }, }, }, OverrideWith: components.V4OverrideParticipantGroup{ Group: []components.V4Participant{ components.V4Participant{ ID: "", Type: "", }, }, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.overrides.create(schedule_id="", start_time="", end_time="", reason="", overridden_participant={ "group": [ { "id": "", "type": "", }, ], }, override_with={ "group": [ { "id": "", "type": "", }, ], }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.overrides.create({ scheduleID: "", v4CreateScheduleOverrideRequest: { startTime: "", endTime: "", reason: "", overriddenParticipant: { group: [ { id: "", type: "", }, ], }, overrideWith: { group: [ { id: "", type: "", }, ], }, }, }); console.log(result); } run(); /v4/schedules/{scheduleID}/overrides/{overrideID}: delete: operationId: "Overrides_deleteScheduleOverride" summary: "Delete Schedule Override" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "overrideID" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Overrides" x-speakeasy-name-override: remove x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.Overrides.Delete(ctx, "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.overrides.remove(schedule_id="", override_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.deleteOverride({ scheduleID: "", overrideID: "", }); console.log(result); } run(); get: operationId: "Overrides_getOverrideById" summary: "Get Override by ID" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "overrideID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.OverrideResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Overrides" x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Overrides.GetByID(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.overrides.get_by_id(schedule_id="", override_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.getOverrideById({ scheduleID: "", overrideID: "", }); console.log(result); } run(); put: operationId: "Overrides_updateScheduleOverride" summary: "Update Schedule Override" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "overrideID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.OverrideResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Overrides" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.UpdateScheduleOverrideRequest" x-speakeasy-group: schedules.overrides x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Overrides.Update(ctx, "", "", components.V4UpdateScheduleOverrideRequest{ StartTime: "", EndTime: "", Reason: "", OverriddenParticipant: components.V4OverrideParticipantGroup{ Group: []components.V4Participant{ components.V4Participant{ ID: "", Type: "", }, }, }, OverrideWith: components.V4OverrideParticipantGroup{ Group: []components.V4Participant{}, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.schedules.overrides.update(schedule_id="", override_id="", start_time="", end_time="", reason="", overridden_participant={ "group": [ { "id": "", "type": "", }, ], }, override_with={ "group": [], }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.overrides.update({ scheduleID: "", overrideID: "", v4UpdateScheduleOverrideRequest: { startTime: "", endTime: "", reason: "", overriddenParticipant: { group: [ { id: "", type: "", }, ], }, overrideWith: { group: [], }, }, }); console.log(result); } run(); /v4/schedules/{scheduleID}/rotations: get: operationId: "Rotations_getScheduleRotations" summary: "List Schedule Rotations" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" properties: data: type: "array" items: $ref: "#/components/schemas/V4.RotationResponse" required: - "data" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Rotation" x-speakeasy-group: rotations x-speakeasy-name-override: listBySchedule x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.Rotations.List(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.rotations.list_by_schedule(schedule_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.rotations.getScheduleRotations({ scheduleID: "", }); console.log(result); } run(); post: operationId: "Rotations_createRotation" summary: "Create Rotation" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.RotationResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Rotation" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.CreateRotationRequest" x-speakeasy-group: rotations x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Rotations.Create(ctx, "", components.V4CreateRotationRequest{ Name: "", StartDate: "", Period: "", ChangeParticipantsFrequency: 62013, ChangeParticipantsUnit: "", ParticipantGroups: []components.V4ParticipantGroup{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.rotations.create(schedule_id="", name="", start_date="", period="", change_participants_frequency=62013, change_participants_unit="", participant_groups=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.createRotation({ scheduleID: "", v4CreateRotationRequest: { name: "", startDate: "", period: "", changeParticipantsFrequency: 62013, changeParticipantsUnit: "", participantGroups: [], }, }); console.log(result); } run(); /v4/schedules/{scheduleID}/rotations/{rotationID}: delete: operationId: "Rotations_deleteRotation" summary: "Delete Rotation" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "rotationID" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Rotation" x-speakeasy-group: rotations x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Schedules.DeleteRotation(ctx, "", "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.rotations.delete(schedule_id="", rotation_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.rotations.delete({ scheduleID: "", rotationID: "", }); console.log(result); } run(); get: operationId: "Rotations_getScheduleRotationById" summary: "Get Schedule Rotation by ID" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "rotationID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.RotationResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Rotation" x-speakeasy-group: rotations x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Rotations.GetByID(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.rotations.get_by_id(schedule_id="", rotation_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.rotations.getById({ scheduleID: "", rotationID: "", }); console.log(result); } run(); put: operationId: "Rotations_updateRotation" summary: "Update Rotation" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "rotationID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.RotationResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Rotation" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.UpdateRotationRequest" x-speakeasy-group: rotations x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Rotations.Update(ctx, "", "", components.V4UpdateRotationRequest{ Name: "", StartDate: "", Period: "", ChangeParticipantsFrequency: 183098, ChangeParticipantsUnit: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.rotations.update(schedule_id="", rotation_id="", name="", start_date="", period="", change_participants_frequency=183098, change_participants_unit="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.schedules.rotations.update({ scheduleID: "", rotationID: "", v4UpdateRotationRequest: { name: "", startDate: "", period: "", changeParticipantsFrequency: 183098, changeParticipantsUnit: "", }, }); console.log(result); } run(); /v4/schedules/{scheduleID}/rotations/{rotationID}/participants: get: operationId: "Rotations_getRotationParticipants" summary: "Get Rotation Participants" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "rotationID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.GetRotationParticipantsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Rotation" x-speakeasy-group: rotations x-speakeasy-name-override: getParticipants x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Rotations.GetParticipants(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.rotations.get_participants(schedule_id="", rotation_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.rotations.getParticipants({ scheduleID: "", rotationID: "", }); console.log(result); } run(); put: operationId: "Rotations_updateRotationParticipants" summary: "Update Rotation Participants" parameters: - name: "scheduleID" in: "path" required: true schema: type: "string" - name: "rotationID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.RotationParticipantsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Rotation" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.UpdateRotationParticipantsRequest" x-speakeasy-group: rotations x-speakeasy-name-override: updateParticipants x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Rotations.UpdateParticipants(ctx, "", "", components.V4UpdateRotationParticipantsRequest{ ParticipantGroups: []components.V4ParticipantGroup{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.rotations.update_participants(schedule_id="", rotation_id="", participant_groups=[]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.rotations.updateParticipants({ scheduleID: "", rotationID: "", v4UpdateRotationParticipantsRequest: { participantGroups: [], }, }); console.log(result); } run(); /v4/squads: get: operationId: "Squads_getAllSquads" summary: "Get All Squads" description: "This endpoint is used to get all the squads details of your organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `squad-read` scope." parameters: - name: "owner_id" in: "query" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" - "pageInfo" properties: data: type: "array" items: $ref: "#/components/schemas/V4.Squads.SquadResponse" pageInfo: $ref: "#/components/schemas/Common.V4.PageInfo" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Squads" x-speakeasy-group: squads x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Squads.List(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.squads.list(owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.squads.list({ ownerId: "", }); console.log(result); } run(); post: operationId: "Squads_createSquad" summary: "Create Squad" description: "This endpoint is used to create a new squad.\nThe role will be considered only if your organization is on the OBAC permission model; otherwise, the role field will be ignored, and only the member will be added to the squad.\n\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `squad-create` scope." parameters: [] responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.Squads.CreateSquadResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Squads" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.Squads.CreateSquadRequest" x-speakeasy-group: squadsV4 x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Squads.V4.Create(ctx, components.V4SquadsCreateSquadRequest{ OwnerID: "", Name: "", Members: []components.V4SquadsSquadMember{}, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.squads_v4.create(owner_id="", name="", members=[ { "user_id": "", }, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.squads.createV4({ ownerId: "", name: "", members: [ { userId: "", }, ], }); console.log(result); } run(); /v4/squads/{squadID}: get: operationId: "Squads_getSquadById" summary: "Get Squad By ID" description: "This endpoint is used to get the squads details by id.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `squad-read` scope." parameters: - name: "squadID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.Squads.SquadResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Squads" x-speakeasy-group: squads x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Squads.V4.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.squads.get_by_id(squad_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.squadsV4.getById({ squadID: "", }); console.log(result); } run(); put: operationId: "Squads_updateSquad" summary: "Update Squad" description: "This endpoint is used to update squad.\n\nThe role will be considered only if your organization is on the OBAC permission model; otherwise, the role field will be ignored, and only the member will be added to the squad.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `squad-create` scope." parameters: - name: "squadID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.Squads.SquadResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Squads" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.Squads.UpdateSquadRequest" x-speakeasy-group: squads x-speakeasy-name-override: updateV4 x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.V4.Squads.Update(ctx, "", components.V4SquadsUpdateSquadRequest{}) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.squads.update_v4(squad_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.squadsV4.update({ squadID: "", v4SquadsUpdateSquadRequest: {}, }); console.log(result); } run(); delete: operationId: "Squads_deleteSquad" summary: "Delete Squad" description: "This endpoint is used to delete the squad. Squad should not be assigned to any incident or part of any escalation policy.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `squad-update` scope." parameters: - name: "squadID" in: "path" required: true schema: type: "string" responses: "204": description: "There is no content to send for this request, but the headers may be useful. " content: '*/*': schema: type: "object" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Squads" x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Squads.Delete(ctx, "") if err != nil { log.Fatal(err) } if res.Body != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.squads.delete(squad_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.squads.delete({ squadID: "", }); console.log(result); } run(); /v4/squads/{squadID}/members/{memberID}: delete: operationId: "Squads_removeSquadMember" summary: "Remove Squad Member" description: "This endpoint is used to update squad member's role.\n\nIf you're attempting to remove a member whose role is 'owner', and that 'owner' is the last squad owner, then the 'replaceWith' query parameter is required. Setting 'replaceWith' to 'member' will promote another member as the owner, and the specified member will be removed.\n\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `squad-create` scope." parameters: - name: "squadID" in: "path" required: true schema: type: "string" - name: "memberID" in: "path" required: true schema: type: "string" - name: "replaceWith" in: "query" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V4.Squads.RemoveSquadMemberResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Squads" x-speakeasy-group: squads x-speakeasy-name-override: removeMember x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Squads.RemoveMember(ctx, "", "", "") if err != nil { log.Fatal(err) } if res.V4SquadsRemoveSquadMemberResponse != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.squads.remove_member(squad_id="", member_id="", replace_with="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.squads.members.remove({ squadID: "", memberID: "", replaceWith: "", }); console.log(result); } run(); put: operationId: "Squads_updateSquadMember" summary: "Update Squad Member" description: "This endpoint is used to update a squad member's role and is only accessible if your organization is using the OBAC permission model.\n\nIf you're attempting to update a member's role from 'owner' to 'member', and that 'owner' is the last squad owner, then the 'replaceWith' query parameter is required. Setting 'replaceWith' to 'member' will promote the member to the role of owner.\n\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `squad-create` scope." parameters: - name: "squadID" in: "path" required: true schema: type: "string" - name: "memberID" in: "path" required: true schema: type: "string" - name: "replaceWith" in: "query" required: true schema: type: "string" responses: "201": description: "The request has succeeded and a new resource has been created as a result." content: application/json: schema: $ref: "#/components/schemas/V4.Squads.UpdateSquadMemberResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Squads" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.Squads.UpdateSquadMemberRequest" x-speakeasy-group: squads.members x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Squads.UpdateMemberRole(ctx, "", "", "", components.V4SquadsUpdateSquadMemberRequest{ Role: "", }) if err != nil { log.Fatal(err) } if res.V4SquadsUpdateSquadMemberResponse != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.squads.members.update(squad_id="", member_id="", replace_with="", role="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.squads.updateMember({ squadID: "", memberID: "", replaceWith: "", v4SquadsUpdateSquadMemberRequest: { role: "", }, }); console.log(result); } run(); /v4/squads/{squadID}/name: put: operationId: "Squads_updateSquadName" summary: "Update Squad Name" description: "This endpoint is used to update squad's name.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `squad-create` scope." parameters: - name: "squadID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.Squads.UpdateSquadNameResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "401": description: "Access is unauthorized." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "402": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "403": description: "Access is forbidden." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "404": description: "The server cannot find the requested resource." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "422": description: "Client error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "500": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "502": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" "504": description: "Server error" content: application/json: schema: $ref: "#/components/schemas/Common.V4.Error" tags: - "Squads" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.Squads.UpdateSquadNameRequest" x-speakeasy-group: squadsV4 x-speakeasy-name-override: updateName x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.Squads.UpdateName(ctx, "", components.V4SquadsUpdateSquadNameRequest{ Name: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.squads_v4.update_name(squad_id="", name="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.squads.updateName({ squadID: "", v4SquadsUpdateSquadNameRequest: { name: "", }, }); console.log(result); } run(); /v4/statuspages: get: operationId: "StatusPages_listStatusPages" summary: "List Status Pages" parameters: - name: "pageSize" in: "query" required: true schema: type: "integer" explode: false - name: "pageNumber" in: "query" required: true schema: type: "integer" explode: false - name: "filters.isPublic" in: "query" required: true schema: type: "string" explode: false - name: "teamID" in: "query" required: true schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.ListStatusPagesResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages" x-speakeasy-pagination: type: "offsetLimit" inputs: - name: "pageNumber" in: "parameters" type: "page" - name: "pageSize" in: "parameters" type: "limit" outputs: results: "$.data" x-speakeasy-group: statusPages x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.List(ctx, 301790, 172386, "", "") if err != nil { log.Fatal(err) } if res.V4StatusPagesListStatusPagesResponse != nil { for { // handle items res, err = res.Next() if err != nil { // handle error } if res == nil { break } } } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.list(page_size=301790, page_number=172386, filters_is_public="", team_id="") while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.list({ pageSize: 301790, pageNumber: 172386, filtersIsPublic: "", teamID: "", }); for await (const page of result) { console.log(page); } } run(); post: operationId: "StatusPages_createStatusPage" summary: "Create Status Page" parameters: [] responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.CreateStatusPageResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.CreateStatusPageRequest" x-speakeasy-group: statusPages x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Create(ctx, components.V4StatusPagesCreateStatusPageRequest{ Name: "", DomainName: "failing-convection.com", LogoURL: "https://snarling-season.info", Timezone: "Pacific/Chuuk", TeamID: "", ContactEmail: "", OwnerType: components.V4StatusPagesCreateStatusPageRequestOwnerTypeTeam, OwnerID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.create(name="", domain_name="failing-convection.com", logo_url="https://snarling-season.info", timezone="Pacific/Chuuk", team_id="", contact_email="", owner_type="team", owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.create({ name: "", domainName: "failing-convection.com", logoUrl: "https://snarling-season.info", timezone: "Pacific/Chuuk", teamID: "", contactEmail: "", ownerType: "team", ownerID: "", }); console.log(result); } run(); /v4/statuspages/{statuspageID}: delete: operationId: "StatusPages_deleteStatusPageById" summary: "Delete Status Page By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.DeleteStatusPageByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages" x-speakeasy-group: statusPages x-speakeasy-name-override: deleteById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.DeleteByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.delete_by_id(statuspage_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.delete({ statuspageID: "", }); console.log(result); } run(); get: operationId: "StatusPages_getStatusPageById" summary: "Get Status Page By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.GetStatusPageByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages" x-speakeasy-group: statusPages x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.GetByID(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.get_by_id(statuspage_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.getById({ statuspageID: "", }); console.log(result); } run(); put: operationId: "StatusPages_updateStatusPageById" summary: "Update Status Page By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.UpdateStatusPageByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.UpdateStatusPageByIdRequest" x-speakeasy-group: statusPages x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.UpdateByID(ctx, "", components.V4StatusPagesUpdateStatusPageByIDRequest{ Name: "", IsPublic: false, DomainName: "blank-brief.info", TeamID: "", ThemeColor: components.V4StatusPagesUpdateStatusPageByIDRequestThemeColor{ Primary: "", Secondary: "", }, ContactEmail: "", OwnerType: "", OwnerID: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.update(statuspage_id="", name="", is_public=False, domain_name="blank-brief.info", team_id="", theme_color={ "primary": "", "secondary": "", }, contact_email="", owner_type="", owner_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.updateById({ statuspageID: "", v4StatusPagesUpdateStatusPageByIdRequest: { name: "", isPublic: false, domainName: "blank-brief.info", teamID: "", themeColor: { primary: "", secondary: "", }, contactEmail: "", ownerType: "", ownerID: "", }, }); console.log(result); } run(); /v4/statuspages/{statuspageID}/components: get: operationId: "Components_listComponents" summary: "List Components" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.Components.ListComponentsResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Components" x-speakeasy-group: components x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Components.List(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.components.list(statuspage_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.components.list({ statuspageID: "", }); console.log(result); } run(); post: operationId: "Components_createComponent" summary: "Create Component" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Components.CreateComponentResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Components" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.Components.CreateComponentRequest" x-speakeasy-group: components x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Components.Create(ctx, "", components.V4StatusPagesComponentsCreateComponentRequest{ Name: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.components.create(statuspage_id="", name="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.components.create({ statuspageID: "", v4StatusPagesComponentsCreateComponentRequest: { name: "", }, }); console.log(result); } run(); /v4/statuspages/{statuspageID}/components/{component_id}: delete: operationId: "Components_deleteComponentById" summary: "Delete Component By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "component_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Components.DeleteComponentByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Components" x-speakeasy-group: statusPages.components x-speakeasy-name-override: deleteById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Components.DeleteByID(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.components.delete_by_id(statuspage_id="", component_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.components.deleteById({ statuspageID: "", componentId: "", }); console.log(result); } run(); get: operationId: "Components_getComponentById" summary: "Get Component By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "component_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Components.GetComponentByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Components" x-speakeasy-group: components x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Components.GetByID(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.components.get_by_id(statuspage_id="", component_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.components.getById({ statuspageID: "", componentId: "", }); console.log(result); } run(); put: operationId: "Components_updateComponentById" summary: "Update Component By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "component_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Components.UpdateComponentByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Components" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.Components.UpdateComponentByIdRequest" x-speakeasy-group: components x-speakeasy-name-override: updateById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Components.UpdateByID(ctx, "", "", components.V4StatusPagesComponentsUpdateComponentByIDRequest{ Name: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.components.update_by_id(statuspage_id="", component_id="", name="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.components.updateById({ statuspageID: "", componentId: "", v4StatusPagesComponentsUpdateComponentByIdRequest: { name: "", }, }); console.log(result); } run(); /v4/statuspages/{statuspageID}/groups: get: operationId: "ComponentGroups_listComponentGroups" summary: "List Component Groups" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.ComponentGroupResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Component groups" x-speakeasy-group: statusPages.componentGroups x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.ComponentGroups.List(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.component_groups.list(statuspage_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.componentGroups.list({ statuspageID: "", }); console.log(result); } run(); post: operationId: "ComponentGroups_createComponentGroup" summary: "Create Component Group" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.CreateComponentGroupResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Component groups" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.CreateComponentGroupRequest" x-speakeasy-group: componentGroups x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.ComponentGroups.Create(ctx, "", components.V4StatusPagesComponentGroupsCreateComponentGroupRequest{ Name: "", }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.component_groups.create(statuspage_id="", name="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.componentGroups.create({ statuspageID: "", v4StatusPagesComponentGroupsCreateComponentGroupRequest: { name: "", }, }); console.log(result); } run(); /v4/statuspages/{statuspageID}/groups/{group_id}: delete: operationId: "ComponentGroups_deleteComponentGroupById" summary: "Delete Component Group By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "group_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.DeleteComponentGroupByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Component groups" x-speakeasy-group: statusPages.componentGroups x-speakeasy-name-override: removeById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.ComponentGroups.DeleteByID(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.component_groups.remove_by_id(statuspage_id="", group_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.componentGroups.deleteById({ statuspageID: "", groupId: "", }); console.log(result); } run(); get: operationId: "ComponentGroups_getComponentGroupById" summary: "Get Component Group By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "group_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.GetComponentGroupByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Component groups" x-speakeasy-group: statusPages.componentGroups x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.ComponentGroups.GetByID(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.component_groups.get_by_id(statuspage_id="", group_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.componentGroups.getById({ statuspageID: "", groupId: "", }); console.log(result); } run(); /v4/statuspages/{statuspageID}/issues: get: operationId: "Issues_listIssues" summary: "List Issues" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.Issues.ListIssuesResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Issues" x-speakeasy-group: statusPages.issues x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Issues.List(ctx, "") if err != nil { log.Fatal(err) } if res.V4StatusPagesIssuesListIssuesResponse != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.issues.list(statuspage_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.issues.list({ statuspageID: "", }); console.log(result); } run(); post: operationId: "Issues_createIssue" summary: "Create Issue" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Issues.CreateIssueResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Issues" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.Issues.CreateIssueRequest" x-speakeasy-group: statusPages.issues x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.CreateIssue(ctx, "", components.V4StatusPagesIssuesCreateIssueRequest{ Title: "", Components: []components.V4StatusPagesIssuesCreateIssueRequestComponent{ components.V4StatusPagesIssuesCreateIssueRequestComponent{}, }, Issues: []components.V4StatusPagesIssuesCreateIssueRequestIssue{ components.V4StatusPagesIssuesCreateIssueRequestIssue{}, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.issues.create(statuspage_id="", title="", components=[ {}, ], issues=[ {}, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.issues.create({ statuspageID: "", v4StatusPagesIssuesCreateIssueRequest: { title: "", components: [ {}, ], issues: [ {}, ], }, }); console.log(result); } run(); /v4/statuspages/{statuspageID}/issues/{issue_id}: delete: operationId: "Issues_deleteIssueById" summary: "Delete Issue By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "issue_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Issues.DeleteIssueByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Issues" x-speakeasy-group: issues x-speakeasy-name-override: deleteById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Issues.Delete(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.issues.delete_by_id(statuspage_id="", issue_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.issues.delete({ statuspageID: "", issueId: "", }); console.log(result); } run(); get: operationId: "Issues_getIssueById" summary: "Get Issue By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "issue_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Issues.GetIssueByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Issues" x-speakeasy-group: statusPages.issues x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Issues.GetByID(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.issues.get_by_id(statuspage_id="", issue_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.getIssueById({ statuspageID: "", issueId: "", }); console.log(result); } run(); put: operationId: "Issues_updateIssue" summary: "Update Issue" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "issue_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Issues.UpdateIssueResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Issues" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.Issues.UpdateIssueRequest" x-speakeasy-group: issues x-speakeasy-name-override: update x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.UpdateIssue(ctx, "", "", components.V4StatusPagesIssuesUpdateIssueRequest{ Title: "", Components: []components.V4StatusPagesIssuesUpdateIssueRequestComponent{ components.V4StatusPagesIssuesUpdateIssueRequestComponent{}, }, Issues: []components.V4StatusPagesIssuesUpdateIssueRequestIssue{ components.V4StatusPagesIssuesUpdateIssueRequestIssue{}, }, }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.issues.update(statuspage_id="", issue_id="", title="", components=[ {}, ], issues=[ {}, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.issues.update({ statuspageID: "", issueId: "", v4StatusPagesIssuesUpdateIssueRequest: { title: "", components: [ {}, ], issues: [ {}, ], }, }); console.log(result); } run(); /v4/statuspages/{statuspageID}/maintenance: get: operationId: "Maintenances_listMaintenances" summary: "List Maintenances" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "startTime" in: "query" required: true schema: type: "string" explode: false - name: "endTime" in: "query" required: true schema: type: "string" explode: false responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.Maintenances.ListMaintenancesResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Maintenances" x-speakeasy-group: statusPages.maintenances x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.ListMaintenances(ctx, "", "", "") if err != nil { log.Fatal(err) } if res.V4StatusPagesMaintenancesListMaintenancesResponse != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.maintenances.list(statuspage_id="", start_time="", end_time="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.maintenances.list({ statuspageID: "", startTime: "", endTime: "", }); console.log(result); } run(); post: operationId: "Maintenances_createMaintenance" summary: "Create Maintenance" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Maintenances.CreateMaintenanceResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Maintenances" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.Maintenances.CreateMaintenanceRequest" x-speakeasy-group: statusPages.maintenances x-speakeasy-name-override: create x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/types" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Maintenances.Create(ctx, "", components.V4StatusPagesMaintenancesCreateMaintenanceRequest{ Title: "", Note: "", Components: []int64{ 191583, 227211, 362920, }, StartTime: types.MustTimeFromString("2024-08-24T09:07:30.992Z"), EndTime: types.MustTimeFromString("2024-04-27T16:39:01.283Z"), }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK from squadcast_sdk.utils import parse_datetime with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.maintenances.create(statuspage_id="", title="", note="", components=[ 191583, 227211, 362920, ], start_time=parse_datetime("2024-08-24T09:07:30.992Z"), end_time=parse_datetime("2024-04-27T16:39:01.283Z")) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.maintenances.create({ statuspageID: "", v4StatusPagesMaintenancesCreateMaintenanceRequest: { title: "", note: "", components: [ 191583, 227211, 362920, ], startTime: new Date("2024-08-24T09:07:30.992Z"), endTime: new Date("2024-04-27T16:39:01.283Z"), }, }); console.log(result); } run(); /v4/statuspages/{statuspageID}/maintenance/{maintenance_id}: delete: operationId: "Maintenances_deleteMaintenanceById" summary: "Delete Maintenance By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "maintenance_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Maintenances.DeleteMaintenanceByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Maintenances" x-speakeasy-group: maintenances x-speakeasy-name-override: delete x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Maintenances.DeleteByID(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.maintenances.delete(statuspage_id="", maintenance_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.maintenances.deleteById({ statuspageID: "", maintenanceId: "", }); console.log(result); } run(); get: operationId: "Maintenances_getMaintenanceById" summary: "Get Maintenance By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "maintenance_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Maintenances.GetMaintenanceByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Maintenances" x-speakeasy-group: statuspages.maintenances x-speakeasy-name-override: getById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.GetMaintenanceByID(ctx, "", "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.statuspages.maintenances.get_by_id(statuspage_id="", maintenance_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.maintenances.getById({ statuspageID: "", maintenanceId: "", }); console.log(result); } run(); put: operationId: "Maintenances_updateMaintenanceById" summary: "Update Maintenance By ID" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" - name: "maintenance_id" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V4.StatusPages.Maintenances.UpdateMaintenanceByIdResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Maintenances" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.Maintenances.UpdateMaintenanceByIdRequest" x-speakeasy-group: maintenances x-speakeasy-name-override: updateById x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "github.com/SquadcastHub/squadcast-sdk-go/types" "github.com/SquadcastHub/squadcast-sdk-go/models/components" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Maintenances.UpdateByID(ctx, "", "", components.V4StatusPagesMaintenancesUpdateMaintenanceByIDRequest{ Title: "", Note: "", StartTime: types.MustTimeFromString("2024-07-22T17:12:15.919Z"), EndTime: types.MustTimeFromString("2024-06-11T21:00:35.262Z"), }) if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK from squadcast_sdk.utils import parse_datetime with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.maintenances.update_by_id(statuspage_id="", maintenance_id="", title="", note="", start_time=parse_datetime("2024-07-22T17:12:15.919Z"), end_time=parse_datetime("2024-06-11T21:00:35.262Z")) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.maintenances.updateById({ statuspageID: "", maintenanceId: "", v4StatusPagesMaintenancesUpdateMaintenanceByIdRequest: { title: "", note: "", startTime: new Date("2024-07-22T17:12:15.919Z"), endTime: new Date("2024-06-11T21:00:35.262Z"), }, }); console.log(result); } run(); /v4/statuspages/{statuspageID}/states: get: operationId: "Issues_listStatusPageIssueStates" summary: "List Status Page Issue States" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.Issues.ListStatusPageIssueStatesResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Issues" x-speakeasy-group: issues x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Issues.ListStates(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.issues.list(statuspage_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.issueStates.list({ statuspageID: "", }); console.log(result); } run(); /v4/statuspages/{statuspageID}/status: get: operationId: "StatusPages_listStatusPageStatuses" summary: "List Status Page Statuses" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: type: "object" required: - "data" properties: data: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.StatusPageStatusesResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages" x-speakeasy-group: statusPages x-speakeasy-name-override: listStatuses x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.GetStatuses(ctx, "") if err != nil { log.Fatal(err) } if res.Object != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.status_pages.list_statuses(statuspage_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPages.listStatuses({ statuspageID: "", }); console.log(result); } run(); /v4/statuspages/{statuspageID}/subscribers: get: operationId: "StatusPages_listSubscribers" summary: "List Subscribers" parameters: - name: "statuspageID" in: "path" required: true schema: type: "string" responses: "200": description: "The request has succeeded." content: application/json: schema: $ref: "#/components/schemas/V4.StatusPages.ListSubscribersResponse" "400": description: "The server could not understand the request due to invalid syntax." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "401": description: "Access is unauthorized." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "402": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "403": description: "Access is forbidden." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "404": description: "The server cannot find the requested resource." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "409": description: "The request conflicts with the current state of the server." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "422": description: "Client error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "500": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "502": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "503": description: "Service unavailable." content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" "504": description: "Server error" content: application/json: schema: type: "object" properties: meta: $ref: "#/components/schemas/Common.V3.ErrorMeta" required: - "meta" tags: - "Status Pages/Subscribers" x-speakeasy-group: subscribers x-speakeasy-name-override: list x-codeSamples: - lang: go label: Go (SDK) source: |- package main import( "context" "os" squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go" "log" ) func main() { ctx := context.Background() s := squadcastsdk.New( squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")), ) res, err := s.StatusPages.Subscribers.List(ctx, "") if err != nil { log.Fatal(err) } if res.V4StatusPagesListSubscribersResponse != nil { // handle response } } - lang: python label: Python (SDK) source: |- from squadcast_sdk import SquadcastSDK with SquadcastSDK( bearer_auth="", ) as ss_client: res = ss_client.subscribers.list(statuspage_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript"; const squadcastSDK = new SquadcastSDK({ bearerAuth: "", }); async function run() { const result = await squadcastSDK.statusPageSubscribers.list({ statuspageID: "", }); console.log(result); } run(); security: - BearerAuth: [] components: parameters: V3.Incidents.IncidentExportRequest.assignedToUserIDsAndTheirSquads: name: "assignedToUserIDsAndTheirSquads" in: "query" required: false schema: type: "array" items: type: "string" explode: false V3.Incidents.IncidentExportRequest.assigned_to: name: "assigned_to" in: "query" required: false schema: type: "array" items: type: "string" explode: false V3.Incidents.IncidentExportRequest.end_time: name: "end_time" in: "query" required: true schema: type: "string" format: "date-time" explode: false V3.Incidents.IncidentExportRequest.is_starred: name: "is_starred" in: "query" required: false schema: type: "string" enum: - "yes" - "no" explode: false V3.Incidents.IncidentExportRequest.notes: name: "notes" in: "query" required: false schema: type: "string" enum: - "present" - "absent" explode: false V3.Incidents.IncidentExportRequest.owner_id: name: "owner_id" in: "query" required: true schema: type: "string" explode: false V3.Incidents.IncidentExportRequest.priority: name: "priority" in: "query" required: false schema: type: "array" items: $ref: "#/components/schemas/V3.Incidents.IncidentPriority" explode: false V3.Incidents.IncidentExportRequest.retrospectives: name: "retrospectives" in: "query" required: false schema: type: "string" enum: - "yes" - "no" explode: false V3.Incidents.IncidentExportRequest.service_owner: name: "service_owner" in: "query" required: false schema: type: "string" explode: false V3.Incidents.IncidentExportRequest.services: name: "services" in: "query" required: false schema: type: "array" items: type: "string" explode: false V3.Incidents.IncidentExportRequest.slo_affecting: name: "slo_affecting" in: "query" required: false schema: type: "string" enum: - "yes" - "no" - "" explode: false V3.Incidents.IncidentExportRequest.slos: name: "slos" in: "query" required: false schema: type: "array" items: type: "integer" format: "int32" explode: false V3.Incidents.IncidentExportRequest.sort_by: name: "sort_by" in: "query" required: false schema: type: "string" enum: - "time" - "priority" explode: false V3.Incidents.IncidentExportRequest.sources: name: "sources" in: "query" required: false schema: type: "array" items: type: "string" explode: false V3.Incidents.IncidentExportRequest.start_time: name: "start_time" in: "query" required: true schema: type: "string" format: "date-time" explode: false V3.Incidents.IncidentExportRequest.status: name: "status" in: "query" required: false schema: type: "array" items: type: "string" explode: false V3.Incidents.IncidentExportRequest.tags: name: "tags" in: "query" required: false schema: type: "array" items: type: "string" explode: false V3.Incidents.IncidentExportRequest.textFilter: name: "textFilter" in: "query" required: false schema: type: "string" explode: false V3.Incidents.IncidentExportRequest.type: name: "type" in: "query" required: true schema: $ref: "#/components/schemas/V3.Incidents.ExportFormat" explode: false schemas: Common.V3.EntityOwner: type: "object" required: - "id" - "type" properties: id: type: "string" description: "The ID of the owner." type: type: "string" description: "The type of the owner ( \"user\", \"squad\")." description: "Represents the owner of an entity." Common.V3.ErrorMeta: type: "object" required: - "status" - "error_message" properties: status: anyOf: - type: "string" - type: "integer" error_message: type: "string" description: "Represents a single response containing data of type T." Common.V3.RBACEntityPermission: type: "object" required: - "user_id" - "abilities" properties: user_id: type: "string" description: "The ID of the user receiving the permission." abilities: type: "object" unevaluatedProperties: type: "boolean" description: "A map of abilities granted to the user." description: "Represents a permission granted to a user for a specific entity." Common.V3.RBACOwner: type: "object" required: - "id" - "type" properties: id: type: "string" description: "The ID of the owner." type: type: "string" enum: - "team" description: "The type of the owner." description: "Represents the RBAC owner of an entity." Common.V4.Error: type: "object" required: - "error" properties: error: type: "object" properties: code: type: "string" message: type: "string" details: type: "array" items: type: "object" properties: field: type: "string" message: type: "string" required: - "field" - "message" required: - "code" - "message" Common.V4.PageInfo: type: "object" required: - "pageSize" - "hasNext" - "hasPrevious" properties: pageSize: type: "integer" format: "int32" hasNext: type: "boolean" hasPrevious: type: "boolean" nextCursor: type: "string" previousCursor: type: "string" V3.Analytics.AnalyticsResponse: type: "object" required: - "mtta" - "mttr" properties: mtta: type: "number" mttr: type: "number" V3.AuditLogs.Actor: type: "object" required: - "userID" - "userName" - "userEmail" - "fullName" properties: userID: type: "string" userName: type: "string" userEmail: type: "string" fullName: type: "string" description: "Represents an actor (user) in audit logs" V3.AuditLogs.AuditLogIDResponse: type: "object" required: - "id" - "resource" - "action" - "actor" - "client" - "timestamp" - "timezone" - "team" - "tokenType" - "ipAddress" - "additionalInfo" - "userAgent" properties: id: type: "integer" format: "int32" resource: type: "string" action: type: "string" actor: $ref: "#/components/schemas/V3.AuditLogs.Actor" client: type: "string" timestamp: type: "string" timezone: type: "string" team: $ref: "#/components/schemas/V3.AuditLogs.Team" tokenType: type: "string" ipAddress: type: "string" additionalInfo: type: "string" meta: anyOf: - type: "object" unevaluatedProperties: {} - type: "null" userAgent: type: "string" description: "Represents detailed audit log entry response" V3.AuditLogs.AuditLogResponse: type: "object" required: - "id" - "resource" - "action" - "actor" - "client" - "timestamp" - "team" properties: id: type: "integer" format: "int32" resource: type: "string" action: type: "string" actor: $ref: "#/components/schemas/V3.AuditLogs.Actor" client: type: "string" timestamp: type: "string" team: $ref: "#/components/schemas/V3.AuditLogs.Team" description: "Represents an audit log entry response" V3.AuditLogs.AuditLogsExportHistoryResponse: type: "object" required: - "id" - "name" - "description" - "exportedAt" - "requestedBy" - "downloadLink" - "status" - "filters" properties: id: type: "string" name: type: "string" description: type: "string" exportedAt: type: "string" requestedBy: $ref: "#/components/schemas/V3.AuditLogs.Actor" downloadLink: type: "string" status: type: "string" filters: $ref: "#/components/schemas/V3.AuditLogs.Filters" description: "Response model for audit logs export history" V3.AuditLogs.ExportAuditLogsRequest: type: "object" required: - "filters" - "name" - "exportType" properties: filters: type: "object" properties: startDate: type: "string" format: "date" endDate: type: "string" format: "date" resource: type: "array" items: type: "string" action: type: "array" items: type: "string" actor: type: "array" items: type: "string" team: type: "array" items: type: "string" client: type: "array" items: type: "string" required: - "startDate" - "endDate" name: type: "string" minLength: 1 maxLength: 100 pattern: "^\\S" description: type: "string" maxLength: 300 exportType: type: "string" enum: - "csv" - "json" description: "Request model for exporting audit logs" V3.AuditLogs.ExportAuditLogsResponse: type: "object" required: - "data" properties: data: type: "object" properties: id: type: "string" message: type: "string" required: - "id" - "message" description: "Response model for exporting audit logs" V3.AuditLogs.Filters: type: "object" required: - "startDate" - "endDate" properties: startDate: type: "string" format: "date" endDate: type: "string" format: "date" resource: anyOf: - type: "array" items: type: "string" - type: "null" action: anyOf: - type: "array" items: type: "string" - type: "null" actor: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.AuditLogs.Actor" - type: "null" team: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.AuditLogs.Team" - type: "null" client: anyOf: - type: "array" items: type: "string" - type: "null" description: "Represents filters used in audit log queries" V3.AuditLogs.GetAuditLogByIDResponse: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.AuditLogs.AuditLogIDResponse" description: "Response model for getting audit log by ID" V3.AuditLogs.GetAuditLogExportHistoryByIDResponse: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.AuditLogs.AuditLogsExportHistoryResponse" description: "Response model for getting audit log export history by ID" V3.AuditLogs.GetFiltersResponse: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.AuditLogs.GetFiltersResponseData" description: "Response model for getting available filters" V3.AuditLogs.GetFiltersResponseData: type: "object" required: - "resources" - "resourceToActionsMap" - "clients" properties: resources: type: "array" items: type: "string" resourceToActionsMap: type: "object" unevaluatedProperties: type: "array" items: type: "string" clients: type: "array" items: type: "string" description: "Model for available filters data" V3.AuditLogs.ListAuditLogsExportHistoryResponse: type: "object" required: - "data" - "metadata" properties: data: type: "array" items: $ref: "#/components/schemas/V3.AuditLogs.AuditLogsExportHistoryResponse" metadata: type: "object" properties: totalCount: type: "integer" required: - "totalCount" description: "Response model for listing audit logs export history" V3.AuditLogs.ListAuditLogsResponse: type: "object" required: - "data" - "metadata" properties: data: type: "array" items: $ref: "#/components/schemas/V3.AuditLogs.AuditLogResponse" metadata: type: "object" properties: totalCount: type: "integer" required: - "totalCount" description: "Response model for listing audit logs" V3.AuditLogs.Team: type: "object" required: - "id" - "name" - "isDeleted" properties: id: type: "string" name: type: "string" isDeleted: type: "boolean" description: "Represents a team in audit logs" V3.Auth.AccessTokenData: type: "object" required: - "access_token" - "expires_at" - "issued_at" - "refresh_token" - "type" properties: access_token: type: "string" description: "JWT access token used as Bearer token for API requests." expires_at: type: "integer" format: "int64" description: "Unix timestamp when the access token expires." issued_at: type: "integer" format: "int64" description: "Unix timestamp when the access token was issued." refresh_token: type: "string" description: "Refresh token that can be used to obtain a new access token." type: type: "string" description: "Token type, e.g. \"Bearer\"." description: "Access token response returned by the OAuth endpoint." V3.EscalationPolicies.CreateEscalationPolicyRequest: type: "object" required: - "owner_id" - "name" - "description" - "repetition" - "repeat_after" - "rules" - "enable_incident_reminders" - "incident_reminder_rules" - "enable_incident_retrigger" - "retrigger_after" properties: owner_id: type: "string" description: "The ID of the team that owns this escalation policy." name: type: "string" description: "The name of the escalation policy." description: type: "string" description: "A description of the escalation policy." repetition: type: "integer" format: "int32" description: "The number of times the entire policy should be repeated." repeat_after: type: "integer" format: "int32" description: "The time in minutes after which the policy should be repeated." rules: type: "array" items: $ref: "#/components/schemas/V3.EscalationPolicies.EscalationPolicyRule" description: "The rules that define the escalation steps." enable_incident_reminders: type: "boolean" description: "Enable or disable incident reminders." incident_reminder_rules: type: "array" items: $ref: "#/components/schemas/V3.EscalationPolicies.IncidentReminderRule" description: "The rules for incident reminders." enable_incident_retrigger: type: "boolean" description: "Enable or disable automatic incident re-triggering." retrigger_after: type: "integer" format: "int32" description: "The time in hours after which an incident should be re-triggered." entity_owner: allOf: - $ref: "#/components/schemas/Common.V3.EntityOwner" description: "The owner of the entity." V3.EscalationPolicies.EscalationEntity: type: "object" required: - "type" properties: id: type: "string" description: "The unique identifier of the entity (user, squad, or schedule v1)." pid: type: "integer" format: "int32" description: "The unique identifier of the entity (schedule v2)." type: type: "string" enum: - "user" - "squad" - "schedule" - "schedulev2" description: "The type of the entity." description: "Represents an entity to be notified in an escalation rule." V3.EscalationPolicies.EscalationPolicyResponse: type: "object" required: - "id" - "name" - "description" - "organization_id" - "repetition" - "repeat_after" - "rules" - "slug" - "enable_incident_reminders" - "incident_reminder_rules" - "enable_incident_retrigger" - "retrigger_after" - "entity_owner" - "owner" - "access_control" properties: id: type: "string" description: "The unique identifier for the escalation policy." name: type: "string" description: "The name of the escalation policy." description: type: "string" description: "A description of the escalation policy." organization_id: type: "string" description: "The ID of the organization this policy belongs to." repetition: type: "integer" format: "int32" description: "The number of times the entire policy should be repeated." repeat_after: type: "integer" format: "int32" description: "The time in minutes after which the policy should be repeated." rules: type: "array" items: $ref: "#/components/schemas/V3.EscalationPolicies.EscalationPolicyRule" description: "The rules that define the escalation steps." slug: type: "string" description: "The URL-friendly slug for the policy name." enable_incident_reminders: type: "boolean" description: "Enable or disable incident reminders." incident_reminder_rules: type: "array" items: $ref: "#/components/schemas/V3.EscalationPolicies.IncidentReminderRule" description: "The rules for incident reminders." enable_incident_retrigger: type: "boolean" description: "Enable or disable automatic incident re-triggering." retrigger_after: type: "integer" format: "int32" description: "The time in hours after which an incident should be re-triggered." entity_owner: allOf: - $ref: "#/components/schemas/Common.V3.EntityOwner" description: "The owner of the entity." owner: allOf: - $ref: "#/components/schemas/Common.V3.RBACOwner" description: "The RBAC owner of the policy (typically a team)." access_control: type: "array" items: $ref: "#/components/schemas/Common.V3.RBACEntityPermission" description: "Access control list for this policy." description: "Represents an Escalation Policy in the system." V3.EscalationPolicies.EscalationPolicyRule: type: "object" required: - "escalationTime" - "via" - "roundrobin_enabled" - "roundrobin_next_index" - "entities" - "escalate_within_roundrobin" - "repetition" - "repeat_after" properties: escalationTime: type: "integer" format: "int32" description: "The time in minutes to wait before this rule is triggered." via: type: "array" items: type: "string" description: "The notification methods to use for this rule." roundrobin_enabled: type: "boolean" description: "Indicates if round-robin is enabled for the entities in this rule." roundrobin_next_index: type: "integer" format: "int32" description: "The index of the next entity to be notified in a round-robin setup." entities: type: "array" items: $ref: "#/components/schemas/V3.EscalationPolicies.EscalationEntity" description: "The entities to be notified in this rule." escalate_within_roundrobin: type: "boolean" description: "Indicates if escalation should happen within the round-robin rotation." repetition: type: "integer" format: "int32" description: "The number of times this specific rule should be repeated." repeat_after: type: "integer" format: "int32" description: "The time in minutes after which this rule should be repeated." description: "Represents a rule within an escalation policy." V3.EscalationPolicies.IncidentReminderRule: type: "object" required: - "via" - "time_interval" - "till" properties: via: type: "array" items: type: "string" description: "The notification methods to use for the reminder." time_interval: type: "integer" format: "int32" description: "The interval in minutes at which to send the reminder." till: type: "integer" format: "int32" description: "The duration in minutes for which to send reminders." description: "Represents a rule for sending incident reminders." V3.EscalationPolicies.UpdateEscalationPolicyRequest: type: "object" properties: owner_id: type: "string" description: "The ID of the team that owns this escalation policy." name: type: "string" description: "The name of the escalation policy." description: type: "string" description: "A description of the escalation policy." repetition: type: "integer" format: "int32" description: "The number of times the entire policy should be repeated." repeat_after: type: "integer" format: "int32" description: "The time in minutes after which the policy should be repeated." rules: type: "array" items: $ref: "#/components/schemas/V3.EscalationPolicies.EscalationPolicyRule" description: "The rules that define the escalation steps." enable_incident_reminders: type: "boolean" description: "Enable or disable incident reminders." incident_reminder_rules: type: "array" items: $ref: "#/components/schemas/V3.EscalationPolicies.IncidentReminderRule" description: "The rules for incident reminders." enable_incident_retrigger: type: "boolean" description: "Enable or disable automatic incident re-triggering." retrigger_after: type: "integer" format: "int32" description: "The time in hours after which an incident should be re-triggered." entity_owner: allOf: - $ref: "#/components/schemas/Common.V3.EntityOwner" description: "The owner of the entity." V3.Export.ExportResponse: type: "object" required: - "id" - "type" - "status" - "format" properties: id: type: "string" type: type: "string" status: type: "string" download_url: type: "string" download_url_expires_at: type: "string" format: type: "string" error_message: type: "string" V3.Extensions.MSTeams.ChannelConfiguration: type: "object" required: - "squadcast_team_id" - "squadcast_team_name" - "is_all_services" - "services" - "msteams_channel_id" - "msteams_channel_name" properties: id: type: "string" description: "The MongoDB ObjectID for this specific channel configuration entry." squadcast_team_id: type: "string" description: "The MongoDB ObjectID of the corresponding team in Squadcast." squadcast_team_name: type: "string" description: "The name of the corresponding team in Squadcast." is_all_services: type: "boolean" description: "If true, alerts for all services in the Squadcast Team are sent to this channel." services: type: "array" items: $ref: "#/components/schemas/V3.Extensions.MSTeams.SquadCastServiceMapping" description: "An array of specific services to route to this channel. Used when 'is_all_services' is false." msteams_channel_id: type: "string" description: "The unique identifier of the target channel in MS Teams." msteams_channel_name: type: "string" description: "The display name of the target channel in MS Teams." description: "Defines a mapping from a Squadcast Team/Service to a specific MS Teams channel." V3.Extensions.MSTeams.ConnectedTeam: type: "object" required: - "id" - "team_id" - "team_name" - "channel_configurations" properties: id: type: "string" team_id: type: "string" team_name: type: "string" channel_configurations: type: "array" items: $ref: "#/components/schemas/V3.Extensions.MSTeams.ChannelConfiguration" V3.Extensions.MSTeams.ConnectedTeams: type: "object" required: - "team_id" - "team_name" - "channel_configurations" properties: id: type: "string" description: "The MongoDB ObjectID for this connected team entry." team_id: type: "string" description: "The unique identifier for the team in MS Teams." team_name: type: "string" description: "The display name of the team in MS Teams." channel_configurations: type: "array" items: $ref: "#/components/schemas/V3.Extensions.MSTeams.ChannelConfiguration" description: "A list of channel routing configurations for this team." description: "Represents a connected MS Team and its channel configurations." V3.Extensions.MSTeams.CreateOrUpdateMSTeamsConfigRequest: type: "object" required: - "default_conversation_name" - "default_conversation_id" - "is_active" - "is_default_active" - "is_custom_channels_active" - "triggers" - "tenant_id" - "from_id" - "connected_teams" properties: custom_incident_alert_state: allOf: - $ref: "#/components/schemas/V3.Extensions.MSTeams.IncidentActionAlertState" description: "A user-friendly way to configure which incident action alerts are active. This is translated by the backend into the 'triggers.custom' array." id: type: "string" description: "The MongoDB ObjectID of the extension document. Should be included for updates." organization_id: type: "string" description: "The MongoDB ObjectID of the organization this extension belongs to." default_conversation_name: type: "string" description: "The display name for the default conversation/channel." default_conversation_id: type: "string" description: "The unique identifier for the default MS Teams conversation/channel." is_active: type: "boolean" description: "A master switch to enable or disable the entire integration." is_default_active: type: "boolean" description: "Determines if notifications should be sent to the default channel." is_custom_channels_active: type: "boolean" description: "Determines if notifications should be sent to custom-configured channels." triggers: allOf: - $ref: "#/components/schemas/V3.Extensions.MSTeams.Triggers" description: "Configuration for which alerts are sent to the MS Teams channel." tenant_id: type: "string" description: "The Azure AD Tenant ID of the organization that owns this extension." from_id: type: "string" description: "The Azure AD Object ID of the user who created this extension." connected_teams: type: "array" items: $ref: "#/components/schemas/V3.Extensions.MSTeams.ConnectedTeams" description: "A list of all MS Teams (teams) connected to this organization." description: "The request body for creating or updating an MS Teams extension configuration." V3.Extensions.MSTeams.CustomIncidentAlertState: type: "object" required: - "is_trigger_active" - "is_retrigger_active" - "is_acknowledge_active" - "is_resolve_active" - "is_reassign_active" - "is_notes_added_active" - "is_postmortem_active" - "is_priority_updated_active" properties: is_trigger_active: type: "boolean" is_retrigger_active: type: "boolean" is_acknowledge_active: type: "boolean" is_resolve_active: type: "boolean" is_reassign_active: type: "boolean" is_notes_added_active: type: "boolean" is_postmortem_active: type: "boolean" is_priority_updated_active: type: "boolean" V3.Extensions.MSTeams.EventClass: anyOf: - type: "string" - type: "string" enum: - "incident_triggered" - "incident_retriggered" - "incident_acknowledged" - "incident_resolved" - "incident_reassigned" - "incident_notes_added" - "incident_postmortem_started" - "incident_priority_updated" - "incident_snoozed" - "incident_unsnoozed" - "incident_delayed_notifications_resumed" description: "Represents the specific type of an incident-related event." V3.Extensions.MSTeams.ExtensionMSTeams: type: "object" required: - "default_conversation_name" - "default_conversation_id" - "is_active" - "is_default_active" - "is_custom_channels_active" - "triggers" - "tenant_id" - "from_id" - "connected_teams" properties: id: type: "string" description: "The MongoDB ObjectID of the extension document. Should be included for updates." organization_id: type: "string" description: "The MongoDB ObjectID of the organization this extension belongs to." default_conversation_name: type: "string" description: "The display name for the default conversation/channel." default_conversation_id: type: "string" description: "The unique identifier for the default MS Teams conversation/channel." is_active: type: "boolean" description: "A master switch to enable or disable the entire integration." is_default_active: type: "boolean" description: "Determines if notifications should be sent to the default channel." is_custom_channels_active: type: "boolean" description: "Determines if notifications should be sent to custom-configured channels." triggers: allOf: - $ref: "#/components/schemas/V3.Extensions.MSTeams.Triggers" description: "Configuration for which alerts are sent to the MS Teams channel." tenant_id: type: "string" description: "The Azure AD Tenant ID of the organization that owns this extension." from_id: type: "string" description: "The Azure AD Object ID of the user who created this extension." connected_teams: type: "array" items: $ref: "#/components/schemas/V3.Extensions.MSTeams.ConnectedTeams" description: "A list of all MS Teams (teams) connected to this organization." description: "The main configuration for the MS Teams extension." V3.Extensions.MSTeams.IncidentActionAlertState: type: "object" required: - "is_trigger_active" - "is_retrigger_active" - "is_acknowledge_active" - "is_resolve_active" - "is_reassign_active" - "is_notes_added_active" - "is_postmortem_active" - "is_priority_updated_active" properties: is_trigger_active: type: "boolean" is_retrigger_active: type: "boolean" is_acknowledge_active: type: "boolean" is_resolve_active: type: "boolean" is_reassign_active: type: "boolean" is_notes_added_active: type: "boolean" is_postmortem_active: type: "boolean" is_priority_updated_active: type: "boolean" description: "A set of booleans to easily configure which incident-related alerts are sent to MS Teams." V3.Extensions.MSTeams.MSTeamsConfig: type: "object" required: - "custom_incident_alert_state" - "id" - "organization_id" - "default_conversation_name" - "default_conversation_id" - "is_active" - "is_default_active" - "is_custom_channels_active" - "triggers" - "tenant_id" - "connected_teams" properties: custom_incident_alert_state: $ref: "#/components/schemas/V3.Extensions.MSTeams.CustomIncidentAlertState" id: type: "string" organization_id: type: "string" default_conversation_name: type: "string" default_conversation_id: type: "string" is_active: type: "boolean" is_default_active: type: "boolean" is_custom_channels_active: type: "boolean" triggers: $ref: "#/components/schemas/V3.Extensions.MSTeams.Triggers" tenant_id: type: "string" connected_teams: type: "array" items: $ref: "#/components/schemas/V3.Extensions.MSTeams.ConnectedTeam" V3.Extensions.MSTeams.MSTeamsConfigResponse: type: "object" required: - "default_conversation_name" - "default_conversation_id" - "is_active" - "is_default_active" - "is_custom_channels_active" - "triggers" - "tenant_id" - "from_id" - "connected_teams" properties: custom_incident_alert_state: allOf: - $ref: "#/components/schemas/V3.Extensions.MSTeams.IncidentActionAlertState" description: "A user-friendly way to configure which incident action alerts are active. This is translated by the backend into the 'triggers.custom' array." id: type: "string" description: "The MongoDB ObjectID of the extension document. Should be included for updates." organization_id: type: "string" description: "The MongoDB ObjectID of the organization this extension belongs to." default_conversation_name: type: "string" description: "The display name for the default conversation/channel." default_conversation_id: type: "string" description: "The unique identifier for the default MS Teams conversation/channel." is_active: type: "boolean" description: "A master switch to enable or disable the entire integration." is_default_active: type: "boolean" description: "Determines if notifications should be sent to the default channel." is_custom_channels_active: type: "boolean" description: "Determines if notifications should be sent to custom-configured channels." triggers: allOf: - $ref: "#/components/schemas/V3.Extensions.MSTeams.Triggers" description: "Configuration for which alerts are sent to the MS Teams channel." tenant_id: type: "string" description: "The Azure AD Tenant ID of the organization that owns this extension." from_id: type: "string" description: "The Azure AD Object ID of the user who created this extension." connected_teams: type: "array" items: $ref: "#/components/schemas/V3.Extensions.MSTeams.ConnectedTeams" description: "A list of all MS Teams (teams) connected to this organization." description: "The request body for creating or updating an MS Teams extension configuration." V3.Extensions.MSTeams.MSTeamsErrorMeta: type: "object" required: - "status" - "error_message" properties: status: anyOf: - type: "integer" - type: "string" error_message: type: "string" V3.Extensions.MSTeams.MSTeamsErrorResponse: type: "object" required: - "meta" properties: meta: $ref: "#/components/schemas/V3.Extensions.MSTeams.MSTeamsErrorMeta" V3.Extensions.MSTeams.SquadCastServiceMapping: type: "object" required: - "squadcast_service_id" - "squadcast_service_name" properties: squadcast_service_id: type: "string" description: "The MongoDB ObjectID of the Squadcast service." squadcast_service_name: type: "string" description: "The name of the Squadcast service." description: "Maps a specific Squadcast service to a channel configuration." V3.Extensions.MSTeams.Triggers: type: "object" required: - "all_active" - "custom" properties: all_active: type: "boolean" description: "If true, all alerts are sent, and the 'custom' list is ignored." custom: type: "array" items: $ref: "#/components/schemas/V3.Extensions.MSTeams.EventClass" description: "A list of specific event classes to send alerts for. This is used when 'all_active' is false." description: "Defines the trigger conditions for sending alerts." V3.Extensions.Webhooks.GetAllWebhooksResponse: type: "object" required: - "data" properties: data: type: "object" properties: result: type: "array" items: $ref: "#/components/schemas/V3.Extensions.Webhooks.WebhookListItem" meta: type: "object" properties: total_count: type: "integer" required: - "total_count" required: - "result" - "meta" V3.Extensions.Webhooks.Webhook: type: "object" required: - "name" - "triggers" - "urls" - "trigger_type" properties: name: type: "string" description: "Name of the webhook" description: type: "string" description: "Description of the webhook" triggers: type: "array" items: $ref: "#/components/schemas/V3.Extensions.Webhooks.WebhookTrigger" description: "A list of triggers for this webhook" urls: type: "array" items: $ref: "#/components/schemas/V3.Extensions.Webhooks.WebhookUrl" description: "A list of URLs to which the webhook payload will be sent" header: anyOf: - type: "object" unevaluatedProperties: type: "string" - type: "null" description: "Headers to be sent with the webhook" filters: anyOf: - $ref: "#/components/schemas/V3.Extensions.Webhooks.WebhookFilter" - type: "null" description: "Filters to apply to the webhook" max_retry: type: "integer" format: "uint8" description: "Maximum number of retries for the webhook" teams: anyOf: - type: "array" items: type: "string" - type: "null" description: "List of team IDs to which this webhook is applicable" is_all_teams_configured: type: "boolean" description: "Set to true if the webhook is configured for all teams" custom_payload_template_slug: type: "string" description: "Slug of the custom payload template" language: type: "string" description: "Language for the webhook payload" mail_ids: anyOf: - type: "array" items: type: "string" - type: "null" description: "List of email IDs for notification" trigger_type: type: "string" description: "Type of trigger" custom_payload: type: "string" description: "Custom payload for the webhook" payload_type: type: "string" description: "Type of payload" V3.Extensions.Webhooks.WebhookErrorMeta: type: "object" required: - "status" - "error_message" properties: status: anyOf: - type: "integer" - type: "string" error_message: type: "string" V3.Extensions.Webhooks.WebhookErrorResponse: type: "object" required: - "meta" properties: meta: $ref: "#/components/schemas/V3.Extensions.Webhooks.WebhookErrorMeta" V3.Extensions.Webhooks.WebhookFilter: type: "object" required: - "op" - "conditions" properties: op: type: "string" conditions: type: "array" items: $ref: "#/components/schemas/V3.Extensions.Webhooks.WebhookFilterCondition" V3.Extensions.Webhooks.WebhookFilterCondition: type: "object" properties: op: type: "string" lhs: type: "string" rhs: type: "string" V3.Extensions.Webhooks.WebhookListItem: type: "object" required: - "id" - "name" - "description" - "trigger_type" - "payload_type" - "custom_payload_template_name" properties: id: type: "string" name: type: "string" description: type: "string" trigger_type: type: "string" payload_type: type: "string" custom_payload_template_name: type: "string" V3.Extensions.Webhooks.WebhookResponse: type: "object" required: - "id" - "created_at" - "updated_at" - "author_id" - "slug" properties: id: type: "string" created_at: type: "string" updated_at: type: "string" organization_id: type: "string" author_id: type: "string" slug: type: "string" version: type: "string" allOf: - $ref: "#/components/schemas/V3.Extensions.Webhooks.Webhook" V3.Extensions.Webhooks.WebhookTrigger: type: "object" required: - "event_class" - "event_type" properties: event_class: type: "string" event_type: type: "string" V3.Extensions.Webhooks.WebhookUrl: type: "object" properties: url: type: "string" method: type: "string" V3.GlobalEventRules.CreateGlobalEventRuleRequest: type: "object" required: - "name" - "description" - "owner_id" - "entity_owner" properties: name: type: "string" description: type: "string" owner_id: type: "string" entity_owner: $ref: "#/components/schemas/V3.GlobalEventRules.EntityOwner" V3.GlobalEventRules.CreateGlobalEventRuleResponse: type: "object" required: - "org_id" properties: org_id: type: "string" allOf: - $ref: "#/components/schemas/V3.GlobalEventRules.CreatedGlobalEventRule" V3.GlobalEventRules.CreateOrUpdateRuleRequest: type: "object" required: - "description" - "expression" - "action" properties: description: type: "string" expression: type: "string" action: $ref: "#/components/schemas/V3.GlobalEventRules.RuleAction" V3.GlobalEventRules.CreateRulesetRequest: type: "object" required: - "alert_source_shortname" - "alert_source_version" properties: alert_source_shortname: type: "string" alert_source_version: type: "string" catch_all_action: $ref: "#/components/schemas/V3.GlobalEventRules.RuleAction" V3.GlobalEventRules.CreatedGlobalEventRule: type: "object" required: - "id" - "owner_id" - "name" - "description" - "routing_key" - "created_at" - "created_by" - "updated_at" - "updated_by" properties: id: type: "integer" owner_id: type: "string" name: type: "string" description: type: "string" routing_key: type: "string" entity_owner: $ref: "#/components/schemas/V3.GlobalEventRules.EntityOwner" rulesets: type: "array" items: $ref: "#/components/schemas/V3.GlobalEventRules.Ruleset" created_at: type: "string" format: "date-time" created_by: type: "string" updated_at: type: "string" format: "date-time" updated_by: type: "string" V3.GlobalEventRules.CreatedGlobalEventRuleResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.GlobalEventRules.CreatedGlobalEventRule" V3.GlobalEventRules.EntityOwner: type: "object" required: - "id" - "type" properties: id: type: "string" type: type: "string" enum: - "team" - "user" - "squad" V3.GlobalEventRules.EntityOwnerUpdate: type: "object" properties: id: type: "string" type: type: "string" enum: - "team" - "user" - "squad" V3.GlobalEventRules.GlobalEventRule: type: "object" allOf: - $ref: "#/components/schemas/V3.GlobalEventRules.CreatedGlobalEventRule" V3.GlobalEventRules.GlobalEventRuleInList: type: "object" properties: id: type: "integer" org_id: type: "string" team_id: type: "string" name: type: "string" description: type: "string" routing_key: type: "string" entity_owner: $ref: "#/components/schemas/V3.GlobalEventRules.EntityOwner" rulesets: type: "array" items: $ref: "#/components/schemas/V3.GlobalEventRules.Ruleset" created_at: type: "string" format: "date-time" created_by: type: "string" updated_at: type: "string" format: "date-time" updated_by: type: "string" V3.GlobalEventRules.GlobalEventRuleResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.GlobalEventRules.GlobalEventRule" V3.GlobalEventRules.Ordering: type: "object" required: - "ordering" properties: ordering: type: "array" items: type: "integer" V3.GlobalEventRules.OrderingResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.GlobalEventRules.Ordering" V3.GlobalEventRules.ReorderRuleRequest: type: "object" properties: shift_to: type: "string" shift_index_by: type: "integer" V3.GlobalEventRules.ReorderRulesetRequest: type: "object" properties: ordering: type: "array" items: type: "integer" V3.GlobalEventRules.RuleAction: type: "object" required: - "route_to" properties: route_to: type: "string" description: "The service ID to which the alert should be routed." V3.GlobalEventRules.RuleActionUpdate: type: "object" properties: route_to: type: "string" description: "The service ID to which the alert should be routed." V3.GlobalEventRules.Ruleset: type: "object" properties: id: type: "integer" global_event_rule_id: type: "integer" alert_source_shortname: type: "string" alert_source_version: type: "string" ordering: type: "array" items: type: "integer" catch_all_action: $ref: "#/components/schemas/V3.GlobalEventRules.RuleAction" created_at: type: "string" format: "date-time" created_by: type: "string" updated_at: type: "string" format: "date-time" updated_by: type: "string" V3.GlobalEventRules.RulesetResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.GlobalEventRules.Ruleset" V3.GlobalEventRules.RulesetRule: type: "object" properties: id: type: "integer" global_event_rule_id: type: "integer" description: type: "string" expression: type: "string" action: $ref: "#/components/schemas/V3.GlobalEventRules.RuleAction" created_at: type: "string" format: "date-time" created_by: type: "string" updated_at: type: "string" format: "date-time" updated_by: type: "string" V3.GlobalEventRules.RulesetRuleResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.GlobalEventRules.RulesetRule" V3.GlobalEventRules.UpdateGlobalEventRuleRequest: type: "object" properties: name: type: "string" description: type: "string" entity_owner: $ref: "#/components/schemas/V3.GlobalEventRules.EntityOwnerUpdate" V3.GlobalEventRules.UpdateRuleRequest: type: "object" properties: description: type: "string" expression: type: "string" action: $ref: "#/components/schemas/V3.GlobalEventRules.RuleActionUpdate" V3.GlobalEventRules.UpdateRulesetRequest: type: "object" properties: catch_all_action: $ref: "#/components/schemas/V3.GlobalEventRules.RuleActionUpdate" V3.GlobalOncallReminderRules.CreateGlobalOncallReminderRulesRequest: type: "object" required: - "is_enabled" - "owner_id" - "rules" properties: is_enabled: type: "boolean" owner_id: type: "string" rules: type: "array" items: $ref: "#/components/schemas/V3.GlobalOncallReminderRules.Rule" V3.GlobalOncallReminderRules.GlobalOncallReminderRule: type: "object" required: - "id" - "is_enabled" - "owner_id" - "rules" properties: id: type: "integer" is_enabled: type: "boolean" owner_id: type: "string" rules: type: "array" items: $ref: "#/components/schemas/V3.GlobalOncallReminderRules.Rule" V3.GlobalOncallReminderRules.GlobalOncallReminderRuleResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.GlobalOncallReminderRules.GlobalOncallReminderRule" V3.GlobalOncallReminderRules.Rule: type: "object" required: - "type" - "time" properties: type: type: "string" time: type: "integer" V3.GlobalOncallReminderRules.UpdateGlobalOncallReminderRulesRequest: type: "object" required: - "is_enabled" - "rules" properties: is_enabled: type: "boolean" rules: type: "array" items: $ref: "#/components/schemas/V3.GlobalOncallReminderRules.Rule" V3.Incidents.AdditionalResponderDetails: type: "object" required: - "id" - "type" - "timeOfAssignment" - "reason" - "name" - "last_notified_at" properties: id: type: "string" type: type: "string" timeOfAssignment: type: "string" format: "date-time" reason: type: "string" name: type: "string" last_notified_at: type: "string" format: "date-time" description: "Details for an additional responder." V3.Incidents.AdditionalResponders.AddAdditionalRespondersRequest: type: "object" required: - "additional_responders" properties: additional_responders: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" required: - "id" - "type" description: "Request body for adding additional responders to an incident." V3.Incidents.AdditionalResponders.AdditionalResponder: type: "object" required: - "id" - "type" properties: id: type: "string" type: type: "string" name: type: "string" time_of_assignment: type: "string" description: "Represents an additional responder for an incident." V3.Incidents.AdditionalResponders.AdditionalResponderResponse: type: "object" required: - "additional_responders" properties: additional_responders: type: "array" items: $ref: "#/components/schemas/V3.Incidents.AdditionalResponders.AdditionalResponder" V3.Incidents.Analytics: type: "object" required: - "tta" - "ttr" properties: tta: $ref: "#/components/schemas/V3.Incidents.AnalyticsMetrics" ttr: $ref: "#/components/schemas/V3.Incidents.AnalyticsMetrics" description: "Incident analytics data." V3.Incidents.AnalyticsMetrics: type: "object" required: - "time" - "userId" - "escalationPolicyId" - "squadId" properties: time: type: "integer" userId: type: "string" escalationPolicyId: type: "string" squadId: type: "string" description: "Analytics metrics for TTA (Time to Acknowledge) and TTR (Time to Resolve)." V3.Incidents.Apta.Message: type: "object" required: - "message" properties: message: type: "string" V3.Incidents.Apta.MessageResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Incidents.Apta.Message" V3.Incidents.AssignTo: type: "object" required: - "id" properties: id: type: "string" type: type: "string" description: "Represents the assignment target for delayed notifications." V3.Incidents.AssignedTo: type: "object" required: - "id" - "type" - "timeOfAssignment" - "reason" properties: id: type: "string" type: type: "string" timeOfAssignment: type: "string" format: "date-time" reason: type: "string" description: "Schema for an assigned entity in an incident." V3.Incidents.AttachedRunbook: type: "object" required: - "runbook_id" - "name" - "steps" properties: runbook_id: type: "string" name: type: "string" steps: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Step" V3.Incidents.BulkIncidentIDsRequest: type: "object" required: - "incident_ids" properties: incident_ids: type: "array" items: type: "string" maxItems: 100 description: "Request body for bulk incident operations (acknowledge, resolve)." V3.Incidents.BulkIncidentsPriorityUpdateRequest: type: "object" required: - "incident_ids" - "priority" properties: incident_ids: type: "array" items: type: "string" priority: type: "string" description: "Request body for bulk updating incident priority." V3.Incidents.CommunicationCards.ArchiveSlackChannelRequest: type: "object" required: - "slack_channel_id" properties: slack_channel_id: type: "string" description: "Request body for archiving a Slack channel." V3.Incidents.CommunicationCards.CommunicationCard: type: "object" required: - "created_at" - "updated_at" - "deleted_at" - "id" - "incident_id" - "url" - "type" - "title" - "channel_id" - "archived_at" properties: created_at: type: "string" updated_at: type: "string" deleted_at: {} id: type: "integer" incident_id: type: "string" url: type: "string" type: type: "string" title: type: "string" channel_id: type: "string" archived_at: {} description: "Represents a communication card." V3.Incidents.CommunicationCards.CommunicationCardResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Incidents.CommunicationCards.CommunicationCard" V3.Incidents.CommunicationCards.CreateCommunicationCardRequest: type: "object" required: - "type" - "url" - "title" properties: type: type: "string" url: type: "string" title: type: "string" description: "Request body for creating a communication card." V3.Incidents.CommunicationCards.CreateSlackChannelRequest: type: "object" required: - "channel_name" - "incident_id" properties: channel_name: type: "string" incident_id: type: "string" description: "Request body for creating a Slack channel in a communication card." V3.Incidents.CommunicationCards.UpdateCommunicationCardRequest: type: "object" required: - "title" - "type" - "url" properties: title: type: "string" type: type: "string" url: type: "string" description: "Request body for updating a communication card." V3.Incidents.DedupData: type: "object" properties: key: type: "string" hash: type: "string" description: "Deduplication data for an incident." V3.Incidents.Export: type: "object" required: - "id" - "organization_id" - "team_id" - "created_at" - "updated_at" - "requested_by" - "type" - "status" - "download_url" - "format" - "start_time" - "end_time" - "incidents_filter" - "on_call_hours_filter" - "additionalInfo" - "error_message" properties: id: type: "string" organization_id: type: "string" team_id: type: "string" status_page_id: type: "integer" created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" requested_by: type: "string" type: $ref: "#/components/schemas/V3.Incidents.ExportType" status: $ref: "#/components/schemas/V3.Incidents.ExportStatus" download_url: type: "string" format: $ref: "#/components/schemas/V3.Incidents.ExportFormat" start_time: type: "string" format: "date-time" end_time: type: "string" format: "date-time" incidents_filter: $ref: "#/components/schemas/V3.Incidents.ExportIncidentsFilter" on_call_hours_filter: $ref: "#/components/schemas/V3.Incidents.ExportOnCallHoursFilter" additionalInfo: type: "object" unevaluatedProperties: {} error_message: type: "string" description: "Represents an export record." V3.Incidents.ExportFormat: type: "string" enum: - "json" - "csv" description: "Defines the format of the export." V3.Incidents.ExportIncidentsCSVFields: type: "object" required: - "id" - "title" - "description" - "status" - "service" - "alert_source" - "assignee" - "created_at" - "acknowledged_at" - "resolved_at" - "slo_name" - "slis" - "error_budget_spent" - "tags" - "event_count" - "tta" - "ttr" - "children" - "logs" - "url" - "priority" - "attached_runbooks" - "incident_tasks" - "incident_tasks_total_count" - "incident_tasks_open_count" - "incident_tasks_closed_count" - "incident_tasks_count" properties: id: type: "string" title: type: "string" description: type: "string" status: type: "string" service: type: "string" alert_source: type: "string" assignee: type: "string" created_at: type: "string" format: "date-time" acknowledged_at: type: "string" format: "date-time" resolved_at: type: "string" format: "date-time" slo_name: type: "string" slis: type: "array" items: type: "string" error_budget_spent: type: "number" format: "float" tags: type: "object" unevaluatedProperties: $ref: "#/components/schemas/V3.Incidents.TagConfigObject" event_count: type: "integer" tta: type: "integer" ttr: type: "integer" children: type: "array" items: $ref: "#/components/schemas/V3.Incidents.MergeIncidentEntityReference" logs: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Logs" url: type: "string" priority: type: "string" attached_runbooks: type: "array" items: $ref: "#/components/schemas/V3.Incidents.AttachedRunbook" incident_tasks: type: "array" items: $ref: "#/components/schemas/V3.Incidents.IncidentTasks" incident_tasks_total_count: type: "integer" incident_tasks_open_count: type: "integer" incident_tasks_closed_count: type: "integer" incident_tasks_count: $ref: "#/components/schemas/V3.Incidents.IncidentTasksCount" description: "Represents the fields for an incidents CSV export." V3.Incidents.ExportIncidentsFilter: type: "object" required: - "services" - "sources" - "serviceOwner" - "assigned_to" - "assignedToUserIDsAndTheirSquads" - "statuses" - "priority" - "tags" - "notes" properties: services: type: "array" items: type: "string" sources: type: "array" items: type: "string" serviceOwner: $ref: "#/components/schemas/V3.Incidents.ServiceOwnerFilter" assigned_to: type: "array" items: type: "string" assignedToUserIDsAndTheirSquads: type: "array" items: type: "string" statuses: type: "array" items: type: "string" priority: type: "array" items: $ref: "#/components/schemas/V3.Incidents.IncidentPriority" tags: type: "array" items: type: "string" notes: type: "string" description: "Filter criteria for incidents in an export." V3.Incidents.ExportOnCallHoursFilter: type: "object" required: - "schedule_ids" - "schedule_owner" properties: schedule_ids: type: "array" items: type: "string" schedule_owner: type: "array" items: type: "string" description: "Filter criteria for on-call hours in an export." V3.Incidents.ExportStatus: type: "string" enum: - "pending" - "running" - "completed" - "failed" description: "Defines the status of an export job." V3.Incidents.ExportType: type: "string" enum: - "incidents" - "statuspage-subscribers" - "schedules-on-call-hours-per-user" description: "Defines the type of data being exported." V3.Incidents.Incident: type: "object" required: - "id" - "service_id" - "alert_source_id" - "organization_id" - "incidentNumber" - "message" - "assignedTo" - "additional_responders" - "description" - "status" - "timeOfCreation" - "updated_at" - "tags" - "logs" - "analytics" - "pinned_messages" - "deleted" - "event_count" - "dedup_data" - "owner" - "access_control" - "relevantUsers" - "relevantEscalationPolicies" - "relevantSquads" - "relevantSchedules" - "relevantPeopleLogs" - "responseNotes" - "attachments" - "is_child" - "children" - "did_auto_pause" - "did_auto_pause_timeout" - "auto_pause_ends_at" - "manually_marked_transient_alert_feedback_type" - "classification_id" - "grouped_alert_count" - "has_priority" - "snooze_details" - "did_notification_delay" - "notification_delay_policy" - "digest_id" properties: id: type: "string" service_id: type: "string" alert_source_id: type: "string" organization_id: type: "string" slo_id: type: "integer" incidentNumber: type: "integer" message: type: "string" assignedTo: type: "array" items: $ref: "#/components/schemas/V3.Incidents.AssignedTo" additional_responders: type: "array" items: $ref: "#/components/schemas/V3.Incidents.AdditionalResponderDetails" description: type: "string" status: type: "string" timeOfCreation: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" last_acknowledged_at: anyOf: - type: "string" format: "date-time" - type: "null" tags: type: "object" unevaluatedProperties: $ref: "#/components/schemas/V3.Incidents.TagConfigObject" logs: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Logs" analytics: $ref: "#/components/schemas/V3.Incidents.Analytics" pinned_messages: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Incidents.PinnedMessage" - type: "null" created_by: type: "string" sender_email: type: "string" deleted: type: "boolean" event_count: type: "integer" dedup_data: $ref: "#/components/schemas/V3.Incidents.DedupData" owner: $ref: "#/components/schemas/Common.V3.RBACOwner" access_control: anyOf: - type: "array" items: $ref: "#/components/schemas/Common.V3.RBACEntityPermission" - type: "null" relevantUsers: anyOf: - type: "array" items: type: "string" - type: "null" relevantEscalationPolicies: anyOf: - type: "array" items: type: "string" - type: "null" relevantSquads: anyOf: - type: "array" items: type: "string" - type: "null" relevantSchedules: anyOf: - type: "array" items: type: "string" - type: "null" relevantPeopleLogs: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Incidents.RelevantPeopleLog" - type: "null" responseNotes: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Incidents.ResponseNote" - type: "null" attachments: anyOf: - type: "array" items: type: "string" - type: "null" retriggerPolicy: anyOf: - type: "object" properties: escalationPolicyId: type: "string" retriggerAt: type: "string" format: "date-time" retriggeredAt: type: "string" format: "date-time" required: - "escalationPolicyId" - type: "null" webform_id: type: "integer" webform_submission_id: type: "integer" is_child: type: "boolean" parent: $ref: "#/components/schemas/V3.Incidents.MergeIncidentEntityReference" children: type: "array" items: $ref: "#/components/schemas/V3.Incidents.MergeIncidentEntityReference" did_auto_pause: type: "boolean" did_auto_pause_timeout: type: "boolean" auto_pause_ends_at: type: "string" format: "date-time" manually_marked_transient_alert_feedback_type: type: "string" classification_id: type: "integer" grouped_alert_count: type: "integer" priority: $ref: "#/components/schemas/V3.Incidents.IncidentPriority" has_priority: type: "boolean" snooze_details: $ref: "#/components/schemas/V3.Incidents.SnoozeDetails" did_notification_delay: type: "boolean" notification_delay_policy: $ref: "#/components/schemas/V3.Incidents.NotificationDelayPolicy" digest_id: type: "string" description: "Represents an incident." V3.Incidents.IncidentActions.CircleCIErrorMeta: type: "object" required: - "status_code" - "error_message" properties: status_code: type: "integer" error_message: type: "string" description: "Represents the metadata for a CircleCI error response." V3.Incidents.IncidentActions.CircleCIRebuildResponse: type: "object" required: - "action_id" - "circleci_response" properties: action_id: type: "string" circleci_response: type: "object" properties: username: type: "string" reponame: type: "string" build_num: type: "integer" build_url: type: "string" build_parameters: type: "object" properties: CIRCLE_JOB: type: "string" required: - "CIRCLE_JOB" previous: type: "object" properties: build_num: type: "integer" build_time_millis: type: "integer" status: type: "string" required: - "build_num" - "build_time_millis" - "status" previous_successful_build: type: "object" properties: build_num: type: "integer" build_time_millis: type: "integer" status: type: "string" required: - "build_num" - "build_time_millis" - "status" retry_of: type: "integer" body: type: "string" subject: type: "string" status: type: "string" lifecycle: type: "string" outcome: type: "string" committer_date: type: "string" committer_email: type: "string" committer_name: type: "string" author_date: type: "string" author_email: type: "string" author_name: type: "string" branch: type: "string" vcs_type: type: "string" vcs_url: type: "string" start_time: type: "string" stop_time: type: "string" required: - "username" - "reponame" - "build_num" - "build_url" - "build_parameters" - "previous" - "previous_successful_build" - "retry_of" - "body" - "subject" - "status" - "lifecycle" - "outcome" - "committer_date" - "committer_email" - "committer_name" - "author_date" - "author_email" - "author_name" - "branch" - "vcs_type" - "vcs_url" - "start_time" - "stop_time" description: "Represents the response structure for rebuilding a project in CircleCI." V3.Incidents.IncidentActions.IncidentActionErrorMeta: type: "object" required: - "status" - "error_message" properties: status: type: "integer" error_message: type: "string" description: "Represents the metadata for a generic incident action error response." V3.Incidents.IncidentActions.IncidentActionErrorResponse: type: "object" required: - "body" properties: body: type: "object" properties: meta: $ref: "#/components/schemas/V3.Incidents.IncidentActions.IncidentActionErrorMeta" required: - "meta" description: "Represents a generic incident action error response for a 400 status code." V3.Incidents.IncidentActions.RebuildCircleCIProjectRequest: type: "object" required: - "vcs_type" - "username" - "reponame" properties: vcs_type: type: "string" username: type: "string" reponame: type: "string" description: "Request body for rebuilding a project in CircleCI." V3.Incidents.IncidentActions.WebhookActionResponse: type: "object" required: - "id" - "created_at" - "updated_at" - "version" - "organization_id" - "author_id" - "name" - "slug" - "description" - "triggers" - "urls" - "teams" - "is_all_teams_configured" - "custom_payload_template_slug" - "header" - "filters" - "trigger_type" - "language" - "max_retry" - "mail_ids" - "payload_type" - "custom_payload" properties: id: type: "string" created_at: type: "string" updated_at: type: "string" version: type: "string" organization_id: type: "string" author_id: type: "string" name: type: "string" slug: type: "string" description: type: "string" triggers: type: "array" items: type: "string" urls: type: "array" items: type: "object" properties: url: type: "string" method: type: "string" teams: type: "array" items: type: "string" is_all_teams_configured: type: "boolean" custom_payload_template_slug: type: "string" header: type: "object" properties: Content-Type: type: "string" required: - "Content-Type" filters: {} trigger_type: type: "string" language: type: "string" max_retry: type: "integer" mail_ids: type: "array" items: type: "string" payload_type: type: "string" custom_payload: type: "string" description: "Represents the response structure for triggering a webhook manually." V3.Incidents.IncidentEvent: type: "object" required: - "incident_id" - "alert_source_id" - "message" - "description" - "time_of_creation" - "tags" - "payload" properties: incident_id: type: "string" alert_source_id: type: "string" message: type: "string" description: type: "string" time_of_creation: type: "string" format: "date-time" tags: anyOf: - type: "object" unevaluatedProperties: {} - type: "null" deduplication_reason: type: "object" properties: matched_event_id: type: "string" evaluated_expression: type: "string" time_window: type: "integer" required: - "matched_event_id" - "evaluated_expression" - "time_window" payload: type: "object" unevaluatedProperties: {} description: "Represents an incident event." V3.Incidents.IncidentEventResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Incidents.IncidentEvent" V3.Incidents.IncidentExportAsyncRequest: type: "object" required: - "owner_id" - "type" - "start_time" - "end_time" - "incident_filters" properties: owner_id: type: "string" type: allOf: - $ref: "#/components/schemas/V3.Incidents.ExportFormat" description: "Type of export, can be csv or json" start_time: type: "string" format: "date-time" end_time: type: "string" format: "date-time" incident_filters: $ref: "#/components/schemas/V3.Incidents.ExportIncidentsFilter" description: "Request body for async incident export." V3.Incidents.IncidentExportAsyncResponse: type: "object" required: - "message" - "request_id" properties: message: type: "string" request_id: type: "string" V3.Incidents.IncidentPriority: type: "string" enum: - "P1" - "P2" - "P3" - "P4" - "P5" description: "Represents the priority of an incident." V3.Incidents.IncidentPriorityUpdateRequest: type: "object" properties: priority: type: "string" description: "Request body for updating incident priority." V3.Incidents.IncidentPriorityUpdateResponse: type: "object" required: - "incident_id" - "priority" properties: incident_id: type: "string" priority: type: "string" V3.Incidents.IncidentResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Incidents.Incident" V3.Incidents.IncidentTasks: type: "object" required: - "id" - "incident_id" - "tasks" - "deleted" - "deleted_at" properties: id: type: "string" incident_id: type: "string" tasks: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Task" deleted: type: "boolean" deleted_at: type: "string" format: "date-time" description: "Represents incident tasks." V3.Incidents.IncidentTasksCount: type: "object" required: - "total" - "open" - "completed" properties: total: type: "integer" open: type: "integer" completed: type: "integer" description: "Represents the count of incident tasks." V3.Incidents.IndividualRequestStatusResponse: type: "object" required: - "status" properties: status: $ref: "#/components/schemas/V3.Incidents.RequestStatus" incident_id: type: "string" event_id: type: "string" description: "Represents the status of a single ingestion request." V3.Incidents.IngestionStatusRequest: type: "object" required: - "request_ids" properties: request_ids: type: "array" items: type: "string" description: "Request body for getting ingestion status." V3.Incidents.Logs: type: "object" required: - "action" - "time" - "reason" properties: action: type: "string" is_manually_created: type: "boolean" created_by: type: "string" updated_by: type: "string" assignedTo: type: "string" assignedBy: type: "string" id: type: "string" workflow_id: type: "integer" time: type: "string" format: "date-time" reason: type: "string" additionalInfo: anyOf: - type: "object" unevaluatedProperties: {} - type: "null" type: type: "string" should_show_in_postmortem: type: "boolean" description: "Represents a log entry for an incident action." V3.Incidents.MergeIncidentEntityReference: type: "object" required: - "id" properties: id: type: "string" description: "Reference to a merged incident entity." V3.Incidents.Notes.CreateNoteRequest: type: "object" required: - "message" - "attachments" properties: message: type: "string" attachments: type: "array" items: type: "string" description: "Request body for creating a new note." V3.Incidents.Notes.Note: type: "object" required: - "id" - "created_at" - "updated_at" - "organization_id" - "incident_id" - "user_id" - "message" - "type" - "attachments" - "user" - "replaced_message" properties: id: type: "string" created_at: type: "string" updated_at: type: "string" organization_id: type: "string" incident_id: type: "string" user_id: type: "string" message: type: "string" type: type: "string" attachments: type: "array" items: type: "string" user: type: "object" properties: id: type: "string" first_name: type: "string" last_name: type: "string" deleted: type: "boolean" required: - "id" - "first_name" - "last_name" - "deleted" replaced_message: type: "string" description: "Represents a note associated with an incident." V3.Incidents.Notes.NoteResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Incidents.Notes.Note" V3.Incidents.Notes.UpdateNoteRequest: type: "object" required: - "message" - "attachments" properties: message: type: "string" attachments: type: "array" items: type: "string" description: "Request body for updating an existing note." V3.Incidents.NotificationDelayPolicy: type: "object" required: - "is_notification_delayed" - "delayed_until" - "assign_to" properties: is_notification_delayed: type: "boolean" delayed_until: type: "string" format: "date-time" assign_to: $ref: "#/components/schemas/V3.Incidents.AssignTo" description: "Policy for delaying notifications." V3.Incidents.PinnedMessage: type: "object" required: - "message" - "message_sender_id" - "time" - "time_of_pinning" - "message_id" - "message_pinned_by" - "message_sender_name" properties: message: type: "string" message_sender_id: type: "string" time: type: "string" format: "date-time" time_of_pinning: type: "string" format: "date-time" message_id: type: "string" message_pinned_by: type: "string" message_sender_name: type: "string" description: "Represents a pinned message in the warroom." V3.Incidents.Postmortems.CreatePostmortemRequest: type: "object" required: - "owner_id" - "title" - "postmortem" - "status" - "follow_ups" - "attachments" properties: owner_id: type: "string" title: type: "string" postmortem: type: "string" status: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemStatus" follow_ups: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemFollowUp" attachments: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemAttachmentRequest" description: "Request body for creating a new postmortem." V3.Incidents.Postmortems.Postmortem: type: "object" required: - "id" - "organization_id" - "incident_id" - "postmortem" - "follow_ups" - "created_at" - "title" - "status" - "owner" - "access_control" properties: id: type: "string" organization_id: type: "string" incident_id: type: "string" postmortem: type: "string" follow_ups: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemFollowUp" - type: "null" created_at: type: "string" title: type: "string" status: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemStatus" owner: $ref: "#/components/schemas/Common.V3.RBACOwner" access_control: type: "array" items: $ref: "#/components/schemas/Common.V3.RBACEntityPermission" attachments: anyOf: - type: "array" items: type: "string" - type: "null" incident: type: "object" properties: message: type: "string" time_of_creation: type: "string" required: - "message" - "time_of_creation" description: "Represents a Postmortem in the system." V3.Incidents.Postmortems.PostmortemAttachmentRequest: type: "object" properties: key: type: "string" mime_type: type: "string" file_size: type: "string" description: "Represents an attachment in a postmortem request." V3.Incidents.Postmortems.PostmortemFollowUp: type: "object" required: - "task" - "is_done" properties: task: type: "string" is_done: type: "boolean" description: "Represents a single follow-up task in a postmortem." V3.Incidents.Postmortems.PostmortemListResult: type: "object" required: - "id" - "organization_id" - "incident_id" - "postmortem" - "follow_ups" - "created_at" - "title" - "status" - "owner" - "access_control" - "incident_message" - "incident_time_of_creation" - "service_name" - "service_id" - "alert_source" - "active_follow_ups_count" properties: id: type: "string" organization_id: type: "string" incident_id: type: "string" postmortem: type: "string" follow_ups: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemFollowUp" - type: "null" created_at: type: "string" title: type: "string" status: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemStatus" owner: $ref: "#/components/schemas/Common.V3.RBACOwner" access_control: type: "array" items: $ref: "#/components/schemas/Common.V3.RBACEntityPermission" attachments: anyOf: - type: "array" items: type: "string" - type: "null" incident: type: "object" properties: message: type: "string" time_of_creation: type: "string" required: - "message" - "time_of_creation" incident_message: type: "string" incident_time_of_creation: type: "string" service_name: type: "string" service_id: type: "string" alert_source: type: "string" active_follow_ups_count: type: "integer" description: "Represents a single result in the postmortem list response." V3.Incidents.Postmortems.PostmortemResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Incidents.Postmortems.Postmortem" V3.Incidents.Postmortems.PostmortemStatus: type: "string" enum: - "in_progress" - "under_review" - "published" description: "Represents the status of a postmortem." V3.Incidents.Postmortems.TotalPostmortemCount: type: "object" required: - "count" properties: count: type: "integer" description: "Represents the total count of postmortems." V3.Incidents.Postmortems.UpdatePostmortemRequest: type: "object" properties: owner_id: type: "string" postmortem: type: "string" follow_ups: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemFollowUp" new_attachments: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemAttachmentRequest" title: type: "string" status: $ref: "#/components/schemas/V3.Incidents.Postmortems.PostmortemStatus" description: "Request body for updating an existing postmortem." V3.Incidents.ReassignIncidentRequest: type: "object" required: - "reassignTo" properties: reassignTo: type: "object" properties: id: type: "string" type: type: "string" required: - "id" - "type" description: "Request body for reassigning an incident." V3.Incidents.RelevantPeopleLog: type: "object" required: - "userId" - "actionTaken" - "actionTakenBy" - "actionTime" properties: userId: type: "string" actionTaken: type: "string" actionTakenBy: type: "string" actionTime: type: "string" format: "date-time" description: "Represents a relevant people log entry." V3.Incidents.RequestStatus: type: "string" enum: - "created" - "deduplicated" - "suppressed" - "discarded" - "error" description: "Defines the status of an ingestion request." V3.Incidents.ResolveIncidentRequest: type: "object" required: - "resolution_reason" properties: resolution_reason: type: "object" properties: message: type: "string" required: - "message" description: "Request body for resolving an incident." V3.Incidents.ResponseNote: type: "object" required: - "timeOfNote" - "note" - "userId" properties: timeOfNote: type: "string" format: "date-time" note: type: "string" userId: type: "string" description: "Represents a response note in an incident." V3.Incidents.Runbooks.AttachRunbooksRequest: type: "object" required: - "runbooks" properties: runbooks: type: "array" items: type: "string" V3.Incidents.Runbooks.RunbookResponse: type: "object" required: - "incident_id" - "runbook_id" - "name" - "steps" properties: id: type: "string" incident_id: type: "string" runbook_id: type: "string" name: type: "string" steps: type: "array" items: type: "object" properties: content: type: "string" completed: type: "boolean" completed_at: type: "string" format: "date-time" required: - "content" - "completed" deleted: type: "boolean" deleted_at: type: "string" format: "date-time" V3.Incidents.ServiceOwnerFilter: type: "object" required: - "userIDs" - "squadIDs" properties: userIDs: type: "array" items: type: "string" squadIDs: type: "array" items: type: "string" userIDsAndTheirSquads: type: "array" items: type: "string" description: "Filter criteria for service owner in an export." V3.Incidents.SnoozeDetails: type: "object" required: - "is_snoozed" - "start_time" - "end_time" - "total_time_in_mins" properties: is_snoozed: type: "boolean" start_time: anyOf: - type: "string" format: "date-time" - type: "null" end_time: anyOf: - type: "string" format: "date-time" - type: "null" total_time_in_mins: type: "integer" description: "Details about incident snoozing." V3.Incidents.SnoozeNotifications.ReassignTo: type: "object" required: - "id" - "type" properties: id: type: "string" type: type: "string" V3.Incidents.SnoozeNotifications.SnoozeIncidentRequest: type: "object" required: - "snooze_duration_in_mins" properties: snooze_duration_in_mins: type: "integer" format: "int32" V3.Incidents.SnoozeNotifications.SnoozeIncidentResponse: type: "object" required: - "incident_id" - "is_snoozed" - "snooze_end_time" properties: incident_id: type: "string" is_snoozed: type: "boolean" snooze_end_time: type: "string" V3.Incidents.SnoozeNotifications.UnsnoozeIncidentRequest: type: "object" required: - "reassign_to" properties: reassign_to: $ref: "#/components/schemas/V3.Incidents.SnoozeNotifications.ReassignTo" V3.Incidents.SnoozeNotifications.UnsnoozeIncidentResponse: type: "object" required: - "incident_id" - "is_snoozed" - "reassign_to" properties: incident_id: type: "string" is_snoozed: type: "boolean" reassign_to: $ref: "#/components/schemas/V3.Incidents.SnoozeNotifications.ReassignTo" V3.Incidents.Step: type: "object" required: - "content" properties: content: type: "string" description: "The content of the step, in Markdown format." description: "Represents an attached runbook for export.Represents a single step in a runbook." V3.Incidents.TagConfigObject: type: "object" required: - "value" - "color" properties: value: type: "string" color: type: "string" description: "Defines the value and color of a tag." V3.Incidents.Tags.AdditionalResponderDetails: type: "object" required: - "id" - "type" - "timeOfAssignment" - "reason" - "name" - "last_notified_at" properties: id: type: "string" type: type: "string" timeOfAssignment: type: "string" format: "date-time" reason: type: "string" name: type: "string" last_notified_at: type: "string" format: "date-time" description: "Details for an additional responder." V3.Incidents.Tags.Analytics: type: "object" required: - "tta" - "ttr" properties: tta: $ref: "#/components/schemas/V3.Incidents.Tags.AnalyticsMetrics" ttr: $ref: "#/components/schemas/V3.Incidents.Tags.AnalyticsMetrics" description: "Incident analytics data." V3.Incidents.Tags.AnalyticsMetrics: type: "object" required: - "time" - "userId" - "escalationPolicyId" - "squadId" properties: time: type: "integer" userId: type: "string" escalationPolicyId: type: "string" squadId: type: "string" description: "Analytics metrics for TTA (Time to Acknowledge) and TTR (Time to Resolve)." V3.Incidents.Tags.AppendTagRequest: type: "object" properties: tags: type: "object" unevaluatedProperties: $ref: "#/components/schemas/V3.Incidents.Tags.TagUpdate" V3.Incidents.Tags.AssignTo: type: "object" required: - "id" properties: id: type: "string" type: type: "string" description: "Represents the assignment target for delayed notifications." V3.Incidents.Tags.AssignedTo: type: "object" required: - "id" - "type" - "timeOfAssignment" - "reason" properties: id: type: "string" type: type: "string" timeOfAssignment: type: "string" format: "date-time" reason: type: "string" V3.Incidents.Tags.DedupData: type: "object" properties: key: type: "string" hash: type: "string" V3.Incidents.Tags.IncidentForTags: type: "object" required: - "id" - "service_id" - "alert_source_id" - "organization_id" - "incidentNumber" - "message" - "assignedTo" - "additional_responders" - "description" - "status" - "timeOfCreation" - "updated_at" - "tags" - "logs" - "analytics" - "pinned_messages" - "deleted" - "event_count" - "dedup_data" - "owner" - "access_control" - "relevantUsers" - "relevantEscalationPolicies" - "relevantSquads" - "relevantSchedules" - "relevantPeopleLogs" - "responseNotes" - "attachments" - "is_child" - "children" - "did_auto_pause" - "did_auto_pause_timeout" - "auto_pause_ends_at" - "manually_marked_transient_alert_feedback_type" - "classification_id" - "grouped_alert_count" - "has_priority" - "snooze_details" - "did_notification_delay" - "notification_delay_policy" - "digest_id" properties: id: type: "string" service_id: type: "string" alert_source_id: type: "string" organization_id: type: "string" slo_id: type: "integer" incidentNumber: type: "integer" message: type: "string" assignedTo: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Tags.AssignedTo" additional_responders: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Tags.AdditionalResponderDetails" description: type: "string" status: type: "string" timeOfCreation: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" last_acknowledged_at: anyOf: - type: "string" format: "date-time" - type: "null" tags: type: "object" unevaluatedProperties: $ref: "#/components/schemas/V3.Incidents.Tags.TagConfigObject" logs: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Tags.Logs" analytics: $ref: "#/components/schemas/V3.Incidents.Tags.Analytics" pinned_messages: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Incidents.Tags.PinnedMessage" - type: "null" created_by: type: "string" sender_email: type: "string" deleted: type: "boolean" event_count: type: "integer" dedup_data: $ref: "#/components/schemas/V3.Incidents.Tags.DedupData" owner: $ref: "#/components/schemas/Common.V3.RBACOwner" access_control: anyOf: - type: "array" items: $ref: "#/components/schemas/Common.V3.RBACEntityPermission" - type: "null" relevantUsers: anyOf: - type: "array" items: type: "string" - type: "null" relevantEscalationPolicies: anyOf: - type: "array" items: type: "string" - type: "null" relevantSquads: anyOf: - type: "array" items: type: "string" - type: "null" relevantSchedules: anyOf: - type: "array" items: type: "string" - type: "null" relevantPeopleLogs: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Incidents.Tags.RelevantPeopleLog" - type: "null" responseNotes: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Incidents.Tags.ResponseNote" - type: "null" attachments: anyOf: - type: "array" items: type: "string" - type: "null" retriggerPolicy: anyOf: - type: "object" properties: escalationPolicyId: type: "string" retriggerAt: type: "string" format: "date-time" retriggeredAt: type: "string" format: "date-time" required: - "escalationPolicyId" - type: "null" webform_id: type: "integer" webform_submission_id: type: "integer" is_child: type: "boolean" parent: anyOf: - $ref: "#/components/schemas/V3.Incidents.Tags.MergeIncidentEntityReference" - type: "null" children: type: "array" items: $ref: "#/components/schemas/V3.Incidents.Tags.MergeIncidentEntityReference" did_auto_pause: type: "boolean" did_auto_pause_timeout: type: "boolean" auto_pause_ends_at: type: "string" format: "date-time" manually_marked_transient_alert_feedback_type: type: "string" classification_id: type: "integer" grouped_alert_count: type: "integer" priority: $ref: "#/components/schemas/V3.Incidents.Tags.IncidentPriority" has_priority: type: "boolean" snooze_details: $ref: "#/components/schemas/V3.Incidents.Tags.SnoozeDetails" did_notification_delay: type: "boolean" notification_delay_policy: $ref: "#/components/schemas/V3.Incidents.Tags.NotificationDelayPolicy" digest_id: type: "string" V3.Incidents.Tags.IncidentForTagsResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Incidents.Tags.IncidentForTags" V3.Incidents.Tags.IncidentPriority: type: "string" enum: - "P1" - "P2" - "P3" - "P4" - "P5" description: "Represents the priority of an incident." V3.Incidents.Tags.Logs: type: "object" required: - "action" - "time" - "reason" properties: action: type: "string" is_manually_created: type: "boolean" created_by: type: "string" updated_by: type: "string" assignedTo: type: "string" assignedBy: type: "string" id: type: "string" workflow_id: type: "integer" time: type: "string" format: "date-time" reason: type: "string" additionalInfo: anyOf: - type: "object" unevaluatedProperties: {} - type: "null" type: type: "string" should_show_in_postmortem: type: "boolean" description: "Represents a log entry for an incident action." V3.Incidents.Tags.MergeIncidentEntityReference: type: "object" required: - "id" properties: id: type: "string" description: "Reference to a merged incident entity." V3.Incidents.Tags.NotificationDelayPolicy: type: "object" required: - "is_notification_delayed" - "delayed_until" - "assign_to" properties: is_notification_delayed: type: "boolean" delayed_until: type: "string" format: "date-time" assign_to: $ref: "#/components/schemas/V3.Incidents.Tags.AssignTo" description: "Policy for delaying notifications." V3.Incidents.Tags.PinnedMessage: type: "object" required: - "message" - "message_sender_id" - "time" - "time_of_pinning" - "message_id" - "message_pinned_by" - "message_sender_name" properties: message: type: "string" message_sender_id: type: "string" time: type: "string" format: "date-time" time_of_pinning: type: "string" format: "date-time" message_id: type: "string" message_pinned_by: type: "string" message_sender_name: type: "string" description: "Represents a pinned message in the warroom." V3.Incidents.Tags.RelevantPeopleLog: type: "object" required: - "userId" - "actionTaken" - "actionTakenBy" - "actionTime" properties: userId: type: "string" actionTaken: type: "string" actionTakenBy: type: "string" actionTime: type: "string" format: "date-time" description: "Represents a relevant people log entry." V3.Incidents.Tags.ResponseNote: type: "object" required: - "timeOfNote" - "note" - "userId" properties: timeOfNote: type: "string" format: "date-time" note: type: "string" userId: type: "string" description: "Represents a response note in an incident." V3.Incidents.Tags.SnoozeDetails: type: "object" required: - "is_snoozed" - "start_time" - "end_time" - "total_time_in_mins" properties: is_snoozed: type: "boolean" start_time: anyOf: - type: "string" format: "date-time" - type: "null" end_time: anyOf: - type: "string" format: "date-time" - type: "null" total_time_in_mins: type: "integer" V3.Incidents.Tags.Tag: type: "object" required: - "value" - "color" properties: value: type: "string" color: type: "string" V3.Incidents.Tags.TagConfigObject: type: "object" required: - "value" - "color" properties: value: type: "string" color: type: "string" description: "Defines the value and color of a tag." V3.Incidents.Tags.TagUpdate: type: "object" properties: value: type: "string" color: type: "string" V3.Incidents.Tags.UpdateTagRequest: type: "object" required: - "tags" properties: tags: type: "object" unevaluatedProperties: $ref: "#/components/schemas/V3.Incidents.Tags.Tag" V3.Incidents.Task: type: "object" required: - "content" - "id" - "completed" - "completed_at" properties: content: type: "string" description: "The content of the step, in Markdown format." id: type: "string" completed: type: "boolean" completed_at: type: "string" format: "date-time" description: "Represents a single task within an incident." V3.Runbooks.CreateRunbookRequest: type: "object" required: - "name" - "steps" - "owner_id" properties: name: type: "string" description: "The name of the runbook." steps: type: "array" items: $ref: "#/components/schemas/V3.Runbooks.Step" description: "The steps that make up the runbook." owner_id: type: "string" description: "The ID of the team that owns this runbook." entity_owner: allOf: - $ref: "#/components/schemas/Common.V3.EntityOwner" description: "The owner of the entity." description: "Represents the request body for creating a new runbook." V3.Runbooks.Runbook: type: "object" required: - "id" - "name" - "created" - "updated" - "used_count" - "steps" - "entity_owner" - "organization_id" - "owner" properties: id: type: "string" description: "The unique identifier for the runbook." name: type: "string" description: "The name of the runbook." created: allOf: - $ref: "#/components/schemas/V3.Runbooks.UpdationInfo" description: "Information about when the runbook was created." updated: allOf: - $ref: "#/components/schemas/V3.Runbooks.UpdationInfo" description: "Information about when the runbook was last updated." used_count: type: "integer" format: "int32" description: "The number of times this runbook has been used." steps: type: "array" items: $ref: "#/components/schemas/V3.Runbooks.Step" description: "The steps that make up the runbook." entity_owner: allOf: - $ref: "#/components/schemas/Common.V3.EntityOwner" description: "The owner of the entity." organization_id: type: "string" description: "The ID of the organization this runbook belongs to." owner: allOf: - $ref: "#/components/schemas/Common.V3.RBACOwner" description: "The RBAC owner of the runbook (typically a team)." description: "Represents a Runbook in the system." V3.Runbooks.RunbookResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Runbooks.Runbook" V3.Runbooks.Step: type: "object" required: - "content" properties: content: type: "string" description: "The content of the step, in Markdown format." description: "Represents a single step in a runbook." V3.Runbooks.UpdateRunbookRequest: type: "object" required: - "name" - "steps" properties: name: type: "string" description: "The name of the runbook." steps: type: "array" items: $ref: "#/components/schemas/V3.Runbooks.Step" description: "The steps that make up the runbook." entity_owner: allOf: - $ref: "#/components/schemas/Common.V3.EntityOwner" description: "The owner of the entity." description: "Represents the request body for updating a runbook." V3.Runbooks.UpdationInfo: type: "object" required: - "user_name" - "username_for_display" - "user_id" - "at" properties: user_name: type: "string" description: "The full name of the user who performed the action." username_for_display: type: "string" description: "The display name of the user who performed the action." user_id: type: "string" description: "The ID of the user who performed the action." at: type: "string" format: "date-time" description: "The timestamp of the action." entity_owner: allOf: - $ref: "#/components/schemas/Common.V3.EntityOwner" description: "The owner of the entity at the time of the action." description: "Represents information about the creation or updation of an entity." V3.SLO.CreateSLORequest: type: "object" required: - "name" - "time_interval_type" - "service_ids" - "slis" - "target_slo" - "start_time" - "end_time" - "duration_in_days" - "owner_type" - "owner_id" - "slo_owner_id" - "slo_owner_type" properties: name: type: "string" description: type: "string" time_interval_type: $ref: "#/components/schemas/V3.SLO.TimeIntervalType" service_ids: type: "array" items: type: "string" slis: type: "array" items: type: "string" target_slo: type: "number" format: "float" start_time: type: "string" format: "date-time" end_time: type: "string" format: "date-time" duration_in_days: type: "integer" format: "uint32" tags: type: "object" unevaluatedProperties: anyOf: - type: "string" - type: "integer" format: "int32" - type: "boolean" - type: "null" slo_monitoring_checks: type: "array" items: $ref: "#/components/schemas/V3.SLO.SloMonitoringCheck" slo_actions: type: "array" items: $ref: "#/components/schemas/V3.SLO.SloAction" owner_type: type: "string" owner_id: type: "string" slo_owner_id: type: "string" slo_owner_type: $ref: "#/components/schemas/V3.SLO.SLOOwnerType" V3.SLO.MarkSLOAffectedRequest: type: "object" required: - "incident_id" - "slis" - "error_budget_spent" - "owner_type" - "owner_id" - "org_id" properties: incident_id: type: "string" slis: type: "array" items: type: "string" error_budget_spent: type: "number" format: "float" owner_type: type: "string" owner_id: type: "string" org_id: type: "string" V3.SLO.SLO: type: "object" required: - "id" - "name" - "time_interval_type" - "service_ids" - "slis" - "target_slo" - "start_time" - "end_time" - "allocated_error_budget" - "is_active" - "owner_type" - "owner_id" - "org_id" properties: id: type: "integer" name: type: "string" description: type: "string" time_interval_type: $ref: "#/components/schemas/V3.SLO.TimeIntervalType" service_ids: type: "array" items: type: "string" slis: type: "array" items: type: "string" target_slo: type: "number" format: "float" current_slo: type: "number" format: "float" start_time: type: "string" format: "date-time" end_time: type: "string" format: "date-time" is_healthy: type: "boolean" remaining_error_budget: type: "number" format: "float" allocated_error_budget: type: "number" format: "float" is_active: type: "boolean" tags: anyOf: - type: "object" unevaluatedProperties: anyOf: - type: "string" - type: "integer" format: "int32" - type: "boolean" - type: "null" - type: "null" incident_count: type: "integer" false_positive_count: type: "integer" slo_monitoring_checks: type: "array" items: $ref: "#/components/schemas/V3.SLO.SloMonitoringCheck" slo_actions: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.SLO.SloAction" - type: "null" owner_type: type: "string" owner_id: type: "string" org_id: type: "string" slo_owner_id: type: "string" slo_owner_type: $ref: "#/components/schemas/V3.SLO.SLOOwnerType" created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" deleted_at: anyOf: - type: "string" format: "date-time" - type: "null" duration_in_days: type: "integer" format: "uint32" V3.SLO.SLODetailedResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.SLO.SLO" V3.SLO.SLOOwnerType: type: "string" enum: - "user" - "squad" V3.SLO.SLOResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.SLO.SLO" V3.SLO.SLOViolatingIncident: type: "object" required: - "id" - "owner_type" - "owner_id" - "org_id" - "slo_id" - "incident_id" - "slis" - "error_budget_spent" - "is_false_positive" - "start_time" - "end_time" - "created_at" - "updated_at" - "deleted_at" properties: id: type: "integer" owner_type: type: "string" owner_id: type: "string" org_id: type: "string" slo_id: type: "integer" incident_id: type: "string" slis: type: "array" items: type: "string" error_budget_spent: type: "number" format: "float" is_false_positive: type: "boolean" start_time: type: "string" format: "date-time" end_time: type: "string" format: "date-time" created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" deleted_at: anyOf: - type: "string" format: "date-time" - type: "null" V3.SLO.SLOViolatingIncidentResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.SLO.SLOViolatingIncident" V3.SLO.SLOWithInsights: type: "object" required: - "slo" properties: insights: type: "object" properties: error_budget_consumption_for_past_30days: type: "integer" required: - "error_budget_consumption_for_past_30days" slo: $ref: "#/components/schemas/V3.SLO.SLO" V3.SLO.SLOWithInsightsResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.SLO.SLOWithInsights" V3.SLO.SloAction: type: "object" required: - "type" properties: id: type: "integer" slo_id: type: "integer" type: $ref: "#/components/schemas/V3.SLO.SloActionType" user_id: type: "string" squad_id: type: "string" service_id: type: "string" owner_type: type: "string" owner_id: type: "string" created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" deleted_at: anyOf: - type: "string" format: "date-time" - type: "null" V3.SLO.SloActionType: type: "string" enum: - "SERVICE" - "USER" - "SQUAD" V3.SLO.SloMonitoringCheck: type: "object" required: - "name" - "owner_type" - "owner_id" properties: id: type: "integer" slo_id: type: "integer" name: type: "string" threshold: type: "integer" owner_type: type: "string" owner_id: type: "string" org_id: type: "string" is_checked: anyOf: - type: "boolean" - type: "null" created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" deleted_at: anyOf: - type: "string" format: "date-time" - type: "null" V3.SLO.TimeIntervalType: type: "string" enum: - "fixed" - "rolling" V3.Services.APTAConfig: type: "object" required: - "is_enabled" - "timeout_in_mins" properties: is_enabled: type: "boolean" timeout_in_mins: type: "number" enum: - 2 - 3 - 5 - 10 - 15 V3.Services.APTAConfigRequest: type: "object" required: - "is_enabled" - "timeout_in_mins" properties: is_enabled: type: "boolean" timeout_in_mins: type: "integer" V3.Services.CreateServiceRequest: type: "object" required: - "name" - "escalation_policy_id" properties: name: type: "string" escalation_policy_id: type: "string" description: type: "string" email_prefix: type: "string" maintainer: $ref: "#/components/schemas/V3.Services.ServiceMaintainer" tags: type: "array" items: $ref: "#/components/schemas/V3.Services.ServiceTag" auto_pause_transient_alerts_config: $ref: "#/components/schemas/V3.Services.APTAConfig" intelligent_alerts_grouping_config: $ref: "#/components/schemas/V3.Services.IAGConfig" delay_notification_config: $ref: "#/components/schemas/V3.Services.NotificationDelayConfigRequest" dedup_init_config: $ref: "#/components/schemas/V3.Services.DedupInitConfig" V3.Services.DedupInitConfig: type: "object" required: - "time_window" - "time_unit" properties: time_window: type: "integer" format: "int64" time_unit: type: "string" enum: - "minute" - "hour" V3.Services.DeduplicationRules.CreateDeduplicationRulesRequest: type: "object" required: - "rules" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.DeduplicationRules.DeduplicationRule" V3.Services.DeduplicationRules.DeduplicationRule: type: "object" required: - "expression" - "time_window" - "time_unit" - "is_basic" properties: expression: type: "string" time_window: type: "integer" format: "int64" time_unit: type: "string" enum: - "minute" - "hour" is_basic: type: "boolean" basic_expression: type: "array" items: $ref: "#/components/schemas/V3.Services.DeduplicationRules.ExpressionBranch" dependency_deduplication: type: "boolean" description: type: "string" V3.Services.DeduplicationRules.DeduplicationRuleResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.DeduplicationRules.DeduplicationRule" V3.Services.DeduplicationRules.ExpressionBranch: type: "object" required: - "lhs" - "rhs" properties: lhs: type: "string" op: type: "string" enum: - "is" - "is_not" - "matches" - "not_contains" - "gt" - "lt" - "gt_eq" - "lt_eq" - "call" - "field_is" - "field_is_not" - "field_gt" - "field_lt" - "field_gt_eq" - "field_lt_eq" rhs: anyOf: - type: "string" - type: "boolean" - type: "integer" format: "int32" - type: "number" format: "float" V3.Services.Dependencies.CreateOrUpdateDependenciesRequest: type: "object" required: - "dependencies" properties: dependencies: type: "array" items: type: "string" V3.Services.EscalationPolicyBasic: type: "object" required: - "id" - "name" - "description" - "slug" properties: id: type: "string" description: "The unique identifier for the escalation policy." name: type: "string" description: "The name of the escalation policy." description: type: "string" description: "A description of the escalation policy." slug: type: "string" description: "The URL-friendly slug for the policy name." description: "Represents the basic details of an Escalation Policy for a service." V3.Services.Extensions.SlackExtensionResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.Extensions.SlackExtensionServiceExtension" V3.Services.Extensions.SlackExtensionServiceExtension: type: "object" required: - "id" - "service_id" - "organization_id" - "channel_id" - "created_at" - "name" properties: id: type: "integer" format: "int32" service_id: type: "string" organization_id: type: "string" channel_id: type: "string" created_at: type: "string" name: type: "string" V3.Services.Extensions.UpdateSlackExtensionRequest: type: "object" required: - "channel_id" properties: channel_id: type: "string" V3.Services.IAGConfig: type: "object" required: - "is_enabled" - "rolling_window_in_mins" properties: is_enabled: type: "boolean" rolling_window_in_mins: type: "number" enum: - 5 - 10 - 15 - 20 - 45 - 60 - 120 - 240 - 480 - 720 - 1440 V3.Services.IAGConfigRequest: type: "object" required: - "is_enabled" - "rolling_window_in_mins" properties: is_enabled: type: "boolean" rolling_window_in_mins: type: "integer" V3.Services.JiraCloudExtension: type: "object" required: - "jira_client_key" - "project" - "issue_type" - "is_manual" properties: jira_client_key: type: "string" project: $ref: "#/components/schemas/V3.Services.JiraProject" issue_type: $ref: "#/components/schemas/V3.Services.JiraIssueType" statusmaps: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Services.JiraStatusMap" - type: "null" is_manual: type: "boolean" V3.Services.JiraIssueType: type: "object" required: - "id" - "name" properties: id: type: "string" name: type: "string" statuses: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Services.JiraStatus" - type: "null" V3.Services.JiraProject: type: "object" required: - "id" - "key" - "name" properties: id: type: "string" key: type: "string" name: type: "string" V3.Services.JiraStatus: type: "object" required: - "id" - "name" properties: id: type: "string" name: type: "string" V3.Services.JiraStatusMap: type: "object" required: - "jira_status" - "system_status" properties: jira_status: type: "string" system_status: type: "string" V3.Services.MaintenanceMode.CreateOrUpdateMaintenanceModeRequest: type: "object" required: - "onMaintenance" - "serviceMaintenance" properties: onMaintenance: type: "boolean" serviceMaintenance: type: "array" items: $ref: "#/components/schemas/V3.Services.MaintenanceMode.ServiceMaintenance" V3.Services.MaintenanceMode.MaintenanceMode: type: "object" required: - "service_id" - "maintenance_from" - "maintenance_till" - "repetition_daily" - "repetition_weekly" - "repetition_two_weekly" - "repetition_three_weekly" - "repetition_monthly" - "deleted" - "repeat_till" properties: service_id: type: "string" maintenance_from: type: "string" format: "date-time" maintenance_till: type: "string" format: "date-time" repetition_daily: type: "boolean" repetition_weekly: type: "boolean" repetition_two_weekly: type: "boolean" repetition_three_weekly: type: "boolean" repetition_monthly: type: "boolean" deleted: type: "boolean" repeat_till: type: "string" format: "date-time" V3.Services.MaintenanceMode.MaintenanceModeResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.MaintenanceMode.MaintenanceMode" V3.Services.MaintenanceMode.ServiceMaintenance: type: "object" required: - "maintenanceStartDate" - "daily" - "weekly" - "twoWeekly" - "threeWeekly" - "monthly" - "deleted" - "repeatTill" properties: maintenanceStartDate: type: "string" maintenanceEndDate: type: "string" daily: type: "boolean" weekly: type: "boolean" twoWeekly: type: "boolean" threeWeekly: type: "boolean" monthly: type: "boolean" deleted: type: "boolean" repeatTill: type: "string" V3.Services.NotificationDelayConfig: type: "object" required: - "is_enabled" properties: is_enabled: type: "boolean" timezone: type: "string" fixed_timeslot_config: type: "object" properties: start_time: type: "string" end_time: type: "string" repeat_days: type: "array" items: type: "integer" format: "int32" custom_timeslots_enabled: type: "boolean" custom_timeslots: type: "object" unevaluatedProperties: type: "array" items: type: "object" properties: start_time: type: "string" end_time: type: "string" assigned_to: type: "object" properties: id: type: "string" type: type: "string" V3.Services.NotificationDelayConfigRequest: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.NotificationDelayConfig" V3.Services.Overlay.CustomContent: type: "object" required: - "message" - "description" properties: message: type: "string" description: type: "string" V3.Services.Overlay.CustomContentOverlay: type: "object" required: - "created_at" - "updated_at" - "deleted_at" - "org_id" - "service_id" - "alert_source_version" - "alert_source_shortname" - "overlay_template_type" - "overlay" - "created_by" - "updated_by" - "alert_source_type" properties: created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" deleted_at: anyOf: - type: "string" format: "date-time" - type: "null" org_id: type: "string" service_id: type: "string" alert_source_version: type: "string" alert_source_shortname: type: "string" overlay_template_type: type: "string" enum: - "message" - "description" overlay: $ref: "#/components/schemas/V3.Services.Overlay.CustomContent" created_by: type: "string" updated_by: type: "string" alert_source_type: type: "string" V3.Services.Overlay.CustomContentOverlayResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.Overlay.CustomContentOverlay" V3.Services.Overlay.DedupKeyOverlay: type: "object" required: - "template" - "duration" properties: template: type: "string" duration: type: "integer" format: "int32" V3.Services.Overlay.OptInForKeyBasedDeduplicationRequest: type: "object" properties: dedup_key_enabled: type: "boolean" V3.Services.Overlay.Overlay: type: "object" required: - "created_at" - "updated_at" - "deleted_at" - "org_id" - "service_id" - "alert_source_version" - "alert_source_shortname" - "overlay_template_type" - "overlay" - "created_by" - "updated_by" - "alert_source_type" properties: created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" deleted_at: anyOf: - type: "string" format: "date-time" - type: "null" org_id: type: "string" service_id: type: "string" alert_source_version: type: "string" alert_source_shortname: type: "string" overlay_template_type: type: "string" enum: - "dedup_key" overlay: $ref: "#/components/schemas/V3.Services.Overlay.DedupKeyOverlay" created_by: type: "string" updated_by: type: "string" alert_source_type: type: "string" V3.Services.Overlay.OverlayResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.Overlay.Overlay" V3.Services.Overlay.RenderCustomContentOverlayRequest: type: "object" required: - "overlay_template_type" - "template" - "payload" properties: overlay_template_type: type: "string" template: type: "string" payload: type: "string" V3.Services.Overlay.RenderDedupKeyTemplateRequest: type: "object" required: - "overlay_template_type" - "template" - "payload" properties: overlay_template_type: type: "string" template: type: "string" payload: type: "string" V3.Services.Overlay.UpdateCustomContentTemplateOverlayRequest: type: "object" required: - "overlay_template_type" - "message_overlay" - "description_overlay" properties: overlay_template_type: type: "string" message_overlay: type: "object" properties: template: type: "string" required: - "template" description_overlay: type: "object" properties: template: type: "string" required: - "template" V3.Services.Overlay.UpdateDedupKeyOverlayRequest: type: "object" required: - "overlay_template_type" - "dedup_key_overlay" properties: overlay_template_type: type: "string" dedup_key_overlay: type: "object" properties: template: type: "string" duration: type: "integer" required: - "template" - "duration" V3.Services.RoutingRules.CreateOrUpdateRoutingRulesRequest: type: "object" required: - "rules" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.RoutingRules.RoutingRule" V3.Services.RoutingRules.ExpressionBranch: type: "object" required: - "lhs" - "rhs" properties: lhs: type: "string" op: type: "string" enum: - "is" - "is_not" - "matches" - "not_contains" - "gt" - "lt" - "gt_eq" - "lt_eq" - "call" - "field_is" - "field_is_not" - "field_gt" - "field_lt" - "field_gt_eq" - "field_lt_eq" rhs: anyOf: - type: "string" - type: "boolean" - type: "integer" format: "int32" - type: "number" format: "float" V3.Services.RoutingRules.RoutingRule: type: "object" required: - "expression" - "route_to" - "is_basic" properties: expression: type: "string" route_to: type: "object" properties: entity_type: type: "string" enum: - "user" - "squad" - "escalation_policy" entity_id: type: "string" required: - "entity_type" - "entity_id" is_basic: type: "boolean" basic_expression: type: "array" items: $ref: "#/components/schemas/V3.Services.RoutingRules.ExpressionBranch" V3.Services.RoutingRules.RoutingRuleResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.RoutingRules.RoutingRule" V3.Services.Service: type: "object" required: - "id" - "name" - "slug" - "email" - "escalation_policy_id" - "organization_id" - "api_key" - "description" - "owner" - "maintainer" - "tags" - "auto_pause_transient_alerts_config" - "intelligent_alerts_grouping_config" - "delay_notification_config" - "config" - "created_at" - "updated_at" properties: id: type: "string" name: type: "string" slug: type: "string" email: type: "string" escalation_policy_id: type: "string" organization_id: type: "string" api_key: type: "string" description: type: "string" depends: anyOf: - type: "array" items: type: "string" - type: "null" owner: $ref: "#/components/schemas/Common.V3.RBACOwner" on_maintenance: type: "boolean" slack: $ref: "#/components/schemas/V3.Services.ServiceSlack" escalation_policy: $ref: "#/components/schemas/V3.Services.EscalationPolicyBasic" jira_cloud: $ref: "#/components/schemas/V3.Services.JiraCloudExtension" maintainer: $ref: "#/components/schemas/V3.Services.ServiceMaintainer" tags: type: "array" items: $ref: "#/components/schemas/V3.Services.ServiceTag" auto_pause_transient_alerts_config: $ref: "#/components/schemas/V3.Services.APTAConfig" intelligent_alerts_grouping_config: $ref: "#/components/schemas/V3.Services.IAGConfig" delay_notification_config: $ref: "#/components/schemas/V3.Services.NotificationDelayConfig" config: type: "object" properties: dedup_key_enabled: type: "boolean" required: - "dedup_key_enabled" created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" V3.Services.ServiceMaintainer: type: "object" required: - "id" - "type" properties: id: type: "string" type: type: "string" enum: - "user" - "squad" V3.Services.ServiceResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.Service" V3.Services.ServiceSlack: type: "object" required: - "channel_id" - "name" - "time" properties: channel_id: type: "string" name: type: "string" time: type: "integer" V3.Services.ServiceTag: type: "object" required: - "key" - "value" properties: key: type: "string" value: type: "string" V3.Services.SlackExtension: type: "object" required: - "id" - "token" - "slack_bot_token" - "slack_channel_id" - "slack_channel_name" - "slack_team_id" properties: id: type: "string" token: type: "string" slack_bot_token: type: "string" slack_channel_id: type: "string" slack_channel_name: type: "string" slack_team_id: type: "string" V3.Services.SlackExtensionServiceExtension: type: "object" required: - "id" - "service_id" - "organization_id" - "channel_id" - "created_at" - "name" properties: id: type: "integer" format: "int32" service_id: type: "string" organization_id: type: "string" channel_id: type: "string" created_at: type: "string" name: type: "string" V3.Services.SlackExtensionServiceExtensionRes: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.SlackExtensionServiceExtension" V3.Services.SlackExtensionUpdatePayload: type: "object" required: - "channel_id" properties: channel_id: type: "string" V3.Services.SuppressionRules.BasicExpression: type: "object" required: - "lhs" - "op" - "rhs" properties: lhs: type: "string" op: type: "string" rhs: type: "string" V3.Services.SuppressionRules.CreateOrUpdateSuppressionRulesRequest: type: "object" required: - "rules" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.SuppressionRules.SuppressionRule" V3.Services.SuppressionRules.CustomRepetition: type: "object" required: - "repeats_count" - "repeats" - "repeats_on_weekdays" - "repeats_on_month" properties: repeats_count: type: "integer" repeats: type: "string" repeats_on_weekdays: type: "array" items: type: "integer" repeats_on_month: type: "string" V3.Services.SuppressionRules.SuppressionRule: type: "object" required: - "rule_id" - "created_at" - "updated_at" - "created_by" - "updated_by" - "description" - "expression" - "is_basic" - "is_timebased" - "timeslots" - "basic_expression" properties: rule_id: type: "string" created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" created_by: type: "string" updated_by: type: "string" description: type: "string" expression: type: "string" is_basic: type: "boolean" is_timebased: type: "boolean" timeslots: anyOf: - type: "array" items: $ref: "#/components/schemas/V3.Services.SuppressionRules.Timeslot" - type: "null" basic_expression: type: "array" items: $ref: "#/components/schemas/V3.Services.SuppressionRules.BasicExpression" V3.Services.SuppressionRules.SuppressionRuleResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.SuppressionRules.SuppressionRule" V3.Services.SuppressionRules.SuppressionRulesContainer: type: "object" required: - "id" - "created_at" - "updated_at" - "service_id" - "organization_id" - "rules" properties: id: type: "string" created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" service_id: type: "string" organization_id: type: "string" rules: type: "array" items: $ref: "#/components/schemas/V3.Services.SuppressionRules.SuppressionRule" V3.Services.SuppressionRules.SuppressionRulesContainerResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.SuppressionRules.SuppressionRulesContainer" V3.Services.SuppressionRules.Timeslot: type: "object" required: - "time_zone" - "start_time" - "end_time" - "is_allday" - "repetition" - "is_custom" - "custom" - "ends_never" - "ends_on" properties: time_zone: type: "string" start_time: type: "string" end_time: type: "string" is_allday: type: "boolean" repetition: type: "string" is_custom: type: "boolean" custom: $ref: "#/components/schemas/V3.Services.SuppressionRules.CustomRepetition" ends_never: type: "boolean" ends_on: type: "string" V3.Services.TaggingRules.CreateOrUpdateTaggingRulesRequest: type: "object" required: - "rules" properties: rules: type: "array" items: $ref: "#/components/schemas/V3.Services.TaggingRules.TagRule" V3.Services.TaggingRules.ExpressionBranch: type: "object" required: - "lhs" - "rhs" properties: lhs: type: "string" op: type: "string" enum: - "is" - "is_not" - "matches" - "not_contains" - "gt" - "lt" - "gt_eq" - "lt_eq" - "call" - "field_is" - "field_is_not" - "field_gt" - "field_lt" - "field_gt_eq" - "field_lt_eq" rhs: anyOf: - type: "string" - type: "boolean" - type: "integer" format: "int32" - type: "number" format: "float" V3.Services.TaggingRules.SubExpressions: type: "array" items: $ref: "#/components/schemas/V3.Services.TaggingRules.ExpressionBranch" V3.Services.TaggingRules.TagConfigObject: type: "object" required: - "value" - "color" properties: value: type: "string" color: type: "string" V3.Services.TaggingRules.TagRule: type: "object" properties: expression: type: "string" tags: allOf: - $ref: "#/components/schemas/V3.Services.TaggingRules.TagsObject" description: "The 'tags' field cannot be empty unless the 'expression' or 'basic_expression' explicitly uses 'addTag' or 'addTags' functions." is_basic: type: "boolean" basic_expression: $ref: "#/components/schemas/V3.Services.TaggingRules.SubExpressions" V3.Services.TaggingRules.TaggingRuleResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Services.TaggingRules.TagRule" V3.Services.TaggingRules.TagsObject: type: "object" properties: severity: $ref: "#/components/schemas/V3.Services.TaggingRules.TagConfigObject" unevaluatedProperties: $ref: "#/components/schemas/V3.Services.TaggingRules.TagConfigObject" V3.Services.UpdateServiceRequest: type: "object" properties: name: type: "string" escalation_policy_id: type: "string" description: type: "string" email_prefix: type: "string" maintainer: $ref: "#/components/schemas/V3.Services.ServiceMaintainer" tags: type: "array" items: $ref: "#/components/schemas/V3.Services.ServiceTag" auto_pause_transient_alerts_config: $ref: "#/components/schemas/V3.Services.APTAConfig" intelligent_alerts_grouping_config: $ref: "#/components/schemas/V3.Services.IAGConfig" delay_notification_config: $ref: "#/components/schemas/V3.Services.NotificationDelayConfigRequest" V3.Teams.Abilities: type: "object" properties: escalation_policies: type: "object" properties: create-escalation-policies: type: "boolean" read-escalation-policies: type: "boolean" update-escalation-policies: type: "boolean" delete-escalation-policies: type: "boolean" schedules: type: "object" properties: create-schedules: type: "boolean" read-schedules: type: "boolean" update-schedules: type: "boolean" delete-schedules: type: "boolean" services: type: "object" properties: create-services: type: "boolean" read-services: type: "boolean" update-services: type: "boolean" delete-services: type: "boolean" squads: type: "object" properties: create-squads: type: "boolean" read-squads: type: "boolean" update-squads: type: "boolean" delete-squads: type: "boolean" stakeholder_groups: type: "object" properties: create-stakeholder-groups: type: "boolean" read-stakeholder-groups: type: "boolean" update-stakeholder-groups: type: "boolean" delete-stakeholder-groups: type: "boolean" runbooks: type: "object" properties: create-runbooks: type: "boolean" read-runbooks: type: "boolean" update-runbooks: type: "boolean" delete-runbooks: type: "boolean" postmortems: type: "object" properties: create-postmortems: type: "boolean" read-postmortems: type: "boolean" update-postmortems: type: "boolean" delete-postmortems: type: "boolean" status_pages: type: "object" properties: create-status-pages: type: "boolean" read-status-pages: type: "boolean" update-status-pages: type: "boolean" delete-status-pages: type: "boolean" team_analytics: type: "object" properties: read-team-analytics: type: "boolean" slos: type: "object" properties: create-slos: type: "boolean" read-slos: type: "boolean" update-slos: type: "boolean" delete-slos: type: "boolean" webforms: type: "object" properties: create-webforms: type: "boolean" read-webforms: type: "boolean" update-webforms: type: "boolean" delete-webforms: type: "boolean" workflows: type: "object" properties: create-workflows: type: "boolean" read-workflows: type: "boolean" update-workflows: type: "boolean" delete-workflows: type: "boolean" ger: type: "object" properties: create-ger: type: "boolean" read-ger: type: "boolean" update-ger: type: "boolean" delete-ger: type: "boolean" routing_numbers: type: "object" properties: create-routing-numbers: type: "boolean" read-routing-numbers: type: "boolean" update-routing-numbers: type: "boolean" delete-routing-numbers: type: "boolean" global_oncall_reminder_rules: type: "object" properties: create-global-oncall-reminder-rules: type: "boolean" read-global-oncall-reminder-rules: type: "boolean" update-global-oncall-reminder-rules: type: "boolean" delete-global-oncall-reminder-rules: type: "boolean" V3.Teams.AddBulkTeamMemberRequest: type: "object" required: - "members" properties: members: type: "array" items: type: "object" properties: user_id: type: "string" role: type: "string" description: "this field is required if you are using OBAC permission model" role_ids: type: "array" items: type: "string" description: "this field is required if you are using RBAC permission model" required: - "user_id" - "role_ids" V3.Teams.AddTeamMemberRequest: type: "object" required: - "user_id" - "role_ids" properties: user_id: type: "string" role_ids: type: "array" items: type: "string" description: "this field is required if you are using RBAC permission model" role: type: "string" description: "this field is required if you are using OBAC permission model" V3.Teams.CreateTeamRequest: type: "object" required: - "name" - "member_ids" properties: name: type: "string" description: type: "string" member_ids: type: "array" items: type: "string" V3.Teams.CreateTeamRoleRequest: type: "object" required: - "name" - "abilities" properties: name: type: "string" abilities: $ref: "#/components/schemas/V3.Teams.Abilities" V3.Teams.TeamBase: type: "object" required: - "id" - "created_at" - "updated_at" - "created_by" - "organization_id" - "name" - "description" - "slug" - "members" - "roles" - "default" properties: id: type: "string" created_at: type: "string" updated_at: type: "string" created_by: type: "string" organization_id: type: "string" name: type: "string" description: type: "string" slug: type: "string" members: type: "array" items: $ref: "#/components/schemas/V3.Teams.TeamMember" roles: type: "array" items: $ref: "#/components/schemas/V3.Teams.TeamRole" default: type: "boolean" V3.Teams.TeamBaseResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Teams.TeamBase" V3.Teams.TeamMember: type: "object" required: - "user_id" properties: user_id: type: "string" role: type: "string" role_ids: type: "array" items: type: "string" abilities: $ref: "#/components/schemas/V3.Teams.Abilities" V3.Teams.TeamMemberResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Teams.TeamMember" V3.Teams.TeamResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Teams.TeamWithOrganization" V3.Teams.TeamRole: type: "object" required: - "id" - "name" - "slug" - "default" properties: id: type: "string" name: type: "string" slug: type: "string" default: type: "boolean" abilities: $ref: "#/components/schemas/V3.Teams.Abilities" V3.Teams.TeamRoleResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Teams.TeamRole" V3.Teams.TeamWithOrganization: type: "object" required: - "id" - "created_at" - "updated_at" - "created_by" - "organization_id" - "name" - "description" - "slug" - "members" - "roles" - "default" - "organization" properties: id: type: "string" created_at: type: "string" updated_at: type: "string" created_by: type: "string" organization_id: type: "string" name: type: "string" description: type: "string" slug: type: "string" members: type: "array" items: $ref: "#/components/schemas/V3.Teams.TeamMember" roles: type: "array" items: $ref: "#/components/schemas/V3.Teams.TeamRole" default: type: "boolean" organization: type: "object" properties: id: type: "string" name: type: "string" slug: type: "string" required: - "id" - "name" - "slug" V3.Teams.UpdateTeamMemberRequest: type: "object" properties: role_ids: type: "array" items: type: "string" description: "this field is required if you are using RBAC permission model" role: type: "string" description: "this field is required if you are using OBAC permission model" V3.Teams.UpdateTeamRequest: type: "object" required: - "members" properties: name: type: "string" description: type: "string" members: type: "array" items: type: "object" properties: user_id: type: "string" role: type: "string" description: "this field is required if you are using OBAC permission model" role_ids: type: "array" items: type: "string" description: "this field is required if you are using RBAC permission model" required: - "user_id" - "role_ids" V3.Teams.UpdateTeamRoleRequest: type: "object" properties: name: type: "string" abilities: $ref: "#/components/schemas/V3.Teams.Abilities" V3.Users.AddUserRequest: type: "object" required: - "email" - "role" - "first_name" - "last_name" properties: email: type: "string" role: type: "string" enum: - "account_owner" - "user" - "stakeholder" first_name: type: "string" last_name: type: "string" V3.Users.ApiToken: type: "object" required: - "id" - "organization_id" - "user_id" - "token" - "last_refresh" - "rate_limit" - "deleted" properties: id: type: "string" organization_id: type: "string" user_id: type: "string" token: type: "string" last_refresh: type: "string" rate_limit: type: "integer" deleted: type: "boolean" V3.Users.ApiTokenResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Users.ApiToken" V3.Users.Contact: type: "object" required: - "dial_code" - "phone_number" properties: dial_code: type: "string" phone_number: type: "string" V3.Users.GlobalRBACAbilityName: type: "string" enum: - "manage-api-tokens" - "manage-billing" - "manage-extensions" - "manage-teams" - "manage-users" - "manage-webhooks" - "manage-organization-analytics" - "manage-postmortem-templates" - "manage-audit-logs" - "manage-feature-settings" description: "Represents the name of a global RBAC ability." V3.Users.NotificationRule: type: "object" required: - "type" - "time" properties: type: type: "string" time: type: "integer" V3.Users.UpdateUserAbilitiesRequest: type: "object" required: - "data" properties: data: type: "array" items: type: "object" properties: user_id: type: "string" abilities: type: "array" items: $ref: "#/components/schemas/V3.Users.GlobalRBACAbilityName" required: - "user_id" - "abilities" V3.Users.UpdateUserRequest: type: "object" required: - "role" properties: role: type: "string" enum: - "account_owner" - "user" - "stakeholder" V3.Users.User: type: "object" required: - "id" - "first_name" - "last_name" - "username_for_display" - "email" - "contact" - "secondary_emails" - "email_verified" - "time_zone" - "title" - "bio" - "notification_rules" - "user_image" properties: id: type: "string" first_name: type: "string" last_name: type: "string" username_for_display: type: "string" email: type: "string" contact: $ref: "#/components/schemas/V3.Users.Contact" secondary_emails: anyOf: - type: "array" items: type: "string" - type: "null" email_verified: type: "boolean" time_zone: type: "string" title: type: "string" bio: type: "string" notification_rules: type: "array" items: $ref: "#/components/schemas/V3.Users.NotificationRule" user_image: type: "boolean" role_id: type: "string" role: type: "string" V3.Users.UserResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Users.User" V3.Users.UserRole: type: "object" required: - "id" - "name" - "limit" - "order" properties: id: type: "string" name: type: "string" limit: type: "integer" order: type: "integer" V3.Users.UserRoleResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Users.UserRole" V3.Webforms.CreateOrUpdateWebformRequest: type: "object" required: - "owner_id" - "name" - "is_cname" - "is_captcha_enabled" - "captcha_secret" - "form_owner_type" - "form_owner_id" - "services" - "header" - "title" - "footer_text" - "footer_link" properties: owner_id: type: "string" description: "Unique identifier of the owner (string or UUID)" name: type: "string" description: "Name of the webform" is_cname: type: "boolean" description: "Indicates if a custom domain (CNAME) is used" host_name: type: "string" description: "Custom hostname if CNAME is enabled" tags: type: "object" unevaluatedProperties: type: "string" description: "Key-value tags for the webform" is_captcha_enabled: type: "boolean" description: "Whether CAPTCHA is enabled on the form" captcha_secret: allOf: - $ref: "#/components/schemas/V3.Webforms.RecaptchaSecrets" description: "CAPTCHA credentials to be validated" form_owner_type: type: "string" description: "Entity type that owns the form (e.g., team, user)" form_owner_id: type: "string" description: "Identifier for the owner entity" services: type: "array" items: $ref: "#/components/schemas/V3.Webforms.WFService" description: "List of services tied to this webform" input_field: type: "array" items: $ref: "#/components/schemas/V3.Webforms.WFInputField" description: "Input fields to be rendered on the form" header: type: "string" description: "Header text shown on the form" title: type: "string" description: "Title of the webform" logo_url: type: "string" description: "URL to the organization's logo" footer_text: type: "string" description: "Text displayed in the footer" footer_link: type: "string" description: "Hyperlink in the footer (mailto or https)" email_on: type: "array" items: type: "string" description: "Emails to notify on submission" description: type: "string" description: "Optional description for the webform" description: "Public API request for creating a webform" V3.Webforms.RecaptchaSecrets: type: "object" required: - "site_key" - "secret" properties: site_key: type: "string" description: "reCAPTCHA site key" secret: type: "string" description: "reCAPTCHA secret key" description: "reCAPTCHA credentials to be validated" V3.Webforms.WFInputField: type: "object" required: - "label" - "options" properties: label: type: "string" description: "Field label" options: type: "array" items: type: "string" description: "Selectable options for this field" description: "Input field definition for a webform" V3.Webforms.WFService: type: "object" required: - "service_id" - "name" - "alias" properties: service_id: type: "string" description: "Public identifier for the service" name: type: "string" description: "Service name as shown in UI" alias: type: "string" description: "Optional alias for the service" description: "Service details for a webform" V3.Webforms.Webform: type: "object" required: - "id" - "org_id" - "owner_id" - "name" - "is_cname" - "public_url" - "tags" - "is_captcha_enabled" - "captcha_provider" - "captcha_secret" - "form_owner_type" - "form_owner_id" - "form_owner_name" - "services" - "input_field" - "header" - "title" - "footer_text" - "footer_link" - "email_on" - "incident_count" - "mttr" - "is_deleted" - "deleted_at" properties: id: type: "integer" format: "int32" org_id: type: "string" owner_id: type: "string" name: type: "string" is_cname: type: "boolean" public_url: type: "string" host_name: type: "string" tags: type: "object" unevaluatedProperties: type: "string" is_captcha_enabled: type: "boolean" captcha_provider: type: "string" captcha_secret: $ref: "#/components/schemas/V3.Webforms.RecaptchaSecrets" form_owner_type: type: "string" form_owner_id: type: "string" form_owner_name: type: "string" services: type: "array" items: $ref: "#/components/schemas/V3.Webforms.WFService" input_field: type: "array" items: $ref: "#/components/schemas/V3.Webforms.WFInputField" header: type: "string" title: type: "string" logo_url: type: "string" footer_text: type: "string" footer_link: type: "string" email_on: type: "array" items: type: "string" description: type: "string" incident_count: type: "integer" format: "int64" mttr: type: "number" format: "double" is_deleted: type: "boolean" deleted_at: type: "string" V3.Webforms.WebformResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Webforms.Webform" V3.Workflows.ActionRequest: anyOf: - type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_attach_runbooks" data: type: "object" properties: runbooks: type: "array" items: type: "string" required: - "runbooks" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" - $ref: "#/components/schemas/V3.Workflows.SqMarkIncidentSLOAffecting" - $ref: "#/components/schemas/V3.Workflows.SqTriggerManualWebhook" - $ref: "#/components/schemas/V3.Workflows.UpdateIncidentPriority" - $ref: "#/components/schemas/V3.Workflows.SqCreateStatusPageIssue" - $ref: "#/components/schemas/V3.Workflows.SqAddIncidentNote" - $ref: "#/components/schemas/V3.Workflows.SlackArchiveChannel" - $ref: "#/components/schemas/V3.Workflows.SqAddCommunicationChannel" - $ref: "#/components/schemas/V3.Workflows.SlackMessageChannel" - $ref: "#/components/schemas/V3.Workflows.SlackMessageUser" - $ref: "#/components/schemas/V3.Workflows.SqMakeHTTPCall" - $ref: "#/components/schemas/V3.Workflows.SlackCreateIncidentChannel" - $ref: "#/components/schemas/V3.Workflows.JiraCreateTicket" - $ref: "#/components/schemas/V3.Workflows.MsTeamsMessageChannel" - $ref: "#/components/schemas/V3.Workflows.MsTeamsMessageUser" - $ref: "#/components/schemas/V3.Workflows.SqSendEmail" - $ref: "#/components/schemas/V3.Workflows.MsTeamsCreateMeetingLink" - {} V3.Workflows.ActionRequestUpdate: anyOf: - type: "object" properties: name: type: "string" enum: - "sq_attach_runbooks" data: type: "object" properties: runbooks: type: "array" items: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" - $ref: "#/components/schemas/V3.Workflows.SqMarkIncidentSLOAffectingUpdate" - $ref: "#/components/schemas/V3.Workflows.SqTriggerManualWebhookUpdate" - $ref: "#/components/schemas/V3.Workflows.UpdateIncidentPriorityUpdate" - $ref: "#/components/schemas/V3.Workflows.SqCreateStatusPageIssueUpdate" - $ref: "#/components/schemas/V3.Workflows.SqAddIncidentNoteUpdate" - $ref: "#/components/schemas/V3.Workflows.SlackArchiveChannelUpdate" - $ref: "#/components/schemas/V3.Workflows.SqAddCommunicationChannelUpdate" - $ref: "#/components/schemas/V3.Workflows.SlackMessageChannelUpdate" - $ref: "#/components/schemas/V3.Workflows.SlackMessageUserUpdate" - $ref: "#/components/schemas/V3.Workflows.SqMakeHTTPCallUpdate" - $ref: "#/components/schemas/V3.Workflows.SlackCreateIncidentChannelUpdate" - $ref: "#/components/schemas/V3.Workflows.JiraCreateTicketUpdate" - $ref: "#/components/schemas/V3.Workflows.MsTeamsMessageChannelUpdate" - $ref: "#/components/schemas/V3.Workflows.MsTeamsMessageUserUpdate" - $ref: "#/components/schemas/V3.Workflows.SqSendEmailUpdate" - $ref: "#/components/schemas/V3.Workflows.MsTeamsCreateMeetingLinkUpdate" - {} V3.Workflows.ActionResponse: anyOf: - type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_attach_runbooks" data: type: "object" properties: runbooks: type: "array" items: $ref: "#/components/schemas/V3.Workflows.RunbookResponse" required: - "runbooks" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" - $ref: "#/components/schemas/V3.Workflows.SqMarkIncidentSLOAffecting" - $ref: "#/components/schemas/V3.Workflows.SqTriggerManualWebhook" - $ref: "#/components/schemas/V3.Workflows.UpdateIncidentPriority" - $ref: "#/components/schemas/V3.Workflows.SqCreateStatusPageIssue" - $ref: "#/components/schemas/V3.Workflows.SqAddIncidentNote" - $ref: "#/components/schemas/V3.Workflows.SlackArchiveChannel" - $ref: "#/components/schemas/V3.Workflows.SqAddCommunicationChannel" - $ref: "#/components/schemas/V3.Workflows.SlackMessageChannel" - $ref: "#/components/schemas/V3.Workflows.SlackMessageUser" - $ref: "#/components/schemas/V3.Workflows.SqMakeHTTPCall" - $ref: "#/components/schemas/V3.Workflows.SlackCreateIncidentChannel" - $ref: "#/components/schemas/V3.Workflows.JiraCreateTicket" - $ref: "#/components/schemas/V3.Workflows.MsTeamsMessageChannel" - $ref: "#/components/schemas/V3.Workflows.MsTeamsMessageUser" - $ref: "#/components/schemas/V3.Workflows.SqSendEmail" - $ref: "#/components/schemas/V3.Workflows.MsTeamsCreateMeetingLink" - {} V3.Workflows.BaseAction: type: "object" required: - "name" properties: name: type: "string" discriminator: propertyName: "name" mapping: sq_mark_incident_slo_affecting: "#/components/schemas/V3.Workflows.SqMarkIncidentSLOAffecting" sq_trigger_manual_webhook: "#/components/schemas/V3.Workflows.SqTriggerManualWebhook" sq_update_incident_priority: "#/components/schemas/V3.Workflows.UpdateIncidentPriority" sq_add_status_page_issue: "#/components/schemas/V3.Workflows.SqCreateStatusPageIssue" sq_add_incident_note: "#/components/schemas/V3.Workflows.SqAddIncidentNote" slack_archive_channel: "#/components/schemas/V3.Workflows.SlackArchiveChannel" sq_add_communication_channel: "#/components/schemas/V3.Workflows.SqAddCommunicationChannel" slack_message_channel: "#/components/schemas/V3.Workflows.SlackMessageChannel" slack_message_user: "#/components/schemas/V3.Workflows.SlackMessageUser" sq_make_http_call: "#/components/schemas/V3.Workflows.SqMakeHTTPCall" slack_create_incident_channel: "#/components/schemas/V3.Workflows.SlackCreateIncidentChannel" jira_create_ticket: "#/components/schemas/V3.Workflows.JiraCreateTicket" msteams_message_channel: "#/components/schemas/V3.Workflows.MsTeamsMessageChannel" msteams_message_user: "#/components/schemas/V3.Workflows.MsTeamsMessageUser" sq_send_email: "#/components/schemas/V3.Workflows.SqSendEmail" msteams_create_meeting_link: "#/components/schemas/V3.Workflows.MsTeamsCreateMeetingLink" V3.Workflows.BaseActionUpdate: type: "object" required: - "name" properties: name: type: "string" discriminator: propertyName: "name" mapping: sq_mark_incident_slo_affecting: "#/components/schemas/V3.Workflows.SqMarkIncidentSLOAffectingUpdate" sq_trigger_manual_webhook: "#/components/schemas/V3.Workflows.SqTriggerManualWebhookUpdate" sq_update_incident_priority: "#/components/schemas/V3.Workflows.UpdateIncidentPriorityUpdate" sq_add_status_page_issue: "#/components/schemas/V3.Workflows.SqCreateStatusPageIssueUpdate" sq_add_incident_note: "#/components/schemas/V3.Workflows.SqAddIncidentNoteUpdate" slack_archive_channel: "#/components/schemas/V3.Workflows.SlackArchiveChannelUpdate" sq_add_communication_channel: "#/components/schemas/V3.Workflows.SqAddCommunicationChannelUpdate" slack_message_channel: "#/components/schemas/V3.Workflows.SlackMessageChannelUpdate" slack_message_user: "#/components/schemas/V3.Workflows.SlackMessageUserUpdate" sq_make_http_call: "#/components/schemas/V3.Workflows.SqMakeHTTPCallUpdate" slack_create_incident_channel: "#/components/schemas/V3.Workflows.SlackCreateIncidentChannelUpdate" jira_create_ticket: "#/components/schemas/V3.Workflows.JiraCreateTicketUpdate" msteams_message_channel: "#/components/schemas/V3.Workflows.MsTeamsMessageChannelUpdate" msteams_message_user: "#/components/schemas/V3.Workflows.MsTeamsMessageUserUpdate" sq_send_email: "#/components/schemas/V3.Workflows.SqSendEmailUpdate" msteams_create_meeting_link: "#/components/schemas/V3.Workflows.MsTeamsCreateMeetingLinkUpdate" V3.Workflows.BulkEnableDisableWorkflowsRequest: type: "object" required: - "owner_id" - "enabled" - "workflow_ids" properties: owner_id: type: "string" enabled: type: "boolean" workflow_ids: type: "array" items: type: "integer" format: "int32" V3.Workflows.CommunicationChannel: type: "object" required: - "display_text" - "link" - "type" properties: display_text: type: "string" link: type: "string" type: type: "string" enum: - "chat_room" - "video_conference" - "other" V3.Workflows.ComponentAndImpact: type: "object" required: - "component_id" - "impact_status_id" properties: component_id: type: "integer" format: "int32" impact_status_id: type: "integer" format: "int32" V3.Workflows.CreateWorkflowFilter: type: "object" properties: type: type: "string" key: type: "string" value: {} fields: $ref: "#/components/schemas/V3.Workflows.CreateWorkflowFilter" children: type: "array" items: $ref: "#/components/schemas/V3.Workflows.CreateWorkflowFilter" label: type: "string" entity: type: "object" unevaluatedProperties: {} filterType: type: "string" V3.Workflows.CreateWorkflowRequest: type: "object" required: - "title" - "owner_id" - "trigger" - "filters" - "actions" properties: title: type: "string" description: type: "string" owner_id: type: "string" owner_type: type: "string" enum: - "user" - "squad" entity_owner: $ref: "#/components/schemas/V3.Workflows.EntityOwner" tags: type: "array" items: $ref: "#/components/schemas/V3.Workflows.Tag" trigger: $ref: "#/components/schemas/V3.Workflows.WorkflowTrigger" filters: $ref: "#/components/schemas/V3.Workflows.CreateWorkflowFilter" actions: type: "array" items: $ref: "#/components/schemas/V3.Workflows.ActionRequest" enabled: type: "boolean" V3.Workflows.CreateWorkflowRequestUpdate: type: "object" properties: title: type: "string" description: type: "string" owner_id: type: "string" owner_type: type: "string" enum: - "user" - "squad" entity_owner: $ref: "#/components/schemas/V3.Workflows.EntityOwnerUpdate" tags: type: "array" items: $ref: "#/components/schemas/V3.Workflows.Tag" trigger: $ref: "#/components/schemas/V3.Workflows.WorkflowTrigger" filters: $ref: "#/components/schemas/V3.Workflows.CreateWorkflowFilter" actions: type: "array" items: $ref: "#/components/schemas/V3.Workflows.ActionRequest" enabled: type: "boolean" V3.Workflows.EnableDisableWorkflowRequest: type: "object" properties: enabled: type: "boolean" V3.Workflows.EntityOwner: type: "object" required: - "id" - "type" properties: id: type: "string" type: type: "string" V3.Workflows.EntityOwnerBasedACL: type: "object" required: - "has_update_access" - "has_update_owner_access" - "has_delete_access" properties: has_update_access: type: "boolean" has_update_owner_access: type: "boolean" has_delete_access: type: "boolean" V3.Workflows.EntityOwnerUpdate: type: "object" properties: id: type: "string" type: type: "string" V3.Workflows.Filter: type: "object" required: - "operator" - "value" - "logicalOperator" properties: operator: type: "string" value: type: "string" logicalOperator: type: "string" V3.Workflows.FilterGroup: type: "object" required: - "type" - "filters" properties: type: type: "string" filters: type: "array" items: $ref: "#/components/schemas/V3.Workflows.Filter" V3.Workflows.GetWorkflowActionByIdResponse: type: "object" required: - "id" - "workflow_id" - "name" - "data" properties: id: type: "integer" format: "int32" workflow_id: type: "integer" format: "int32" name: type: "string" data: {} V3.Workflows.GetWorkflowByIdResponse: type: "object" required: - "data" properties: data: $ref: "#/components/schemas/V3.Workflows.WorkflowAPIResponse" V3.Workflows.GetWorkflowLogsResponse: type: "object" required: - "data" - "meta" properties: data: type: "array" items: type: "object" properties: id: type: "string" status: type: "string" enum: - "queued" - "running" - "successful" - "partial" - "failed" incident_id: type: "string" action_execution: type: "string" message: type: "string" executed_at: type: "string" required: - "id" - "status" - "incident_id" - "action_execution" - "message" - "executed_at" meta: type: "object" properties: total_count: type: "integer" required: - "total_count" V3.Workflows.IssueStatusAndMessage: type: "object" required: - "messages" - "status_id" properties: messages: type: "array" items: type: "string" status_id: type: "integer" format: "int32" V3.Workflows.JiraCreateTicket: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "jira_create_ticket" data: type: "object" properties: account: type: "string" project: type: "string" issue_type: type: "string" title: type: "string" description: type: "string" required: - "account" - "project" - "issue_type" - "title" - "description" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.JiraCreateTicketUpdate: type: "object" properties: name: type: "string" enum: - "jira_create_ticket" data: type: "object" properties: account: type: "string" project: type: "string" issue_type: type: "string" title: type: "string" description: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.ListWorkflowAPIResponse: type: "object" required: - "data" - "meta" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Workflows.WorkflowAPIResponse" meta: type: "object" properties: total_count: type: "integer" format: "int32" acl: type: "object" unevaluatedProperties: $ref: "#/components/schemas/V3.Workflows.EntityOwnerBasedACL" required: - "total_count" V3.Workflows.ListWorkflowResponse: type: "object" required: - "data" - "metadata" properties: data: type: "array" items: $ref: "#/components/schemas/V3.Workflows.WorkflowResponse" metadata: type: "object" properties: total_count: type: "integer" format: "int32" acl: type: "object" unevaluatedProperties: $ref: "#/components/schemas/V3.Workflows.EntityOwnerBasedACL" required: - "total_count" V3.Workflows.MsTeamsCreateMeetingLink: type: "object" required: - "name" properties: name: type: "string" enum: - "msteams_create_meeting_link" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.MsTeamsCreateMeetingLinkUpdate: type: "object" properties: name: type: "string" enum: - "msteams_create_meeting_link" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.MsTeamsMessageChannel: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "msteams_message_channel" data: type: "object" properties: channel_id: type: "string" message: type: "string" required: - "channel_id" - "message" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.MsTeamsMessageChannelUpdate: type: "object" properties: name: type: "string" enum: - "msteams_message_channel" data: type: "object" properties: channel_id: type: "string" message: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.MsTeamsMessageUser: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "msteams_message_user" data: type: "object" properties: member_id: type: "string" message: type: "string" required: - "member_id" - "message" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.MsTeamsMessageUserUpdate: type: "object" properties: name: type: "string" enum: - "msteams_message_user" data: type: "object" properties: member_id: type: "string" message: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.RunbookResponse: type: "object" required: - "id" - "name" properties: id: type: "string" name: type: "string" V3.Workflows.SlackArchiveChannel: type: "object" required: - "name" properties: name: type: "string" enum: - "slack_archive_channel" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SlackArchiveChannelUpdate: type: "object" properties: name: type: "string" enum: - "slack_archive_channel" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.SlackCreateIncidentChannel: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "slack_create_incident_channel" data: type: "object" properties: auto_name: type: "boolean" channel_name: type: "string" required: - "auto_name" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SlackCreateIncidentChannelUpdate: type: "object" properties: name: type: "string" enum: - "slack_create_incident_channel" data: type: "object" properties: auto_name: type: "boolean" channel_name: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.SlackMessageChannel: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "slack_message_channel" data: type: "object" properties: channel_id: type: "string" channel_name: type: "string" message: type: "string" required: - "channel_id" - "channel_name" - "message" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SlackMessageChannelUpdate: type: "object" properties: name: type: "string" enum: - "slack_message_channel" data: type: "object" properties: channel_id: type: "string" channel_name: type: "string" message: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.SlackMessageUser: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "slack_message_user" data: type: "object" properties: member_id: type: "string" message: type: "string" required: - "member_id" - "message" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SlackMessageUserUpdate: type: "object" properties: name: type: "string" enum: - "slack_message_user" data: type: "object" properties: member_id: type: "string" message: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.SqAddCommunicationChannel: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_add_communication_channel" data: type: "object" properties: channels: type: "array" items: $ref: "#/components/schemas/V3.Workflows.CommunicationChannel" required: - "channels" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SqAddCommunicationChannelUpdate: type: "object" properties: name: type: "string" enum: - "sq_add_communication_channel" data: type: "object" properties: channels: type: "array" items: $ref: "#/components/schemas/V3.Workflows.CommunicationChannel" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.SqAddIncidentNote: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_add_incident_note" data: type: "object" properties: note: type: "string" required: - "note" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SqAddIncidentNoteUpdate: type: "object" properties: name: type: "string" enum: - "sq_add_incident_note" data: type: "object" properties: note: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.SqCreateStatusPageIssue: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_add_status_page_issue" data: type: "object" properties: component_and_impact: type: "array" items: $ref: "#/components/schemas/V3.Workflows.ComponentAndImpact" issue_title: type: "string" page_status_id: type: "integer" format: "int32" status_and_message: type: "array" items: $ref: "#/components/schemas/V3.Workflows.IssueStatusAndMessage" status_page_id: type: "integer" format: "int32" required: - "component_and_impact" - "issue_title" - "page_status_id" - "status_and_message" - "status_page_id" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SqCreateStatusPageIssueUpdate: type: "object" properties: name: type: "string" enum: - "sq_add_status_page_issue" data: type: "object" properties: component_and_impact: type: "array" items: $ref: "#/components/schemas/V3.Workflows.ComponentAndImpact" issue_title: type: "string" page_status_id: type: "integer" format: "int32" status_and_message: type: "array" items: $ref: "#/components/schemas/V3.Workflows.IssueStatusAndMessage" status_page_id: type: "integer" format: "int32" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.SqMakeHTTPCall: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_make_http_call" data: type: "object" properties: method: type: "string" enum: - "GET" - "POST" - "PUT" - "PATCH" - "DELETE" url: type: "string" headers: type: "array" items: type: "object" properties: key: type: "string" value: type: "string" required: - "key" - "value" body: type: "string" required: - "method" - "url" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SqMakeHTTPCallUpdate: type: "object" properties: name: type: "string" enum: - "sq_make_http_call" data: type: "object" properties: method: type: "string" enum: - "GET" - "POST" - "PUT" - "PATCH" - "DELETE" url: type: "string" headers: type: "array" items: type: "object" properties: key: type: "string" value: type: "string" required: - "key" - "value" body: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.SqMarkIncidentSLOAffecting: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_mark_incident_slo_affecting" data: type: "object" properties: slis: type: "array" items: type: "string" slo: type: "integer" format: "int32" required: - "slis" - "slo" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SqMarkIncidentSLOAffectingUpdate: type: "object" properties: name: type: "string" enum: - "sq_mark_incident_slo_affecting" data: type: "object" properties: slis: type: "array" items: type: "string" slo: type: "integer" format: "int32" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.SqSendEmail: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_send_email" data: type: "object" properties: to: type: "array" items: type: "string" subject: type: "string" body: type: "string" required: - "to" - "subject" - "body" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SqSendEmailUpdate: type: "object" properties: name: type: "string" enum: - "sq_send_email" data: type: "object" properties: to: type: "array" items: type: "string" subject: type: "string" body: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.SqTriggerManualWebhook: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_trigger_manual_webhook" data: type: "object" properties: id: type: "string" required: - "id" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.SqTriggerManualWebhookUpdate: type: "object" properties: name: type: "string" enum: - "sq_trigger_manual_webhook" data: type: "object" properties: id: type: "string" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.Tag: type: "object" properties: color: type: "string" key: type: "string" value: type: "string" V3.Workflows.UpdateActionsOrderRequest: type: "object" properties: action_order: type: "array" items: type: "integer" format: "int32" V3.Workflows.UpdateActionsOrderResponse: type: "object" required: - "data" properties: data: type: "object" properties: action_order: type: "array" items: type: "integer" format: "int32" required: - "action_order" V3.Workflows.UpdateIncidentPriority: type: "object" required: - "name" - "data" properties: name: type: "string" enum: - "sq_update_incident_priority" data: type: "object" properties: priority: type: "string" enum: - "P1" - "P2" - "P3" - "P4" - "P5" - "UNSET" required: - "priority" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseAction" V3.Workflows.UpdateIncidentPriorityUpdate: type: "object" properties: name: type: "string" enum: - "sq_update_incident_priority" data: type: "object" properties: priority: type: "string" enum: - "P1" - "P2" - "P3" - "P4" - "P5" - "UNSET" allOf: - $ref: "#/components/schemas/V3.Workflows.BaseActionUpdate" V3.Workflows.UpdateWorkflowAPIResponse: type: "object" properties: id: type: "integer" format: "int32" owner_id: type: "string" title: type: "string" description: type: "string" enabled: type: "boolean" trigger: type: "string" filters: $ref: "#/components/schemas/V3.Workflows.WorkflowFilters" tags: type: "array" items: $ref: "#/components/schemas/V3.Workflows.Tag" actions: type: "array" items: $ref: "#/components/schemas/V3.Workflows.ActionResponse" created_at: type: "string" created_by: type: "string" updated_at: type: "string" updated_by: type: "string" V3.Workflows.UpdateWorkflowRequest: type: "object" properties: owner_id: type: "string" title: type: "string" description: type: "string" enabled: type: "boolean" trigger: $ref: "#/components/schemas/V3.Workflows.WorkflowTrigger" filters: type: "object" properties: condition: type: "string" filters: type: "array" items: type: "object" properties: type: type: "string" value: type: "string" required: - "type" - "value" required: - "condition" - "filters" tags: type: "array" items: $ref: "#/components/schemas/V3.Workflows.Tag" actions: type: "array" items: type: "object" properties: data: type: "object" properties: note: type: "string" required: - "note" name: type: "string" entity_owner: type: "object" properties: id: type: "string" type: type: "string" required: - "id" - "type" V3.Workflows.WfDomainFilter: type: "object" properties: type: type: "string" key: type: "string" value: type: "string" fields: $ref: "#/components/schemas/V3.Workflows.WfDomainFilter" children: type: "array" items: $ref: "#/components/schemas/V3.Workflows.WfDomainFilter" V3.Workflows.Workflow: type: "object" required: - "team_id" - "actions" - "created_at" - "created_by" - "description" - "enabled" - "filters" - "filter_groups" - "id" - "owner_id" - "owner_type" - "tags" - "title" - "trigger" properties: team_id: type: "string" actions: type: "array" items: $ref: "#/components/schemas/V3.Workflows.ActionResponse" created_at: type: "string" created_by: type: "string" description: type: "string" enabled: type: "boolean" filters: $ref: "#/components/schemas/V3.Workflows.WfDomainFilter" filter_groups: type: "array" items: $ref: "#/components/schemas/V3.Workflows.FilterGroup" id: type: "integer" format: "int32" owner_id: type: "string" owner_type: type: "string" enum: - "user" - "squad" tags: type: "array" items: $ref: "#/components/schemas/V3.Workflows.Tag" title: type: "string" trigger: $ref: "#/components/schemas/V3.Workflows.WorkflowTrigger" updated_at: type: "string" updated_by: type: "string" execution_count: type: "integer" format: "int32" V3.Workflows.WorkflowAPI: type: "object" required: - "id" - "owner_id" - "title" - "description" - "enabled" - "trigger" - "tags" - "actions" - "created_at" - "created_by" properties: id: type: "integer" format: "int32" owner_id: type: "string" title: type: "string" description: type: "string" enabled: type: "boolean" trigger: type: "string" filters: $ref: "#/components/schemas/V3.Workflows.WorkflowFilters" tags: type: "array" items: $ref: "#/components/schemas/V3.Workflows.Tag" actions: type: "array" items: $ref: "#/components/schemas/V3.Workflows.ActionResponse" created_at: type: "string" created_by: type: "string" updated_at: type: "string" updated_by: type: "string" V3.Workflows.WorkflowAPIRequest: type: "object" required: - "owner_id" - "title" - "description" - "enabled" - "trigger" - "filters" - "tags" - "actions" properties: owner_id: type: "string" title: type: "string" description: type: "string" enabled: type: "boolean" trigger: type: "string" filters: $ref: "#/components/schemas/V3.Workflows.WorkflowFilters" tags: type: "array" items: $ref: "#/components/schemas/V3.Workflows.Tag" actions: type: "array" items: $ref: "#/components/schemas/V3.Workflows.ActionRequest" V3.Workflows.WorkflowAPIResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Workflows.WorkflowAPI" V3.Workflows.WorkflowFilters: type: "object" properties: type: type: "string" key: type: "string" value: type: "string" condition: type: "string" enum: - "and" - "or" filters: type: "array" items: $ref: "#/components/schemas/V3.Workflows.WorkflowFilters" V3.Workflows.WorkflowResponse: type: "object" allOf: - $ref: "#/components/schemas/V3.Workflows.Workflow" V3.Workflows.WorkflowTrigger: type: "string" enum: - "incident_triggered" - "incident_acknowledged" - "incident_resolved" - "incident_reassigned" - "incident_tag_updated" - "incident_priority_updated" - "incident_note_added" V4.ChangeTimezoneResponse: type: "object" required: - "timeZone" properties: timeZone: type: "string" V4.CreateRotationRequest: type: "object" required: - "name" - "startDate" - "period" - "changeParticipantsFrequency" - "changeParticipantsUnit" - "participantGroups" properties: name: type: "string" color: type: "string" startDate: type: "string" period: type: "string" customPeriodFrequency: type: "integer" customPeriodUnit: type: "string" shiftTimeSlots: type: "array" items: $ref: "#/components/schemas/V4.ShiftTimeSlot" changeParticipantsFrequency: type: "integer" changeParticipantsUnit: type: "string" endDate: type: "string" endsAfterIterations: type: "integer" participantGroups: type: "array" items: $ref: "#/components/schemas/V4.ParticipantGroup" V4.CreateScheduleOverrideRequest: type: "object" required: - "startTime" - "endTime" - "reason" - "overriddenParticipant" - "overrideWith" properties: startTime: type: "string" endTime: type: "string" reason: type: "string" overriddenParticipant: $ref: "#/components/schemas/V4.OverrideParticipantGroup" overrideWith: $ref: "#/components/schemas/V4.OverrideParticipantGroup" V4.CreateScheduleRequest: type: "object" required: - "name" - "description" - "teamID" - "ownerID" - "ownerType" - "timeZone" - "tags" properties: name: type: "string" description: type: "string" teamID: type: "string" ownerID: type: "string" ownerType: type: "string" enum: - "user" - "squad" timeZone: type: "string" tags: type: "array" items: $ref: "#/components/schemas/V4.Tag" V4.DeleteScheduleRequest: type: "object" required: - "replaceOnConflict" properties: replaceOnConflict: type: "array" items: type: "object" properties: escalationPolicyID: type: "string" scheduleIDs: type: "array" items: type: "integer" userIDs: type: "array" items: {} squadIDs: type: "array" items: {} V4.GetRotationParticipantsResponse: type: "object" required: - "rotationID" - "participants" properties: rotationID: type: "integer" participants: type: "array" items: $ref: "#/components/schemas/V4.ParticipantGroup" V4.ICalLink: type: "object" properties: iCalLink: type: "string" iCalLinkForMyOnCalls: type: "string" V4.ICalLinkResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.ICalLink" V4.OverrideParticipantGroup: type: "object" required: - "group" properties: group: type: "array" items: $ref: "#/components/schemas/V4.Participant" V4.OverrideResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.ScheduleOverride" V4.Participant: type: "object" required: - "id" - "type" properties: id: type: "string" type: type: "string" V4.ParticipantGroup: type: "object" required: - "participants" properties: participants: type: "array" items: $ref: "#/components/schemas/V4.Participant" V4.PauseResumeScheduleResponse: type: "object" required: - "action" - "success" properties: action: type: "string" success: type: "boolean" V4.Rotation: type: "object" required: - "id" - "name" - "scheduleID" - "color" - "startDate" - "period" - "changeParticipantsFrequency" - "changeParticipantsUnit" - "createdAt" - "updatedAt" properties: id: type: "integer" name: type: "string" scheduleID: type: "integer" color: type: "string" startDate: type: "string" period: type: "string" customPeriodFrequency: type: "integer" customPeriodUnit: type: "string" shiftTimeSlots: type: "array" items: $ref: "#/components/schemas/V4.ShiftTimeSlot" changeParticipantsFrequency: type: "integer" changeParticipantsUnit: type: "string" endDate: type: "string" endsAfterIterations: type: "integer" rotationParticipants: type: "array" items: $ref: "#/components/schemas/V4.ParticipantGroup" createdAt: type: "string" updatedAt: type: "string" V4.RotationParticipants: type: "object" required: - "rotationID" - "participantGroups" properties: rotationID: type: "integer" participantGroups: type: "array" items: $ref: "#/components/schemas/V4.ParticipantGroup" V4.RotationParticipantsResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.RotationParticipants" V4.RotationResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.Rotation" V4.Schedule: type: "object" required: - "id" - "name" - "description" - "orgID" - "teamID" - "timeZone" - "paused" - "ownerID" - "ownerType" - "tags" - "createdAt" - "updatedAt" properties: id: type: "integer" name: type: "string" description: type: "string" orgID: type: "string" teamID: type: "string" timeZone: type: "string" paused: type: "boolean" ownerID: type: "string" ownerType: type: "string" enum: - "user" - "squad" tags: anyOf: - type: "array" items: $ref: "#/components/schemas/V4.Tag" - type: "null" createdAt: type: "string" updatedAt: type: "string" V4.ScheduleOverride: type: "object" required: - "id" - "orgID" - "teamID" - "scheduleID" - "startTime" - "endTime" - "reason" - "overriddenParticipant" - "overrideWith" - "createdAt" - "updatedAt" properties: id: type: "integer" orgID: type: "string" teamID: type: "string" scheduleID: type: "integer" startTime: type: "string" endTime: type: "string" reason: type: "string" overriddenParticipant: $ref: "#/components/schemas/V4.OverrideParticipantGroup" overrideWith: $ref: "#/components/schemas/V4.OverrideParticipantGroup" createdAt: type: "string" updatedAt: type: "string" V4.ScheduleResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.Schedule" V4.ShiftTimeSlot: type: "object" required: - "startHour" - "startMin" - "duration" properties: startHour: type: "integer" startMin: type: "integer" duration: type: "integer" dayOfWeek: type: "string" V4.Squads.CreateSquadRequest: type: "object" required: - "owner_id" - "name" - "members" properties: owner_id: type: "string" name: type: "string" members: type: "array" items: $ref: "#/components/schemas/V4.Squads.SquadMember" V4.Squads.CreateSquadResponse: type: "object" required: - "organization_id" - "owner_id" - "id" - "name" - "slug" - "members" - "created_at" - "created_by" properties: organization_id: type: "string" owner_id: type: "string" id: type: "string" name: type: "string" slug: type: "string" members: type: "array" items: $ref: "#/components/schemas/V4.Squads.SquadMember" created_at: type: "string" created_by: type: "string" V4.Squads.RemoveSquadMemberResponse: type: "object" required: - "id" - "members" properties: id: type: "string" members: type: "array" items: $ref: "#/components/schemas/V4.Squads.SquadMember" V4.Squads.Squad: type: "object" required: - "id" - "org_id" - "team_id" - "name" - "members" - "createdAt" - "updatedAt" properties: id: type: "string" org_id: type: "string" team_id: type: "string" name: type: "string" members: type: "array" items: $ref: "#/components/schemas/V4.Squads.SquadMember" createdAt: type: "string" createdBy: type: "string" updatedAt: type: "string" updatedBy: type: "string" V4.Squads.SquadMember: type: "object" required: - "user_id" properties: user_id: type: "string" role: type: "string" description: "this field is required if you are using OBAC permission model" V4.Squads.SquadResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.Squads.Squad" V4.Squads.UpdateSquadMemberRequest: type: "object" required: - "role" properties: role: type: "string" V4.Squads.UpdateSquadMemberResponse: type: "object" required: - "id" - "members" properties: id: type: "string" members: type: "array" items: $ref: "#/components/schemas/V4.Squads.SquadMember" V4.Squads.UpdateSquadNameRequest: type: "object" required: - "name" properties: name: type: "string" V4.Squads.UpdateSquadNameResponse: type: "object" required: - "id" - "name" properties: id: type: "string" name: type: "string" V4.Squads.UpdateSquadRequest: type: "object" properties: name: type: "string" members: type: "array" items: $ref: "#/components/schemas/V4.Squads.SquadMember" V4.StatusPages.ComponentGroups.Component: type: "object" properties: id: type: "integer" type: type: "string" name: type: "string" allowSubscription: type: "boolean" description: type: "string" status: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.ComponentStatus" underMaintenance: type: "boolean" statusMaintenance: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.ComponentStatus" components: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.Component" isHidden: type: "boolean" V4.StatusPages.ComponentGroups.ComponentGroup: type: "object" required: - "id" - "type" - "name" - "allowSubscription" properties: id: type: "integer" type: type: "string" name: type: "string" allowSubscription: type: "boolean" description: type: "string" status: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.ComponentStatus" underMaintenance: type: "boolean" statusMaintenance: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.ComponentStatus" components: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.Component" isHidden: type: "boolean" V4.StatusPages.ComponentGroups.ComponentGroupResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.StatusPages.ComponentGroups.ComponentGroup" V4.StatusPages.ComponentGroups.ComponentStatus: type: "object" required: - "id" - "name" - "color" - "slug" properties: id: type: "integer" name: type: "string" color: type: "string" slug: type: "string" V4.StatusPages.ComponentGroups.CreateComponentGroupRequest: type: "object" required: - "name" properties: name: type: "string" description: type: "string" allowSubscription: type: "boolean" V4.StatusPages.ComponentGroups.CreateComponentGroupResponse: type: "object" required: - "id" - "pageID" - "name" - "allowSubscription" properties: id: type: "integer" pageID: type: "integer" name: type: "string" description: type: "string" allowSubscription: type: "boolean" V4.StatusPages.ComponentGroups.DeleteComponentGroupByIdResponse: type: "object" required: - "id" - "name" - "description" - "allowSubscription" properties: id: type: "integer" name: type: "string" description: anyOf: - type: "string" - type: "null" allowSubscription: type: "boolean" V4.StatusPages.ComponentGroups.GetComponentGroupByIdResponse: type: "object" required: - "id" - "pageID" - "name" - "allowSubscription" properties: id: type: "integer" pageID: type: "integer" name: type: "string" description: type: "string" allowSubscription: type: "boolean" V4.StatusPages.Components.Component: type: "object" properties: id: type: "integer" type: type: "string" name: type: "string" allowSubscription: type: "boolean" description: type: "string" status: $ref: "#/components/schemas/V4.StatusPages.Components.ComponentStatus" underMaintenance: type: "boolean" statusMaintenance: $ref: "#/components/schemas/V4.StatusPages.Components.ComponentStatus" components: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.Components.Component" isHidden: type: "boolean" V4.StatusPages.Components.ComponentStatus: type: "object" required: - "id" - "name" - "color" - "slug" properties: id: type: "integer" name: type: "string" color: type: "string" slug: type: "string" V4.StatusPages.Components.CreateComponentRequest: type: "object" required: - "name" properties: name: type: "string" description: type: "string" allowSubscription: type: "boolean" groupID: type: "string" serviceID: type: "string" V4.StatusPages.Components.CreateComponentResponse: type: "object" required: - "id" - "pageID" - "name" - "description" - "underMaintenance" properties: id: type: "integer" pageID: type: "integer" name: type: "string" description: type: "string" statusID: type: "integer" underMaintenance: type: "boolean" groupID: type: "integer" V4.StatusPages.Components.DeleteComponentByIdResponse: type: "object" required: - "id" - "name" - "description" - "allowSubscription" properties: id: type: "integer" name: type: "string" description: type: "string" allowSubscription: type: "boolean" V4.StatusPages.Components.GetComponentByIdResponse: type: "object" required: - "id" - "pageID" - "name" - "description" - "underMaintenance" properties: id: type: "integer" pageID: type: "integer" name: type: "string" description: type: "string" statusID: type: "integer" underMaintenance: type: "boolean" V4.StatusPages.Components.ListComponentsResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.StatusPages.Components.Component" V4.StatusPages.Components.UpdateComponentByIdRequest: type: "object" required: - "name" properties: name: type: "string" description: type: "string" allowSubscription: type: "boolean" groupID: type: "string" serviceID: type: "string" belongsToGroup: type: "string" V4.StatusPages.Components.UpdateComponentByIdResponse: type: "object" required: - "id" - "pageID" - "name" - "description" - "allowSubscription" properties: id: type: "integer" pageID: type: "integer" name: type: "string" description: type: "string" groupID: type: "integer" allowSubscription: type: "boolean" V4.StatusPages.CreateStatusPageRequest: type: "object" required: - "name" - "domainName" - "logoUrl" - "timezone" - "teamID" - "contactEmail" - "ownerType" - "ownerID" properties: name: type: "string" description: type: "string" isPublic: type: "boolean" domainName: type: "string" customDomainName: type: "string" logoUrl: type: "string" timezone: type: "string" teamID: type: "string" themeColor: $ref: "#/components/schemas/V4.StatusPages.NewStatusPageThemeColor" components: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.NewStatusPageComponentList" contactEmail: type: "string" allowWebhookSubscription: type: "boolean" allowComponentsSubscription: type: "boolean" allowMaintenanceSubscription: type: "boolean" ownerType: type: "string" enum: - "team" - "user" - "squad" ownerID: type: "string" V4.StatusPages.CreateStatusPageResponse: type: "object" required: - "id" - "organizationID" - "name" - "isPublic" - "timezone" - "domainName" - "contactEmail" - "allowComponentsSubscription" - "allowMaintenanceSubscription" - "allowWebhookSubscription" - "ownerType" - "ownerID" - "teamID" properties: id: type: "integer" organizationID: type: "string" name: type: "string" isPublic: type: "boolean" timezone: type: "string" description: type: "string" domainName: type: "string" contactEmail: type: "string" themeColor: $ref: "#/components/schemas/V4.StatusPages.NewStatusPageThemeColor" components: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.NewStatusPageComponentList" allowComponentsSubscription: type: "boolean" allowMaintenanceSubscription: type: "boolean" allowWebhookSubscription: type: "boolean" ownerType: type: "string" ownerID: type: "string" teamID: type: "string" V4.StatusPages.DeleteStatusPageByIdRequest: type: "object" required: - "name" - "description" - "belongsToGroup" - "groupID" properties: name: type: "string" description: type: "string" belongsToGroup: type: "boolean" groupID: type: "integer" V4.StatusPages.DeleteStatusPageByIdResponse: type: "object" required: - "id" - "name" - "organizationID" - "teamID" properties: id: type: "integer" name: type: "string" organizationID: type: "string" teamID: type: "string" V4.StatusPages.GetStatusPageByIdResponse: type: "object" required: - "id" - "organizationID" - "name" - "isPublic" - "timezone" - "domainName" - "customDomainName" - "contactEmail" - "themeColor" - "allowComponentsSubscription" - "allowMaintenanceSubscription" - "allowWebhookSubscription" - "ownerType" - "ownerID" - "teamID" properties: id: type: "integer" organizationID: type: "string" name: type: "string" isPublic: type: "boolean" timezone: type: "string" description: type: "string" domainName: type: "string" customDomainName: type: "string" contactEmail: type: "string" themeColor: type: "object" properties: primary: type: "string" secondary: type: "string" required: - "primary" - "secondary" allowComponentsSubscription: type: "boolean" allowMaintenanceSubscription: type: "boolean" allowWebhookSubscription: type: "boolean" ownerType: type: "string" ownerID: type: "string" teamID: type: "string" V4.StatusPages.Issues.ComponentStatus: type: "object" required: - "id" - "name" - "color" - "slug" properties: id: type: "integer" name: type: "string" color: type: "string" slug: type: "string" V4.StatusPages.Issues.CreateIssueRequest: type: "object" required: - "title" - "components" - "issues" properties: title: type: "string" statusID: type: "integer" components: type: "array" items: type: "object" properties: id: type: "integer" statusID: type: "integer" issues: type: "array" items: type: "object" properties: stateID: type: "integer" stateMessages: type: "array" items: type: "object" properties: text: type: "string" timestamp: type: "string" format: "date-time" V4.StatusPages.Issues.CreateIssueResponse: type: "object" required: - "id" - "componentIDs" - "title" properties: id: type: "integer" componentIDs: type: "array" items: type: "integer" title: type: "string" V4.StatusPages.Issues.DeleteIssueByIdResponse: type: "object" required: - "id" - "componentIDs" - "title" properties: id: type: "integer" componentIDs: anyOf: - type: "array" items: type: "integer" - type: "null" title: type: "string" V4.StatusPages.Issues.GetIssueByIdData: type: "object" required: - "id" - "title" - "lastUpdatedAt" - "components" - "issues" - "currentIssueState" - "pageStatus" - "underMaintenance" - "statusMaintenance" - "pageID" - "isMigrated" properties: id: type: "integer" title: type: "string" lastUpdatedAt: type: "string" format: "date-time" components: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.Issues.IssueComponentDetail" issues: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.Issues.IssueDetail" currentIssueState: $ref: "#/components/schemas/V4.StatusPages.Issues.ComponentStatus" pageStatus: $ref: "#/components/schemas/V4.StatusPages.Issues.ComponentStatus" underMaintenance: type: "boolean" statusMaintenance: $ref: "#/components/schemas/V4.StatusPages.Issues.ComponentStatus" pageID: type: "integer" isMigrated: type: "boolean" V4.StatusPages.Issues.GetIssueByIdResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.StatusPages.Issues.GetIssueByIdData" V4.StatusPages.Issues.Issue: type: "object" properties: id: type: "integer" title: type: "string" components: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.Issues.IssueComponent" currentState: $ref: "#/components/schemas/V4.StatusPages.Issues.IssueState" createdAt: type: "string" format: "date-time" V4.StatusPages.Issues.IssueComponent: type: "object" properties: id: type: "integer" name: type: "string" V4.StatusPages.Issues.IssueComponentDetail: type: "object" properties: id: type: "integer" status: $ref: "#/components/schemas/V4.StatusPages.Issues.ComponentStatus" underMaintenance: type: "boolean" statusMaintenance: $ref: "#/components/schemas/V4.StatusPages.Issues.ComponentStatus" V4.StatusPages.Issues.IssueDetail: type: "object" properties: state: $ref: "#/components/schemas/V4.StatusPages.Issues.ComponentStatus" stateMessages: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.Issues.IssueStateMessage" V4.StatusPages.Issues.IssueResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.StatusPages.Issues.Issue" V4.StatusPages.Issues.IssueState: type: "object" required: - "id" - "name" - "color" - "slug" properties: id: type: "integer" name: type: "string" color: type: "string" slug: type: "string" V4.StatusPages.Issues.IssueStateMessage: type: "object" properties: id: type: "integer" text: type: "string" timestamp: type: "string" format: "date-time" V4.StatusPages.Issues.ListIssuesResponse: type: "object" required: - "data" - "meta" properties: data: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.Issues.Issue" meta: type: "object" properties: totalCount: type: "integer" required: - "totalCount" V4.StatusPages.Issues.ListStatusPageIssueStatesResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.StatusPages.Issues.StatusPageIssueState" V4.StatusPages.Issues.StatusPageIssueState: type: "object" required: - "ID" - "Idx" - "PageID" - "Name" - "Color" - "DefaultMessage" - "createdAt" - "updatedAt" - "deletedAt" properties: ID: type: "integer" Idx: type: "integer" PageID: type: "integer" Name: type: "string" Color: type: "string" DefaultMessage: type: "string" createdAt: type: "string" format: "date-time" updatedAt: type: "string" format: "date-time" deletedAt: anyOf: - type: "string" format: "date-time" - type: "null" V4.StatusPages.Issues.UpdateIssueRequest: type: "object" required: - "title" - "components" - "issues" properties: title: type: "string" statusID: type: "integer" components: type: "array" items: type: "object" properties: id: type: "integer" statusID: type: "integer" issues: type: "array" items: type: "object" properties: stateID: type: "integer" stateMessages: type: "array" items: type: "object" properties: text: type: "string" timestamp: type: "string" format: "date-time" V4.StatusPages.Issues.UpdateIssueResponse: type: "object" required: - "id" - "componentIDs" - "title" properties: id: type: "integer" componentIDs: type: "array" items: type: "integer" title: type: "string" V4.StatusPages.ListStatusPagesResponse: type: "object" required: - "data" - "meta" properties: data: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.StatusPage" meta: type: "object" properties: totalCount: type: "integer" orgTotalCount: type: "integer" required: - "totalCount" - "orgTotalCount" V4.StatusPages.ListSubscribersResponse: type: "object" required: - "data" properties: data: anyOf: - type: "array" items: $ref: "#/components/schemas/V4.StatusPages.StatusPageSubscriber" - type: "null" meta: $ref: "#/components/schemas/V4.StatusPages.ListSubscribersResponseMeta" V4.StatusPages.ListSubscribersResponseMeta: type: "object" required: - "maximumSubscribersLimit" - "lastWeekSubscribersCount" properties: totalSubscribersCount: $ref: "#/components/schemas/V4.StatusPages.TotalSubscribersCount" maximumSubscribersLimit: type: "integer" lastWeekSubscribersCount: type: "integer" V4.StatusPages.Maintenances.CreateMaintenanceRequest: type: "object" required: - "title" - "note" - "components" - "startTime" - "endTime" properties: title: type: "string" note: type: "string" components: type: "array" items: type: "integer" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" V4.StatusPages.Maintenances.CreateMaintenanceResponse: type: "object" required: - "id" - "title" - "pageID" - "note" - "startTime" - "endTime" properties: id: type: "integer" title: type: "string" pageID: type: "integer" note: type: "string" components: type: "array" items: type: "integer" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" V4.StatusPages.Maintenances.DeleteMaintenanceByIdResponse: type: "object" required: - "id" - "title" - "pageID" - "note" - "startTime" - "endTime" properties: id: type: "integer" title: type: "string" pageID: type: "integer" note: type: "string" components: type: "array" items: type: "integer" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" V4.StatusPages.Maintenances.GetMaintenanceByIdResponse: type: "object" required: - "ID" - "PageID" - "Title" - "Note" - "StartTime" - "EndTime" - "createdAt" - "updatedAt" - "deletedAt" properties: ID: type: "integer" PageID: type: "integer" ComponentIDList: type: "array" items: type: "integer" Title: type: "string" Note: type: "string" StartTime: type: "string" format: "date-time" EndTime: type: "string" format: "date-time" createdAt: type: "string" format: "date-time" updatedAt: type: "string" format: "date-time" deletedAt: anyOf: - type: "string" format: "date-time" - type: "null" V4.StatusPages.Maintenances.ListMaintenancesResponse: type: "object" required: - "data" - "meta" properties: data: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.Maintenances.Maintenance" meta: type: "object" properties: totalCount: type: "integer" required: - "totalCount" V4.StatusPages.Maintenances.Maintenance: type: "object" properties: id: type: "integer" title: type: "string" pageID: type: "integer" note: type: "string" components: type: "array" items: type: "object" properties: id: type: "integer" name: type: "string" groupName: type: "string" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" maintenanceState: type: "string" V4.StatusPages.Maintenances.MaintenanceResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.StatusPages.Maintenances.Maintenance" V4.StatusPages.Maintenances.UpdateMaintenanceByIdRequest: type: "object" required: - "title" - "note" - "startTime" - "endTime" properties: title: type: "string" note: type: "string" components: type: "array" items: type: "integer" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" V4.StatusPages.Maintenances.UpdateMaintenanceByIdResponse: type: "object" required: - "id" - "title" - "pageID" - "note" - "startTime" - "endTime" properties: id: type: "integer" title: type: "string" pageID: type: "integer" note: type: "string" components: type: "array" items: type: "integer" startTime: type: "string" format: "date-time" endTime: type: "string" format: "date-time" V4.StatusPages.NewStatusPageComponent: type: "object" required: - "type" - "name" - "allowSubscription" properties: type: type: "string" enum: - "component" - "group" name: type: "string" allowSubscription: type: "boolean" description: type: "string" serviceID: type: "string" V4.StatusPages.NewStatusPageComponentList: type: "object" required: - "type" - "name" properties: type: type: "string" enum: - "component" - "group" name: type: "string" allowSubscription: type: "boolean" description: type: "string" components: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.NewStatusPageComponent" V4.StatusPages.NewStatusPageThemeColor: type: "object" properties: primary: type: "string" secondary: type: "string" V4.StatusPages.StatusPage: type: "object" required: - "id" - "name" - "isPublic" - "domainName" - "customDomainName" - "timezone" - "logoUrl" - "components" - "isCustomDomainEnabled" - "isCustomARecordVerified" - "isCustomTxtVerified" - "txtRecord" - "aRecord" - "subscribersCount" - "status" - "underMaintenance" - "statusMaintenance" - "ownerType" - "ownerID" properties: id: type: "integer" name: type: "string" isPublic: type: "boolean" domainName: type: "string" customDomainName: type: "string" timezone: type: "string" logoUrl: type: "string" components: type: "array" items: type: "object" properties: id: type: "integer" name: type: "string" required: - "id" - "name" isCustomDomainEnabled: type: "boolean" isCustomARecordVerified: type: "boolean" isCustomTxtVerified: type: "boolean" txtRecord: type: "string" aRecord: type: "string" subscribersCount: type: "integer" status: type: "object" properties: id: type: "integer" name: type: "string" color: type: "string" slug: type: "string" required: - "id" - "name" - "color" - "slug" underMaintenance: type: "boolean" statusMaintenance: type: "object" properties: id: type: "integer" name: type: "string" color: type: "string" slug: type: "string" required: - "id" - "name" - "color" - "slug" ownerType: type: "string" ownerID: type: "string" V4.StatusPages.StatusPageResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.StatusPages.StatusPage" V4.StatusPages.StatusPageStatus: type: "object" required: - "id" - "name" - "status" - "description" - "color" properties: id: type: "integer" name: type: "string" status: type: "string" description: type: "string" color: type: "string" V4.StatusPages.StatusPageStatusesResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.StatusPages.StatusPageStatus" V4.StatusPages.StatusPageSubscriber: type: "object" required: - "id" - "type" - "emailID" - "webhookURL" - "status" - "subscribedOn" properties: id: type: "integer" type: type: "string" emailID: type: "string" webhookURL: type: "string" status: type: "string" componentList: type: "array" items: $ref: "#/components/schemas/V4.StatusPages.StatusPageSubscriberComponent" subscribedOn: type: "string" format: "date-time" V4.StatusPages.StatusPageSubscriberComponent: type: "object" required: - "id" - "name" properties: id: type: "integer" name: type: "string" V4.StatusPages.StatusPageSubscriberResponse: type: "object" allOf: - $ref: "#/components/schemas/V4.StatusPages.StatusPageSubscriber" V4.StatusPages.TotalSubscribersCount: type: "object" required: - "totalCount" properties: totalCount: type: "integer" V4.StatusPages.UpdateStatusPageByIdRequest: type: "object" required: - "name" - "isPublic" - "domainName" - "teamID" - "themeColor" - "contactEmail" - "ownerType" - "ownerID" properties: name: type: "string" description: type: "string" isPublic: type: "boolean" domainName: type: "string" customDomainName: type: "string" logoUrl: type: "string" timezone: type: "string" teamID: type: "string" themeColor: type: "object" properties: primary: type: "string" secondary: type: "string" required: - "primary" - "secondary" allowComponentsSubscription: type: "boolean" allowMaintenanceSubscription: type: "boolean" allowWebhookSubscription: type: "boolean" components: type: "array" items: type: "object" properties: type: type: "string" name: type: "string" allowSubscription: type: "boolean" description: type: "string" components: type: "array" items: type: "object" properties: type: type: "string" name: type: "string" allowSubscription: type: "boolean" description: type: "string" serviceID: type: "string" contactEmail: type: "string" isCustomDomainEnabled: type: "boolean" hideFromSearchEngines: type: "boolean" ownerType: type: "string" ownerID: type: "string" V4.StatusPages.UpdateStatusPageByIdResponse: type: "object" required: - "id" - "name" - "isPublic" - "timezone" - "domainName" - "customDomainName" - "contactEmail" - "themeColor" - "allowComponentsSubscription" - "allowMaintenanceSubscription" - "allowWebhookSubscription" - "hideFromSearchEngines" - "ownerType" - "ownerID" - "teamID" properties: id: type: "integer" organizationID: type: "string" name: type: "string" isPublic: type: "boolean" timezone: type: "string" description: type: "string" domainName: type: "string" customDomainName: type: "string" contactEmail: type: "string" themeColor: type: "object" properties: primary: type: "string" secondary: type: "string" required: - "primary" - "secondary" allowComponentsSubscription: type: "boolean" allowMaintenanceSubscription: type: "boolean" allowWebhookSubscription: type: "boolean" hideFromSearchEngines: type: "boolean" ownerType: type: "string" ownerID: type: "string" teamID: type: "string" V4.Tag: type: "object" required: - "key" - "value" - "color" properties: key: type: "string" value: type: "string" color: type: "string" V4.UpdateRotationParticipantsRequest: type: "object" required: - "participantGroups" properties: participantGroups: type: "array" items: $ref: "#/components/schemas/V4.ParticipantGroup" V4.UpdateRotationRequest: type: "object" required: - "name" - "startDate" - "period" - "changeParticipantsFrequency" - "changeParticipantsUnit" properties: name: type: "string" color: type: "string" startDate: type: "string" period: type: "string" customPeriodFrequency: type: "integer" customPeriodUnit: type: "string" shiftTimeSlots: type: "array" items: $ref: "#/components/schemas/V4.ShiftTimeSlot" changeParticipantsFrequency: type: "integer" changeParticipantsUnit: type: "string" endDate: type: "string" endsAfterIterations: type: "integer" V4.UpdateScheduleOverrideRequest: type: "object" required: - "startTime" - "endTime" - "reason" - "overriddenParticipant" - "overrideWith" properties: startTime: type: "string" endTime: type: "string" reason: type: "string" overriddenParticipant: $ref: "#/components/schemas/V4.OverrideParticipantGroup" overrideWith: $ref: "#/components/schemas/V4.OverrideParticipantGroup" V4.UpdateScheduleRequest: type: "object" required: - "name" - "description" - "ownerID" - "ownerType" - "tags" properties: name: type: "string" description: type: "string" ownerID: type: "string" ownerType: type: "string" enum: - "user" - "squad" tags: type: "array" items: $ref: "#/components/schemas/V4.Tag" securitySchemes: BearerAuth: type: "http" scheme: "bearer" servers: - url: "https://api.eu.squadcast.com" description: "production EU env" variables: {} - url: "https://api.squadcast.com" description: "production US env" variables: {}