hcloud

package module
v0.0.19 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 27, 2023 License: MIT Imports: 6 Imported by: 0

README

hcloud-sdk-go

This is the official go SDK for the helmut.cloud platform.
A more advanced documentation will follow.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddOrganizationMember added in v0.0.19 

type AddOrganizationMember struct {
	Email      string                 `json:"email,omitempty"`
	Permission OrganizationPermission `json:"permission,omitempty"`
}

type App added in v0.0.13 

type App struct {
	Id             string       `json:"_id,omitempty"`
	Name           string       `json:"name,omitempty"`
	Permissions    []Permission `json:"permissions,omitempty"`
	OrganizationId string       `json:"organizationId,omitempty"`
	CreatorId      string       `json:"creatorId,omitempty"`
	CreateDate     int          `json:"createDate,omitempty"` // UTC+0 unix timestamp
}

type AppPermission added in v0.0.13 

type AppPermission string
const (
	NONE    AppPermission = "NONE"
	READ    AppPermission = "READ"
	EXECUTE AppPermission = "EXECUTE"
	WRITE   AppPermission = "WRITE"
	MANAGE  AppPermission = "MANAGE"
	OWNER   AppPermission = "OWNER"
)

type AuditLog added in v0.0.9 

type AuditLog struct {
	Origin    string      `json:"origin"`
	Level     string      `json:"level"`
	Event     string      `json:"event"`
	Type      string      `json:"type"`
	User      string      `json:"user"`
	Timestamp int64       `json:"timestamp"`
	Message   interface{} `json:"message"`
}

type Client 

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

func New 

func New(config *Config) *Client

func (*Client) Delete 

func (c *Client) Delete(url string) (*http.Response, []byte, *ErrorResponse)

func (*Client) Get 

func (c *Client) Get(url string) (*http.Response, []byte, *ErrorResponse)

func (*Client) GetEndpoint 

func (c *Client) GetEndpoint(endpoint string) string

func (*Client) Patch added in v0.0.19 

func (c *Client) Patch(url string, payload interface{}) (*http.Response, []byte, *ErrorResponse)

func (*Client) Post 

func (c *Client) Post(url string, payload interface{}) (*http.Response, []byte, *ErrorResponse)

func (*Client) SetApi 

func (c *Client) SetApi(api string)

func (*Client) SetToken 

func (c *Client) SetToken(token string)

type Config added in v0.0.4 

type Config struct {
	Api   string
	Token string
}

type Cronjob added in v0.0.19 

type Cronjob struct {
	Id               string          `json:"_id,omitempty"`
	Enabled          bool            `json:"enabled,omitempty"`
	Name             string          `json:"name,omitempty"`
	Expression       string          `json:"expression,omitempty"`
	Target           string          `json:"targetUrl,omitempty"`
	Method           string          `json:"httpMethod,omitempty"`
	AcceptInvalidSSL bool            `json:"acceptInvalidSSL,omitempty"`
	Timezone         string          `json:"timezone,omitempty"`
	Creator          string          `json:"creatorId,omitempty"`
	CreateDate       int             `json:"createDate,omitempty"`
	ModifyDate       int             `json:"modifyDate,omitempty"`
	AppId            string          `json:"appId,omitempty"`
	OrganizationId   string          `json:"organizationId,omitempty"`
	Headers          []CronjobHeader `json:"headers,omitempty"`
	Body             string          `json:"body,omitempty"`
}

type CronjobHeader added in v0.0.19 

type CronjobHeader struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type ErrorResponse 

type ErrorResponse struct {
	Code    string `json:"code"`
	Error   string `json:"error"`
	Message string `json:"message"`
}

ErrorReponse holds a code and a message parsed from an error resposne from the helmut.cloud platform

func (*ErrorResponse) ToString added in v0.0.7 

func (e *ErrorResponse) ToString() string

type Event added in v0.0.13 

type Event struct {
	Id             string `json:"_id,omitempty"`
	Name           string `json:"name,omitempty"`
	AppId          string `json:"appId,omitempty"`
	OrganizationId string `json:"organizationId,omitempty"`
	CreatorId      string `json:"creatorId,omitempty"`
	CreateDate     int    `json:"createDate,omitempty"` // UTC+0 unix timestamp
}

type EventExecutionRequest added in v0.0.17 

type EventExecutionRequest struct {
	EventName     string `json:"eventName"`
	Target        string `json:"target"`
	Payload       StreamExecutionPayload
	Timeout       int  `json:"timeout"`
	WaitForResult bool `json:"waitForResult"`
}

type Login 

type Login struct {
	Email    string `json:"email"`
	Password string `json:"password"`
	Totp     string `json:"totp"`
}

type Organization 

type Organization struct {
	Id      string `json:"_id,omitempty"`
	Name    string `json:"name,omitempty"`
	Creator *User  `json:"creator,omitempty"`
	Company string `json:"company,omitempty"`
}

type OrganizationMember 

type OrganizationMember struct {
	Id             string                 `json:"_id,omitempty"`
	OrganizationId string                 `json:"organizationId,omitempty"`
	User           *User                  `json:"user,omitempty"`
	Permission     OrganizationPermission `json:"permission,omitempty"`
}

type OrganizationPermission added in v0.0.19 

type OrganizationPermission string
const (
	ORGANIZATION_READ   OrganizationPermission = "READ"
	ORGANIZATION_MANAGE OrganizationPermission = "MANAGE"
	ORGANIZATION_ADMIN  OrganizationPermission = "ADMIN"
	ORGANIZATION_OWNER  OrganizationPermission = "OWNER"
)

type PatchUser added in v0.0.19 

type PatchUser struct {
	Name                 string `json:"name,omitempty"`
	Email                string `json:"email,omitempty"`
	Company              string `json:"company,omitempty"`
	ActiveOrganizationId string `json:"activeOrganizationId,omitempty"`
}

type Permission added in v0.0.13 

type Permission struct {
	UserId     string        `json:"userId,omitempty"`
	Permission AppPermission `json:"permission,omitempty"`
}

func (Permission) String added in v0.0.13 

func (p Permission) String() string

type Register 

type Register struct {
	Name     string `json:"name"`
	Company  string `json:"company,omitempty"`
	Email    string `json:"email"`
	Password string `json:"password"`
}

type Stream added in v0.0.13 

type Stream struct {
	Id             string `json:"_id,omitempty"`
	Name           string `json:"name,omitempty"`
	EventId        string `json:"eventId,omitempty"`
	AppId          string `json:"appId,omitempty"`
	Order          int    `json:"order,omitempty"`
	OrganizationId string `json:"organizationId,omitempty"`
	CreatorId      string `json:"creatorId,omitempty"`
	CreateDate     int    `json:"createDate,omitempty"` // UTC+0 unix timestamp
}

type StreamExecutionPayload added in v0.0.19 

type StreamExecutionPayload struct {
	Type string `json:"type"`
	Data string `json:"data"`
}

type StreamExecutionRequest added in v0.0.13 

type StreamExecutionRequest struct {
	Target        string                 `json:"target"`
	Payload       StreamExecutionPayload `json:"payload"`
	Timeout       int                    `json:"timeout"`
	WaitForResult bool                   `json:"waitForResult"`
}

type StreamOrder added in v0.0.19 

type StreamOrder struct {
	StreamId string `json:"streamId"`
	Order    int    `json:"order"`
}

type Token 

type Token struct {
	Token string `json:"token"`
}

type User 

type User struct {
	Id                   string `json:"_id,omitempty"`
	Name                 string `json:"name,omitempty"`
	Email                string `json:"email,omitempty"`
	Company              string `json:"company,omitempty"`
	ActiveOrganizationId string `json:"activeOrganizationId,omitempty"`
}

type Version 

type Version struct {
	Version string `json:"version"`
}

func (Version) String 

func (v Version) String() string

type Webhook added in v0.0.19 

type Webhook struct {
	Id              string                 `json:"_id,omitempty"`
	Name            string                 `json:"name,omitempty"`
	Url             string                 `json:"url,omitempty"`
	Token           string                 `json:"token,omitempty"`
	Target          string                 `json:"target"`
	SecurityHeaders WebhookSecurityHeaders `json:"securityHeaders,omitempty"`
	AppId           string                 `json:"appId,omitempty"`
	EventId         string                 `json:"eventId,omitempty"`
	OrganizationId  string                 `json:"organizationId,omitempty"`
	CreatorId       string                 `json:"creatorId,omitempty"`
	CreateDate      int                    `json:"createDate,omitempty"` // UTC+0 unix timestamp
	ModifyDate      int                    `json:"modifyDate,omitempty"` // UTC+0 unix timestamp
}

type WebhookCreation added in v0.0.19 

type WebhookCreation struct {
	Name            string                 `json:"name"`
	Token           string                 `json:"token"`
	EventId         string                 `json:"eventId"`
	AppId           string                 `json:"appId"`
	Target          string                 `json:"target"`
	SecurityHeaders WebhookSecurityHeaders `json:"securityHeaders,omitempty"`
}

type WebhookLog added in v0.0.19 

type WebhookLog struct {
	Id                 string      `json:"_id,omitempty"`
	WebhookId          string      `json:"webhookId,omitempty"`
	AppId              string      `json:"appId,omitempty"`
	EventId            string      `json:"eventId,omitempty"`
	OrganizationId     string      `json:"organizationId,omitempty"`
	SourceIP           string      `json:"sourceIp,omitempty"`
	CompleteHeader     interface{} `json:"completeHeader,omitempty"`
	RequestBody        interface{} `json:"requestBody,omitempty"`
	ResponseBody       interface{} `json:"responseBody,omitempty"`
	ResponseStatusCode int         `json:"responseStatusCode,omitempty"`
	Timestamp          int         `json:"timestamp,omitempty"`  // UTC+0 unix timestamp
	CreateDate         int         `json:"createDate,omitempty"` // UTC+0 unix timestamp
	ModifyDate         int         `json:"modifyDate,omitempty"` // UTC+0 unix timestamp
}

type WebhookSecurityHeaders added in v0.0.19 

type WebhookSecurityHeaders map[string]string

Source Files

View all Source files

Directories

Path Synopsis
service
auditor
fuse
high5
idp
mailer

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.