public

package
v0.9.1 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2020 License: Apache-2.0 Imports: 0 Imported by: 0

README

DO NOT EDIT: The .go and .plush files in this folder are copied here from a protected location.

Pace API definition

Pace uses the Oto project to describe its API using Go (Golang) interfaces.

The definition can be found in the definition folder.

The Oto tooling combines the definition with the templates to generate simple API clients like the Go client library, and the Pace CLI tool.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddCommentRequest 

type AddCommentRequest struct {
	// OrgID is the ID of the org.
	// example: "your-org-id"
	OrgID string
	// TargetKind is the kind of item this comment is for.
	// Can be "card", "message", or "showcase".
	// example: "card"
	TargetKind string
	// TargetID is the ID of the target.
	// example: "123"
	TargetID string
	// Body is the markdown body of the comment.
	// example: "This is my **comment**"
	Body string
}

AddCommentRequest is the input object for AddComment.

type AddCommentResponse 

type AddCommentResponse struct {
	// Comment is the comment that was created.
	Comment Comment
}

AddCommentResponse is the output object for AddComment.

type Card 

type Card struct {
	// ID is the unique ID of the card within the org.
	// example: "123"
	ID string
	// CTime is the time this was created.
	// example: "2020-07-23T15:42:06.597897724Z"
	CTime string
	// MTime is the time this comment was last modified.
	// example: "2020-07-23T15:42:06.597897724Z"
	MTime string
	// TeamID is the ID of the team that this card belongs to.
	// example: "your-team-id"
	TeamID string
	// Slug is the URL slug for this card.
	// example: "this-is-my-card"
	Slug string
	// Title is the title of the card.
	// example: "This is my card"
	Title string
	// Status is the current status of the card.
	// example: "done"
	Status string
	// Author is the Person who created this card.
	Author Person
	// Body is the markdown body of this card.
	// example: "Hello from **Pace**."
	Body string
	// BodyHTML is the HTML rendering of the body of this card.
	// example: "<p>Hello from <strong>Pace</strong>."
	BodyHTML string
	// Tags is a list of tags associated with this card.
	// example: ["bug", "question"]
	Tags []string
	// TakenByCurrentUser indicates whether the current user has
	// taken this card or not.
	// example: true
	TakenByCurrentUser bool
	// TakenByPeople is a list of people who have taken responsibility
	// for this Card.
	TakenByPeople []Person
	// Files are the list of files that are attached to
	// this Card.
	Files []File
}

Card is a card in Pace.

type CardsService 

type CardsService interface {
	// GetCard gets a card.
	GetCard(GetCardRequest) GetCardResponse
	// CreateCard creates a new Card.
	CreateCard(CreateCardRequest) CreateCardResponse
	// UpdateCard updates the title and body of the card.
	UpdateCard(UpdateCardRequest) UpdateCardResponse
	// UpdateCardStatus updates a card's status.
	UpdateCardStatus(UpdateCardStatusRequest) UpdateCardStatusResponse
	// TakeCard takes responsibility for a card.
	// Can be undone with PutBackCard.
	TakeCard(TakeCardRequest) TakeCardResponse
	// PutBackCard removes a user from the list of responsbile users.
	// Undoes TakeCard.
	PutBackCard(PutBackCardRequest) PutBackCardResponse
	// DeleteCard deletes a card.
	DeleteCard(DeleteCardRequest) DeleteCardResponse
}

CardsService allows you to programmatically manage cards in Pace.

type Comment 

type Comment struct {
	// ID is the ID of the comment.
	// example: "5f19afce3979fb39"
	ID string
	// CTime is the time this was created.
	// example: "2020-07-23T15:42:06.597897724Z"
	CTime string
	// MTime is the time this comment was last modified.
	// example: "2020-07-23T15:42:06.597897724Z"
	MTime string
	// Body is the markdown body of the comment.
	// example: "Hello **Pace**"
	Body string
	// BodyHTML is the HTML formatted body of the comment.
	// example: "<p>Hello <strong>Pace</strong></p>"
	BodyHTML string
	// Author is the person who posted this comment.
	Author Person
}

Comment is a single comment in Pace.

type CommentsService 

type CommentsService interface {
	// AddComment adds a comment.
	AddComment(AddCommentRequest) AddCommentResponse
	// DeleteComment deletes a Comment.
	DeleteComment(DeleteCommentRequest) DeleteCommentResponse
}

CommentsService allows you to programmatically manage comments in Pace.

type CreateCardRequest 

type CreateCardRequest struct {
	// OrgID is the org ID in which to create the card.
	// example: "your-org-id"
	OrgID string
	// TeamID is the team ID in which to create the card.
	// example: "your-team-id"
	TeamID string
	// Title is the title of the card.
	// example: "This is my new card"
	Title string
	// ParentTargetKind is the kind of target to relate this card to (e.g. "card", "message", or "showcase")
	// example: "card"
	ParentTargetKind string
	// ParentTargetID is the ID of the item to relate this new card to.
	// example: "123"
	ParentTargetID string
}

CreateCardRequest is the input object for CreateCard.

type CreateCardResponse 

type CreateCardResponse struct {
	// Card is the card that was just created.
	Card Card
}

CreateCardResponse is the output object for CreateCard.

type DeleteCardRequest 

type DeleteCardRequest struct {
	// OrgID is the ID of your org.
	// example: "your-org-id"
	OrgID string
	// CardID is the ID of the card to delete.
	// example: "123"
	CardID string
}

DeleteCardRequest is the input object for DeleteCard.

type DeleteCardResponse 

type DeleteCardResponse struct{}

DeleteCardResponse is the output object for DeleteCard.

type DeleteCommentRequest 

type DeleteCommentRequest struct {
	// ID is the ID of the comment to delete.
	// example: "5f19afce3979fb39"
	ID string
	// OrgID is the ID of your org.
	// example: "your-org-id"
	OrgID string
	// TargetKind is the kind of target this Comment was made on.
	// Can be "card", "message", or "showcase".
	// Used to help identify the Comment.
	// example: "card"
	TargetKind string
	// TargetID is the ID of the target.
	// Used to help identify the Comment.
	// example: "123"
	TargetID string
}

DeleteCommentRequest is the input object for DeleteComment.

type DeleteCommentResponse 

type DeleteCommentResponse struct{}

DeleteCommentResponse is the output object for DeleteComment.

type File 

type File struct {
	// ID is the identifier for this file.
	// example: "5f19afce3979fb39"
	ID string
	// CTime is the time the file was uploaded.
	// example: "2020-07-23T15:42:06.597897724Z"
	CTime string
	// Name is the name of the file.
	// example: "filename.jpg"
	Name string
	// Path is the path of the file.
	// example: "/path/to/filename.jpg"
	Path string
	// ContentType is the type of the file.
	// example: "image/jpg"
	ContentType string
	// FileType is the type of file.
	// Can be "file", "video", "image", "audio" or "screenshare".
	// example: "image"
	FileType string
	// Size is the size of the file in bytes.
	// example: 65211
	Size int
	// DownloadURL URL which can be used to get the file.
	// example: "/d/path/to/filename.jpg"
	DownloadURL string
	// ThumbnailURL is an optional thumbnail URL for this file.
	// example: "/d/path/to/filename-thumbnail.jpg"
	ThumbnailURL string
	// Author is the person who uploaded the file.
	Author Person
}

File represents an attached file.

type GetCardRequest 

type GetCardRequest struct {
	// OrgID is the ID of the org.
	// example: "your-org-id"
	OrgID string
	// CardID is the ID of the card to get.
	// example: "123"
	CardID string
}

GetCardRequest is the input object for GetCard.

type GetCardResponse 

type GetCardResponse struct {
	// Card is the card.
	Card Card
}

GetCardResponse is the output object for GetCard.

type Person 

type Person struct {
	// ID is the ID of the Person.
	// example: "5f19afce3979fb39"
	ID string
	// Username is the Person's username within the org.
	// example: "mat"
	Username string
	// Name is the name of the Person.
	// example: "Mat Ryer"
	Name string
	// PhotoURL is the URL of a picture of this Person.
	// example: "https://pace.dev/public/people/matryer.png"
	PhotoURL string
}

Person is a human who uses Pace.

type PutBackCardRequest 

type PutBackCardRequest struct {
	// OrgID is the ID of your org.
	// example: "your-org-id"
	OrgID string
	// CardID is the ID of the card to unassign yourself from.
	// example: "123"
	CardID string
}

PutBackCardRequest is the input object for PutBackCard.

type PutBackCardResponse 

type PutBackCardResponse struct {
	// Card is the newly updated Card.
	Card Card
}

PutBackCardResponse is the output object for PutBackCard.

type TakeCardRequest 

type TakeCardRequest struct {
	// OrgID is the ID of your org.
	// example: "your-org-id"
	OrgID string
	// CardID is the ID of the card to assign yourself to.
	// example: "123"
	CardID string
}

TakeCardRequest is the input object for TakeCard.

type TakeCardResponse 

type TakeCardResponse struct {
	// Card is the newly updated Card.
	Card Card
}

TakeCardResponse is the output object for TakeCard.

type UpdateCardRequest 

type UpdateCardRequest struct {
	// OrgID is the ID of the org.
	// example: "your-org-id"
	OrgID string
	// CardID is the ID of the card to update.
	// example: "123"
	CardID string
	// Title is the new title for the card.
	// example: "New title"
	Title string
	// Body is the new markdown body for the card.
	// example: "I have been **updated**"
	Body string
}

UpdateCardRequest is the input object for UpdateCard.

type UpdateCardResponse 

type UpdateCardResponse struct {
	// Card is the recently updated Card.
	Card Card
}

UpdateCardResponse is the output object for UpdateCard.

type UpdateCardStatusRequest 

type UpdateCardStatusRequest struct {
	// OrgID is the ID of the org.
	// example: "your-org-id"
	OrgID string
	// CardID is the ID number of the card.
	// example: "123"
	CardID string
	// Status is the new status of the card.
	// Valid strings are "future", "next", "progress", "done".
	// example: "progress"
	Status string
}

UpdateCardStatusRequest is the input object UpdateCardStatus.

type UpdateCardStatusResponse 

type UpdateCardStatusResponse struct {
	// Card is the card that was updated.
	Card Card
}

UpdateCardStatusResponse is the output object for UpdateCardService.

Source Files

View all Source files

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.