shared

package

v0.16.0 Latest Latest Go to latest Published: Apr 1, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Finch-API/finch-api-go

Links

Open Source Insights

Documentation ¶

Index ¶

type ConnectionStatusType
- func (r ConnectionStatusType) IsKnown() bool
type OperationSupport
- func (r OperationSupport) IsKnown() bool
type OperationSupportMatrix
- func (r *OperationSupportMatrix) UnmarshalJSON(data []byte) (err error)
type Paging
- func (r *Paging) UnmarshalJSON(data []byte) (err error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ConnectionStatusType ¶ added in v0.9.0

type ConnectionStatusType string

const (
	ConnectionStatusTypePending             ConnectionStatusType = "pending"
	ConnectionStatusTypeProcessing          ConnectionStatusType = "processing"
	ConnectionStatusTypeConnected           ConnectionStatusType = "connected"
	ConnectionStatusTypeErrorNoAccountSetup ConnectionStatusType = "error_no_account_setup"
	ConnectionStatusTypeErrorPermissions    ConnectionStatusType = "error_permissions"
	ConnectionStatusTypeReauth              ConnectionStatusType = "reauth"
)

func (ConnectionStatusType) IsKnown ¶ added in v0.16.0

func (r ConnectionStatusType) IsKnown() bool

type OperationSupport ¶ added in v0.5.0

type OperationSupport string

- `supported`: This operation is supported by both the provider and Finch

`not_supported_by_finch`: This operation is not supported by Finch but supported by the provider
`not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support
`client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch

const (
	OperationSupportSupported              OperationSupport = "supported"
	OperationSupportNotSupportedByFinch    OperationSupport = "not_supported_by_finch"
	OperationSupportNotSupportedByProvider OperationSupport = "not_supported_by_provider"
	OperationSupportClientAccessOnly       OperationSupport = "client_access_only"
)

func (OperationSupport) IsKnown ¶ added in v0.16.0

func (r OperationSupport) IsKnown() bool

type OperationSupportMatrix ¶ added in v0.5.0

type OperationSupportMatrix struct {
	// - `supported`: This operation is supported by both the provider and Finch
	//
	//   - `not_supported_by_finch`: This operation is not supported by Finch but
	//     supported by the provider
	//
	//   - `not_supported_by_provider`: This operation is not supported by the provider,
	//     so Finch cannot support
	//
	//   - `client_access_only`: This behavior is supported by the provider, but only
	//     available to the client and not to Finch
	Create OperationSupport `json:"create"`
	// - `supported`: This operation is supported by both the provider and Finch
	//
	//   - `not_supported_by_finch`: This operation is not supported by Finch but
	//     supported by the provider
	//
	//   - `not_supported_by_provider`: This operation is not supported by the provider,
	//     so Finch cannot support
	//
	//   - `client_access_only`: This behavior is supported by the provider, but only
	//     available to the client and not to Finch
	Delete OperationSupport `json:"delete"`
	// - `supported`: This operation is supported by both the provider and Finch
	//
	//   - `not_supported_by_finch`: This operation is not supported by Finch but
	//     supported by the provider
	//
	//   - `not_supported_by_provider`: This operation is not supported by the provider,
	//     so Finch cannot support
	//
	//   - `client_access_only`: This behavior is supported by the provider, but only
	//     available to the client and not to Finch
	Read OperationSupport `json:"read"`
	// - `supported`: This operation is supported by both the provider and Finch
	//
	//   - `not_supported_by_finch`: This operation is not supported by Finch but
	//     supported by the provider
	//
	//   - `not_supported_by_provider`: This operation is not supported by the provider,
	//     so Finch cannot support
	//
	//   - `client_access_only`: This behavior is supported by the provider, but only
	//     available to the client and not to Finch
	Update OperationSupport           `json:"update"`
	JSON   operationSupportMatrixJSON `json:"-"`
}

func (*OperationSupportMatrix) UnmarshalJSON ¶ added in v0.5.0

func (r *OperationSupportMatrix) UnmarshalJSON(data []byte) (err error)

type Paging ¶ added in v0.7.0

type Paging struct {
	// The total number of elements for the entire query (not just the given page)
	Count int64 `json:"count"`
	// The current start index of the returned list of elements
	Offset int64      `json:"offset"`
	JSON   pagingJSON `json:"-"`
}

func (*Paging) UnmarshalJSON ¶ added in v0.7.0

func (r *Paging) UnmarshalJSON(data []byte) (err error)

Source Files ¶

View all Source files

shared.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL