Documentation ¶
Overview ¶
Package parameters contains types that represent sets of parameters that are passed to the API.
Index ¶
- Constants
- type Avatar
- type Comparator
- type ContactIDSet
- type CopyFolder
- type CreateCustomField
- type CreateFolder
- type CreateGroup
- type CreateTask
- type CreateWorkflow
- type CustomField
- type CustomFieldFilter
- type CustomFieldIDSet
- type CustomFieldSet
- type CustomStatus
- type CustomStatusIDSet
- type DateOrRange
- type DateRange
- type FieldSet
- type FolderIDSet
- type GetFolderSubtree
- type GetFolderTree
- type GetFolders
- type Metadata
- type MetadataSet
- type ModifyAccount
- type ModifyContact
- type ModifyCustomField
- type ModifyFolder
- type ModifyFolders
- type ModifyGroup
- type ModifyTask
- type ModifyTasks
- type ModifyUser
- type ModifyWorkflow
- type Profile
- type Project
- type ProjectModify
- type QueryAccounts
- type QueryContacts
- type QueryGroup
- type QueryGroups
- type QueryTasks
- type QueryTasksByIDs
- type Settings
- type TaskDates
- type TaskEffort
- type TaskField
- type TaskFieldSet
- type TaskIDSet
- type TaskSortField
- type TaskSortOrder
- type TaskStatusSet
Constants ¶
const ( RecurrentField TaskField = "recurrent" AttachmentCountField TaskField = "attachmentCount" EffortAllocationField TaskField = "effortAllocation" AuthorIDsField TaskField = "authorIds" HasAttachmentsField TaskField = "hasAttachments" ParentIDsField TaskField = "parentIds" SuperParentIDsField TaskField = "superParentIds" ResponsibleIDsField TaskField = "responsibleIds" DescriptionField TaskField = "description" BriefDescriptionField TaskField = "briefDescription" SuperTaskIDsField TaskField = "superTaskIds" SubTaskIDsField TaskField = "subTaskIds" DependencyIDsField TaskField = "dependencyIds" MetadataField TaskField = "metadata" CustomFieldsField TaskField = "customFields" CreatedDateSortField TaskSortField = "CreatedDate" UpdatedDateSortField TaskSortField = "UpdatedDate" CompletedDateSortField TaskSortField = "CompletedDate" DueDateSortField TaskSortField = "DueDate" StatusSortField TaskSortField = "Status" ImportanceSortField TaskSortField = "Importance" TitleSortField TaskSortField = "Title" LastAccessDateSortField TaskSortField = "LastAccessDate" Asc TaskSortOrder = "Asc" Desc TaskSortOrder = "Desc" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Avatar ¶
func (*Avatar) EncodeValues ¶
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type Comparator ¶
type Comparator string
const ( EqualTo Comparator = "EqualTo" IsEmpty Comparator = "IsEmpty" IsNotEmpty Comparator = "IsNotEmpty" LessThan Comparator = "LessThan" LessOrEqualTo Comparator = "LessOrEqualTo" GreaterThan Comparator = "GreaterThan" GreaterOrEqualTo Comparator = "GreaterOrEqualTo" InRange Comparator = "InRange" NotInRange Comparator = "NotInRange" Contains Comparator = "Contains" StartsWith Comparator = "StartsWith" EndsWith Comparator = "EndsWith" ContainsAll Comparator = "ContainsAll" ContainsAny Comparator = "ContainsAny" )
type ContactIDSet ¶
func (ContactIDSet) EncodeValues ¶
func (ids ContactIDSet) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
func (ContactIDSet) ToSlice ¶
func (ids ContactIDSet) ToSlice() []string
type CopyFolder ¶
type CopyFolder struct { Parent types.FolderID `url:"parent"` Title string `url:"title"` TitlePrefix string `url:"titlePrefix,omitempty"` CopyDescriptions *bool `url:"copyDescriptions,omitempty"` CopyResponsibles *bool `url:"copyResponsibles,omitempty"` AddResponsibles ContactIDSet `url:"addResponsibles,omitempty"` RemoveResponsibles ContactIDSet `url:"removeResponsibles,omitempty"` CopyCustomFields *bool `url:"copyCustomFields,omitempty"` CopyCustomStatuses *bool `url:"copyCustomStatuses,omitempty"` CopyStatuses *bool `url:"copyStatuses,omitempty"` CopyParents *bool `url:"copyParents,omitempty"` RescheduleDate string `url:"rescheduleDate,omitempty"` RescheduleMode string `url:"rescheduleMode,omitempty"` EntryLimit *int `url:"entryLimit,omitempty"` }
CopyFolder contains parameters that will be passed to CopyFolder api.
type CreateCustomField ¶
type CreateCustomField struct { Title string `url:"title"` Type types.CustomFieldType `url:"type"` Settings *Settings `url:"settings,omitempty"` }
CreateCustomField contains parameters that will be passed to CreateCustomField API.
type CreateFolder ¶
type CreateFolder struct { Title string `url:"title"` Description string `url:"description,omitempty"` Metadata *MetadataSet `url:"metadata,omitempty"` CustomFields CustomFieldSet `url:"customFields,omitempty"` CustomColumns CustomFieldIDSet `url:"customColumns,omitempty"` Project Project `url:"project,omitempty"` }
type CreateGroup ¶
type CreateGroup struct { Title string `url:"title,omitempty"` Members ContactIDSet `url:"members,omitempty"` Parent *types.ContactID `url:"parent,omitempty"` Avatar *Avatar `url:"avatar,omitempty"` Metadata *MetadataSet `url:"metadata,omitempty"` }
CreateGroup contains parameters that will be passed to CreateGroup API.
type CreateTask ¶
type CreateTask struct { Title string `url:"title,omitempty"` Description *string `url:"description,omitempty"` Status TaskStatusSet `url:"status,omitempty"` Importance types.TaskImportance `url:"importance,omitempty"` Dates *TaskDates `url:"dates,omitempty"` Parents FolderIDSet `url:"parents,omitempty"` Responsibles ContactIDSet `url:"responsibles,omitempty"` Followers ContactIDSet `url:"followers,omitempty"` Follow *bool `url:"follow,omitempty"` PriorityBefore types.TaskID `url:"priorityBefore,omitempty"` PriorityAfter types.TaskID `url:"priorityAfter,omitempty"` SuperTasks TaskIDSet `url:"superTasks,omitempty"` Metadata *MetadataSet `url:"metadata,omitempty"` CustomFields CustomFieldSet `url:"customFields,omitempty"` CustomStatus types.CustomStatusID `url:"customStatus,omitempty"` EffortAllocation *TaskEffort `url:"effortAllocation,omitempty"` Fields TaskFieldSet `url:"fields,omitempty"` }
CreateTask contains parameters that will be passed to CreateTask API.
type CreateWorkflow ¶
type CreateWorkflow struct {
Name string `url:"name"`
}
CreateWorkflow contains parameters that will be passed to CreateWorkflow API.
type CustomField ¶
type CustomField struct { ID types.CustomFieldID `json:"id"` Value string `json:"value,omitempty"` }
func (*CustomField) EncodeValues ¶
func (f *CustomField) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type CustomFieldFilter ¶
type CustomFieldFilter struct { ID string `json:"id"` Comparator Comparator `json:"comparator,omitempty"` Value *string `json:"value,omitempty"` MinValue *string `json:"minValue,omitempty"` MaxValue *string `json:"maxValue,omitempty"` Values []string `json:"values,omitempty"` }
func (*CustomFieldFilter) EncodeValues ¶
func (f *CustomFieldFilter) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type CustomFieldIDSet ¶
type CustomFieldIDSet []types.CustomFieldID
func (CustomFieldIDSet) EncodeValues ¶
func (f CustomFieldIDSet) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type CustomFieldSet ¶
type CustomFieldSet []CustomField
func (CustomFieldSet) EncodeValues ¶
func (f CustomFieldSet) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type CustomStatus ¶
type CustomStatus struct { ID *types.CustomStatusID `json:"id,omitempty"` Name *string `json:"name,omitempty"` StandardName *bool `json:"standardName,omitempty"` Color *string `json:"color,omitempty"` Standard *bool `json:"standard,omitempty"` Group *string `json:"group,omitempty"` Hidden *bool `json:"hidden,omitempty"` }
CustomStatus contains custom status data to be added/modified. Note that the fields are pointers so it can properly ignore blank values.
func (*CustomStatus) EncodeValues ¶
func (cs *CustomStatus) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type CustomStatusIDSet ¶
type CustomStatusIDSet []types.CustomStatusID
func (CustomStatusIDSet) EncodeValues ¶
func (f CustomStatusIDSet) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type DateOrRange ¶
type DateOrRange struct { Start string `json:"start,omitempty"` End string `json:"end,omitempty"` Equal string `json:"equal,omitempty"` }
func (*DateOrRange) EncodeValues ¶
func (f *DateOrRange) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type FieldSet ¶
func (*FieldSet) EncodeValues ¶
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type FolderIDSet ¶
func (FolderIDSet) EncodeValues ¶
func (ids FolderIDSet) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type GetFolderSubtree ¶
type GetFolderSubtree struct { Permalink *string `url:"permalink,omitempty"` Descendants *bool `url:"descendants,omitempty"` Metadata *Metadata `url:"metadata,omitempty"` CustomField *CustomFieldFilter `url:"customField,omitempty"` UpdatedDate *DateRange `url:"updatedDate,omitempty"` Project *bool `url:"project,omitempty"` Fields *FieldSet `url:"fields,omitempty"` }
GetFolderSubtree contains parameters that will be passed to GetFolderSubTree API.
type GetFolderTree ¶
type GetFolderTree struct { Permalink *string `url:"permalink,omitempty"` Descendants *bool `url:"descendants,omitempty"` Metadata *Metadata `url:"metadata,omitempty"` CustomField *CustomFieldFilter `url:"customField,omitempty"` UpdatedDate *DateRange `url:"updatedDate,omitempty"` Project *bool `url:"project,omitempty"` Deleted *bool `url:"deleted,omitempty"` Fields *FieldSet `url:"fields,omitempty"` }
GetFolderTree contains parameters that will be passed to GetFolderTree API.
type GetFolders ¶
type GetFolders struct {
Fields *FieldSet `url:"fields,omitempty"`
}
GetFolders contains parameters that will be passed to GetFolder API.
type Metadata ¶
Metadata represents a metadata, part of other API objects.
func (*Metadata) EncodeValues ¶
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type MetadataSet ¶
type MetadataSet []Metadata
MetadataSet represents a list of pointers to Metadata
func (*MetadataSet) EncodeValues ¶
func (s *MetadataSet) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type ModifyAccount ¶
type ModifyAccount struct {
Metadata *MetadataSet `url:"metadata,omitempty"`
}
ModifyAccount contains parameters that will be passed to ModifyAccount API.
type ModifyContact ¶
type ModifyContact struct {
Metadata *MetadataSet `url:"metadata,omitempty"`
}
ModifyContact contains parameters that will be passed to ModifyContact API.
type ModifyCustomField ¶
type ModifyCustomField struct { Title *string `url:"title"` Type *types.CustomFieldType `url:"type"` Settings *Settings `url:"settings,omitempty"` }
ModifyCustomField contains parameters that will be passed to ModifyCustomField API.
type ModifyFolder ¶
type ModifyFolder struct { Title string `url:"title"` Description *string `url:"description"` AddParents FolderIDSet `url:"addParents,omitempty"` RemoveParents FolderIDSet `url:"removeParents,omitempty"` Metadata *MetadataSet `url:"metadata,omitempty"` Restore *bool `url:"restore,omitempty"` CustomFields CustomFieldSet `url:"customFields,omitempty"` CustomColumns CustomFieldIDSet `url:"customColumns,omitempty"` Project ProjectModify `url:"project"` }
type ModifyFolders ¶
type ModifyFolders struct {
CustomFields CustomFieldSet `url:"customFields,omitempty"`
}
type ModifyGroup ¶
type ModifyGroup struct { Title *string `url:"title,omitempty"` AddMembers ContactIDSet `url:"addMembers,omitempty"` RemoveMembers ContactIDSet `url:"removeMembers,omitempty"` Parent *string `url:"parent,omitempty"` Avatar *Avatar `url:"avatar,omitempty"` Metadata *MetadataSet `url:"metadata,omitempty"` }
ModifyGroup contains parameters that will be passed to ModifyGroup API.
type ModifyTask ¶
type ModifyTask struct { Title *string `url:"title,omitempty"` Description *string `url:"description,omitempty"` Status TaskStatusSet `url:"status,omitempty"` Importance types.TaskImportance `url:"importance,omitempty"` Dates *TaskDates `url:"dates,omitempty"` AddParents FolderIDSet `url:"addParents,omitempty"` RemoveParents FolderIDSet `url:"removeParents,omitempty"` AddResponsibles ContactIDSet `url:"addResponsibles,omitempty"` RemoveResponsibles ContactIDSet `url:"removeResponsibles,omitempty"` AddFollowers ContactIDSet `url:"addFollowers,omitempty"` Follow *bool `url:"follow,omitempty"` PriorityBefore types.TaskID `url:"priorityBefore,omitempty"` PriorityAfter types.TaskID `url:"priorityAfter,omitempty"` AddSuperTasks TaskIDSet `url:"addSuperTasks,omitempty"` RemoveSuperTasks TaskIDSet `url:"removeSuperTasks,omitempty"` Metadata *MetadataSet `url:"metadata,omitempty"` CustomFields CustomFieldSet `url:"customFields,omitempty"` CustomStatus types.CustomStatusID `url:"customStatus,omitempty"` Restore *bool `url:"restore,omitempty"` EffortAllocation *TaskEffort `url:"effortAllocation,omitempty"` Fields TaskFieldSet `url:"fields,omitempty"` }
ModifyTask contains parameters that will be passed to ModifyTask API.
type ModifyTasks ¶
type ModifyTasks struct { CustomFields CustomFieldSet `url:"customFields,omitempty"` EffortAllocation *TaskEffort `url:"effortAllocation,omitempty"` }
ModifyTasks contains parameters that will be passed to ModifyTasks API.
type ModifyUser ¶
type ModifyUser struct {
Profile *Profile `url:"profile,omitempty"`
}
ModifyUser contains parameters that will be passed to ModifyUser API.
type ModifyWorkflow ¶
type ModifyWorkflow struct { Name *string `url:"name,omitempty"` Hidden *bool `url:"hidden,omitempty"` CustomStatus *CustomStatus `url:"customStatus,omitempty"` }
ModifyWorkflow contains parameters that will be passed to ModifyWorkflow API.
type Profile ¶
type Profile struct { AccountID *string `json:"accountId,omitempty"` Role *string `json:"role,omitempty"` External *bool `json:"external,omitempty"` }
Profile contains profile data to be modified. Note that the fields are pointers so it can properly ignore blank values.
func (*Profile) EncodeValues ¶
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type Project ¶
type Project struct { OwnerIDs ContactIDSet `json:"ownerIds,omitempty"` Status types.ProjectStatus `json:"status,omitempty"` StartDate string `json:"startDate,omitempty"` EndDate string `json:"endDate,omitempty"` }
func (Project) EncodeValues ¶
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type ProjectModify ¶
type ProjectModify struct { OwnersAdd ContactIDSet `json:"ownerAdd,omitempty"` OwnersRemove ContactIDSet `json:"ownerRemove,omitempty"` Status types.ProjectStatus `json:"status,omitempty"` StartDate string `json:"startDate,omitempty"` EndDate string `json:"endDate,omitempty"` }
func (ProjectModify) EncodeValues ¶
func (p ProjectModify) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type QueryAccounts ¶
type QueryAccounts struct { Metadata *Metadata `url:"metadata,omitempty"` Fields *FieldSet `url:"fields,omitempty"` }
QueryAccounts contains parameters that will be passed to QueryAccounts API.
type QueryContacts ¶
type QueryContacts struct { Me *bool `url:"me,omitempty"` Metadata *Metadata `url:"metadata,omitempty"` Deleted *bool `url:"deleted,omitempty"` Fields *FieldSet `url:"fields,omitempty"` }
QueryContacts contains parameters that will be passed to QueryContacts API.
type QueryGroup ¶
type QueryGroup struct {
Fields *FieldSet `url:"fields,omitempty"`
}
QueryGroup contains parameters that will be passed to QueryGroup API.
type QueryGroups ¶
type QueryGroups struct { Metadata *Metadata `url:"metadata,omitempty"` Fields *FieldSet `url:"fields,omitempty"` }
QueryGroups contains parameters that will be passed to QueryGroups API.
type QueryTasks ¶
type QueryTasks struct { Descendants *bool `url:"descendants,omitempty"` Title *string `url:"title,omitempty"` Status TaskStatusSet `url:"status,omitempty"` Importance types.TaskImportance `url:"importance,omitempty"` StartDate *DateOrRange `url:"startDate,omitempty"` DueDate *DateOrRange `url:"dueDate,omitempty"` ScheduledDate *DateOrRange `url:"scheduledDate,omitempty"` CreatedDate *DateOrRange `url:"createdDate,omitempty"` UpdatedDate *DateOrRange `url:"updatedDate,omitempty"` CompletedDate *DateOrRange `url:"completedDate,omitempty"` Authors ContactIDSet `url:"authors,omitempty"` Responsibles ContactIDSet `url:"responsibles,omitempty"` Permalink *string `url:"permalink,omitempty"` Type types.TaskDatesType `url:"type,omitempty"` Limit *int `url:"limit,omitempty"` SortField TaskSortField `url:"sortField,omitempty"` SortOrder TaskSortOrder `url:"sortOrder,omitempty"` SubTasks *bool `url:"subTasks,omitempty"` PageSize *int `url:"pageSize,omitempty"` NextPageToken *string `url:"nextPageToken,omitempty"` Metadata *Metadata `url:"metadata,omitempty"` CustomField *CustomField `url:"customField,omitempty"` CustomStatuses CustomStatusIDSet `url:"customStatuses,omitempty"` Fields TaskFieldSet `url:"fields,omitempty"` }
QueryTasks contains parameters that will be passed to QueryTasks API.
type QueryTasksByIDs ¶
type QueryTasksByIDs struct {
Fields TaskFieldSet `url:"fields,omitempty"`
}
QueryTasksByIDs contains parameters that will be passed to QueryTasksByIDs API.
type Settings ¶
type Settings struct { InheritanceType *string `url:"inheritanceType,omitempty"` DecimalPlaces *int `url:"decimalPlaces,omitempty"` UseThousandsSeparator *bool `url:"useThousandsSeparator,omitempty"` Currency *string `url:"currency,omitempty"` Aggregation *string `url:"aggregation,omitempty"` Values *[]string `url:"values,omitempty"` AllowOtherValues *bool `url:"allowOtherValues,omitempty"` Contacts ContactIDSet `url:"contacts,omitempty"` }
type TaskDates ¶
type TaskDates struct { Type types.TaskDatesType `json:"type,omitempty"` Duration int `json:"duration,omitempty"` Start string `json:"start,omitempty"` Due string `json:"due,omitempty"` WorkOnWeekends bool `json:"workOnWeekends,omitempty,omitempty"` }
func (TaskDates) EncodeValues ¶
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type TaskEffort ¶
type TaskEffort struct { Mode types.TaskEffortMode `json:"mode"` TotalEffort int `json:"totalEffort,omitempty"` AllocatedEffort int `json:"allocatedEffort,omitempty"` }
func (TaskEffort) EncodeValues ¶
func (f TaskEffort) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type TaskFieldSet ¶
type TaskFieldSet []TaskField
func (TaskFieldSet) EncodeValues ¶
func (f TaskFieldSet) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type TaskIDSet ¶
func (TaskIDSet) EncodeValues ¶
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder
type TaskSortField ¶
type TaskSortField string
type TaskSortOrder ¶
type TaskSortOrder string
type TaskStatusSet ¶
type TaskStatusSet []types.TaskStatus
func (TaskStatusSet) EncodeValues ¶
func (f TaskStatusSet) EncodeValues(key string, v *url.Values) error
EncodeValues defines how to encode the type. For more details, refer to https://godoc.org/github.com/google/go-querystring/query#Encoder