@ifunny/ifunny-api-types 0.6.7 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +40 -0
- package/dist/rest/endpoints.js +156 -0
- package/dist/rest/endpoints.js.map +1 -0
- package/dist/rest/oauth2.js.map +1 -1
- package/dist/utils/errors.js +1 -0
- package/dist/utils/errors.js.map +1 -1
- package/package.json +1 -1
- package/types/rest/endpoints.d.ts +118 -0
- package/types/rest/endpoints.d.ts.map +1 -0
- package/types/rest/oauth2.d.ts +17 -2
- package/types/rest/oauth2.d.ts.map +1 -1
- package/types/utils/errors.d.ts +15 -1
- package/types/utils/errors.d.ts.map +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,46 @@
|
|
|
2
2
|
> All notable changes to this project will be documented in this file.
|
|
3
3
|
> This Changelog adheres to the [Semantic Versioning]("https://semver.org/")
|
|
4
4
|
|
|
5
|
+
## [v0.7.0](https://github.com/ifunny-co/ifunny-api-types/compare/v0.6.9...v0.7.0) - 2022-08-25
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* Add endpoints.ts @MakeShiftArtist ([`e39adf6`](https://github.com/ifunny-co/ifunny-api-types/commit/e39adf6adde6699dd0630dbfaaae960ba939177d))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Documentation
|
|
14
|
+
|
|
15
|
+
* Update CHANGELOG.md @MakeShiftArtist ([`13a6361`](https://github.com/ifunny-co/ifunny-api-types/commit/13a63613724d515986b87a746b674fd5d2446d9b))
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## [v0.6.9](https://github.com/ifunny-co/ifunny-api-types/compare/v0.6.8...v0.6.9) - 2022-08-25
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Fixes
|
|
22
|
+
|
|
23
|
+
* Typo in InvalidEmailError @MakeShiftArtist ([`7cfb791`](https://github.com/ifunny-co/ifunny-api-types/commit/7cfb791cbbaa2e31f38f24f697bf35a16764ee5c))
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Documentation
|
|
27
|
+
|
|
28
|
+
* Update CHANGELOG.md @MakeShiftArtist ([`35d4a6d`](https://github.com/ifunny-co/ifunny-api-types/commit/35d4a6dba29fdbfdaaeee74c320ddc14152c4da4))
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## [v0.6.8](https://github.com/ifunny-co/ifunny-api-types/compare/v0.6.7...v0.6.8) - 2022-08-25
|
|
32
|
+
|
|
33
|
+
### Features
|
|
34
|
+
|
|
35
|
+
* Add InvalidEmail and EmailExists errors @MakeShiftArtist ([`6336ad7`](https://github.com/ifunny-co/ifunny-api-types/commit/6336ad739d3589a2d22740919a6ba1b16e505742))
|
|
36
|
+
* Add RESTAPISignUpSuccess @MakeShiftArtist ([`b149416`](https://github.com/ifunny-co/ifunny-api-types/commit/b14941614a9681a986e631a43646dd2cc91c4caf))
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Documentation
|
|
41
|
+
|
|
42
|
+
* Update CHANGELOG.md @MakeShiftArtist ([`d1187e9`](https://github.com/ifunny-co/ifunny-api-types/commit/d1187e9c203d26129e2ac8a4a4991a87fff4c878))
|
|
43
|
+
|
|
44
|
+
|
|
5
45
|
## [v0.6.7](https://github.com/ifunny-co/ifunny-api-types/compare/v0.6.6...v0.6.7) - 2022-08-25
|
|
6
46
|
|
|
7
47
|
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Endpoints = void 0;
|
|
4
|
+
class Endpoints {
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* "/timelines/users/:userId"
|
|
8
|
+
* "/timelines/users/by_nick/:userNick"
|
|
9
|
+
*/
|
|
10
|
+
static userTimeline(query, byNick = false) {
|
|
11
|
+
return this.timelines + this.user(query, byNick);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @param query The user id or nick
|
|
15
|
+
* @param byNick Whether to search by nick (Default: false)
|
|
16
|
+
* @example
|
|
17
|
+
* "/users"
|
|
18
|
+
* "/users/:userId"
|
|
19
|
+
* "/users/by_nick/:userNick"
|
|
20
|
+
*/
|
|
21
|
+
static user(query, byNick = false) {
|
|
22
|
+
let users = "/users";
|
|
23
|
+
if (!query)
|
|
24
|
+
return users;
|
|
25
|
+
return users + (byNick ? `/by_nick/${query}` : `/query`);
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* @param user The user id or nick
|
|
29
|
+
* @param byNick Whether the user is by nick (Default: false)
|
|
30
|
+
* @example
|
|
31
|
+
* "/users/:userId/guests"
|
|
32
|
+
* "/users/by_nick/:userNick/guests"
|
|
33
|
+
*/
|
|
34
|
+
static guests(user, byNick = false) {
|
|
35
|
+
return this.user(user, byNick) + "/guests";
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* @param user The user id or nick
|
|
39
|
+
* @param byNick Whether the user is by nick (Default: false)
|
|
40
|
+
* @example
|
|
41
|
+
* "/users/:userId/blocked"
|
|
42
|
+
* "/users/by_nick/:userNick/blocked"
|
|
43
|
+
*/
|
|
44
|
+
static blocked(user, byNick = false) {
|
|
45
|
+
return this.user(user, byNick) + "/blocked";
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* @param user The user id or nick
|
|
49
|
+
* @param byNick Whether the user is by nick (Default: false)
|
|
50
|
+
* @example
|
|
51
|
+
* "/users/:userId/subscribers"
|
|
52
|
+
* "/users/by_nick/:userNick/subscribers"
|
|
53
|
+
*/
|
|
54
|
+
static subscribers(user, byNick = false) {
|
|
55
|
+
return this.user(user, byNick) + "/subscribers";
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* @param user The user id or nick
|
|
59
|
+
* @param byNick Whether the user is by nick (Default: false)
|
|
60
|
+
* @example
|
|
61
|
+
* "/users/:userId/subscriptions"
|
|
62
|
+
*/
|
|
63
|
+
static subscriptions(user, byNick = false) {
|
|
64
|
+
return this.user(user, byNick) + "/subscriptions";
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* @example
|
|
68
|
+
* "/content"
|
|
69
|
+
* "/content/:contentId"
|
|
70
|
+
*/
|
|
71
|
+
static content(id) {
|
|
72
|
+
return "/content" + (id ? `/${id}` : "");
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @param contentId The content id or array of content ids if adding to reads
|
|
76
|
+
* @example
|
|
77
|
+
* "/content/:contentId/smiles"
|
|
78
|
+
*/
|
|
79
|
+
static smiles(contentId) {
|
|
80
|
+
return this.content(contentId) + "/smiles";
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* @param contentId The content id
|
|
84
|
+
* @example
|
|
85
|
+
* "/content/:contentId/republished"
|
|
86
|
+
*/
|
|
87
|
+
static republishes(id) {
|
|
88
|
+
return this.content(id) + "/republished";
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* @example
|
|
92
|
+
* "/content/:contentId/comments"
|
|
93
|
+
*/
|
|
94
|
+
static comments(contentId) {
|
|
95
|
+
return this.content(contentId) + "/comments";
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* @param contentId The content id
|
|
99
|
+
* @param commentId The comment id
|
|
100
|
+
* @example
|
|
101
|
+
* "/content/:contentId/comments/:commentId/replies"
|
|
102
|
+
*/
|
|
103
|
+
static replies(contentId, commentId) {
|
|
104
|
+
return this.comments(contentId) + `/${commentId}/replies`;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* @param contentId The content id
|
|
108
|
+
* @example
|
|
109
|
+
* "/content/:contentId/comments/attached_content"
|
|
110
|
+
*/
|
|
111
|
+
static commentAttachment(contentId) {
|
|
112
|
+
return this.comments(contentId) + "/attached_content";
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* @param contentId The content id or array of content ids if adding to reads
|
|
116
|
+
* @example
|
|
117
|
+
* "/reads"
|
|
118
|
+
* "/reads/:contentId"
|
|
119
|
+
* "/reads/:contentId1,contentId2..."
|
|
120
|
+
*/
|
|
121
|
+
static reads(contentId) {
|
|
122
|
+
if (Array.isArray(contentId)) {
|
|
123
|
+
contentId = contentId.join(",");
|
|
124
|
+
}
|
|
125
|
+
return "/reads" + (contentId ? `/${contentId}` : "");
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* @param userId The id of the user the ban belongs to
|
|
129
|
+
* @param banId The id of the Ban
|
|
130
|
+
* @example
|
|
131
|
+
* "/users/:userId/bans"
|
|
132
|
+
* "/users/:userId/bans/:banId"
|
|
133
|
+
*/
|
|
134
|
+
static bans(userId, banId) {
|
|
135
|
+
return `/users/${userId}/bans` + (banId ? `/${banId}` : "");
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
exports.Endpoints = Endpoints;
|
|
139
|
+
Endpoints.base = "api.ifunny.mobi";
|
|
140
|
+
Endpoints.account = "/account";
|
|
141
|
+
Endpoints.collective = "/feeds/collective";
|
|
142
|
+
Endpoints.counters = "/counters";
|
|
143
|
+
Endpoints.featured = "/feeds/featured";
|
|
144
|
+
Endpoints.feeds = "/feeds";
|
|
145
|
+
Endpoints.oauth2 = "/oauth2";
|
|
146
|
+
Endpoints.projectElements = "/feeds/project_elements";
|
|
147
|
+
Endpoints.subscriptionFeed = "/timelines/home";
|
|
148
|
+
Endpoints.timelines = "/timelines";
|
|
149
|
+
Endpoints.token = "/oauth2/token";
|
|
150
|
+
Endpoints.myComments = "users/my/comments";
|
|
151
|
+
Endpoints.chatInvites = "users/my/chat_invitations";
|
|
152
|
+
Endpoints.mySmiles = "/users/my/content_smiles";
|
|
153
|
+
Endpoints.myAppeals = "users/my/appeals";
|
|
154
|
+
Endpoints.unreadChatMessages = "users/my/unread_chat_messages";
|
|
155
|
+
Endpoints.myNews = "news/my";
|
|
156
|
+
//# sourceMappingURL=endpoints.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../../src/rest/endpoints.ts"],"names":[],"mappings":";;;AAAA,MAAa,SAAS;IAoBrB;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,KAAa,EAAE,SAAkB,KAAK;QACzD,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,KAAc,EAAE,SAAkB,KAAK;QAClD,IAAI,KAAK,GAAG,QAAQ,CAAC;QACrB,IAAI,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QACzB,OAAO,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,SAAkB,KAAK;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,IAAY,EAAE,SAAkB,KAAK;QACnD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,UAAU,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,IAAY,EAAE,SAAkB,KAAK;QACvD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,cAAc,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,aAAa,CAAC,IAAY,EAAE,SAAkB,KAAK;QACzD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,gBAAgB,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,EAAW;QACzB,OAAO,UAAU,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,SAAiB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAiB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,SAAiB,EAAE,SAAiB;QAClD,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,IAAI,SAAS,UAAU,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,SAAiB;QACzC,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,mBAAmB,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,SAA6B;QACzC,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAC7B,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAChC;QACD,OAAO,QAAQ,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,MAAc,EAAE,KAAc;QACzC,OAAO,UAAU,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7D,CAAC;;AAnKF,8BAoKC;AAnKgB,cAAI,GAAG,iBAAiB,CAAC;AACzB,iBAAO,GAAG,UAAU,CAAC;AACrB,oBAAU,GAAG,mBAAmB,CAAC;AACjC,kBAAQ,GAAG,WAAW,CAAC;AACvB,kBAAQ,GAAG,iBAAiB,CAAC;AAC7B,eAAK,GAAG,QAAQ,CAAC;AACjB,gBAAM,GAAG,SAAS,CAAC;AACnB,yBAAe,GAAG,yBAAyB,CAAC;AAC5C,0BAAgB,GAAG,iBAAiB,CAAC;AACrC,mBAAS,GAAG,YAAY,CAAC;AACzB,eAAK,GAAG,eAAe,CAAC;AAExB,oBAAU,GAAG,mBAAmB,CAAC;AACjC,qBAAW,GAAG,2BAA2B,CAAC;AAC1C,kBAAQ,GAAG,0BAA0B,CAAC;AACtC,mBAAS,GAAG,kBAAkB,CAAC;AAC/B,4BAAkB,GAAG,+BAA+B,CAAC;AACrD,gBAAM,GAAG,SAAS,CAAC"}
|
package/dist/rest/oauth2.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"oauth2.js","sourceRoot":"","sources":["../../src/rest/oauth2.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"oauth2.js","sourceRoot":"","sources":["../../src/rest/oauth2.ts"],"names":[],"mappings":";;;AAmBA,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;AAChB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB"}
|
package/dist/utils/errors.js
CHANGED
|
@@ -20,6 +20,7 @@ var IFUNNY_ERRORS;
|
|
|
20
20
|
IFUNNY_ERRORS["BAD_REQUEST"] = "bad_request";
|
|
21
21
|
IFUNNY_ERRORS["CAPTCHA_REQUIRED"] = "captcha_required";
|
|
22
22
|
IFUNNY_ERRORS["CONTENT_WAS_DELETED"] = "content_was_deleted";
|
|
23
|
+
IFUNNY_ERRORS["EMAIL_EXISTS"] = "email_exists";
|
|
23
24
|
IFUNNY_ERRORS["EMAIL_NOT_CONFIRMED"] = "email_not_confirmed";
|
|
24
25
|
IFUNNY_ERRORS["ENTITY_ABUSED"] = "entity_abused";
|
|
25
26
|
IFUNNY_ERRORS["FORBIDDEN_FOR_BANNED"] = "forbidden_for_banned";
|
package/dist/utils/errors.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":";;;AAwCA;;GAEG;AACH,IAAK,YAGJ;AAHD,WAAK,YAAY;IAChB,2CAA2B,CAAA;IAC3B,uCAAuB,CAAA;AACxB,CAAC,EAHI,YAAY,KAAZ,YAAY,QAGhB;AAkBD;;GAEG;AACH,IAAY,aA+BX;AA/BD,WAAY,aAAa;IACxB,4DAA2C,CAAA;IAC3C,kDAAiC,CAAA;IACjC,sDAAqC,CAAA;IACrC,4CAA2B,CAAA;IAC3B,sDAAqC,CAAA;IACrC,4DAA2C,CAAA;IAC3C,8CAA6B,CAAA;IAC7B,4DAA2C,CAAA;IAC3C,gDAA+B,CAAA;IAC/B,8DAA6C,CAAA;IAC7C,oEAAmD,CAAA;IACnD,kDAAiC,CAAA;IACjC,gDAA+B,CAAA;IAC/B,gDAA+B,CAAA;IAC/B,oDAAmC,CAAA;IACnC,0CAAyB,CAAA;IACzB,8CAA6B,CAAA;IAC7B,0EAAyD,CAAA;IACzD,0DAAyC,CAAA;IACzC,oDAAmC,CAAA;IACnC,sEAAqD,CAAA;IACrD,gEAA+C,CAAA;IAC/C,mDAAkC,CAAA;IAClC,0DAAyC,CAAA;IACzC,8DAA6C,CAAA;IAC7C,8CAA6B,CAAA;IAC7B,gDAA+B,CAAA;IAC/B,kDAAiC,CAAA;IACjC,sDAAqC,CAAA;IACrC,oDAAmC,CAAA;AACpC,CAAC,EA/BW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA+BxB"}
|
package/package.json
CHANGED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
export declare class Endpoints {
|
|
2
|
+
static readonly base = "api.ifunny.mobi";
|
|
3
|
+
static readonly account = "/account";
|
|
4
|
+
static readonly collective = "/feeds/collective";
|
|
5
|
+
static readonly counters = "/counters";
|
|
6
|
+
static readonly featured = "/feeds/featured";
|
|
7
|
+
static readonly feeds = "/feeds";
|
|
8
|
+
static readonly oauth2 = "/oauth2";
|
|
9
|
+
static readonly projectElements = "/feeds/project_elements";
|
|
10
|
+
static readonly subscriptionFeed = "/timelines/home";
|
|
11
|
+
static readonly timelines = "/timelines";
|
|
12
|
+
static readonly token = "/oauth2/token";
|
|
13
|
+
static readonly myComments = "users/my/comments";
|
|
14
|
+
static readonly chatInvites = "users/my/chat_invitations";
|
|
15
|
+
static readonly mySmiles = "/users/my/content_smiles";
|
|
16
|
+
static readonly myAppeals = "users/my/appeals";
|
|
17
|
+
static readonly unreadChatMessages = "users/my/unread_chat_messages";
|
|
18
|
+
static readonly myNews = "news/my";
|
|
19
|
+
/**
|
|
20
|
+
* @example
|
|
21
|
+
* "/timelines/users/:userId"
|
|
22
|
+
* "/timelines/users/by_nick/:userNick"
|
|
23
|
+
*/
|
|
24
|
+
static userTimeline(query: string, byNick?: boolean): string;
|
|
25
|
+
/**
|
|
26
|
+
* @param query The user id or nick
|
|
27
|
+
* @param byNick Whether to search by nick (Default: false)
|
|
28
|
+
* @example
|
|
29
|
+
* "/users"
|
|
30
|
+
* "/users/:userId"
|
|
31
|
+
* "/users/by_nick/:userNick"
|
|
32
|
+
*/
|
|
33
|
+
static user(query?: string, byNick?: boolean): string;
|
|
34
|
+
/**
|
|
35
|
+
* @param user The user id or nick
|
|
36
|
+
* @param byNick Whether the user is by nick (Default: false)
|
|
37
|
+
* @example
|
|
38
|
+
* "/users/:userId/guests"
|
|
39
|
+
* "/users/by_nick/:userNick/guests"
|
|
40
|
+
*/
|
|
41
|
+
static guests(user: string, byNick?: boolean): string;
|
|
42
|
+
/**
|
|
43
|
+
* @param user The user id or nick
|
|
44
|
+
* @param byNick Whether the user is by nick (Default: false)
|
|
45
|
+
* @example
|
|
46
|
+
* "/users/:userId/blocked"
|
|
47
|
+
* "/users/by_nick/:userNick/blocked"
|
|
48
|
+
*/
|
|
49
|
+
static blocked(user: string, byNick?: boolean): string;
|
|
50
|
+
/**
|
|
51
|
+
* @param user The user id or nick
|
|
52
|
+
* @param byNick Whether the user is by nick (Default: false)
|
|
53
|
+
* @example
|
|
54
|
+
* "/users/:userId/subscribers"
|
|
55
|
+
* "/users/by_nick/:userNick/subscribers"
|
|
56
|
+
*/
|
|
57
|
+
static subscribers(user: string, byNick?: boolean): string;
|
|
58
|
+
/**
|
|
59
|
+
* @param user The user id or nick
|
|
60
|
+
* @param byNick Whether the user is by nick (Default: false)
|
|
61
|
+
* @example
|
|
62
|
+
* "/users/:userId/subscriptions"
|
|
63
|
+
*/
|
|
64
|
+
static subscriptions(user: string, byNick?: boolean): string;
|
|
65
|
+
/**
|
|
66
|
+
* @example
|
|
67
|
+
* "/content"
|
|
68
|
+
* "/content/:contentId"
|
|
69
|
+
*/
|
|
70
|
+
static content(id?: string): string;
|
|
71
|
+
/**
|
|
72
|
+
* @param contentId The content id or array of content ids if adding to reads
|
|
73
|
+
* @example
|
|
74
|
+
* "/content/:contentId/smiles"
|
|
75
|
+
*/
|
|
76
|
+
static smiles(contentId: string): string;
|
|
77
|
+
/**
|
|
78
|
+
* @param contentId The content id
|
|
79
|
+
* @example
|
|
80
|
+
* "/content/:contentId/republished"
|
|
81
|
+
*/
|
|
82
|
+
static republishes(id: string): string;
|
|
83
|
+
/**
|
|
84
|
+
* @example
|
|
85
|
+
* "/content/:contentId/comments"
|
|
86
|
+
*/
|
|
87
|
+
static comments(contentId: string): string;
|
|
88
|
+
/**
|
|
89
|
+
* @param contentId The content id
|
|
90
|
+
* @param commentId The comment id
|
|
91
|
+
* @example
|
|
92
|
+
* "/content/:contentId/comments/:commentId/replies"
|
|
93
|
+
*/
|
|
94
|
+
static replies(contentId: string, commentId: string): string;
|
|
95
|
+
/**
|
|
96
|
+
* @param contentId The content id
|
|
97
|
+
* @example
|
|
98
|
+
* "/content/:contentId/comments/attached_content"
|
|
99
|
+
*/
|
|
100
|
+
static commentAttachment(contentId: string): string;
|
|
101
|
+
/**
|
|
102
|
+
* @param contentId The content id or array of content ids if adding to reads
|
|
103
|
+
* @example
|
|
104
|
+
* "/reads"
|
|
105
|
+
* "/reads/:contentId"
|
|
106
|
+
* "/reads/:contentId1,contentId2..."
|
|
107
|
+
*/
|
|
108
|
+
static reads(contentId?: string | string[]): string;
|
|
109
|
+
/**
|
|
110
|
+
* @param userId The id of the user the ban belongs to
|
|
111
|
+
* @param banId The id of the Ban
|
|
112
|
+
* @example
|
|
113
|
+
* "/users/:userId/bans"
|
|
114
|
+
* "/users/:userId/bans/:banId"
|
|
115
|
+
*/
|
|
116
|
+
static bans(userId: string, banId?: string): string;
|
|
117
|
+
}
|
|
118
|
+
//# sourceMappingURL=endpoints.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../src/rest/endpoints.ts"],"names":[],"mappings":"AAAA,qBAAa,SAAS;IACrB,MAAM,CAAC,QAAQ,CAAC,IAAI,qBAAqB;IACzC,MAAM,CAAC,QAAQ,CAAC,OAAO,cAAc;IACrC,MAAM,CAAC,QAAQ,CAAC,UAAU,uBAAuB;IACjD,MAAM,CAAC,QAAQ,CAAC,QAAQ,eAAe;IACvC,MAAM,CAAC,QAAQ,CAAC,QAAQ,qBAAqB;IAC7C,MAAM,CAAC,QAAQ,CAAC,KAAK,YAAY;IACjC,MAAM,CAAC,QAAQ,CAAC,MAAM,aAAa;IACnC,MAAM,CAAC,QAAQ,CAAC,eAAe,6BAA6B;IAC5D,MAAM,CAAC,QAAQ,CAAC,gBAAgB,qBAAqB;IACrD,MAAM,CAAC,QAAQ,CAAC,SAAS,gBAAgB;IACzC,MAAM,CAAC,QAAQ,CAAC,KAAK,mBAAmB;IAExC,MAAM,CAAC,QAAQ,CAAC,UAAU,uBAAuB;IACjD,MAAM,CAAC,QAAQ,CAAC,WAAW,+BAA+B;IAC1D,MAAM,CAAC,QAAQ,CAAC,QAAQ,8BAA8B;IACtD,MAAM,CAAC,QAAQ,CAAC,SAAS,sBAAsB;IAC/C,MAAM,CAAC,QAAQ,CAAC,kBAAkB,mCAAmC;IACrE,MAAM,CAAC,QAAQ,CAAC,MAAM,aAAa;IAEnC;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAG,MAAM;IAInE;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAG,MAAM;IAM5D;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAG,MAAM;IAI5D;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAG,MAAM;IAI7D;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAG,MAAM;IAIjE;;;;;OAKG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAG,MAAM;IAInE;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAInC;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAIxC;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAItC;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAI1C;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAI5D;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAInD;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IAOnD;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;CAG1C"}
|
package/types/rest/oauth2.d.ts
CHANGED
|
@@ -1,10 +1,13 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { RESTAPIErrorResponse } from "../utils/errors";
|
|
2
2
|
export declare type RESTAPIOauth2Login = RESTAPIOauth2LoginSuccess | RESTAPIOauth2LoginError;
|
|
3
3
|
export interface RESTAPIOauth2LoginSuccess {
|
|
4
4
|
/**
|
|
5
5
|
* Bearer token used for requests
|
|
6
6
|
*/
|
|
7
7
|
access_token: string;
|
|
8
|
+
/**
|
|
9
|
+
* The type of token created
|
|
10
|
+
*/
|
|
8
11
|
token_type: TOKEN_TYPES.BEARER;
|
|
9
12
|
/**
|
|
10
13
|
* ? This Timestamp is in seconds, which is equivilent to 10 years
|
|
@@ -16,5 +19,17 @@ export declare enum TOKEN_TYPES {
|
|
|
16
19
|
BASIC = "basic"
|
|
17
20
|
}
|
|
18
21
|
export declare type APITokenType = `${TOKEN_TYPES}`;
|
|
19
|
-
export declare type RESTAPIOauth2LoginError = RESTAPIErrorResponse
|
|
22
|
+
export declare type RESTAPIOauth2LoginError = RESTAPIErrorResponse;
|
|
23
|
+
export interface RESTAPISignUpSuccess {
|
|
24
|
+
/**
|
|
25
|
+
* Data about the account created
|
|
26
|
+
*/
|
|
27
|
+
data: {
|
|
28
|
+
/**
|
|
29
|
+
* The user id of the account created
|
|
30
|
+
*/
|
|
31
|
+
id: string;
|
|
32
|
+
};
|
|
33
|
+
status: 200;
|
|
34
|
+
}
|
|
20
35
|
//# sourceMappingURL=oauth2.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"oauth2.d.ts","sourceRoot":"","sources":["../../src/rest/oauth2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"oauth2.d.ts","sourceRoot":"","sources":["../../src/rest/oauth2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEvD,oBAAY,kBAAkB,GAAG,yBAAyB,GAAG,uBAAuB,CAAC;AAErF,MAAM,WAAW,yBAAyB;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC;IAC/B;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;CACtB;AAED,oBAAY,WAAW;IACtB,MAAM,WAAW;IACjB,KAAK,UAAU;CACf;AAED,oBAAY,YAAY,GAAG,GAAG,WAAW,EAAE,CAAC;AAE5C,oBAAY,uBAAuB,GAAG,oBAAoB,CAAC;AAE3D,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,IAAI,EAAE;QACL;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACX,CAAC;IACF,MAAM,EAAE,GAAG,CAAC;CACZ"}
|
package/types/utils/errors.d.ts
CHANGED
|
@@ -21,6 +21,19 @@ export interface RESTAPICaptchaError extends RESTAPIError {
|
|
|
21
21
|
};
|
|
22
22
|
status: 403;
|
|
23
23
|
}
|
|
24
|
+
/**
|
|
25
|
+
* Returned when an email is invalid
|
|
26
|
+
*/
|
|
27
|
+
export interface RESTAPIInvalidEmailError {
|
|
28
|
+
error: IFUNNY_ERRORS.INVALID_EMAIL;
|
|
29
|
+
error_description: string;
|
|
30
|
+
status: 403;
|
|
31
|
+
}
|
|
32
|
+
export interface RESTAPIEmailExistsError {
|
|
33
|
+
error: IFUNNY_ERRORS.EMAIL_EXISTS;
|
|
34
|
+
error_description: string;
|
|
35
|
+
status: 403;
|
|
36
|
+
}
|
|
24
37
|
/**
|
|
25
38
|
* Known captcha types
|
|
26
39
|
*/
|
|
@@ -32,7 +45,7 @@ declare type CaptchaType = `${CaptchaTypes}`;
|
|
|
32
45
|
/**
|
|
33
46
|
* Returns when the request throws an error.
|
|
34
47
|
*/
|
|
35
|
-
export declare type RESTAPIErrorResponse = RESTAPICaptchaError | RESTAPIError;
|
|
48
|
+
export declare type RESTAPIErrorResponse = RESTAPICaptchaError | RESTAPIInvalidEmailError | RESTAPIEmailExistsError | RESTAPIError;
|
|
36
49
|
/**
|
|
37
50
|
* Possible iFunny Errors
|
|
38
51
|
*/
|
|
@@ -47,6 +60,7 @@ export declare enum IFUNNY_ERRORS {
|
|
|
47
60
|
BAD_REQUEST = "bad_request",
|
|
48
61
|
CAPTCHA_REQUIRED = "captcha_required",
|
|
49
62
|
CONTENT_WAS_DELETED = "content_was_deleted",
|
|
63
|
+
EMAIL_EXISTS = "email_exists",
|
|
50
64
|
EMAIL_NOT_CONFIRMED = "email_not_confirmed",
|
|
51
65
|
ENTITY_ABUSED = "entity_abused",
|
|
52
66
|
FORBIDDEN_FOR_BANNED = "forbidden_for_banned",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACxD,KAAK,EAAE,aAAa,CAAC,gBAAgB,CAAC;IACtC,iBAAiB,EAAE,gCAAgC,CAAC;IACpD,IAAI,EAAE;QACL;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,WAAW,CAAC;KAClB,CAAC;IACF,MAAM,EAAE,GAAG,CAAC;CACZ;AAED;;GAEG;AACH,aAAK,YAAY;IAChB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;CACvB;AAED,aAAK,WAAW,GAAG,GAAG,YAAY,EAAE,CAAC;AAErC;;GAEG;AACH,oBAAY,oBAAoB,
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACxD,KAAK,EAAE,aAAa,CAAC,gBAAgB,CAAC;IACtC,iBAAiB,EAAE,gCAAgC,CAAC;IACpD,IAAI,EAAE;QACL;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,WAAW,CAAC;KAClB,CAAC;IACF,MAAM,EAAE,GAAG,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC;IACnC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,GAAG,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACvC,KAAK,EAAE,aAAa,CAAC,YAAY,CAAC;IAClC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,GAAG,CAAC;CACZ;AAED;;GAEG;AACH,aAAK,YAAY;IAChB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;CACvB;AAED,aAAK,WAAW,GAAG,GAAG,YAAY,EAAE,CAAC;AAErC;;GAEG;AACH,oBAAY,oBAAoB,GAC7B,mBAAmB,GACnB,wBAAwB,GACxB,uBAAuB,GACvB,YAAY,CAAC;AAEhB;;GAEG;AACH,oBAAY,kBAAkB,GAAG,GAAG,aAAa,EAAE,CAAC;AAEpD;;GAEG;AACH,oBAAY,aAAa;IACxB,mBAAmB,wBAAwB;IAC3C,cAAc,mBAAmB;IACjC,gBAAgB,qBAAqB;IACrC,WAAW,gBAAgB;IAC3B,gBAAgB,qBAAqB;IACrC,mBAAmB,wBAAwB;IAC3C,YAAY,iBAAiB;IAC7B,mBAAmB,wBAAwB;IAC3C,aAAa,kBAAkB;IAC/B,oBAAoB,yBAAyB;IAC7C,qBAAqB,8BAA8B;IACnD,cAAc,mBAAmB;IACjC,aAAa,kBAAkB;IAC/B,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;IACnC,UAAU,eAAe;IACzB,YAAY,iBAAiB;IAC7B,qBAAqB,oCAAoC;IACzD,kBAAkB,uBAAuB;IACzC,eAAe,oBAAoB;IACnC,wBAAwB,6BAA6B;IACrD,qBAAqB,0BAA0B;IAC/C,SAAS,yBAAyB;IAClC,kBAAkB,uBAAuB;IACzC,oBAAoB,yBAAyB;IAC7C,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IACjC,gBAAgB,qBAAqB;IACrC,eAAe,oBAAoB;CACnC"}
|