bookmark.go

// This file was auto-generated by Fern from our API Definition.

package api

import (
	fmt "fmt"
	core "github.com/hookdeck/hookdeck-go-sdk/core"
	time "time"
)

type BookmarkCreateRequest struct {
	// ID of the event data to bookmark
	EventDataId string `json:"event_data_id" url:"-"`
	// ID of the associated connection
	WebhookId string `json:"webhook_id" url:"-"`
	// Descriptive name of the bookmark
	Label string `json:"label" url:"-"`
	// A unique, human-friendly name for the bookmark
	Name *core.Optional[string] `json:"name,omitempty" url:"-"`
}

type BookmarkListRequest struct {
	Id          []*string                   `json:"-" url:"id,omitempty"`
	Name        []*string                   `json:"-" url:"name,omitempty"`
	WebhookId   []*string                   `json:"-" url:"webhook_id,omitempty"`
	EventDataId []*string                   `json:"-" url:"event_data_id,omitempty"`
	Label       []*string                   `json:"-" url:"label,omitempty"`
	LastUsedAt  *time.Time                  `json:"-" url:"last_used_at,omitempty"`
	OrderBy     *BookmarkListRequestOrderBy `json:"-" url:"order_by,omitempty"`
	Dir         *BookmarkListRequestDir     `json:"-" url:"dir,omitempty"`
	Limit       *int                        `json:"-" url:"limit,omitempty"`
	Next        *string                     `json:"-" url:"next,omitempty"`
	Prev        *string                     `json:"-" url:"prev,omitempty"`
}

type BookmarkTriggerRequest struct {
	// Bookmark target
	Target *core.Optional[BookmarkTriggerRequestTarget] `json:"target,omitempty" url:"-"`
}

type BookmarkListRequestDir string

const (
	BookmarkListRequestDirAsc  BookmarkListRequestDir = "asc"
	BookmarkListRequestDirDesc BookmarkListRequestDir = "desc"
)

func NewBookmarkListRequestDirFromString(s string) (BookmarkListRequestDir, error) {
	switch s {
	case "asc":
		return BookmarkListRequestDirAsc, nil
	case "desc":
		return BookmarkListRequestDirDesc, nil
	}
	var t BookmarkListRequestDir
	return "", fmt.Errorf("%s is not a valid %T", s, t)
}

func (b BookmarkListRequestDir) Ptr() *BookmarkListRequestDir {
	return &b
}

type BookmarkListRequestOrderBy string

const (
	BookmarkListRequestOrderByCreatedAt BookmarkListRequestOrderBy = "created_at"
)

func NewBookmarkListRequestOrderByFromString(s string) (BookmarkListRequestOrderBy, error) {
	switch s {
	case "created_at":
		return BookmarkListRequestOrderByCreatedAt, nil
	}
	var t BookmarkListRequestOrderBy
	return "", fmt.Errorf("%s is not a valid %T", s, t)
}

func (b BookmarkListRequestOrderBy) Ptr() *BookmarkListRequestOrderBy {
	return &b
}

// Bookmark target
type BookmarkTriggerRequestTarget string

const (
	BookmarkTriggerRequestTargetHttp BookmarkTriggerRequestTarget = "http"
	BookmarkTriggerRequestTargetCli  BookmarkTriggerRequestTarget = "cli"
)

func NewBookmarkTriggerRequestTargetFromString(s string) (BookmarkTriggerRequestTarget, error) {
	switch s {
	case "http":
		return BookmarkTriggerRequestTargetHttp, nil
	case "cli":
		return BookmarkTriggerRequestTargetCli, nil
	}
	var t BookmarkTriggerRequestTarget
	return "", fmt.Errorf("%s is not a valid %T", s, t)
}

func (b BookmarkTriggerRequestTarget) Ptr() *BookmarkTriggerRequestTarget {
	return &b
}

type BookmarkUpdateRequest struct {
	// ID of the event data to bookmark
	EventDataId *core.Optional[string] `json:"event_data_id,omitempty" url:"-"`
	// ID of the associated connection
	WebhookId *core.Optional[string] `json:"webhook_id,omitempty" url:"-"`
	// Descriptive name of the bookmark
	Label *core.Optional[string] `json:"label,omitempty" url:"-"`
	// A unique, human-friendly name for the bookmark
	Name *core.Optional[string] `json:"name,omitempty" url:"-"`
}