@firmenakte/api-client 1.0.5 → 2.1.0

package/client.js

@@ -12,6 +12,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Api = exports.HttpClient = exports.ContentType = exports.ChangeType = void 0;
+/** Which register a change came from, and therefore which typed feed and payload it belongs to: "business" the Firmenbuch, "document" a newly filed document, "edikt" the Ediktsdatei, "gisa" the trade register, "scheinunternehmen" the BMF list. "unknown" is a change we could not classify. */
 var ChangeType;
 (function (ChangeType) {
     ChangeType["Business"] = "business";
@@ -195,6 +196,7 @@ class Api extends HttpClient {
              *
              * @tags Trades
              * @name V1TradesDocumentsDetail
+             * @summary Downloads the signed GISA PDF extract for a license (GISA-Zahl). Language defaults to German (De).
              * @request GET:/api/v1/trades/documents/{gisaZahl}
              * @secure
              */
@@ -210,6 +212,7 @@ class Api extends HttpClient {
              *
              * @tags Trades
              * @name V1TradesList
+             * @summary Returns the global catalog of GISA Trade Definitions with pagination.
              * @request GET:/api/v1/trades
              * @secure
              */
@@ -226,6 +229,7 @@ class Api extends HttpClient {
              *
              * @tags Trades
              * @name V1TradesLicensesList
+             * @summary Returns all company licenses for a specific trade definition with pagination.
              * @request GET:/api/v1/trades/{tradeKey}/licenses
              * @secure
              */
@@ -242,6 +246,7 @@ class Api extends HttpClient {
              *
              * @tags Trades
              * @name V1TradesCompanyDetail
+             * @summary Returns all licenses for a specific company (FNR).
              * @request GET:/api/v1/trades/company/{fnr}
              * @secure
              */
@@ -257,6 +262,7 @@ class Api extends HttpClient {
              *
              * @tags Trades
              * @name V1TradesChangesDetail
+             * @summary Returns a single GISA change by id.
              * @request GET:/api/v1/trades/changes/{id}
              * @secure
              */
@@ -268,10 +274,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
              *
              * @tags Trades
              * @name V1TradesChangesList
+             * @summary Feed of GISA changes — one entry per change to a company's trade licences.
              * @request GET:/api/v1/trades/changes
              * @secure
              */
@@ -287,7 +294,24 @@ class Api extends HttpClient {
              * No description
              *
              * @tags People
+             * @name V1PeopleNamesList
+             * @summary Returns (id, name) pairs for all people with at least one business assignment. For client-side name index.
+             * @request GET:/api/v1/people/names
+             * @secure
+             */
+            v1PeopleNamesList: (params = {}) => this.request({
+                path: `/api/v1/people/names`,
+                method: "GET",
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @description name and search behave identically here — both split the term on spaces and keep people whose "firstName lastName" contains every token, case-insensitively — except that search wins when both are given. Ordered by last name, then first name unless orderBy says otherwise. Combine with fnr or businessName to get the officers of one company, or with functionCode for one role. fnr, functionCode, businessName, businessCity and businessRegisteredSince_gte all describe one and the same assignment: a person comes back only if a single company of theirs satisfies every one of them. So the youngest owners of this year's new Viennese companies are one page: ?businessCity=Wien&businessRegisteredSince_gte=2026-01-01&functionCode=IN&functionCode=KP&functionCode=GS&functionCode=PG&orderBy=birthDate&orderByDescending=true&pageSize=3
+             *
+             * @tags People
              * @name V1PeopleList
+             * @summary Lists people who hold a function in, or a GISA licence for, an Austrian company.
              * @request GET:/api/v1/people
              * @secure
              */
@@ -300,10 +324,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description personId is the synthetic id described in the glossary — "firstname-lastname-birthdate", lower case, inner spaces replaced by hyphens and "x" for a part the register does not give, e.g. "max-mustermann-1970-01-01". It is matched exactly. Take it from a list row or from an assignment on a company rather than composing it yourself.
              *
              * @tags People
              * @name V1PeopleDetail
+             * @summary Returns one person with every company function, GISA licence and Edikt attached to them.
              * @request GET:/api/v1/people/{personId}
              * @secure
              */
@@ -314,11 +339,29 @@ class Api extends HttpClient {
                 format: "json",
                 ...params,
             }),
+            /**
+             * No description
+             *
+             * @tags Oenace
+             * @name V1OenaceList
+             * @summary Returns the OeNACE classification catalog with company counts. Results are ordered by company count descending — most used first.
+             * @request GET:/api/v1/oenace
+             * @secure
+             */
+            v1OenaceList: (query, params = {}) => this.request({
+                path: `/api/v1/oenace`,
+                method: "GET",
+                query: query,
+                secure: true,
+                format: "json",
+                ...params,
+            }),
             /**
              * No description
              *
              * @tags LegalForms
              * @name V1LegalformsList
+             * @summary Returns all legal forms with pagination and optional search, sorted by business count descending.
              * @request GET:/api/v1/legalforms
              * @secure
              */
@@ -331,10 +374,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description The network of people and companies around one starting point — who sits on which board with whom. nodes are people ("person") and companies ("business"), each carrying the id you would pass to /people/{personId} or /businesses/{fnr}; edges are source/target pairs of those ids whose relationshipType is "assignment", a person holding a function in a company. ("address", two companies registered at the same street address, is a second edge type the deployment can enable; it is off today, so expect only assignment edges.) The traversal depth is fixed at 2 hops and is not a parameter — a node with further connections outside that boundary carries hasMore=true, and isCentralNode marks the entity you started from. personId and fnr are mutually exclusive, not combinable: supplying both, or neither, is a 400, and an id that exists in neither register is a 404.
              *
              * @tags Graph
              * @name V1GraphList
+             * @summary Returns the graph (nodes and edges) within 2 hops of the start entity. Exactly one of personId or fnr must be provided.
              * @request GET:/api/v1/graph
              * @secure
              */
@@ -347,10 +391,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description Each row carries only id, fnr, changeType and the dates; fetch the payload with GET /globalchanges/{id}, or poll one register's typed feed instead (/businesses/changes, /documents/changes, /edikte/changes, /trades/changes). Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id.
              *
              * @tags GlobalChanges
              * @name V1GlobalchangesList
+             * @summary The single feed of every change across all registers — Firmenbuch, GISA, Ediktsdatei and the BMF Scheinunternehmen list — as lightweight reference rows.
              * @request GET:/api/v1/globalchanges
              * @secure
              */
@@ -363,10 +408,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description Built for watchlist polling: pass up to 1000 fnr values (repeat the parameter) and one cursor, and get back four arrays — businessChanges, documentChanges, ediktChanges, globalChanges — each ordered by ascending id and capped at maxResultsPerType. Not paged: raise maxResultsPerType or advance sinceId instead. sinceId is exclusive and since is inclusive, exactly as on the paged feeds, but one sinceId covers all four arrays: an array that comes back full at maxResultsPerType has more behind it and bounds the cursor, so advance sinceId only to the lowest of the full arrays' highest ids, and to the highest id of all four once none comes back full. Passing no fnr returns four empty arrays, not the whole feed.
              *
              * @tags GlobalChanges
              * @name V1GlobalchangesAggregatedList
+             * @summary Changes for a watchlist of companies, all four change types in one unpaged response.
              * @request GET:/api/v1/globalchanges/aggregated
              * @secure
              */
@@ -379,10 +425,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description The envelope is a discriminator plus the payload: changeType says which register, and data is the matching object — a BusinessChange, DocumentChange, EdiktChange, GisaChange or ScheinunternehmenChange. Since data is a union, read changeType before it.
              *
              * @tags GlobalChanges
              * @name V1GlobalchangesDetail
+             * @summary Returns one change with its typed payload, whichever register it came from.
              * @request GET:/api/v1/globalchanges/{id}
              * @secure
              */
@@ -394,10 +441,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "edikt" answers 404 here.
              *
              * @tags Edikte
              * @name V1EdikteChangesDetail
+             * @summary Returns one Ediktsdatei change by id.
              * @request GET:/api/v1/edikte/changes/{id}
              * @secure
              */
@@ -409,10 +457,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on the publication date, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss an insolvency notice resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
              *
              * @tags Edikte
              * @name V1EdikteChangesList
+             * @summary Feed of Ediktsdatei changes — insolvency and other court notices published about a company or a person.
              * @request GET:/api/v1/edikte/changes
              * @secure
              */
@@ -429,6 +478,7 @@ class Api extends HttpClient {
              *
              * @tags Documents
              * @name V1DocumentsDownloadDetail
+             * @summary Downloads a Firmenbuch document (PDF/XML) by its document key.
              * @request GET:/api/v1/documents/download/{documentKey}
              * @secure
              */
@@ -439,10 +489,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "document" answers 404 here.
              *
              * @tags Documents
              * @name V1DocumentsChangesDetail
+             * @summary Returns one document change by id, with the document's metadata.
              * @request GET:/api/v1/documents/changes/{id}
              * @secure
              */
@@ -454,10 +505,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description Each entry names a documentKey; fetch the file itself with GET /documents/download/{documentKey}. Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on the document date, and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses.
              *
              * @tags Documents
              * @name V1DocumentsChangesList
+             * @summary Feed of newly filed Firmenbuch documents — this is how you learn that a company has published a new Jahresabschluss.
              * @request GET:/api/v1/documents/changes
              * @secure
              */
@@ -474,6 +526,7 @@ class Api extends HttpClient {
              *
              * @tags Courts
              * @name V1CourtsList
+             * @summary Returns all courts with pagination and optional search, sorted by business count descending.
              * @request GET:/api/v1/courts
              * @secure
              */
@@ -489,7 +542,26 @@ class Api extends HttpClient {
              * No description
              *
              * @tags Businesses
+             * @name V1BusinessesResolveNamesCreate
+             * @summary Resolve company names to FNRs by exact name match (1:1). Used for CSV import.
+             * @request POST:/api/v1/businesses/resolve-names
+             * @secure
+             */
+            v1BusinessesResolveNamesCreate: (data, params = {}) => this.request({
+                path: `/api/v1/businesses/resolve-names`,
+                method: "POST",
+                body: data,
+                secure: true,
+                type: ContentType.Json,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @description name and search are different tools. name is a case-insensitive substring match on the company name and nothing else. search splits the term on spaces and keeps only companies matching every token, where a token matches the name, the fnr, or — when the whole term is a number — a GISA licence key or GISA-Zahl; it additionally lifts companies whose name starts with the term to the top of the default (name) ordering. So name narrows a known name, search finds an unknown one. Inactive companies always sort after active ones, whatever orderBy says. Pass countOnly=true for totalRecords without the rows, and use /businesses/aggregate to group the same filter set instead of paging through it.
+             *
+             * @tags Businesses
              * @name V1BusinessesList
+             * @summary Lists companies matching the filters, one page of list rows per call.
              * @request GET:/api/v1/businesses
              * @secure
              */
@@ -505,7 +577,24 @@ class Api extends HttpClient {
              * No description
              *
              * @tags Businesses
+             * @name V1BusinessesNamesList
+             * @summary Returns all business (fnr, name) pairs for client-side name index. No pagination.
+             * @request GET:/api/v1/businesses/names
+             * @secure
+             */
+            v1BusinessesNamesList: (params = {}) => this.request({
+                path: `/api/v1/businesses/names`,
+                method: "GET",
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @description Unfiltered — it is the size of the whole dataset, not of a search. For a count over filters, call GET /businesses with countOnly=true and read totalRecords.
+             *
+             * @tags Businesses
              * @name V1BusinessesCountList
+             * @summary Returns the number of companies in the dataset, as a bare integer.
              * @request GET:/api/v1/businesses/count
              * @secure
              */
@@ -520,13 +609,15 @@ class Api extends HttpClient {
              * No description
              *
              * @tags Businesses
-             * @name V1BusinessesDetail
-             * @request GET:/api/v1/businesses/{fnr}
+             * @name V1BusinessesAggregateList
+             * @summary Counts over the same filter set as GET /businesses, grouped by one dimension — the server-side GROUP BY that a caller would otherwise page the whole result set to compute. Every /businesses filter means exactly what it means there; page, pageSize, orderBy, orderByDescending and countOnly are ignored — top and minCount cap the bucket list instead. totalRecords equals /businesses?countOnly=true for the same filter; how the buckets relate to it is documented on BusinessAggregateResponse.
+             * @request GET:/api/v1/businesses/aggregate
              * @secure
              */
-            v1BusinessesDetail: (fnr, params = {}) => this.request({
-                path: `/api/v1/businesses/${fnr}`,
+            v1BusinessesAggregateList: (query, params = {}) => this.request({
+                path: `/api/v1/businesses/aggregate`,
                 method: "GET",
+                query: query,
                 secure: true,
                 format: "json",
                 ...params,
@@ -535,21 +626,40 @@ class Api extends HttpClient {
              * No description
              *
              * @tags Businesses
-             * @name V1BusinessesSyncCreate
-             * @request POST:/api/v1/businesses/{fnr}/sync
+             * @name V1BusinessesSimilarList
+             * @summary Active businesses similar to the given one (same OeNACE branch, same region preferred).
+             * @request GET:/api/v1/businesses/{fnr}/similar
              * @secure
              */
-            v1BusinessesSyncCreate: (fnr, params = {}) => this.request({
-                path: `/api/v1/businesses/${fnr}/sync`,
-                method: "POST",
+            v1BusinessesSimilarList: (fnr, params = {}) => this.request({
+                path: `/api/v1/businesses/${fnr}/similar`,
+                method: "GET",
                 secure: true,
+                format: "json",
                 ...params,
             }),
             /**
-             * No description
+             * @description fnr is matched exactly against the stored, normalised Firmenbuchnummer — lower case, no spaces, no leading zeros and no "FN" prefix, e.g. 34853f. Nothing is normalised on the way in, so "FN 34853 f" answers 404 rather than the company. 404 also means the company is not in the dataset yet.
+             *
+             * @tags Businesses
+             * @name V1BusinessesDetail
+             * @summary Returns the whole Firmenakte of one company: master data, addresses, people, GISA licences, Edikte, documents and the parsed annual accounts.
+             * @request GET:/api/v1/businesses/{fnr}
+             * @secure
+             */
+            v1BusinessesDetail: (fnr, params = {}) => this.request({
+                path: `/api/v1/businesses/${fnr}`,
+                method: "GET",
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * @description The id is the shared change id from GET /globalchanges, so an id that exists but whose changeType is not "business" answers 404 here.
              *
              * @tags Businesses
              * @name V1BusinessesChangesDetail
+             * @summary Returns one Firmenbuch change by id.
              * @request GET:/api/v1/businesses/changes/{id}
              * @secure
              */
@@ -561,10 +671,11 @@ class Api extends HttpClient {
                 ...params,
             }),
             /**
-             * No description
+             * @description Ordered by ascending id, and that id is the cursor: request with sinceId set to the highest id you have stored, walk page=1,2,… at a fixed pageSize until a page comes back with fewer than pageSize rows, keep the highest id you saw, and start the next poll from it. sinceId is exclusive, so nothing is delivered twice, and a new change always takes a higher id than every change already in the feed, so it appends to the end and never shifts a page you have already read. since is inclusive, filters on when we recorded the change rather than on changedDate — so a back-dated entry is not missed — and applies together with sinceId when both are sent. Paging without sinceId is not a reliable feed: an offset is not a watermark, and page stops at 1000. Under concurrent writes a change can become visible just after a higher id, so a consumer that must not miss one resumes from the previous poll's watermark and de-duplicates by id. fnr is normalised before matching — trimmed, spaces and leading zeros removed, case left alone — so 034853 f and 34853f are the same company, exactly as on GET /businesses. Use GET /globalchanges for the same feed across all four registers.
              *
              * @tags Businesses
              * @name V1BusinessesChangesList
+             * @summary Feed of Firmenbuch changes — one entry per new legal record (Eintragung).
              * @request GET:/api/v1/businesses/changes
              * @secure
              */
@@ -581,6 +692,7 @@ class Api extends HttpClient {
              *
              * @tags AssignmentFunctions
              * @name V1AssignmentfunctionsList
+             * @summary Returns all assignment functions (code/text lookup) for display. Cached 24h.
              * @request GET:/api/v1/assignmentfunctions
              * @secure
              */
@@ -596,6 +708,7 @@ class Api extends HttpClient {
              *
              * @tags Addresses
              * @name V1AddressesLocationsList
+             * @summary Returns unique City+ZipCode combinations from addresses with pagination and optional search.
              * @request GET:/api/v1/addresses/locations
              * @secure
              */
@@ -612,6 +725,7 @@ class Api extends HttpClient {
              *
              * @tags Addresses
              * @name V1AddressesCitiesList
+             * @summary Returns unique cities from addresses with pagination and optional search.
              * @request GET:/api/v1/addresses/cities
              * @secure
              */
@@ -628,6 +742,7 @@ class Api extends HttpClient {
              *
              * @tags Addresses
              * @name V1AddressesZipcodesList
+             * @summary Returns unique zip codes from addresses with pagination and optional search.
              * @request GET:/api/v1/addresses/zipcodes
              * @secure
              */