docbase

type Attachment struct {
	ID        AttachmentID `json:"id"`
	Name      string       `json:"name"`
	Size      int64        `json:"size"`
	URL       string       `json:"url"`
	Markdown  string       `json:"markdown"`
	CreatedAt time.Time    `json:"created_at"`
}

type AttachmentID int64

type Client struct {

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

	// Services used for talking to different parts of the Docbase API.
	User       *userService
	Tag        *tagService
	Group      *groupService
	Post       *postService
	Comment    *commentService
	Attachment *attachmentService
	// contains filtered or unexported fields
}

type Comment struct {
	Body      string    `json:"body"`
	CreatedAt string    `json:"created_at"`
	ID        CommentID `json:"id"`
	User      User      `json:"user"`
}

type CommentID int64

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
	Messages []string       `json:"messages"` // more detail on individual errors
	Value    string         `json:"error"`    // error message
}

type Group struct {
	ID             GroupID   `json:"id"`
	Name           string    `json:"name"`
	Description    string    `json:"description"`
	PostsCount     int64     `json:"posts_count"`
	LastActivityAt time.Time `json:"last_activity_at"`
	CreatedAt      time.Time `json:"created_at"`
	Users          []User
}

type GroupID int64

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

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

type Meta struct {
	NextPage     string `json:"next_page"`
	PreviousPage string `json:"previous_page"`
	Total        int64  `json:"total"`
}

type Post struct {
	ID            PostID    `json:"id"`
	Title         string    `json:"title"`
	Body          string    `json:"body"`
	Draft         bool      `json:"draft"`
	Archived      bool      `json:"archived"`
	URL           string    `json:"url"`
	CreatedAt     string    `json:"created_at"`
	Scope         Scope     `json:"scope"`
	SharingURL    string    `json:"sharing_url"`
	Tags          []Tag     `json:"tags"`
	User          User      `json:"user"`
	StarsCount    int64     `json:"stars_count"`
	GoodJobsCount int64     `json:"good_jobs_count"`
	Comments      []Comment `json:"comments"`
	Groups        []Group   `json:"groups"`
}

type PostID int64

type Rate struct {
	// The number of requests per hour the client is currently limited to.
	Limit int64

	// The number of remaining requests the client can make this hour.
	Remaining int64

	// The time at which the current rate limit will reset.
	Reset Timestamp
}

type RateLimitError struct {
	Rate     Rate           // Rate specifies last known rate limit for the client
	Response *http.Response // HTTP response that caused this error
	Messages []string       `json:"messages"` // error message
}

type Response struct {
	*http.Response

	Body bytes.Buffer
	Meta
	Rate
}

type Scope string

type Tag struct {
	Name string `json:"name"`
}

type Timestamp struct {
	time.Time
}

type TokenTransport struct {
	Token string

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

type User struct {
	ID                    UserID    `json:"id"`
	Name                  string    `json:"name"`
	Username              string    `json:"username"`
	ProfileImageURL       string    `json:"profile_image_url"`
	Role                  UserRole  `json:"role"`
	PostsCount            int64     `json:"posts_count"`
	LastAccessTime        time.Time `json:"last_access_time"`
	TwoStepAuthentication bool      `json:"two_step_authentication"`
	Groups                []Group   `json:"groups"`
}

type UserID int64

type UserRole int64