Documentation ¶
Index ¶
- Variables
- type AuthMetadataConnector
- type Connector
- type DeleteConnector
- type DeleteParams
- type DeleteResult
- type ErrorWithStatus
- type ListObjectMetadataResult
- type ObjectMetadataConnector
- type ReadConnector
- type ReadParams
- type ReadResult
- type URLConnector
- type WebhookVerifierConnector
- type WriteConnector
- type WriteParams
- type WriteResult
Constants ¶
This section is empty.
Variables ¶
var Fields = datautils.NewStringSet // nolint:gochecknoglobals
Functions ¶
This section is empty.
Types ¶
type AuthMetadataConnector ¶
type AuthMetadataConnector interface { Connector // GetPostAuthInfo returns authentication metadata. GetPostAuthInfo(ctx context.Context) (*common.PostAuthInfo, error) }
AuthMetadataConnector is an interface that extends the Connector interface with the ability to retrieve metadata information about authentication.
type Connector ¶
type Connector interface { fmt.Stringer // JSONHTTPClient returns the underlying JSON HTTP client. This is useful for // testing, or for calling methods that aren't exposed by the Connector // interface directly. Authentication and token refreshes will be handled automatically. JSONHTTPClient() *common.JSONHTTPClient // HTTPClient returns the underlying HTTP client. This is useful for proxy requests. HTTPClient() *common.HTTPClient // Provider returns the connector provider. Provider() providers.Provider }
Connector is an interface that can be used to implement a connector with basic configuration about the provider.
type DeleteConnector ¶
type DeleteConnector interface { Connector Delete(ctx context.Context, params DeleteParams) (*DeleteResult, error) }
DeleteConnector is an interface that extends the Connector interface with delete capabilities.
type DeleteParams ¶
type DeleteParams = common.DeleteParams
We re-export the following types so that they can be used by consumers of this library.
type DeleteResult ¶
type DeleteResult = common.DeleteResult
We re-export the following types so that they can be used by consumers of this library.
type ErrorWithStatus ¶
type ErrorWithStatus = common.HTTPStatusError //nolint:errname
We re-export the following types so that they can be used by consumers of this library.
type ListObjectMetadataResult ¶
type ListObjectMetadataResult = common.ListObjectMetadataResult
We re-export the following types so that they can be used by consumers of this library.
type ObjectMetadataConnector ¶
type ObjectMetadataConnector interface { Connector ListObjectMetadata(ctx context.Context, objectNames []string) (*ListObjectMetadataResult, error) }
ObjectMetadataConnector is an interface that extends the Connector interface with the ability to list object metadata.
type ReadConnector ¶
type ReadConnector interface { Connector // Read reads a page of data from the connector. This can be called multiple // times to read all the data. The caller is responsible for paging, by // passing the NextPage value correctly, and by terminating the loop when // Done is true. The caller is also responsible for handling errors. // Authentication corner cases are handled internally, but all other errors // are returned to the caller. Read(ctx context.Context, params ReadParams) (*ReadResult, error) }
ReadConnector is an interface that extends the Connector interface with read capabilities.
type ReadParams ¶
type ReadParams = common.ReadParams
We re-export the following types so that they can be used by consumers of this library.
type ReadResult ¶
type ReadResult = common.ReadResult
We re-export the following types so that they can be used by consumers of this library.
type URLConnector ¶
type URLConnector interface { Connector // GetURL returns the URL of some resource. The resource is provider-specific. // The URL is returned as a string, or an error is returned if the URL cannot be // retrieved. The precise meaning of the resource is provider-specific, and the // caller should consult the provider's documentation for more information. // The args parameter is a map of key-value pairs that can be used to customize // the URL. The keys and values are provider-specific, and the caller should // consult the provider's documentation for more information. Certain providers // may ignore the args parameter entirely if it's unnecessary. GetURL(resource string, args map[string]any) (string, error) }
URLConnector is an interface that extends the Connector interface with the ability to retrieve URLs for resources.
type WriteConnector ¶
type WriteConnector interface { Connector Write(ctx context.Context, params WriteParams) (*WriteResult, error) }
WriteConnector is an interface that extends the Connector interface with write capabilities.
type WriteParams ¶
type WriteParams = common.WriteParams
We re-export the following types so that they can be used by consumers of this library.
type WriteResult ¶
type WriteResult = common.WriteResult
We re-export the following types so that they can be used by consumers of this library.
Directories ¶
Path | Synopsis |
---|---|
interpreter
nolint:ireturn
|
nolint:ireturn |
paramsbuilder
Package paramsbuilder provides common parameters used to initialize connectors.
|
Package paramsbuilder provides common parameters used to initialize connectors. |
scanning
nolint: ireturn
|
nolint: ireturn |
scanning/credscanning
Package credscanning is a wrapper for scanning package.
|
Package credscanning is a wrapper for scanning package. |
nolint
|
nolint |
examples
|
|
internal
|
|
nolint:lll
|
nolint:lll |
attio
nolint
|
nolint |
kit
nolint
|
nolint |
salesforce
Package salesforce This file has bulk related functionality that is internal to this package.
|
Package salesforce This file has bulk related functionality that is internal to this package. |
scripts
|
|
oauth
nolint
|
nolint |
openapi/intercom/metadata
OpenAPI documentation can be found under this official github repository.
|
OpenAPI documentation can be found under this official github repository. |
proxy
nolint
|
nolint |
test
|
|
utils/testroutines
Package testroutines holds a collection of common test procedures.
|
Package testroutines holds a collection of common test procedures. |
tools
|
|