Documentation ¶
Index ¶
Constants ¶
View Source
const TRACKER_URL = "https://www.pivotaltracker.com/services/v5"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client can be used to communicate with the Tracker API.
func TestClient ¶
TestClient returns a new client explicitly meant for internal testing. This should not be used for production code.
func (*Client) MakeRequest ¶
func (*Client) Me ¶
Me returns information from the user's profile plus the list of projects to which the user has access.
func (*Client) WrapConnection ¶
func (client *Client) WrapConnection(wrapper internal.ConnectionWrapper)
WrapConnection wraps the current Client connection in the wrapper.
type Config ¶
type Config struct { // AppName is the name of the application/process using the client. AppName string // AppVersion is the version of the application/process using the client. AppVersion string // APIToken is the tracker API token to make requests with. APIToken string // Wrappers that apply to the client connection. Wrappers []internal.ConnectionWrapper // SkipSSLValidation will skip hostname validation when set to true. SkipSSLValidation bool }
Config allows the Client to be configured
type EmbeddedProject ¶
type Me ¶
type Me struct { // APIToken is a string that can be used as the API authentication token // (X-TrackerToken) to authenticate future API requests as being on behalf of // the current user. This field is read only. APIToken string `json:"api_token"` // Email is the authenticated user's email. This field is read only. Email string `json:"email"` // ID is the database id of the authenticated user. This field is read only. // This field is always returned. ID uint64 `json:"id"` // Name is the name of the authenticated user. This field is read only. Name string `json:"name"` // Projects is a list of the project(s) that the authenticated user is a // member of. This field is read only. Projects []EmbeddedProject `json:"projects"` // Username is the authenticated user's optional 'username' for login // purposes. This field is read only. Username string `json:"username"` }
Directories ¶
Path | Synopsis |
---|---|
internalfakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
Click to show internal directories.
Click to hide internal directories.