Schedules

Overview

Available Operations

• 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

List

List Schedules

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/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: "<id>",
    })
    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
            }
        }
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.SchedulesListSchedulesRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.SchedulesListSchedulesResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

Create

Create Schedule

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/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: "<value>",
        Description: "fumigate pfft kooky whoa but lighthearted popularity",
        TeamID: "<id>",
        OwnerID: "<id>",
        OwnerType: components.V4CreateScheduleRequestOwnerTypeUser,
        TimeZone: "Pacific/Easter",
        Tags: []components.V4Tag{
            components.V4Tag{
                Key: "<key>",
                Value: "<value>",
                Color: "pink",
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	components.V4CreateScheduleRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.SchedulesCreateScheduleResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

Delete

Delete Schedule

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/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, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.SchedulesDeleteScheduleResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

GetByID

Get Schedule by ID

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/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, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.SchedulesGetScheduleByIDResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

Update

Update Schedule

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/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, "<id>", components.V4UpdateScheduleRequest{
        Name: "<value>",
        Description: "smoothly festival unruly alert now far provided absentmindedly",
        OwnerID: "<id>",
        OwnerType: components.V4UpdateScheduleRequestOwnerTypeSquad,
        Tags: []components.V4Tag{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
v4UpdateScheduleRequest	components.V4UpdateScheduleRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.SchedulesUpdateScheduleResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

PauseResume

Pause/Resume Schedule

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/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, "<id>", operations.SchedulesPauseresumeScheduleRequestBody{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
requestBody	operations.SchedulesPauseresumeScheduleRequestBody	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.SchedulesPauseresumeScheduleResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

ChangeTimezone

Change Timezone

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/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, "<id>", operations.SchedulesChangeTimezoneRequestBody{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
requestBody	operations.SchedulesChangeTimezoneRequestBody	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.SchedulesChangeTimezoneResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

Clone

Clone Schedule

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/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, "<id>", operations.SchedulesCloneScheduleRequestBody{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
requestBody	operations.SchedulesCloneScheduleRequestBody	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.SchedulesCloneScheduleResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

GetIcalLink

Get Schedule ICal Link

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/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, "<id>", false)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
myOnCall	bool	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ExportGetScheduleIcalLinkResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

RefreshIcalLink

Refresh Schedule ICal Link

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/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, "<id>", true, operations.ExportRefreshScheduleIcalLinkRequestBody{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
myOnCall	bool	✔️	N/A
requestBody	operations.ExportRefreshScheduleIcalLinkRequestBody	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ExportRefreshScheduleIcalLinkResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

CreateIcalLink

Create Schedule ICal Link

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/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, "<id>", true, operations.ExportCreateScheduleIcalLinkRequestBody{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
myOnCall	bool	✔️	N/A
requestBody	operations.ExportCreateScheduleIcalLinkRequestBody	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ExportCreateScheduleIcalLinkResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

CreateScheduleOverride

Create Schedule Override

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/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, "<id>", components.V4CreateScheduleOverrideRequest{
        StartTime: "<value>",
        EndTime: "<value>",
        Reason: "<value>",
        OverriddenParticipant: components.V4OverrideParticipantGroup{
            Group: []components.V4Participant{
                components.V4Participant{
                    ID: "<id>",
                    Type: "<value>",
                },
            },
        },
        OverrideWith: components.V4OverrideParticipantGroup{
            Group: []components.V4Participant{
                components.V4Participant{
                    ID: "<id>",
                    Type: "<value>",
                },
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
v4CreateScheduleOverrideRequest	components.V4CreateScheduleOverrideRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.OverridesCreateScheduleOverrideResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

DeleteRotation

Delete Rotation

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/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, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
scheduleID	string	✔️	N/A
rotationID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.RotationsDeleteRotationResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*