prclient

type AcceptedError struct {
	// Raw contains the response body.
	Raw []byte
}

type BasicAuthTransport struct {
	Username string // PavedRoad username
	Password string // PavedRoad password
	OTP      string // one-time password for users with two-factor auth enabled

	// Transport is the underlying HTTP transport to use when making requests.
	// It will default to http.DefaultTransport if nil.
	Transport http.RoundTripper
}

type Client struct {

	// Base URL for API requests. Defaults to the public PavedRoad API, but can be
	// set to a domain endpoint to use with PavedRoad Enterprise. BaseURL should
	// always be specified with a trailing slash.
	BaseURL *url.URL

	// Base URL for uploading files.
	UploadURL *url.URL

	// User agent used when communicating with the PavedRoad API.
	UserAgent string

	// Services used for talking to different parts of the PavedRoad API.
	Token        *TokensService
	UserIdMapper *UserIdMappersService
	// contains filtered or unexported fields
}

type Error struct {
	Resource string `json:"resource"` // resource on which the error occurred
	Field    string `json:"field"`    // field on which the error occurred
	Code     string `json:"code"`     // validation error code
	Message  string `json:"message"`  // Message describing the error. Errors with Code == "custom" will always have this set.
}

type ErrorResponse struct {
	Response *http.Response // HTTP response that caused this error
	Message  string         `json:"message"` // error message
	Errors   []Error        `json:"errors"`  // more detail on individual errors
	// Block is only populated on certain types of errors such as code 451.
	Block *struct {
		Reason    string     `json:"reason,omitempty"`
		CreatedAt *Timestamp `json:"created_at,omitempty"`
	} `json:"block,omitempty"`
	// Most errors will also include a documentation_url field pointing
	// to some content that might help you resolve the error, see
	// TODO:(tbd)  https://developer.pavedroad.io/v3/#client-errors
	DocumentationURL string `json:"documentation_url,omitempty"`
}

type ListOptions struct {
	// For paginated result sets, page of results to retrieve.
	Page int `url:"page,omitempty"`

	// For paginated result sets, the number of results to include per page.
	PerPage int `url:"per_page,omitempty"`
}

type Metadata struct {
	Name      string   `json:"name"`
	Namespace string   `json:"namespace"`
	UID       string   `json:"uid"`
	Site      string   `json:"site"`
	EndPoint  string   `json:"endPoint"`
	Token     string   `json:"token"`
	Scope     []string `json:"scope"`
}

type RawOptions struct {
	Type RawType
}

type RawType uint8

type Response struct {
	*http.Response

	NextPage  int
	PrevPage  int
	FirstPage int
	LastPage  int
}

type Timestamp struct {
	time.Time
}

type Token struct {
	APIVersion string   `json:"apiVersion"`
	Kind       string   `json:"kind"`
	Metadata   Metadata `json:"metadata"`
	Created    string   `json:"created,ignoreempty"`
	Updated    string   `json:"updated"`
	Active     bool     `json:"active"`
}

type TokenListOptions struct {
	// ID of the last token seen
	Since int64 `url:"since,omitempty"`

	// Note: Pagination is powered exclusively by the Since parameter,
	// ListOptions.Page has no effect.
	// ListOptions.PerPage controls an undocumented PavedRoad API parameter.
	ListOptions
}

type TokensService service

type UploadOptions struct {
	Name      string `url:"name,omitempty"`
	Label     string `url:"label,omitempty"`
	MediaType string `url:"-"`
}

type UserIdMapper struct {
	APIVersion string `json:"apiVersion"`
	ObjVersion string `json:"objVersion"`
	Kind       string `json:"kind"`
	Credential string `json:"login"`
	UserUUID   string `json:"userUUID"`
	LoginCount int    `json:"loginCount"`
	Created    string `json:"created,ignoreempty"`
	Updated    string `json:"updated,ignoreempty"`
	Active     string `json:"active"`
}

type UserIdMapperListOptions struct {
	// ID of the last token seen
	Since int64 `url:"since,omitempty"`

	// Note: Pagination is powered exclusively by the Since parameter,
	// ListOptions.Page has no effect.
	// ListOptions.PerPage controls an undocumented PavedRoad API parameter.
	ListOptions
}

type UserIdMappersService service