zoom

Documentation

Index

• Constants
• Variables
• type Connector
  • func NewConnector(opts ...Option) (conn *Connector, outErr error)
  • func (c *Connector) Close() error
  • func (c *Connector) HTTPClient() *common.HTTPClient
  • func (c *Connector) JSONHTTPClient() *common.JSONHTTPClient
  • func (c *Connector) ListObjectMetadata(ctx context.Context, objectNames []string) (*common.ListObjectMetadataResult, error)
  • func (c *Connector) Provider() providers.Provider
  • func (c *Connector) Read(ctx context.Context, config common.ReadParams) (*common.ReadResult, error)
  • func (c *Connector) String() string
  • func (c *Connector) Write(ctx context.Context, config common.WriteParams) (*common.WriteResult, error)
• type Option
  • func WithAuthenticatedClient(client common.AuthenticatedHTTPClient) Option
  • func WithClient(ctx context.Context, client *http.Client, config *oauth2.Config, ...) Option
  • func WithModule(module common.ModuleID) Option

Constants

const (
	ModuleUser common.ModuleID = "user"

	ModuleMeeting common.ModuleID = "meeting"
)

const (
	DefaultPageSize = 300
)

Variables

var (
	ObjectNameContactGroup = "contacts_groups" // nolint: gochecknoglobals
	ObjectNameUser         = "users"           // nolint: gochecknoglobals
	ObjectNameGroup        = "groups"          // nolint: gochecknoglobals

)

var ObjectNameToResponseField = common.ModuleObjectNameToFieldName{

	ModuleMeeting: datautils.NewDefaultMap(map[string]string{
		"device_groups":     "groups",
		"archive_files":     "meetings",
		"meeting_summaries": "summaries",
		"billing_report":    "billing_reports",
		"activities_report": "activity_logs",
	},
		func(objectName string) (fieldName string) {
			return objectName
		},
	),
	ModuleUser: datautils.NewDefaultMap(map[string]string{
		"contacts_groups": "groups",
	},
		func(objectName string) (fieldName string) {
			return objectName
		},
	),
}

ObjectNameToResponseField maps ObjectName to the response field name which contains that object.

var SupportedModules = metadata.Schemas.ModuleRegistry() // nolint: gochecknoglobals

Types

type Connector

type Connector struct {
	BaseURL string
	Client  *common.JSONHTTPClient
	Module  common.Module
}

func NewConnector

func NewConnector(opts ...Option) (conn *Connector, outErr error)

func (*Connector) Close

func (c *Connector) Close() error

func (*Connector) HTTPClient

func (c *Connector) HTTPClient() *common.HTTPClient

func (*Connector) JSONHTTPClient

func (c *Connector) JSONHTTPClient() *common.JSONHTTPClient

JSONHTTPClient returns the underlying JSON HTTP client.

func (*Connector) ListObjectMetadata

func (c *Connector) ListObjectMetadata(
	ctx context.Context, objectNames []string,
) (*common.ListObjectMetadataResult, error)

func (*Connector) Provider

func (c *Connector) Provider() providers.Provider

func (*Connector) Read

func (c *Connector) Read(ctx context.Context, config common.ReadParams) (*common.ReadResult, error)

func (*Connector) String

func (c *Connector) String() string

func (*Connector) Write

func (c *Connector) Write(ctx context.Context, config common.WriteParams) (*common.WriteResult, error)

type Option

type Option = func(params *parameters)

func WithAuthenticatedClient

func WithAuthenticatedClient(client common.AuthenticatedHTTPClient) Option

func WithClient

func WithClient(ctx context.Context, client *http.Client,
	config *oauth2.Config, token *oauth2.Token, opts ...common.OAuthOption,
) Option

func WithModule

func WithModule(module common.ModuleID) Option