types.go
author Mikael Berthe <mikael@lilotux.net>
Mon, 17 Apr 2017 12:07:44 +0200
changeset 131 68ef6504637e
parent 130 c450bb73f59a
child 133 0085bcfc1131
permissions -rw-r--r--
Introduce RestoreApp(), bump library version RestoreApp() lets the client provide an existing application ID/Secret pair. The library no longer falls back to mastodon.social, an instance name is required. The version is bumped to 0.1 (we have something that works!).
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
130
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 123
diff changeset
     1
/*
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 123
diff changeset
     2
Copyright 2017 Ollivier Robert
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 123
diff changeset
     3
Copyright 2017 Mikael Berthe
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 123
diff changeset
     4
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 123
diff changeset
     5
Licensed under the MIT license.  Please see the LICENSE file is this directory.
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 123
diff changeset
     6
*/
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 123
diff changeset
     7
7
0fbbac6d8e8c We have an skeleton now.
Ollivier Robert <roberto@keltia.net>
parents:
diff changeset
     8
package gondole
0fbbac6d8e8c We have an skeleton now.
Ollivier Robert <roberto@keltia.net>
parents:
diff changeset
     9
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    10
import (
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    11
	"time"
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    12
)
16
9d64e00d3ea6 Begin to fill in types.
Ollivier Robert <roberto@keltia.net>
parents: 10
diff changeset
    13
83
adc39ae774c0 Make it work with non-defaut instances
Mikael Berthe <mikael@lilotux.net>
parents: 74
diff changeset
    14
// Client contains data for a gondole client application
74
ba06092b91a6 Rename "Gondole" as "Client" to avoid "gondole.Gondole".
Ollivier Robert <roberto@keltia.net>
parents: 70
diff changeset
    15
type Client struct {
131
68ef6504637e Introduce RestoreApp(), bump library version
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
    16
	Name        string // Name of the client
68ef6504637e Introduce RestoreApp(), bump library version
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
    17
	ID          string // Application ID
68ef6504637e Introduce RestoreApp(), bump library version
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
    18
	Secret      string // Application secret
68ef6504637e Introduce RestoreApp(), bump library version
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
    19
	APIBase     string // API prefix URL
68ef6504637e Introduce RestoreApp(), bump library version
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
    20
	InstanceURL string // Instance base URL
85
abf0f5e40281 Initial login support
Mikael Berthe <mikael@lilotux.net>
parents: 83
diff changeset
    21
131
68ef6504637e Introduce RestoreApp(), bump library version
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
    22
	UserToken *UserToken // User token
10
bb83de52ba5f Adding types.
Ollivier Robert <roberto@keltia.net>
parents: 7
diff changeset
    23
}
bb83de52ba5f Adding types.
Ollivier Robert <roberto@keltia.net>
parents: 7
diff changeset
    24
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    25
/*
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    26
Entities:
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    27
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    28
Everything manipulated/returned by the API
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    29
*/
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    30
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    31
// Account represents a Mastodon account entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    32
type Account struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    33
	ID             int    `json:"id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    34
	Username       string `json:"username"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    35
	Acct           string `json:"acct"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    36
	DisplayName    string `json:"display_name"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    37
	Note           string `json:"note"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    38
	URL            string `json:"url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    39
	Avatar         string `json:"avatar"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    40
	Header         string `json:"header"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    41
	Locked         bool   `json:"locked"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    42
	CreatedAt      string `json:"created_at"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    43
	FollowersCount int    `json:"followers_count"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    44
	FollowingCount int    `json:"following_count"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    45
	StatusesCount  int    `json:"statuses_count"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    46
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    47
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    48
// Application represents a Mastodon application entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    49
type Application struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    50
	Name    string `json:"name"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    51
	Website string `json:"website"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    52
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    53
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    54
// Attachment represents a Mastodon attachement entity
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    55
type Attachment struct {
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    56
	ID         int    `json:"iD"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    57
	Type       string `json:"type"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    58
	URL        string `json:"url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    59
	RemoteURL  string `json:"remote_url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    60
	PreviewURL string `json:"preview_url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    61
	TextURL    string `json:"text_url"`
10
bb83de52ba5f Adding types.
Ollivier Robert <roberto@keltia.net>
parents: 7
diff changeset
    62
}
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    63
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    64
// Card represents a Mastodon card entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    65
type Card struct {
100
e327896577dd Uncomment the Card type
Mikael Berthe <mikael@lilotux.net>
parents: 85
diff changeset
    66
	URL         string `json:"url"`
e327896577dd Uncomment the Card type
Mikael Berthe <mikael@lilotux.net>
parents: 85
diff changeset
    67
	Title       string `json:"title"`
e327896577dd Uncomment the Card type
Mikael Berthe <mikael@lilotux.net>
parents: 85
diff changeset
    68
	Description string `json:"description"`
e327896577dd Uncomment the Card type
Mikael Berthe <mikael@lilotux.net>
parents: 85
diff changeset
    69
	Image       string `json:"image"`
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    70
}
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    71
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    72
// Context represents a Mastodon context entity
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    73
type Context struct {
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    74
	Ancestors   []Status `json:"ancestors"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    75
	Descendents []Status `json:"descendents"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    76
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    77
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    78
// Error represents a Mastodon error entity
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    79
type Error struct {
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    80
	Text string `json:"error"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    81
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    82
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    83
// Instance represents a Mastodon instance entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    84
type Instance struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    85
	URI         string `json:"uri"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    86
	Title       string `json:"title"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    87
	Description string `json:"description"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    88
	Email       string `json:"email"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    89
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    90
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    91
// Mention represents a Mastodon mention entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
    92
type Mention struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    93
	ID       int    `json:"id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    94
	URL      string `json:"url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    95
	Username string `json:"username"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
    96
	Acct     string `json:"acct"`
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
// Notification represents a Mastodon notification entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   100
type Notification struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   101
	ID        int      `json:"id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   102
	Type      string   `json:"type"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   103
	CreatedAt string   `json:"created_at"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   104
	Account   *Account `json:"account"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   105
	Status    *Status  `json:"status"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   106
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   107
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   108
// Relationship represents a Mastodon relationship entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   109
type Relationship struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   110
	Following  bool `json:"following"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   111
	FollowedBy bool `json:"followed_by"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   112
	Blocking   bool `json:"blocking"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   113
	Muting     bool `json:"muting"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   114
	Requested  bool `json:"requested"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   115
}
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   116
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   117
// Report represents a Mastodon report entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   118
type Report struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   119
	ID          int    `json:"iD"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   120
	ActionTaken string `json:"action_taken"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   121
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   122
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   123
// Results represents a Mastodon results entity
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   124
type Results struct {
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   125
	Accounts []Account `json:"accounts"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   126
	Statuses []Status  `json:"statuses"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   127
	Hashtags []string  `json:"hashtags"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   128
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   129
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   130
// Status represents a Mastodon status entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   131
type Status struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   132
	ID                 int          `json:"id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   133
	URI                string       `json:"uri"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   134
	URL                string       `json:"url"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   135
	Account            *Account     `json:"account"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   136
	InReplyToID        int          `json:"in_reply_to_id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   137
	InReplyToAccountID int          `json:"in_reply_to_account_id"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   138
	Reblog             *Status      `json:"reblog"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   139
	Content            string       `json:"content"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   140
	CreatedAt          time.Time    `json:"created_at"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   141
	ReblogsCount       int          `json:"reblogs_count"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   142
	FavouritesCount    int          `json:"favourites_count"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   143
	Reblogged          bool         `json:"reblogged"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   144
	Favourited         bool         `json:"favourited"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   145
	Sensitive          bool         `json:"sensitive"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   146
	SpoilerText        string       `json:"spoiler_text"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   147
	Visibility         string       `json:"visibility"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   148
	MediaAttachments   []Attachment `json:"media_attachments"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   149
	Mentions           []Mention    `json:"mentions"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   150
	Tags               []Tag        `json:"tags"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   151
	Application        Application  `json:"application"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   152
}
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   153
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   154
// Tag represents a Mastodon tag entity
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   155
type Tag struct {
70
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   156
	Name string `json:"name"`
fbc089e7249d Add json tags.
Ollivier Robert <roberto@keltia.net>
parents: 66
diff changeset
   157
	URL  string `json:"url"`
17
9f17ef336aad Add all types documented.
Ollivier Robert <roberto@keltia.net>
parents: 16
diff changeset
   158
}