rehive 4.2.2 → 4.4.0

package/src/extensions/sumsub/openapi-ts/types.gen.ts

@@ -0,0 +1,1061 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: 'https://sumsub.services.rehive.com/api/' | (string & {});
+};
+
+/**
+ * This serializer can be used if only a `status` is required in the response.
+ */
+export type ActionResponse = {
+    status: string;
+};
+
+/**
+ * Serialize the activation data, should be a token that represents an admin
+ * user.
+ */
+export type Activate = {
+    token: string;
+    readonly id: string;
+    readonly name: string;
+    readonly secret: string;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type AdminCompany = {
+    readonly id: string;
+    readonly secret: string;
+    /**
+     * * `test` - Test
+     * * `production` - Production
+     */
+    readonly mode: 'test' | 'production';
+    sumsub_app_token: string;
+    sumsub_secret_key: string;
+    sumsub_webhook_secret_key: string;
+    readonly supported_groups: {
+        [key: string]: {
+            sumsub_verification_level: string;
+            sumsub_type: 'individual' | 'company';
+        };
+    };
+};
+
+export type AdminCompanyResponse = {
+    status: string;
+    data: AdminCompany;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type AdminCurrency = {
+    readonly code: string;
+    readonly display_code: string | null;
+    readonly description: string | null;
+    readonly symbol: string | null;
+    readonly unit: string | null;
+    readonly divisibility: number;
+    readonly manager: string | null;
+};
+
+export type AdminCurrencyResponse = {
+    status: string;
+    data: AdminCurrency;
+};
+
+/**
+ * Mapping between a platform document type id and a Sumsub document type.
+ * Scoped to the requesting admin's company (enforced by the view).
+ */
+export type AdminDocumentType = {
+    readonly id: string;
+    platform_type: string;
+    /**
+     * * `ID_CARD` - Id Card
+     * * `PASSPORT` - Passport
+     * * `DRIVERS` - Drivers
+     * * `RESIDENCE_PERMIT` - Residence Permit
+     * * `VISA` - Visa
+     * * `UTILITY_BILL` - Utility Bill
+     * * `UTILITY_BILL2` - Utility Bill2
+     * * `SELFIE` - Selfie
+     * * `VIDEO_SELFIE` - Video Selfie
+     * * `IDENTITY_VIDEO` - Identity Video
+     * * `PROFILE_IMAGE` - Profile Image
+     * * `ID_DOC_PHOTO` - Id Doc Photo
+     * * `EXTERNAL_DB_DOC` - External Db Doc
+     * * `AGREEMENT` - Agreement
+     * * `CONTRACT` - Contract
+     * * `SIGNED_CONTRACT` - Signed Contract
+     * * `DRIVERS_TRANSLATION` - Drivers Translation
+     * * `INVESTOR_DOC` - Investor Doc
+     * * `VEHICLE_REGISTRATION_CERTIFICATE` - Vehicle Registration Certificate
+     * * `INCOME_SOURCE` - Income Source
+     * * `PAYMENT_METHOD` - Payment Method
+     * * `PAYMENT_SOURCE` - Payment Source
+     * * `BANK_CARD` - Bank Card
+     * * `ARBITRARY_DOC` - Arbitrary Doc
+     * * `OTHER` - Other
+     * * `COMPANY_DOC` - Company Doc
+     * * `POWER_OF_ATTORNEY` - Power Of Attorney
+     * * `TRANSPARENCY_REGISTRY_EXTRACT` - Transparency Registry Extract
+     */
+    sumsub_type: 'ID_CARD' | 'PASSPORT' | 'DRIVERS' | 'RESIDENCE_PERMIT' | 'VISA' | 'UTILITY_BILL' | 'UTILITY_BILL2' | 'SELFIE' | 'VIDEO_SELFIE' | 'IDENTITY_VIDEO' | 'PROFILE_IMAGE' | 'ID_DOC_PHOTO' | 'EXTERNAL_DB_DOC' | 'AGREEMENT' | 'CONTRACT' | 'SIGNED_CONTRACT' | 'DRIVERS_TRANSLATION' | 'INVESTOR_DOC' | 'VEHICLE_REGISTRATION_CERTIFICATE' | 'INCOME_SOURCE' | 'PAYMENT_METHOD' | 'PAYMENT_SOURCE' | 'BANK_CARD' | 'ARBITRARY_DOC' | 'OTHER' | 'COMPANY_DOC' | 'POWER_OF_ATTORNEY' | 'TRANSPARENCY_REGISTRY_EXTRACT';
+    readonly file_rules: {
+        [key: string]: unknown;
+    };
+    readonly created: number;
+    readonly updated: number;
+};
+
+export type AdminDocumentTypeResponse = {
+    status: string;
+    data: AdminDocumentType;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type AdminUpdateCompany = {
+    readonly id: string;
+    readonly secret: string;
+    /**
+     * * `test` - Test
+     * * `production` - Production
+     */
+    readonly mode: 'test' | 'production';
+    sumsub_app_token?: string;
+    sumsub_secret_key?: string;
+    sumsub_webhook_secret_key?: string;
+    supported_groups?: {
+        [key: string]: {
+            sumsub_verification_level: string;
+            sumsub_type: 'individual' | 'company';
+        };
+    };
+};
+
+/**
+ * Admin-facing user serializer. Includes the internal `sumsub_client_comment`
+ * (not safe for end users) plus created/updated timestamps. All fields are
+ * read-only.
+ */
+export type AdminUser = {
+    readonly id: string;
+    readonly sumsub_id: string;
+    readonly sumsub_verification_level: string | null;
+    /**
+     * * `individual` - Individual
+     * * `company` - Company
+     */
+    readonly sumsub_type: 'individual' | 'company' | null;
+    /**
+     * * `init` - Init
+     * * `pending` - Pending
+     * * `prechecked` - Prechecked
+     * * `queued` - Queued
+     * * `completed` - Completed
+     * * `onHold` - On Hold
+     * * `awaitingService` - Awaiting Service
+     * * `awaitingUser` - Awaiting User
+     */
+    readonly sumsub_review_status: 'init' | 'pending' | 'prechecked' | 'queued' | 'completed' | 'onHold' | 'awaitingService' | 'awaitingUser';
+    /**
+     * * `GREEN` - Green
+     * * `RED` - Red
+     */
+    readonly sumsub_review_answer: 'GREEN' | 'RED' | null;
+    /**
+     * * `FINAL` - Final
+     * * `RETRY` - Retry
+     */
+    readonly sumsub_reject_type: 'FINAL' | 'RETRY' | null;
+    readonly sumsub_reject_labels: Array<string>;
+    readonly sumsub_moderation_comment: string | null;
+    readonly sumsub_client_comment: string | null;
+    readonly created: number;
+    readonly updated: number;
+};
+
+export type AdminUserResponse = {
+    status: string;
+    data: AdminUser;
+};
+
+/**
+ * Generate a Sumsub share token for the target admin user so another Sumsub
+ * client (identified by `client_id`) can reuse this applicant's identity.
+ */
+export type AdminUserShareToken = {
+    client_id: string;
+    readonly token: string;
+};
+
+export type AdminUserShareTokenResponse = {
+    status: string;
+    data: AdminUserShareToken;
+};
+
+/**
+ * Serialize the deactivation data, should be a token that represents an admin
+ * user.
+ */
+export type Deactivate = {
+    token: string;
+    purge?: boolean;
+};
+
+export type PaginatedAdminCurrencyList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminCurrency>;
+};
+
+export type PaginatedAdminCurrencyListResponse = {
+    status: string;
+    data: PaginatedAdminCurrencyList;
+};
+
+export type PaginatedAdminDocumentTypeList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminDocumentType>;
+};
+
+export type PaginatedAdminDocumentTypeListResponse = {
+    status: string;
+    data: PaginatedAdminDocumentTypeList;
+};
+
+export type PaginatedAdminUserList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminUser>;
+};
+
+export type PaginatedAdminUserListResponse = {
+    status: string;
+    data: PaginatedAdminUserList;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type PatchedAdminCurrency = {
+    readonly code?: string;
+    readonly display_code?: string | null;
+    readonly description?: string | null;
+    readonly symbol?: string | null;
+    readonly unit?: string | null;
+    readonly divisibility?: number;
+    readonly manager?: string | null;
+};
+
+/**
+ * Mapping between a platform document type id and a Sumsub document type.
+ * Scoped to the requesting admin's company (enforced by the view).
+ */
+export type PatchedAdminDocumentType = {
+    readonly id?: string;
+    platform_type?: string;
+    /**
+     * * `ID_CARD` - Id Card
+     * * `PASSPORT` - Passport
+     * * `DRIVERS` - Drivers
+     * * `RESIDENCE_PERMIT` - Residence Permit
+     * * `VISA` - Visa
+     * * `UTILITY_BILL` - Utility Bill
+     * * `UTILITY_BILL2` - Utility Bill2
+     * * `SELFIE` - Selfie
+     * * `VIDEO_SELFIE` - Video Selfie
+     * * `IDENTITY_VIDEO` - Identity Video
+     * * `PROFILE_IMAGE` - Profile Image
+     * * `ID_DOC_PHOTO` - Id Doc Photo
+     * * `EXTERNAL_DB_DOC` - External Db Doc
+     * * `AGREEMENT` - Agreement
+     * * `CONTRACT` - Contract
+     * * `SIGNED_CONTRACT` - Signed Contract
+     * * `DRIVERS_TRANSLATION` - Drivers Translation
+     * * `INVESTOR_DOC` - Investor Doc
+     * * `VEHICLE_REGISTRATION_CERTIFICATE` - Vehicle Registration Certificate
+     * * `INCOME_SOURCE` - Income Source
+     * * `PAYMENT_METHOD` - Payment Method
+     * * `PAYMENT_SOURCE` - Payment Source
+     * * `BANK_CARD` - Bank Card
+     * * `ARBITRARY_DOC` - Arbitrary Doc
+     * * `OTHER` - Other
+     * * `COMPANY_DOC` - Company Doc
+     * * `POWER_OF_ATTORNEY` - Power Of Attorney
+     * * `TRANSPARENCY_REGISTRY_EXTRACT` - Transparency Registry Extract
+     */
+    sumsub_type?: 'ID_CARD' | 'PASSPORT' | 'DRIVERS' | 'RESIDENCE_PERMIT' | 'VISA' | 'UTILITY_BILL' | 'UTILITY_BILL2' | 'SELFIE' | 'VIDEO_SELFIE' | 'IDENTITY_VIDEO' | 'PROFILE_IMAGE' | 'ID_DOC_PHOTO' | 'EXTERNAL_DB_DOC' | 'AGREEMENT' | 'CONTRACT' | 'SIGNED_CONTRACT' | 'DRIVERS_TRANSLATION' | 'INVESTOR_DOC' | 'VEHICLE_REGISTRATION_CERTIFICATE' | 'INCOME_SOURCE' | 'PAYMENT_METHOD' | 'PAYMENT_SOURCE' | 'BANK_CARD' | 'ARBITRARY_DOC' | 'OTHER' | 'COMPANY_DOC' | 'POWER_OF_ATTORNEY' | 'TRANSPARENCY_REGISTRY_EXTRACT';
+    readonly file_rules?: {
+        [key: string]: unknown;
+    };
+    readonly created?: number;
+    readonly updated?: number;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type PatchedAdminUpdateCompany = {
+    readonly id?: string;
+    readonly secret?: string;
+    /**
+     * * `test` - Test
+     * * `production` - Production
+     */
+    readonly mode?: 'test' | 'production';
+    sumsub_app_token?: string;
+    sumsub_secret_key?: string;
+    sumsub_webhook_secret_key?: string;
+    supported_groups?: {
+        [key: string]: {
+            sumsub_verification_level: string;
+            sumsub_type: 'individual' | 'company';
+        };
+    };
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type PatchedUser = {
+    readonly id?: string;
+    readonly sumsub_id?: string;
+    /**
+     * * `init` - Init
+     * * `pending` - Pending
+     * * `prechecked` - Prechecked
+     * * `queued` - Queued
+     * * `completed` - Completed
+     * * `onHold` - On Hold
+     * * `awaitingService` - Awaiting Service
+     * * `awaitingUser` - Awaiting User
+     */
+    readonly sumsub_review_status?: 'init' | 'pending' | 'prechecked' | 'queued' | 'completed' | 'onHold' | 'awaitingService' | 'awaitingUser';
+    /**
+     * * `GREEN` - Green
+     * * `RED` - Red
+     */
+    readonly sumsub_review_answer?: 'GREEN' | 'RED' | null;
+    /**
+     * * `FINAL` - Final
+     * * `RETRY` - Retry
+     */
+    readonly sumsub_reject_type?: 'FINAL' | 'RETRY' | null;
+    readonly sumsub_reject_labels?: Array<string>;
+    readonly sumsub_moderation_comment?: string | null;
+};
+
+/**
+ * Accept all Sumsub webhook events, but only log + process events listed in
+ * `SumsubWebhookEvent`. Signature is verified using HMAC-SHA512 over the raw
+ * request body, keyed by the company's webhook secret.
+ */
+export type SumsubWebhook = {
+    type: string;
+    applicantId?: string | null;
+    createdAtMs?: string | null;
+    externalUserId?: string | null;
+    reviewStatus?: string | null;
+    reviewResult?: {
+        [key: string]: unknown;
+    } | null;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type User = {
+    readonly id: string;
+    readonly sumsub_id: string;
+    /**
+     * * `init` - Init
+     * * `pending` - Pending
+     * * `prechecked` - Prechecked
+     * * `queued` - Queued
+     * * `completed` - Completed
+     * * `onHold` - On Hold
+     * * `awaitingService` - Awaiting Service
+     * * `awaitingUser` - Awaiting User
+     */
+    readonly sumsub_review_status: 'init' | 'pending' | 'prechecked' | 'queued' | 'completed' | 'onHold' | 'awaitingService' | 'awaitingUser';
+    /**
+     * * `GREEN` - Green
+     * * `RED` - Red
+     */
+    readonly sumsub_review_answer: 'GREEN' | 'RED' | null;
+    /**
+     * * `FINAL` - Final
+     * * `RETRY` - Retry
+     */
+    readonly sumsub_reject_type: 'FINAL' | 'RETRY' | null;
+    readonly sumsub_reject_labels: Array<string>;
+    readonly sumsub_moderation_comment: string | null;
+};
+
+/**
+ * Generate a Sumsub access token for the authenticated user.
+ *
+ * Creates a Sumsub applicant for the user on first call (populating initial
+ * info from the Rehive platform resource), then issues a short-lived access
+ * token that can be used to initialize the Sumsub Web/Mobile SDK.
+ */
+export type UserAccessToken = {
+    readonly token: string;
+};
+
+export type UserAccessTokenResponse = {
+    status: string;
+    data: UserAccessToken;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type UserCompany = {
+    readonly id: string;
+    readonly supported_groups: {
+        [key: string]: {
+            sumsub_type: 'individual' | 'company';
+        };
+    };
+};
+
+export type UserCompanyResponse = {
+    status: string;
+    data: UserCompany;
+};
+
+export type UserResponse = {
+    status: string;
+    data: User;
+};
+
+export type Webhook = {
+    id: string;
+    /**
+     * * `currency.create` - Currency Create
+     * * `currency.update` - Currency Update
+     */
+    event: 'currency.create' | 'currency.update';
+    company: string;
+    data: {
+        [key: string]: unknown;
+    };
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type AdminCompanyWritable = {
+    sumsub_app_token: string;
+    sumsub_secret_key: string;
+    sumsub_webhook_secret_key: string;
+};
+
+export type AdminCompanyResponseWritable = {
+    status: string;
+    data: AdminCompanyWritable;
+};
+
+export type AdminCurrencyResponseWritable = {
+    status: string;
+};
+
+/**
+ * Mapping between a platform document type id and a Sumsub document type.
+ * Scoped to the requesting admin's company (enforced by the view).
+ */
+export type AdminDocumentTypeWritable = {
+    platform_type: string;
+    /**
+     * * `ID_CARD` - Id Card
+     * * `PASSPORT` - Passport
+     * * `DRIVERS` - Drivers
+     * * `RESIDENCE_PERMIT` - Residence Permit
+     * * `VISA` - Visa
+     * * `UTILITY_BILL` - Utility Bill
+     * * `UTILITY_BILL2` - Utility Bill2
+     * * `SELFIE` - Selfie
+     * * `VIDEO_SELFIE` - Video Selfie
+     * * `IDENTITY_VIDEO` - Identity Video
+     * * `PROFILE_IMAGE` - Profile Image
+     * * `ID_DOC_PHOTO` - Id Doc Photo
+     * * `EXTERNAL_DB_DOC` - External Db Doc
+     * * `AGREEMENT` - Agreement
+     * * `CONTRACT` - Contract
+     * * `SIGNED_CONTRACT` - Signed Contract
+     * * `DRIVERS_TRANSLATION` - Drivers Translation
+     * * `INVESTOR_DOC` - Investor Doc
+     * * `VEHICLE_REGISTRATION_CERTIFICATE` - Vehicle Registration Certificate
+     * * `INCOME_SOURCE` - Income Source
+     * * `PAYMENT_METHOD` - Payment Method
+     * * `PAYMENT_SOURCE` - Payment Source
+     * * `BANK_CARD` - Bank Card
+     * * `ARBITRARY_DOC` - Arbitrary Doc
+     * * `OTHER` - Other
+     * * `COMPANY_DOC` - Company Doc
+     * * `POWER_OF_ATTORNEY` - Power Of Attorney
+     * * `TRANSPARENCY_REGISTRY_EXTRACT` - Transparency Registry Extract
+     */
+    sumsub_type: 'ID_CARD' | 'PASSPORT' | 'DRIVERS' | 'RESIDENCE_PERMIT' | 'VISA' | 'UTILITY_BILL' | 'UTILITY_BILL2' | 'SELFIE' | 'VIDEO_SELFIE' | 'IDENTITY_VIDEO' | 'PROFILE_IMAGE' | 'ID_DOC_PHOTO' | 'EXTERNAL_DB_DOC' | 'AGREEMENT' | 'CONTRACT' | 'SIGNED_CONTRACT' | 'DRIVERS_TRANSLATION' | 'INVESTOR_DOC' | 'VEHICLE_REGISTRATION_CERTIFICATE' | 'INCOME_SOURCE' | 'PAYMENT_METHOD' | 'PAYMENT_SOURCE' | 'BANK_CARD' | 'ARBITRARY_DOC' | 'OTHER' | 'COMPANY_DOC' | 'POWER_OF_ATTORNEY' | 'TRANSPARENCY_REGISTRY_EXTRACT';
+};
+
+export type AdminDocumentTypeResponseWritable = {
+    status: string;
+    data: AdminDocumentTypeWritable;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type AdminUpdateCompanyWritable = {
+    sumsub_app_token?: string;
+    sumsub_secret_key?: string;
+    sumsub_webhook_secret_key?: string;
+    supported_groups?: {
+        [key: string]: {
+            sumsub_verification_level: string;
+            sumsub_type: 'individual' | 'company';
+        };
+    };
+};
+
+export type AdminUserResponseWritable = {
+    status: string;
+};
+
+export type PaginatedAdminCurrencyListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<unknown>;
+};
+
+export type PaginatedAdminCurrencyListResponseWritable = {
+    status: string;
+    data: PaginatedAdminCurrencyListWritable;
+};
+
+export type PaginatedAdminDocumentTypeListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminDocumentTypeWritable>;
+};
+
+export type PaginatedAdminDocumentTypeListResponseWritable = {
+    status: string;
+    data: PaginatedAdminDocumentTypeListWritable;
+};
+
+export type PaginatedAdminUserListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<unknown>;
+};
+
+export type PaginatedAdminUserListResponseWritable = {
+    status: string;
+    data: PaginatedAdminUserListWritable;
+};
+
+/**
+ * Mapping between a platform document type id and a Sumsub document type.
+ * Scoped to the requesting admin's company (enforced by the view).
+ */
+export type PatchedAdminDocumentTypeWritable = {
+    platform_type?: string;
+    /**
+     * * `ID_CARD` - Id Card
+     * * `PASSPORT` - Passport
+     * * `DRIVERS` - Drivers
+     * * `RESIDENCE_PERMIT` - Residence Permit
+     * * `VISA` - Visa
+     * * `UTILITY_BILL` - Utility Bill
+     * * `UTILITY_BILL2` - Utility Bill2
+     * * `SELFIE` - Selfie
+     * * `VIDEO_SELFIE` - Video Selfie
+     * * `IDENTITY_VIDEO` - Identity Video
+     * * `PROFILE_IMAGE` - Profile Image
+     * * `ID_DOC_PHOTO` - Id Doc Photo
+     * * `EXTERNAL_DB_DOC` - External Db Doc
+     * * `AGREEMENT` - Agreement
+     * * `CONTRACT` - Contract
+     * * `SIGNED_CONTRACT` - Signed Contract
+     * * `DRIVERS_TRANSLATION` - Drivers Translation
+     * * `INVESTOR_DOC` - Investor Doc
+     * * `VEHICLE_REGISTRATION_CERTIFICATE` - Vehicle Registration Certificate
+     * * `INCOME_SOURCE` - Income Source
+     * * `PAYMENT_METHOD` - Payment Method
+     * * `PAYMENT_SOURCE` - Payment Source
+     * * `BANK_CARD` - Bank Card
+     * * `ARBITRARY_DOC` - Arbitrary Doc
+     * * `OTHER` - Other
+     * * `COMPANY_DOC` - Company Doc
+     * * `POWER_OF_ATTORNEY` - Power Of Attorney
+     * * `TRANSPARENCY_REGISTRY_EXTRACT` - Transparency Registry Extract
+     */
+    sumsub_type?: 'ID_CARD' | 'PASSPORT' | 'DRIVERS' | 'RESIDENCE_PERMIT' | 'VISA' | 'UTILITY_BILL' | 'UTILITY_BILL2' | 'SELFIE' | 'VIDEO_SELFIE' | 'IDENTITY_VIDEO' | 'PROFILE_IMAGE' | 'ID_DOC_PHOTO' | 'EXTERNAL_DB_DOC' | 'AGREEMENT' | 'CONTRACT' | 'SIGNED_CONTRACT' | 'DRIVERS_TRANSLATION' | 'INVESTOR_DOC' | 'VEHICLE_REGISTRATION_CERTIFICATE' | 'INCOME_SOURCE' | 'PAYMENT_METHOD' | 'PAYMENT_SOURCE' | 'BANK_CARD' | 'ARBITRARY_DOC' | 'OTHER' | 'COMPANY_DOC' | 'POWER_OF_ATTORNEY' | 'TRANSPARENCY_REGISTRY_EXTRACT';
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type PatchedAdminUpdateCompanyWritable = {
+    sumsub_app_token?: string;
+    sumsub_secret_key?: string;
+    sumsub_webhook_secret_key?: string;
+    supported_groups?: {
+        [key: string]: {
+            sumsub_verification_level: string;
+            sumsub_type: 'individual' | 'company';
+        };
+    };
+};
+
+export type UserAccessTokenResponseWritable = {
+    status: string;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type UserCompanyWritable = {
+    [key: string]: unknown;
+};
+
+export type UserCompanyResponseWritable = {
+    status: string;
+    data: UserCompanyWritable;
+};
+
+export type UserResponseWritable = {
+    status: string;
+};
+
+export type ActivateCreateData = {
+    body: Activate;
+    path?: never;
+    query?: never;
+    url: '/activate/';
+};
+
+export type ActivateCreateResponses = {
+    200: ActionResponse;
+};
+
+export type ActivateCreateResponse = ActivateCreateResponses[keyof ActivateCreateResponses];
+
+export type AdminCompanyRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+
+export type AdminCompanyRetrieveResponses = {
+    200: AdminCompanyResponse;
+};
+
+export type AdminCompanyRetrieveResponse = AdminCompanyRetrieveResponses[keyof AdminCompanyRetrieveResponses];
+
+export type AdminCompanyPartialUpdateData = {
+    body?: PatchedAdminUpdateCompanyWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+
+export type AdminCompanyPartialUpdateResponses = {
+    200: AdminCompanyResponse;
+};
+
+export type AdminCompanyPartialUpdateResponse = AdminCompanyPartialUpdateResponses[keyof AdminCompanyPartialUpdateResponses];
+
+export type AdminCompanyUpdateData = {
+    body?: AdminUpdateCompanyWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+
+export type AdminCompanyUpdateResponses = {
+    200: AdminCompanyResponse;
+};
+
+export type AdminCompanyUpdateResponse = AdminCompanyUpdateResponses[keyof AdminCompanyUpdateResponses];
+
+export type AdminCurrenciesListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+    };
+    url: '/admin/currencies/';
+};
+
+export type AdminCurrenciesListResponses = {
+    200: PaginatedAdminCurrencyListResponse;
+};
+
+export type AdminCurrenciesListResponse = AdminCurrenciesListResponses[keyof AdminCurrenciesListResponses];
+
+export type AdminCurrenciesRetrieveData = {
+    body?: never;
+    path: {
+        code: string;
+    };
+    query?: never;
+    url: '/admin/currencies/{code}/';
+};
+
+export type AdminCurrenciesRetrieveResponses = {
+    200: AdminCurrencyResponse;
+};
+
+export type AdminCurrenciesRetrieveResponse = AdminCurrenciesRetrieveResponses[keyof AdminCurrenciesRetrieveResponses];
+
+export type AdminCurrenciesPartialUpdateData = {
+    body?: PatchedAdminCurrency;
+    path: {
+        code: string;
+    };
+    query?: never;
+    url: '/admin/currencies/{code}/';
+};
+
+export type AdminCurrenciesPartialUpdateResponses = {
+    200: AdminCurrencyResponse;
+};
+
+export type AdminCurrenciesPartialUpdateResponse = AdminCurrenciesPartialUpdateResponses[keyof AdminCurrenciesPartialUpdateResponses];
+
+export type AdminCurrenciesUpdateData = {
+    body?: AdminCurrency;
+    path: {
+        code: string;
+    };
+    query?: never;
+    url: '/admin/currencies/{code}/';
+};
+
+export type AdminCurrenciesUpdateResponses = {
+    200: AdminCurrencyResponse;
+};
+
+export type AdminCurrenciesUpdateResponse = AdminCurrenciesUpdateResponses[keyof AdminCurrenciesUpdateResponses];
+
+export type AdminDocumentTypesListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        id?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        platform_type?: string;
+        sumsub_type?: string;
+    };
+    url: '/admin/document-types/';
+};
+
+export type AdminDocumentTypesListResponses = {
+    200: PaginatedAdminDocumentTypeListResponse;
+};
+
+export type AdminDocumentTypesListResponse = AdminDocumentTypesListResponses[keyof AdminDocumentTypesListResponses];
+
+export type AdminDocumentTypesCreateData = {
+    body: AdminDocumentTypeWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/document-types/';
+};
+
+export type AdminDocumentTypesCreateResponses = {
+    201: AdminDocumentTypeResponse;
+};
+
+export type AdminDocumentTypesCreateResponse = AdminDocumentTypesCreateResponses[keyof AdminDocumentTypesCreateResponses];
+
+export type AdminDocumentTypesDestroyData = {
+    body?: never;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/document-types/{identifier}/';
+};
+
+export type AdminDocumentTypesDestroyResponses = {
+    200: AdminDocumentTypeResponse;
+};
+
+export type AdminDocumentTypesDestroyResponse = AdminDocumentTypesDestroyResponses[keyof AdminDocumentTypesDestroyResponses];
+
+export type AdminDocumentTypesRetrieveData = {
+    body?: never;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/document-types/{identifier}/';
+};
+
+export type AdminDocumentTypesRetrieveResponses = {
+    200: AdminDocumentTypeResponse;
+};
+
+export type AdminDocumentTypesRetrieveResponse = AdminDocumentTypesRetrieveResponses[keyof AdminDocumentTypesRetrieveResponses];
+
+export type AdminDocumentTypesPartialUpdateData = {
+    body?: PatchedAdminDocumentTypeWritable;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/document-types/{identifier}/';
+};
+
+export type AdminDocumentTypesPartialUpdateResponses = {
+    200: AdminDocumentTypeResponse;
+};
+
+export type AdminDocumentTypesPartialUpdateResponse = AdminDocumentTypesPartialUpdateResponses[keyof AdminDocumentTypesPartialUpdateResponses];
+
+export type AdminDocumentTypesUpdateData = {
+    body: AdminDocumentTypeWritable;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/document-types/{identifier}/';
+};
+
+export type AdminDocumentTypesUpdateResponses = {
+    200: AdminDocumentTypeResponse;
+};
+
+export type AdminDocumentTypesUpdateResponse = AdminDocumentTypesUpdateResponses[keyof AdminDocumentTypesUpdateResponses];
+
+export type AdminUserShareCreateData = {
+    body: AdminUserShareToken;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/user/{identifier}/share/';
+};
+
+export type AdminUserShareCreateResponses = {
+    201: AdminUserShareTokenResponse;
+};
+
+export type AdminUserShareCreateResponse = AdminUserShareCreateResponses[keyof AdminUserShareCreateResponses];
+
+export type AdminUsersListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        id?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        sumsub_id?: string;
+        sumsub_review_status?: string;
+        sumsub_type?: string;
+    };
+    url: '/admin/users/';
+};
+
+export type AdminUsersListResponses = {
+    200: PaginatedAdminUserListResponse;
+};
+
+export type AdminUsersListResponse = AdminUsersListResponses[keyof AdminUsersListResponses];
+
+export type AdminUsersRetrieveData = {
+    body?: never;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/users/{identifier}/';
+};
+
+export type AdminUsersRetrieveResponses = {
+    200: AdminUserResponse;
+};
+
+export type AdminUsersRetrieveResponse = AdminUsersRetrieveResponses[keyof AdminUsersRetrieveResponses];
+
+export type DeactivateCreateData = {
+    body: Deactivate;
+    path?: never;
+    query?: never;
+    url: '/deactivate/';
+};
+
+export type DeactivateCreateResponses = {
+    200: ActionResponse;
+};
+
+export type DeactivateCreateResponse = DeactivateCreateResponses[keyof DeactivateCreateResponses];
+
+export type SumsubWebhookCreateData = {
+    body: SumsubWebhook;
+    path: {
+        company_id: string;
+    };
+    query?: never;
+    url: '/sumsub/webhook/{company_id}/';
+};
+
+export type SumsubWebhookCreateResponses = {
+    200: ActionResponse;
+};
+
+export type SumsubWebhookCreateResponse = SumsubWebhookCreateResponses[keyof SumsubWebhookCreateResponses];
+
+export type UserRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/user/';
+};
+
+export type UserRetrieveResponses = {
+    200: UserResponse;
+};
+
+export type UserRetrieveResponse = UserRetrieveResponses[keyof UserRetrieveResponses];
+
+export type UserPartialUpdateData = {
+    body?: PatchedUser;
+    path?: never;
+    query?: never;
+    url: '/user/';
+};
+
+export type UserPartialUpdateResponses = {
+    200: UserResponse;
+};
+
+export type UserPartialUpdateResponse = UserPartialUpdateResponses[keyof UserPartialUpdateResponses];
+
+export type UserUpdateData = {
+    body?: User;
+    path?: never;
+    query?: never;
+    url: '/user/';
+};
+
+export type UserUpdateResponses = {
+    200: UserResponse;
+};
+
+export type UserUpdateResponse = UserUpdateResponses[keyof UserUpdateResponses];
+
+export type UserAccessTokenCreateData = {
+    body?: UserAccessToken;
+    path?: never;
+    query?: never;
+    url: '/user/access-token/';
+};
+
+export type UserAccessTokenCreateResponses = {
+    200: UserAccessTokenResponse;
+};
+
+export type UserAccessTokenCreateResponse = UserAccessTokenCreateResponses[keyof UserAccessTokenCreateResponses];
+
+export type UserCompanyRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/user/company/';
+};
+
+export type UserCompanyRetrieveResponses = {
+    200: UserCompanyResponse;
+};
+
+export type UserCompanyRetrieveResponse = UserCompanyRetrieveResponses[keyof UserCompanyRetrieveResponses];
+
+export type WebhookCreateData = {
+    body: Webhook;
+    path?: never;
+    query?: never;
+    url: '/webhook/';
+};
+
+export type WebhookCreateResponses = {
+    200: ActionResponse;
+};
+
+export type WebhookCreateResponse = WebhookCreateResponses[keyof WebhookCreateResponses];