api

package

Go to main page

Versions in this module

v0

v0.4.1

Sep 30, 2026

v0.4.0

Sep 29, 2026

Changes in this version

type Client

+ Tokens TokenSource

+ func (c *Client) WithTokenSource(ts TokenSource) *Client

type RequestOption

+ func WithTokenRejection() RequestOption

+ type TokenSource interface

+ MaybeExpired func(token string) bool

+ Renew func(ctx context.Context, rejected string) (string, error)

+ Token func(ctx context.Context) (string, error)

v0.3.4

Sep 24, 2026

v0.3.3

Sep 24, 2026

Changes in this version

+ type RealtimeGrant struct

+ ExpiresAt time.Time

+ Grant string

+ func MintRealtimeGrant(ctx context.Context, c *Client) (*RealtimeGrant, error)

type RequestOption

+ func WithRedactedResponseLog() RequestOption

v0.3.2

Sep 21, 2026

Changes in this version

+ const PageOutlineTypeCanvas

+ const PageOutlineTypePage

+ const PageOutlineTypeRepeatable

+ func PageOutlineContent(editable map[string]any) any

type PageDocument

+ func PageCompactDocument(doc PageDocument) (PageDocument, error)

+ func PageProjectFields(doc PageDocument, fields []string) (PageDocument, error)

+ type PageOutlineEntry struct

+ Content any

+ Depth int

+ ID string

+ Label string

+ Path string

+ RawPath string

+ Repeatables int

+ Slug string

+ Type string

+ func PageOutline(doc PageDocument) []PageOutlineEntry

v0.3.1

Sep 11, 2026

Changes in this version

+ func FileRefCopyWarning(rawURL string) string

+ func PageETag(id, updatedAt string) (string, error)

+ func PageShapeWithSchema(doc PageDocument, schema *pagepath.Schema) any

+ func ParseNimbuCDNSiteShortID(rawURL string) (string, bool)

+ func ParseRelationIDs(value any) []string

+ func ResolveSiteShortID(ctx context.Context, client *Client) (string, error)

+ type Anchor struct

+ ID string

+ Set bool

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

+ type BatchOpError struct

+ Code string

+ Message string

+ type BatchOpResult struct

+ Error *BatchOpError

+ ID string

+ Index int

+ Path string

+ Status string

+ Warning string

+ type BatchOperation struct

+ After *Anchor

+ Op string

+ Path string

+ Value any

+ type BatchOptions struct

+ Atomic bool

+ ContentLocale string

+ IfMatch string

+ IncludeResult bool

+ type BatchResult struct

+ ETag string

+ Page json.RawMessage

+ Results []BatchOpResult

+ UpdatedAt string

type Client

+ func (c *Client) CreatePageDraftPreviewToken(ctx context.Context, pageID string) (*PageDraftPreviewToken, error)

+ func (c *Client) DeletePageDraft(ctx context.Context, pageID string) error

+ func (c *Client) GetPageDraft(ctx context.Context, pageID string, opts DraftOptions) (*PageDraft, error)

+ func (c *Client) GetPageItems(ctx context.Context, pageID, rawPath string) (*PageSubtree, error)

+ func (c *Client) GetPageSchema(ctx context.Context, pageID string) (*pagepath.Schema, error)

+ func (c *Client) PostPageBatch(ctx context.Context, pageID string, ops []BatchOperation, opts BatchOptions) (*BatchResult, error)

+ func (c *Client) PostPageDraft(ctx context.Context, pageID string, body any, opts DraftOptions) (*PageDraft, error)

+ func (c *Client) PostPageDraftBatch(ctx context.Context, pageID string, ops []BatchOperation, ...) (*DraftBatchResult, error)

+ func (c *Client) PublishPageDraft(ctx context.Context, pageID string, confirm bool) (PageDocument, error)

+ type DraftBatchOptions struct

+ ContentLocale string

+ type DraftBatchResult struct

+ Draft json.RawMessage

+ Results []BatchOpResult

+ type DraftOptions struct

+ ContentLocale string

type Error

+ Raw map[string]any

+ func (e *Error) BatchResults() []BatchOpResult

+ func (e *Error) CurrentETag() string

+ type FileRefNormalizer struct

+ Client *Client

+ HTTPClient *http.Client

+ SiteShortID string

+ func (n *FileRefNormalizer) EnsureSiteShortID(ctx context.Context) (string, error)

+ func (n *FileRefNormalizer) NormalizeURL(ctx context.Context, rawURL string) (map[string]any, string, error)

type PageAttachmentExpansionOptions

+ Context context.Context

+ FileRef *FileRefNormalizer

+ Warn func(string)

+ type PageDraft struct

+ Content json.RawMessage

+ FuturePageID string

+ ID string

+ PageID string

+ ReservedFullpath string

+ UpdatedAt string

+ func (d *PageDraft) UnmarshalJSON(data []byte) error

+ func (d PageDraft) ContentMap() map[string]any

+ func (d PageDraft) MarshalJSON() ([]byte, error)

+ type PageDraftPreviewToken struct

+ PreviewURL string

+ Token string

+ type PageSubtree struct

+ Data json.RawMessage

+ ParentPath string

+ Path string

+ Position int

+ SiblingsCount int

+ Type string

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

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

+ type RelationIDs []string

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

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

+ type ResponseDecodeError struct

+ Body []byte

+ Err error

+ StatusCode int

+ func (e *ResponseDecodeError) Error() string

+ func (e *ResponseDecodeError) Unwrap() error

type Role

+ ChildrenExpanded bool

+ CustomersExpanded bool

+ ParentsExpanded bool

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

v0.3.0

Jul 31, 2026

Changes in this version

+ func DocumentValues[T any](documents []Document[T]) []T

+ func MenuNestingLost(submitted, returned MenuDocumentStats) bool

+ func ReconcileMenuDocument(current, desired MenuDocument)

+ type Document struct

+ Value T

+ func (d *Document[T]) UnmarshalJSON(data []byte) error

+ func (d Document[T]) MarshalJSON() ([]byte, error)

type MenuDocumentStats

+ HasItems bool

+ Shape string

+ type ShippingRate struct

+ Criteria any

+ Default bool

+ ID string

+ Name string

+ OrderMax any

+ OrderMin any

+ Pickup bool

+ Price any

+ RegionID string

+ Restricted bool

+ WeightMax any

+ WeightMin any

+ Zipcodes any

v0.2.6

Jul 27, 2026

Changes in this version

type App

+ InstallScopes []string

+ Internal bool

v0.2.5

Jul 9, 2026

Changes in this version

+ func NewUploadCreateFileRefPayload(sourceURI string) map[string]any

+ type AppLog struct

+ Context json.RawMessage

+ CreatedAt time.Time

+ Data json.RawMessage

+ ID string

+ Level string

+ Time float64

+ func ListAppLogs(ctx context.Context, client *Client, appKey string, opts AppLogOptions) ([]AppLog, error)

+ type AppLogOptions struct

+ Before string

+ Job string

+ Level string

+ Limit int

+ Query string

+ Since string

v0.2.4

Jun 23, 2026

Changes in this version

+ func ExpandPageAttachmentPathsWithOptions(doc PageDocument, opts PageAttachmentExpansionOptions) error

+ func NormalizePageDocumentForWrite(doc PageDocument)

+ func PageCanvasRepeatableCounts(doc PageDocument) map[string]int

+ func PageCanvasRepeatableInstanceCounts(doc PageDocument) map[string]int

+ func PageShape(doc PageDocument) any

type MenuDocument

+ func PostMenuDocument(ctx context.Context, c *Client, doc MenuDocument, opts ...RequestOption) (MenuDocument, error)

+ type PageAttachmentExpansionOptions struct

+ AllowEmptyFile bool

+ DropEmptyFile bool

+ DropReadOnlyFileURL bool

type RequestOption

+ func WithReplace(replace bool) RequestOption

v0.2.3

Jun 13, 2026

Changes in this version

+ func DeleteChannel(ctx context.Context, c *Client, slug string, opts ...RequestOption) error

type ChannelDetail

+ RSSDescription string

+ RSSDescriptionField string

+ RSSTitle string

+ RSSTitleField string

+ func CreateChannel(ctx context.Context, c *Client, payload any, opts ...RequestOption) (ChannelDetail, error)

type PagedResponse

+ func (p *PagedResponse[T]) HasMore(perPage, collected int) bool

v0.2.2

Jun 12, 2026

v0.2.1

May 26, 2026

Changes in this version

type Client

+ Readonly bool

+ func (c *Client) WithReadonly(readonly bool) *Client

+ type ReadonlyError struct

+ Method string

+ Path string

+ func (e *ReadonlyError) Error() string

v0.2.0

Apr 30, 2026

v0.1.15

Apr 30, 2026

v0.1.14

Apr 30, 2026

Changes in this version

type ChannelDetail

+ func PatchChannelCustomizations(ctx context.Context, c *Client, slug string, fields any, replace bool, ...) (ChannelDetail, error)

type CustomField

+ func GetChannelCustomizations(ctx context.Context, c *Client, slug string, opts ...RequestOption) ([]CustomField, error)

v0.1.13

Apr 28, 2026

Changes in this version

+ func NewUploadCreatePayload(filename string, content []byte, contentType string) map[string]any

v0.1.12

Apr 24, 2026

v0.1.11

Apr 23, 2026

v0.1.10

Apr 23, 2026

v0.1.9

Apr 22, 2026

v0.1.8

Apr 22, 2026

v0.1.7

Apr 22, 2026

Changes in this version

type Entry

+ Extra map[string]any

+ func (e *Entry) UnmarshalJSON(data []byte) error

+ func (e Entry) MarshalJSON() ([]byte, error)

type RequestOption

+ func WithContentLocale(locale string) RequestOption

v0.1.6

Mar 31, 2026

v0.1.5

Mar 24, 2026

v0.1.4

Mar 23, 2026

Changes in this version

+ type ActionStatus struct

+ Domain string

+ Message string

+ Paid bool

+ Primary bool

+ State string

+ Status string

type Client

+ Version string

+ func (c *Client) WithVersion(version string) *Client

+ type Domain struct

+ CreatedAt time.Time

+ DNSCheck bool

+ DefaultCountry string

+ DefaultLocale string

+ Domain string

+ ID string

+ Primary bool

+ RedirectDomain string

+ SSLEnabled bool

+ UpdatedAt time.Time

+ type SenderDNSRecord struct

+ Description string

+ Host string

+ Name string

+ Priority int

+ Required bool

+ TTL int

+ Type string

+ Value string

+ type SenderDomain struct

+ CreatedAt time.Time

+ DNSRecords []SenderDNSRecord

+ Domain string

+ ExpectedTXTRecord string

+ ID string

+ LastCheckAt *time.Time

+ LastCheckError string

+ OwnershipVerified bool

+ OwnershipVerifiedAt *time.Time

+ Provider string

+ Status string

+ UpdatedAt time.Time

+ VerifiedAt *time.Time

v0.1.3

Mar 23, 2026

v0.1.2

Mar 19, 2026

Changes in this version

type Theme

+ Short string

v0.1.1

Mar 14, 2026

Changes in this version

+ var ErrForbidden = errors.New("forbidden")

+ var ErrNotFound = errors.New("not found")

+ var ErrRateLimit = errors.New("rate limit exceeded")

+ var ErrUnauthorized = errors.New("unauthorized")

+ func Count(ctx context.Context, c *Client, path string, opts ...RequestOption) (int, error)

+ func CreateCustomerCustomizations(ctx context.Context, c *Client, fields any, opts ...RequestOption) error

+ func CreateProductCustomizations(ctx context.Context, c *Client, fields any, opts ...RequestOption) error

+ func DownloadPageAssets(ctx context.Context, c *Client, doc PageDocument, dir string) (int, []string, error)

+ func ExpandPageAttachmentPaths(doc PageDocument) error

+ func IsForbidden(err error) bool

+ func IsNotFound(err error) bool

+ func IsRateLimit(err error) bool

+ func IsUnauthorized(err error) bool

+ func List[T any](ctx context.Context, c *Client, path string, opts ...RequestOption) ([]T, error)

+ func MenuDocumentHandle(doc MenuDocument) string

+ func MenuDocumentHasItems(doc MenuDocument) bool

+ func MenuDocumentName(doc MenuDocument) string

+ func MenuDocumentSlug(doc MenuDocument) string

+ func NormalizeMenuDocumentForWrite(doc MenuDocument)

+ func NormalizePageFullpath(fullpath string) string

+ func PageDocumentFullpath(doc PageDocument) string

+ func PageDocumentLocale(doc PageDocument) string

+ func PageDocumentParentPath(doc PageDocument) string

+ func PageDocumentPublished(doc PageDocument) bool

+ func PageDocumentTemplate(doc PageDocument) string

+ func PageDocumentTitle(doc PageDocument) string

+ func PageEditableFile(editable map[string]any) map[string]any

+ func ReplaceCustomerCustomizations(ctx context.Context, c *Client, fields any, opts ...RequestOption) error

+ func ReplaceProductCustomizations(ctx context.Context, c *Client, fields any, opts ...RequestOption) error

+ func WalkPageEditables(doc PageDocument, fn func(name string, editable map[string]any) error) error

+ type Account struct

+ CreatedAt time.Time

+ ID string

+ Locale string

+ Name string

+ Owner string

+ Plan string

+ SKUCount int

+ SiteCount int

+ Sites []string

+ StorageCount int

+ URL string

+ UpdatedAt time.Time

+ UsersCount int

+ type App struct

+ CallbackURL string

+ Callbacks []AppCallback

+ CreatedAt time.Time

+ Domain string

+ Functions []AppFunction

+ Jobs []AppJob

+ Key string

+ Name string

+ Routes []AppRoute

+ SDKVersion string

+ Schedules []AppSchedule

+ URL string

+ UpdatedAt time.Time

+ type AppCallback struct

+ Event string

+ SHA string

+ Type string

+ URL string

+ UpdatedAt time.Time

+ type AppCodeFile struct

+ Code string

+ CreatedAt time.Time

+ Name string

+ URL string

+ UpdatedAt time.Time

+ type AppFunction struct

+ Name string

+ SHA string

+ type AppJob struct

+ Every string

+ Name string

+ SHA string

+ UpdatedAt time.Time

+ type AppRoute struct

+ Constraints map[string]any

+ Order int

+ Path string

+ SHA string

+ UpdatedAt time.Time

+ Verb string

+ type AppSchedule struct

+ Cron string

+ Data map[string]any

+ Name string

+ SHA string

+ Timing string

+ UpdatedAt time.Time

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

+ type AuthResponse struct

+ Token string

+ User User

+ type Blog struct

+ CreatedAt time.Time

+ Handle string

+ ID string

+ Name string

+ Slug string

+ UpdatedAt time.Time

+ func (b *Blog) UnmarshalJSON(data []byte) error

+ type BlogPost struct

+ Author string

+ CreatedAt time.Time

+ ID string

+ Slug string

+ Status string

+ TextContent string

+ Title string

+ UpdatedAt time.Time

+ type Channel struct

+ CreatedAt time.Time

+ Description string

+ EntryCount *int

+ ID string

+ Name string

+ Slug string

+ UpdatedAt time.Time

+ func (c *Channel) UnmarshalJSON(data []byte) error

+ type ChannelDependencyGraph struct

+ func BuildChannelDependencyGraph(channels []ChannelDetail) ChannelDependencyGraph

+ func (g ChannelDependencyGraph) DirectDependants(slug string) []string

+ func (g ChannelDependencyGraph) DirectDependencies(slug string) []string

+ func (g ChannelDependencyGraph) HasCircularDependencies(slug string) bool

+ func (g ChannelDependencyGraph) TransitiveDependants(slug string) []string

+ func (g ChannelDependencyGraph) TransitiveDependencies(slug string) []string

+ type ChannelDetail struct

+ ACL map[string]any

+ Customizations []CustomField

+ Description string

+ EntriesURL string

+ ID string

+ LabelField string

+ Name string

+ OrderBy string

+ OrderDirection string

+ RSSEnabled bool

+ Slug string

+ Submittable bool

+ SubmittableFieldIDs []string

+ TitleField string

+ URL string

+ func GetChannelDetail(ctx context.Context, c *Client, slug string, opts ...RequestOption) (ChannelDetail, error)

+ func ListChannelDetails(ctx context.Context, c *Client, opts ...RequestOption) ([]ChannelDetail, error)

+ type ChannelSummary = Channel

+ type Client struct

+ BaseURL string

+ Debug bool

+ HTTPClient *http.Client

+ Site string

+ Token string

+ func New(baseURL, token string) *Client

+ func (c *Client) Delete(ctx context.Context, path string, result any, opts ...RequestOption) error

+ func (c *Client) DownloadURL(ctx context.Context, rawURL string) (*http.Response, string, error)

+ func (c *Client) Get(ctx context.Context, path string, result any, opts ...RequestOption) error

+ func (c *Client) Patch(ctx context.Context, path string, body any, result any, opts ...RequestOption) error

+ func (c *Client) Post(ctx context.Context, path string, body any, result any, opts ...RequestOption) error

+ func (c *Client) Put(ctx context.Context, path string, body any, result any, opts ...RequestOption) error

+ func (c *Client) RawRequest(ctx context.Context, method, path string, body any, opts ...RequestOption) (*http.Response, error)

+ func (c *Client) Request(ctx context.Context, method, path string, body any, result any, ...) error

+ func (c *Client) SimulatorRender(ctx context.Context, payload SimulatorPayload) (*SimulatorResponse, error)

+ func (c *Client) WithDebug(debug bool) *Client

+ func (c *Client) WithSite(site string) *Client

+ func (c *Client) WithTimeout(timeout time.Duration) *Client

+ type Collection struct

+ CreatedAt time.Time

+ Description string

+ FeaturedImage *CollectionImage

+ Fullpath string

+ ID string

+ Images []CollectionImage

+ Name string

+ Priority int

+ ProductCount int

+ SEODescription string

+ SEOKeywords string

+ SEOTitle string

+ Slug string

+ Status string

+ Translations map[string]map[string]any

+ Type string

+ URL string

+ UpdatedAt time.Time

+ type CollectionImage struct

+ ContentType string

+ Height int

+ ID string

+ Position int

+ Size int64

+ URL string

+ Width int

+ type Coupon struct

+ Code string

+ CollectionIDs []string

+ Constraints string

+ CouponAmount float64

+ CouponPercentage float64

+ CouponType string

+ CreatedAt time.Time

+ CustomerSpecific bool

+ Customers []map[string]any

+ Description string

+ ID string

+ Lifespan string

+ LifespanAmount int

+ LifespanTime string

+ Name string

+ ProductTypeIDs []string

+ Reason string

+ Redemptions []map[string]any

+ Referral map[string]any

+ Referrer map[string]any

+ RequiredAmount int

+ RequiredValue float64

+ Requirements string

+ Start string

+ StartType string

+ State string

+ UpdatedAt time.Time

+ type CustomField struct

+ CalculatedExpression string

+ CalculationType string

+ Encrypted bool

+ Extra map[string]any

+ GeoType string

+ Hint string

+ ID string

+ Label string

+ Localized bool

+ Name string

+ PrivateStorage bool

+ Reference string

+ Required bool

+ RequiredExpression string

+ SelectOptions []SelectOption

+ Type string

+ Unique bool

+ func GetCustomerCustomizations(ctx context.Context, c *Client, opts ...RequestOption) ([]CustomField, error)

+ func GetProductCustomizations(ctx context.Context, c *Client, opts ...RequestOption) ([]CustomField, error)

+ func (f *CustomField) UnmarshalJSON(data []byte) error

+ func (f CustomField) IsRelational() bool

+ func (f CustomField) MarshalJSON() ([]byte, error)

+ type Customer struct

+ CreatedAt time.Time

+ Email string

+ FirstName string

+ ID string

+ LastName string

+ Phone string

+ UpdatedAt time.Time

+ func (c *Customer) UnmarshalJSON(data []byte) error

+ type Entry struct

+ Body string

+ CreatedAt time.Time

+ Fields map[string]any

+ ID string

+ Locale string

+ Position int

+ Published bool

+ Slug string

+ Title string

+ UpdatedAt time.Time

+ type Error struct

+ Code string

+ Details map[string]any

+ Err error

+ Errors []ValidationError

+ Message string

+ StatusCode int

+ func (e *Error) Error() string

+ func (e *Error) IsForbidden() bool

+ func (e *Error) IsNotFound() bool

+ func (e *Error) IsRateLimit() bool

+ func (e *Error) IsUnauthorized() bool

+ func (e *Error) IsValidation() bool

+ func (e *Error) Unwrap() error

+ type JobRunResult struct

+ JID string

+ type Links struct

+ First string

+ Last string

+ Next string

+ Prev string

+ func ParseLinks(header string) Links

+ func (l Links) HasNext() bool

+ type LoginRequest struct

+ Description string

+ ExpiresIn int

+ type Menu struct

+ CreatedAt time.Time

+ Handle string

+ ID string

+ Items []MenuItem

+ Name string

+ Slug string

+ UpdatedAt time.Time

+ func (m *Menu) UnmarshalJSON(data []byte) error

+ type MenuDocument map[string]any

+ func GetMenuDocument(ctx context.Context, c *Client, identifier string, opts ...RequestOption) (MenuDocument, error)

+ func PatchMenuDocument(ctx context.Context, c *Client, slug string, doc MenuDocument, ...) (MenuDocument, error)

+ func SelectMenuDocument(menus []MenuDocument, identifier string) (MenuDocument, bool)

+ type MenuDocumentStats struct

+ ItemCount int

+ MaxDepth int

+ func MenuStats(doc MenuDocument) MenuDocumentStats

+ type MenuItem struct

+ Children []MenuItem

+ ID string

+ Position int

+ Target string

+ Title string

+ URL string

+ type MenuSummary = Menu

+ type Notification struct

+ CreatedAt time.Time

+ Description string

+ HTML string

+ HTMLEnabled bool

+ ID string

+ Name string

+ Slug string

+ Subject string

+ Text string

+ Translations map[string]map[string]any

+ URL string

+ UpdatedAt time.Time

+ type OperationClass string

+ const OperationDestructive

+ const OperationMutate

+ const OperationRead

+ type Order struct

+ CreatedAt time.Time

+ Currency string

+ CustomerID string

+ ID string

+ Number string

+ Status string

+ Total float64

+ UpdatedAt time.Time

+ func (o *Order) UnmarshalJSON(data []byte) error

+ type Page struct

+ CreatedAt time.Time

+ Fields map[string]any

+ Fullpath string

+ ID string

+ Locale string

+ Parent string

+ ParentPath string

+ Published bool

+ Slug string

+ Template string

+ Title string

+ UpdatedAt time.Time

+ type PageDocument map[string]any

+ func GetPageDocument(ctx context.Context, c *Client, fullpath string, opts ...RequestOption) (PageDocument, error)

+ func PatchPageDocument(ctx context.Context, c *Client, fullpath string, doc PageDocument, ...) (PageDocument, error)

+ type PageDocumentStats struct

+ AttachmentCount int

+ EditableCount int

+ func PageStats(doc PageDocument) PageDocumentStats

+ type PageSummary = Page

+ type PagedResponse struct

+ Data []T

+ Links Links

+ Pagination Pagination

+ func ListPage[T any](ctx context.Context, c *Client, path string, page, perPage int, ...) (*PagedResponse[T], error)

+ type Pagination struct

+ Page int

+ PerPage int

+ Total int

+ TotalKnown bool

+ TotalPages int

+ type Product struct

+ CreatedAt time.Time

+ Currency string

+ CurrentStock int

+ Description string

+ Digital bool

+ ID string

+ Inventory int

+ KeepStock bool

+ Name string

+ OnSale bool

+ OnSalePrice float64

+ Price float64

+ Published bool

+ RequiresShipping bool

+ SKU string

+ Slug string

+ Status string

+ URL string

+ UpdatedAt time.Time

+ VariantsEnabled bool

+ func (p *Product) UnmarshalJSON(data []byte) error

+ type Redirect struct

+ CreatedAt time.Time

+ ID string

+ Source string

+ Target string

+ URL string

+ UpdatedAt time.Time

+ type RequestBody struct

+ ContentLength int64

+ ContentType string

+ GetBody func() (io.ReadCloser, error)

+ Reader io.Reader

+ type RequestOption func(*requestOptions)

+ func WithFields(fields string) RequestOption

+ func WithHeader(key, value string) RequestOption

+ func WithIdempotent(idempotent bool) RequestOption

+ func WithInclude(include string) RequestOption

+ func WithLocale(locale string) RequestOption

+ func WithOperationClass(class OperationClass) RequestOption

+ func WithPage(page, perPage int) RequestOption

+ func WithParam(key, value string) RequestOption

+ func WithQuery(params map[string]string) RequestOption

+ func WithSite(site string) RequestOption

+ type RetryTransport struct

+ BaseDelay time.Duration

+ MaxRetries int

+ Transport http.RoundTripper

+ func NewRetryTransport(transport http.RoundTripper) *RetryTransport

+ func (t *RetryTransport) RoundTrip(req *http.Request) (*http.Response, error)

+ type Role struct

+ ACL map[string]any

+ Children []string

+ CreatedAt time.Time

+ Customers []string

+ Description string

+ ID string

+ Name string

+ Owner string

+ Parents []string

+ UpdatedAt time.Time

+ type SelectOption struct

+ ID string

+ Name string

+ Position int

+ Slug string

+ type SimulatorPayload struct

+ Simulator SimulatorRequest

+ type SimulatorRequest struct

+ Code string

+ Method string

+ Path string

+ Request SimulatorRequestContext

+ Version string

+ type SimulatorRequestContext struct

+ Body *string

+ Headers string

+ Host string

+ Method string

+ Params map[string]any

+ Port int

+ Query string

+ RawBody *string

+ type SimulatorResponse struct

+ Body string

+ Encoding string

+ Headers map[string]string

+ Status int

+ StatusCode int

+ func (r *SimulatorResponse) EffectiveStatus() int

+ type Site struct

+ CreatedAt time.Time

+ Description string

+ Domain string

+ ID string

+ Locales []string

+ Name string

+ Subdomain string

+ Timezone string

+ UpdatedAt time.Time

+ type Theme struct

+ Active bool

+ CDNBasePath string

+ CDNHost string

+ CDNRoot string

+ CreatedAt time.Time

+ ID string

+ Name string

+ SiteID string

+ SiteShortID string

+ ThemeShortID string

+ UpdatedAt time.Time

+ type ThemeFile struct

+ Path string

+ Size int64

+ Type string

+ UpdatedAt time.Time

+ type ThemeResource struct

+ ChangedLive bool

+ Code string

+ CreatedAt time.Time

+ Folder string

+ ID string

+ Name string

+ Path string

+ Permalink string

+ PublicURL string

+ URL string

+ UpdatedAt time.Time

+ type Token struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID string

+ Name string

+ Scopes []string

+ Token string

+ type Translation struct

+ Key string

+ Locale string

+ Value string

+ Values map[string]string

+ type Upload struct

+ CreatedAt time.Time

+ ID string

+ MimeType string

+ Name string

+ Size int64

+ URL string

+ UpdatedAt time.Time

+ func (u *Upload) UnmarshalJSON(data []byte) error

+ type User struct

+ Admin bool

+ CreatedAt time.Time

+ Email string

+ ID string

+ Name string

+ UpdatedAt time.Time

+ type ValidationError struct

+ Code string

+ Field string

+ Message string

+ type Webhook struct

+ Active bool

+ CreatedAt time.Time

+ Events []string

+ ID string

+ Secret string

+ TargetURL string

+ URL string

+ UpdatedAt time.Time

+ func (w *Webhook) UnmarshalJSON(data []byte) error

v0.1.0

Mar 11, 2026

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