client

package

Go to main page

Versions in this module

v0

v0.0.18

Nov 10, 2026

v0.0.17

Nov 9, 2026

v0.0.16

Nov 8, 2026

Changes in this version

type EnsureFieldWorkerRequest

+ Phone *string

type FieldWorkerResponse

+ Phone string

type UpdateFieldWorkerRequest

+ Phone *string

v0.0.15

Nov 6, 2026

Changes in this version

+ type FieldLinkedPrincipal struct

+ Email string

+ ID string

+ Name string

type FieldTokenIntrospectResponse

+ LinkedPrincipalID string

type FieldWorkerFilters

+ LinkedPrincipalID string

type FieldWorkerResponse

+ LinkedPrincipal *FieldLinkedPrincipal

type FieldWorkersResource

+ func (r *FieldWorkersResource) Link(ctx context.Context, id, principalID string) (*FieldWorkerResponse, error)

+ func (r *FieldWorkersResource) Unlink(ctx context.Context, id string) (*FieldWorkerResponse, error)

+ type LinkFieldWorkerRequest struct

+ PrincipalID string

v0.0.14

Nov 6, 2026

Changes in this version

+ type BulkIssueFieldBadgesRequest struct

+ WorkerIDs []string

+ type BulkIssueFieldBadgesResponse struct

+ Issued []BulkIssuedFieldBadge

+ type BulkIssuedFieldBadge struct

+ Badge FieldBadgeResponse

+ Name string

+ Token string

+ WorkerCode string

+ WorkerID string

+ type CreateFieldSignInCodeRequest struct

+ AppCode string

type EnsureFieldWorkerRequest

+ CanImpersonate *bool

+ IsTest *bool

+ type FieldBadgeIssuedResponse struct

+ Badge FieldBadgeResponse

+ Token string

+ type FieldBadgeListResponse struct

+ Badges []FieldBadgeResponse

+ type FieldBadgeResponse struct

+ CreatedAt string

+ CreatedBy string

+ ID string

+ Label string

+ LastUsedAt string

+ RevokedAt string

+ Status string

+ WorkerID string

type FieldPolicyResponse

+ BadgeOnlyLogin bool

+ ImpersonationMaxSecs int

+ RequireEnrolledDevice bool

+ UnenrolledIdleSecs int

+ type FieldSignInCodeResponse struct

+ AppCode string

+ Code string

+ ExpiresAt string

+ WorkerID string

+ type FieldTokenActor struct

+ Sub string

+ Typ string

type FieldTokenIntrospectResponse

+ Act *FieldTokenActor

+ Test bool

+ type FieldWorkerBadgeRef struct

+ CreatedAt string

+ ID string

+ LastUsedAt string

+ Status string

type FieldWorkerFilters

+ IsTest *bool

type FieldWorkerResponse

+ Badge *FieldWorkerBadgeRef

+ CanImpersonate bool

+ IsTest bool

type FieldWorkerSignInResponse

+ ActorID string

type FieldWorkersResource

+ func (r *FieldWorkersResource) BulkIssueBadges(ctx context.Context, workerIDs []string) (*BulkIssueFieldBadgesResponse, error)

+ func (r *FieldWorkersResource) CreateSignInCode(ctx context.Context, id, appCode string) (*FieldSignInCodeResponse, error)

+ func (r *FieldWorkersResource) IssueBadge(ctx context.Context, id string, req *IssueFieldBadgeRequest) (*FieldBadgeIssuedResponse, error)

+ func (r *FieldWorkersResource) ListBadges(ctx context.Context, id string) (*FieldBadgeListResponse, error)

+ func (r *FieldWorkersResource) RevokeBadge(ctx context.Context, id, badgeID string) error

+ type IssueFieldBadgeRequest struct

+ Label string

type PutFieldPolicyRequest

+ BadgeOnlyLogin bool

+ ImpersonationMaxSecs *int

+ RequireEnrolledDevice bool

+ UnenrolledIdleSecs *int

type UpdateFieldWorkerRequest

+ CanImpersonate *bool

+ IsTest *bool

v0.0.13

Nov 3, 2026

v0.0.12

Nov 3, 2026

Changes in this version

+ type CreateEnrolmentCodeRequest struct

+ AppCodes []string

+ AssignedWorkerID *string

+ ClientID string

+ Label *string

+ Mode string

+ type EnsureFieldWorkerRequest struct

+ AppCodes []string

+ ClientID string

+ Email *string

+ Name string

+ Pin *string

+ WorkerCode string

+ type FieldAppRef struct

+ Code string

+ ID string

+ Name string

+ type FieldDeviceFilters struct

+ Mode string

+ Page *uint32

+ PageSize *uint32

+ Status string

+ type FieldDeviceListResponse struct

+ Devices []FieldDeviceResponse

+ Page int

+ Size int

+ Total int64

+ type FieldDeviceResponse struct

+ ActiveSessions int

+ Apps []FieldAppRef

+ AssignedWorkerID *string

+ AttestationLevel string

+ ClientID string

+ EnrolledAt string

+ ID string

+ Jkt string

+ Label string

+ LastSeenAt string

+ Mode string

+ Model string

+ Platform string

+ Status string

+ type FieldDevicesResource struct

+ func (r *FieldDevicesResource) Activate(ctx context.Context, id string) error

+ func (r *FieldDevicesResource) CreateEnrolmentCode(ctx context.Context, req *CreateEnrolmentCodeRequest) (*FieldEnrolmentCodeResponse, error)

+ func (r *FieldDevicesResource) Get(ctx context.Context, id string) (*FieldDeviceResponse, error)

+ func (r *FieldDevicesResource) List(ctx context.Context, clientID string, filters *FieldDeviceFilters) (*FieldDeviceListResponse, error)

+ func (r *FieldDevicesResource) Revoke(ctx context.Context, id string) error

+ func (r *FieldDevicesResource) Suspend(ctx context.Context, id string) error

+ type FieldEnrolmentCodeResponse struct

+ Code string

+ ExpiresAt string

+ QrPayload string

+ type FieldPoliciesResource struct

+ func (r *FieldPoliciesResource) Get(ctx context.Context, clientID string) (*FieldPolicyResponse, error)

+ func (r *FieldPoliciesResource) Put(ctx context.Context, clientID string, req *PutFieldPolicyRequest) (*FieldPolicyResponse, error)

+ type FieldPolicyResponse struct

+ ClientID string

+ HardLockThreshold int

+ IsDefault bool

+ PersonalIdleSecs int

+ PinMinLength int

+ PinReauthDays int

+ RequireAttestation bool

+ SharedIdleSecs int

+ ShiftMaxSecs int

+ SoftLockSecs int

+ SoftLockThreshold int

+ UpdatedAt string

+ type FieldTokenIntrospectRequest struct

+ Token string

+ type FieldTokenIntrospectResponse struct

+ Active bool

+ Amr []string

+ AppCode string

+ AuthTime string

+ ClientID string

+ DeviceID string

+ Exp string

+ Sub string

+ WorkerCode string

+ type FieldTokensResource struct

+ func (r *FieldTokensResource) Introspect(ctx context.Context, token string) (*FieldTokenIntrospectResponse, error)

+ type FieldWorkerAppRef struct

+ Code string

+ GrantedAt string

+ ID string

+ Name string

+ Source string

+ type FieldWorkerFilters struct

+ AppCode string

+ Page *uint32

+ PageSize *uint32

+ Q string

+ Status string

+ type FieldWorkerListResponse struct

+ Page int

+ Size int

+ Total int64

+ Workers []FieldWorkerResponse

+ type FieldWorkerResponse struct

+ Apps []FieldWorkerAppRef

+ ClientID string

+ Created *bool

+ CreatedAt string

+ Email string

+ FailedSinceSuccess int

+ HardLocked bool

+ HasPin bool

+ ID string

+ LastLoginAt string

+ Locked bool

+ LockedUntil string

+ Name string

+ PinChangeRequired bool

+ Status string

+ UpdatedAt string

+ WorkerCode string

+ type FieldWorkerSignInListResponse struct

+ Page int

+ SignIns []FieldWorkerSignInResponse

+ Size int

+ Total int64

+ type FieldWorkerSignInResponse struct

+ AppCode string

+ AttemptedAt string

+ AuthMethod string

+ DeviceID string

+ FailureReason string

+ ID string

+ IPAddress string

+ Outcome string

+ type FieldWorkersResource struct

+ func (r *FieldWorkersResource) Activate(ctx context.Context, id string) error

+ func (r *FieldWorkersResource) Delete(ctx context.Context, id string) error

+ func (r *FieldWorkersResource) Ensure(ctx context.Context, req *EnsureFieldWorkerRequest) (*FieldWorkerResponse, error)

+ func (r *FieldWorkersResource) Get(ctx context.Context, id string) (*FieldWorkerResponse, error)

+ func (r *FieldWorkersResource) GrantApp(ctx context.Context, id, appCode string) error

+ func (r *FieldWorkersResource) List(ctx context.Context, clientID string, filters *FieldWorkerFilters) (*FieldWorkerListResponse, error)

+ func (r *FieldWorkersResource) ResetPin(ctx context.Context, id string, req *ResetFieldWorkerPinRequest) (*ResetFieldWorkerPinResponse, error)

+ func (r *FieldWorkersResource) RevokeApp(ctx context.Context, id, appCode string) error

+ func (r *FieldWorkersResource) SignIns(ctx context.Context, id string, page, pageSize *uint32) (*FieldWorkerSignInListResponse, error)

+ func (r *FieldWorkersResource) Suspend(ctx context.Context, id string) error

+ func (r *FieldWorkersResource) Unlock(ctx context.Context, id string) error

+ func (r *FieldWorkersResource) Update(ctx context.Context, id string, req *UpdateFieldWorkerRequest) (*FieldWorkerResponse, error)

type FlowCatalystClient

+ func (c *FlowCatalystClient) FieldDevices() *FieldDevicesResource

+ func (c *FlowCatalystClient) FieldPolicies() *FieldPoliciesResource

+ func (c *FlowCatalystClient) FieldTokens() *FieldTokensResource

+ func (c *FlowCatalystClient) FieldWorkers() *FieldWorkersResource

+ type GrantFieldWorkerAppRequest struct

+ AppCode string

+ type PutFieldPolicyRequest struct

+ HardLockThreshold *int

+ PersonalIdleSecs *int

+ PinMinLength *int

+ PinReauthDays *int

+ RequireAttestation bool

+ SharedIdleSecs *int

+ ShiftMaxSecs *int

+ SoftLockSecs *int

+ SoftLockThreshold *int

+ type ResetFieldWorkerPinRequest struct

+ Pin *string

+ type ResetFieldWorkerPinResponse struct

+ PinChangeRequired bool

+ TemporaryPin *string

+ type UpdateFieldWorkerRequest struct

+ Email *string

+ Name string

v0.0.11

Nov 1, 2026

Changes in this version

+ type HTTPAccept struct

+ Body HTTPAcceptBody

+ ContentTypes []string

+ type HTTPAcceptBody string

+ const AcceptBodyJSON

+ const AcceptBodyJSONObject

+ const AcceptBodyNone

+ const AcceptBodyXML

type HTTPSource

+ Accept *HTTPAccept

type IngestionTarget

+ DataOnly bool

+ Kind IngestionTargetKind

+ WrapNonJSON bool

+ type IngestionTargetKind string

+ const TargetKindDispatchJob

+ const TargetKindEvent

v0.0.10

Oct 30, 2026

v0.0.9

Oct 30, 2026

Changes in this version

+ const OnBehalfOfHeader

+ const SecretMask

+ var ErrInvalidOnBehalfOf = errors.New(...)

+ func EncodeQuery(pairs ...string) string

+ func WithOnBehalfOf(ctx context.Context, who string) context.Context

+ type APIAuth interface

+ type APIBasicAuth struct

+ Password SecretRef

+ Username string

+ func (a APIBasicAuth) MarshalJSON() ([]byte, error)

+ type APIBearerAuth struct

+ Token SecretRef

+ func (a APIBearerAuth) MarshalJSON() ([]byte, error)

+ type APIClientCredentialsAuth struct

+ Audience *string

+ ClientID string

+ ClientSecret SecretRef

+ CredentialsIn string

+ Scope *string

+ TokenURL string

+ func (a APIClientCredentialsAuth) MarshalJSON() ([]byte, error)

+ type APICursor struct

+ From string

+ Initial *string

+ Param string

+ type APIError struct

+ Body string

+ StatusCode int

+ func (e *APIError) Code() string

+ func (e *APIError) Error() string

+ func (e *APIError) IsConflict() bool

+ func (e *APIError) IsForbidden() bool

+ func (e *APIError) IsNotFound() bool

+ func (e *APIError) IsUnauthorized() bool

+ func (e *APIError) Message() string

+ func (e *APIError) Retryable() bool

+ type APIHeader struct

+ Name string

+ Value string

+ type APIHeaderResults struct

+ Equals *string

+ Name string

+ func (r APIHeaderResults) MarshalJSON() ([]byte, error)

+ type APIJSONPathResults struct

+ Path string

+ func (r APIJSONPathResults) MarshalJSON() ([]byte, error)

+ type APIKeyAuth struct

+ Header string

+ Value SecretRef

+ func (a APIKeyAuth) MarshalJSON() ([]byte, error)

+ type APILoginAuth struct

+ ExpiresInPath *string

+ ExtraFields map[string]string

+ Format string

+ Header string

+ Lifetime string

+ Password SecretRef

+ PasswordField string

+ Prefix string

+ TokenPath string

+ URL string

+ Username string

+ UsernameField string

+ func (a APILoginAuth) MarshalJSON() ([]byte, error)

+ type APINoAuth struct

+ func (a APINoAuth) MarshalJSON() ([]byte, error)

+ type APIPollSource struct

+ Auth APIAuth

+ Body *string

+ Cursor *APICursor

+ Every string

+ Headers []APIHeader

+ IdleDelay string

+ Method string

+ Results APIResults

+ URL string

+ func (s *APIPollSource) UnmarshalJSON(data []byte) error

+ func (s APIPollSource) MarshalJSON() ([]byte, error)

+ type APIRecordsResults struct

+ func (r APIRecordsResults) MarshalJSON() ([]byte, error)

+ type APIResults interface

+ type AWSCredential struct

+ AccessKeyID string

+ SecretAccessKey SecretRef

+ type AddNoteRequest struct

+ Category string

+ Text string

+ type AddNoteResponse struct

+ Message string

+ type AddSchemaVersionRequest struct

+ Schema json.RawMessage

+ Version string

+ type ApplicationListResponse struct

+ Applications []ApplicationResponse

+ Total uint64

+ type ApplicationResponse struct

+ Active bool

+ ApplicationType string

+ Code string

+ CreatedAt string

+ DefaultBaseURL string

+ Description string

+ HasLoginClient bool

+ ID string

+ IconURL string

+ Logo string

+ LogoMimeType string

+ Name string

+ ServiceAccountID string

+ UpdatedAt string

+ Website string

+ type ApplicationsResource struct

+ func (r *ApplicationsResource) Activate(ctx context.Context, id string) (*ApplicationResponse, error)

+ func (r *ApplicationsResource) Create(ctx context.Context, req *CreateApplicationRequest) (*CreatedResponse, error)

+ func (r *ApplicationsResource) Deactivate(ctx context.Context, id string) (*ApplicationResponse, error)

+ func (r *ApplicationsResource) Delete(ctx context.Context, id string) error

+ func (r *ApplicationsResource) DisableForClient(ctx context.Context, id, clientID string) error

+ func (r *ApplicationsResource) EnableForClient(ctx context.Context, id, clientID string) error

+ func (r *ApplicationsResource) Get(ctx context.Context, id string) (*ApplicationResponse, error)

+ func (r *ApplicationsResource) GetByCode(ctx context.Context, code string) (*ApplicationResponse, error)

+ func (r *ApplicationsResource) GetClientConfig(ctx context.Context, id, clientID string) (*ClientConfigResponse, error)

+ func (r *ApplicationsResource) LinkServiceAccount(ctx context.Context, id string, req *LinkServiceAccountRequest) error

+ func (r *ApplicationsResource) List(ctx context.Context, appType string, active *bool) (*ApplicationListResponse, error)

+ func (r *ApplicationsResource) ListClients(ctx context.Context, id string) (*ClientConfigsResponse, error)

+ func (r *ApplicationsResource) ListRoles(ctx context.Context, id string) ([]string, error)

+ func (r *ApplicationsResource) ProvisionServiceAccount(ctx context.Context, id string) (*ProvisionServiceAccountResponse, error)

+ func (r *ApplicationsResource) Update(ctx context.Context, id string, req *UpdateApplicationRequest) error

+ type ApplyIngestionSetRequest struct

+ Files []SetFile

+ Items []IngestionSetItem

+ type AssignRoleRequest struct

+ Role string

+ type AuditLogFilters struct

+ After string

+ ApplicationIDs []string

+ ClientIDs []string

+ EntityID string

+ EntityType string

+ Operation string

+ PageSize *uint32

+ PrincipalID string

+ type AuditLogListResponse struct

+ AuditLogs []AuditLogResponse

+ HasMore bool

+ NextCursor string

+ type AuditLogResponse struct

+ ApplicationID string

+ ClientID string

+ EntityID string

+ EntityType string

+ ID string

+ Operation string

+ OperationJSON string

+ PerformedAt string

+ PrincipalID string

+ PrincipalName string

+ type AuditLogsResource struct

+ func (r *AuditLogsResource) Get(ctx context.Context, id string) (*AuditLogResponse, error)

+ func (r *AuditLogsResource) List(ctx context.Context, filters *AuditLogFilters) (*AuditLogListResponse, error)

+ type CSVSplit struct

+ Header bool

+ func (s CSVSplit) MarshalJSON() ([]byte, error)

+ type ClientAccessGrantResponse struct

+ ClientID string

+ ExpiresAt string

+ GrantedAt string

+ ID string

+ type ClientAccessListResponse struct

+ Grants []ClientAccessGrantResponse

+ type ClientApplicationResponse struct

+ Active bool

+ Code string

+ Description string

+ EnabledForClient bool

+ ID string

+ IconURL string

+ Name string

+ type ClientApplicationsResponse struct

+ Applications []ClientApplicationResponse

+ Total uint64

+ type ClientConfigResponse struct

+ ApplicationID string

+ BaseURLOverride string

+ ClientID string

+ ConfigJSON json.RawMessage

+ CreatedAt string

+ Enabled bool

+ ID string

+ UpdatedAt string

+ type ClientConfigsResponse struct

+ ClientConfigs []ClientConfigResponse

+ type ClientListResponse struct

+ Clients []ClientResponse

+ Total uint64

+ type ClientResponse struct

+ CreatedAt string

+ ID string

+ Identifier string

+ Name string

+ Notes []NoteResponse

+ Status string

+ StatusChangedAt string

+ StatusReason string

+ UpdatedAt string

+ type ClientsResource struct

+ func (r *ClientsResource) Activate(ctx context.Context, id string) (*StatusChangeResponse, error)

+ func (r *ClientsResource) AddNote(ctx context.Context, id string, req *AddNoteRequest) (*AddNoteResponse, error)

+ func (r *ClientsResource) Create(ctx context.Context, req *CreateClientRequest) (*CreatedResponse, error)

+ func (r *ClientsResource) Deactivate(ctx context.Context, id string, req *StatusChangeRequest) (*StatusChangeResponse, error)

+ func (r *ClientsResource) Delete(ctx context.Context, id string) error

+ func (r *ClientsResource) DisableApplication(ctx context.Context, clientID, applicationID string) error

+ func (r *ClientsResource) EnableApplication(ctx context.Context, clientID, applicationID string) error

+ func (r *ClientsResource) Get(ctx context.Context, id string) (*ClientResponse, error)

+ func (r *ClientsResource) GetByIdentifier(ctx context.Context, identifier string) (*ClientResponse, error)

+ func (r *ClientsResource) List(ctx context.Context) (*ClientListResponse, error)

+ func (r *ClientsResource) ListApplications(ctx context.Context, clientID string) (*ClientApplicationsResponse, error)

+ func (r *ClientsResource) Search(ctx context.Context, query string) (*ClientListResponse, error)

+ func (r *ClientsResource) Suspend(ctx context.Context, id string, req *StatusChangeRequest) (*StatusChangeResponse, error)

+ func (r *ClientsResource) Update(ctx context.Context, id string, req *UpdateClientRequest) error

+ func (r *ClientsResource) UpdateApplications(ctx context.Context, clientID string, req *UpdateClientApplicationsRequest) error

+ type CompletionStatus string

+ const CompletionStatusFailure

+ const CompletionStatusSuccess

+ type ConfigEntry struct

+ Key string

+ Value string

+ type ConfigResponse struct

+ ApplicationCode string

+ ClientID string

+ ClientIdentifier string

+ CreatedAt string

+ Description string

+ ID string

+ Property string

+ Scope string

+ Section string

+ UpdatedAt string

+ Value string

+ ValueType string

+ type ConnectionResponse struct

+ ApplicationCode string

+ ClientID string

+ ClientIdentifier string

+ Code string

+ CreatedAt string

+ Description string

+ ExternalID string

+ ID string

+ Name string

+ ServiceAccountID string

+ Source string

+ Status string

+ UpdatedAt string

+ type ConnectionsListResponse struct

+ Connections []ConnectionResponse

+ Total uint64

+ type ConnectionsResource struct

+ func (r *ConnectionsResource) Activate(ctx context.Context, id string) (*ConnectionResponse, error)

+ func (r *ConnectionsResource) Create(ctx context.Context, req *CreateConnectionRequest) (*ConnectionResponse, error)

+ func (r *ConnectionsResource) Delete(ctx context.Context, id string) error

+ func (r *ConnectionsResource) Get(ctx context.Context, id string) (*ConnectionResponse, error)

+ func (r *ConnectionsResource) List(ctx context.Context, clientID, status string) (*ConnectionsListResponse, error)

+ func (r *ConnectionsResource) Pause(ctx context.Context, id string) (*ConnectionResponse, error)

+ func (r *ConnectionsResource) Sync(ctx context.Context, appCode string, req *SyncConnectionsRequest, ...) (*SyncResult, error)

+ func (r *ConnectionsResource) Update(ctx context.Context, id string, req *UpdateConnectionRequest) error

+ type CreateApplicationRequest struct

+ ApplicationType string

+ Code string

+ DefaultBaseURL string

+ Description string

+ IconURL string

+ Logo string

+ LogoMimeType string

+ Name string

+ Website string

+ type CreateClientRequest struct

+ Identifier string

+ Name string

+ type CreateConnectionRequest struct

+ ApplicationCode string

+ ClientID string

+ Code string

+ Description string

+ ExternalID string

+ Name string

+ ServiceAccountID string

+ type CreateDispatchPoolRequest struct

+ ClientID string

+ Code string

+ Concurrency uint32

+ Description string

+ Name string

+ RateLimit *uint32

+ type CreateEventTypeRequest struct

+ ClientID string

+ ClientScoped bool

+ Code string

+ Description string

+ Name string

+ Schema json.RawMessage

+ type CreateIngestionRequest struct

+ Application string

+ Client string

+ Code string

+ KeepFailedPayloads bool

+ Live *bool

+ Name string

+ Note string

+ Source IngestionSource

+ Split IngestionSplit

+ Target IngestionTarget

+ type CreateProcessRequest struct

+ Body string

+ Code string

+ Description string

+ DiagramType string

+ Name string

+ Tags []string

+ type CreateRoleRequest struct

+ ApplicationCode string

+ ClientManaged bool

+ Description string

+ DisplayName string

+ Permissions []string

+ RoleName string

+ type CreateScheduledJobRequest struct

+ ApplicationID string

+ ClientID string

+ Code string

+ Concurrent bool

+ Crons []string

+ DeliveryMaxAttempts *int32

+ Description string

+ Name string

+ Payload json.RawMessage

+ TargetURL string

+ TimeoutSeconds *int32

+ Timezone string

+ TracksCompletion bool

+ type CreateSubscriptionRequest struct

+ ClientID string

+ ClientScoped bool

+ Code string

+ ConnectionID string

+ CustomConfig []ConfigEntry

+ DataOnly bool

+ DelaySeconds *uint32

+ Description string

+ DispatchPoolID string

+ Endpoint string

+ EventTypes []EventTypeBinding

+ MaxAgeSeconds *uint32

+ MaxRetries *uint32

+ Mode string

+ Name string

+ Queue string

+ Sequence *int32

+ ServiceAccountID string

+ TimeoutSeconds *uint32

+ type CreateUserRequest struct

+ ClientID string

+ Email string

+ EnforcePasswordComplexity *bool

+ InviteRedirectURI string

+ Name string

+ Password string

+ ReturnInviteLink *bool

+ Scope string

+ SendInvitation *bool

+ type CreatedResponse struct

+ ID string

+ type CustomSource struct

+ Settings map[string]any

+ Type string

+ func (s CustomSource) MarshalJSON() ([]byte, error)

+ type DatabasePollSource struct

+ Every string

+ JDBCURL string

+ MaxRows int

+ Password SecretRef

+ Table string

+ Track DatabaseTrack

+ Username string

+ func (s *DatabasePollSource) UnmarshalJSON(data []byte) error

+ func (s DatabasePollSource) MarshalJSON() ([]byte, error)

+ type DatabaseTrack interface

+ type DispatchPoolListResponse struct

+ Pools []DispatchPoolResponse

+ Total uint64

+ type DispatchPoolResponse struct

+ ClientID string

+ ClientIdentifier string

+ Code string

+ Concurrency uint32

+ CreatedAt string

+ Description string

+ ID string

+ Name string

+ RateLimit *uint32

+ Status string

+ UpdatedAt string

+ type DispatchPoolsResource struct

+ func (r *DispatchPoolsResource) Activate(ctx context.Context, id string) error

+ func (r *DispatchPoolsResource) Archive(ctx context.Context, id string) error

+ func (r *DispatchPoolsResource) Create(ctx context.Context, req *CreateDispatchPoolRequest) (*CreatedResponse, error)

+ func (r *DispatchPoolsResource) Delete(ctx context.Context, id string) error

+ func (r *DispatchPoolsResource) Get(ctx context.Context, id string) (*DispatchPoolResponse, error)

+ func (r *DispatchPoolsResource) List(ctx context.Context, clientID, status string) (*DispatchPoolListResponse, error)

+ func (r *DispatchPoolsResource) Suspend(ctx context.Context, id string) error

+ func (r *DispatchPoolsResource) Sync(ctx context.Context, appCode string, req *SyncDispatchPoolsRequest, ...) (*SyncResult, error)

+ func (r *DispatchPoolsResource) Update(ctx context.Context, id string, req *UpdateDispatchPoolRequest) error

+ type DocsResource struct

+ func (r *DocsResource) Sync(ctx context.Context, appCode string, req *SyncDocsRequest) (*SyncResult, error)

+ type EventTypeBinding struct

+ EventTypeCode string

+ EventTypeID string

+ Filter string

+ SpecVersion string

+ type EventTypeFilters struct

+ Aggregate string

+ Application string

+ ClientID string

+ Status string

+ Subdomain string

+ type EventTypeListResponse struct

+ Items []EventTypeResponse

+ type EventTypeResponse struct

+ Aggregate string

+ Application string

+ ClientID string

+ Code string

+ CreatedAt string

+ CreatedBy string

+ Description string

+ EventName string

+ ID string

+ Name string

+ Source string

+ SpecVersions []SpecVersionResponse

+ Status string

+ Subdomain string

+ UpdatedAt string

+ type EventTypesResource struct

+ func (r *EventTypesResource) AddSchemaVersion(ctx context.Context, id string, req *AddSchemaVersionRequest) (*EventTypeResponse, error)

+ func (r *EventTypesResource) Archive(ctx context.Context, id string) error

+ func (r *EventTypesResource) Create(ctx context.Context, req *CreateEventTypeRequest) (*CreatedResponse, error)

+ func (r *EventTypesResource) Get(ctx context.Context, id string) (*EventTypeResponse, error)

+ func (r *EventTypesResource) GetByCode(ctx context.Context, code string) (*EventTypeResponse, error)

+ func (r *EventTypesResource) List(ctx context.Context, filters *EventTypeFilters) (*EventTypeListResponse, error)

+ func (r *EventTypesResource) Sync(ctx context.Context, appCode string, req *SyncEventTypesRequest, ...) (*SyncResult, error)

+ func (r *EventTypesResource) Update(ctx context.Context, id string, req *UpdateEventTypeRequest) error

+ type FireRequest struct

+ CorrelationID string

+ type FireResponse struct

+ ID string

+ InstanceID string

+ ScheduledJobID string

+ type FlowCatalystClient struct

+ func New(baseURL string, opts ...Option) *FlowCatalystClient

+ func (c *FlowCatalystClient) Applications() *ApplicationsResource

+ func (c *FlowCatalystClient) AuditLogs() *AuditLogsResource

+ func (c *FlowCatalystClient) BaseURL() string

+ func (c *FlowCatalystClient) Clients() *ClientsResource

+ func (c *FlowCatalystClient) Connections() *ConnectionsResource

+ func (c *FlowCatalystClient) Delete(ctx context.Context, path string, out any) error

+ func (c *FlowCatalystClient) DispatchPools() *DispatchPoolsResource

+ func (c *FlowCatalystClient) Docs() *DocsResource

+ func (c *FlowCatalystClient) EventTypes() *EventTypesResource

+ func (c *FlowCatalystClient) Get(ctx context.Context, path string, out any) error

+ func (c *FlowCatalystClient) GetRouter(ctx context.Context, path string, out any) error

+ func (c *FlowCatalystClient) IngestionSets() *IngestionSetsResource

+ func (c *FlowCatalystClient) Ingestions() *IngestionsResource

+ func (c *FlowCatalystClient) Me() *MeResource

+ func (c *FlowCatalystClient) OpenAPI() *OpenAPIResource

+ func (c *FlowCatalystClient) Patch(ctx context.Context, path string, body, out any) error

+ func (c *FlowCatalystClient) Permissions() *PermissionsResource

+ func (c *FlowCatalystClient) PlatformConfig() *PlatformConfigResource

+ func (c *FlowCatalystClient) Post(ctx context.Context, path string, body, out any) error

+ func (c *FlowCatalystClient) Principals() *PrincipalsResource

+ func (c *FlowCatalystClient) Processes() *ProcessesResource

+ func (c *FlowCatalystClient) Put(ctx context.Context, path string, body, out any) error

+ func (c *FlowCatalystClient) Roles() *RolesResource

+ func (c *FlowCatalystClient) Router() *RouterResource

+ func (c *FlowCatalystClient) RouterBaseURL() string

+ func (c *FlowCatalystClient) ScheduledJobs() *ScheduledJobsResource

+ func (c *FlowCatalystClient) ServiceAccounts() *ServiceAccountsResource

+ func (c *FlowCatalystClient) Subscriptions() *SubscriptionsResource

+ type GrantClientAccessRequest struct

+ ClientID string

+ type GrantPermissionRequest struct

+ Permission string

+ type HTTPAuth interface

+ type HTTPBasicAuth struct

+ Password SecretRef

+ Username string

+ func (a HTTPBasicAuth) MarshalJSON() ([]byte, error)

+ type HTTPBearerAuth struct

+ Token SecretRef

+ func (a HTTPBearerAuth) MarshalJSON() ([]byte, error)

+ type HTTPFlowCatalystTokenAuth struct

+ Application string

+ PrincipalID *string

+ func (a HTTPFlowCatalystTokenAuth) MarshalJSON() ([]byte, error)

+ type HTTPSource struct

+ Auth HTTPAuth

+ RateLimit *RateLimit

+ func (s *HTTPSource) UnmarshalJSON(data []byte) error

+ func (s HTTPSource) MarshalJSON() ([]byte, error)

+ type InPipelineBatchRequest struct

+ MessageIDs []string

+ type InPipelineCheckResponse struct

+ Detail *InPipelineDetail

+ InPipeline bool

+ MessageID string

+ type InPipelineDetail struct

+ AddedToInPipelineAt string

+ BrokerMessageID string

+ ElapsedTimeMs uint64

+ MessageID string

+ PoolCode string

+ QueueID string

+ type IngestionConfigStatus struct

+ Key string

+ Problems []IngestionFieldError

+ Status string

+ UpdatedAt string

+ type IngestionDefinition struct

+ KeepFailedPayloads bool

+ Name string

+ Source IngestionSource

+ Split IngestionSplit

+ Target IngestionTarget

+ type IngestionFailureFilters struct

+ After string

+ Category string

+ Limit *uint32

+ Undismissed bool

+ type IngestionFailureListResponse struct

+ Failures []IngestionFailureResponse

+ HasMore bool

+ NextCursor string

+ type IngestionFailureResponse struct

+ AfterRecords int64

+ Category string

+ CreatedAt string

+ DismissedAt string

+ DismissedBy string

+ Excerpt string

+ ID string

+ Kind string

+ Message string

+ OccurredAt string

+ RuntimeID string

+ Version int64

+ type IngestionFieldError struct

+ Code string

+ Field string

+ Message string

+ type IngestionHistoryEntry struct

+ Details json.RawMessage

+ ID string

+ Operation string

+ PerformedAt string

+ PrincipalID string

+ PrincipalName string

+ type IngestionHistoryResponse struct

+ Entries []IngestionHistoryEntry

+ HasMore bool

+ type IngestionListResponse struct

+ HasMore bool

+ Ingestions []IngestionResponse

+ NextCursor string

+ type IngestionResponse struct

+ ApplicationCode string

+ ApplicationID string

+ ClientID string

+ ClientIdentifier string

+ Code string

+ Config *IngestionConfigStatus

+ CreatedAt string

+ ID string

+ KeepFailedPayloads bool

+ LatestNotice string

+ LatestNoticeAt string

+ LatestVersion int64

+ ManagedBy string

+ Name string

+ Notices int64

+ RuntimeNotice string

+ Save *IngestionSaveOutcome

+ Source IngestionSource

+ Split IngestionSplit

+ Status string

+ Target IngestionTarget

+ UpdatedAt string

+ Version int64

+ Warnings []string

+ func (r *IngestionResponse) UnmarshalJSON(data []byte) error

+ type IngestionSaveOutcome struct

+ AwaitingPromote bool

+ Message string

+ Outcome string

+ Version int64

+ type IngestionSecretFetch struct

+ FetchCount int64

+ LastFetchedAt string

+ PrincipalID string

+ RuntimeID string

+ Version int64

+ type IngestionSecretListResponse struct

+ NamesHidden bool

+ Secrets []IngestionSecretResponse

+ type IngestionSecretResponse struct

+ Bound bool

+ Fetches []IngestionSecretFetch

+ Name string

+ type IngestionSetApplyListResponse struct

+ Applies []IngestionSetApplyResponse

+ type IngestionSetApplyResponse struct

+ AppliedAt string

+ AppliedBy string

+ Changes []SetChange

+ Files int64

+ GoingBackTo string

+ ID string

+ Items int64

+ Set string

+ type IngestionSetArchiveResponse struct

+ AppliedAt string

+ AppliedBy string

+ ApplyID string

+ Files []SetFile

+ GoingBackTo string

+ Items []IngestionSetItem

+ Set string

+ type IngestionSetItem struct

+ Active *bool

+ Application string

+ Client string

+ Code string

+ KeepFailedPayloads bool

+ Name string

+ Source IngestionSource

+ Split IngestionSplit

+ Target IngestionTarget

+ func (i *IngestionSetItem) UnmarshalJSON(data []byte) error

+ type IngestionSetListResponse struct

+ Sets []IngestionSetResponse

+ type IngestionSetPlanResponse struct

+ ApplyID string

+ Changes []SetChange

+ DryRun bool

+ Name string

+ type IngestionSetReleaseResponse struct

+ Name string

+ Released int64

+ type IngestionSetResponse struct

+ CreatedAt string

+ ID string

+ Ingestions int64

+ Name string

+ UpdatedAt string

+ type IngestionSetsResource struct

+ func (r *IngestionSetsResource) Apply(ctx context.Context, name string, req *ApplyIngestionSetRequest, dryRun *bool) (*IngestionSetPlanResponse, error)

+ func (r *IngestionSetsResource) GetApply(ctx context.Context, name, applyID string) (*IngestionSetArchiveResponse, error)

+ func (r *IngestionSetsResource) List(ctx context.Context) (*IngestionSetListResponse, error)

+ func (r *IngestionSetsResource) ListApplies(ctx context.Context, name string) (*IngestionSetApplyListResponse, error)

+ func (r *IngestionSetsResource) Reapply(ctx context.Context, name, applyID string, dryRun *bool) (*IngestionSetPlanResponse, error)

+ func (r *IngestionSetsResource) Release(ctx context.Context, name string) (*IngestionSetReleaseResponse, error)

+ type IngestionSource interface

+ func DecodeIngestionSource(data []byte) (IngestionSource, error)

+ type IngestionSourceKindListResponse struct

+ Kinds []IngestionSourceKindResponse

+ type IngestionSourceKindResponse struct

+ BuiltIn bool

+ Description string

+ Kind string

+ RequiredPermission string

+ Settings json.RawMessage

+ SingleOwner bool

+ type IngestionSplit interface

+ func DecodeIngestionSplit(data []byte) (IngestionSplit, error)

+ type IngestionTarget struct

+ BatchSize int64

+ Code string

+ Connection string

+ Mode IngestionTargetMode

+ Pool string

+ ServiceAccount string

+ TargetURL string

+ type IngestionTargetMode string

+ const TargetModeBlockOnError

+ const TargetModeImmediate

+ const TargetModeNextOnError

+ type IngestionTestResponse struct

+ CompletedAt string

+ CreatedAt string

+ Excerpt string

+ ExpiresAt string

+ ID string

+ IngestionID string

+ Kind string

+ Notice string

+ Outcome string

+ Records int64

+ RuntimeID string

+ Status string

+ Steps []string

+ type IngestionVersionListResponse struct

+ Versions []IngestionVersionResponse

+ type IngestionVersionResponse struct

+ AppliedFrom string

+ CreatedAt string

+ CreatedBy string

+ Digest string

+ Draft bool

+ ID string

+ KeepFailedPayloads bool

+ Live bool

+ Name string

+ Note string

+ Save *IngestionSaveOutcome

+ Source IngestionSource

+ Split IngestionSplit

+ Target IngestionTarget

+ Version int64

+ Warnings []string

+ func (r *IngestionVersionResponse) UnmarshalJSON(data []byte) error

+ type IngestionsResource struct

+ func (r *IngestionsResource) Create(ctx context.Context, req *CreateIngestionRequest) (*IngestionResponse, error)

+ func (r *IngestionsResource) Definition(ctx context.Context, id string) (string, error)

+ func (r *IngestionsResource) Delete(ctx context.Context, id string) error

+ func (r *IngestionsResource) DismissFailure(ctx context.Context, id, failureID string) (*IngestionFailureResponse, error)

+ func (r *IngestionsResource) Failures(ctx context.Context, id string, f IngestionFailureFilters) (*IngestionFailureListResponse, error)

+ func (r *IngestionsResource) Get(ctx context.Context, id string) (*IngestionResponse, error)

+ func (r *IngestionsResource) GetTest(ctx context.Context, id string) (*IngestionTestResponse, error)

+ func (r *IngestionsResource) History(ctx context.Context, id string, limit, offset *uint32) (*IngestionHistoryResponse, error)

+ func (r *IngestionsResource) List(ctx context.Context, f *ListIngestionsFilters) (*IngestionListResponse, error)

+ func (r *IngestionsResource) ListVersions(ctx context.Context, id string) (*IngestionVersionListResponse, error)

+ func (r *IngestionsResource) MakeVersionLive(ctx context.Context, id, version string) (*IngestionResponse, error)

+ func (r *IngestionsResource) Pause(ctx context.Context, id string) (*IngestionResponse, error)

+ func (r *IngestionsResource) Resume(ctx context.Context, id string) (*IngestionResponse, error)

+ func (r *IngestionsResource) SaveVersion(ctx context.Context, id string, req *SaveIngestionVersionRequest) (*IngestionVersionResponse, error)

+ func (r *IngestionsResource) Secrets(ctx context.Context, id string) (*IngestionSecretListResponse, error)

+ func (r *IngestionsResource) SourceKinds(ctx context.Context) (*IngestionSourceKindListResponse, error)

+ func (r *IngestionsResource) TestConnection(ctx context.Context, req *TestIngestionRequest) (*IngestionTestResponse, error)

+ func (r *IngestionsResource) Update(ctx context.Context, id string, req *UpdateIngestionRequest) (*IngestionResponse, error)

+ type InstanceCompleteRequest struct

+ Result json.RawMessage

+ Status CompletionStatus

+ type InstanceFilters struct

+ Page *uint32

+ Size *uint32

+ Status string

+ type InstanceLogListResponse struct

+ Logs []InstanceLogResponse

+ Total uint64

+ type InstanceLogRequest struct

+ Level LogLevel

+ Message string

+ Metadata json.RawMessage

+ type InstanceLogResponse struct

+ ClientID string

+ CreatedAt string

+ ID string

+ InstanceID string

+ Level string

+ Message string

+ Metadata json.RawMessage

+ ScheduledJobID string

+ type JSONSplit struct

+ ArrayPath string

+ func (s JSONSplit) MarshalJSON() ([]byte, error)

+ type LinkServiceAccountRequest struct

+ ServiceAccountCode string

+ ServiceAccountID string

+ type ListIngestionsFilters struct

+ After string

+ ApplicationCode string

+ ClientID string

+ Kind string

+ Limit *uint32

+ Q string

+ Status string

+ type LogLevel string

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelWarn

+ type MeResource struct

+ func (r *MeResource) Client(ctx context.Context, clientID string) (*MyClient, error)

+ func (r *MeResource) ClientApplications(ctx context.Context, clientID string) (*MyApplicationsResponse, error)

+ func (r *MeResource) Clients(ctx context.Context) (*MyClientsResponse, error)

+ type MyApplication struct

+ BaseURL string

+ Code string

+ Description string

+ ID string

+ IconURL string

+ LogoMimeType string

+ Name string

+ Website string

+ type MyApplicationsResponse struct

+ Applications []MyApplication

+ ClientID string

+ Total uint64

+ type MyClient struct

+ CreatedAt string

+ ID string

+ Identifier string

+ Name string

+ Status string

+ UpdatedAt string

+ type MyClientsResponse struct

+ Clients []MyClient

+ Total uint64

+ type NoSplit struct

+ func (s NoSplit) MarshalJSON() ([]byte, error)

+ type NoteResponse struct

+ AddedAt string

+ AddedBy string

+ Category string

+ Text string

+ type OAuthClientCredentials struct

+ ClientID string

+ ClientSecret string

+ ID string

+ type OpenAPIResource struct

+ func (r *OpenAPIResource) Sync(ctx context.Context, appCode string, spec json.RawMessage) (*SyncOpenAPISpecResponse, error)

+ type Option func(*FlowCatalystClient)

+ func WithHTTPClient(h *http.Client) Option

+ func WithRetry(attempts int, baseDelay time.Duration) Option

+ func WithRouterBaseURL(u string) Option

+ func WithTimeout(d time.Duration) Option

+ func WithToken(token string) Option

+ func WithTokenProvider(p TokenProvider) Option

+ type PermissionListResponse struct

+ Permissions []PermissionResponse

+ Total uint64

+ type PermissionResponse struct

+ Category string

+ Description string

+ Name string

+ Permission string

+ type PermissionsResource struct

+ func (r *PermissionsResource) Get(ctx context.Context, name string) (*PermissionResponse, error)

+ func (r *PermissionsResource) List(ctx context.Context) (*PermissionListResponse, error)

+ type PlatformConfigResource struct

+ func (r *PlatformConfigResource) Delete(ctx context.Context, app, section, property, clientID string) error

+ func (r *PlatformConfigResource) Get(ctx context.Context, app, section, property, clientID string) (*ConfigResponse, error)

+ func (r *PlatformConfigResource) RevealSecret(ctx context.Context, app, section, property, clientID string) (*SecretResponse, error)

+ func (r *PlatformConfigResource) Set(ctx context.Context, app, section, property string, ...) (*ConfigResponse, error)

+ type PrincipalFilters struct

+ Active string

+ ClientID string

+ Email string

+ Page *uint32

+ PageSize *uint32

+ Roles string

+ SortField string

+ SortOrder string

+ Type string

+ type PrincipalListResponse struct

+ Principals []PrincipalResponse

+ Total uint64

+ type PrincipalResponse struct

+ Active bool

+ ClientID string

+ CreatedAt string

+ DeveloperCredentialUpdatedAt string

+ Email string

+ GrantedClientIDs []string

+ HasDeveloperCredential bool

+ ID string

+ IdpType string

+ InviteLink string

+ IsAnchorUser bool

+ Name string

+ PrincipalType string

+ Roles []string

+ Scope string

+ ServiceAccountID string

+ TwoFactorMethods []string

+ UpdatedAt string

+ type PrincipalRoleListResponse struct

+ Roles []PrincipalRoleResponse

+ type PrincipalRoleResponse struct

+ AssignedAt string

+ AssignmentSource string

+ ID string

+ RoleName string

+ type PrincipalsResource struct

+ func (r *PrincipalsResource) Activate(ctx context.Context, id string) error

+ func (r *PrincipalsResource) AddRole(ctx context.Context, id, roleName string) (*PrincipalResponse, error)

+ func (r *PrincipalsResource) ClientAccessGrants(ctx context.Context, id string) (*ClientAccessListResponse, error)

+ func (r *PrincipalsResource) CreateUser(ctx context.Context, req *CreateUserRequest) (*PrincipalResponse, error)

+ func (r *PrincipalsResource) Deactivate(ctx context.Context, id string) error

+ func (r *PrincipalsResource) FindByEmail(ctx context.Context, email string) (*PrincipalListResponse, error)

+ func (r *PrincipalsResource) Get(ctx context.Context, id string) (*PrincipalResponse, error)

+ func (r *PrincipalsResource) GrantClientAccess(ctx context.Context, principalID, clientID string) (*ClientAccessGrantResponse, error)

+ func (r *PrincipalsResource) List(ctx context.Context, filters *PrincipalFilters) (*PrincipalListResponse, error)

+ func (r *PrincipalsResource) RemoveRole(ctx context.Context, id, roleName string) (*PrincipalResponse, error)

+ func (r *PrincipalsResource) ResetPassword(ctx context.Context, principalID string, req *ResetPasswordRequest) error

+ func (r *PrincipalsResource) RevokeClientAccess(ctx context.Context, principalID, clientID string) error

+ func (r *PrincipalsResource) Roles(ctx context.Context, id string) (*PrincipalRoleListResponse, error)

+ func (r *PrincipalsResource) SetRoles(ctx context.Context, id string, roles []string) (*SetRolesResponse, error)

+ func (r *PrincipalsResource) Sync(ctx context.Context, appCode string, req *SyncPrincipalsRequest, ...) (*SyncResult, error)

+ func (r *PrincipalsResource) SyncUsers(ctx context.Context, req *SyncPrincipalsRequest) (*SyncUsersResult, error)

+ func (r *PrincipalsResource) Update(ctx context.Context, id string, req *UpdatePrincipalRequest) (*PrincipalResponse, error)

+ type ProcessFilters struct

+ Application string

+ Status string

+ Subdomain string

+ type ProcessListResponse struct

+ Items []ProcessResponse

+ type ProcessResponse struct

+ Application string

+ Body string

+ Code string

+ CreatedAt string

+ CreatedBy string

+ Description string

+ DiagramType string

+ ID string

+ Name string

+ ProcessName string

+ Source string

+ Status string

+ Subdomain string

+ Tags []string

+ UpdatedAt string

+ type ProcessesResource struct

+ func (r *ProcessesResource) Archive(ctx context.Context, id string) error

+ func (r *ProcessesResource) Create(ctx context.Context, req *CreateProcessRequest) (*CreatedResponse, error)

+ func (r *ProcessesResource) Delete(ctx context.Context, id string) error

+ func (r *ProcessesResource) Get(ctx context.Context, id string) (*ProcessResponse, error)

+ func (r *ProcessesResource) GetByCode(ctx context.Context, code string) (*ProcessResponse, error)

+ func (r *ProcessesResource) List(ctx context.Context, filters *ProcessFilters) (*ProcessListResponse, error)

+ func (r *ProcessesResource) Sync(ctx context.Context, appCode string, req *SyncProcessesRequest, ...) (*SyncResult, error)

+ func (r *ProcessesResource) Update(ctx context.Context, id string, req *UpdateProcessRequest) error

+ type ProvisionServiceAccountResponse struct

+ Message string

+ ServiceAccount ServiceAccountCredentials

+ type QueryBuilder struct

+ func NewQuery() *QueryBuilder

+ func (q *QueryBuilder) Bool(name string, value *bool) *QueryBuilder

+ func (q *QueryBuilder) Encode() string

+ func (q *QueryBuilder) String(name, value string) *QueryBuilder

+ func (q *QueryBuilder) Uint32(name string, value *uint32) *QueryBuilder

+ type RabbitMQSource struct

+ Password SecretRef

+ Queue string

+ URI string

+ Username string

+ func (s RabbitMQSource) MarshalJSON() ([]byte, error)

+ type RateLimit struct

+ Per string

+ Requests int

+ type ReplaceRolesRequest struct

+ Roles []string

+ type ResetPasswordRequest struct

+ EnforcePasswordComplexity *bool

+ NewPassword string

+ type RoleListResponse struct

+ Roles []RoleResponse

+ Total uint64

+ type RoleResponse struct

+ ApplicationCode string

+ ApplicationID string

+ ClientManaged bool

+ CreatedAt string

+ Description string

+ DisplayName string

+ ID string

+ Name string

+ Permissions []string

+ Source string

+ UpdatedAt string

+ type RolesResource struct

+ func (r *RolesResource) Create(ctx context.Context, req *CreateRoleRequest) (*CreatedResponse, error)

+ func (r *RolesResource) Delete(ctx context.Context, name string) error

+ func (r *RolesResource) Get(ctx context.Context, name string) (*RoleResponse, error)

+ func (r *RolesResource) GetByCode(ctx context.Context, code string) (*RoleResponse, error)

+ func (r *RolesResource) GrantPermission(ctx context.Context, roleName, permission string) (*RoleResponse, error)

+ func (r *RolesResource) List(ctx context.Context) (*RoleListResponse, error)

+ func (r *RolesResource) ListForApplication(ctx context.Context, applicationID string) ([]RoleResponse, error)

+ func (r *RolesResource) RevokePermission(ctx context.Context, roleName, permission string) (*RoleResponse, error)

+ func (r *RolesResource) Sync(ctx context.Context, appCode string, req *SyncRolesRequest, ...) (*SyncResult, error)

+ func (r *RolesResource) Update(ctx context.Context, name string, req *UpdateRoleRequest) error

+ type RouterResource struct

+ func (r *RouterResource) InPipeline(ctx context.Context, messageID string) (*InPipelineCheckResponse, error)

+ func (r *RouterResource) InPipelineBatch(ctx context.Context, messageIDs []string) (map[string]bool, error)

+ type S3Source struct

+ Bucket string

+ Credential *AWSCredential

+ Every string

+ Prefix *string

+ Region string

+ func (s S3Source) MarshalJSON() ([]byte, error)

+ type SFTPSource struct

+ AcceptAnyHostKey bool

+ Credential SecretRef

+ Directory string

+ Every string

+ Host string

+ Include *string

+ KnownHosts *string

+ Port int

+ Username string

+ func (s SFTPSource) MarshalJSON() ([]byte, error)

+ type SQSSource struct

+ Credential *AWSCredential

+ Queue string

+ Region string

+ func (s SQSSource) MarshalJSON() ([]byte, error)

+ type SaveIngestionVersionRequest struct

+ KeepFailedPayloads bool

+ Live *bool

+ Name string

+ Note string

+ Source IngestionSource

+ Split IngestionSplit

+ Target IngestionTarget

+ type ScheduledJobFilters struct

+ ClientID string

+ Page *uint32

+ Search string

+ Size *uint32

+ Status string

+ type ScheduledJobInstanceListResponse struct

+ Data []ScheduledJobInstanceResponse

+ Page uint32

+ Size uint32

+ Total uint64

+ TotalPages uint32

+ type ScheduledJobInstanceResponse struct

+ ClientID string

+ CompletedAt string

+ CompletionResult json.RawMessage

+ CompletionStatus string

+ CorrelationID string

+ CreatedAt string

+ DeliveredAt string

+ DeliveryAttempts int32

+ DeliveryError string

+ FiredAt string

+ ID string

+ JobCode string

+ ScheduledFor string

+ ScheduledJobID string

+ Status string

+ TriggerKind string

+ type ScheduledJobListResponse struct

+ Data []ScheduledJobResponse

+ Page uint32

+ Size uint32

+ Total uint64

+ TotalPages uint32

+ type ScheduledJobResponse struct

+ ApplicationID string

+ ClientID string

+ Code string

+ Concurrent bool

+ CreatedAt string

+ CreatedBy string

+ Crons []string

+ DeliveryMaxAttempts int32

+ Description string

+ HasActiveInstance bool

+ ID string

+ LastFiredAt string

+ Name string

+ Payload json.RawMessage

+ Status string

+ TargetURL string

+ TimeoutSeconds *int32

+ Timezone string

+ TracksCompletion bool

+ UpdatedAt string

+ UpdatedBy string

+ Version int32

+ type ScheduledJobsResource struct

+ func (r *ScheduledJobsResource) Archive(ctx context.Context, id string) error

+ func (r *ScheduledJobsResource) CompleteInstance(ctx context.Context, instanceID string, req *InstanceCompleteRequest) error

+ func (r *ScheduledJobsResource) Create(ctx context.Context, req *CreateScheduledJobRequest) (*CreatedResponse, error)

+ func (r *ScheduledJobsResource) Delete(ctx context.Context, id string) error

+ func (r *ScheduledJobsResource) Fire(ctx context.Context, id string, req *FireRequest) (*FireResponse, error)

+ func (r *ScheduledJobsResource) Get(ctx context.Context, id string) (*ScheduledJobResponse, error)

+ func (r *ScheduledJobsResource) GetByCode(ctx context.Context, code, clientID string) (*ScheduledJobResponse, error)

+ func (r *ScheduledJobsResource) GetInstance(ctx context.Context, instanceID string) (*ScheduledJobInstanceResponse, error)

+ func (r *ScheduledJobsResource) List(ctx context.Context, filters *ScheduledJobFilters) (*ScheduledJobListResponse, error)

+ func (r *ScheduledJobsResource) ListInstanceLogs(ctx context.Context, instanceID string) (*InstanceLogListResponse, error)

+ func (r *ScheduledJobsResource) ListInstances(ctx context.Context, jobID string, filters *InstanceFilters) (*ScheduledJobInstanceListResponse, error)

+ func (r *ScheduledJobsResource) LogForInstance(ctx context.Context, instanceID string, req *InstanceLogRequest) error

+ func (r *ScheduledJobsResource) Pause(ctx context.Context, id string) error

+ func (r *ScheduledJobsResource) Resume(ctx context.Context, id string) error

+ func (r *ScheduledJobsResource) Sync(ctx context.Context, appCode string, req *SyncScheduledJobsRequest) (*SyncScheduledJobsResult, error)

+ func (r *ScheduledJobsResource) Update(ctx context.Context, id string, req *UpdateScheduledJobRequest) error

+ type SecretRef struct

+ Name string

+ type SecretResponse struct

+ ApplicationCode string

+ ClientID string

+ Property string

+ Section string

+ UpdatedAt string

+ Value string

+ func (s SecretResponse) GoString() string

+ func (s SecretResponse) LogValue() slog.Value

+ func (s SecretResponse) String() string

+ type ServiceAccountCredentials struct

+ Name string

+ OAuthClient OAuthClientCredentials

+ PrincipalID string

+ type ServiceAccountResponse struct

+ Active bool

+ ApplicationID string

+ AuthType string

+ ClientIDs []string

+ Code string

+ CreatedAt string

+ Description string

+ ID string

+ LastUsedAt string

+ Name string

+ OAuthClientID string

+ PrincipalID string

+ Roles []string

+ Scope string

+ UpdatedAt string

+ type ServiceAccountsResource struct

+ func (r *ServiceAccountsResource) Get(ctx context.Context, id string) (*ServiceAccountResponse, error)

+ type SetChange struct

+ Action string

+ Application string

+ Changed []string

+ Client string

+ Code string

+ IngestionID string

+ Warnings []string

+ type SetConfigPropertyRequest struct

+ ClientID string

+ Description string

+ Value string

+ ValueType string

+ type SetFile struct

+ Content string

+ Path string

+ type SetRolesResponse struct

+ Added []string

+ Removed []string

+ Roles []PrincipalRoleResponse

+ type SpecVersionResponse struct

+ CreatedAt string

+ Schema json.RawMessage

+ Status string

+ Version string

+ type StatusChangeRequest struct

+ Reason string

+ type StatusChangeResponse struct

+ Message string

+ type StatusTrack struct

+ Column string

+ KeyColumn string

+ Pending string

+ Processed string

+ func (t StatusTrack) MarshalJSON() ([]byte, error)

+ type SubscriptionListResponse struct

+ Subscriptions []SubscriptionResponse

+ Total uint64

+ type SubscriptionResponse struct

+ ApplicationCode string

+ ClientID string

+ ClientIdentifier string

+ ClientScoped bool

+ Code string

+ ConnectionID string

+ CreatedAt string

+ CreatedBy string

+ CustomConfig []ConfigEntry

+ DataOnly bool

+ DelaySeconds uint32

+ Description string

+ DispatchPoolCode string

+ DispatchPoolID string

+ Endpoint string

+ EventTypes []EventTypeBinding

+ ID string

+ MaxAgeSeconds uint32

+ MaxRetries uint32

+ Mode string

+ Name string

+ Queue string

+ Sequence int32

+ ServiceAccountID string

+ Source string

+ Status string

+ TimeoutSeconds uint32

+ UpdatedAt string

+ type SubscriptionsResource struct

+ func (r *SubscriptionsResource) Create(ctx context.Context, req *CreateSubscriptionRequest) (*CreatedResponse, error)

+ func (r *SubscriptionsResource) Delete(ctx context.Context, id string) error

+ func (r *SubscriptionsResource) Get(ctx context.Context, id string) (*SubscriptionResponse, error)

+ func (r *SubscriptionsResource) List(ctx context.Context, clientID, status string) (*SubscriptionListResponse, error)

+ func (r *SubscriptionsResource) Pause(ctx context.Context, id string) error

+ func (r *SubscriptionsResource) Resume(ctx context.Context, id string) error

+ func (r *SubscriptionsResource) Sync(ctx context.Context, appCode string, req *SyncSubscriptionsRequest, ...) (*SyncResult, error)

+ func (r *SubscriptionsResource) Update(ctx context.Context, id string, req *UpdateSubscriptionRequest) error

+ type SyncConnectionItem struct

+ Code string

+ Description string

+ ExternalID string

+ Name string

+ type SyncConnectionsRequest struct

+ ClientID string

+ Connections []SyncConnectionItem

+ type SyncDispatchPoolItem struct

+ Code string

+ Concurrency uint32

+ Description string

+ Name string

+ RateLimit *uint32

+ type SyncDispatchPoolsRequest struct

+ Pools []SyncDispatchPoolItem

+ type SyncDocInput struct

+ Content string

+ Slug string

+ Title string

+ type SyncDocsRequest struct

+ Docs []SyncDocInput

+ type SyncEventTypeItem struct

+ Code string

+ Description string

+ Name string

+ type SyncEventTypesRequest struct

+ EventTypes []SyncEventTypeItem

+ type SyncOpenAPISpecRequest struct

+ Spec json.RawMessage

+ type SyncOpenAPISpecResponse struct

+ ApplicationCode string

+ ArchivedPriorVersion string

+ HasBreaking bool

+ SpecID string

+ Status string

+ Unchanged bool

+ Version string

+ type SyncPrincipalItem struct

+ Active bool

+ Email string

+ Name string

+ PasswordHash *string

+ Roles []string

+ type SyncPrincipalsRequest struct

+ Principals []SyncPrincipalItem

+ type SyncProcessInput struct

+ Body string

+ Code string

+ Description string

+ DiagramType string

+ Name string

+ Tags []string

+ type SyncProcessesRequest struct

+ Processes []SyncProcessInput

+ type SyncResult struct

+ ApplicationCode string

+ Created uint32

+ Deleted uint32

+ PasswordHashIgnored []string

+ SkippedRoles []string

+ SyncedCodes []string

+ Updated uint32

+ type SyncRoleItem struct

+ ClientManaged bool

+ Description string

+ DisplayName string

+ Name string

+ Permissions []string

+ type SyncRolesRequest struct

+ Roles []SyncRoleItem

+ type SyncScheduledJobItem struct

+ Code string

+ Concurrent bool

+ Crons []string

+ DeliveryMaxAttempts *int32

+ Description string

+ Name string

+ Payload json.RawMessage

+ TargetURL string

+ TimeoutSeconds *int32

+ Timezone string

+ TracksCompletion bool

+ type SyncScheduledJobsRequest struct

+ ArchiveUnlisted bool

+ ClientID string

+ Jobs []SyncScheduledJobItem

+ type SyncScheduledJobsResult struct

+ ApplicationCode string

+ Archived []string

+ Created []string

+ Updated []string

+ type SyncSubscriptionItem struct

+ Code string

+ ConnectionCode string

+ ConnectionID string

+ DataOnly bool

+ Description string

+ DispatchPoolCode string

+ EventTypes []EventTypeBinding

+ MaxRetries *uint32

+ Mode string

+ Name string

+ SharedConnection bool

+ Target string

+ TimeoutSeconds *uint32

+ type SyncSubscriptionsRequest struct

+ ClientID string

+ Subscriptions []SyncSubscriptionItem

+ type SyncUsersResult struct

+ Created uint32

+ Deleted uint32

+ PasswordHashIgnored []string

+ SyncedEmails []string

+ Updated uint32

+ type TestIngestionRequest struct

+ Application string

+ Client string

+ Definition *IngestionDefinition

+ IngestionID string

+ type TokenProvider func(ctx context.Context) (string, error)

+ type Unrecognized struct

+ Raw json.RawMessage

+ func (u Unrecognized) Kind() string

+ func (u Unrecognized) MarshalJSON() ([]byte, error)

+ type UpdateApplicationRequest struct

+ DefaultBaseURL *string

+ Description *string

+ IconURL *string

+ Logo *string

+ LogoMimeType *string

+ Name *string

+ Website *string

+ type UpdateClientApplicationsRequest struct

+ EnabledApplicationIDs []string

+ type UpdateClientRequest struct

+ Name *string

+ type UpdateConnectionRequest struct

+ ApplicationCode *string

+ Description *string

+ ExternalID *string

+ Name string

+ Status *string

+ type UpdateDispatchPoolRequest struct

+ Concurrency *uint32

+ Description *string

+ Name *string

+ RateLimit *uint32

+ type UpdateEventTypeRequest struct

+ ClientScoped *bool

+ Description *string

+ Name string

+ type UpdateIngestionRequest struct

+ ExpectedVersion int64

+ KeepFailedPayloads bool

+ Name string

+ Note string

+ Source IngestionSource

+ Split IngestionSplit

+ Target IngestionTarget

+ type UpdatePrincipalRequest struct

+ Active *bool

+ Email *string

+ Name *string

+ type UpdateProcessRequest struct

+ Body *string

+ Description *string

+ DiagramType *string

+ Name *string

+ Tags []string

+ type UpdateRoleRequest struct

+ ClientManaged *bool

+ Description *string

+ DisplayName *string

+ Permissions []string

+ type UpdateScheduledJobRequest struct

+ Concurrent *bool

+ Crons []string

+ DeliveryMaxAttempts *int32

+ Description *string

+ Name *string

+ Payload json.RawMessage

+ TargetURL *string

+ TimeoutSeconds *int32

+ Timezone *string

+ TracksCompletion *bool

+ type UpdateSubscriptionRequest struct

+ ConnectionID *string

+ CustomConfig *[]ConfigEntry

+ DataOnly *bool

+ DelaySeconds *uint32

+ Description *string

+ DispatchPoolID *string

+ Endpoint *string

+ EventTypes *[]EventTypeBinding

+ MaxAgeSeconds *uint32

+ MaxRetries *uint32

+ Mode *string

+ Name *string

+ Queue *string

+ ServiceAccountID *string

+ TimeoutSeconds *uint32

+ type WatermarkTrack struct

+ Column string

+ Type string

+ func (t WatermarkTrack) MarshalJSON() ([]byte, error)

+ type XMLSplit struct

+ Element string

+ func (s XMLSplit) MarshalJSON() ([]byte, error)

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