providers

type AccessTokenOpts struct {
	// AttachmentType How the access token should be attached to requests.
	AttachmentType AccessTokenOptsAttachmentType `json:"attachmentType" validate:"required"`

	// DocsURL URL with more information about how access token is used.
	DocsURL string `json:"docsURL,omitempty"`

	// Header Configuration for access token in header. Must be provided if type is in-header.
	Header *AccessTokenOptsHeader `json:"header,omitempty"`
}

type AccessTokenOptsAttachmentType string

type AccessTokenOptsHeader struct {
	// Name The name of the header to be used for the access token.
	Name string `json:"name"`

	// ValuePrefix The prefix to be added to the access token value when it is sent in the header.
	ValuePrefix string `json:"valuePrefix,omitempty"`
}

type ApiKeyAsBasicOpts struct {
	// FieldUsed whether the API key should be used as the username or password.
	FieldUsed ApiKeyAsBasicOptsFieldUsed `json:"fieldUsed,omitempty"`

	// KeyFormat How to transform the API key in to a basic auth user:pass string. The %s is replaced with the API key value.
	KeyFormat string `json:"keyFormat,omitempty"`
}

type ApiKeyAsBasicOptsFieldUsed string

type ApiKeyOpts struct {
	// AttachmentType How the API key should be attached to requests.
	AttachmentType ApiKeyOptsAttachmentType `json:"attachmentType" validate:"required"`

	// DocsURL URL with more information about how to get or use an API key.
	DocsURL string `json:"docsURL,omitempty"`

	// Header Configuration for API key in header. Must be provided if type is in-header.
	Header *ApiKeyOptsHeader `json:"header,omitempty"`

	// Query Configuration for API key in query parameter. Must be provided if type is in-query.
	Query *ApiKeyOptsQuery `json:"query,omitempty"`
}

type ApiKeyOptsAttachmentType string

type ApiKeyOptsHeader struct {
	// Name The name of the header to be used for the API key.
	Name string `json:"name"`

	// ValuePrefix The prefix to be added to the API key value when it is sent in the header.
	ValuePrefix string `json:"valuePrefix,omitempty"`
}

type ApiKeyOptsQuery struct {
	// Name The name of the query parameter to be used for the API key.
	Name string `json:"name"`
}

type ApiKeyParams struct {
	Key           string
	HeaderOptions []common.HeaderAuthClientOption
	QueryOptions  []common.QueryParamAuthClientOption
}

type AuthHealthCheck struct {
	// Method The HTTP method to use for the health check. If not set, defaults to GET.
	Method string `json:"method,omitempty"`

	// SuccessStatusCodes The HTTP status codes that indicate a successful health check. If not set, defaults to 200 and 204.
	SuccessStatusCodes []int `json:"successStatusCodes,omitempty"`

	// Url a no-op URL to check the health of the credentials. The URL MUST not mutate any state. If the provider doesn't have such an endpoint, then don't provide credentialsHealthCheck.
	Url string `json:"url"`
}

type AuthType string

type BasicAuthOpts struct {
	// ApiKeyAsBasic If true, the provider uses an API key which then gets encoded as a basic auth user:pass string.
	ApiKeyAsBasic bool `json:"apiKeyAsBasic,omitempty"`

	// ApiKeyAsBasicOpts when this object is present, it means that this provider uses Basic Auth to actually collect an API key
	ApiKeyAsBasicOpts *ApiKeyAsBasicOpts `json:"apiKeyAsBasicOpts,omitempty"`

	// DocsURL URL with more information about how to get or use an API key.
	DocsURL string `json:"docsURL,omitempty"`
}

type BasicParams struct {
	User    string
	Pass    string
	Options []common.HeaderAuthClientOption
}

type BatchWriteSupport struct {
	Create BatchWriteSupportConfig `json:"create"`
	Delete BatchWriteSupportConfig `json:"delete"`
	Update BatchWriteSupportConfig `json:"update"`
	Upsert BatchWriteSupportConfig `json:"upsert"`
}

type BatchWriteSupportConfig struct {
	// DefaultRecordLimit The default number of records supported in a batch
	DefaultRecordLimit *int `json:"defaultRecordLimit,omitempty"`

	// ObjectRecordLimits Defines object-level overrides for batch record limits. Keys represent object names, and values specify the maximum number of records per batch for those objects.
	ObjectRecordLimits *map[string]int `json:"objectRecordLimits,omitempty"`

	// Supported Whether this type of batch write operation is supported
	Supported bool `json:"supported"`
}

type BulkWriteSupport struct {
	Delete bool `json:"delete"`
	Insert bool `json:"insert"`
	Update bool `json:"update"`
	Upsert bool `json:"upsert"`
}

type CatalogOption func(params *catalogParams)

type CatalogType map[string]ProviderInfo

type CatalogWrapper struct {
	Catalog CatalogType `json:"catalog"`

	// Timestamp An RFC3339 formatted timestamp of when the catalog was generated.
	Timestamp string `json:"timestamp" validate:"required"`
}

type CustomAuthHeader struct {
	// Name The name of the header.
	Name string `json:"name"`

	// ValueTemplate The value of the header, represented as a Golang text/template expression. Only the backend will interpret this.
	ValueTemplate string `json:"valueTemplate" skipSubstitutions:"true"`
}

type CustomAuthInput struct {
	// DisplayName The human-readable name for the custom auth input field.
	DisplayName string `json:"displayName"`

	// DocsURL URL with details about this authentication mechanism and how to use it. Might be specific to this field, or a general URL for the provider. Optional.
	DocsURL string `json:"docsURL,omitempty"`

	// Name The internal identifier for the custom auth input field.
	Name string `json:"name"`

	// Prompt Some helpful text or context to be displayed to the user when asking for this input.
	Prompt string `json:"prompt,omitempty"`
}

type CustomAuthOpts struct {
	// Headers A list of custom headers to be used for authentication. The backend will add these headers.
	Headers []CustomAuthHeader `json:"headers,omitempty"`

	// Inputs A list of custom input fields for authentication. The frontend will render these input fields and the backend will receive the values of these fields before making a request.
	Inputs []CustomAuthInput `json:"inputs,omitempty"`

	// QueryParams A list of custom query parameters to be used for authentication. The backend will add these query parameters.
	QueryParams []CustomAuthQueryParam `json:"queryParams,omitempty"`
}

type CustomAuthParams struct {
	Values  map[string]string
	Options []common.CustomAuthClientOption
}

type CustomAuthQueryParam struct {
	// Name The name of the query parameter.
	Name string `json:"name"`

	// ValueTemplate The value of the query parameter, represented as a Golang text/template expression. Only the backend will interpret this.
	ValueTemplate string `json:"valueTemplate" skipSubstitutions:"true"`
}

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

type IsUnauthorizedDecider func(rsp *http.Response) (bool, error)

type Labels map[string]string

type Media struct {
	// DarkMode Media to be used in dark mode.
	DarkMode *MediaTypeDarkMode `json:"darkMode,omitempty"`

	// Regular Media for light/regular mode.
	Regular *MediaTypeRegular `json:"regular,omitempty"`
}

type MediaTypeDarkMode struct {
	// IconURL URL to the icon for the provider that is to be used in dark mode.
	IconURL string `json:"iconURL,omitempty"`

	// LogoURL URL to the logo for the provider that is to be used in dark mode.
	LogoURL string `json:"logoURL,omitempty"`
}

type MediaTypeRegular struct {
	// IconURL URL to the icon for the provider.
	IconURL string `json:"iconURL,omitempty"`

	// LogoURL URL to the logo for the provider.
	LogoURL string `json:"logoURL,omitempty"`
}

type MetadataItemInput struct {
	// DefaultValue Default value for this metadata item
	DefaultValue string `json:"defaultValue,omitempty"`

	// DisplayName The human-readable name for the field
	DisplayName string `json:"displayName,omitempty"`

	// DocsURL URL with more information about how to locate this value
	DocsURL string `json:"docsURL,omitempty"`

	// ModuleDependencies Does this metadata item only apply to a specific module?
	ModuleDependencies *ModuleDependencies `json:"moduleDependencies,omitempty"`

	// Name The internal identifier for the metadata field
	Name string `json:"name"`

	// Prompt Human-readable description that can contain instructions on how to collect metadata
	Prompt string `json:"prompt,omitempty"`
}

type MetadataItemPostAuthentication struct {
	// ModuleDependencies Does this metadata item only apply to a specific module?
	ModuleDependencies *ModuleDependencies `json:"moduleDependencies,omitempty"`

	// Name The internal identifier for the metadata field
	Name string `json:"name"`
}

type ModuleDependencies map[string]ModuleDependency

type ModuleDependency = map[string]interface{}

type ModuleInfo struct {
	BaseURL     string `json:"baseURL"`
	DisplayName string `json:"displayName"`

	// Support The supported features for the provider.
	Support Support `json:"support" validate:"required"`
}

type Modules map[string]ModuleInfo

type NewClientParams struct {
	// Debug will enable debug mode for the client.
	Debug bool

	// Client is the http client to use for the client. If
	// the value is nil, the default http client will be used.
	Client *http.Client

	// OnUnauthorized is the handler to call when the client receives an
	// unauthorized response.
	OnUnauthorized UnauthorizedHandler

	// IsUnauthorized is the function to call to determine if the response is unauthorized.
	// If not set, it will default to the dumb logic of checking for 401 status codes.
	IsUnauthorized IsUnauthorizedDecider

	// BasicCreds is the basic auth credentials to use for the client.
	// If the provider uses basic auth, this field must be set.
	BasicCreds *BasicParams

	// OAuth2ClientCreds is the client credentials to use for the client.
	// If the provider uses client credentials, this field must be set.
	OAuth2ClientCreds *OAuth2ClientCredentialsParams

	// OAuth2AuthCodeCreds is the auth code credentials to use for the client.
	// If the provider uses auth code, this field must be set.
	OAuth2AuthCodeCreds *OAuth2AuthCodeParams

	// ApiKeyCreds is the api key to use for the client. If the provider uses
	// api-key auth, this field must be set.
	ApiKeyCreds *ApiKeyParams

	// CustomCreds is the custom auth credentials to use for the client. If the provider uses
	// custom auth, this field must be set.
	CustomCreds *CustomAuthParams
}

type OAuth2AuthCodeParams struct {
	Config  *oauth2.Config
	Token   *oauth2.Token
	Options []common.OAuthOption
}

type OAuth2ClientCredentialsParams struct {
	Config  *clientcredentials.Config
	Options []common.OAuthOption
}

type Oauth2Opts struct {
	// AccessTokenOpts Configuration that defines how an OAuth 2.0 access token is attached to
	// outbound API requests. When provided, this configuration overrides the
	// default access-token handling behavior for the connector.
	AccessTokenOpts *AccessTokenOpts `json:"accessTokenOpts,omitempty"`

	// Audience A list of URLs that represent the audience for the token, which is needed for some client credential grant flows.
	Audience []string `json:"audience,omitempty"`

	// AuthURL The authorization URL.
	AuthURL       string            `json:"authURL,omitempty"`
	AuthURLParams map[string]string `json:"authURLParams,omitempty"`

	// DocsURL URL with more information about where to retrieve Client ID and Client Secret, etc.
	DocsURL string `json:"docsURL,omitempty"`

	// ExplicitScopesRequired Whether scopes are required to be known ahead of the OAuth flow.
	ExplicitScopesRequired bool `json:"explicitScopesRequired"`

	// ExplicitWorkspaceRequired Whether the workspace is required to be known ahead of the OAuth flow.
	ExplicitWorkspaceRequired bool                `json:"explicitWorkspaceRequired"`
	GrantType                 Oauth2OptsGrantType `json:"grantType"`

	// ScopeMappings Maps input scopes to their full OAuth scope values with template variable support. Scopes not in this map are passed through unchanged. Needed for some providers.
	ScopeMappings map[string]string `json:"scopeMappings,omitempty"`

	// TokenMetadataFields Fields to be used to extract token metadata from the token response.
	TokenMetadataFields TokenMetadataFields `json:"tokenMetadataFields"`

	// TokenURL The token URL.
	TokenURL string `json:"tokenURL" validate:"required"`
}

type Oauth2OptsGrantType string

type Provider = string

type ProviderInfo struct {
	// ApiKeyOpts Configuration for API key. Must be provided if authType is apiKey.
	ApiKeyOpts *ApiKeyOpts `json:"apiKeyOpts,omitempty"`

	// AuthHealthCheck A URL to check the health of a provider's credentials. It's used to see if the credentials are valid and if the provider is reachable.
	AuthHealthCheck *AuthHealthCheck `json:"authHealthCheck,omitempty"`

	// AuthType The type of authentication required by the provider.
	AuthType AuthType `json:"authType" validate:"required"`

	// BaseURL The base URL for making API requests.
	BaseURL string `json:"baseURL" validate:"required"`

	// BasicOpts Configuration for Basic Auth. Optional.
	BasicOpts *BasicAuthOpts `json:"basicOpts,omitempty"`

	// CustomOpts Configuration for custom auth. Optional.
	CustomOpts    *CustomAuthOpts `json:"customOpts,omitempty"`
	DefaultModule string          `json:"defaultModule"`

	// DisplayName The display name of the provider, if omitted, defaults to provider name.
	DisplayName string  `json:"displayName,omitempty"`
	Labels      *Labels `json:"labels,omitempty"`
	Media       *Media  `json:"media,omitempty"`

	// Metadata Provider metadata that needs to be given by the user or fetched by the connector post authentication for the connector to work.
	Metadata *ProviderMetadata `json:"metadata,omitempty"`

	// Modules The registry of provider modules.
	Modules *Modules `json:"modules,omitempty"`
	Name    string   `json:"name"`

	// Oauth2Opts Configuration for OAuth2.0. Must be provided if authType is oauth2.
	Oauth2Opts *Oauth2Opts `json:"oauth2Opts,omitempty"`

	// PostAuthInfoNeeded If true, we require additional information after auth to start making requests.
	PostAuthInfoNeeded bool `json:"postAuthInfoNeeded,omitempty"`

	// ProviderOpts Additional provider-specific metadata.
	ProviderOpts  ProviderOpts   `json:"providerOpts"`
	SubscribeOpts *SubscribeOpts `json:"subscribeOpts,omitempty"`

	// Support The supported features for the provider.
	Support Support `json:"support" validate:"required"`
}

type ProviderMetadata struct {
	// Input Metadata provided as manual input
	Input []MetadataItemInput `json:"input,omitempty"`

	// PostAuthentication Metadata fetched by the connector post authentication
	PostAuthentication []MetadataItemPostAuthentication `json:"postAuthentication,omitempty"`
}

type ProviderOpts map[string]string

type SubscribeOpts struct {
	// RegistrationTiming The timing of the registration.
	RegistrationTiming SubscribeOptsRegistrationTiming `json:"registrationTiming"`

	// SubscriptionScope The scope of the subscription.
	SubscriptionScope SubscribeOptsSubscriptionScope `json:"subscriptionScope"`

	// TargetURLScope The scope of the target URL.
	TargetURLScope interface{} `json:"targetURLScope"`
}

type SubscribeOptsRegistrationTiming string

type SubscribeOptsSubscriptionScope string

type SubscribeSupport struct {
	Create      *bool `json:"create,omitempty"`
	Delete      *bool `json:"delete,omitempty"`
	PassThrough *bool `json:"passThrough,omitempty"`
	Update      *bool `json:"update,omitempty"`
}

type Support struct {
	BatchWrite       *BatchWriteSupport `json:"batchWrite,omitempty"`
	BulkWrite        BulkWriteSupport   `json:"bulkWrite" validate:"required"`
	Proxy            bool               `json:"proxy"`
	Read             bool               `json:"read"`
	Subscribe        bool               `json:"subscribe"`
	SubscribeSupport *SubscribeSupport  `json:"subscribeSupport,omitempty"`
	Write            bool               `json:"write"`
}

type TokenMetadataFields struct {
	ConsumerRefField string `json:"consumerRefField,omitempty"`

	// OtherFields Additional fields to extract and transform from the token response
	OtherFields       *TokenMetadataFieldsOtherFields `json:"otherFields,omitempty"`
	ScopesField       string                          `json:"scopesField,omitempty"`
	WorkspaceRefField string                          `json:"workspaceRefField,omitempty"`
}

type TokenMetadataFieldsOtherFields = []struct {
	// Capture A regex expression to capture the value that we need from the path. There must be only one capture group named 'result' in the expression. If not provided, will cause an error.
	Capture string `json:"capture,omitempty"`

	// DisplayName The human-readable name of the field
	DisplayName string `json:"displayName"`

	// Name The internal name of the field
	Name string `json:"name"`

	// Path The path to the field in the token response (accepts dot notation for nested fields)
	Path string `json:"path"`
}

type UnauthorizedEvent struct {
	Provider    *ProviderInfo
	Headers     []common.Header     // Only certain providers will set this, depending on the auth type
	QueryParams []common.QueryParam // Only certain providers will set this, depending on the auth type
	OAuthToken  *oauth2.Token       // Only certain providers will set this, depending on the auth type
	Request     *http.Request
	Response    *http.Response
}

type UnauthorizedHandler func(client common.AuthenticatedHTTPClient, event *UnauthorizedEvent) (*http.Response, error)