seatsio

package module
v9.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 22, 2024 License: MIT Imports: 10 Imported by: 0

README

seatsio-go, the official Seats.io Go SDK

Build Go Report Card License GitHub release (with filter) Go Reference

This is the official Go client library for the Seats.io V2 REST API.

Installing

require (
    github.com/seatsio/seatsio-go/v9 v9.1.0
)

Usage

General instructions

To use this library, you'll need to create a SeatsioClient:

import (
    "github.com/seatsio/seatsio-go/v9"
)

client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)

You can find your workspace secret key in the settings section of the workspace. It is important that you keep your secret key private and not expose it in-browser calls unless it is password protected.

The region should correspond to the region of your account:

  • seatsio.EU: Europe
  • seatsio.NA: North-America
  • seatsio.SA: South-America
  • seatsio.OC: Oceania

If you're unsure about your region, have a look at your company settings page.

Creating a chart and an event
import (
    "fmt"
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/charts"
    "github.com/seatsio/seatsio-go/v9/events"
)

func CreateChartAndEvent() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    chart, _ := client.Charts.Create(&charts.CreateChartParams{Name: "aChart"})
    event, _ := client.Events.Create(&events.CreateEventParams{ChartKey: chart.Key})
    fmt.Printf(`Created a chart with key %s and an event with key: %s`, chart.Key, event.Key)
}
Creating multiple events
import (
    "fmt"
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/charts"
    "github.com/seatsio/seatsio-go/v9/events"
)

func CreateMultipleEvents() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    chart, _ := client.Charts.Create(&charts.CreateChartParams{Name: "aChart"})
	result, err := client.Events.CreateMultiple(chartKey,
		events.CreateMultipleEventParams{EventParams: &events.EventParams{EventKey: "event1", Date: "2023-10-18"}},
		events.CreateMultipleEventParams{EventParams: &events.EventParams{EventKey: "event2", Date: "2023-10-20"}},
	)
    for _, event := range result.Events {
        fmt.Printf(`Created an event with key: %s`, event.Key)
    }
}
Booking objects

Booking an object changes its status to booked. Booked seats are not selectable on a rendered chart.

https://docs.seats.io/docs/api-book-objects.

import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/events"
)

func BookObject() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    result, _ := client.Events.Book(<AN EVENT KEY>, "A-1", "A-2")
}
Booking objects that are on HOLD
import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/events"
)

func BookHeldObject() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    result, _ := client.Events.BookWithHoldToken(<AN EVENT KEY>, []string{"A-1", "A-2"}, <A HOLD TOKEN>)
}
Booking general admission (GA) areas

Either

import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/events"
)

func BookGA() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    result, _ := client.Events.Book(<AN EVENT KEY>, "GA1", "GA1", "GA1")
}

Or:

import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/events"
)

func BookGA() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    result, _ := client.Events.BookWithObjectProperties(event.Key, events.ObjectProperties{ObjectId: "GA1", Quantity: 3})
}
Releasing objects

Releasing objects changes its status to free. Free seats are selectable on a rendered chart.

https://docs.seats.io/docs/api-release-objects.

import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/events"
)

func ReleaseObjects() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    result, _ := client.Events.Release(event.Key, "A-1", "A-2")
}
Changing object status

Changes the object status to a custom status of your choice. If you need more statuses than just booked and free, you can use this to change the status of a seat, table or booth to your own custom status.

https://docs.seats.io/docs/api-custom-object-status

import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/events"
)

func ChangeObjectStatus() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    objects, err := client.Events.ChangeObjectStatus(&events.StatusChangeParams{
        Events: []string{event.Key},
        StatusChanges: events.StatusChanges{
            Status:  "unavailable",
            Objects: []events.ObjectProperties{{ObjectId: "A-1"}, {ObjectId: "A-2"}},
        },
    })
}
Listing status changes

StatusChanges() function returns an events.Lister. You can use StatusChanges().All() to iterate over all status changes.

import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/events"
)

func ListStatusChanges() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    statusChanges, err := client.Events.StatusChanges(event.Key, "", "objectLabel", "desc").All(shared.Pagination.PageSize(2))
    for index, change := range statusChanges {
        //Do something with the status change
    }
}

You can alternatively use the paginated functions to retrieve status changes. To list status changes that comes after or before a given status change, you can use StatusChanges().ListPageAfter() and StatusChanges().ListPageBefore() functions.

import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/events"
)

func ListStatusChanges() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    client.Events.StatusChanges(<AN EVENT KEY>).ListFirstPage(<OPTIONAL parameters>)
    client.Events.statusChanges(<AN EVENT KEY>).ListPageAfter(<A STATUS CHANGE ID>)
    client.Events.statusChanges(<AN EVENT KEY>).ListPageBefore(<A STATUS CHANGE ID>)
}

You can also pass an optional parameter to filter, sort or order status changes. For this parameter, you can you use the helper functions of events.EventSupport.

import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/events"
)

func ListStatusChanges() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    support := events.EventSupport
    client.Events.StatusChanges(<AN EVENT KEY>, support.WithFilter("A"), support.WithSortAsc("objectLabel", "asc")).ListFirstPage(<OPTIONAL parameters>)
    client.Events.statusChanges(<AN EVENT KEY>, support.WithFilter("A"), support.WithSortDesc("objectLabel", "asc")).ListPageAfter(<A STATUS CHANGE ID>)
    client.Events.statusChanges(<AN EVENT KEY>, support.WithFilter("A"), support.WithSortAsc("objectLabel", "asc")).ListPageBefore(<A STATUS CHANGE ID>)
}

A combination of filter, sorting order and sorting option is also possible.

Retrieving object category and status (and other information)
import (
    "fmt"
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/events"
)

func RetrieveObjectInformation() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    info, _ := client.Events.RetrieveObjectInfo(<AN EVENT KEY>, "A-1", "A-2")

    fmt.Println(info["A-1"].CategoryKey)
    fmt.Println(info["A-1"].Label)
    fmt.Println(info["A-1"].Status)

    fmt.Println(info["A-2"].CategoryKey)
    fmt.Println(info["A-2"].Label)
    fmt.Println(info["A-2"].Status)
}
Event reports

Want to know which seats of an event are booked, and which ones are free? That’s where reporting comes in handy.

The report types you can choose from are:

  • status
  • category label
  • category key
  • label
  • order ID

https://docs.seats.io/docs/api-event-reports

import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/reports"
)

func GetSummary() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    report, _ := client.EventReports.SummaryByStatus(<AN EVENT KEY>)
}

func GetDeepReport() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    report, _ := client.EventReports.DeepSummaryByStatus(<AN EVENT KEY>)
}
Listing all charts

You can list all charts using ListAll() function which returns an array of charts.

import (
	"fmt"
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/charts"
)

func GetAllCharts() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    retrievedCharts, _ := client.Charts.ListAll()
	
	fmt.Println(retrievedCharts[0].Key)
	fmt.Println(retrievedCharts[1].Key)
	fmt.Println(retrievedCharts[2].Key)
}
Listing charts page by page

E.g. to show charts in a paginated list on a dashboard.

Each page contains an Items array of Chart instances, and NextPageStartsAfter and PreviousPageEndsBefore properties. Those properties are the chart IDs after which the next page starts or the previous page ends.

// ... user initially opens the screen ...

import (
	"fmt"
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/charts"
)

func GetFirstPage() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    chartsPage, _ := client.Charts.ListFirstPage()

    for _, chart := range chartsPage.Items {
        fmt.Println(chart.Key)
    }
}

// ... user clicks on 'next page' button ...

import (
	"fmt"
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/charts"
)

func GetNextPage() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    chartsPage, err := client.Charts.List().ListPageAfter(<NextPageStartsAfter>)

    for _, chart := range chartsPage.Items {
        fmt.Println(chart.Key)
    }
}

// ... user clicks on 'previous page' button ...

import (
	"fmt"
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/charts"
)

func GetPreviousPage() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    chartsPage, err := client.Charts.List().ListPageAfter(<PreviousPageEndsBefore>)

    for _, chart := range chartsPage.Items {
        fmt.Println(chart.Key)
    }
}
Creating a workspace
import (
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/workspaces"
)

func CreateWorkspace() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)
    workspace, _ := client.Workspaces.CreateProductionWorkspace("a workspace")
}
Creating a chart and an event with the company admin key
import (
	"fmt"
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/charts"
    "github.com/seatsio/seatsio-go/v9/events"
)

func UsingTheCompanyAdminKey() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <COMPANY ADMIN KEY>, seatsio.ClientSupport.WorkspaceKey(<WORKSPACE PUBLIC KEY>))
    chart, _ := client.Charts.Create(&charts.CreateChartParams{Name: "aChart"})
    event, _ := client.Events.Create(&events.CreateEventParams{ChartKey: chart.Key})
    fmt.Printf(`Created a chart with key %s and an event with key: %s`, chart.Key, event.Key)
}
Listing categories
import (
    "fmt"
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/charts"
    "github.com/seatsio/seatsio-go/v9/events"
)

func RetrieveAndListCategories() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <COMPANY ADMIN KEY>, seatsio.ClientSupport.WorkspaceKey(<WORKSPACE PUBLIC KEY>))
    categories, err := client.Charts.ListCategories(<CHART KEY>)
    for _, category := range categories {
        fmt.Println(category.Label)
    }
}
Updating a category
import (
    "fmt"
    "github.com/seatsio/seatsio-go/v9"
    "github.com/seatsio/seatsio-go/v9/charts"
    "github.com/seatsio/seatsio-go/v9/events"
)

func UpdateCategory() {
    client := seatsio.NewSeatsioClient(seatsio.EU, <COMPANY ADMIN KEY>, seatsio.ClientSupport.WorkspaceKey(<WORKSPACE PUBLIC KEY>))
    err = client.Charts.UpdateCategory(<CHART KEY>, <CATEGORY KEY>, charts.UpdateCategoryParams{
        Label:      "New label",
        Color:      "#bbbbbb",
        Accessible: false,
    })
}

Error Handling

When an API call results in an error, the error returned by the function is not nil and contains the following format of information:

{
  "errors": [{ "code": "RATE_LIMIT_EXCEEDED", "message": "Rate limit exceeded" }],
  "messages": ["Rate limit exceeded"],
  "requestId": "123456",
  "status": 429
}

Rate limiting - exponential backoff

This library supports exponential backoff.

When you send too many concurrent requests, the server returns an error 429 - Too Many Requests. The client reacts to this by waiting for a while, and then retrying the request. If the request still fails with an error 429, it waits a little longer, and try again. By default, this happens 5 times, before giving up (after approximately 15 seconds).

To change the maximum number of retries, create the SeatsioClient as follows:

import (
    "github.com/seatsio/seatsio-go/v9"
)

client := seatsio.NewSeatsioClient(seatsio.EU, <COMPANY ADMIN KEY>, seatsio.ClientSupport.WorkspaceKey(<WORKSPACE PUBLIC KEY>)).SetMaxRetries(3)

Passing in 0 disables exponential backoff completely. In that case, the client will never retry a failed request.

Documentation

Index

Constants

View Source 
const (
	EU string = baseUrlStart + "eu" + baseUrlEnd
	NA string = baseUrlStart + "na" + baseUrlEnd
	SA string = baseUrlStart + "sa" + baseUrlEnd
	OC string = baseUrlStart + "oc" + baseUrlEnd
)

Variables

View Source 
var ClientSupport seatsioClientNS

Functions

This section is empty.

Types

type SeatsioClient 

type SeatsioClient struct {
	Workspaces   *workspaces.Workspaces
	Charts       *charts.Charts
	Events       *events.Events
	HoldTokens   *holdtokens.HoldTokens
	ChartReports *reports.ChartReports
	EventReports *reports.EventReports
	UsageReports *reports.UsageReports
	Channels     *events.Channels
	Seasons      *seasons.Seasons
	EventLog     *eventlog.EventLog
	// contains filtered or unexported fields
}

func NewSeatsioClient 

func NewSeatsioClient(baseUrl string, secretKey string, additionalHeaders ...shared.AdditionalHeader) *SeatsioClient

func (*SeatsioClient) SetMaxRetries 

func (c *SeatsioClient) SetMaxRetries(count int) error

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.