rehive 4.2.2 → 4.4.0

package/dist/extensions/sumsub.d.ts

@@ -0,0 +1,1336 @@
+import { A as ApiFactoryConfig, B as BoundSdk } from '../create-api-client-CBNjHT-x.js';
+import '../create-auth-CROjq_cP.js';
+
+type AuthToken = string | undefined;
+interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
+    in?: 'header' | 'query' | 'cookie';
+    /**
+     * A unique identifier for the security scheme.
+     *
+     * Defined only when there are multiple security schemes whose `Auth`
+     * shape would otherwise be identical.
+     */
+    key?: string;
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
+    name?: string;
+    scheme?: 'basic' | 'bearer';
+    type: 'apiKey' | 'http';
+}
+
+interface SerializerOptions<T> {
+    /**
+     * @default true
+     */
+    explode: boolean;
+    style: T;
+}
+type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
+type ObjectStyle = 'form' | 'deepObject';
+
+type QuerySerializer = (query: Record<string, unknown>) => string;
+type BodySerializer = (body: unknown) => unknown;
+type QuerySerializerOptionsObject = {
+    allowReserved?: boolean;
+    array?: Partial<SerializerOptions<ArrayStyle>>;
+    object?: Partial<SerializerOptions<ObjectStyle>>;
+};
+type QuerySerializerOptions = QuerySerializerOptionsObject & {
+    /**
+     * Per-parameter serialization overrides. When provided, these settings
+     * override the global array/object settings for specific parameter names.
+     */
+    parameters?: Record<string, QuerySerializerOptionsObject>;
+};
+
+type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
+type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
+    /**
+     * Returns the final request URL.
+     */
+    buildUrl: BuildUrlFn;
+    getConfig: () => Config;
+    request: RequestFn;
+    setConfig: (config: Config) => Config;
+} & {
+    [K in HttpMethod]: MethodFn;
+} & ([SseFn] extends [never] ? {
+    sse?: never;
+} : {
+    sse: {
+        [K in HttpMethod]: SseFn;
+    };
+});
+interface Config$1 {
+    /**
+     * Auth token or a function returning auth token. The resolved value will be
+     * added to the request payload as defined by its `security` array.
+     */
+    auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+    /**
+     * A function for serializing request body parameter. By default,
+     * {@link JSON.stringify()} will be used.
+     */
+    bodySerializer?: BodySerializer | null;
+    /**
+     * An object containing any HTTP headers that you want to pre-populate your
+     * `Headers` object with.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+     */
+    headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
+    /**
+     * The request method.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+     */
+    method?: Uppercase<HttpMethod>;
+    /**
+     * A function for serializing request query parameters. By default, arrays
+     * will be exploded in form style, objects will be exploded in deepObject
+     * style, and reserved characters are percent-encoded.
+     *
+     * This method will have no effect if the native `paramsSerializer()` Axios
+     * API function is used.
+     *
+     * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+     */
+    querySerializer?: QuerySerializer | QuerySerializerOptions;
+    /**
+     * A function validating request data. This is useful if you want to ensure
+     * the request conforms to the desired shape, so it can be safely sent to
+     * the server.
+     */
+    requestValidator?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function transforming response data before it's returned. This is useful
+     * for post-processing data, e.g., converting ISO strings into Date objects.
+     */
+    responseTransformer?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function validating response data. This is useful if you want to ensure
+     * the response conforms to the desired shape, so it can be safely passed to
+     * the transformers and returned to the user.
+     */
+    responseValidator?: (data: unknown) => Promise<unknown>;
+}
+/**
+ * Arbitrary metadata passed through the `meta` request option.
+ */
+interface ClientMeta {
+}
+
+type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Implementing clients can call request interceptors inside this hook.
+     */
+    onRequest?: (url: string, init: RequestInit) => Promise<Request>;
+    /**
+     * Callback invoked when a network or parsing error occurs during streaming.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @param error The error that occurred.
+     */
+    onSseError?: (error: unknown) => void;
+    /**
+     * Callback invoked when an event is streamed from the server.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @param event Event streamed from the server.
+     * @returns Nothing (void).
+     */
+    onSseEvent?: (event: StreamEvent<TData>) => void;
+    serializedBody?: RequestInit['body'];
+    /**
+     * Default retry delay in milliseconds.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @default 3000
+     */
+    sseDefaultRetryDelay?: number;
+    /**
+     * Maximum number of retry attempts before giving up.
+     */
+    sseMaxRetryAttempts?: number;
+    /**
+     * Maximum retry delay in milliseconds.
+     *
+     * Applies only when exponential backoff is used.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @default 30000
+     */
+    sseMaxRetryDelay?: number;
+    /**
+     * Optional sleep function for retry backoff.
+     *
+     * Defaults to using `setTimeout`.
+     */
+    sseSleepFn?: (ms: number) => Promise<void>;
+    url: string;
+};
+interface StreamEvent<TData = unknown> {
+    data: TData;
+    event?: string;
+    id?: string;
+    retry?: number;
+}
+type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
+    stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
+};
+
+type ErrInterceptor<Err, Res, Req, Options> = (error: Err, 
+/** response may be undefined due to a network error where no response object is produced */
+response: Res | undefined, 
+/** request may be undefined, because error may be from building the request object itself */
+request: Req | undefined, options: Options) => Err | Promise<Err>;
+type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
+type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
+declare class Interceptors<Interceptor> {
+    fns: Array<Interceptor | null>;
+    clear(): void;
+    eject(id: number | Interceptor): void;
+    exists(id: number | Interceptor): boolean;
+    getInterceptorIndex(id: number | Interceptor): number;
+    update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
+    use(fn: Interceptor): number;
+}
+interface Middleware<Req, Res, Err, Options> {
+    error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
+    request: Interceptors<ReqInterceptor<Req, Options>>;
+    response: Interceptors<ResInterceptor<Res, Req, Options>>;
+}
+
+type ResponseStyle = 'data' | 'fields';
+interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$1 {
+    /**
+     * Base URL for all requests made by this client.
+     */
+    baseUrl?: T['baseUrl'];
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Please don't use the Fetch client for Next.js applications. The `next`
+     * options won't have any effect.
+     *
+     * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
+     */
+    next?: never;
+    /**
+     * Return the response data parsed in a specified format. By default, `auto`
+     * will infer the appropriate method from the `Content-Type` response header.
+     * You can override this behavior with any of the {@link Body} methods.
+     * Select `stream` if you don't want to parse response data at all.
+     *
+     * @default 'auto'
+     */
+    parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
+    /**
+     * Should we return only data or multiple fields (data, error, response, etc.)?
+     *
+     * @default 'fields'
+     */
+    responseStyle?: ResponseStyle;
+    /**
+     * Throw an error instead of returning it in the response?
+     *
+     * @default false
+     */
+    throwOnError?: T['throwOnError'];
+}
+interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'data', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
+    responseStyle: TResponseStyle;
+    throwOnError: ThrowOnError;
+}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
+    /**
+     * Any body that you want to add to your request.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
+     */
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    /**
+     * Security mechanism(s) to use for the request.
+     */
+    security?: ReadonlyArray<Auth>;
+    url: Url;
+}
+interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'data', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
+    headers: Headers;
+    serializedBody?: string;
+}
+type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'data'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    request: Request;
+    response: Response;
+}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    error: undefined;
+} | {
+    data: undefined;
+    error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
+}) & {
+    /** request may be undefined, because error may be from building the request object itself */
+    request?: Request;
+    /** response may be undefined, because error may be from building the request object itself or from a network error */
+    response?: Response;
+}>;
+interface ClientOptions$1 {
+    baseUrl?: string;
+    responseStyle?: ResponseStyle;
+    throwOnError?: boolean;
+}
+type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'data'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'data'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
+type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'data'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type BuildUrlFn = <TData extends {
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    url: string;
+}>(options: TData & Options$1<TData>) => string;
+type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
+    interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
+};
+interface TDataShape {
+    body?: unknown;
+    headers?: unknown;
+    path?: unknown;
+    query?: unknown;
+    url: string;
+}
+type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
+type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'data'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
+
+type ClientOptions = {
+    baseUrl: 'https://sumsub.services.rehive.com/api/' | (string & {});
+};
+/**
+ * This serializer can be used if only a `status` is required in the response.
+ */
+type ActionResponse = {
+    status: string;
+};
+/**
+ * Serialize the activation data, should be a token that represents an admin
+ * user.
+ */
+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
+ */
+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';
+        };
+    };
+};
+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
+ */
+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;
+};
+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).
+ */
+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;
+};
+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
+ */
+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.
+ */
+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;
+};
+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.
+ */
+type AdminUserShareToken = {
+    client_id: string;
+    readonly token: string;
+};
+type AdminUserShareTokenResponse = {
+    status: string;
+    data: AdminUserShareToken;
+};
+/**
+ * Serialize the deactivation data, should be a token that represents an admin
+ * user.
+ */
+type Deactivate = {
+    token: string;
+    purge?: boolean;
+};
+type PaginatedAdminCurrencyList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminCurrency>;
+};
+type PaginatedAdminCurrencyListResponse = {
+    status: string;
+    data: PaginatedAdminCurrencyList;
+};
+type PaginatedAdminDocumentTypeList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminDocumentType>;
+};
+type PaginatedAdminDocumentTypeListResponse = {
+    status: string;
+    data: PaginatedAdminDocumentTypeList;
+};
+type PaginatedAdminUserList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminUser>;
+};
+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
+ */
+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).
+ */
+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
+ */
+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
+ */
+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.
+ */
+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
+ */
+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.
+ */
+type UserAccessToken = {
+    readonly token: string;
+};
+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
+ */
+type UserCompany = {
+    readonly id: string;
+    readonly supported_groups: {
+        [key: string]: {
+            sumsub_type: 'individual' | 'company';
+        };
+    };
+};
+type UserCompanyResponse = {
+    status: string;
+    data: UserCompany;
+};
+type UserResponse = {
+    status: string;
+    data: User;
+};
+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
+ */
+type AdminCompanyWritable = {
+    sumsub_app_token: string;
+    sumsub_secret_key: string;
+    sumsub_webhook_secret_key: string;
+};
+type AdminCompanyResponseWritable = {
+    status: string;
+    data: AdminCompanyWritable;
+};
+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).
+ */
+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';
+};
+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
+ */
+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';
+        };
+    };
+};
+type AdminUserResponseWritable = {
+    status: string;
+};
+type PaginatedAdminCurrencyListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<unknown>;
+};
+type PaginatedAdminCurrencyListResponseWritable = {
+    status: string;
+    data: PaginatedAdminCurrencyListWritable;
+};
+type PaginatedAdminDocumentTypeListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminDocumentTypeWritable>;
+};
+type PaginatedAdminDocumentTypeListResponseWritable = {
+    status: string;
+    data: PaginatedAdminDocumentTypeListWritable;
+};
+type PaginatedAdminUserListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<unknown>;
+};
+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).
+ */
+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
+ */
+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';
+        };
+    };
+};
+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
+ */
+type UserCompanyWritable = {
+    [key: string]: unknown;
+};
+type UserCompanyResponseWritable = {
+    status: string;
+    data: UserCompanyWritable;
+};
+type UserResponseWritable = {
+    status: string;
+};
+type ActivateCreateData = {
+    body: Activate;
+    path?: never;
+    query?: never;
+    url: '/activate/';
+};
+type ActivateCreateResponses = {
+    200: ActionResponse;
+};
+type ActivateCreateResponse = ActivateCreateResponses[keyof ActivateCreateResponses];
+type AdminCompanyRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+type AdminCompanyRetrieveResponses = {
+    200: AdminCompanyResponse;
+};
+type AdminCompanyRetrieveResponse = AdminCompanyRetrieveResponses[keyof AdminCompanyRetrieveResponses];
+type AdminCompanyPartialUpdateData = {
+    body?: PatchedAdminUpdateCompanyWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+type AdminCompanyPartialUpdateResponses = {
+    200: AdminCompanyResponse;
+};
+type AdminCompanyPartialUpdateResponse = AdminCompanyPartialUpdateResponses[keyof AdminCompanyPartialUpdateResponses];
+type AdminCompanyUpdateData = {
+    body?: AdminUpdateCompanyWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+type AdminCompanyUpdateResponses = {
+    200: AdminCompanyResponse;
+};
+type AdminCompanyUpdateResponse = AdminCompanyUpdateResponses[keyof AdminCompanyUpdateResponses];
+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/';
+};
+type AdminCurrenciesListResponses = {
+    200: PaginatedAdminCurrencyListResponse;
+};
+type AdminCurrenciesListResponse = AdminCurrenciesListResponses[keyof AdminCurrenciesListResponses];
+type AdminCurrenciesRetrieveData = {
+    body?: never;
+    path: {
+        code: string;
+    };
+    query?: never;
+    url: '/admin/currencies/{code}/';
+};
+type AdminCurrenciesRetrieveResponses = {
+    200: AdminCurrencyResponse;
+};
+type AdminCurrenciesRetrieveResponse = AdminCurrenciesRetrieveResponses[keyof AdminCurrenciesRetrieveResponses];
+type AdminCurrenciesPartialUpdateData = {
+    body?: PatchedAdminCurrency;
+    path: {
+        code: string;
+    };
+    query?: never;
+    url: '/admin/currencies/{code}/';
+};
+type AdminCurrenciesPartialUpdateResponses = {
+    200: AdminCurrencyResponse;
+};
+type AdminCurrenciesPartialUpdateResponse = AdminCurrenciesPartialUpdateResponses[keyof AdminCurrenciesPartialUpdateResponses];
+type AdminCurrenciesUpdateData = {
+    body?: AdminCurrency;
+    path: {
+        code: string;
+    };
+    query?: never;
+    url: '/admin/currencies/{code}/';
+};
+type AdminCurrenciesUpdateResponses = {
+    200: AdminCurrencyResponse;
+};
+type AdminCurrenciesUpdateResponse = AdminCurrenciesUpdateResponses[keyof AdminCurrenciesUpdateResponses];
+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/';
+};
+type AdminDocumentTypesListResponses = {
+    200: PaginatedAdminDocumentTypeListResponse;
+};
+type AdminDocumentTypesListResponse = AdminDocumentTypesListResponses[keyof AdminDocumentTypesListResponses];
+type AdminDocumentTypesCreateData = {
+    body: AdminDocumentTypeWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/document-types/';
+};
+type AdminDocumentTypesCreateResponses = {
+    201: AdminDocumentTypeResponse;
+};
+type AdminDocumentTypesCreateResponse = AdminDocumentTypesCreateResponses[keyof AdminDocumentTypesCreateResponses];
+type AdminDocumentTypesDestroyData = {
+    body?: never;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/document-types/{identifier}/';
+};
+type AdminDocumentTypesDestroyResponses = {
+    200: AdminDocumentTypeResponse;
+};
+type AdminDocumentTypesDestroyResponse = AdminDocumentTypesDestroyResponses[keyof AdminDocumentTypesDestroyResponses];
+type AdminDocumentTypesRetrieveData = {
+    body?: never;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/document-types/{identifier}/';
+};
+type AdminDocumentTypesRetrieveResponses = {
+    200: AdminDocumentTypeResponse;
+};
+type AdminDocumentTypesRetrieveResponse = AdminDocumentTypesRetrieveResponses[keyof AdminDocumentTypesRetrieveResponses];
+type AdminDocumentTypesPartialUpdateData = {
+    body?: PatchedAdminDocumentTypeWritable;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/document-types/{identifier}/';
+};
+type AdminDocumentTypesPartialUpdateResponses = {
+    200: AdminDocumentTypeResponse;
+};
+type AdminDocumentTypesPartialUpdateResponse = AdminDocumentTypesPartialUpdateResponses[keyof AdminDocumentTypesPartialUpdateResponses];
+type AdminDocumentTypesUpdateData = {
+    body: AdminDocumentTypeWritable;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/document-types/{identifier}/';
+};
+type AdminDocumentTypesUpdateResponses = {
+    200: AdminDocumentTypeResponse;
+};
+type AdminDocumentTypesUpdateResponse = AdminDocumentTypesUpdateResponses[keyof AdminDocumentTypesUpdateResponses];
+type AdminUserShareCreateData = {
+    body: AdminUserShareToken;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/user/{identifier}/share/';
+};
+type AdminUserShareCreateResponses = {
+    201: AdminUserShareTokenResponse;
+};
+type AdminUserShareCreateResponse = AdminUserShareCreateResponses[keyof AdminUserShareCreateResponses];
+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/';
+};
+type AdminUsersListResponses = {
+    200: PaginatedAdminUserListResponse;
+};
+type AdminUsersListResponse = AdminUsersListResponses[keyof AdminUsersListResponses];
+type AdminUsersRetrieveData = {
+    body?: never;
+    path: {
+        identifier: string;
+    };
+    query?: never;
+    url: '/admin/users/{identifier}/';
+};
+type AdminUsersRetrieveResponses = {
+    200: AdminUserResponse;
+};
+type AdminUsersRetrieveResponse = AdminUsersRetrieveResponses[keyof AdminUsersRetrieveResponses];
+type DeactivateCreateData = {
+    body: Deactivate;
+    path?: never;
+    query?: never;
+    url: '/deactivate/';
+};
+type DeactivateCreateResponses = {
+    200: ActionResponse;
+};
+type DeactivateCreateResponse = DeactivateCreateResponses[keyof DeactivateCreateResponses];
+type SumsubWebhookCreateData = {
+    body: SumsubWebhook;
+    path: {
+        company_id: string;
+    };
+    query?: never;
+    url: '/sumsub/webhook/{company_id}/';
+};
+type SumsubWebhookCreateResponses = {
+    200: ActionResponse;
+};
+type SumsubWebhookCreateResponse = SumsubWebhookCreateResponses[keyof SumsubWebhookCreateResponses];
+type UserRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/user/';
+};
+type UserRetrieveResponses = {
+    200: UserResponse;
+};
+type UserRetrieveResponse = UserRetrieveResponses[keyof UserRetrieveResponses];
+type UserPartialUpdateData = {
+    body?: PatchedUser;
+    path?: never;
+    query?: never;
+    url: '/user/';
+};
+type UserPartialUpdateResponses = {
+    200: UserResponse;
+};
+type UserPartialUpdateResponse = UserPartialUpdateResponses[keyof UserPartialUpdateResponses];
+type UserUpdateData = {
+    body?: User;
+    path?: never;
+    query?: never;
+    url: '/user/';
+};
+type UserUpdateResponses = {
+    200: UserResponse;
+};
+type UserUpdateResponse = UserUpdateResponses[keyof UserUpdateResponses];
+type UserAccessTokenCreateData = {
+    body?: UserAccessToken;
+    path?: never;
+    query?: never;
+    url: '/user/access-token/';
+};
+type UserAccessTokenCreateResponses = {
+    200: UserAccessTokenResponse;
+};
+type UserAccessTokenCreateResponse = UserAccessTokenCreateResponses[keyof UserAccessTokenCreateResponses];
+type UserCompanyRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/user/company/';
+};
+type UserCompanyRetrieveResponses = {
+    200: UserCompanyResponse;
+};
+type UserCompanyRetrieveResponse = UserCompanyRetrieveResponses[keyof UserCompanyRetrieveResponses];
+type WebhookCreateData = {
+    body: Webhook;
+    path?: never;
+    query?: never;
+    url: '/webhook/';
+};
+type WebhookCreateResponses = {
+    200: ActionResponse;
+};
+type WebhookCreateResponse = WebhookCreateResponses[keyof WebhookCreateResponses];
+
+type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+declare const activateCreate: <ThrowOnError extends boolean = false>(options: Options<ActivateCreateData, ThrowOnError>) => RequestResult<ActivateCreateResponses, unknown, ThrowOnError>;
+declare const adminCompanyRetrieve: <ThrowOnError extends boolean = false>(options?: Options<AdminCompanyRetrieveData, ThrowOnError>) => RequestResult<AdminCompanyRetrieveResponses, unknown, ThrowOnError>;
+declare const adminCompanyPartialUpdate: <ThrowOnError extends boolean = false>(options?: Options<AdminCompanyPartialUpdateData, ThrowOnError>) => RequestResult<AdminCompanyPartialUpdateResponses, unknown, ThrowOnError>;
+declare const adminCompanyUpdate: <ThrowOnError extends boolean = false>(options?: Options<AdminCompanyUpdateData, ThrowOnError>) => RequestResult<AdminCompanyUpdateResponses, unknown, ThrowOnError>;
+declare const adminCurrenciesList: <ThrowOnError extends boolean = false>(options?: Options<AdminCurrenciesListData, ThrowOnError>) => RequestResult<AdminCurrenciesListResponses, unknown, ThrowOnError>;
+declare const adminCurrenciesRetrieve: <ThrowOnError extends boolean = false>(options: Options<AdminCurrenciesRetrieveData, ThrowOnError>) => RequestResult<AdminCurrenciesRetrieveResponses, unknown, ThrowOnError>;
+declare const adminCurrenciesPartialUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminCurrenciesPartialUpdateData, ThrowOnError>) => RequestResult<AdminCurrenciesPartialUpdateResponses, unknown, ThrowOnError>;
+declare const adminCurrenciesUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminCurrenciesUpdateData, ThrowOnError>) => RequestResult<AdminCurrenciesUpdateResponses, unknown, ThrowOnError>;
+declare const adminDocumentTypesList: <ThrowOnError extends boolean = false>(options?: Options<AdminDocumentTypesListData, ThrowOnError>) => RequestResult<AdminDocumentTypesListResponses, unknown, ThrowOnError>;
+declare const adminDocumentTypesCreate: <ThrowOnError extends boolean = false>(options: Options<AdminDocumentTypesCreateData, ThrowOnError>) => RequestResult<AdminDocumentTypesCreateResponses, unknown, ThrowOnError>;
+declare const adminDocumentTypesDestroy: <ThrowOnError extends boolean = false>(options: Options<AdminDocumentTypesDestroyData, ThrowOnError>) => RequestResult<AdminDocumentTypesDestroyResponses, unknown, ThrowOnError>;
+declare const adminDocumentTypesRetrieve: <ThrowOnError extends boolean = false>(options: Options<AdminDocumentTypesRetrieveData, ThrowOnError>) => RequestResult<AdminDocumentTypesRetrieveResponses, unknown, ThrowOnError>;
+declare const adminDocumentTypesPartialUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminDocumentTypesPartialUpdateData, ThrowOnError>) => RequestResult<AdminDocumentTypesPartialUpdateResponses, unknown, ThrowOnError>;
+declare const adminDocumentTypesUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminDocumentTypesUpdateData, ThrowOnError>) => RequestResult<AdminDocumentTypesUpdateResponses, unknown, ThrowOnError>;
+declare const adminUserShareCreate: <ThrowOnError extends boolean = false>(options: Options<AdminUserShareCreateData, ThrowOnError>) => RequestResult<AdminUserShareCreateResponses, unknown, ThrowOnError>;
+declare const adminUsersList: <ThrowOnError extends boolean = false>(options?: Options<AdminUsersListData, ThrowOnError>) => RequestResult<AdminUsersListResponses, unknown, ThrowOnError>;
+declare const adminUsersRetrieve: <ThrowOnError extends boolean = false>(options: Options<AdminUsersRetrieveData, ThrowOnError>) => RequestResult<AdminUsersRetrieveResponses, unknown, ThrowOnError>;
+declare const deactivateCreate: <ThrowOnError extends boolean = false>(options: Options<DeactivateCreateData, ThrowOnError>) => RequestResult<DeactivateCreateResponses, unknown, ThrowOnError>;
+declare const sumsubWebhookCreate: <ThrowOnError extends boolean = false>(options: Options<SumsubWebhookCreateData, ThrowOnError>) => RequestResult<SumsubWebhookCreateResponses, unknown, ThrowOnError>;
+declare const userRetrieve: <ThrowOnError extends boolean = false>(options?: Options<UserRetrieveData, ThrowOnError>) => RequestResult<UserRetrieveResponses, unknown, ThrowOnError>;
+declare const userPartialUpdate: <ThrowOnError extends boolean = false>(options?: Options<UserPartialUpdateData, ThrowOnError>) => RequestResult<UserPartialUpdateResponses, unknown, ThrowOnError>;
+declare const userUpdate: <ThrowOnError extends boolean = false>(options?: Options<UserUpdateData, ThrowOnError>) => RequestResult<UserUpdateResponses, unknown, ThrowOnError>;
+declare const userAccessTokenCreate: <ThrowOnError extends boolean = false>(options?: Options<UserAccessTokenCreateData, ThrowOnError>) => RequestResult<UserAccessTokenCreateResponses, unknown, ThrowOnError>;
+declare const userCompanyRetrieve: <ThrowOnError extends boolean = false>(options?: Options<UserCompanyRetrieveData, ThrowOnError>) => RequestResult<UserCompanyRetrieveResponses, unknown, ThrowOnError>;
+declare const webhookCreate: <ThrowOnError extends boolean = false>(options: Options<WebhookCreateData, ThrowOnError>) => RequestResult<WebhookCreateResponses, unknown, ThrowOnError>;
+
+type sdk_Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options<TData, ThrowOnError, TResponse>;
+declare const sdk_activateCreate: typeof activateCreate;
+declare const sdk_adminCompanyPartialUpdate: typeof adminCompanyPartialUpdate;
+declare const sdk_adminCompanyRetrieve: typeof adminCompanyRetrieve;
+declare const sdk_adminCompanyUpdate: typeof adminCompanyUpdate;
+declare const sdk_adminCurrenciesList: typeof adminCurrenciesList;
+declare const sdk_adminCurrenciesPartialUpdate: typeof adminCurrenciesPartialUpdate;
+declare const sdk_adminCurrenciesRetrieve: typeof adminCurrenciesRetrieve;
+declare const sdk_adminCurrenciesUpdate: typeof adminCurrenciesUpdate;
+declare const sdk_adminDocumentTypesCreate: typeof adminDocumentTypesCreate;
+declare const sdk_adminDocumentTypesDestroy: typeof adminDocumentTypesDestroy;
+declare const sdk_adminDocumentTypesList: typeof adminDocumentTypesList;
+declare const sdk_adminDocumentTypesPartialUpdate: typeof adminDocumentTypesPartialUpdate;
+declare const sdk_adminDocumentTypesRetrieve: typeof adminDocumentTypesRetrieve;
+declare const sdk_adminDocumentTypesUpdate: typeof adminDocumentTypesUpdate;
+declare const sdk_adminUserShareCreate: typeof adminUserShareCreate;
+declare const sdk_adminUsersList: typeof adminUsersList;
+declare const sdk_adminUsersRetrieve: typeof adminUsersRetrieve;
+declare const sdk_deactivateCreate: typeof deactivateCreate;
+declare const sdk_sumsubWebhookCreate: typeof sumsubWebhookCreate;
+declare const sdk_userAccessTokenCreate: typeof userAccessTokenCreate;
+declare const sdk_userCompanyRetrieve: typeof userCompanyRetrieve;
+declare const sdk_userPartialUpdate: typeof userPartialUpdate;
+declare const sdk_userRetrieve: typeof userRetrieve;
+declare const sdk_userUpdate: typeof userUpdate;
+declare const sdk_webhookCreate: typeof webhookCreate;
+declare namespace sdk {
+  export { type sdk_Options as Options, sdk_activateCreate as activateCreate, sdk_adminCompanyPartialUpdate as adminCompanyPartialUpdate, sdk_adminCompanyRetrieve as adminCompanyRetrieve, sdk_adminCompanyUpdate as adminCompanyUpdate, sdk_adminCurrenciesList as adminCurrenciesList, sdk_adminCurrenciesPartialUpdate as adminCurrenciesPartialUpdate, sdk_adminCurrenciesRetrieve as adminCurrenciesRetrieve, sdk_adminCurrenciesUpdate as adminCurrenciesUpdate, sdk_adminDocumentTypesCreate as adminDocumentTypesCreate, sdk_adminDocumentTypesDestroy as adminDocumentTypesDestroy, sdk_adminDocumentTypesList as adminDocumentTypesList, sdk_adminDocumentTypesPartialUpdate as adminDocumentTypesPartialUpdate, sdk_adminDocumentTypesRetrieve as adminDocumentTypesRetrieve, sdk_adminDocumentTypesUpdate as adminDocumentTypesUpdate, sdk_adminUserShareCreate as adminUserShareCreate, sdk_adminUsersList as adminUsersList, sdk_adminUsersRetrieve as adminUsersRetrieve, sdk_deactivateCreate as deactivateCreate, sdk_sumsubWebhookCreate as sumsubWebhookCreate, sdk_userAccessTokenCreate as userAccessTokenCreate, sdk_userCompanyRetrieve as userCompanyRetrieve, sdk_userPartialUpdate as userPartialUpdate, sdk_userRetrieve as userRetrieve, sdk_userUpdate as userUpdate, sdk_webhookCreate as webhookCreate };
+}
+
+type SumsubApi = BoundSdk<typeof sdk>;
+declare function createSumsubApi(config: ApiFactoryConfig): SumsubApi;
+
+export { type ActionResponse, type Activate, type ActivateCreateData, type ActivateCreateResponse, type ActivateCreateResponses, type AdminCompany, type AdminCompanyPartialUpdateData, type AdminCompanyPartialUpdateResponse, type AdminCompanyPartialUpdateResponses, type AdminCompanyResponse, type AdminCompanyResponseWritable, type AdminCompanyRetrieveData, type AdminCompanyRetrieveResponse, type AdminCompanyRetrieveResponses, type AdminCompanyUpdateData, type AdminCompanyUpdateResponse, type AdminCompanyUpdateResponses, type AdminCompanyWritable, type AdminCurrenciesListData, type AdminCurrenciesListResponse, type AdminCurrenciesListResponses, type AdminCurrenciesPartialUpdateData, type AdminCurrenciesPartialUpdateResponse, type AdminCurrenciesPartialUpdateResponses, type AdminCurrenciesRetrieveData, type AdminCurrenciesRetrieveResponse, type AdminCurrenciesRetrieveResponses, type AdminCurrenciesUpdateData, type AdminCurrenciesUpdateResponse, type AdminCurrenciesUpdateResponses, type AdminCurrency, type AdminCurrencyResponse, type AdminCurrencyResponseWritable, type AdminDocumentType, type AdminDocumentTypeResponse, type AdminDocumentTypeResponseWritable, type AdminDocumentTypeWritable, type AdminDocumentTypesCreateData, type AdminDocumentTypesCreateResponse, type AdminDocumentTypesCreateResponses, type AdminDocumentTypesDestroyData, type AdminDocumentTypesDestroyResponse, type AdminDocumentTypesDestroyResponses, type AdminDocumentTypesListData, type AdminDocumentTypesListResponse, type AdminDocumentTypesListResponses, type AdminDocumentTypesPartialUpdateData, type AdminDocumentTypesPartialUpdateResponse, type AdminDocumentTypesPartialUpdateResponses, type AdminDocumentTypesRetrieveData, type AdminDocumentTypesRetrieveResponse, type AdminDocumentTypesRetrieveResponses, type AdminDocumentTypesUpdateData, type AdminDocumentTypesUpdateResponse, type AdminDocumentTypesUpdateResponses, type AdminUpdateCompany, type AdminUpdateCompanyWritable, type AdminUser, type AdminUserResponse, type AdminUserResponseWritable, type AdminUserShareCreateData, type AdminUserShareCreateResponse, type AdminUserShareCreateResponses, type AdminUserShareToken, type AdminUserShareTokenResponse, type AdminUsersListData, type AdminUsersListResponse, type AdminUsersListResponses, type AdminUsersRetrieveData, type AdminUsersRetrieveResponse, type AdminUsersRetrieveResponses, type ClientOptions, type Deactivate, type DeactivateCreateData, type DeactivateCreateResponse, type DeactivateCreateResponses, type PaginatedAdminCurrencyList, type PaginatedAdminCurrencyListResponse, type PaginatedAdminCurrencyListResponseWritable, type PaginatedAdminCurrencyListWritable, type PaginatedAdminDocumentTypeList, type PaginatedAdminDocumentTypeListResponse, type PaginatedAdminDocumentTypeListResponseWritable, type PaginatedAdminDocumentTypeListWritable, type PaginatedAdminUserList, type PaginatedAdminUserListResponse, type PaginatedAdminUserListResponseWritable, type PaginatedAdminUserListWritable, type PatchedAdminCurrency, type PatchedAdminDocumentType, type PatchedAdminDocumentTypeWritable, type PatchedAdminUpdateCompany, type PatchedAdminUpdateCompanyWritable, type PatchedUser, type SumsubApi, type SumsubWebhook, type SumsubWebhookCreateData, type SumsubWebhookCreateResponse, type SumsubWebhookCreateResponses, type User, type UserAccessToken, type UserAccessTokenCreateData, type UserAccessTokenCreateResponse, type UserAccessTokenCreateResponses, type UserAccessTokenResponse, type UserAccessTokenResponseWritable, type UserCompany, type UserCompanyResponse, type UserCompanyResponseWritable, type UserCompanyRetrieveData, type UserCompanyRetrieveResponse, type UserCompanyRetrieveResponses, type UserCompanyWritable, type UserPartialUpdateData, type UserPartialUpdateResponse, type UserPartialUpdateResponses, type UserResponse, type UserResponseWritable, type UserRetrieveData, type UserRetrieveResponse, type UserRetrieveResponses, type UserUpdateData, type UserUpdateResponse, type UserUpdateResponses, type Webhook, type WebhookCreateData, type WebhookCreateResponse, type WebhookCreateResponses, createSumsubApi };