shared

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)

Types

type ConnectionStatusType

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

func (r ConnectionStatusType) IsKnown() bool

type OperationSupport

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

func (r OperationSupport) IsKnown() bool

type OperationSupportMatrix

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

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

type Paging

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

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