requests

package
v0.6.1 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2019 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConduitConnectRequest 

type ConduitConnectRequest struct {
	Client            string `json:"client"`
	ClientVersion     string `json:"clientVersion"`
	ClientDescription string `json:"clientDescription"`
	Host              string `json:"host"`
	User              string `json:"user"`
	AuthToken         string `json:"authToken"`
	AuthSignature     string `json:"authSignature"`
}

ConduitConnectRequest represents a request to conduit.connect.

type ConduitMetadata added in v0.2.0 

type ConduitMetadata struct {
	Scope         string `json:"scope,omitempty"`
	ConnectionID  string `json:"connectionID,omitempty"`
	AuthType      string `json:"auth.type,omitempty"`
	AuthHost      string `json:"auth.host,omitempty"`
	AuthKey       string `json:"auth.key,omitempty"`
	AuthUser      string `json:"auth.user,omitempty"`
	AuthSignature string `json:"auth.signature,omitempty"`
	Token         string `json:"token,omitempty"`
	AccessToken   string `json:"access_token,omitempty"`
	SessionKey    string `json:"sessionKey,omitempty"`
}

ConduitMetadata contains auth/API metadata included on Conduit requests.

type DifferentialGetCommitMessageRequest added in v0.5.0 

type DifferentialGetCommitMessageRequest struct {
	RevisionID uint64                                         `json:"revision_id"`
	Fields     []string                                       `json:"fields"`
	Edit       constants.DifferentialGetCommitMessageEditType `json:"edit"`
	Request
}

DifferentialGetCommitMessageRequest represents a request to the differential.getcommitmessage call.

type DifferentialGetCommitPathsRequest added in v0.4.1 

type DifferentialGetCommitPathsRequest struct {
	RevisionID uint64 `json:"revision_id"`
	Request
}

DifferentialGetCommitPathsRequest represents a request to the differential.getcommitpaths call.

type DifferentialQueryDiffsRequest added in v0.4.0 

type DifferentialQueryDiffsRequest struct {
	IDs         []uint64 `json:"ids"`
	RevisionIDs []uint64 `json:"revisionIDs"`
	Request
}

DifferentialQueryRequest represents a request to the differential.querydiffs call.

type DifferentialQueryRequest 

type DifferentialQueryRequest struct {
	Authors          []string                           `json:"authors"`
	CCs              []string                           `json:"ccs"`
	Reviewers        []string                           `json:"reviewers"`
	Paths            [][]string                         `json:"paths"`
	CommitHashes     [][]string                         `json:"commitHashes"`
	Status           constants.DifferentialStatusLegacy `json:"status"`
	Order            constants.DifferentialQueryOrder   `json:"order"`
	Limit            uint64                             `json:"limit"`
	Offset           uint64                             `json:"offset"`
	IDs              []uint64                           `json:"ids"`
	PHIDs            []string                           `json:"phids"`
	Subscribers      []string                           `json:"subscribers"`
	ResponsibleUsers []string                           `json:"responsibleUsers"`
	Branches         []string                           `json:"branches"`
	Request
}

DifferentialQueryRequest represents a request to the differential.query call.

type DiffusionQueryCommitsRequest 

type DiffusionQueryCommitsRequest struct {
	IDs            []uint64 `json:"ids"`
	PHIDs          []string `json:"phids"`
	Names          []string `json:"names"`
	RepositoryPHID string   `json:"repositoryPHID"`
	NeedMessages   bool     `json:"needMessages"`
	BypassCache    bool     `json:"bypassCache"`
	Before         string   `json:"before"`
	After          string   `json:"after"`
	Limit          uint64   `json:"limit"`
	Request
}

DiffusionQueryCommitsRequest represents a request to the diffusion.querycommits call.

type FileDownloadRequest 

type FileDownloadRequest struct {
	PHID string `json:"phid"`
	Request
}

FileDownloadRequest represents a call to file.download.

type MacroCreateMemeRequest 

type MacroCreateMemeRequest struct {
	MacroName string `json:"macroName"`
	UpperText string `json:"upperText"`
	LowerText string `json:"lowerText"`
	Request
}

MacroCreateMemeRequest represents a call to macro.creatememe.

type ManiphestCreateTaskRequest added in v0.2.0 

type ManiphestCreateTaskRequest struct {
	Title        string   `json:"title"`
	Description  string   `json:"description"`
	OwnerPHID    string   `json:"ownerPHID"`
	ViewPolicy   string   `json:"viewPolicy"`
	EditPolicy   string   `json:"editPolicy"`
	CCPHIDs      []string `json:"ccPHIDs"`
	Priority     int      `json:"priority"`
	ProjectPHIDs []string `json:"projectPHIDs"`
	Request
}

ManiphestCreateTaskRequest represents a request to maniphest.createtask.

type ManiphestGetTaskTransactions added in v0.3.0 

type ManiphestGetTaskTransactions struct {
	IDs []string `json:"ids"`
	Request
}

ManiphestGetTaskTransactions represents a request to maniphest.gettasktransactions.

type ManiphestQueryRequest 

type ManiphestQueryRequest struct {
	IDs          []string                      `json:"ids"`
	PHIDs        []string                      `json:"phids"`
	OwnerPHIDs   []string                      `json:"ownerPHIDs"`
	AuthorPHIDs  []string                      `json:"authorPHIDs"`
	ProjectPHIDs []string                      `json:"projectPHIDs"`
	CCPHIDs      []string                      `json:"ccPHIDs"`
	FullText     string                        `json:"fullText"`
	Status       constants.ManiphestTaskStatus `json:"status"`
	Order        constants.ManiphestQueryOrder `json:"order"`
	Limit        uint64                        `json:"limit"`
	Offset       uint64                        `json:"offset"`
	Request
}

ManiphestQueryRequest represents a request to maniphest.query.

type ManiphestRequestSearchOrder added in v0.3.3 

type ManiphestRequestSearchOrder struct {
	// Builtin is the name of predefined order to use.
	Builtin string
	// Order is list of columns to use for sorting, e.g. ["color", "-name", "id"],
	Order []string
}

ManiphestRequestSearchOrder describers how results should be ordered.

func (*ManiphestRequestSearchOrder) MarshalJSON added in v0.3.3 

func (o *ManiphestRequestSearchOrder) MarshalJSON() ([]byte, error)

MarshalJSON creates JSON our of ManiphestRequestSearchOrder instance.

func (*ManiphestRequestSearchOrder) UnmarshalJSON added in v0.3.3 

func (o *ManiphestRequestSearchOrder) UnmarshalJSON(data []byte) error

UnmarshalJSON parses JSON into an instance of ManiphestRequestSearchOrder type.

type ManiphestSearchAttachments added in v0.3.3 

type ManiphestSearchAttachments struct {
	// Subscribers if true instructs server to return subscribers list for each task.
	Subscribers bool `json:"subscribers,omitempty"`
	// Columns requests to get the workboard columns where an object appears.
	Columns bool `json:"columns,omitempty"`
	// Projects requests to get information about projects.
	Projects bool `json:"projects,omitempty"`
}

ManiphestSearchAttachments contains fields that specify what additional data should be returned with search results.

type ManiphestSearchConstraints added in v0.3.3 

type ManiphestSearchConstraints struct {
	// IDs - search for objects with specific IDs.
	IDs []int `json:"ids,omitempty"`
	// PHIDs - search for objects with specific PHIDs.
	PHIDs []string `json:"phids,omitempty"`
	// AssignedTo - search for tasks owned by a user from a list.
	AssignedTo []string `json:"assigned,omitempty"`
	// Authors - search for tasks with given authors.
	Authors []string `json:"authorPHIDs,omitempty"`
	// Statuses - search for tasks with given statuses.
	Statuses []string `json:"statuses,omitempty"`
	// Priorities - search for tasks with given priorities.
	Priorities []int `json:"priorities,omitempty"`
	// Subtypes - search for tasks with given subtypes.
	Subtypes []string `json:"subtypes,omitempty"`
	// Column PHIDs ??? - no doc on phab site.
	ColumnPHIDs []string `json:"columnPHIDs,omitempty"`
	// OpenParents - search for tasks that have parents in open state.
	OpenParents *bool `json:"hasParents,omitempty"`
	// OpenSubtasks - search for tasks that have child tasks in open state.
	OpenSubtasks *bool `json:"hasSubtasks,omitempty"`
	// ParentIDs - search for children of these parents.
	ParentIDs []int `json:"parentIDs,omitempty"`
	// SubtaskIDs - Search for tasks that have these children.
	SubtaskIDs []int `json:"subtaskIDs,omitempty"`
	// CreatedAfter - search for tasks created after given date.
	CreatedAfter *util.UnixTimestamp `json:"createdStart,omitempty"`
	// CreatedBefore - search for tasks created before given date.
	CreatedBefore *util.UnixTimestamp `json:"createdEnd,omitempty"`
	// ModifiedAfter - search for tasks modified after given date.
	ModifiedAfter *util.UnixTimestamp `json:"modifiedStart,omitempty"`
	// ModifiedBefore - search for tasks modified before given date.
	ModifiedBefore *util.UnixTimestamp `json:"modifiedEnd,omitempty"`
	// ClosedAfter - search for tasks closed after given date.
	ClosedAfter *util.UnixTimestamp `json:"closedStart,omitempty"`
	// ClosedBefore - search for tasks closed before given date.
	ClosedBefore *util.UnixTimestamp `json:"closedEnd,omitempty"`
	// ClosedBy - search for tasks closed by people with given PHIDs.
	ClosedBy []string `json:"closerPHIDs,omitempty"`
	// Query - find objects matching a fulltext search query.
	Query string `json:"query,omitempty"`
	// Subscribers - search for objects with certain subscribers.
	Subscribers []string `json:"subscribers,omitempty"`
	// Projects - search for objects tagged with given projects.
	Projects []string `json:"projects,omitempty"`
	// Spaces - search for objects in certain spaces.
	Spaces []string `json:"spaces,omitempty"`
}

ManiphestSearchConstraints describes search criteria for request.

type ManiphestSearchRequest added in v0.3.3 

type ManiphestSearchRequest struct {
	// QueryKey is builtin or saved query to use. It is optional and sets initial constraints.
	QueryKey string `json:"queryKey,omitempty"`
	// Constraints contains additional filters for results. Applied on top of query if provided.
	Constraints *ManiphestSearchConstraints `json:"constraints,omitempty"`
	// Attachments specified what additional data should be returned with each result.
	Attachments *ManiphestSearchAttachments `json:"attachments,omitempty"`

	*entities.Cursor
	Request
}

ManiphestSearchRequest represents a request to maniphest.search API method.

type PHIDLookupRequest 

type PHIDLookupRequest struct {
	Names []string `json:"names"`
	Request
}

type PHIDQueryRequest 

type PHIDQueryRequest struct {
	PHIDs []string `json:"phids"`
	Request
}

type PasteCreateRequest 

type PasteCreateRequest struct {
	Content  string `json:"content"`  // required
	Title    string `json:"title"`    // optional
	Language string `json:"language"` // optional
	Request
}

PasteCreateRequest represents a request to paste.create.

type PasteQueryRequest 

type PasteQueryRequest struct {
	IDs         []uint64 `json:"ids"`         // optional
	PHIDs       []string `json:"phids"`       // optional
	AuthorPHIDs []string `json:"authorPHIDs"` // optional
	Offset      uint64   `json:"after"`       // optional
	Limit       uint64   `json:"limit"`       // optional
	Request
}

PasteQueryRequest represents a request to paste.query.

type PhrictionInfoRequest added in v0.3.0 

type PhrictionInfoRequest struct {
	Slug string `json:"slug"`
	Request
}

type ProjectQueryRequest 

type ProjectQueryRequest struct {
	IDs     []string                `json:"ids"`
	Names   []string                `json:"names"`
	PHIDs   []string                `json:"phids"`
	Slugs   []string                `json:"slugs"`
	Icons   []string                `json:"icons"`
	Colors  []string                `json:"colors"`
	Status  constants.ProjectStatus `json:"status"`
	Members []string                `json:"members"`
	Limit   uint64                  `json:"limit"`
	Offset  uint64                  `json:"offset"`
	Request
}

ProjectQueryRequest represents a request to project.query.

type RemarkupProcessRequest added in v0.3.0 

type RemarkupProcessRequest struct {
	Context  constants.RemarkupProcessContextType `json:"context"`
	Contents []string                             `json:"contents"`
	Request
}

RemarkupProcessQuery represents a request to project.query.

type RepositoryQueryRequest 

type RepositoryQueryRequest struct {
	IDs        []uint64 `json:"ids"`
	PHIDs      []string `json:"phids"`
	Callsigns  []string `json:"callsigns"`
	VCSTypes   []string `json:"vcsTypes"`
	RemoteURIs []string `json:"remoteURIs"`
	UUIDs      []string `json:"uuids"`
	Order      string   `json:"order"`
	Before     string   `json:"before"`
	After      string   `json:"after"`
	Limit      uint64   `json:"limit"`
	Request
}

RepositoryQueryRequest represents a request to the repository.query call.

type Request 

type Request struct {
	Metadata *ConduitMetadata `json:"__conduit__,omitempty"`
}

Request is the base request struct.

func (*Request) GetMetadata added in v0.2.0 

func (r *Request) GetMetadata() *ConduitMetadata

GetMetadata gets the inner Conduit metadata.

func (*Request) SetMetadata added in v0.2.0 

func (r *Request) SetMetadata(metadata *ConduitMetadata)

SetMetadata sets the inner Conduit metadata.

type RequestInterface added in v0.2.0 

type RequestInterface interface {
	GetMetadata() *ConduitMetadata
	SetMetadata(*ConduitMetadata)
}

RequestInterface describes a base Conduit request

type UserQueryRequest added in v0.3.0 

type UserQueryRequest struct {
	Usernames []string `json:"usernames"`
	Emails    []string `json:"emails"`
	RealNames []string `json:"realnames"`
	PHIDs     []string `json:"phids"`
	IDs       []string `json:"ids"`
	Offset    int      `json:"offset"`
	Limit     int      `json:"limit"`
	Request
}

UserQueryRequest represents a request to user.query.

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.