README

squadcastsdk

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

Speakeasy Logo BUILT BY SPEAKEASY LICENSE // MIT

Summary

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

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

Service Regions

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

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

Authentication

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

Steps to procure the access_token:

1. Generate a refresh_token (API Token) from the Squadcast web app. More details on how to get the refresh_token can be found in the Squadcast support documentation.

2. Call the authentication API with the refresh_token to obtain an access_token.

3. Use the access_token as a Bearer token in the Authorization header for all subsequent API requests.

Example — Generating an Access Token

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

The API response will look similar to:

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

Access Control

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

Authorization

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

Table of Contents

• squadcastsdk

  • SDK Installation

  • SDK Example Usage

  • Authentication

  • Available Resources and Operations

  • Pagination

  • Retries

  • Error Handling

  • Server Selection

  • Custom HTTP Client

  • Special Types

• Development

  • Maturity

  • Contributions

SDK Installation

To add the SDK as a dependency to your project:

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

SDK Example Usage

Example

package main

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

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

	s := squadcastsdk.New()

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

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
BearerAuth	http	HTTP Bearer	SQUADCASTSDK_BEARER_AUTH

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

package main

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

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

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

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

Available Resources and Operations

Available methods

Analytics

• GetOrganization - Get Org level analytics

• GetTeam - Get Team level analytics

ApiTokens

• List - Get All Tokens

AuditLogs

• List - List all Audit Logs

• Export - Initiate an asynchronous export of audit logs based on the provided filters. The export file will be generated and available for download. Use 'Get details of Audit Logs export history by ID' API to retrieve the download URL.

• ListExportHistory - List all Audit Logs export history

• GetExportHistoryByID - Get details of Audit Logs export history by ID

• GetByID - Get audit log by ID

Auth

• AuthGetAccessToken - Get Access Token

CommunicationCards

• CreateSlackChannel - Create Slack Channel in Communication Card

• ArchiveSlackChannel - Archive Slack Channel

EscalationPolicies

• GetByTeam - Get Escalation Policy By team

• Create - Create Escalation Policies

• Remove - Remove Escalation Policy

• GetByID - Get Escalation Policy By ID

• Update - Update Escalation Policy

Exports

• GetDetails - Get Export Details

Extensions.Msteams

• UpsertConfig - Create Or Update MSTeams Configuration

Extensions.Webhooks

• Delete - Delete Webhook

• GetByID - Get Webhook By ID

GlobalEventRules

• List - List Global Event Rules

• Create - Create Global Event Rule

• DeleteRule - Delete Global Event Rule by ID

• GetByID - Get Global Event Rule by ID

• UpdateByID - Update Global Event Rule by ID

• GetRuleset - Get Ruleset

• UpdateRuleset - Update Ruleset

• UpdateRule - Update Rule by ID

GlobalEventRules.Rules

• ReorderByIndex - Reorder Ruleset By Index

GlobalEventRules.Rulesets

• Create - Create Ruleset

• Reorder - Reorder Ruleset

• ListRulesetRules - List Ruleset Rules

GlobalEventRules.Rulesets.Rules

• Create - Create Rule

• GetByID - Get Rule by ID

GlobalEventRulesRulesets

• Delete - Delete GER Ruleset

GlobalEventRulesRulesetsRules

• DeleteByID - Delete Rule by ID

GlobalOncallReminderRules

• Delete - Delete Global Oncall Reminder Rules

• List - Get Global Oncall Reminder Rules

• Create - Create Global Oncall Reminder Rules

• Update - Update Global Oncall Reminder Rules

IncidentActions.Circleci

• Rebuild - Rebuild a Project In CircleCI

Incidents

• BulkAcknowledge - Bulk Acknowledge Incidents

• Export - Incident Export

• ExportAsync - Incident Export Async

• BulkUpdatePriority - Bulk Incidents Priority Update

• BulkResolve - Bulk Resolve Incidents

• GetByID - Get Incident by ID

• Acknowledge - Acknowledge Incident

• MarkSloFalsePositive - Mark Incident SLO False Positive

• UpdatePriority - Incident Priority Update

• Reassign - Reassign Incident

• Resolve - Resolve Incident

• GetStatusByRequestIds - Get Incidents Status By RequestIDs

• GetAllPostmortems - Get All Postmortems

• MarkAsTransient - Mark as Transient

• UpdatePostmortem - Update Postmortem By Incident

• UnsnoozeNotifications - Unsnooze Incident Notifications

Incidents.Actions

• CreateJiraCloudTicket - Create a Ticket on Jira Cloud

• CreateJiraServerTicket - Create a Ticket on Jira Server

• CreateInServicenow - Create an Incident in ServiceNow

Incidents.Actions.Webhook

• TriggerManually - Trigger a Webhook Manually

Incidents.AdditionalResponders

• Get - Get Additional Responders

• Add - Add Additional Responders

• Delete - Remove Additional Responders

Incidents.AutoPauseTransientAlerts

• MarkAsNotTransient - Mark as Not Transient

Incidents.CommunicationCard

• Update - Update Communication Card

Incidents.CommunicationCards

• GetAll - Get All Communication Card

• Create - Create Communication Card

• Delete - Delete Communication Card

Incidents.Events

• List - Get Incident Events

Incidents.Notes

• Create - Create Notes

• Delete - Delete Note

• Update - Update Note

Incidents.Postmortems

• DeleteByIncident - Delete Postmortem By Incident

• GetByIncident - Get Postmortem By Incident

• Create - Create Postmortem

Incidents.Runbooks

• Attach - Attach Runbooks

Incidents.SnoozeNotifications

• Snooze - Snooze Incident Notifications

Incidents.Tags

• Update - Update Tag

• Append - Append Tag

Msteams

• GetConfig - Get MSTeams Config

Notes

• List - Get All Notes

Overlays

• DeleteNotificationTemplate - Delete Notification Template Overlay

Overrides

• GetByID - Get Override by ID

• Update - Update Schedule Override

Rotations

• Create - Create Rotation

• GetByID - Get Schedule Rotation by ID

• Update - Update Rotation

• GetParticipants - Get Rotation Participants

• UpdateParticipants - Update Rotation Participants

Runbooks

• ListByTeam - Get All Runbooks By Team

• Create - Create Runbook

• Remove - Remove Runbook

• GetByID - Get Runbook By ID

• Update - Update Runbook

Schedules

• List - List Schedules

• Create - Create Schedule

• Delete - Delete Schedule

• GetByID - Get Schedule by ID

• Update - Update Schedule

• PauseResume - Pause/Resume Schedule

• ChangeTimezone - Change Timezone

• Clone - Clone Schedule

• GetIcalLink - Get Schedule ICal Link

• RefreshIcalLink - Refresh Schedule ICal Link

• CreateIcalLink - Create Schedule ICal Link

• CreateScheduleOverride - Create Schedule Override

• DeleteRotation - Delete Rotation

Schedules.Export

• DeleteIcalLink - Delete ICal Link

Schedules.Overrides

• List - List Overrides

• Delete - Delete Schedule Override

Schedules.Rotations

• List - List Schedule Rotations

Services

• List - Get All Services

• Create - Create Service

• GetByName - Get Services By Name

• GetByID - Get Service By ID

• Update - Update Service

• Delete - Delete Service

• CreateOrUpdateAptaConfig - Auto Pause Transient Alerts (APTA)

• UpsertIagConfig - Intelligent Alert Grouping (IAG)

• UpdateNotificationDelayConfig - Delayed Notification Config

• CreateOrUpdateDependencies - Create or Update Dependencies

• CreateOrUpdateNotificationTemplateOverlay - Create or Update Notification Template Overlay

• GetAllDedupKeyOverlays - Get All Dedup Key Overlay by Service

• UpdateDedupKeyOverlay - Update Dedup Key Overlay

• GetRoutingRules - Get Routing Rules

• CreateOrUpdateSuppressionRules - Create or Update Suppression Rules

• CreateOrUpdateTaggingRules - Create or Update Tagging Rules

Services.DeduplicationRules

• Get - Get Deduplication Rules

• CreateOrUpdate - Create or Update Deduplication Rules

Services.Extensions

• UpdateSlack - Update Slack Extension

Services.MaintenanceMode

• Get - Get Maintenance Mode

• CreateOrUpdate - Create or Update Maintenance Mode

Services.Overlay

• GetKeyBasedDeduplicationOptin - Get Opt-in for Key Based Deduplication for a service

• OptInForKeyBasedDeduplication - Opt-in for Key Based Deduplication for a service

Services.Overlays

• GetCustomContentTemplates - Get All Custom Content Template Overlay by Service

• GetCustomContent - Get Custom Content Template Overlay

• GetDedupKey - Get Dedup Key Overlay for Alert Source

Services.Overlays.CustomContent

• Render - Render Custom Content Overlay

Services.Overlays.DedupKey

• Render - Render Dedup Key template

• Delete - Delete Dedup Key Overlay

Services.RoutingRules

• CreateOrUpdate - Create or Update Routing Rules

Services.SuppressionRules

• Get - Get Suppression Rules

Services.TaggingRules

• Get - Get Tagging Rules

Slos

• ListAll - Get All SLOs

• Create - Create SLO

• Update - Update SLO

• Remove - Remove SLO

• GetByID - Get SLO By ID

• MarkAffected - Mark SLO Affected

• MarkFalsePositive - Mark SLO False Positive

Squads

• List - Get All Squads

• RemoveMember - Remove Squad Member

• UpdateMemberRole - Update Squad Member

• UpdateName - Update Squad Name

• Delete - Delete Squad

Squads.V4

• Create - Create Squad

• GetByID - Get Squad By ID

StatusPages

• List - List Status Pages

• Create - Create Status Page

• DeleteByID - Delete Status Page By ID

• GetByID - Get Status Page By ID

• UpdateByID - Update Status Page By ID

• CreateIssue - Create Issue

• UpdateIssue - Update Issue

• ListMaintenances - List Maintenances

• GetMaintenanceByID - Get Maintenance By ID

• GetStatuses - List Status Page Statuses

StatusPages.ComponentGroups

• List - List Component Groups

• Create - Create Component Group

• DeleteByID - Delete Component Group By ID

• GetByID - Get Component Group By ID

StatusPages.Components

• List - List Components

• Create - Create Component

• DeleteByID - Delete Component By ID

• GetByID - Get Component By ID

• UpdateByID - Update Component By ID

StatusPages.Issues

• List - List Issues

• Delete - Delete Issue By ID

• GetByID - Get Issue By ID

• ListStates - List Status Page Issue States

StatusPages.Maintenances

• Create - Create Maintenance

• DeleteByID - Delete Maintenance By ID

• UpdateByID - Update Maintenance By ID

StatusPages.Subscribers

• List - List Subscribers

Teams

• GetAll - Get All Teams

• Create - Create Team

• GetByID - Get Team By ID

• Update - Update Team

• Delete - Remove Team

• AddMember - Add Team Member

• AddBulkMember - Add Bulk Team Member

• RemoveMember - Remove Team Member

• UpdateMember - Update Team Member

• GetAllRoles - Get All Team Roles

• CreateRole - Create Team Role

• RemoveRole - Remove Team Role

• UpdateRole - Update Team Role

Teams.Members

• GetAll - Get All Team Members

Tokens

• CreateUserToken - Create Token

Users

• GetAll - Get All Users

• Add - Add User

• UpdateOrgLevelPermissions - Update Org Level Permissions

• Delete - Delete User

• GetRoles - Get User Roles

• RemoveFromOrg - Remove User From Org

• GetByID - Get User By ID

• Update - Update User by userID

Users.ApiToken

• Remove - Remove Token

V4.Squads

• Update - Update Squad

Webforms

• GetAll - Get All Webforms

• Create - Create Webform

• Update - Update Webform

• Remove - Remove Webform

• Get - Get Webform By ID

Webhooks

• GetAll - Get All Webhooks

• Create - Create Webhook

• Update - Update Webhook

Workflows

• List - List Workflows

• Create - Create Workflow

• BulkEnableDisable - Bulk Enable/Disable Workflows

• Delete - Delete Workflow

• GetByID - Get Workflow By ID

• Update - Update Workflow

• UpdateActionsOrder - Update Actions Order

• DeleteAction - Delete Workflow Action

• GetAction - Get Workflow Action By ID

• UpdateAction - Update Workflow Action

• ToggleEnable - Enable/Disable Workflow

• GetLogs - Get Workflow Logs

Workflows.Actions

• Create - Create Action

Pagination

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

Here's an example of one such pagination call:

package main

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

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

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

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

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}
	}
}

Retries

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

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

package main

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

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

	s := squadcastsdk.New()

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

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

package main

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

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

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

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

Error Handling

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

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

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

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

Example

package main

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

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

	s := squadcastsdk.New()

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

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

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

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

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

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

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

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

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

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

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

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

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

Server Selection

Select Server by Index

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

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

Example

package main

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

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

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

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

Override Server URL Per-Client

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

package main

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

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

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

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

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

package main

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

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

	s := squadcastsdk.New()

	res, err := s.Auth.AuthGetAccessToken(ctx, "<value>", operations.WithServerURL("https://auth.eu.squadcast.com"))
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Custom HTTP Client

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

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

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

import (
	"net/http"
	"time"

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

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

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

Special Types

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

Date

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

Usage

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

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

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

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

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

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

Development

Maturity

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

Contributions

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

SDK Created by Speakeasy