@ifunny/ifunny-api-types 0.6.7 → 0.6.8

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 > All notable changes to this project will be documented in this file.
 > This Changelog adheres to the [Semantic Versioning]("https://semver.org/")
 
+## [v0.6.8](https://github.com/ifunny-co/ifunny-api-types/compare/v0.6.7...v0.6.8) - 2022-08-25
+
+### Features
+
+*  Add InvalidEmail and EmailExists errors @MakeShiftArtist ([`6336ad7`](https://github.com/ifunny-co/ifunny-api-types/commit/6336ad739d3589a2d22740919a6ba1b16e505742))
+*  Add RESTAPISignUpSuccess @MakeShiftArtist ([`b149416`](https://github.com/ifunny-co/ifunny-api-types/commit/b14941614a9681a986e631a43646dd2cc91c4caf))
+
+
+
+### Documentation
+
+*  Update CHANGELOG.md @MakeShiftArtist ([`d1187e9`](https://github.com/ifunny-co/ifunny-api-types/commit/d1187e9c203d26129e2ac8a4a4991a87fff4c878))
+
+
 ## [v0.6.7](https://github.com/ifunny-co/ifunny-api-types/compare/v0.6.6...v0.6.7) - 2022-08-25
 
 

package/dist/rest/oauth2.js.map

@@ -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"}
+{"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

@@ -20,6 +20,7 @@ var IFUNNY_ERRORS;
     IFUNNY_ERRORS["BAD_REQUEST"] = "bad_request";
     IFUNNY_ERRORS["CAPTCHA_REQUIRED"] = "captcha_required";
     IFUNNY_ERRORS["CONTENT_WAS_DELETED"] = "content_was_deleted";
+    IFUNNY_ERRORS["EMAIL_EXISTS"] = "email_exists";
     IFUNNY_ERRORS["EMAIL_NOT_CONFIRMED"] = "email_not_confirmed";
     IFUNNY_ERRORS["ENTITY_ABUSED"] = "entity_abused";
     IFUNNY_ERRORS["FORBIDDEN_FOR_BANNED"] = "forbidden_for_banned";

package/dist/utils/errors.js.map

@@ -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;AAcD;;GAEG;AACH,IAAY,aA8BX;AA9BD,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,gDAA+B,CAAA;IAC/B,kDAAiC,CAAA;IACjC,sDAAqC,CAAA;IACrC,oDAAmC,CAAA;AACpC,CAAC,EA9BW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA8BxB"}
+{"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

@@ -1,6 +1,6 @@
 {
 	"name": "@ifunny/ifunny-api-types",
-	"version": "0.6.7",
+	"version": "0.6.8",
 	"description": "iFunny API typings for use in bot library creaion.",
 	"main": "dist/index.js",
 	"types": "types",

package/types/rest/oauth2.d.ts

@@ -1,10 +1,13 @@
-import { RESTAPICaptchaError, RESTAPIErrorResponse } from "../utils/errors";
+import { RESTAPIErrorResponse } from "../utils/errors";
 export declare type RESTAPIOauth2Login = RESTAPIOauth2LoginSuccess | RESTAPIOauth2LoginError;
 export interface RESTAPIOauth2LoginSuccess {
     /**
      * Bearer token used for requests
      */
     access_token: string;
+    /**
+     * The type of token created
+     */
     token_type: TOKEN_TYPES.BEARER;
     /**
      * ? This Timestamp is in seconds, which is equivilent to 10 years
@@ -16,5 +19,17 @@ export declare enum TOKEN_TYPES {
     BASIC = "basic"
 }
 export declare type APITokenType = `${TOKEN_TYPES}`;
-export declare type RESTAPIOauth2LoginError = RESTAPIErrorResponse | RESTAPICaptchaError;
+export declare type RESTAPIOauth2LoginError = RESTAPIErrorResponse;
+export interface RESTAPISignUpSuccess {
+    /**
+     * Data about the account created
+     */
+    data: {
+        /**
+         * The user id of the account created
+         */
+        id: string;
+    };
+    status: 200;
+}
 //# sourceMappingURL=oauth2.d.ts.map

package/types/rest/oauth2.d.ts.map

@@ -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"}
+{"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

@@ -21,6 +21,19 @@ export interface RESTAPICaptchaError extends RESTAPIError {
     };
     status: 403;
 }
+/**
+ * Returned when an email is invalid
+ */
+export interface RESTAPIInvalidEmailError {
+    error: IFUNNY_ERRORS.INVALID_EMAIL;
+    error_decription: string;
+    status: 403;
+}
+export interface RESTAPIEmailExistsError {
+    error: IFUNNY_ERRORS.EMAIL_EXISTS;
+    error_description: string;
+    status: 403;
+}
 /**
  * Known captcha types
  */
@@ -32,7 +45,7 @@ declare type CaptchaType = `${CaptchaTypes}`;
 /**
  * Returns when the request throws an error.
  */
-export declare type RESTAPIErrorResponse = RESTAPICaptchaError | RESTAPIError;
+export declare type RESTAPIErrorResponse = RESTAPICaptchaError | RESTAPIInvalidEmailError | RESTAPIEmailExistsError | RESTAPIError;
 /**
  * Possible iFunny Errors
  */
@@ -47,6 +60,7 @@ export declare enum IFUNNY_ERRORS {
     BAD_REQUEST = "bad_request",
     CAPTCHA_REQUIRED = "captcha_required",
     CONTENT_WAS_DELETED = "content_was_deleted",
+    EMAIL_EXISTS = "email_exists",
     EMAIL_NOT_CONFIRMED = "email_not_confirmed",
     ENTITY_ABUSED = "entity_abused",
     FORBIDDEN_FOR_BANNED = "forbidden_for_banned",

package/types/utils/errors.d.ts.map

@@ -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;;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,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"}
+{"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,gBAAgB,EAAE,MAAM,CAAC;IACzB,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"}