sdk

package module
v0.0.7 Latest Latest
Warning

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

 Go to latest Published: Dec 4, 2024 License: MIT Imports: 13 Imported by: 0

README

API.stream SDK for Go

This is a prototype implementation of the API.stream API as a Go-based SDK. API design is based upon the NodeJS SDK we provide.

While we use this SDK internally, we currently don't provide active support and make no guarantees around it's usage.

Documentation

Overview

--------------------------------------------------------------------------------------------- Copyright (c) Infiniscene, Inc. All rights reserved. Licensed under the MIT License. See License.txt in the project root for license information. ---------------------------------------------------------------------------------------------

--------------------------------------------------------------------------------------------- Copyright (c) Infiniscene, Inc. All rights reserved. Licensed under the MIT License. See License.txt in the project root for license information. ---------------------------------------------------------------------------------------------

--------------------------------------------------------------------------------------------- Copyright (c) Infiniscene, Inc. All rights reserved. Licensed under the MIT License. See License.txt in the project root for license information. ---------------------------------------------------------------------------------------------

--------------------------------------------------------------------------------------------- Copyright (c) Infiniscene, Inc. All rights reserved. Licensed under the MIT License. See License.txt in the project root for license information. ---------------------------------------------------------------------------------------------

--------------------------------------------------------------------------------------------- Copyright (c) Infiniscene, Inc. All rights reserved. Licensed under the MIT License. See License.txt in the project root for license information. ---------------------------------------------------------------------------------------------

Index

Constants

This section is empty.

Variables

View Source 
var LiveAPIServers = map[Environment]string{
	"local": "localhost:8090",
	"stage": "live.silly.horse:443",
	"prod":  "live.api.stream:443",
}

Functions

This section is empty.

Types

type APIStreamClient 

type APIStreamClient struct {
	// contains filtered or unexported fields
}

func NewAPIStreamClient 

func NewAPIStreamClient(config APIStreamConfig) *APIStreamClient

NewAPIStreamClient returns a new instance of the API.stream client

func (*APIStreamClient) GetEventAPI 

func (client *APIStreamClient) GetEventAPI() *APIStreamEventAPI

func (*APIStreamClient) GetLayoutAPI 

func (client *APIStreamClient) GetLayoutAPI() *APIStreamLayoutAPI

func (*APIStreamClient) GetLiveAPI 

func (client *APIStreamClient) GetLiveAPI() *APIStreamLiveAPI

func (*APIStreamClient) Load 

func (client *APIStreamClient) Load(token string)

type APIStreamConfig 

type APIStreamConfig struct {
	// The API key to use, only required if completing actions requiring API Key access.
	APIKey      string
	AccessToken string

	// The environment to uss, defaults to prod
	Env Environment

	OverrideEndpoint APIStreamConfigOverrides

	// A list of feature overrides to enable within the target api.
	FeatureOverrides []string

	// Optional: An interceptor to apply for unary grpc requests. This can be used to enable tracing.
	UnaryInterceptor grpc.UnaryClientInterceptor
	// contains filtered or unexported fields
}

type APIStreamConfigOverrides 

type APIStreamConfigOverrides struct {
	LiveAPIServer string
}

type APIStreamEventAPI 

type APIStreamEventAPI struct {
	// contains filtered or unexported fields
}

func (*APIStreamEventAPI) GetEventService 

func (eventApi *APIStreamEventAPI) GetEventService() (eventv2.EventServiceClient, error)

GetEventService returns an instance of the event service. This requires an access token for authentication.

func (*APIStreamEventAPI) GetHistoryService added in v0.0.2 

func (eventApi *APIStreamEventAPI) GetHistoryService() (eventv2.HistoryServiceClient, error)

GetHistoryService returns an instance of the event history service. This requires an apikey for authentication.

func (*APIStreamEventAPI) GetWebhookService added in v0.0.2 

func (eventApi *APIStreamEventAPI) GetWebhookService() (eventv2.WebhookServiceClient, error)

GetWebhookService returns an instance of the webhook service. This requires an apikey for authentication.

type APIStreamLayoutAPI 

type APIStreamLayoutAPI struct {
	// contains filtered or unexported fields
}

func (*APIStreamLayoutAPI) GetLayerService 

func (layoutApi *APIStreamLayoutAPI) GetLayerService() (layoutv2.LayerServiceClient, error)

GetLayerService returns an instance of the layer service. This requires an access token for authentication.

func (*APIStreamLayoutAPI) GetLayoutService 

func (layoutApi *APIStreamLayoutAPI) GetLayoutService() (layoutv2.LayoutServiceClient, error)

GetLayoutService returns an instance of the layout service. This requires an access token for authentication.

type APIStreamLiveAPI 

type APIStreamLiveAPI struct {
	// contains filtered or unexported fields
}

func (*APIStreamLiveAPI) GetAccountConfigurationService 

func (liveApi *APIStreamLiveAPI) GetAccountConfigurationService() (livev21.AccountConfigurationServiceClient, error)

GetAccountConfigurationService returns an instance of the account configuration service. This requires API Key authentication

func (*APIStreamLiveAPI) GetAccountService added in v0.0.2 

func (liveApi *APIStreamLiveAPI) GetAccountService() (livev21.AccountServiceClient, error)

GetAccountService returns an instance of account service. This requires API Key authentication

func (*APIStreamLiveAPI) GetAuthenticationService 

func (liveApi *APIStreamLiveAPI) GetAuthenticationService() (livev21.AuthenticationServiceClient, error)

GetAuthenticationService returns an instance of the authentication service. This requires an access token for authentication.

func (*APIStreamLiveAPI) GetBackendAuthenticationService 

func (liveApi *APIStreamLiveAPI) GetBackendAuthenticationService() (livev21.BackendAuthenticationServiceClient, error)

GetBackendAuthenticationService returns an instance of the backend authentication service. This requires API Key authentication

func (*APIStreamLiveAPI) GetCollectionService 

func (liveApi *APIStreamLiveAPI) GetCollectionService() (livev21.CollectionServiceClient, error)

GetCollectionService returns an instance of the collection service. This requires an access token for authentication.

func (*APIStreamLiveAPI) GetDestinationService 

func (liveApi *APIStreamLiveAPI) GetDestinationService() (livev21.DestinationServiceClient, error)

GetDestinationService returns an instance of the destination service. This requires an access token for authentication.

func (*APIStreamLiveAPI) GetProjectService 

func (liveApi *APIStreamLiveAPI) GetProjectService() (livev21.ProjectServiceClient, error)

GetProjectService returns an instance of the project service. This requires an access token for authentication.

func (*APIStreamLiveAPI) GetPublicAuthenticationService 

func (liveApi *APIStreamLiveAPI) GetPublicAuthenticationService() (livev21.PublicAuthenticationServiceClient, error)

GetPublicAuthenticationService returns an instance of the public authentication service. This requires API Key authentication

func (*APIStreamLiveAPI) GetSourceService 

func (liveApi *APIStreamLiveAPI) GetSourceService() (livev21.SourceServiceClient, error)

GetSourceService returns an instance of the source service. This requires an access token for authentication.

type Environment 

type Environment string
const (
	EnvStage Environment = "stage"
	EnvProd  Environment = "prod"
	EnvDev   Environment = "dev"
)

Source Files

View all Source files

Directories

Path Synopsis
proto
apis/event/v2
apis/layout/v2
common/v21
live/v21

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.