sec-edgar-api 0.3.1 → 0.3.2

package/build/services/SecEdgarApi/SecEdgarApi.d.ts

@@ -57,11 +57,6 @@ export interface GetDocumentXMLParams {
     accessionNumber: string;
     primaryDocument: string;
 }
-export interface GetSubmissionsParams {
-    /** symbol or cik */
-    symbol: string;
-    includeTranslated?: boolean;
-}
 /**
  * Gets reports from companies filed with the SEC
  *
@@ -93,7 +88,10 @@ export default class SecEdgarApi {
      *
      * endpoint: `/submissions/CIK${cik}.json`
      */
-    getSubmissions(params: GetSubmissionsParams): Promise<SubmissionList>;
+    getSubmissions(params: GetSymbolParams): Promise<{
+        submissionList: SubmissionList;
+        filings: FilingListItemTranslated[];
+    }>;
     /**
      * The company-concept API returns all the XBRL disclosures from a single company (CIK)
      * and concept (a taxonomy and tag) into a single JSON file, with a separate array
@@ -165,7 +163,7 @@ export default class SecEdgarApi {
      */
     getMutualFundList(): Promise<FieldDataResponse<'cik' | 'seriesId' | 'classId' | 'symbol'>>;
     /**
-     * Gets a raw xml document string. the parameters are found in the submission list response. (response.filings.recent or response.filings.recentTranslated)
+     * Gets a raw xml document string. the parameters are found in the submission list response.
      *
      * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
      *

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -168,21 +168,19 @@ var SecEdgarApi = /** @class */ (function () {
      * endpoint: `/submissions/CIK${cik}.json`
      */
     SecEdgarApi.prototype.getSubmissions = function (params) {
+        var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var symbol, includeTranslated, cik, submissions;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var symbol, cik, submissionList;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        symbol = params.symbol, includeTranslated = params.includeTranslated;
+                        symbol = params.symbol;
                         cik = this.getCikString(symbol);
                         return [4 /*yield*/, this.request("".concat(this.baseUrlEdgar, "/submissions/CIK").concat(cik, ".json"))];
                     case 1:
-                        submissions = _a.sent();
-                        submissions.cik = Number(submissions.cik);
-                        if (!includeTranslated)
-                            return [2 /*return*/, submissions];
-                        submissions.filings.recentTranslated = this.mapFilingListDetails(cik, submissions.filings.recent);
-                        return [2 /*return*/, submissions];
+                        submissionList = _b.sent();
+                        submissionList.cik = Number(submissionList.cik);
+                        return [2 /*return*/, { submissionList: submissionList, filings: this.mapFilingListDetails(cik, (_a = submissionList === null || submissionList === void 0 ? void 0 : submissionList.filings) === null || _a === void 0 ? void 0 : _a.recent) }];
                 }
             });
         });
@@ -342,7 +340,7 @@ var SecEdgarApi = /** @class */ (function () {
         });
     };
     /**
-     * Gets a raw xml document string. the parameters are found in the submission list response. (response.filings.recent or response.filings.recentTranslated)
+     * Gets a raw xml document string. the parameters are found in the submission list response.
      *
      * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
      *

package/build/types/submission.type.d.ts

@@ -57,7 +57,6 @@ export interface FilingListItemTranslated {
 interface FilingList {
     recent: FilingListDetails;
     files: FileData[];
-    recentTranslated?: FilingListItemTranslated[];
 }
 export interface SubmissionList {
     cik: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.3.1",
+    "version": "0.3.2",
     "description": "Fetch and parse SEC earnings reports and other filings. Useful for financial analysis.",
     "main": "build/index.js",
     "author": "Andrew Evers (https://github.com/andyevers)",