Documentation
¶
Index ¶
- type Client
- type ForumsService
- type HelloResponse
- type PaginationOptions
- type PaginationResponse
- type SystemAuthorizedUserEmailResponse
- type SystemAuthorizedUserResponse
- type SystemAuthorizedUserService
- type SystemClubsContentTypesParameters
- type SystemClubsFetchParameters
- type SystemClubsListResponse
- type SystemClubsMembersParameters
- type SystemClubsMembersResponse
- type SystemClubsNodesObject
- type SystemClubsNodesParameters
- type SystemClubsNodesResponse
- type SystemClubsObject
- type SystemClubsService
- func (s *SystemClubsService) ContentTypes(params *SystemClubsContentTypesParameters) (*SystemCommonContentTypesObject, *http.Response, error)
- func (s *SystemClubsService) Create(params *SystemClubsFetchParameters) (*SystemClubsObject, *http.Response, error)
- func (s *SystemClubsService) CreateMember(params *SystemClubsMembersParameters, clubID int) (*SystemClubsMembersResponse, *http.Response, error)
- func (s *SystemClubsService) Delete(clubID int) (*http.Response, error)
- func (s *SystemClubsService) DeleteMember(clubID, memberID int) (*http.Response, error)
- func (s *SystemClubsService) DeleteNode(nodeID int) (*http.Response, error)
- func (s *SystemClubsService) Fetch(clubID int) (*SystemClubsObject, *http.Response, error)
- func (s *SystemClubsService) List(opt *PaginationOptions) (*SystemClubsListResponse, *http.Response, error)
- func (s *SystemClubsService) ListMembers(clubID int) (*SystemClubsMembersResponse, *http.Response, error)
- func (s *SystemClubsService) ListNodes() (*SystemClubsNodesResponse, *http.Response, error)
- func (s *SystemClubsService) Update(params *SystemClubsUpdateParameters, clubID int) (*SystemClubsObject, *http.Response, error)
- type SystemClubsUpdateParameters
- type SystemCommonContentTypesObject
- type SystemCommonFieldGroupObject
- type SystemCommonFieldObject
- type SystemCommonMemberObject
- type SystemGroupsListResponse
- type SystemGroupsObject
- type SystemGroupsService
- type SystemMembersCreateParameters
- type SystemMembersListParameters
- type SystemMembersListResponse
- type SystemMembersService
- func (s *SystemMembersService) Create(params *SystemMembersCreateParameters) (*SystemCommonMemberObject, *http.Response, error)
- func (s *SystemMembersService) Delete(memberID int) (*http.Response, error)
- func (s *SystemMembersService) Fetch(membersID int) (*SystemCommonMemberObject, *http.Response, error)
- func (s *SystemMembersService) List(params *SystemMembersListParameters) (*SystemMembersListResponse, *http.Response, error)
- func (s *SystemMembersService) Update(params *SystemMembersCreateParameters, memberID int) (*SystemCommonMemberObject, *http.Response, error)
- type SystemMessagesCreateParameters
- type SystemMessagesService
- type SystemMessagesUpdateParameters
- type SystemSearchListParameters
- type SystemSearchListResponse
- type SystemSearchService
- type SystemService
- func (s *SystemService) AuthorizedUser(ctx context.Context) *SystemAuthorizedUserService
- func (s *SystemService) Clubs(ctx context.Context) *SystemClubsService
- func (s *SystemService) Groups(ctx context.Context) *SystemGroupsService
- func (s *SystemService) Hello(ctx context.Context) (*HelloResponse, *http.Response, error)
- func (s *SystemService) Members(ctx context.Context) *SystemMembersService
- func (s *SystemService) Messages(ctx context.Context) *SystemMessagesService
- func (s *SystemService) Search(ctx context.Context) *SystemSearchService
- func (s *SystemService) WarnReasons(ctx context.Context) *SystemWarnReasonsService
- type SystemWarnReasonsListResponse
- type SystemWarnReasonsObject
- type SystemWarnReasonsParameters
- type SystemWarnReasonsService
- func (s *SystemWarnReasonsService) Create(params *SystemWarnReasonsParameters) (*SystemWarnReasonsObject, *http.Response, error)
- func (s *SystemWarnReasonsService) Delete(warnID int) (*http.Response, error)
- func (s *SystemWarnReasonsService) Fetch(warnID int) (*SystemWarnReasonsObject, *http.Response, error)
- func (s *SystemWarnReasonsService) List(opt *PaginationOptions) (*SystemWarnReasonsListResponse, *http.Response, error)
- func (s *SystemWarnReasonsService) Update(params *SystemWarnReasonsParameters, warnID int) (*SystemWarnReasonsObject, *http.Response, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
System *SystemService
Forums *ForumsService
// contains filtered or unexported fields
}
func NewClientWithAPIKey ¶
type ForumsService ¶
type ForumsService service
type HelloResponse ¶
type PaginationOptions ¶
type PaginationResponse ¶
type SystemAuthorizedUserEmailResponse ¶
type SystemAuthorizedUserEmailResponse struct {
Email string `json:"email"`
}
type SystemAuthorizedUserResponse ¶
type SystemAuthorizedUserResponse struct {
SystemCommonMemberObject
}
type SystemAuthorizedUserService ¶
type SystemAuthorizedUserService SystemService
func (*SystemAuthorizedUserService) Me ¶
func (s *SystemAuthorizedUserService) Me() (*SystemAuthorizedUserResponse, *http.Response, error)
func (*SystemAuthorizedUserService) MeEmail ¶
func (s *SystemAuthorizedUserService) MeEmail() (*SystemAuthorizedUserEmailResponse, *http.Response, error)
type SystemClubsContentTypesParameters ¶
type SystemClubsContentTypesParameters struct {
MemberID int `url:"memberId"`
}
type SystemClubsFetchParameters ¶
type SystemClubsFetchParameters struct {
Owner int `url:"owner"`
SystemClubsUpdateParameters
}
type SystemClubsListResponse ¶
type SystemClubsListResponse struct {
PaginationResponse
Results []SystemClubsObject `json:"results"`
}
type SystemClubsMembersResponse ¶
type SystemClubsMembersResponse struct {
Owner SystemCommonMemberObject `json:"owner"`
Members []SystemCommonMemberObject `json:"members"`
Leaders []SystemCommonMemberObject `json:"leaders"`
Moderators []SystemCommonMemberObject `json:"moderators"`
}
type SystemClubsNodesObject ¶
type SystemClubsNodesResponse ¶
type SystemClubsNodesResponse struct {
Nodes []SystemClubsNodesObject `json:"nodes"`
}
type SystemClubsObject ¶
type SystemClubsObject struct {
SystemClubsMembersResponse
ID int `json:"id"`
Name string `json:"name"`
URL string `json:"url"`
Type string `json:"type"`
Approved bool `json:"approved"`
Created time.Time `json:"created"`
MemberCount int `json:"memberCount"`
Photo *string `json:"photo"`
Paid bool `json:"paid"`
Featured bool `json:"featured"`
Location interface{} `json:"location"`
About string `json:"about"`
LastActivity time.Time `json:"lastActivity"`
ContentCount int `json:"contentCount"`
CoverPhotoURL *string `json:"coverPhotoUrl"`
CoverOffset string `json:"coverOffset"`
CoverPhotoColor string `json:"coverPhotoColor"`
FieldValues []SystemCommonFieldObject `json:"fieldValues"`
Nodes []SystemClubsNodesObject `json:"nodes"`
JoiningFee interface{} `json:"joiningFee"`
RenewalTerm interface{} `json:"renewalTerm"`
}
type SystemClubsService ¶
type SystemClubsService SystemService
func (*SystemClubsService) ContentTypes ¶
func (s *SystemClubsService) ContentTypes(params *SystemClubsContentTypesParameters) (*SystemCommonContentTypesObject, *http.Response, error)
func (*SystemClubsService) Create ¶
func (s *SystemClubsService) Create(params *SystemClubsFetchParameters) (*SystemClubsObject, *http.Response, error)
func (*SystemClubsService) CreateMember ¶
func (s *SystemClubsService) CreateMember(params *SystemClubsMembersParameters, clubID int) (*SystemClubsMembersResponse, *http.Response, error)
func (*SystemClubsService) Delete ¶
func (s *SystemClubsService) Delete(clubID int) (*http.Response, error)
func (*SystemClubsService) DeleteMember ¶
func (s *SystemClubsService) DeleteMember(clubID, memberID int) (*http.Response, error)
func (*SystemClubsService) DeleteNode ¶
func (s *SystemClubsService) DeleteNode(nodeID int) (*http.Response, error)
func (*SystemClubsService) Fetch ¶
func (s *SystemClubsService) Fetch(clubID int) (*SystemClubsObject, *http.Response, error)
func (*SystemClubsService) List ¶
func (s *SystemClubsService) List(opt *PaginationOptions) (*SystemClubsListResponse, *http.Response, error)
func (*SystemClubsService) ListMembers ¶
func (s *SystemClubsService) ListMembers(clubID int) (*SystemClubsMembersResponse, *http.Response, error)
func (*SystemClubsService) ListNodes ¶
func (s *SystemClubsService) ListNodes() (*SystemClubsNodesResponse, *http.Response, error)
func (*SystemClubsService) Update ¶
func (s *SystemClubsService) Update(params *SystemClubsUpdateParameters, clubID int) (*SystemClubsObject, *http.Response, error)
type SystemClubsUpdateParameters ¶
type SystemClubsUpdateParameters struct {
Name string `url:"name"`
About string `url:"about,omitempty"`
Type string `url:"type,omitempty"`
Approved bool `url:"approved,omitempty"`
Featured bool `url:"featured,omitempty"`
Lat float64 `url:"lat,omitempty"`
Long float64 `url:"long,omitempty"`
JoiningFee interface{} `url:"joiningFee,omitempty"`
RenewalTerm interface{} `url:"renewalTerm,omitempty"`
}
type SystemCommonContentTypesObject ¶
type SystemCommonContentTypesObject struct {
ContentTypes []string `json:"contenttypes"`
}
type SystemCommonFieldGroupObject ¶
type SystemCommonFieldGroupObject struct {
Name string `json:"name"`
Fields []SystemCommonFieldObject `json:"fields"`
}
type SystemCommonFieldObject ¶
type SystemCommonMemberObject ¶
type SystemCommonMemberObject struct {
ID int `json:"id"`
Name string `json:"name"`
Title string `json:"title"`
Timezone string `json:"timezone"`
FormattedName string `json:"formattedName"`
IPAddress string `json:"ipAddress"`
PrimaryGroup struct {
ID int `json:"id"`
Name string `json:"name"`
FormattedName string `json:"formattedName"`
} `json:"primaryGroup"`
SecondaryGroups []struct {
ID int `json:"id"`
Name string `json:"name"`
FormattedName string `json:"formattedName"`
} `json:"secondaryGroups"`
Email string `json:"email"`
Joined time.Time `json:"joined"`
RegistrationIPAddress string `json:"registrationIpAddress"`
WarningPoints int `json:"warningPoints"`
ReputationPoints int `json:"reputationPoints"`
PhotoURL string `json:"photoUrl"`
PhotoURLIsDefault bool `json:"photoUrlIsDefault"`
CoverPhotoURL string `json:"coverPhotoUrl"`
ProfileURL *string `json:"profileUrl"`
Validating bool `json:"validating"`
Posts int `json:"posts"`
LastActivity *time.Time `json:"lastActivity"`
LastVisit *time.Time `json:"lastVisit"`
LastPost *time.Time `json:"lastPost"`
ProfileViews int `json:"profileViews"`
Birthday string `json:"birthday"`
CustomFields []SystemCommonFieldGroupObject `json:"customFields"`
}
type SystemGroupsListResponse ¶
type SystemGroupsListResponse struct {
PaginationResponse
Results []SystemGroupsObject `json:"results"`
}
type SystemGroupsObject ¶
type SystemGroupsService ¶
type SystemGroupsService SystemService
func (*SystemGroupsService) Delete ¶
func (s *SystemGroupsService) Delete(groupID int) (*http.Response, error)
func (*SystemGroupsService) Fetch ¶
func (s *SystemGroupsService) Fetch(groupID int) (*SystemGroupsObject, *http.Response, error)
func (*SystemGroupsService) List ¶
func (s *SystemGroupsService) List(opt *PaginationOptions) (*SystemGroupsListResponse, *http.Response, error)
type SystemMembersCreateParameters ¶
type SystemMembersCreateParameters struct {
Name string `url:"name"`
Email string `url:"email"`
Password string `url:"password"`
Group int `url:"group"`
RegistrationIPAddress string `url:"registrationIpAddress"`
SecondaryGroups []int `url:"secondaryGroups"`
CustomFields interface{} `url:"customFields"`
Validated int `url:"validated"`
RawProperties map[string]interface{} `url:"rawProperties"`
}
type SystemMembersListParameters ¶
type SystemMembersListParameters struct {
SortBy string `url:"sortBy,omitempty"`
SortDir string `url:"sortDir,omitempty"`
Name string `url:"name,omitempty"`
Email string `url:"email,omitempty"`
Group []int `url:"group,omitempty"`
ActivityAfter int `url:"activity_after,omitempty"`
ActivityBefore int `url:"activity_before,omitempty"`
PaginationOptions
}
type SystemMembersListResponse ¶
type SystemMembersListResponse struct {
PaginationResponse
Results []SystemCommonMemberObject `json:"results"`
}
type SystemMembersService ¶
type SystemMembersService SystemService
func (*SystemMembersService) Create ¶
func (s *SystemMembersService) Create(params *SystemMembersCreateParameters) (*SystemCommonMemberObject, *http.Response, error)
func (*SystemMembersService) Delete ¶
func (s *SystemMembersService) Delete(memberID int) (*http.Response, error)
func (*SystemMembersService) Fetch ¶
func (s *SystemMembersService) Fetch(membersID int) (*SystemCommonMemberObject, *http.Response, error)
func (*SystemMembersService) List ¶
func (s *SystemMembersService) List(params *SystemMembersListParameters) (*SystemMembersListResponse, *http.Response, error)
func (*SystemMembersService) Update ¶
func (s *SystemMembersService) Update(params *SystemMembersCreateParameters, memberID int) (*SystemCommonMemberObject, *http.Response, error)
type SystemMessagesService ¶
type SystemMessagesService SystemService
func (*SystemMessagesService) Create ¶
func (s *SystemMessagesService) Create(params *SystemMessagesCreateParameters) (*http.Response, error)
func (*SystemMessagesService) Delete ¶
func (s *SystemMessagesService) Delete(msgID int) (*http.Response, error)
func (*SystemMessagesService) Update ¶
func (s *SystemMessagesService) Update(params *SystemMessagesUpdateParameters, msgID int) (*http.Response, error)
type SystemSearchListParameters ¶
type SystemSearchListParameters struct {
PaginationOptions
Q string `url:"q,omitempty"`
Tags string `url:"tags,omitempty"`
Type string `url:"type,omitempty"`
Item int `url:"item,omitempty"`
Nodes string `url:"nodes,omitempty"`
SearchMinComments int `url:" search_min_comments,omitempty"`
SearchMinReplies int `url:"search_min_replies,omitempty"`
SearchMinReviews int `url:"search_min_reviews,omitempty"`
SearchMinViews int `url:"search_min_views,omitempty"`
Author string `url:"author,omitempty"`
Club string `url:"club,omitempty"`
StartBefore string `url:"start_before,omitempty"`
StartAfter string `url:"start_after,omitempty"`
UpdatedBefore string `url:"updated_before,omitempty"`
UpdatedAfter string `url:"updated_after,omitempty"`
SortBy string `url:"sortby,omitempty"`
EitherTermsOrTags string `url:"eitherTermsOrTags,omitempty"`
SearchAndOr string `url:"search_and_or,omitempty"`
SearchIn string `url:"search_in,omitempty"`
SearchAs int `url:"search_as,omitempty"`
}
type SystemSearchListResponse ¶
type SystemSearchListResponse struct {
PaginationResponse
Results []struct {
Title string `json:"title"`
Content string `json:"content"`
Class string `json:"class"`
ObjectID int `json:"objectId"`
ItemClass string `json:"itemClass"`
ItemID int `json:"itemId"`
Started time.Time `json:"started"`
Updated time.Time `json:"updated"`
ItemURL string `json:"itemUrl"`
ObjectURL string `json:"objectUrl"`
Reputation int `json:"reputation"`
Comments *int `json:"comments"`
Reviews *int `json:"reviews"`
Container string `json:"container"`
ContainerURL string `json:"containerUrl"`
Author string `json:"author"`
AuthorURL string `json:"authorUrl"`
AuthorPhoto string `json:"authorPhoto"`
AuthorPhotoThumbnail string `json:"authorPhotoThumbnail"`
Tags []string `json:"tags"`
} `json:"results"`
}
type SystemSearchService ¶
type SystemSearchService SystemService
func (*SystemSearchService) List ¶
func (s *SystemSearchService) List(params *SystemSearchListParameters) (*SystemSearchListResponse, *http.Response, error)
func (*SystemSearchService) ListContentTypes ¶
func (s *SystemSearchService) ListContentTypes() (*SystemCommonContentTypesObject, *http.Response, error)
type SystemService ¶
type SystemService service
func (*SystemService) AuthorizedUser ¶
func (s *SystemService) AuthorizedUser(ctx context.Context) *SystemAuthorizedUserService
func (*SystemService) Clubs ¶
func (s *SystemService) Clubs(ctx context.Context) *SystemClubsService
func (*SystemService) Groups ¶
func (s *SystemService) Groups(ctx context.Context) *SystemGroupsService
func (*SystemService) Hello ¶
func (s *SystemService) Hello(ctx context.Context) (*HelloResponse, *http.Response, error)
func (*SystemService) Members ¶
func (s *SystemService) Members(ctx context.Context) *SystemMembersService
func (*SystemService) Messages ¶
func (s *SystemService) Messages(ctx context.Context) *SystemMessagesService
func (*SystemService) Search ¶
func (s *SystemService) Search(ctx context.Context) *SystemSearchService
func (*SystemService) WarnReasons ¶
func (s *SystemService) WarnReasons(ctx context.Context) *SystemWarnReasonsService
type SystemWarnReasonsListResponse ¶
type SystemWarnReasonsListResponse struct {
PaginationResponse
Results []SystemWarnReasonsObject `json:"results"`
}
type SystemWarnReasonsObject ¶
type SystemWarnReasonsObject struct {
ID int `json:"id"`
Name string `json:"name"`
DefaultNotes string `json:"defaultNotes"`
Points int `json:"points"`
PointsOverride bool `json:"pointsOverride"`
RemoveOverride bool `json:"removeOverride"`
RemovePoints string `json:"removePoints"`
PointsAutoRemove bool `json:"pointsAutoRemove"`
}
type SystemWarnReasonsParameters ¶
type SystemWarnReasonsParameters struct {
Name string `url:"name"`
DefaultNotes string `url:"defaultNotes,omitempty"`
Points int `url:"points,omitempty"`
PointsOverride bool `url:"pointsOverride,omitempty"`
RemoveOverride bool `url:"removeOverride,omitempty"`
RemovePoints string `url:"removePoints,omitempty"`
PointsAutoRemove bool `url:"pointsAutoRemove,omitempty"`
}
type SystemWarnReasonsService ¶
type SystemWarnReasonsService SystemService
func (*SystemWarnReasonsService) Create ¶
func (s *SystemWarnReasonsService) Create(params *SystemWarnReasonsParameters) (*SystemWarnReasonsObject, *http.Response, error)
func (*SystemWarnReasonsService) Delete ¶
func (s *SystemWarnReasonsService) Delete(warnID int) (*http.Response, error)
func (*SystemWarnReasonsService) Fetch ¶
func (s *SystemWarnReasonsService) Fetch(warnID int) (*SystemWarnReasonsObject, *http.Response, error)
func (*SystemWarnReasonsService) List ¶
func (s *SystemWarnReasonsService) List(opt *PaginationOptions) (*SystemWarnReasonsListResponse, *http.Response, error)
func (*SystemWarnReasonsService) Update ¶
func (s *SystemWarnReasonsService) Update(params *SystemWarnReasonsParameters, warnID int) (*SystemWarnReasonsObject, *http.Response, error)
Source Files
¶
Click to show internal directories.
Click to hide internal directories.