Documentation
¶
Overview ¶
Package openapi provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT.
Package openapi provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT.
Index ¶
- type ApiProblem
- type Backfill
- type DefaultPeriod
- type HydratedIntegration
- type HydratedIntegrationField
- func (t HydratedIntegrationField) AsHydratedIntegrationFieldExistent() (HydratedIntegrationFieldExistent, error)
- func (t HydratedIntegrationField) AsIntegrationFieldMapping() (IntegrationFieldMapping, error)
- func (t *HydratedIntegrationField) FromHydratedIntegrationFieldExistent(v HydratedIntegrationFieldExistent) error
- func (t *HydratedIntegrationField) FromIntegrationFieldMapping(v IntegrationFieldMapping) error
- func (t HydratedIntegrationField) MarshalJSON() ([]byte, error)
- func (t *HydratedIntegrationField) MergeHydratedIntegrationFieldExistent(v HydratedIntegrationFieldExistent) error
- func (t *HydratedIntegrationField) MergeIntegrationFieldMapping(v IntegrationFieldMapping) error
- func (t *HydratedIntegrationField) UnmarshalJSON(b []byte) error
- type HydratedIntegrationFieldExistent
- type HydratedIntegrationObject
- type HydratedIntegrationProxy
- type HydratedIntegrationRead
- type HydratedIntegrationWrite
- type HydratedIntegrationWriteObject
- type InputValidationIssue
- type InputValidationProblem
- type InputValidationProblemResponse
- type Integration
- type IntegrationField
- func (t IntegrationField) AsIntegrationFieldExistent() (IntegrationFieldExistent, error)
- func (t IntegrationField) AsIntegrationFieldMapping() (IntegrationFieldMapping, error)
- func (t *IntegrationField) FromIntegrationFieldExistent(v IntegrationFieldExistent) error
- func (t *IntegrationField) FromIntegrationFieldMapping(v IntegrationFieldMapping) error
- func (t IntegrationField) MarshalJSON() ([]byte, error)
- func (t *IntegrationField) MergeIntegrationFieldExistent(v IntegrationFieldExistent) error
- func (t *IntegrationField) MergeIntegrationFieldMapping(v IntegrationFieldMapping) error
- func (t *IntegrationField) UnmarshalJSON(b []byte) error
- type IntegrationFieldExistent
- type IntegrationFieldMapping
- type IntegrationObject
- type IntegrationProxy
- type IntegrationRead
- type IntegrationWrite
- type IntegrationWriteObject
- type Manifest
- type OptionalFieldsAutoOption
- type Problem
- type ProblemResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiProblem ¶
type ApiProblem = Problem
ApiProblem A Problem Details object (RFC 9457).
Additional properties specific to the problem type may be present.
type Backfill ¶ added in v1.0.3
type Backfill struct {
DefaultPeriod DefaultPeriod `json:"defaultPeriod"`
}
Backfill defines model for Backfill.
type DefaultPeriod ¶ added in v1.0.3
type DefaultPeriod struct {
// Days Number of days in past to backfill from. 0 is no backfill. e.g) if 10, then backfill last 10 days of data. Required if fullHistory is not set.
Days *int `json:"days,omitempty" validate:"required_without=FullHistory,omitempty,min=0"`
// FullHistory If true, backfill all history. Required if days is not set.
FullHistory *bool `json:"fullHistory,omitempty" validate:"required_without=Days"`
}
DefaultPeriod defines model for DefaultPeriod.
type HydratedIntegration ¶
type HydratedIntegration struct {
DisplayName *string `json:"displayName,omitempty"`
Name string `json:"name"`
Provider string `json:"provider"`
Proxy *HydratedIntegrationProxy `json:"proxy,omitempty"`
Read *HydratedIntegrationRead `json:"read,omitempty"`
Write *HydratedIntegrationWrite `json:"write,omitempty"`
}
HydratedIntegration defines model for HydratedIntegration.
type HydratedIntegrationField ¶
type HydratedIntegrationField struct {
// contains filtered or unexported fields
}
HydratedIntegrationField defines model for HydratedIntegrationField.
func (HydratedIntegrationField) AsHydratedIntegrationFieldExistent ¶
func (t HydratedIntegrationField) AsHydratedIntegrationFieldExistent() (HydratedIntegrationFieldExistent, error)
AsHydratedIntegrationFieldExistent returns the union data inside the HydratedIntegrationField as a HydratedIntegrationFieldExistent
func (HydratedIntegrationField) AsIntegrationFieldMapping ¶
func (t HydratedIntegrationField) AsIntegrationFieldMapping() (IntegrationFieldMapping, error)
AsIntegrationFieldMapping returns the union data inside the HydratedIntegrationField as a IntegrationFieldMapping
func (*HydratedIntegrationField) FromHydratedIntegrationFieldExistent ¶
func (t *HydratedIntegrationField) FromHydratedIntegrationFieldExistent(v HydratedIntegrationFieldExistent) error
FromHydratedIntegrationFieldExistent overwrites any union data inside the HydratedIntegrationField as the provided HydratedIntegrationFieldExistent
func (*HydratedIntegrationField) FromIntegrationFieldMapping ¶
func (t *HydratedIntegrationField) FromIntegrationFieldMapping(v IntegrationFieldMapping) error
FromIntegrationFieldMapping overwrites any union data inside the HydratedIntegrationField as the provided IntegrationFieldMapping
func (HydratedIntegrationField) MarshalJSON ¶
func (t HydratedIntegrationField) MarshalJSON() ([]byte, error)
func (*HydratedIntegrationField) MergeHydratedIntegrationFieldExistent ¶
func (t *HydratedIntegrationField) MergeHydratedIntegrationFieldExistent(v HydratedIntegrationFieldExistent) error
MergeHydratedIntegrationFieldExistent performs a merge with any union data inside the HydratedIntegrationField, using the provided HydratedIntegrationFieldExistent
func (*HydratedIntegrationField) MergeIntegrationFieldMapping ¶
func (t *HydratedIntegrationField) MergeIntegrationFieldMapping(v IntegrationFieldMapping) error
MergeIntegrationFieldMapping performs a merge with any union data inside the HydratedIntegrationField, using the provided IntegrationFieldMapping
func (*HydratedIntegrationField) UnmarshalJSON ¶
func (t *HydratedIntegrationField) UnmarshalJSON(b []byte) error
type HydratedIntegrationFieldExistent ¶
type HydratedIntegrationFieldExistent struct {
DisplayName string `json:"displayName"`
FieldName string `json:"fieldName"`
}
HydratedIntegrationFieldExistent defines model for HydratedIntegrationFieldExistent.
type HydratedIntegrationObject ¶
type HydratedIntegrationObject struct {
// AllFields This is a list of all fields on the object for a particular SaaS instance. This is used to populate the UI during configuration.
AllFields *[]HydratedIntegrationField `json:"allFields,omitempty"`
Backfill *Backfill `json:"backfill,omitempty"`
Destination string `json:"destination"`
DisplayName string `json:"displayName"`
ObjectName string `json:"objectName"`
OptionalFields *[]HydratedIntegrationField `json:"optionalFields,omitempty"`
OptionalFieldsAuto *OptionalFieldsAutoOption `json:"optionalFieldsAuto,omitempty"`
RequiredFields *[]HydratedIntegrationField `json:"requiredFields,omitempty"`
Schedule string `json:"schedule"`
}
HydratedIntegrationObject defines model for HydratedIntegrationObject.
type HydratedIntegrationProxy ¶
type HydratedIntegrationProxy struct {
Enabled *bool `json:"enabled,omitempty"`
}
HydratedIntegrationProxy defines model for HydratedIntegrationProxy.
type HydratedIntegrationRead ¶
type HydratedIntegrationRead struct {
Objects *[]HydratedIntegrationObject `json:"objects,omitempty"`
}
HydratedIntegrationRead defines model for HydratedIntegrationRead.
type HydratedIntegrationWrite ¶
type HydratedIntegrationWrite struct {
Objects *[]HydratedIntegrationWriteObject `json:"objects,omitempty"`
}
HydratedIntegrationWrite defines model for HydratedIntegrationWrite.
type HydratedIntegrationWriteObject ¶
type HydratedIntegrationWriteObject struct {
DisplayName string `json:"displayName"`
ObjectName string `json:"objectName"`
}
HydratedIntegrationWriteObject defines model for HydratedIntegrationWriteObject.
type InputValidationIssue ¶
type InputValidationIssue = ApiProblem
InputValidationIssue defines model for InputValidationIssue.
type InputValidationProblem ¶
type InputValidationProblem = ApiProblem
InputValidationProblem defines model for InputValidationProblem.
type InputValidationProblemResponse ¶
type InputValidationProblemResponse = InputValidationProblem
InputValidationProblemResponse defines model for InputValidationProblemResponse.
type Integration ¶
type Integration struct {
DisplayName *string `json:"displayName,omitempty"`
Name string `json:"name"`
Provider string `json:"provider"`
Proxy *IntegrationProxy `json:"proxy,omitempty"`
Read *IntegrationRead `json:"read,omitempty"`
Write *IntegrationWrite `json:"write,omitempty"`
}
Integration defines model for Integration.
type IntegrationField ¶
type IntegrationField struct {
// contains filtered or unexported fields
}
IntegrationField defines model for IntegrationField.
func (IntegrationField) AsIntegrationFieldExistent ¶
func (t IntegrationField) AsIntegrationFieldExistent() (IntegrationFieldExistent, error)
AsIntegrationFieldExistent returns the union data inside the IntegrationField as a IntegrationFieldExistent
func (IntegrationField) AsIntegrationFieldMapping ¶
func (t IntegrationField) AsIntegrationFieldMapping() (IntegrationFieldMapping, error)
AsIntegrationFieldMapping returns the union data inside the IntegrationField as a IntegrationFieldMapping
func (*IntegrationField) FromIntegrationFieldExistent ¶
func (t *IntegrationField) FromIntegrationFieldExistent(v IntegrationFieldExistent) error
FromIntegrationFieldExistent overwrites any union data inside the IntegrationField as the provided IntegrationFieldExistent
func (*IntegrationField) FromIntegrationFieldMapping ¶
func (t *IntegrationField) FromIntegrationFieldMapping(v IntegrationFieldMapping) error
FromIntegrationFieldMapping overwrites any union data inside the IntegrationField as the provided IntegrationFieldMapping
func (IntegrationField) MarshalJSON ¶
func (t IntegrationField) MarshalJSON() ([]byte, error)
func (*IntegrationField) MergeIntegrationFieldExistent ¶
func (t *IntegrationField) MergeIntegrationFieldExistent(v IntegrationFieldExistent) error
MergeIntegrationFieldExistent performs a merge with any union data inside the IntegrationField, using the provided IntegrationFieldExistent
func (*IntegrationField) MergeIntegrationFieldMapping ¶
func (t *IntegrationField) MergeIntegrationFieldMapping(v IntegrationFieldMapping) error
MergeIntegrationFieldMapping performs a merge with any union data inside the IntegrationField, using the provided IntegrationFieldMapping
func (*IntegrationField) UnmarshalJSON ¶
func (t *IntegrationField) UnmarshalJSON(b []byte) error
type IntegrationFieldExistent ¶
type IntegrationFieldExistent struct {
FieldName string `json:"fieldName"`
}
IntegrationFieldExistent defines model for IntegrationFieldExistent.
type IntegrationFieldMapping ¶
type IntegrationFieldMapping struct {
Default *string `json:"default,omitempty"`
MapToDisplayName *string `json:"mapToDisplayName,omitempty"`
MapToName string `json:"mapToName"`
Prompt *string `json:"prompt,omitempty"`
}
IntegrationFieldMapping defines model for IntegrationFieldMapping.
type IntegrationObject ¶
type IntegrationObject struct {
Backfill *Backfill `json:"backfill,omitempty"`
Destination string `json:"destination"`
ObjectName string `json:"objectName"`
OptionalFields *[]IntegrationField `json:"optionalFields,omitempty"`
OptionalFieldsAuto *OptionalFieldsAutoOption `json:"optionalFieldsAuto,omitempty"`
RequiredFields *[]IntegrationField `json:"requiredFields,omitempty"`
Schedule string `json:"schedule"`
}
IntegrationObject defines model for IntegrationObject.
type IntegrationProxy ¶
type IntegrationProxy struct {
Enabled *bool `json:"enabled,omitempty"`
}
IntegrationProxy defines model for IntegrationProxy.
type IntegrationRead ¶
type IntegrationRead struct {
Objects *[]IntegrationObject `json:"objects,omitempty"`
}
IntegrationRead defines model for IntegrationRead.
type IntegrationWrite ¶
type IntegrationWrite struct {
Objects *[]IntegrationWriteObject `json:"objects,omitempty"`
}
IntegrationWrite defines model for IntegrationWrite.
type IntegrationWriteObject ¶
type IntegrationWriteObject struct {
ObjectName string `json:"objectName"`
}
IntegrationWriteObject defines model for IntegrationWriteObject.
type Manifest ¶
type Manifest struct {
Integrations []Integration `json:"integrations"`
// SpecVersion The version of the manifest spec that this file conforms to.
SpecVersion string `json:"specVersion"`
}
Manifest This is the schema of the manifest file that is used to define the integrations of the project.
type OptionalFieldsAutoOption ¶
type OptionalFieldsAutoOption string
OptionalFieldsAutoOption defines model for OptionalFieldsAutoOption.
const (
All OptionalFieldsAutoOption = "all"
)
Defines values for OptionalFieldsAutoOption.
type Problem ¶
type Problem struct {
// Detail A human-readable explanation specific to this occurrence of the problem
Detail *string `json:"detail,omitempty"`
// Href An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).
Href *string `json:"href,omitempty"`
// Instance An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
Instance *string `json:"instance,omitempty"`
// Status The HTTP status code generated by the origin server for this occurrence of the problem.
Status *int32 `json:"status,omitempty"`
// Title A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).
Title *string `json:"title,omitempty"`
// Type An absolute URI that identifies the problem type
Type *string `json:"type,omitempty"`
}
Problem A Problem Details object (RFC 9457).
Additional properties specific to the problem type may be present.
type ProblemResponse ¶
type ProblemResponse = Problem
ProblemResponse A Problem Details object (RFC 9457).
Additional properties specific to the problem type may be present.