sheets

Documentation

Index

• type Client
  • func NewClient(opts ...option.RequestOption) *Client
  • func (c *Client) Delete(ctx context.Context, sheetId flatfilego.SheetId, opts ...option.RequestOption) (*flatfilego.Success, error)
  • func (c *Client) Get(ctx context.Context, sheetId flatfilego.SheetId, opts ...option.RequestOption) (*flatfilego.SheetResponse, error)
  • func (c *Client) GetCellValues(ctx context.Context, sheetId flatfilego.SheetId, ...) (*flatfilego.CellsResponse, error)
  • func (c *Client) GetRecordCounts(ctx context.Context, sheetId flatfilego.SheetId, ...) (*flatfilego.RecordCountsResponse, error)
  • func (c *Client) GetRecordsAsCsv(ctx context.Context, sheetId flatfilego.SheetId, ...) (io.Reader, error)
  • func (c *Client) GetSheetCommits(ctx context.Context, sheetId flatfilego.SheetId, ...) (*flatfilego.ListCommitsResponse, error)
  • func (c *Client) List(ctx context.Context, request *flatfilego.ListSheetsRequest, ...) (*flatfilego.ListSheetsResponse, error)
  • func (c *Client) LockSheet(ctx context.Context, sheetId flatfilego.SheetId, opts ...option.RequestOption) (*flatfilego.Success, error)
  • func (c *Client) UnlockSheet(ctx context.Context, sheetId flatfilego.SheetId, opts ...option.RequestOption) (*flatfilego.Success, error)
  • func (c *Client) UpdateSheet(ctx context.Context, sheetId flatfilego.SheetId, ...) (*flatfilego.SheetResponse, error)
  • func (c *Client) Validate(ctx context.Context, sheetId flatfilego.SheetId, opts ...option.RequestOption) (*flatfilego.Success, error)

Types

type Client

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

func NewClient

func NewClient(opts ...option.RequestOption) *Client

func (*Client) Delete

func (c *Client) Delete(
	ctx context.Context,

	sheetId flatfilego.SheetId,
	opts ...option.RequestOption,
) (*flatfilego.Success, error)

Deletes a specific sheet from a workbook

func (*Client) Get

func (c *Client) Get(
	ctx context.Context,

	sheetId flatfilego.SheetId,
	opts ...option.RequestOption,
) (*flatfilego.SheetResponse, error)

Returns a sheet in a workbook

func (*Client) GetCellValues

func (c *Client) GetCellValues(
	ctx context.Context,

	sheetId flatfilego.SheetId,
	request *flatfilego.GetFieldValuesRequest,
	opts ...option.RequestOption,
) (*flatfilego.CellsResponse, error)

Returns record cell values grouped by all fields in the sheet

func (*Client) GetRecordCounts

func (c *Client) GetRecordCounts(
	ctx context.Context,

	sheetId flatfilego.SheetId,
	request *flatfilego.GetRecordCountsRequest,
	opts ...option.RequestOption,
) (*flatfilego.RecordCountsResponse, error)

Returns counts of records from a sheet

func (*Client) GetRecordsAsCsv

func (c *Client) GetRecordsAsCsv(
	ctx context.Context,

	sheetId flatfilego.SheetId,
	request *flatfilego.GetRecordsCsvRequest,
	opts ...option.RequestOption,
) (io.Reader, error)

Returns records from a sheet in a workbook as a csv file

func (*Client) GetSheetCommits

func (c *Client) GetSheetCommits(
	ctx context.Context,

	sheetId flatfilego.SheetId,
	request *flatfilego.ListSheetCommitsRequest,
	opts ...option.RequestOption,
) (*flatfilego.ListCommitsResponse, error)

Returns the commit versions for a sheet

func (*Client) List

func (c *Client) List(
	ctx context.Context,
	request *flatfilego.ListSheetsRequest,
	opts ...option.RequestOption,
) (*flatfilego.ListSheetsResponse, error)

Returns sheets in a workbook

func (*Client) LockSheet

func (c *Client) LockSheet(
	ctx context.Context,

	sheetId flatfilego.SheetId,
	opts ...option.RequestOption,
) (*flatfilego.Success, error)

Locks a sheet

func (*Client) UnlockSheet

func (c *Client) UnlockSheet(
	ctx context.Context,

	sheetId flatfilego.SheetId,
	opts ...option.RequestOption,
) (*flatfilego.Success, error)

Removes a lock from a sheet

func (*Client) UpdateSheet

func (c *Client) UpdateSheet(
	ctx context.Context,

	sheetId flatfilego.SheetId,
	request *flatfilego.SheetUpdateRequest,
	opts ...option.RequestOption,
) (*flatfilego.SheetResponse, error)

Updates Sheet

func (*Client) Validate

func (c *Client) Validate(
	ctx context.Context,

	sheetId flatfilego.SheetId,
	opts ...option.RequestOption,
) (*flatfilego.Success, error)

Trigger data hooks and validation to run on a sheet