@firmenakte/api-client 2.23.0 → 2.25.0

package/v2/generated/types.gen.d.ts

@@ -22,6 +22,77 @@ export type AccountSubject = {
     city?: null | string;
     entryId?: null | string;
 };
+export type AddressCoordinatesResponse = {
+    lat: number;
+    lng: number;
+    source: string;
+    transformationAccuracyMetres: number;
+    determination: string;
+    sourceMethod: string;
+};
+export type AddressGeographyReference = {
+    id: string;
+    type: string;
+    code: string;
+    label: string;
+};
+export type AddressProvenance = {
+    source: string;
+    sourceDate: string;
+    importedAt: string;
+    datasetVersion: string;
+    license: string;
+    attribution: string;
+    processing: string;
+};
+export type AddressUpdateStatus = {
+    status: string;
+    sourceDate?: null | string;
+    importedAt?: null | string;
+    datasetVersion?: null | string;
+    lastCheck?: null | string;
+    lastError?: null | string;
+    revision?: null | string;
+};
+export type AddressValidationRequest = {
+    /**
+     * Country code/name; required.
+     */
+    country: string;
+    /**
+     * Full address; or supply street fields.
+     */
+    text?: null | string;
+    /**
+     * Street.
+     */
+    street?: null | string;
+    /**
+     * Base house number.
+     */
+    houseNumber?: null | string;
+    /**
+     * Postal code.
+     */
+    zip?: null | string;
+    /**
+     * City.
+     */
+    city?: null | string;
+    /**
+     * Unit; never BEV-verified.
+     */
+    unit?: null | string;
+};
+export type AddressValidationResponse = {
+    status: string;
+    address?: null | ReferenceAddressResponse;
+    candidates: Array<ReferenceAddressResponse>;
+    changes: Array<string>;
+    unitStatus: string;
+    coverage: string;
+    datasetVersion?: null | string;
+};
 /**
  * A Firmenakte ID or register alias, for example fnr:56247t, resolved to the canonical record.
  */
@@ -59,6 +130,10 @@ export type CatalogEntry = {
     fieldDetailSince?: null | string;
     detailCoverage?: null | string;
     parentCode?: null | string;
+    parentCodes?: null | Array<string>;
+    geographyId?: null | string;
+    geographyType?: null | string;
+    datasetVersion?: null | string;
     childCount?: null | number;
     refCount?: null | number;
     path?: null | Array<CatalogPathEntry>;
@@ -259,6 +334,11 @@ export type CompanyAddress = {
     current: boolean;
     source: string;
     country?: null | string;
+    addressId?: null | string;
+    matchStatus?: null | string;
+    datasetVersion?: null | string;
+    unit?: null | string;
+    until?: null | string;
 };
 export type CompanyAggregateGroup = {
     groupBy: string;
@@ -597,6 +677,11 @@ export type CompanySeat = {
     state?: null | string;
     country?: null | string;
     location?: null | GeoLocation;
+    addressId?: null | string;
+    matchStatus?: null | string;
+    coordinateSource?: null | string;
+    datasetVersion?: null | string;
+    role?: null | string;
 };
 export type CompanyTopItem = {
     group: TopGroup;
@@ -907,6 +992,11 @@ export type CursorPageOfPlaceEntry = {
     nextCursor?: null | string;
     total?: null | number;
 };
+export type CursorPageOfReferenceAddressResponse = {
+    items: Array<ReferenceAddressResponse>;
+    nextCursor?: null | string;
+    total?: null | number;
+};
 export type CursorPageOfRuleDto = {
     items: Array<RuleDto>;
     nextCursor?: null | string;
@@ -1132,6 +1222,8 @@ export type FieldDefinition = {
     aliases?: null | Array<string>;
     projection?: null | FieldProjection;
     catalog?: null | string;
+    filterVia?: null | string;
+    searchTerms?: null | Array<string>;
 };
 export type FieldDto = {
     id: string;
@@ -1148,6 +1240,7 @@ export type FieldDto = {
 export type FieldGroup = {
     code: string;
     label: string;
+    rank?: null | number;
 };
 export type FieldOption = {
     code: string;
@@ -1238,6 +1331,16 @@ export type GeoCluster = {
     count: number;
     kind?: null | string;
 };
+export type GeographicPlaceResponse = {
+    id: string;
+    type: string;
+    code: string;
+    name: string;
+    active: boolean;
+    sourceDate: string;
+    datasetVersion: string;
+    parents: Array<AddressGeographyReference>;
+};
 export type GeoLocation = {
     lat: number;
     lng: number;
@@ -1732,6 +1835,9 @@ export type PlaceEntry = {
     aliases?: null | Array<string>;
     companyCount?: null | number;
     parentCode?: null | string;
+    parentCodes?: null | Array<string>;
+    geographyId?: null | string;
+    datasetVersion?: null | string;
     level?: null | number;
     childCount?: null | number;
     refCount?: null | number;
@@ -1765,9 +1871,23 @@ export type ReadNotificationsDto = {
     ids?: null | Array<string>;
     all?: boolean;
 };
+export type ReferenceAddressResponse = {
+    id: string;
+    bevCode: string;
+    street: string;
+    houseNumber: string;
+    zip: string;
+    city: string;
+    country: string;
+    active: boolean;
+    geography: Array<AddressGeographyReference>;
+    coordinates: AddressCoordinatesResponse;
+    provenance: AddressProvenance;
+};
 export type RegisterIdentifier = {
     scheme: string;
     value: string;
+    source?: null | string;
 };
 export type RegistrationAddress = {
     street?: null | string;
@@ -4692,11 +4812,16 @@ export type GetMyEntityData = {
     };
     path: {
         /**
-         * Workspace resource ID.
+         * Firmenakte ID, register alias such as fnr:56247t, or workspace own-record ID.
          */
         id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Resolve current register values for source fields. Defaults to true; false returns only stored workspace fields, including saved Firmenakte fields, without projecting register values.
+         */
+        resolveSourceValues?: boolean;
+    };
     url: '/api/v2/me/entities/{id}';
 };
 export type GetMyEntityErrors = {
@@ -4763,7 +4888,12 @@ export type UpdateMyEntityData = {
          */
         id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Resolve current register values in the response. Defaults to true; false returns only saved workspace source-field values.
+         */
+        resolveSourceValues?: boolean;
+    };
     url: '/api/v2/me/entities/{id}';
 };
 export type UpdateMyEntityErrors = {
@@ -5459,7 +5589,12 @@ export type GetOwnRecordData = {
          */
         id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Resolve current register values for source fields. Defaults to true; false returns only saved workspace fields.
+         */
+        resolveSourceValues?: boolean;
+    };
     url: '/api/v2/me/own-records/{id}';
 };
 export type GetOwnRecordErrors = {
@@ -5541,7 +5676,12 @@ export type UpdateOwnRecordData = {
          */
         id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Resolve current register values in the response. Defaults to true; false returns only saved workspace source-field values.
+         */
+        resolveSourceValues?: boolean;
+    };
     url: '/api/v2/me/own-records/{id}';
 };
 export type UpdateOwnRecordErrors = {
@@ -7769,7 +7909,7 @@ export type ListFieldCatalogData = {
          */
         filterable?: boolean;
         /**
-         * Optional exact group.code from field metadata, for example figures, company, status, people, person or account. Groups come from the same catalog used by the interface.
+         * Optional exact group.code from this subject's field metadata: basics, location, activity, status, people, figures or account. Groups describe the field's meaning, independently of its value type.
          */
         group?: string;
     };
@@ -8888,6 +9028,338 @@ export type ListSimilarCompaniesResponses = {
     200: CursorPageOfSimilarCompany;
 };
 export type ListSimilarCompaniesResponse = ListSimilarCompaniesResponses[keyof ListSimilarCompaniesResponses];
+export type GetAddressStatusData = {
+    body?: never;
+    headers?: {
+        /**
+         * Optional replay key, retained for 24 hours. Replays are free.
+         */
+        'Idempotency-Key'?: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/v2/addresses/status';
+};
+export type GetAddressStatusErrors = {
+    /**
+     * Malformed request, or a cursor from another request.
+     */
+    400: Problem;
+    /**
+     * No valid API key or session.
+     */
+    401: Problem;
+    /**
+     * Not enough credits for this call.
+     */
+    402: Problem;
+    /**
+     * Not found, or it belongs to another workspace.
+     */
+    404: Problem;
+    /**
+     * Conflict with the current state; `code` says which.
+     */
+    409: Problem;
+    /**
+     * Erased or expired.
+     */
+    410: Problem;
+    /**
+     * Validation failed; `errors[]` names each parameter or JSON pointer.
+     */
+    422: Problem;
+    /**
+     * Too many requests; retry after `Retry-After`.
+     */
+    429: Problem;
+    /**
+     * Internal error; quote `requestId` to support.
+     */
+    500: Problem;
+};
+export type GetAddressStatusError = GetAddressStatusErrors[keyof GetAddressStatusErrors];
+export type GetAddressStatusResponses = {
+    /**
+     * Read address snapshot status.
+     */
+    200: AddressUpdateStatus;
+};
+export type GetAddressStatusResponse = GetAddressStatusResponses[keyof GetAddressStatusResponses];
+export type SearchAddressesData = {
+    body?: never;
+    headers?: {
+        /**
+         * ETag from a previous read. A match returns a free 304.
+         */
+        'If-None-Match'?: string;
+        /**
+         * Optional replay key, retained for 24 hours. Replays are free.
+         */
+        'Idempotency-Key'?: string;
+    };
+    path?: never;
+    query?: {
+        /**
+         * Address search text, 2–200 characters.
+         */
+        q?: string;
+        /**
+         * Page size, 1–100; default 25. Zero is not supported.
+         */
+        limit?: number;
+        /**
+         * Opaque continuation from nextCursor. Bound to the query, geography, postal code and active snapshot; expires after 24 hours.
+         */
+        cursor?: string;
+        /**
+         * Optional G-ID restricting geography.
+         */
+        geographyId?: string;
+        /**
+         * Optional postal code.
+         */
+        zip?: string;
+    };
+    url: '/api/v2/addresses';
+};
+export type SearchAddressesErrors = {
+    /**
+     * Malformed request, or a cursor from another request.
+     */
+    400: Problem;
+    /**
+     * No valid API key or session.
+     */
+    401: Problem;
+    /**
+     * Not enough credits for this call.
+     */
+    402: Problem;
+    /**
+     * Not found, or it belongs to another workspace.
+     */
+    404: Problem;
+    /**
+     * Conflict with the current state; `code` says which.
+     */
+    409: Problem;
+    /**
+     * Erased or expired.
+     */
+    410: Problem;
+    /**
+     * Validation failed; `errors[]` names each parameter or JSON pointer.
+     */
+    422: Problem;
+    /**
+     * Too many requests; retry after `Retry-After`.
+     */
+    429: Problem;
+    /**
+     * Internal error; quote `requestId` to support.
+     */
+    500: Problem;
+};
+export type SearchAddressesError = SearchAddressesErrors[keyof SearchAddressesErrors];
+export type SearchAddressesResponses = {
+    /**
+     * Search Austrian reference addresses.
+     */
+    200: CursorPageOfReferenceAddressResponse;
+};
+export type SearchAddressesResponse = SearchAddressesResponses[keyof SearchAddressesResponses];
+export type CheckAddressData = {
+    /**
+     * Country is required. Supply full address text or structured street fields. Matching needs a base house number, postal code and city; units remain unverified. The input is never saved.
+     */
+    body: AddressValidationRequest;
+    headers?: {
+        /**
+         * Optional replay key, retained for 24 hours. Replays are free.
+         */
+        'Idempotency-Key'?: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/v2/addresses/validate';
+};
+export type CheckAddressErrors = {
+    /**
+     * Malformed request, or a cursor from another request.
+     */
+    400: Problem;
+    /**
+     * No valid API key or session.
+     */
+    401: Problem;
+    /**
+     * Not enough credits for this call.
+     */
+    402: Problem;
+    /**
+     * Not found, or it belongs to another workspace.
+     */
+    404: Problem;
+    /**
+     * Conflict with the current state; `code` says which.
+     */
+    409: Problem;
+    /**
+     * Erased or expired.
+     */
+    410: Problem;
+    /**
+     * Validation failed; `errors[]` names each parameter or JSON pointer.
+     */
+    422: Problem;
+    /**
+     * Too many requests; retry after `Retry-After`.
+     */
+    429: Problem;
+    /**
+     * Internal error; quote `requestId` to support.
+     */
+    500: Problem;
+};
+export type CheckAddressError = CheckAddressErrors[keyof CheckAddressErrors];
+export type CheckAddressResponses = {
+    /**
+     * Check an address against the Austrian snapshot.
+     */
+    200: AddressValidationResponse;
+};
+export type CheckAddressResponse = CheckAddressResponses[keyof CheckAddressResponses];
+export type GetAddressData = {
+    body?: never;
+    headers?: {
+        /**
+         * ETag from a previous read. A match returns a free 304.
+         */
+        'If-None-Match'?: string;
+        /**
+         * Optional replay key, retained for 24 hours. Replays are free.
+         */
+        'Idempotency-Key'?: string;
+    };
+    path: {
+        /**
+         * Stable A Firmenakte-ID (compact or hyphenated, including merged IDs), or bev:<address-code> alias. Resolves published current or historical addresses.
+         */
+        id: AkteId;
+    };
+    query?: never;
+    url: '/api/v2/addresses/{id}';
+};
+export type GetAddressErrors = {
+    /**
+     * Malformed request, or a cursor from another request.
+     */
+    400: Problem;
+    /**
+     * No valid API key or session.
+     */
+    401: Problem;
+    /**
+     * Not enough credits for this call.
+     */
+    402: Problem;
+    /**
+     * Not found, or it belongs to another workspace.
+     */
+    404: Problem;
+    /**
+     * Conflict with the current state; `code` says which.
+     */
+    409: Problem;
+    /**
+     * Erased or expired.
+     */
+    410: Problem;
+    /**
+     * Validation failed; `errors[]` names each parameter or JSON pointer.
+     */
+    422: Problem;
+    /**
+     * Too many requests; retry after `Retry-After`.
+     */
+    429: Problem;
+    /**
+     * Internal error; quote `requestId` to support.
+     */
+    500: Problem;
+};
+export type GetAddressError = GetAddressErrors[keyof GetAddressErrors];
+export type GetAddressResponses = {
+    /**
+     * Get a reference address.
+     */
+    200: ReferenceAddressResponse;
+};
+export type GetAddressResponse = GetAddressResponses[keyof GetAddressResponses];
+export type GetPlaceData = {
+    body?: never;
+    headers?: {
+        /**
+         * ETag from a previous read. A match returns a free 304.
+         */
+        'If-None-Match'?: string;
+    };
+    path: {
+        /**
+         * Stable G Firmenakte-ID (compact or hyphenated, including merged IDs), or geographic source alias such as gkz:10101. Resolves published current or retired geography.
+         */
+        id: AkteId;
+    };
+    query?: never;
+    url: '/api/v2/places/{id}';
+};
+export type GetPlaceErrors = {
+    /**
+     * Malformed request, or a cursor from another request.
+     */
+    400: Problem;
+    /**
+     * No valid API key or session.
+     */
+    401: Problem;
+    /**
+     * Not enough credits for this call.
+     */
+    402: Problem;
+    /**
+     * Not found, or it belongs to another workspace.
+     */
+    404: Problem;
+    /**
+     * Conflict with the current state; `code` says which.
+     */
+    409: Problem;
+    /**
+     * Erased or expired.
+     */
+    410: Problem;
+    /**
+     * Validation failed; `errors[]` names each parameter or JSON pointer.
+     */
+    422: Problem;
+    /**
+     * Too many requests; retry after `Retry-After`.
+     */
+    429: Problem;
+    /**
+     * Internal error; quote `requestId` to support.
+     */
+    500: Problem;
+};
+export type GetPlaceError = GetPlaceErrors[keyof GetPlaceErrors];
+export type GetPlaceResponses = {
+    /**
+     * Get a geographic place.
+     */
+    200: GeographicPlaceResponse;
+};
+export type GetPlaceResponse = GetPlaceResponses[keyof GetPlaceResponses];
 export type GetDocumentContentData = {
     body?: never;
     headers?: {