@risika/api-response-types 1.1.0

package/monitor/export.ts

@@ -0,0 +1,212 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type SecondaryIndustryObject = {
+  group_name: string | null;
+  industry_code: string | null;
+  industry_description: string | null;
+  isic: NaseOrIsic;
+  nace: NaseOrIsic;
+  priority: number;
+  section: string | null;
+}[];
+export type ListOfMonitoringEvents = MonitorEvent[];
+export type Highlights = (
+  | null
+  | {}
+  | {
+      url: string;
+      latest_control: number;
+      latest_control_date: string;
+      local_production_unit: {};
+    }[]
+  | {
+      personal_id: string;
+      local_id: string[];
+    }[]
+  | {
+      status: string | null;
+      valid_from: string | null;
+      valid_to: string | null;
+    }[]
+)[];
+
+export interface CompanyMonitorListAllSchema {
+  monitor_list: {
+    local_organization_id: LocalOrganizationId;
+    internal_id?: string | null;
+    company_name: string;
+    status: string | null;
+    status_code: string | null;
+    score: (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10) | null;
+    credit_max: number;
+    address: Address;
+    financial_key_figures: FinancialKeyFigures;
+    industry_code: string | null;
+    industries?: Industries;
+    employee_interval: string | null;
+    employees_number?: number | number | null;
+    company_type: string | null;
+    date_of_incorporation: string | null;
+    email?: string | null;
+    phone_number?: string | null;
+    webpage?: string | null;
+    capital?: number | null;
+    changes: ListOfMonitoringEvents | null;
+    credit_policy: null | CreditPolicyTrue | CreditPolicyFalse;
+    risk_assessment: string | null;
+    risk_assessment_code: null | (("LOW" | "MEDIUM" | "HIGH") | null);
+    highlights?: Highlights;
+    employment_trend?: "UP" | "NEUTRAL" | "DOWN" | "UNKNOWN";
+    equity_trend?: "UP" | "NEUTRAL" | "DOWN" | "UNKNOWN";
+    profit_loss_trend?: "UP" | "NEUTRAL" | "DOWN" | "UNKNOWN";
+    fraud_indicators_count?: number | null;
+  }[];
+  count?: number;
+}
+export interface LocalOrganizationId {
+  country: ("DK" | "SE" | "NO" | "FI" | "FO" | "DE" | "UK" | "dk" | "se" | "no" | "fi" | "fo" | "de" | "uk") | null;
+  id: string | null;
+  hash?: string | null;
+}
+export interface Address {
+  city: string | null;
+  coname: null | string;
+  number: string | null;
+  street: string | null;
+  country: string | null;
+  zipcode: number | string | null;
+  municipality: string | null;
+  postdistrict: string | null;
+}
+export interface FinancialKeyFigures {
+  currency: string;
+  equity: number | number | null;
+  profit_loss: number | number | null;
+  solidity: number | number | null;
+  short_term_debt: number | number | null;
+  long_term_debt: number | number | null;
+  ebitda: number | number | null;
+  ebit: number | number | null;
+  ordinary_profit: number | number | null;
+  short_term_trade_payables: number | number | null;
+  short_term_receivables_from_sales_and_services: number | number | null;
+}
+export interface Industries {
+  main_industry?: null | IndustryObject;
+  secondary_industry_codes?: null | SecondaryIndustryObject;
+}
+export interface IndustryObject {
+  code: string | null;
+  description: string | null;
+  isic: NaseOrIsic;
+  nace: NaseOrIsic;
+  section: string | null;
+}
+export interface NaseOrIsic {
+  code: string | null;
+  section: string | null;
+  description: string | null;
+}
+export interface MonitorEvent {
+  new: Event;
+  old?: Event;
+  date?: string | string;
+  registration_date?: string;
+  sentence: string;
+  type: string;
+  weight: number;
+}
+export interface Event {
+  valid_from?: string | null;
+  valid_to?: string | null;
+  value?:
+    | ScoreModel
+    | string
+    | number
+    | null
+    | {
+        entity_id?: string;
+        function?: string;
+        name?: string;
+      };
+}
+export interface ScoreModel {
+  date?: string | null;
+  probability_of_distress: number | null;
+  risk_assessment: string | null;
+  risk_assessment_code: ("LOW" | "MEDIUM" | "HIGH") | null;
+  score: (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10) | null;
+}
+export interface CreditPolicyTrue {
+  allowed: true;
+  /**
+   * @maxItems 0
+   */
+  conflicts: [];
+}
+export interface CreditPolicyFalse {
+  allowed: false;
+  /**
+   * @minItems 1
+   */
+  conflicts: [
+    {
+      code:
+        | "POLICY_RISIKA_SCORE"
+        | "POLICY_AUDITOR_ASSISTANCE"
+        | "POLICY_COMPANY_TYPE"
+        | "POLICY_INDUSTRY"
+        | "POLICY_BANKRUPTCIES"
+        | "POLICY_BANKRUPTCIES_LONG"
+        | "POLICY_AGE"
+        | "POLICY_NEGATIVE_EQUITY"
+        | "POLICY_LOCAL_ID"
+        | "POLICY_ENTITY_ID"
+        | "POLICY_PREPAID_PHONE_NUMBER"
+        | "POLICY_PHONE_NUMBER_REGISTRY"
+        | "POLICY_DISTANCE_TO_CEO"
+        | "POLICY_AUDITOR_HAS_ID"
+        | "POLICY_PAYMENT_REMARKS_COUNT"
+        | "POLICY_PAYMENT_REMARKS_CREDITORS_COUNT"
+        | "POLICY_PAYMENT_REMARKS_TOTAL_AMOUNT"
+        | "POLICY_PAYMENT_REMARKS_MAX_REPAYMENT_TIME"
+        | "POLICY_DEBT"
+        | "POLICY_SHORT_TERM_DEBT"
+        | "POLICY_PROFIT_LOSS"
+        | "POLICY_NUMBER_OF_EMPLOYEES";
+      text: string;
+    },
+    ...{
+      code:
+        | "POLICY_RISIKA_SCORE"
+        | "POLICY_AUDITOR_ASSISTANCE"
+        | "POLICY_COMPANY_TYPE"
+        | "POLICY_INDUSTRY"
+        | "POLICY_BANKRUPTCIES"
+        | "POLICY_BANKRUPTCIES_LONG"
+        | "POLICY_AGE"
+        | "POLICY_NEGATIVE_EQUITY"
+        | "POLICY_LOCAL_ID"
+        | "POLICY_ENTITY_ID"
+        | "POLICY_PREPAID_PHONE_NUMBER"
+        | "POLICY_PHONE_NUMBER_REGISTRY"
+        | "POLICY_DISTANCE_TO_CEO"
+        | "POLICY_AUDITOR_HAS_ID"
+        | "POLICY_PAYMENT_REMARKS_COUNT"
+        | "POLICY_PAYMENT_REMARKS_CREDITORS_COUNT"
+        | "POLICY_PAYMENT_REMARKS_TOTAL_AMOUNT"
+        | "POLICY_PAYMENT_REMARKS_MAX_REPAYMENT_TIME"
+        | "POLICY_DEBT"
+        | "POLICY_SHORT_TERM_DEBT"
+        | "POLICY_PROFIT_LOSS"
+        | "POLICY_NUMBER_OF_EMPLOYEES";
+      text: string;
+    }[]
+  ];
+}

package/monitor/extract.ts

@@ -0,0 +1,46 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type Extract = {
+  country?: "DK" | "SE" | "NO" | "FI" | "FO" | "DE" | "UK" | "dk" | "se" | "no" | "fi" | "fo" | "de" | "uk";
+  id?: string;
+  package?: {
+    date?: string;
+    package?: {
+      new?: Event;
+      old?: Event;
+      sentence_id?: number;
+      type?: string;
+      weight?: number;
+    }[];
+    tag?: string;
+    ts?: string;
+  }[];
+}[];
+
+export interface Event {
+  valid_from?: string | null;
+  valid_to?: string | null;
+  value?:
+    | ScoreModel
+    | string
+    | number
+    | null
+    | {
+        entity_id?: string;
+        function?: string;
+        name?: string;
+      };
+}
+export interface ScoreModel {
+  date?: string | null;
+  probability_of_distress: number | null;
+  risk_assessment: string | null;
+  risk_assessment_code: ("LOW" | "MEDIUM" | "HIGH") | null;
+  score: (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10) | null;
+}

package/monitor/index.ts

@@ -0,0 +1,20 @@
+// @ts-nocheck
+export type { Add as Add } from "./add"
+export type { Export as Export } from "./export"
+export type { Extract as Extract } from "./extract"
+export type { Add as ListAdd } from "./list/add"
+export type { MostRelevant as ListMostRelevant } from "./list/most_relevant"
+export type { MostRelevantList as ListMostRelevantList } from "./list/most_relevant_list"
+export type { PolicyViolations as ListPolicyViolations } from "./list/policy_violations"
+export type { Remove as ListRemove } from "./list/remove"
+export type { Rename as ListRename } from "./list/rename"
+export type { Show as ListShow } from "./list/show"
+export type { AggregatedHighlights as ListStatisticsAggregatedHighlights } from "./list/statistics/aggregated_highlights"
+export type { Category as ListStatisticsCategory } from "./list/statistics/category"
+export type { Compliance as ListStatisticsCompliance } from "./list/statistics/compliance"
+export type { Timeline as ListStatisticsTimeline } from "./list/statistics/timeline"
+export type { Visibility as ListVisibility } from "./list/visibility"
+export type { List as List } from "./list"
+export type { Listpaged as Listpaged } from "./listpaged"
+export type { Remove as Remove } from "./remove"
+export type { Verify as Verify } from "./verify"

package/monitor/list/add.ts

@@ -0,0 +1,11 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Add {
+  list_id: number;
+}

package/monitor/list/most_relevant.ts

@@ -0,0 +1,51 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type MostRelevant = {
+  local_organization_id?: LocalOrganizationId;
+  name?: string;
+  weight?: string;
+  date?: string;
+  changes?: MonitorEvent[];
+}[];
+
+export interface LocalOrganizationId {
+  country: ("DK" | "SE" | "NO" | "FI" | "FO" | "DE" | "UK" | "dk" | "se" | "no" | "fi" | "fo" | "de" | "uk") | null;
+  id: string | null;
+  hash?: string | null;
+}
+export interface MonitorEvent {
+  new: Event;
+  old?: Event;
+  date?: string | string;
+  registration_date?: string;
+  sentence: string;
+  type: string;
+  weight: number;
+}
+export interface Event {
+  valid_from?: string | null;
+  valid_to?: string | null;
+  value?:
+    | ScoreModel
+    | string
+    | number
+    | null
+    | {
+        entity_id?: string;
+        function?: string;
+        name?: string;
+      };
+}
+export interface ScoreModel {
+  date?: string | null;
+  probability_of_distress: number | null;
+  risk_assessment: string | null;
+  risk_assessment_code: ("LOW" | "MEDIUM" | "HIGH") | null;
+  score: (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10) | null;
+}

package/monitor/list/most_relevant_list.ts

@@ -0,0 +1,9 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface MostRelevantList {}

package/monitor/list/policy_violations.ts

@@ -0,0 +1,32 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface PolicyViolations {
+  POLICY_RISIKA_SCORE?: string;
+  POLICY_AUDITOR_ASSISTANCE?: string;
+  POLICY_COMPANY_TYPE?: string;
+  POLICY_INDUSTRY?: string;
+  POLICY_BANKRUPTCIES?: string;
+  POLICY_BANKRUPTCIES_LONG?: string;
+  POLICY_AGE?: string;
+  POLICY_NEGATIVE_EQUITY?: string;
+  POLICY_LOCAL_ID?: string;
+  POLICY_ENTITY_ID?: string;
+  POLICY_PREPAID_PHONE_NUMBER?: string;
+  POLICY_PHONE_NUMBER_REGISTRY?: string;
+  POLICY_DISTANCE_TO_CEO?: string;
+  POLICY_AUDITOR_HAS_ID?: string;
+  POLICY_PAYMENT_REMARKS_COUNT?: string;
+  POLICY_PAYMENT_REMARKS_CREDITORS_COUNT?: string;
+  POLICY_PAYMENT_REMARKS_TOTAL_AMOUNT?: string;
+  POLICY_PAYMENT_REMARKS_MAX_REPAYMENT_TIME?: string;
+  POLICY_DEBT?: string;
+  POLICY_SHORT_TERM_DEBT?: string;
+  POLICY_PROFIT_LOSS?: string;
+  POLICY_NUMBER_OF_EMPLOYEES?: string;
+}

package/monitor/list/remove.ts

@@ -0,0 +1,11 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Remove {
+  status: "ok";
+}

package/monitor/list/rename.ts

@@ -0,0 +1,11 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Rename {
+  status: "ok";
+}

package/monitor/list/show.ts

@@ -0,0 +1,20 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type Show = {
+  list_id?: number;
+  name?: string;
+  owner_id?: number | null;
+  list_users?: number[] | null;
+  risk_assessment?: {
+    HIGH?: number;
+    MEDIUM?: number;
+    LOW?: number;
+    NONE?: number;
+  };
+}[];

package/monitor/list/statistics/aggregated_highlights.ts

@@ -0,0 +1,16 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type AggregatedHighlights = {
+  category: string;
+  count: number;
+  header: string;
+  message: string;
+  title: string;
+  value: string;
+}[];

package/monitor/list/statistics/category.ts

@@ -0,0 +1,50 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type GroupCategories =
+  | "SCORE"
+  | "RISK_ASSESSMENT"
+  | "COMPANY_TYPE"
+  | "COMPANY_TYPE_INTL"
+  | "EMPLOYEES"
+  | "EMPLOYEES_NUMBER"
+  | "REGION"
+  | "NACE"
+  | "GROSS_RESULT"
+  | "NONCURRENT_ASSETS"
+  | "CURRENT_ASSETS"
+  | "ASSETS"
+  | "LONG_TERM_DEBT"
+  | "SHORT_TERM_DEBT"
+  | "DEBT"
+  | "CURRENT_RATIO"
+  | "RETURN_ON_ASSETS"
+  | "RETURN_ON_EQUITY"
+  | "SOLIDITY_RATIO"
+  | "COUNTRY";
+export type Category = (InnerCategory | OuterCategory)[];
+
+export interface InnerCategory {
+  category_type?: GroupCategories;
+  function?: "COUNT" | "PERCENTAGE" | "AVERAGE" | "MEDIAN";
+  category?: string;
+  value?: number;
+}
+export interface OuterCategory {
+  group?:
+    | string
+    | number
+    | {
+        geoname?: string;
+        lat?: number;
+        long?: number;
+      };
+  group_code?: string | number;
+  group_type?: GroupCategories;
+  values?: InnerCategory | OuterCategory;
+}

package/monitor/list/statistics/compliance.ts

@@ -0,0 +1,49 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type Compliance =
+  | {
+      allowed: number;
+      rejected: number;
+      manual_check: number;
+      do_not_evaluate: number;
+      allowed_list: CountryLocalIdLists;
+      rejected_list: CountryLocalIdLists;
+      manual_check_list: CountryLocalIdLists;
+      do_not_evaluate_list: CountryLocalIdLists;
+      credit_policy_used: "credit_automator";
+      rejected_explanations: {};
+    }
+  | {
+      allowed: number;
+      rejected: number;
+      allowed_list: CountryLocalIdLists;
+      rejected_list: CountryLocalIdLists;
+      credit_policy_used: "credit_policy";
+      rejected_explanations: {
+        /**
+         * This interface was referenced by `undefined`'s JSON-Schema definition
+         * via the `patternProperty` "^.*$".
+         */
+        [k: string]: {
+          count?: number;
+          text?: string;
+          title?: string;
+        };
+      };
+    };
+export type LocalIdList = string[];
+
+export interface CountryLocalIdLists {
+  DK?: LocalIdList;
+  NO?: LocalIdList;
+  SE?: LocalIdList;
+  FI?: LocalIdList;
+  UK?: LocalIdList;
+  DE?: LocalIdList;
+}

package/monitor/list/statistics/timeline.ts

@@ -0,0 +1,43 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type Values = {
+  date: string;
+  value: number;
+}[];
+export type Timeline = (
+  | {
+      group: string;
+      group_code: string | null;
+      group_type: "RISK_ASSESSMENT" | "CREDIT_COMPLIANCE";
+      function: "COUNT";
+      values: Values;
+    }
+  | {
+      group: string;
+      group_code: string | null;
+      group_type:
+        | "SCORE"
+        | "EMPLOYEES_NUMBER"
+        | "GROSS_RESULT"
+        | "NONCURRENT_ASSETS"
+        | "CURRENT_ASSETS"
+        | "ASSETS"
+        | "LONG_TERM_DEBT"
+        | "SHORT_TERM_DEBT"
+        | "DEBT"
+        | "CURRENT_RATIO"
+        | "RETURN_ON_ASSETS"
+        | "RETURN_ON_EQUITY"
+        | "SOLIDITY_RATIO"
+        | "EQUITY"
+        | "PROFIT_LOSS";
+      function: "AVERAGE" | "MEDIAN";
+      values: Values;
+    }
+)[];

package/monitor/list/visibility.ts

@@ -0,0 +1,11 @@
+// @ts-nocheck
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Visibility {
+  status: "ok";
+}