@ifunny/ifunny-api-types 0.6.6 → 0.6.9

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.
Files changed (9) hide show
  1. package/CHANGELOG.md +40 -0
  2. package/dist/rest/oauth2.js.map +1 -1
  3. package/dist/utils/errors.js +5 -0
  4. package/dist/utils/errors.js.map +1 -1
  5. package/package.json +1 -1
  6. package/types/rest/oauth2.d.ts +17 -2
  7. package/types/rest/oauth2.d.ts.map +1 -1
  8. package/types/utils/errors.d.ts +22 -1
  9. 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.6.9](https://github.com/ifunny-co/ifunny-api-types/compare/v0.6.8...v0.6.9) - 2022-08-25
6
+
7
+
8
+ ### Fixes
9
+
10
+ * Typo in InvalidEmailError @MakeShiftArtist ([`7cfb791`](https://github.com/ifunny-co/ifunny-api-types/commit/7cfb791cbbaa2e31f38f24f697bf35a16764ee5c))
11
+
12
+
13
+ ### Documentation
14
+
15
+ * Update CHANGELOG.md @MakeShiftArtist ([`35d4a6d`](https://github.com/ifunny-co/ifunny-api-types/commit/35d4a6dba29fdbfdaaeee74c320ddc14152c4da4))
16
+
17
+
18
+ ## [v0.6.8](https://github.com/ifunny-co/ifunny-api-types/compare/v0.6.7...v0.6.8) - 2022-08-25
19
+
20
+ ### Features
21
+
22
+ * Add InvalidEmail and EmailExists errors @MakeShiftArtist ([`6336ad7`](https://github.com/ifunny-co/ifunny-api-types/commit/6336ad739d3589a2d22740919a6ba1b16e505742))
23
+ * Add RESTAPISignUpSuccess @MakeShiftArtist ([`b149416`](https://github.com/ifunny-co/ifunny-api-types/commit/b14941614a9681a986e631a43646dd2cc91c4caf))
24
+
25
+
26
+
27
+ ### Documentation
28
+
29
+ * Update CHANGELOG.md @MakeShiftArtist ([`d1187e9`](https://github.com/ifunny-co/ifunny-api-types/commit/d1187e9c203d26129e2ac8a4a4991a87fff4c878))
30
+
31
+
32
+ ## [v0.6.7](https://github.com/ifunny-co/ifunny-api-types/compare/v0.6.6...v0.6.7) - 2022-08-25
33
+
34
+
35
+ ### Fixes
36
+
37
+ * Added unknown_error to iFUNNY_ERRORS @MakeShiftArtist ([`afdafbf`](https://github.com/ifunny-co/ifunny-api-types/commit/afdafbf86640f712080088538e05a38090908845))
38
+
39
+
40
+ ### Documentation
41
+
42
+ * Update CHANGELOG.md @MakeShiftArtist ([`d548197`](https://github.com/ifunny-co/ifunny-api-types/commit/d548197dfe9e6c19b9bbf53954251fb052175209))
43
+
44
+
5
45
  ## [v0.6.6](https://github.com/ifunny-co/ifunny-api-types/compare/v0.6.5...v0.6.6) - 2022-08-21
6
46
 
7
47
  ### Features
package/dist/rest/oauth2.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"oauth2.js","sourceRoot":"","sources":["../../src/rest/oauth2.ts"],"names":[],"mappings":";;;AAgBA,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;AAChB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB"}
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
@@ -9,6 +9,9 @@ var CaptchaTypes;
9
9
  CaptchaTypes["FUN_CAPTCHA"] = "fun_captcha";
10
10
  CaptchaTypes["RECAPTCHA"] = "recaptcha";
11
11
  })(CaptchaTypes || (CaptchaTypes = {}));
12
+ /**
13
+ * All known error types
14
+ */
12
15
  var IFUNNY_ERRORS;
13
16
  (function (IFUNNY_ERRORS) {
14
17
  IFUNNY_ERRORS["ALREADY_REPUBLISHED"] = "already_republished";
@@ -17,6 +20,7 @@ var IFUNNY_ERRORS;
17
20
  IFUNNY_ERRORS["BAD_REQUEST"] = "bad_request";
18
21
  IFUNNY_ERRORS["CAPTCHA_REQUIRED"] = "captcha_required";
19
22
  IFUNNY_ERRORS["CONTENT_WAS_DELETED"] = "content_was_deleted";
23
+ IFUNNY_ERRORS["EMAIL_EXISTS"] = "email_exists";
20
24
  IFUNNY_ERRORS["EMAIL_NOT_CONFIRMED"] = "email_not_confirmed";
21
25
  IFUNNY_ERRORS["ENTITY_ABUSED"] = "entity_abused";
22
26
  IFUNNY_ERRORS["FORBIDDEN_FOR_BANNED"] = "forbidden_for_banned";
@@ -36,6 +40,7 @@ var IFUNNY_ERRORS;
36
40
  IFUNNY_ERRORS["TOO_MANY_UPPERCASE"] = "too_many_uppercase";
37
41
  IFUNNY_ERRORS["UNACCEPTABLE_SYMBOLS"] = "unacceptable_symbols";
38
42
  IFUNNY_ERRORS["UNAUTHORIZED"] = "unauthorized";
43
+ IFUNNY_ERRORS["UNKNOWN_ERROR"] = "unknown_error";
39
44
  IFUNNY_ERRORS["UNKNOWN_SOURCE"] = "unknown_source";
40
45
  IFUNNY_ERRORS["VIDEO_IS_INVALID"] = "video_is_invalid";
41
46
  IFUNNY_ERRORS["YOU_ARE_BLOCKED"] = "you_are_blocked";
package/dist/utils/errors.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":";;;AAyBA;;GAEG;AACH,IAAK,YAGJ;AAHD,WAAK,YAAY;IAChB,2CAA2B,CAAA;IAC3B,uCAAuB,CAAA;AACxB,CAAC,EAHI,YAAY,KAAZ,YAAY,QAGhB;AAWD,IAAY,aA6BX;AA7BD,WAAY,aAAa;IACxB,4DAA2C,CAAA;IAC3C,kDAAiC,CAAA;IACjC,sDAAqC,CAAA;IACrC,4CAA2B,CAAA;IAC3B,sDAAqC,CAAA;IACrC,4DAA2C,CAAA;IAC3C,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,kDAAiC,CAAA;IACjC,sDAAqC,CAAA;IACrC,oDAAmC,CAAA;AACpC,CAAC,EA7BW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA6BxB"}
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ifunny/ifunny-api-types",
3
- "version": "0.6.6",
3
+ "version": "0.6.9",
4
4
  "description": "iFunny API typings for use in bot library creaion.",
5
5
  "main": "dist/index.js",
6
6
  "types": "types",
package/types/rest/oauth2.d.ts CHANGED
@@ -1,10 +1,13 @@
1
- import { RESTAPICaptchaError, RESTAPIErrorResponse } from "../utils/errors";
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 | RESTAPICaptchaError;
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
package/types/rest/oauth2.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"oauth2.d.ts","sourceRoot":"","sources":["../../src/rest/oauth2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAE5E,oBAAY,kBAAkB,GAAG,yBAAyB,GAAG,uBAAuB,CAAC;AAErF,MAAM,WAAW,yBAAyB;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,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,GAAG,mBAAmB,CAAC"}
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,8 +45,14 @@ 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;
49
+ /**
50
+ * Possible iFunny Errors
51
+ */
36
52
  export declare type RESTAPIiFunnyError = `${IFUNNY_ERRORS}`;
53
+ /**
54
+ * All known error types
55
+ */
37
56
  export declare enum IFUNNY_ERRORS {
38
57
  ALREADY_REPUBLISHED = "already_republished",
39
58
  ALREADY_SMILED = "already_smiled",
@@ -41,6 +60,7 @@ export declare enum IFUNNY_ERRORS {
41
60
  BAD_REQUEST = "bad_request",
42
61
  CAPTCHA_REQUIRED = "captcha_required",
43
62
  CONTENT_WAS_DELETED = "content_was_deleted",
63
+ EMAIL_EXISTS = "email_exists",
44
64
  EMAIL_NOT_CONFIRMED = "email_not_confirmed",
45
65
  ENTITY_ABUSED = "entity_abused",
46
66
  FORBIDDEN_FOR_BANNED = "forbidden_for_banned",
@@ -60,6 +80,7 @@ export declare enum IFUNNY_ERRORS {
60
80
  TOO_MANY_UPPERCASE = "too_many_uppercase",
61
81
  UNACCEPTABLE_SYMBOLS = "unacceptable_symbols",
62
82
  UNAUTHORIZED = "unauthorized",
83
+ UNKNOWN_ERROR = "unknown_error",
63
84
  UNKNOWN_SOURCE = "unknown_source",
64
85
  VIDEO_IS_INVALID = "video_is_invalid",
65
86
  YOU_ARE_BLOCKED = "you_are_blocked"
package/types/utils/errors.d.ts.map CHANGED
@@ -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,GAAG,mBAAmB,GAAG,YAAY,CAAC;AAEtE,oBAAY,kBAAkB,GAAG,GAAG,aAAa,EAAE,CAAC;AAEpD,oBAAY,aAAa;IACxB,mBAAmB,wBAAwB;IAC3C,cAAc,mBAAmB;IACjC,gBAAgB,qBAAqB;IACrC,WAAW,gBAAgB;IAC3B,gBAAgB,qBAAqB;IACrC,mBAAmB,wBAAwB;IAC3C,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,cAAc,mBAAmB;IACjC,gBAAgB,qBAAqB;IACrC,eAAe,oBAAoB;CACnC"}
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"}