@ifunny/ifunny-api-types 0.1.0

package/dist/payloads/user.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NICK_COLORS = exports.BAN_TYPES = exports.RANKS = exports.MESSAGING_PRIVACY_STATUS = void 0;
+/**
+ * `public` anyone can create a direct message the user\
+ * `subscribers` only subscribers can create a direct message with the user\
+ * `closed` only the user can create direct messages\
+ * ? Backend does not check this status on requests as of 5/28/22
+ */
+var MESSAGING_PRIVACY_STATUS;
+(function (MESSAGING_PRIVACY_STATUS) {
+    MESSAGING_PRIVACY_STATUS["PUBLIC"] = "public";
+    MESSAGING_PRIVACY_STATUS["SUBSCRIBERS"] = "subscribers";
+    MESSAGING_PRIVACY_STATUS["CLOSED"] = "closed";
+})(MESSAGING_PRIVACY_STATUS = exports.MESSAGING_PRIVACY_STATUS || (exports.MESSAGING_PRIVACY_STATUS = {}));
+/**
+ * All current MemeRanks from the API
+ */
+var RANKS;
+(function (RANKS) {
+    RANKS["MEME_EXPLORER"] = "Meme explorer";
+    RANKS["MEME_BRO"] = "Meme bro";
+    RANKS["MEME_DADDY"] = "Meme daddy";
+    RANKS["DANK_MEMER"] = "Dank memer";
+    RANKS["MEME_MASTER_BAKER"] = "Meme master baker";
+    RANKS["DEEP_FRIED_MEMER"] = "Deep fried memer";
+    RANKS["SAUCY_MEMER"] = "Saucy memer";
+    RANKS["ORIGINAL_MEME_GANGSTER"] = "Original Meme Gangster";
+    RANKS["MEME_DEMON"] = "Meme demon";
+    RANKS["STEAL_BEAMS_OF_MEMES"] = "Steal beams of memes";
+    RANKS["MEME_DEALER"] = "Meme dealer";
+    RANKS["IFUNNY_VETERAN"] = "iFunny Veteran";
+    /**
+     * Final MemeExperience rank
+     */
+    RANKS["CHEFS_MEME_AGENT"] = "Chef's meme agent";
+})(RANKS = exports.RANKS || (exports.RANKS = {}));
+// TODO: Discover more ban types
+/**
+ * Known ban types
+ */
+var BAN_TYPES;
+(function (BAN_TYPES) {
+    BAN_TYPES["COLLECTIVE_SHADOW"] = "collective";
+})(BAN_TYPES = exports.BAN_TYPES || (exports.BAN_TYPES = {}));
+// TODO: Find all nick colors.
+/**
+ * Known nick colors
+ */
+var NICK_COLORS;
+(function (NICK_COLORS) {
+    NICK_COLORS["BRIGHT_GREEN"] = "55FF00";
+    NICK_COLORS["BETA_TESTER"] = "55FF00";
+    NICK_COLORS["MAROON"] = "660000";
+    NICK_COLORS["RED"] = "ff3e52";
+    NICK_COLORS["PURPLE"] = "a078f0";
+    NICK_COLORS["ORANGE"] = "e0b400";
+})(NICK_COLORS = exports.NICK_COLORS || (exports.NICK_COLORS = {}));
+//# sourceMappingURL=user.js.map

package/dist/payloads/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/payloads/user.ts"],"names":[],"mappings":";;;AAqIA;;;;;GAKG;AACH,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IACnC,6CAAiB,CAAA;IACjB,uDAA2B,CAAA;IAC3B,6CAAiB,CAAA;AAClB,CAAC,EAJW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAInC;AAgCD;;GAEG;AACH,IAAY,KAiBX;AAjBD,WAAY,KAAK;IAChB,wCAA+B,CAAA;IAC/B,8BAAqB,CAAA;IACrB,kCAAyB,CAAA;IACzB,kCAAyB,CAAA;IACzB,gDAAuC,CAAA;IACvC,8CAAqC,CAAA;IACrC,oCAA2B,CAAA;IAC3B,0DAAiD,CAAA;IACjD,kCAAyB,CAAA;IACzB,sDAA6C,CAAA;IAC7C,oCAA2B,CAAA;IAC3B,0CAAiC,CAAA;IACjC;;OAEG;IACH,+CAAsC,CAAA;AACvC,CAAC,EAjBW,KAAK,GAAL,aAAK,KAAL,aAAK,QAiBhB;AAID,gCAAgC;AAChC;;GAEG;AACH,IAAY,SAEX;AAFD,WAAY,SAAS;IACpB,6CAAgC,CAAA;AACjC,CAAC,EAFW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAEpB;AAsHD,8BAA8B;AAC9B;;GAEG;AACH,IAAY,WAOX;AAPD,WAAY,WAAW;IACtB,sCAAuB,CAAA;IACvB,qCAA0B,CAAA;IAC1B,gCAAiB,CAAA;IACjB,6BAAc,CAAA;IACd,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;AAClB,CAAC,EAPW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAOtB"}

package/dist/payloads/util.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=util.js.map

package/dist/payloads/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/payloads/util.ts"],"names":[],"mappings":""}

package/dist/rest/explore.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXPLORE_TAB_IDS = void 0;
+exports.EXPLORE_TAB_IDS = {
+    Best: 2,
+    Memes: 3,
+    Users: 4,
+    Chats: 5,
+    Channels: 6,
+};
+//# sourceMappingURL=explore.js.map

package/dist/rest/explore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"explore.js","sourceRoot":"","sources":["../../src/rest/explore.ts"],"names":[],"mappings":";;;AAMa,QAAA,eAAe,GAAG;IAC9B,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;IACR,QAAQ,EAAE,CAAC;CACF,CAAC"}

package/dist/rest/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./explore"), exports);
+__exportStar(require("./issues"), exports);
+//# sourceMappingURL=index.js.map

package/dist/rest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rest/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,2CAAyB"}

package/dist/rest/issues.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=issues.js.map

package/dist/rest/issues.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"issues.js","sourceRoot":"","sources":["../../src/rest/issues.ts"],"names":[],"mappings":""}

package/dist/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./util"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB"}

package/dist/utils/util.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=util.js.map

package/dist/utils/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/utils/util.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,46 @@
+{
+	"name": "@ifunny/ifunny-api-types",
+	"version": "0.1.0",
+	"description": "iFunny API typings for use in bot library creaion.",
+	"main": "dist/index.js",
+	"types": "types",
+	"scripts": {
+		"build-js": "tsc",
+		"build": "npm run build-js && npm run changelog",
+		"changelog": "auto-changelog -p  && git add CHANGELOG.md",
+		"test": "tsc --noEmit",
+		"link": "npm run build && npm link"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/ifunny-co/ifunny-api-types.git"
+	},
+	"keywords": [
+		"ifunny",
+		"types",
+		"typescript"
+	],
+	"author": "MakeShiftArtist <makeshiftdevelopment@gmail.com> (https://github.com/makeshiftartist)",
+	"license": "CC0-1.0",
+	"bugs": {
+		"url": "https://github.com/ifunny-co/ifunny-api-types/issues"
+	},
+	"homepage": "https://github.com/ifunny-co/ifunny-api-types#readme",
+	"devDependencies": {
+		"@types/node": "^17.0.36",
+		"auto-changelog": "^2.4.0",
+		"typescript": "^4.7.2"
+	},
+	"auto-changelog": {
+		"template": "changelog-template.hbs",
+		"hideEmptyReleases": true,
+		"commitLimit": false,
+		"unreleased": true,
+		"replaceText": {
+			"[Ff]eat:": "",
+			"[Ff]ix:": "",
+			"[Bb]reak:": "",
+			"[Dd]oc:": ""
+		}
+	}
+}

package/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./payloads";
+export * from "./rest";
+export * from "./utils";
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}

package/types/payloads/client.d.ts

@@ -0,0 +1,79 @@
+import { APIUserBase } from "./user";
+/**
+ * The user data retrieved from `/account`
+ */
+export interface APIClientUser extends APIUserBase {
+    /**
+     * Is the client blocked from using chats
+     */
+    is_blocked_in_messenger: boolean;
+    /**
+     * Is safe mode enabled
+     */
+    safe_mode: boolean;
+    /**
+     * Is the client a moderator of iFunny
+     */
+    is_moderator: boolean;
+    /**
+     * Is the client an iFunny staff member
+     */
+    is_ifunny_team_member: boolean;
+    /**
+     * Does the Client have unnotified bans
+     */
+    have_unnotified_bans: boolean;
+    /**
+     * Does the client have unnotified strikes
+     */
+    have_unnotified_strikes: boolean;
+    /**
+     * Does the client have unnotified achievements
+     */
+    have_unnotified_achievements: boolean;
+    /**
+     * Does the client have unnotified levels
+     */
+    have_unnotified_levels: boolean;
+    /**
+     * Does the client still need to set up their account
+     */
+    need_account_setup: boolean;
+    /**
+     * Hometown of the client. Can be an empty string
+     */
+    hometown: string;
+    /**
+     * Location of the client. Can be an empty string
+     */
+    location: string;
+    /**
+     * The Clinet's sex
+     */
+    sex: APIClientUserSex;
+    /**
+     * `YYYY-MM-DD`
+     */
+    birth_date: string;
+    /**
+     * The email attached to the Client's account
+     */
+    email: string;
+}
+/**
+ * All current genders (sex) for the Client
+ */
+export declare enum API_SEX {
+    MALE = "male",
+    FEMALE = "female",
+    OTHER = "other"
+}
+/**
+ * Possible sex types for the Client
+ */
+export declare type APIClientUserSex = `${API_SEX}`;
+/**
+ * Alias for {@link APIClientUserSex}
+ */
+export declare type APIClientUserGender = APIClientUserSex;
+//# sourceMappingURL=client.d.ts.map

package/types/payloads/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/payloads/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,WAAW;IACjD;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,4BAA4B,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,GAAG,EAAE,gBAAgB,CAAC;IACtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,oBAAY,OAAO;IAClB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;CACf;AAED;;GAEG;AACH,oBAAY,gBAAgB,GAAG,GAAG,OAAO,EAAE,CAAC;AAE5C;;GAEG;AACH,oBAAY,mBAAmB,GAAG,gBAAgB,CAAC"}

package/types/payloads/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./post";
+export * from "./user";
+export * from "./client";
+//# sourceMappingURL=index.d.ts.map

package/types/payloads/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/payloads/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}

package/types/payloads/post.d.ts

@@ -0,0 +1,372 @@
+import { HexCode, Size, Timestamp } from "../utils/util";
+import { APIUser, APIUserNums } from "./user";
+/**
+ * JSON data of an iFunny Post
+ */
+export interface APIPostBase<Type extends APIPostType = APIPostType> {
+    /**
+     * Unique id of the post.\
+     * Typically 9 characters long
+     */
+    id: string;
+    /**
+     * The type of the post.
+     */
+    type: Type;
+    /**
+     * Content url of the post.
+     */
+    url: string;
+    /**
+     * If the post uses the old watermark or the new one
+     */
+    old_watermark: boolean;
+    /**
+     * In-app share url.
+     * @example
+     * `https://ifunny.co/picture/${post.id}`
+     * `https://ifunny.co/video/${post.id}`
+     */
+    link: string;
+    /**
+     * The title of the post
+     */
+    title: string;
+    /**
+     * Fixed title of the post
+     * @example
+     * `Gif memes ${post.id} by ${post.creator.nick}`
+     * `Picture memes ${post.id} by ${post.creator.nick}: ${post.num.comments} comments`
+     */
+    fixed_title: string;
+    /**
+     * Array of tags on the post
+     */
+    tags: string[];
+    /**
+     * The publish state of the post
+     */
+    state: APIPostState;
+    /**
+     * {@link Timestamp} of when the post was created
+     */
+    date_create: Timestamp;
+    /**
+     * {@link Timestamp} of when the Post was published
+     */
+    publish_at: Timestamp;
+    /**
+     * Is the post smiled by the Client
+     */
+    is_smiled: boolean;
+    /**
+     * Is the post unsmiled by the Client
+     */
+    is_unsmiled: boolean;
+    /**
+     * Is the post removed by iFunny
+     */
+    is_abused: boolean;
+    /**
+     * Is the post featured by iFunny
+     */
+    is_featured: boolean;
+    /**
+     * Is the post republished by the Client
+     */
+    is_republished: boolean;
+    /**
+     * Is the post pinned by the creator
+     */
+    is_pinned: boolean;
+    /**
+     * Background color of the post.
+     */
+    bg_color: HexCode;
+    /**
+     * The {@link APIPostThumbnail thumbnail} of the post
+     */
+    thumb: APIPostThumbnail;
+    /**
+     * A post's {@link APIPostCopyright copyright} data
+     */
+    copyright: APIPostCopyright;
+    /**
+     * The {@link APIPostNums numbers} on the post.
+     */
+    num: APIPostNums;
+    /**
+     * The author of the post
+     */
+    creator: APIPostCreator;
+    /**
+     * Size of the post
+     */
+    size: Size;
+    /**
+     * The post's visibility
+     */
+    visibility: APIPostVisibility;
+    /**
+     * ? Don't know what this is
+     */
+    shot_status: APIPostShotStatus;
+    /**
+     * ? Don't know what this does
+     */
+    fast_start: boolean;
+    /**
+     * @example
+     * `https://ifunny.co/picture/${post.id}`
+     */
+    canonical_url: string;
+    /**
+     * Can the post be boosted still
+     */
+    can_be_boosted: boolean;
+}
+export declare enum POST_VISIBILITIES {
+    PUBLIC = "public"
+}
+export declare type APIPostVisibility = `${POST_VISIBILITIES}`;
+export declare enum SHOT_STATUSES {
+    APPROVED = "approved"
+}
+export declare type APIPostShotStatus = `${SHOT_STATUSES}`;
+/**
+ * All currently known post types
+ */
+export declare enum POST_TYPES {
+    PIC = "pic",
+    VIDEO_CLIP = "video_clip",
+    GIF = "gif",
+    GIF_CAPTION = "gif_caption",
+    CAPTION = "caption",
+    VINE = "vine",
+    COMICS = "comics",
+    MEME = "mem"
+}
+/**
+ * Possible post types
+ */
+export declare type APIPostType = `${POST_TYPES}`;
+export declare enum POST_STATES {
+    PUBLISHED = "published"
+}
+export declare type APIPostState = `${POST_STATES}`;
+/**
+ * Author of a Post\
+ * Only includes info also in the user object
+ */
+export declare type APIPostCreatorBase = Pick<APIUser, "id" | "nick" | "photo" | "is_verified" | "is_banned" | "is_deleted" | "is_in_subscriptions" | "is_in_subscribers" | "is_blocked" | "nick_color" | "original_nick">;
+/**
+ * The creator object for a post
+ */
+export interface APIPostCreator extends APIPostCreatorBase {
+    /**
+     * Only includes subscription and subscriber count
+     */
+    num: APIPostCreatorNum;
+    /**
+     * Total amount of posts the creator has. For some reason this is not in the nums object for creators
+     */
+    total_posts: number;
+}
+/**
+ * Alias for {@link APIPostCreator}
+ */
+export declare type APIPostAuthor = APIPostCreator;
+/**
+ * Num object for Post Creator.\
+ * total_posts is in the creator object for some reason
+ */
+export declare type APIPostCreatorNum = Pick<APIUserNums, "subscribers" | "subscriptions">;
+/**
+ * Numbers attatched to a post
+ */
+export interface APIPostNums {
+    /**
+     * The amount of smiles the post has
+     */
+    smiles: number;
+    /**
+     * The amount of unsmiles the post has
+     */
+    unsmiles: number;
+    /**
+     * How many smiles came from users visiting the creators profile
+     */
+    guest_smiles: number;
+    /**
+     * How many comments are on the post
+     */
+    comments: number;
+    /**
+     * How many views the post has
+     */
+    views: number;
+    /**
+     * How many republishes the post has
+     */
+    republished: number;
+    /**
+     * How many shares the post has.\
+     * ? Increases from the share url if the share url is different from the web_url
+     */
+    shares: number;
+}
+/**
+ * Copyright data for a post.
+ */
+export interface APIPostCopyright {
+    /**
+     * Note about the copyright
+     */
+    note?: string;
+    /**
+     * URL of original source
+     */
+    url?: string;
+}
+/**
+ * The Thumbnail object returned from the API\
+ * @example
+ * ```ts
+ * APIPostThumbnail.url = `https://imageproxy.ifunny.co/${params}/images/${content_id}.jpg`
+ * APIPostThumbnail.webp_url = `https://imageproxy.ifunny.co/${params}/images/${content_id}.webp
+ * ```
+ * Content URL params:\
+ * `crop:x-{number}` crops `number` pixels from bottom of the image\
+ * `crop:x+{number}` leaves `number` pixels at the top, and crops the rest\
+ * `crop:square` makes the image a square aspect ratio\
+ * `resize:{number}` changes the size of the image\
+ * `quality:{number}` changes the image quality\
+ *
+ *
+ * ? Bottom iFunny watermarks are 20 pixels tall\
+ * ? `crop:x-20` crops the watermakr from an image
+ */
+export interface APIPostThumbnail {
+    /**
+     * crop:x-20,crop:square,resize:65x,quality:90x75\
+     * `jpg`
+     */
+    small_url: string;
+    /**
+     * crop:x-20,crop:square,resize:160x,quality:90x75\
+     * `jpg`
+     */
+    url: string;
+    /**
+     * crop:x-20,crop:square,resize:320x,quality:90x75\
+     * `jpg`
+     */
+    large_url: string;
+    /**
+     * crop:x-20,resize:640x,quality:90x75\
+     * `jpg`
+     */
+    x640_url: string;
+    /**
+     * crop:x-20,resize:640x,quality:90x75
+     */
+    webp_url: string;
+    /**
+     * crop:x-20,crop:square,resize:320x,quality:90
+     */
+    large_webp_url: string;
+    /**
+     * crop:x-20,resize:640x,quality:90
+     */
+    x640_webp_url: string;
+    /**
+     * crop:x-20,resize:320x,crop:x800,quality:90x75
+     */
+    proportional_url: string;
+    /**
+     * crop:x-20,resize:320x,crop:x800,quality:90
+     */
+    proportional_webp_url: string;
+    /**
+     * The proportional size of the image
+     */
+    proportional_size: Size;
+}
+export interface APIPicturePost extends APIPostBase<"pic"> {
+    pic: {
+        /**
+         * webp format url of the post
+         */
+        webp_url: string;
+    };
+}
+/**
+ * A video post object
+ */
+export interface APIVideoPost extends APIPostBase<"video_clip"> {
+    video_clip: APIPostVideoData;
+}
+/**
+ * A gif post
+ */
+export interface APIGifPost extends APIPostBase<"gif"> {
+    gif: APIPostGifData;
+}
+/**
+ * A gif caption post
+ */
+export interface APIGifCaptionPost extends APIPostBase<"gif_caption"> {
+    gif: APIPostGifCaptionData;
+}
+/**
+ * A caption post
+ */
+export interface APICaptionPost extends APIPostBase<"caption"> {
+    caption: APIPostCaptionData;
+}
+export interface APIVinePost extends APIPostBase<"vine"> {
+}
+export interface APIComicsPost extends APIPostBase<"comics"> {
+}
+export interface APIMemePost extends APIPostBase<"mem"> {
+}
+export interface APIPostVideoData {
+    screen_url: string;
+    bytes: number;
+    source_type: "user";
+    duration: 0;
+}
+export declare enum VIDEO_SOURCE_TYPES {
+    USER = "user"
+}
+export declare type APIVideoPostSourceType = `${VIDEO_SOURCE_TYPES}`;
+export declare type APIPostGifCaptionData = APIPostGifData & APIPostCaptionData;
+export interface APIPostCaptionData {
+    /**
+     * The caption of the post
+     */
+    caption: string;
+}
+export interface APIPostGifData {
+    /**
+     * JPEG url of the post
+     */
+    screen_url: string;
+    /**
+     * How many bytes the post is
+     */
+    bytes: number;
+    /**
+     * Url of the post in MP4 format
+     */
+    mp4_url: string;
+    /**
+     * How many bytes the mp4 version is
+     */
+    mp4_bytes: number;
+}
+/**
+ * All possible Post Objects
+ */
+export declare type APIPost = APIPicturePost | APIVideoPost | APIGifPost | APIGifCaptionPost | APICaptionPost | APIVinePost | APIComicsPost | APIMemePost;
+//# sourceMappingURL=post.d.ts.map

package/types/payloads/post.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"post.d.ts","sourceRoot":"","sources":["../../src/payloads/post.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,IAAI,SAAS,WAAW,GAAG,WAAW;IAClE;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;IACpB;;OAEG;IACH,WAAW,EAAE,SAAS,CAAC;IACvB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IACxB;;OAEG;IACH,SAAS,EAAE,gBAAgB,CAAC;IAC5B;;OAEG;IACH,GAAG,EAAE,WAAW,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IACxB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,UAAU,EAAE,iBAAiB,CAAC;IAC9B;;OAEG;IACH,WAAW,EAAE,iBAAiB,CAAC;IAC/B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;CACxB;AAKD,oBAAY,iBAAiB;IAC5B,MAAM,WAAW;CACjB;AAED,oBAAY,iBAAiB,GAAG,GAAG,iBAAiB,EAAE,CAAC;AAGvD,oBAAY,aAAa;IACxB,QAAQ,aAAa;CACrB;AAED,oBAAY,iBAAiB,GAAG,GAAG,aAAa,EAAE,CAAC;AAEnD;;GAEG;AACH,oBAAY,UAAU;IACrB,GAAG,QAAQ;IACX,UAAU,eAAe;IACzB,GAAG,QAAQ;IACX,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,IAAI,QAAQ;CACZ;AAED;;GAEG;AACH,oBAAY,WAAW,GAAG,GAAG,UAAU,EAAE,CAAC;AAG1C,oBAAY,WAAW;IACtB,SAAS,cAAc;CACvB;AAED,oBAAY,YAAY,GAAG,GAAG,WAAW,EAAE,CAAC;AAI5C;;;GAGG;AACH,oBAAY,kBAAkB,GAAG,IAAI,CACpC,OAAO,EACL,IAAI,GACJ,MAAM,GACN,OAAO,GACP,aAAa,GACb,WAAW,GACX,YAAY,GACZ,qBAAqB,GACrB,mBAAmB,GACnB,YAAY,GACZ,YAAY,GACZ,eAAe,CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACzD;;OAEG;IACH,GAAG,EAAE,iBAAiB,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,cAAc,CAAC;AAE3C;;;GAGG;AACH,oBAAY,iBAAiB,GAAG,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,eAAe,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,iBAAiB,EAAE,IAAI,CAAC;CACxB;AAID,MAAM,WAAW,cAAe,SAAQ,WAAW,CAAC,KAAK,CAAC;IACzD,GAAG,EAAE;QACJ;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KACjB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW,CAAC,YAAY,CAAC;IAC9D,UAAU,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,WAAW,CAAC,KAAK,CAAC;IACrD,GAAG,EAAE,cAAc,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW,CAAC,aAAa,CAAC;IACpE,GAAG,EAAE,qBAAqB,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW,CAAC,SAAS,CAAC;IAC7D,OAAO,EAAE,kBAAkB,CAAC;CAC5B;AAGD,MAAM,WAAW,WAAY,SAAQ,WAAW,CAAC,MAAM,CAAC;CAAG;AAG3D,MAAM,WAAW,aAAc,SAAQ,WAAW,CAAC,QAAQ,CAAC;CAAG;AAG/D,MAAM,WAAW,WAAY,SAAQ,WAAW,CAAC,KAAK,CAAC;CAAG;AAG1D,MAAM,WAAW,gBAAgB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,CAAC,CAAC;CACZ;AAED,oBAAY,kBAAkB;IAC7B,IAAI,SAAS;CACb;AAED,oBAAY,sBAAsB,GAAG,GAAG,kBAAkB,EAAE,CAAC;AAE7D,oBAAY,qBAAqB,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAExE,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,oBAAY,OAAO,GAChB,cAAc,GACd,YAAY,GACZ,UAAU,GACV,iBAAiB,GACjB,cAAc,GACd,WAAW,GACX,aAAa,GACb,WAAW,CAAC"}