Documentation
¶
Index ¶
- type ApiClient
- func (a *ApiClient) CreateCollection(params *CreateCollectionRequest) (*CreateCollectionResponse, diag.Diagnostics)
- func (a *ApiClient) CreateTeamMember(params *CreateTeamMemberRequest) (*CreateTeamMemberResponse, diag.Diagnostics)
- func (a *ApiClient) DeleteCollection(collectionID string) (*UpdateCollectionResponse, diag.Diagnostics)
- func (a *ApiClient) DeleteTeamMember(id string) diag.Diagnostics
- func (a *ApiClient) GetCollection(collectionID string) (*ReadCollectionResponse, diag.Diagnostics)
- func (a *ApiClient) GetDataLake(filters []*Filter) (map[string]interface{}, diag.Diagnostics)
- func (a *ApiClient) GetSchema(filters []*Filter) (map[string]interface{}, diag.Diagnostics)
- func (a *ApiClient) GetTeamMember(accountID string) (*ReadTeamMemberResponse, diag.Diagnostics)
- func (a *ApiClient) Request(method, endpoint string, payload []byte) ([]byte, diag.Diagnostics)
- func (a *ApiClient) UpdateCollection(collectionID string, params *UpdateCollectionRequest) (*UpdateCollectionResponse, diag.Diagnostics)
- func (a *ApiClient) UpdateTeamMember(id string, params *UpdateTeamMemberRequest) (*UpdateTeamMemberResponse, diag.Diagnostics)
- type Config
- type CreateCollectionRequest
- type CreateCollectionResponse
- type CreateTeamMemberRequest
- type CreateTeamMemberResponse
- type ErrorResponse
- type Filter
- type IBatchAPI
- type ReadCollectionResponse
- type ReadTeamMemberResponse
- type ResponseError
- type UpdateCollectionRequest
- type UpdateCollectionResponse
- type UpdateTeamMemberRequest
- type UpdateTeamMemberResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiClient ¶
type ApiClient struct {
*Config
}
func (*ApiClient) CreateCollection ¶
func (a *ApiClient) CreateCollection(params *CreateCollectionRequest) (*CreateCollectionResponse, diag.Diagnostics)
func (*ApiClient) CreateTeamMember ¶
func (a *ApiClient) CreateTeamMember(params *CreateTeamMemberRequest) (*CreateTeamMemberResponse, diag.Diagnostics)
func (*ApiClient) DeleteCollection ¶
func (a *ApiClient) DeleteCollection(collectionID string) (*UpdateCollectionResponse, diag.Diagnostics)
func (*ApiClient) DeleteTeamMember ¶
func (a *ApiClient) DeleteTeamMember(id string) diag.Diagnostics
func (*ApiClient) GetCollection ¶
func (a *ApiClient) GetCollection(collectionID string) (*ReadCollectionResponse, diag.Diagnostics)
GetCollection obtains data for a single collection
func (*ApiClient) GetDataLake ¶
func (a *ApiClient) GetDataLake(filters []*Filter) (map[string]interface{}, diag.Diagnostics)
func (*ApiClient) GetSchema ¶
func (a *ApiClient) GetSchema(filters []*Filter) (map[string]interface{}, diag.Diagnostics)
func (*ApiClient) GetTeamMember ¶
func (a *ApiClient) GetTeamMember(accountID string) (*ReadTeamMemberResponse, diag.Diagnostics)
func (*ApiClient) UpdateCollection ¶
func (a *ApiClient) UpdateCollection(collectionID string, params *UpdateCollectionRequest) (*UpdateCollectionResponse, diag.Diagnostics)
func (*ApiClient) UpdateTeamMember ¶
func (a *ApiClient) UpdateTeamMember(id string, params *UpdateTeamMemberRequest) (*UpdateTeamMemberResponse, diag.Diagnostics)
type CreateCollectionRequest ¶
type CreateCollectionRequest struct {
Name string `json:"name"`
Notes string `json:"notes"`
SchemaID string `json:"schema_id"`
DatalakeID string `json:"datalake_id"`
EnvelopeType string `json:"envelope_type"`
EnvelopeRootMessage string `json:"envelope_root_message"`
PayloadRootMessage string `json:"payload_root_message"`
PayloadFieldID int `json:"payload_field_id"`
}
type CreateTeamMemberRequest ¶
type ErrorResponse ¶
type ErrorResponse struct {
Errors []*ResponseError `json:"errors"`
}
ErrorResponse is used to unmarshal an error response from our API
type IBatchAPI ¶
type IBatchAPI interface {
CreateCollection(params *CreateCollectionRequest) (*CreateCollectionResponse, diag.Diagnostics)
DeleteCollection(collectionID string) (*UpdateCollectionResponse, diag.Diagnostics)
GetCollection(collectionID string) (*ReadCollectionResponse, diag.Diagnostics)
UpdateCollection(collectionID string, params *UpdateCollectionRequest) (*UpdateCollectionResponse, diag.Diagnostics)
CreateTeamMember(params *CreateTeamMemberRequest) (*CreateTeamMemberResponse, diag.Diagnostics)
DeleteTeamMember(id string) diag.Diagnostics
GetTeamMember(accountID string) (*ReadTeamMemberResponse, diag.Diagnostics)
UpdateTeamMember(id string, params *UpdateTeamMemberRequest) (*UpdateTeamMemberResponse, diag.Diagnostics)
GetDataLake(filters []*Filter) (map[string]interface{}, diag.Diagnostics)
GetSchema(filters []*Filter) (map[string]interface{}, diag.Diagnostics)
}
type ReadCollectionResponse ¶
type ReadCollectionResponse struct {
ID string `json:"id"`
Token string `json:"token"`
Name string `json:"name"`
Notes string `json:"notes"`
Archived bool `json:"archived"`
SchemaID string `json:"schema_id"`
DatalakeID string `json:"datalake_id"`
EnvelopeType string `json:"envelope_type"`
EnvelopeRootMessage string `json:"envelope_root_message"`
PayloadRootMessage string `json:"payload_root_message"`
PayloadFieldID int `json:"payload_field_id"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
}
ReadCollectionResponse is used to unmarshal a read response from the API
type ReadTeamMemberResponse ¶
type ResponseError ¶
type ResponseError struct {
Code int `json:"code"`
Domain string `json:"domain"`
Status string `json:"status"`
RawError string `json:"raw_error"`
Message string `json:"message"`
Field string `json:"field"`
}
ResponseError is used to unmarshal an error response from our API
type UpdateCollectionRequest ¶
type UpdateCollectionResponse ¶
type UpdateCollectionResponse struct {
ID string `json:"id"`
Name string `json:"name"`
Notes string `json:"notes"`
SchemaID string `json:"schema_id"`
DatalakeID string `json:"datalake_id"`
EnvelopeType string `json:"envelope_type"`
EnvelopeRootMessage string `json:"envelope_root_message"`
PayloadRootMessage string `json:"payload_root_message"`
PayloadFieldID int `json:"payload_field_id"`
Paused bool `json:"paused"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
Archived bool `json:"archived"`
}
type UpdateTeamMemberRequest ¶
Source Files
¶
Click to show internal directories.
Click to hide internal directories.