types.go
author Ollivier Robert <roberto@keltia.net>
Wed, 12 Apr 2017 14:12:40 +0200
changeset 74 ba06092b91a6
parent 70 fbc089e7249d
child 83 adc39ae774c0
permissions -rw-r--r--
Rename "Gondole" as "Client" to avoid "gondole.Gondole". (expecting "golint" to go through the roof otherwise)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
7
0fbbac6d8e8c We have an skeleton now.
Ollivier Robert <roberto@keltia.net>
parents:
diff changeset
     1
package gondole
0fbbac6d8e8c We have an skeleton now.
Ollivier Robert <roberto@keltia.net>
parents:
diff changeset
     2
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
     3
import (
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
     4
	"time"
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
     5
)
16
9d64e00d3ea6 Begin to fill in types.
Ollivier Robert <roberto@keltia.net>
parents: 10
diff changeset
     6
74
ba06092b91a6 Rename "Gondole" as "Client" to avoid "gondole.Gondole".
Ollivier Robert <roberto@keltia.net>
parents: 70
diff changeset
     7
type Client struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
     8
	Name    string
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
     9
	ID      string
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    10
	Secret  string
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    11
	APIBase string
10
bb83de52ba5f Adding types.
Ollivier Robert <roberto@keltia.net>
parents: 7
diff changeset
    12
}
bb83de52ba5f Adding types.
Ollivier Robert <roberto@keltia.net>
parents: 7
diff changeset
    13
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    14
/*
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    15
Entities:
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    16
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    17
Everything manipulated/returned by the API
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    18
*/
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    19
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    20
// Account represents a Mastodon account entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    21
type Account struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    22
	ID             int    `json:"id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    23
	Username       string `json:"username"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    24
	Acct           string `json:"acct"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    25
	DisplayName    string `json:"display_name"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    26
	Note           string `json:"note"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    27
	URL            string `json:"url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    28
	Avatar         string `json:"avatar"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    29
	Header         string `json:"header"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    30
	Locked         bool   `json:"locked"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    31
	CreatedAt      string `json:"created_at"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    32
	FollowersCount int    `json:"followers_count"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    33
	FollowingCount int    `json:"following_count"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    34
	StatusesCount  int    `json:"statuses_count"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    35
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    36
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    37
// Application represents a Mastodon application entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    38
type Application struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    39
	Name    string `json:"name"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    40
	Website string `json:"website"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    41
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    42
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    43
// Attachment represents a Mastodon attachement entity
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    44
type Attachment struct {
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    45
	ID         int    `json:"iD"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    46
	Type       string `json:"type"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    47
	URL        string `json:"url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    48
	RemoteURL  string `json:"remote_url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    49
	PreviewURL string `json:"preview_url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    50
	TextURL    string `json:"text_url"`
10
bb83de52ba5f Adding types.
Ollivier Robert <roberto@keltia.net>
parents: 7
diff changeset
    51
}
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    52
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    53
/*
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    54
// Card represents a Mastodon card entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    55
type Card struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    56
	URL         string       `json:"url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    57
	Title       string       `json:"title"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    58
	Description string       `json:"description"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    59
	Image       *interface{} `json:"image"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    60
}
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    61
*/
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    62
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    63
// Context represents a Mastodon context entity
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    64
type Context struct {
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    65
	Ancestors   []Status `json:"ancestors"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    66
	Descendents []Status `json:"descendents"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    67
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    68
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    69
// Error represents a Mastodon error entity
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    70
type Error struct {
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    71
	Text string `json:"error"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    72
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    73
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    74
// Instance represents a Mastodon instance entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    75
type Instance struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    76
	URI         string `json:"uri"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    77
	Title       string `json:"title"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    78
	Description string `json:"description"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    79
	Email       string `json:"email"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    80
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    81
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    82
// Mention represents a Mastodon mention entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    83
type Mention struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    84
	ID       int    `json:"id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    85
	URL      string `json:"url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    86
	Username string `json:"username"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    87
	Acct     string `json:"acct"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    88
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    89
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    90
// Notification represents a Mastodon notification entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    91
type Notification struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    92
	ID        int      `json:"id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    93
	Type      string   `json:"type"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    94
	CreatedAt string   `json:"created_at"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    95
	Account   *Account `json:"account"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    96
	Status    *Status  `json:"status"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    97
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    98
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    99
// Relationship represents a Mastodon relationship entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   100
type Relationship struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   101
	Following  bool `json:"following"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   102
	FollowedBy bool `json:"followed_by"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   103
	Blocking   bool `json:"blocking"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   104
	Muting     bool `json:"muting"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   105
	Requested  bool `json:"requested"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   106
}
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   107
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   108
// Report represents a Mastodon report entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   109
type Report struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   110
	ID          int    `json:"iD"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   111
	ActionTaken string `json:"action_taken"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   112
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   113
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   114
// Results represents a Mastodon results entity
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   115
type Results struct {
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   116
	Accounts []Account `json:"accounts"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   117
	Statuses []Status  `json:"statuses"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   118
	Hashtags []string  `json:"hashtags"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   119
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   120
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   121
// Status represents a Mastodon status entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   122
type Status struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   123
	ID                 int          `json:"id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   124
	URI                string       `json:"uri"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   125
	URL                string       `json:"url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   126
	Account            *Account     `json:"account"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   127
	InReplyToID        int          `json:"in_reply_to_id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   128
	InReplyToAccountID int          `json:"in_reply_to_account_id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   129
	Reblog             *Status      `json:"reblog"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   130
	Content            string       `json:"content"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   131
	CreatedAt          time.Time    `json:"created_at"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   132
	ReblogsCount       int          `json:"reblogs_count"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   133
	FavouritesCount    int          `json:"favourites_count"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   134
	Reblogged          bool         `json:"reblogged"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   135
	Favourited         bool         `json:"favourited"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   136
	Sensitive          bool         `json:"sensitive"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   137
	SpoilerText        string       `json:"spoiler_text"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   138
	Visibility         string       `json:"visibility"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   139
	MediaAttachments   []Attachment `json:"media_attachments"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   140
	Mentions           []Mention    `json:"mentions"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   141
	Tags               []Tag        `json:"tags"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   142
	Application        Application  `json:"application"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   143
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   144
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   145
// Tag represents a Mastodon tag entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   146
type Tag struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   147
	Name string `json:"name"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   148
	URL  string `json:"url"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   149
}