vercel

package
v0.0.0-...-ff1469b Latest Latest
Warning

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

Go to latest
Published: Jul 6, 2023 License: MPL-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

func New

func New(logger zerolog.Logger, hc HTTPDoer, baseURL, token, teamID string, maxRetries, maxWait, pageSize int64) *Client

func (*Client) ListDeploymentChecks

func (v *Client) ListDeploymentChecks(ctx context.Context, deploymentId string, pag *Paginator) ([]DeploymentCheck, *Paginator, error)

func (*Client) ListDeployments

func (v *Client) ListDeployments(ctx context.Context, pag *Paginator) ([]Deployment, *Paginator, error)

func (*Client) ListDomainRecords

func (v *Client) ListDomainRecords(ctx context.Context, domainName string, pag *Paginator) ([]DomainRecord, *Paginator, error)

func (*Client) ListDomains

func (v *Client) ListDomains(ctx context.Context, pag *Paginator) ([]Domain, *Paginator, error)

func (*Client) ListProjectEnvs

func (v *Client) ListProjectEnvs(ctx context.Context, projectId string, pag *Paginator) ([]ProjectEnv, *Paginator, error)

func (*Client) ListProjects

func (v *Client) ListProjects(ctx context.Context, pag *Paginator) ([]Project, *Paginator, error)

func (*Client) ListTeamMembers

func (v *Client) ListTeamMembers(ctx context.Context, teamID string, pag *Paginator) ([]TeamMember, *Paginator, error)

func (*Client) ListTeams

func (v *Client) ListTeams(ctx context.Context, pag *Paginator) ([]Team, *Paginator, error)

func (*Client) Request

func (v *Client) Request(ctx context.Context, path string, until *int64, fill any) error

func (*Client) WithTeamID

func (v *Client) WithTeamID(teamID string) *Client

type Deployment

type Deployment struct {
	UID                 string     `json:"uid"`
	Name                string     `json:"name"`
	URL                 *string    `json:"url,omitempty"`
	Source              *string    `json:"source,omitempty"`
	State               *string    `json:"state,omitempty"`
	Type                string     `json:"type"`
	Creator             any        `json:"creator"`
	InspectorURL        string     `json:"inspectorUrl"`
	Meta                any        `json:"meta"`
	Target              any        `json:"target"`
	AliasError          any        `json:"aliasError"`
	AliasAssigned       any        `json:"aliasAssigned"`
	IsRollbackCandidate *bool      `json:"isRollbackCandidate,omitempty"`
	Ready               *MilliTime `json:"ready,omitempty"`
	ChecksState         *string    `json:"checksState,omitempty"`
	ChecksConclusion    *string    `json:"checksConclusion,omitempty"`

	// duplicate: Created             MilliTime       `json:"created"`
	CreatedAt  MilliTime `json:"createdAt"`
	BuildingAt MilliTime `json:"buildingAt"`
}

type DeploymentCheck

type DeploymentCheck struct {
	ID            string     `json:"id"`
	CreatedAt     MilliTime  `json:"createdAt"`
	CompletedAt   *MilliTime `json:"completedAt,omitempty"`
	Conclusion    *string    `json:"conclusion,omitempty"`
	DetailsURL    *string    `json:"detailsUrl,omitempty"`
	IntegrationID *string    `json:"integrationId,omitempty"`
	Name          *string    `json:"name,omitempty"`
	Output        any        `json:"output"`
	Path          *string    `json:"path,omitempty"`
	Rerequestable bool       `json:"rererequestable"`
	StartedAt     *MilliTime `json:"startedAt,omitempty"`
	UpdatedAt     *MilliTime `json:"updatedAt,omitempty"`
	Status        string     `json:"status"`
}

type Domain

type Domain struct {
	BoughtAt            *MilliTime `json:"boughtAt"`
	CdnEnabled          bool       `json:"cdnEnabled"`       // undocumented
	ConfigVerifiedAt    *MilliTime `json:"configVerifiedAt"` // undocumented
	CreatedAt           MilliTime  `json:"createdAt"`
	ExpiresAt           *MilliTime `json:"expiresAt"`
	ID                  string     `json:"id"`
	IntendedNameservers []string   `json:"intendedNameservers"`
	CustomNameservers   []string   `json:"customNameservers"`
	Name                string     `json:"name"`
	Nameservers         []string   `json:"nameservers"`
	NsVerifiedAt        *MilliTime `json:"nsVerifiedAt"` // undocumented
	OrderedAt           *MilliTime `json:"orderedAt"`
	Renew               bool       `json:"renew"`
	ServiceType         string     `json:"serviceType"`
	TransferStartedAt   *MilliTime `json:"transferStartedAt"`
	TransferredAt       *MilliTime `json:"transferredAt"`
	TxtVerifiedAt       *MilliTime `json:"txtVerifiedAt"`      // undocumented
	VerificationRecord  string     `json:"verificationRecord"` // undocumented
	Verified            bool       `json:"verified"`
	Zone                bool       `json:"zone"` // undocumented
	Creator             struct {
		CustomerID       *string `json:"customerId"`
		Email            string  `json:"email"`
		ID               string  `json:"id"`
		IsDomainReseller *bool   `json:"isDomainReseller"`
		Username         string  `json:"username"`
	} `json:"creator"`
}

type DomainRecord

type DomainRecord struct {
	ID         string `json:"id"`
	Slug       string `json:"slug"`
	Name       string `json:"name"`
	Type       string `json:"type"`
	Value      string `json:"value"`
	MxPriority *int64 `json:"mxPriority"`
	Priority   *int64 `json:"priority"`
	Creator    string `json:"creator"`
	// duplicate: Created    *MilliTime `json:"created"`
	// duplicate: Updated    *MilliTime `json:"updated"`
	CreatedAt *MilliTime `json:"createdAt"`
	UpdatedAt *MilliTime `json:"updatedAt"`
	TTL       int64      `json:"ttl"` // undocumented
}

type HTTPDoer

type HTTPDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type MemberSubAccount

type MemberSubAccount struct {
	AccountID *string `json:"accountId,omitempty"`
	Email     *string `json:"email,omitempty"`
	Login     *string `json:"login,omitempty"`
	UserID    *int64  `json:"userId,omitempty"`
}

type MilliTime

type MilliTime time.Time

func (*MilliTime) MarshalJSON

func (t *MilliTime) MarshalJSON() ([]byte, error)

func (*MilliTime) UnmarshalJSON

func (t *MilliTime) UnmarshalJSON(data []byte) error

type Paginator

type Paginator struct {
	Count int64  `json:"count"`
	Next  *int64 `json:"next"`
	Prev  *int64 `json:"prev"`
}

type Project

type Project struct {
	AccountID                       string     `json:"accountId"`
	Analytics                       any        `json:"analytics,omitempty"`
	AutoExposeSystemEnvs            bool       `json:"autoExposeSystemEnvs,omitempty"`
	BuildCommand                    *string    `json:"buildCommand,omitempty"`
	CommandForIgnoringBuildStep     *string    `json:"commandForIgnoringBuildStep,omitempty"`
	CreatedAt                       MilliTime  `json:"createdAt"`
	DevCommand                      *string    `json:"devCommand,omitempty"`
	DirectoryListing                bool       `json:"directoryListing"`
	Env                             []any      `json:"env"`
	Framework                       *string    `json:"framework,omitempty"`
	GitForkProtection               *bool      `json:"gitForkProtection,omitempty"`
	ID                              string     `json:"id"`
	InstallCommand                  *string    `json:"installCommand,omitempty"`
	Name                            string     `json:"name"`
	NodeVersion                     string     `json:"nodeVersion"`
	OutputDirectory                 *string    `json:"outputDirectory,omitempty"`
	PasswordProtection              any        `json:"passwordProtection"`
	PublicSource                    *bool      `json:"publicSource,omitempty"`
	RootDirectory                   *string    `json:"rootDirectory,omitempty"`
	ServerlessFunctionRegion        *string    `json:"serverlessFunctionRegion,omitempty"`
	SourceFilesOutsideRootDirectory *bool      `json:"sourceFilesOutsideRootDirectory,omitempty"`
	UpdatedAt                       MilliTime  `json:"updatedAt"`
	Live                            *bool      `json:"live,omitempty"`
	Link                            any        `json:"link"`
	LatestDeployments               []any      `json:"latestDeployments"`
	Targets                         any        `json:"targets"`
	TransferStartedAt               *MilliTime `json:"transferStartedAt"`
	TransferCompletedAt             *MilliTime `json:"transferCompletedAt"`
	TransferredFromAccountID        *string    `json:"transferredFromAccountId"`
}

type ProjectEnv

type ProjectEnv struct {
	ID                string     `json:"id"`
	Target            *string    `json:"target,omitempty"`
	Type              *string    `json:"type,omitempty"`
	Key               *string    `json:"key,omitempty"`
	Value             *string    `json:"value,omitempty"`
	ConfigurationId   *string    `json:"configurationId,omitempty"`
	GitBranch         *string    `json:"gitBranch,omitempty"`
	EdgeConfigId      *string    `json:"edgeConfigId,omitempty"`
	EdgeConfigTokenId *string    `json:"edgeConfigTokenId,omitempty"`
	Decrypted         *bool      `json:"decrypted,omitempty"`
	System            *bool      `json:"system,omitempty"`
	CreatedAt         MilliTime  `json:"createdAt"`
	CreatedBy         string     `json:"createdBy"`
	UpdatedAt         *MilliTime `json:"updatedAt,omitempty"`
	UpdatedBy         *string    `json:"updatedBy,omitempty"`
}

type Team

type Team struct {
	ID        string    `json:"id"`
	Slug      string    `json:"slug"`
	Name      *string   `json:"name"`
	Avatar    *string   `json:"avatar"`
	CreatedAt MilliTime `json:"createdAt"`

	Membership              any        `json:"membership"`
	EnablePreviewFeedback   any        `json:"enablePreviewFeedback"`
	CreatorID               string     `json:"creatorId"`
	UpdatedAt               *MilliTime `json:"updatedAt"`
	PlatformVersion         any        `json:"platformVersion"`
	Billing                 any        `json:"billing"`
	Description             any        `json:"description"`
	Profiles                []any      `json:"profiles"`
	StagingPrefix           string     `json:"stagingPrefix"`
	ResourceConfig          any        `json:"resourceConfig"`
	PreviewDeploymentSuffix any        `json:"previewDeploymentSuffix"`
	SoftBlock               any        `json:"softBlock"`
	RemoteCaching           any        `json:"remoteCaching"`
	EnabledInvoiceItems     any        `json:"enabledInvoiceItems"`
}

type TeamMember

type TeamMember struct {
	Avatar    *string           `json:"avatar"`
	Confirmed bool              `json:"confirmed"`
	Email     string            `json:"email"`
	Github    *MemberSubAccount `json:"github"`
	Gitlab    *MemberSubAccount `json:"gitlab"`
	Bitbucket *MemberSubAccount `json:"bitbucket"`

	Role     string  `json:"role"`
	UID      string  `json:"uid"`
	Username string  `json:"username"`
	Name     *string `json:"name"`

	CreatedAt         MilliTime  `json:"createdAt"`
	AccessRequestedAt *MilliTime `json:"accessRequestedAt"`
	JoinedFrom        any        `json:"joinedFrom"`
}

Jump to

Keyboard shortcuts

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