rettiwt-api 2.4.2 → 2.5.1

package/dist/models/errors/HttpError.d.ts

@@ -0,0 +1,17 @@
+import { RettiwtError } from './RettiwtError';
+/**
+ * Represents an HTTP error that occues while making a request to Twitter API.
+ *
+ * @internal
+ */
+export declare class HttpError extends RettiwtError {
+    /** The HTTP status code. */
+    status: number;
+    /**
+     * Initializes a new HttpError based on the given error details.
+     *
+     * @param httpStatus - The HTTP status code received upon making the request
+     * @param message - Any additional error message.
+     */
+    constructor(httpStatus: number, message?: string);
+}

package/dist/models/errors/HttpError.js

@@ -0,0 +1,42 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpError = void 0;
+// ERRORS
+var RettiwtError_1 = require("./RettiwtError");
+/**
+ * Represents an HTTP error that occues while making a request to Twitter API.
+ *
+ * @internal
+ */
+var HttpError = /** @class */ (function (_super) {
+    __extends(HttpError, _super);
+    /**
+     * Initializes a new HttpError based on the given error details.
+     *
+     * @param httpStatus - The HTTP status code received upon making the request
+     * @param message - Any additional error message.
+     */
+    function HttpError(httpStatus, message) {
+        var _this = _super.call(this, message) || this;
+        _this.status = httpStatus;
+        return _this;
+    }
+    return HttpError;
+}(RettiwtError_1.RettiwtError));
+exports.HttpError = HttpError;
+//# sourceMappingURL=HttpError.js.map

package/dist/models/errors/HttpError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpError.js","sourceRoot":"","sources":["../../../src/models/errors/HttpError.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,SAAS;AACT,+CAA8C;AAE9C;;;;GAIG;AACH;IAA+B,6BAAY;IAI1C;;;;;OAKG;IACH,mBAAmB,UAAkB,EAAE,OAAgB;QAAvD,YACC,kBAAM,OAAO,CAAC,SAGd;QADA,KAAI,CAAC,MAAM,GAAG,UAAU,CAAC;;IAC1B,CAAC;IACF,gBAAC;AAAD,CAAC,AAfD,CAA+B,2BAAY,GAe1C;AAfY,8BAAS"}

package/dist/models/errors/RettiwtError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Represents an error that arises inside the package.
+ *
+ * @internal
+ */
+export declare class RettiwtError extends Error {
+    constructor(message?: string);
+}

package/dist/models/errors/RettiwtError.js

@@ -0,0 +1,34 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RettiwtError = void 0;
+/**
+ * Represents an error that arises inside the package.
+ *
+ * @internal
+ */
+var RettiwtError = /** @class */ (function (_super) {
+    __extends(RettiwtError, _super);
+    function RettiwtError(message) {
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, RettiwtError.prototype);
+        return _this;
+    }
+    return RettiwtError;
+}(Error));
+exports.RettiwtError = RettiwtError;
+//# sourceMappingURL=RettiwtError.js.map

package/dist/models/errors/RettiwtError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RettiwtError.js","sourceRoot":"","sources":["../../../src/models/errors/RettiwtError.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA;;;;GAIG;AACH;IAAkC,gCAAK;IACtC,sBAAmB,OAAgB;QAAnC,YACC,kBAAM,OAAO,CAAC,SAGd;QADA,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;;IACrD,CAAC;IACF,mBAAC;AAAD,CAAC,AAND,CAAkC,KAAK,GAMtC;AANY,oCAAY"}

package/dist/models/errors/TimeoutError.d.ts

@@ -0,0 +1,14 @@
+import { RettiwtError } from './RettiwtError';
+/**
+ * Represents an HTTP error that occues while making a request to Twitter API.
+ *
+ * @internal
+ */
+export declare class TimeoutError extends RettiwtError {
+    /**
+     * Initializes a new TimeoutError based on the given error details.
+     *
+     * @param message - Error message with the configured timeout.
+     */
+    constructor(message?: string);
+}

package/dist/models/errors/TimeoutError.js

@@ -0,0 +1,39 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeoutError = void 0;
+// ERRORS
+var RettiwtError_1 = require("./RettiwtError");
+/**
+ * Represents an HTTP error that occues while making a request to Twitter API.
+ *
+ * @internal
+ */
+var TimeoutError = /** @class */ (function (_super) {
+    __extends(TimeoutError, _super);
+    /**
+     * Initializes a new TimeoutError based on the given error details.
+     *
+     * @param message - Error message with the configured timeout.
+     */
+    function TimeoutError(message) {
+        return _super.call(this, message) || this;
+    }
+    return TimeoutError;
+}(RettiwtError_1.RettiwtError));
+exports.TimeoutError = TimeoutError;
+//# sourceMappingURL=TimeoutError.js.map

package/dist/models/errors/TimeoutError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimeoutError.js","sourceRoot":"","sources":["../../../src/models/errors/TimeoutError.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,SAAS;AACT,+CAA8C;AAE9C;;;;GAIG;AACH;IAAkC,gCAAY;IAC7C;;;;OAIG;IACH,sBAAmB,OAAgB;eAClC,kBAAM,OAAO,CAAC;IACf,CAAC;IACF,mBAAC;AAAD,CAAC,AATD,CAAkC,2BAAY,GAS7C;AATY,oCAAY"}

package/dist/services/internal/ErrorService.d.ts

@@ -0,0 +1,85 @@
+import { AxiosError, AxiosResponse } from 'axios';
+import { IErrorHandler } from '../../types/ErrorHandler';
+import { ApiError } from '../../models/errors/ApiError';
+import { HttpError } from '../../models/errors/HttpError';
+/**
+ * The base service that handles any errors.
+ *
+ * @public
+ */
+export declare class ErrorService implements IErrorHandler {
+    /**
+     * Error message used when the specific error type is not defined in the required enums.
+     */
+    protected static readonly DEFAULT_ERROR_MESSAGE = "Unknown error";
+    /**
+     * The method called when an error response is received from Twitter API.
+     *
+     * @param error - The error caught while making HTTP request to Twitter API.
+     */
+    handle(error: unknown): void;
+    /**
+     * Handles exceeded timeout, configured in RettiwtConfig.
+     *
+     * @param error - The error object.
+     * @throws An error if the configured request timeout has been exceeded.
+     */
+    protected handleTimeoutError(error: AxiosError): void;
+    /**
+     * Retrieves the response data from the given error.
+     *
+     * @param error - The error object.
+     * @returns The response data.
+     * @throws The original error if it is not an HTTP error with a response.
+     */
+    protected getAxiosResponse(error: AxiosError): AxiosResponse;
+    /**
+     * Handles HTTP error in a response.
+     *
+     * @param response - The response object received.
+     * @throws An error with the corresponding HTTP status text if any HTTP-related error has occurred.
+     */
+    protected handleHttpError(response: AxiosResponse): void;
+    /**
+     * Handles API error in a response.
+     *
+     * @param response - The response object received.
+     * @throws An error with the corresponding API error message if any API-related error has occurred.
+     */
+    protected handleApiError(response: AxiosResponse): void;
+    /**
+     * Creates an HTTP error instance based on the provided HTTP status.
+     *
+     * @param httpStatus - The HTTP status code.
+     * @returns An HTTP error instance.
+     */
+    protected createHttpError(httpStatus: number): HttpError;
+    /**
+     * Retrieves the HTTP error message based on the provided HTTP status.
+     *
+     * @param httpStatus - The HTTP status code.
+     * @returns The HTTP error message.
+     */
+    protected getHttpErrorMessage(httpStatus: number): string;
+    /**
+     * Retrieves the API error code from the Axios response data.
+     *
+     * @param response - The response object received.
+     * @returns The error code, or undefined if not found.
+     */
+    protected getErrorCode(response: AxiosResponse): number | undefined;
+    /**
+     * Creates an API error instance based on the provided error code.
+     *
+     * @param errorCode - The error code.
+     * @returns An API error instance.
+     */
+    protected createApiError(errorCode: number): ApiError;
+    /**
+     * Retrieves the API error message based on the provided error code.
+     *
+     * @param errorCode - The error code.
+     * @returns The API error message.
+     */
+    protected getApiErrorMessage(errorCode: number): string;
+}

package/dist/services/internal/ErrorService.js

@@ -0,0 +1,144 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorService = void 0;
+// PACKAGES
+var axios_1 = __importDefault(require("axios"));
+var JsonUtils_1 = require("../../helper/JsonUtils");
+// ENUMS
+var Api_1 = require("../../enums/Api");
+var Http_1 = require("../../enums/Http");
+var rettiwt_core_1 = require("rettiwt-core");
+// ERRORS
+var ApiError_1 = require("../../models/errors/ApiError");
+var HttpError_1 = require("../../models/errors/HttpError");
+var TimeoutError_1 = require("../../models/errors/TimeoutError");
+// TODO Refactor and document this module
+/**
+ * The base service that handles any errors.
+ *
+ * @public
+ */
+var ErrorService = exports.ErrorService = /** @class */ (function () {
+    function ErrorService() {
+    }
+    /**
+     * The method called when an error response is received from Twitter API.
+     *
+     * @param error - The error caught while making HTTP request to Twitter API.
+     */
+    ErrorService.prototype.handle = function (error) {
+        if (!axios_1.default.isAxiosError(error)) {
+            throw error;
+        }
+        this.handleTimeoutError(error);
+        var axiosResponse = this.getAxiosResponse(error);
+        this.handleApiError(axiosResponse);
+        this.handleHttpError(axiosResponse);
+    };
+    /**
+     * Handles exceeded timeout, configured in RettiwtConfig.
+     *
+     * @param error - The error object.
+     * @throws An error if the configured request timeout has been exceeded.
+     */
+    ErrorService.prototype.handleTimeoutError = function (error) {
+        if (error.code === 'ECONNABORTED') {
+            throw new TimeoutError_1.TimeoutError(error.message);
+        }
+    };
+    /**
+     * Retrieves the response data from the given error.
+     *
+     * @param error - The error object.
+     * @returns The response data.
+     * @throws The original error if it is not an HTTP error with a response.
+     */
+    ErrorService.prototype.getAxiosResponse = function (error) {
+        if (error.response) {
+            return error.response;
+        }
+        throw error;
+    };
+    /**
+     * Handles HTTP error in a response.
+     *
+     * @param response - The response object received.
+     * @throws An error with the corresponding HTTP status text if any HTTP-related error has occurred.
+     */
+    ErrorService.prototype.handleHttpError = function (response) {
+        throw this.createHttpError(response.status);
+    };
+    /**
+     * Handles API error in a response.
+     *
+     * @param response - The response object received.
+     * @throws An error with the corresponding API error message if any API-related error has occurred.
+     */
+    ErrorService.prototype.handleApiError = function (response) {
+        var errorCode = this.getErrorCode(response);
+        if (errorCode === undefined) {
+            return;
+        }
+        throw this.createApiError(errorCode);
+    };
+    /**
+     * Creates an HTTP error instance based on the provided HTTP status.
+     *
+     * @param httpStatus - The HTTP status code.
+     * @returns An HTTP error instance.
+     */
+    ErrorService.prototype.createHttpError = function (httpStatus) {
+        return new HttpError_1.HttpError(httpStatus, this.getHttpErrorMessage(httpStatus));
+    };
+    /**
+     * Retrieves the HTTP error message based on the provided HTTP status.
+     *
+     * @param httpStatus - The HTTP status code.
+     * @returns The HTTP error message.
+     */
+    ErrorService.prototype.getHttpErrorMessage = function (httpStatus) {
+        return Object.values(Http_1.EHttpStatus).includes(httpStatus)
+            ? Http_1.EHttpStatus[httpStatus]
+            : ErrorService.DEFAULT_ERROR_MESSAGE;
+    };
+    /**
+     * Retrieves the API error code from the Axios response data.
+     *
+     * @param response - The response object received.
+     * @returns The error code, or undefined if not found.
+     */
+    ErrorService.prototype.getErrorCode = function (response) {
+        var errors = response.data.errors;
+        return !!errors && errors.length ? errors[0].code : undefined;
+    };
+    /**
+     * Creates an API error instance based on the provided error code.
+     *
+     * @param errorCode - The error code.
+     * @returns An API error instance.
+     */
+    ErrorService.prototype.createApiError = function (errorCode) {
+        return new ApiError_1.ApiError(errorCode, this.getApiErrorMessage(errorCode));
+    };
+    /**
+     * Retrieves the API error message based on the provided error code.
+     *
+     * @param errorCode - The error code.
+     * @returns The API error message.
+     */
+    ErrorService.prototype.getApiErrorMessage = function (errorCode) {
+        var errorCodeKey = (0, JsonUtils_1.findKeyByValue)(rettiwt_core_1.EErrorCodes, errorCode.toString());
+        return !!errorCodeKey && errorCodeKey in Api_1.EApiErrors
+            ? Api_1.EApiErrors[errorCodeKey]
+            : ErrorService.DEFAULT_ERROR_MESSAGE;
+    };
+    /**
+     * Error message used when the specific error type is not defined in the required enums.
+     */
+    ErrorService.DEFAULT_ERROR_MESSAGE = 'Unknown error';
+    return ErrorService;
+}());
+//# sourceMappingURL=ErrorService.js.map

package/dist/services/internal/ErrorService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorService.js","sourceRoot":"","sources":["../../../src/services/internal/ErrorService.ts"],"names":[],"mappings":";;;;;;AAAA,WAAW;AACX,gDAAyD;AACzD,oDAAwD;AAKxD,QAAQ;AACR,uCAA6C;AAC7C,yCAA+C;AAC/C,6CAA2C;AAE3C,SAAS;AACT,yDAAwD;AACxD,2DAA0D;AAC1D,iEAAgE;AAEhE,yCAAyC;AAEzC;;;;GAIG;AACH;IAAA;IAqIA,CAAC;IA/HA;;;;OAIG;IACI,6BAAM,GAAb,UAAc,KAAc;QAC3B,IAAI,CAAC,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;YAC/B,MAAM,KAAK,CAAC;SACZ;QAED,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAE/B,IAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACnC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACO,yCAAkB,GAA5B,UAA6B,KAAiB;QAC7C,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;YAClC,MAAM,IAAI,2BAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SACtC;IACF,CAAC;IAED;;;;;;OAMG;IACO,uCAAgB,GAA1B,UAA2B,KAAiB;QAC3C,IAAI,KAAK,CAAC,QAAQ,EAAE;YACnB,OAAO,KAAK,CAAC,QAAQ,CAAC;SACtB;QAED,MAAM,KAAK,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACO,sCAAe,GAAzB,UAA0B,QAAuB;QAChD,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACO,qCAAc,GAAxB,UAAyB,QAAuB;QAC/C,IAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE9C,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,OAAO;SACP;QAED,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACO,sCAAe,GAAzB,UAA0B,UAAkB;QAC3C,OAAO,IAAI,qBAAS,CAAC,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACO,0CAAmB,GAA7B,UAA8B,UAAkB;QAC/C,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAW,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;YACrD,CAAC,CAAC,kBAAW,CAAC,UAAU,CAAC;YACzB,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACO,mCAAY,GAAtB,UAAuB,QAAuB;QAC7C,IAAM,MAAM,GAAI,QAAQ,CAAC,IAAuC,CAAC,MAAM,CAAC;QAExE,OAAO,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACO,qCAAc,GAAxB,UAAyB,SAAiB;QACzC,OAAO,IAAI,mBAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACO,yCAAkB,GAA5B,UAA6B,SAAiB;QAC7C,IAAM,YAAY,GAAG,IAAA,0BAAc,EAAC,0BAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEvE,OAAO,CAAC,CAAC,YAAY,IAAI,YAAY,IAAI,gBAAU;YAClD,CAAC,CAAC,gBAAU,CAAC,YAAuC,CAAC;YACrD,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC;IACvC,CAAC;IAnID;;OAEG;IACuB,kCAAqB,GAAG,eAAe,CAAC;IAiInE,mBAAC;CAAA,AArID,IAqIC"}

package/dist/services/internal/FetcherService.d.ts

@@ -1,8 +1,8 @@
-import { Args, EResourceType } from 'rettiwt-core';
-import { RettiwtConfig } from '../../models/internal/RettiwtConfig';
-import { CursoredData } from '../../models/public/CursoredData';
-import { Tweet } from '../../models/public/Tweet';
-import { User } from '../../models/public/User';
+import { FetchArgs, PostArgs, EResourceType } from 'rettiwt-core';
+import { IRettiwtConfig } from '../../types/RettiwtConfig';
+import { CursoredData } from '../../models/data/CursoredData';
+import { Tweet } from '../../models/data/Tweet';
+import { User } from '../../models/data/User';
 /**
  * The base service that handles all HTTP requests.
  *
@@ -13,14 +13,20 @@ export declare class FetcherService {
     private cred?;
     /** Whether the instance is authenticated or not. */
     private readonly isAuthenticated;
+    /** The URL to the proxy server to use for authentication. */
+    protected readonly authProxyUrl?: URL;
     /** The HTTPS Agent to use for requests to Twitter API. */
     private readonly httpsAgent;
+    /** The max wait time for a response. */
+    private readonly timeout;
     /** The log service instance to use to logging. */
     private readonly logger;
+    /** The service used to handle HTTP and API errors */
+    private readonly errorHandler;
     /**
      * @param config - The config object for configuring the Rettiwt instance.
      */
-    constructor(config?: RettiwtConfig);
+    constructor(config?: IRettiwtConfig);
     /**
      * Returns an AuthCredential generated using the given API key.
      *
@@ -49,25 +55,10 @@ export declare class FetcherService {
      * @returns The HttpsAgent to use.
      */
     private getHttpsAgent;
-    /**
-     * The middleware for handling any http error.
-     *
-     * @param res - The response object received.
-     * @returns The received response, if no HTTP errors are found.
-     * @throws An error if any HTTP-related error has occured.
-     */
-    private handleHttpError;
-    /**
-     * The middleware for handling any Twitter API-level errors.
-     *
-     * @param res - The response object received.
-     * @returns The received response, if no API errors are found.
-     * @throws An error if any API-related error has occured.
-     */
-    private handleApiError;
     /**
      * Makes an HTTP request according to the given parameters.
      *
+     * @typeParam ResType - The type of the returned response data.
      * @param config - The request configuration.
      * @returns The response received.
      */
@@ -96,7 +87,7 @@ export declare class FetcherService {
      * @typeParam OutType - The type of deserialized data returned.
      * @returns The processed data requested from Twitter.
      */
-    protected fetch<OutType extends Tweet | User>(resourceType: EResourceType, args: Args): Promise<CursoredData<OutType>>;
+    protected fetch<OutType extends Tweet | User>(resourceType: EResourceType, args: FetchArgs): Promise<CursoredData<OutType>>;
     /**
      * Posts the requested resource to Twitter and returns the response.
      *
@@ -104,5 +95,12 @@ export declare class FetcherService {
      * @param args - Resource specific arguments.
      * @returns Whether posting was successful or not.
      */
-    protected post(resourceType: EResourceType, args: Args): Promise<boolean>;
+    protected post(resourceType: EResourceType, args: PostArgs): Promise<boolean>;
+    /**
+     * Uploads the given media file to Twitter
+     *
+     * @param media - The path to the media file to upload.
+     * @returns The id of the uploaded media.
+     */
+    protected upload(media: string): Promise<string>;
 }