sdk

type APIError ¶ added in v1.14.0

type APIError struct {
	StatusCode int
	Errors     *api.JSONErrors
}

APIError represents an error returned by the files API

func (e *APIError) Error() string

type Client ¶

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

Client is the SDK client for dp-files-api

func New(filesAPIURL, authToken string) *Client

func NewWithHealthClient(hcCli *health.Client, authToken string) *Client

func (c *Client) Checker(ctx context.Context, check *healthcheck.CheckState) error

func (c *Client) CreateFileEvent(ctx context.Context, event files.FileEvent) (*files.FileEvent, error)

func (c *Client) DeleteFile(ctx context.Context, filePath string) error

func (c *Client) GetFile(ctx context.Context, filePath string) (*files.StoredRegisteredMetaData, error)

func (c *Client) Health() *health.Client

func (c *Client) MarkFilePublished(ctx context.Context, filePath string) error

func (c *Client) URL() string

type Clienter ¶ added in v1.14.0

type Clienter interface {
	Checker(ctx context.Context, check *healthcheck.CheckState) error
	Health() *health.Client
	URL() string

	CreateFileEvent(ctx context.Context, event files.FileEvent) (*files.FileEvent, error)
	DeleteFile(ctx context.Context, filePath string) error
	GetFile(ctx context.Context, filePath string) (*files.StoredRegisteredMetaData, error)
	MarkFilePublished(ctx context.Context, filePath string) error
}

type Error ¶

type Error struct {
	Code        string `json:"code"`
	Description string `json:"description"`
}

Error represents a single error in the error response

type ErrorResponse ¶

type ErrorResponse struct {
	Errors []Error `json:"errors"`
}

ErrorResponse represents an error response from the API

type FilePatchRequest ¶ added in v1.14.0

type FilePatchRequest struct {
	api.StateMetadata
	ETag string `json:"etag,omitempty"`
}

FilePatchRequest represents the request payload for a PATCH request to "/files/{path:.*}" It includes StateMetadata and an optional ETag as some handlers require it