rehive 3.1.4 → 4.0.0

package/dist/extensions/rewards.d.ts

@@ -0,0 +1,2038 @@
+import { A as ApiFactoryConfig, B as BoundSdk } from '../create-api-client-BMeX50D6.js';
+import '../create-auth-UTklIOTc.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';
+    /**
+     * 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: any) => any;
+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>;
+}
+
+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: Res, request: Req, 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>, '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> {
+    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: Request;
+    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<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
+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://reward.services.rehive.io/api/' | (string & {});
+};
+/**
+ * This serializer can be used if only a `status` is required in the response.
+ */
+type ActionResponse = {
+    status?: string;
+};
+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 AdminCampaign = {
+    readonly id: string;
+    name?: string;
+    image?: string | null;
+    description?: string;
+    start_date: number;
+    end_date: number;
+    currency: Currency;
+    credit_account_name?: string | null;
+    credit_account?: string | null;
+    account: string;
+    readonly total: number;
+    readonly fixed_amount: number | null;
+    percentage?: string | null;
+    readonly balance: number;
+    /**
+     * * `percentage` - Percentage
+     * * `fixed` - Fixed
+     * * `fixedpercentage` - Fixedpercentage
+     */
+    type?: 'percentage' | 'fixed' | 'fixedpercentage';
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    default_status?: 'pending' | 'accepted' | 'rejected';
+    users?: Array<unknown>;
+    groups?: Array<unknown>;
+    max_per_user?: number | null;
+    max_per_user_per_timeframe?: number | null;
+    /**
+     * * `daily` - Daily
+     * * `weekly` - Weekly
+     * * `monthly` - Monthly
+     */
+    timeframe?: 'daily' | 'weekly' | 'monthly' | '' | null;
+    transactions_currency: Currency;
+    min_num_transactions?: number | null;
+    readonly min_value_transactions: number | null;
+    active?: boolean;
+    visible?: boolean;
+    claim?: boolean;
+    expression?: string | null;
+    /**
+     * * `company.link.create` - company.link.create
+     * * `company.link.update` - company.link.update
+     * * `company.update` - company.update
+     * * `currency.create` - currency.create
+     * * `currency.update` - currency.update
+     * * `user.create` - user.create
+     * * `user.update` - user.update
+     * * `user.password.reset` - user.password.reset
+     * * `user.password.set` - user.password.set
+     * * `user.deactivate.verify` - user.deactivate.verify
+     * * `user.request_delete.verify` - user.request_delete.verify
+     * * `user.email.verify` - user.email.verify
+     * * `user.mobile.verify` - user.mobile.verify
+     * * `email.create` - email.create
+     * * `email.update` - email.update
+     * * `mobile.create` - mobile.create
+     * * `mobile.update` - mobile.update
+     * * `address.create` - address.create
+     * * `address.update` - address.update
+     * * `document.create` - document.create
+     * * `document.update` - document.update
+     * * `bank_account.create` - bank_account.create
+     * * `bank_account.update` - bank_account.update
+     * * `crypto_account.create` - crypto_account.create
+     * * `crypto_account.update` - crypto_account.update
+     * * `account.create` - account.create
+     * * `account.update` - account.update
+     * * `transaction.create` - transaction.create
+     * * `transaction.update` - transaction.update
+     * * `transaction.initiate` - transaction.initiate
+     * * `transaction.execute` - transaction.execute
+     * * `transaction.transition.create` - transaction.transition.create
+     * * `transaction.transition.update` - transaction.transition.update
+     * * `mfa.sms.verify` - mfa.sms.verify
+     */
+    event?: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify' | '' | null;
+    event_user?: string | null;
+    event_amount?: string | null;
+};
+type AdminCampaignResponse = {
+    status?: string;
+    data?: AdminCampaign;
+};
+/**
+ * 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 identifier: string;
+    readonly secret: string;
+    readonly name: string;
+    operational_account?: string | null;
+};
+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 AdminCreateReward = {
+    readonly id: string;
+    user: string;
+    campaign?: string;
+    currency?: string;
+    amount?: number;
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    status?: 'pending' | 'accepted' | 'rejected';
+    readonly collection: string | null;
+    readonly created: number;
+    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 AdminCreateUpdateCampaign = {
+    readonly id: string;
+    name?: string;
+    image?: string | null;
+    description?: string;
+    start_date?: number | null;
+    end_date?: number | null;
+    currency: string;
+    credit_account_name?: string | null;
+    credit_account?: string | null;
+    account?: string | null;
+    total: number;
+    fixed_amount?: number;
+    percentage?: number | null;
+    readonly balance: number;
+    /**
+     * * `percentage` - Percentage
+     * * `fixed` - Fixed
+     * * `fixedpercentage` - Fixedpercentage
+     */
+    type?: 'percentage' | 'fixed' | 'fixedpercentage';
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    default_status?: 'pending' | 'accepted' | 'rejected';
+    users?: Array<unknown>;
+    groups?: Array<unknown>;
+    max_per_user?: number | null;
+    max_per_user_per_timeframe?: number | null;
+    /**
+     * * `daily` - Daily
+     * * `weekly` - Weekly
+     * * `monthly` - Monthly
+     */
+    timeframe?: 'daily' | 'weekly' | 'monthly' | '' | null;
+    transactions_currency?: string | null;
+    min_num_transactions?: number | null;
+    min_value_transactions?: number | null;
+    active?: boolean;
+    visible?: boolean;
+    claim?: boolean;
+    expression?: string | null;
+    /**
+     * * `company.link.create` - company.link.create
+     * * `company.link.update` - company.link.update
+     * * `company.update` - company.update
+     * * `currency.create` - currency.create
+     * * `currency.update` - currency.update
+     * * `user.create` - user.create
+     * * `user.update` - user.update
+     * * `user.password.reset` - user.password.reset
+     * * `user.password.set` - user.password.set
+     * * `user.deactivate.verify` - user.deactivate.verify
+     * * `user.request_delete.verify` - user.request_delete.verify
+     * * `user.email.verify` - user.email.verify
+     * * `user.mobile.verify` - user.mobile.verify
+     * * `email.create` - email.create
+     * * `email.update` - email.update
+     * * `mobile.create` - mobile.create
+     * * `mobile.update` - mobile.update
+     * * `address.create` - address.create
+     * * `address.update` - address.update
+     * * `document.create` - document.create
+     * * `document.update` - document.update
+     * * `bank_account.create` - bank_account.create
+     * * `bank_account.update` - bank_account.update
+     * * `crypto_account.create` - crypto_account.create
+     * * `crypto_account.update` - crypto_account.update
+     * * `account.create` - account.create
+     * * `account.update` - account.update
+     * * `transaction.create` - transaction.create
+     * * `transaction.update` - transaction.update
+     * * `transaction.initiate` - transaction.initiate
+     * * `transaction.execute` - transaction.execute
+     * * `transaction.transition.create` - transaction.transition.create
+     * * `transaction.transition.update` - transaction.transition.update
+     * * `mfa.sms.verify` - mfa.sms.verify
+     */
+    event?: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify' | '' | null;
+    event_user?: string | null;
+    event_amount?: string | 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 AdminReward = {
+    readonly id: string;
+    readonly user: string;
+    campaign: Campaign;
+    currency: Currency;
+    readonly amount: number;
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    status?: 'pending' | 'accepted' | 'rejected';
+    readonly collection: string | null;
+    readonly type: string;
+    readonly created: number;
+};
+type AdminRewardResponse = {
+    status?: string;
+    data?: AdminReward;
+};
+/**
+ * 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 AdminUser = {
+    readonly id: string;
+    readonly referral_code: string | null;
+    readonly referee_code: string | null;
+};
+type AdminUserResponse = {
+    status?: string;
+    data?: AdminUser;
+};
+/**
+ * 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 Campaign = {
+    readonly id: string;
+    name?: string;
+    description?: string;
+    active?: boolean;
+    default_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 Currency = {
+    code: string;
+    display_code?: string | null;
+    description?: string | null;
+    symbol?: string | null;
+    unit?: string | null;
+    divisibility?: number;
+    enabled?: boolean;
+};
+type CurrencyResponse = {
+    status?: string;
+    data?: Currency;
+};
+type Deactivate = {
+    token: string;
+    purge?: boolean;
+};
+type PaginatedAdminCampaignList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminCampaign>;
+};
+type PaginatedAdminCampaignListResponse = {
+    status?: string;
+    data?: PaginatedAdminCampaignList;
+};
+type PaginatedAdminRewardList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminReward>;
+};
+type PaginatedAdminRewardListResponse = {
+    status?: string;
+    data?: PaginatedAdminRewardList;
+};
+type PaginatedAdminUserList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminUser>;
+};
+type PaginatedAdminUserListResponse = {
+    status?: string;
+    data?: PaginatedAdminUserList;
+};
+type PaginatedCurrencyList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<Currency>;
+};
+type PaginatedCurrencyListResponse = {
+    status?: string;
+    data?: PaginatedCurrencyList;
+};
+type PaginatedUserCampaignList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<UserCampaign>;
+};
+type PaginatedUserCampaignListResponse = {
+    status?: string;
+    data?: PaginatedUserCampaignList;
+};
+type PaginatedUserRewardList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<UserReward>;
+};
+type PaginatedUserRewardListResponse = {
+    status?: string;
+    data?: PaginatedUserRewardList;
+};
+/**
+ * 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 PatchedAdminCompany = {
+    readonly id?: string;
+    readonly identifier?: string;
+    readonly secret?: string;
+    readonly name?: string;
+    operational_account?: string | 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 PatchedAdminCreateUpdateCampaign = {
+    readonly id?: string;
+    name?: string;
+    image?: string | null;
+    description?: string;
+    start_date?: number | null;
+    end_date?: number | null;
+    currency?: string;
+    credit_account_name?: string | null;
+    credit_account?: string | null;
+    account?: string | null;
+    total?: number;
+    fixed_amount?: number;
+    percentage?: number | null;
+    readonly balance?: number;
+    /**
+     * * `percentage` - Percentage
+     * * `fixed` - Fixed
+     * * `fixedpercentage` - Fixedpercentage
+     */
+    type?: 'percentage' | 'fixed' | 'fixedpercentage';
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    default_status?: 'pending' | 'accepted' | 'rejected';
+    users?: Array<unknown>;
+    groups?: Array<unknown>;
+    max_per_user?: number | null;
+    max_per_user_per_timeframe?: number | null;
+    /**
+     * * `daily` - Daily
+     * * `weekly` - Weekly
+     * * `monthly` - Monthly
+     */
+    timeframe?: 'daily' | 'weekly' | 'monthly' | '' | null;
+    transactions_currency?: string | null;
+    min_num_transactions?: number | null;
+    min_value_transactions?: number | null;
+    active?: boolean;
+    visible?: boolean;
+    claim?: boolean;
+    expression?: string | null;
+    /**
+     * * `company.link.create` - company.link.create
+     * * `company.link.update` - company.link.update
+     * * `company.update` - company.update
+     * * `currency.create` - currency.create
+     * * `currency.update` - currency.update
+     * * `user.create` - user.create
+     * * `user.update` - user.update
+     * * `user.password.reset` - user.password.reset
+     * * `user.password.set` - user.password.set
+     * * `user.deactivate.verify` - user.deactivate.verify
+     * * `user.request_delete.verify` - user.request_delete.verify
+     * * `user.email.verify` - user.email.verify
+     * * `user.mobile.verify` - user.mobile.verify
+     * * `email.create` - email.create
+     * * `email.update` - email.update
+     * * `mobile.create` - mobile.create
+     * * `mobile.update` - mobile.update
+     * * `address.create` - address.create
+     * * `address.update` - address.update
+     * * `document.create` - document.create
+     * * `document.update` - document.update
+     * * `bank_account.create` - bank_account.create
+     * * `bank_account.update` - bank_account.update
+     * * `crypto_account.create` - crypto_account.create
+     * * `crypto_account.update` - crypto_account.update
+     * * `account.create` - account.create
+     * * `account.update` - account.update
+     * * `transaction.create` - transaction.create
+     * * `transaction.update` - transaction.update
+     * * `transaction.initiate` - transaction.initiate
+     * * `transaction.execute` - transaction.execute
+     * * `transaction.transition.create` - transaction.transition.create
+     * * `transaction.transition.update` - transaction.transition.update
+     * * `mfa.sms.verify` - mfa.sms.verify
+     */
+    event?: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify' | '' | null;
+    event_user?: string | null;
+    event_amount?: string | 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 PatchedAdminReward = {
+    readonly id?: string;
+    readonly user?: string;
+    campaign?: Campaign;
+    currency?: Currency;
+    readonly amount?: number;
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    status?: 'pending' | 'accepted' | 'rejected';
+    readonly collection?: string | null;
+    readonly type?: string;
+    readonly created?: 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 PatchedUserUpdateReferral = {
+    readonly referral_code?: string | null;
+    referee_code?: 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 User = {
+    readonly id: string;
+    readonly referral_code: string | null;
+    readonly referee_code: string | 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 UserCampaign = {
+    readonly id: string;
+    name?: string;
+    readonly description: string;
+    image?: string | null;
+    start_date: number;
+    end_date: number;
+    currency: Currency;
+    readonly total: number;
+    readonly fixed_amount: number;
+    percentage?: string | null;
+    readonly balance: number;
+    type: string;
+    default_status: string;
+    users?: Array<unknown>;
+    groups?: Array<unknown>;
+    max_per_user?: number | null;
+    max_per_user_per_timeframe?: number | null;
+    timeframe?: string;
+    transactions_currency: Currency;
+    min_num_transactions?: number | null;
+    readonly min_value_transactions: number | null;
+    active?: boolean;
+    claim?: boolean;
+};
+type UserCampaignResponse = {
+    status?: string;
+    data?: UserCampaign;
+};
+/**
+ * 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 UserCreateReward = {
+    readonly id: string;
+    readonly user: string;
+    campaign: string;
+    currency: Currency;
+    readonly amount: number;
+    readonly status: string;
+    readonly collection: string | null;
+    readonly created: number;
+};
+type UserResponse = {
+    status?: string;
+    data?: User;
+};
+/**
+ * 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 UserReward = {
+    readonly id: string;
+    readonly user: string;
+    campaign: Campaign;
+    currency: Currency;
+    readonly amount: number;
+    readonly status: string;
+    readonly type: string;
+    collection?: string | null;
+    readonly created: number;
+};
+type UserRewardResponse = {
+    status?: string;
+    data?: UserReward;
+};
+/**
+ * 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 UserUpdateReferral = {
+    readonly referral_code: string | null;
+    referee_code: string;
+};
+type Webhook = {
+    id: string;
+    /**
+     * * `company.link.create` - company.link.create
+     * * `company.link.update` - company.link.update
+     * * `company.update` - company.update
+     * * `currency.create` - currency.create
+     * * `currency.update` - currency.update
+     * * `user.create` - user.create
+     * * `user.update` - user.update
+     * * `user.password.reset` - user.password.reset
+     * * `user.password.set` - user.password.set
+     * * `user.deactivate.verify` - user.deactivate.verify
+     * * `user.request_delete.verify` - user.request_delete.verify
+     * * `user.email.verify` - user.email.verify
+     * * `user.mobile.verify` - user.mobile.verify
+     * * `email.create` - email.create
+     * * `email.update` - email.update
+     * * `mobile.create` - mobile.create
+     * * `mobile.update` - mobile.update
+     * * `address.create` - address.create
+     * * `address.update` - address.update
+     * * `document.create` - document.create
+     * * `document.update` - document.update
+     * * `bank_account.create` - bank_account.create
+     * * `bank_account.update` - bank_account.update
+     * * `crypto_account.create` - crypto_account.create
+     * * `crypto_account.update` - crypto_account.update
+     * * `account.create` - account.create
+     * * `account.update` - account.update
+     * * `transaction.create` - transaction.create
+     * * `transaction.update` - transaction.update
+     * * `transaction.initiate` - transaction.initiate
+     * * `transaction.execute` - transaction.execute
+     * * `transaction.transition.create` - transaction.transition.create
+     * * `transaction.transition.update` - transaction.transition.update
+     * * `mfa.sms.verify` - mfa.sms.verify
+     */
+    event: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify';
+    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 AdminCampaignWritable = {
+    name?: string;
+    image?: string | null;
+    description?: string;
+    start_date: number;
+    end_date: number;
+    currency: Currency;
+    credit_account_name?: string | null;
+    credit_account?: string | null;
+    account: string;
+    percentage?: string | null;
+    /**
+     * * `percentage` - Percentage
+     * * `fixed` - Fixed
+     * * `fixedpercentage` - Fixedpercentage
+     */
+    type?: 'percentage' | 'fixed' | 'fixedpercentage';
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    default_status?: 'pending' | 'accepted' | 'rejected';
+    users?: Array<unknown>;
+    groups?: Array<unknown>;
+    max_per_user?: number | null;
+    max_per_user_per_timeframe?: number | null;
+    /**
+     * * `daily` - Daily
+     * * `weekly` - Weekly
+     * * `monthly` - Monthly
+     */
+    timeframe?: 'daily' | 'weekly' | 'monthly' | '' | null;
+    transactions_currency: Currency;
+    min_num_transactions?: number | null;
+    active?: boolean;
+    visible?: boolean;
+    claim?: boolean;
+    expression?: string | null;
+    /**
+     * * `company.link.create` - company.link.create
+     * * `company.link.update` - company.link.update
+     * * `company.update` - company.update
+     * * `currency.create` - currency.create
+     * * `currency.update` - currency.update
+     * * `user.create` - user.create
+     * * `user.update` - user.update
+     * * `user.password.reset` - user.password.reset
+     * * `user.password.set` - user.password.set
+     * * `user.deactivate.verify` - user.deactivate.verify
+     * * `user.request_delete.verify` - user.request_delete.verify
+     * * `user.email.verify` - user.email.verify
+     * * `user.mobile.verify` - user.mobile.verify
+     * * `email.create` - email.create
+     * * `email.update` - email.update
+     * * `mobile.create` - mobile.create
+     * * `mobile.update` - mobile.update
+     * * `address.create` - address.create
+     * * `address.update` - address.update
+     * * `document.create` - document.create
+     * * `document.update` - document.update
+     * * `bank_account.create` - bank_account.create
+     * * `bank_account.update` - bank_account.update
+     * * `crypto_account.create` - crypto_account.create
+     * * `crypto_account.update` - crypto_account.update
+     * * `account.create` - account.create
+     * * `account.update` - account.update
+     * * `transaction.create` - transaction.create
+     * * `transaction.update` - transaction.update
+     * * `transaction.initiate` - transaction.initiate
+     * * `transaction.execute` - transaction.execute
+     * * `transaction.transition.create` - transaction.transition.create
+     * * `transaction.transition.update` - transaction.transition.update
+     * * `mfa.sms.verify` - mfa.sms.verify
+     */
+    event?: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify' | '' | null;
+    event_user?: string | null;
+    event_amount?: string | null;
+};
+type AdminCampaignResponseWritable = {
+    status?: string;
+    data?: AdminCampaignWritable;
+};
+/**
+ * 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 = {
+    operational_account?: string | null;
+};
+type AdminCompanyResponseWritable = {
+    status?: string;
+    data?: AdminCompanyWritable;
+};
+/**
+ * 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 AdminCreateRewardWritable = {
+    user: string;
+    campaign?: string;
+    currency?: string;
+    amount?: number;
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    status?: 'pending' | 'accepted' | 'rejected';
+    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 AdminCreateUpdateCampaignWritable = {
+    name?: string;
+    image?: string | null;
+    description?: string;
+    start_date?: number | null;
+    end_date?: number | null;
+    currency: string;
+    credit_account_name?: string | null;
+    credit_account?: string | null;
+    account?: string | null;
+    total: number;
+    fixed_amount?: number;
+    percentage?: number | null;
+    /**
+     * * `percentage` - Percentage
+     * * `fixed` - Fixed
+     * * `fixedpercentage` - Fixedpercentage
+     */
+    type?: 'percentage' | 'fixed' | 'fixedpercentage';
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    default_status?: 'pending' | 'accepted' | 'rejected';
+    users?: Array<unknown>;
+    groups?: Array<unknown>;
+    max_per_user?: number | null;
+    max_per_user_per_timeframe?: number | null;
+    /**
+     * * `daily` - Daily
+     * * `weekly` - Weekly
+     * * `monthly` - Monthly
+     */
+    timeframe?: 'daily' | 'weekly' | 'monthly' | '' | null;
+    transactions_currency?: string | null;
+    min_num_transactions?: number | null;
+    min_value_transactions?: number | null;
+    active?: boolean;
+    visible?: boolean;
+    claim?: boolean;
+    expression?: string | null;
+    /**
+     * * `company.link.create` - company.link.create
+     * * `company.link.update` - company.link.update
+     * * `company.update` - company.update
+     * * `currency.create` - currency.create
+     * * `currency.update` - currency.update
+     * * `user.create` - user.create
+     * * `user.update` - user.update
+     * * `user.password.reset` - user.password.reset
+     * * `user.password.set` - user.password.set
+     * * `user.deactivate.verify` - user.deactivate.verify
+     * * `user.request_delete.verify` - user.request_delete.verify
+     * * `user.email.verify` - user.email.verify
+     * * `user.mobile.verify` - user.mobile.verify
+     * * `email.create` - email.create
+     * * `email.update` - email.update
+     * * `mobile.create` - mobile.create
+     * * `mobile.update` - mobile.update
+     * * `address.create` - address.create
+     * * `address.update` - address.update
+     * * `document.create` - document.create
+     * * `document.update` - document.update
+     * * `bank_account.create` - bank_account.create
+     * * `bank_account.update` - bank_account.update
+     * * `crypto_account.create` - crypto_account.create
+     * * `crypto_account.update` - crypto_account.update
+     * * `account.create` - account.create
+     * * `account.update` - account.update
+     * * `transaction.create` - transaction.create
+     * * `transaction.update` - transaction.update
+     * * `transaction.initiate` - transaction.initiate
+     * * `transaction.execute` - transaction.execute
+     * * `transaction.transition.create` - transaction.transition.create
+     * * `transaction.transition.update` - transaction.transition.update
+     * * `mfa.sms.verify` - mfa.sms.verify
+     */
+    event?: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify' | '' | null;
+    event_user?: string | null;
+    event_amount?: string | 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 AdminRewardWritable = {
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    status?: 'pending' | 'accepted' | 'rejected';
+};
+type AdminRewardResponseWritable = {
+    status?: string;
+    data?: AdminRewardWritable;
+};
+type AdminUserResponseWritable = {
+    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 CampaignWritable = {
+    name?: string;
+    description?: string;
+    active?: boolean;
+    default_status: string;
+};
+type PaginatedAdminCampaignListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminCampaignWritable>;
+};
+type PaginatedAdminCampaignListResponseWritable = {
+    status?: string;
+    data?: PaginatedAdminCampaignListWritable;
+};
+type PaginatedAdminRewardListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminRewardWritable>;
+};
+type PaginatedAdminRewardListResponseWritable = {
+    status?: string;
+    data?: PaginatedAdminRewardListWritable;
+};
+type PaginatedAdminUserListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<unknown>;
+};
+type PaginatedAdminUserListResponseWritable = {
+    status?: string;
+    data?: PaginatedAdminUserListWritable;
+};
+type PaginatedUserCampaignListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<UserCampaignWritable>;
+};
+type PaginatedUserCampaignListResponseWritable = {
+    status?: string;
+    data?: PaginatedUserCampaignListWritable;
+};
+type PaginatedUserRewardListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<UserRewardWritable>;
+};
+type PaginatedUserRewardListResponseWritable = {
+    status?: string;
+    data?: PaginatedUserRewardListWritable;
+};
+/**
+ * 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 PatchedAdminCompanyWritable = {
+    operational_account?: string | 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 PatchedAdminCreateUpdateCampaignWritable = {
+    name?: string;
+    image?: string | null;
+    description?: string;
+    start_date?: number | null;
+    end_date?: number | null;
+    currency?: string;
+    credit_account_name?: string | null;
+    credit_account?: string | null;
+    account?: string | null;
+    total?: number;
+    fixed_amount?: number;
+    percentage?: number | null;
+    /**
+     * * `percentage` - Percentage
+     * * `fixed` - Fixed
+     * * `fixedpercentage` - Fixedpercentage
+     */
+    type?: 'percentage' | 'fixed' | 'fixedpercentage';
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    default_status?: 'pending' | 'accepted' | 'rejected';
+    users?: Array<unknown>;
+    groups?: Array<unknown>;
+    max_per_user?: number | null;
+    max_per_user_per_timeframe?: number | null;
+    /**
+     * * `daily` - Daily
+     * * `weekly` - Weekly
+     * * `monthly` - Monthly
+     */
+    timeframe?: 'daily' | 'weekly' | 'monthly' | '' | null;
+    transactions_currency?: string | null;
+    min_num_transactions?: number | null;
+    min_value_transactions?: number | null;
+    active?: boolean;
+    visible?: boolean;
+    claim?: boolean;
+    expression?: string | null;
+    /**
+     * * `company.link.create` - company.link.create
+     * * `company.link.update` - company.link.update
+     * * `company.update` - company.update
+     * * `currency.create` - currency.create
+     * * `currency.update` - currency.update
+     * * `user.create` - user.create
+     * * `user.update` - user.update
+     * * `user.password.reset` - user.password.reset
+     * * `user.password.set` - user.password.set
+     * * `user.deactivate.verify` - user.deactivate.verify
+     * * `user.request_delete.verify` - user.request_delete.verify
+     * * `user.email.verify` - user.email.verify
+     * * `user.mobile.verify` - user.mobile.verify
+     * * `email.create` - email.create
+     * * `email.update` - email.update
+     * * `mobile.create` - mobile.create
+     * * `mobile.update` - mobile.update
+     * * `address.create` - address.create
+     * * `address.update` - address.update
+     * * `document.create` - document.create
+     * * `document.update` - document.update
+     * * `bank_account.create` - bank_account.create
+     * * `bank_account.update` - bank_account.update
+     * * `crypto_account.create` - crypto_account.create
+     * * `crypto_account.update` - crypto_account.update
+     * * `account.create` - account.create
+     * * `account.update` - account.update
+     * * `transaction.create` - transaction.create
+     * * `transaction.update` - transaction.update
+     * * `transaction.initiate` - transaction.initiate
+     * * `transaction.execute` - transaction.execute
+     * * `transaction.transition.create` - transaction.transition.create
+     * * `transaction.transition.update` - transaction.transition.update
+     * * `mfa.sms.verify` - mfa.sms.verify
+     */
+    event?: 'company.link.create' | 'company.link.update' | 'company.update' | 'currency.create' | 'currency.update' | 'user.create' | 'user.update' | 'user.password.reset' | 'user.password.set' | 'user.deactivate.verify' | 'user.request_delete.verify' | 'user.email.verify' | 'user.mobile.verify' | 'email.create' | 'email.update' | 'mobile.create' | 'mobile.update' | 'address.create' | 'address.update' | 'document.create' | 'document.update' | 'bank_account.create' | 'bank_account.update' | 'crypto_account.create' | 'crypto_account.update' | 'account.create' | 'account.update' | 'transaction.create' | 'transaction.update' | 'transaction.initiate' | 'transaction.execute' | 'transaction.transition.create' | 'transaction.transition.update' | 'mfa.sms.verify' | '' | null;
+    event_user?: string | null;
+    event_amount?: string | 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 PatchedAdminRewardWritable = {
+    /**
+     * * `pending` - Pending
+     * * `accepted` - Accepted
+     * * `rejected` - Rejected
+     */
+    status?: 'pending' | 'accepted' | 'rejected';
+};
+/**
+ * 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 PatchedUserUpdateReferralWritable = {
+    referee_code?: 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 UserCampaignWritable = {
+    name?: string;
+    image?: string | null;
+    start_date: number;
+    end_date: number;
+    currency: Currency;
+    percentage?: string | null;
+    type: string;
+    default_status: string;
+    users?: Array<unknown>;
+    groups?: Array<unknown>;
+    max_per_user?: number | null;
+    max_per_user_per_timeframe?: number | null;
+    timeframe?: string;
+    transactions_currency: Currency;
+    min_num_transactions?: number | null;
+    active?: boolean;
+    claim?: boolean;
+};
+type UserCampaignResponseWritable = {
+    status?: string;
+    data?: UserCampaignWritable;
+};
+/**
+ * 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 UserCreateRewardWritable = {
+    campaign: string;
+    data?: {
+        [key: string]: unknown;
+    };
+};
+type UserResponseWritable = {
+    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 UserRewardWritable = {
+    collection?: string | null;
+};
+type UserRewardResponseWritable = {
+    status?: string;
+    data?: UserRewardWritable;
+};
+/**
+ * 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 UserUpdateReferralWritable = {
+    referee_code: string;
+};
+type ActivateCreateData = {
+    body: Activate;
+    path?: never;
+    query?: never;
+    url: '/activate/';
+};
+type ActivateCreateResponses = {
+    200: ActionResponse;
+};
+type ActivateCreateResponse = ActivateCreateResponses[keyof ActivateCreateResponses];
+type AdminCampaignsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        active?: boolean;
+        available?: string;
+        currency?: string;
+        end_date?: string;
+        end_date__gt?: string;
+        end_date__lt?: string;
+        id?: string;
+        name__contains?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        search?: string;
+        start_date?: string;
+        start_date__gt?: string;
+        start_date__lt?: string;
+        type?: string;
+        visible?: boolean;
+    };
+    url: '/admin/campaigns/';
+};
+type AdminCampaignsListResponses = {
+    200: PaginatedAdminCampaignListResponse;
+};
+type AdminCampaignsListResponse = AdminCampaignsListResponses[keyof AdminCampaignsListResponses];
+type AdminCampaignsCreateData = {
+    body: AdminCreateUpdateCampaignWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/campaigns/';
+};
+type AdminCampaignsCreateResponses = {
+    201: AdminCampaignResponse;
+};
+type AdminCampaignsCreateResponse = AdminCampaignsCreateResponses[keyof AdminCampaignsCreateResponses];
+type AdminCampaignsDestroyData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/campaigns/{id}/';
+};
+type AdminCampaignsDestroyResponses = {
+    200: AdminCampaignResponse;
+};
+type AdminCampaignsDestroyResponse = AdminCampaignsDestroyResponses[keyof AdminCampaignsDestroyResponses];
+type AdminCampaignsRetrieveData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/campaigns/{id}/';
+};
+type AdminCampaignsRetrieveResponses = {
+    200: AdminCampaignResponse;
+};
+type AdminCampaignsRetrieveResponse = AdminCampaignsRetrieveResponses[keyof AdminCampaignsRetrieveResponses];
+type AdminCampaignsPartialUpdateData = {
+    body?: PatchedAdminCreateUpdateCampaignWritable;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/campaigns/{id}/';
+};
+type AdminCampaignsPartialUpdateResponses = {
+    200: AdminCampaignResponse;
+};
+type AdminCampaignsPartialUpdateResponse = AdminCampaignsPartialUpdateResponses[keyof AdminCampaignsPartialUpdateResponses];
+type AdminCampaignsUpdateData = {
+    body: AdminCreateUpdateCampaignWritable;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/campaigns/{id}/';
+};
+type AdminCampaignsUpdateResponses = {
+    200: AdminCampaignResponse;
+};
+type AdminCampaignsUpdateResponse = AdminCampaignsUpdateResponses[keyof AdminCampaignsUpdateResponses];
+type AdminCompanyRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+type AdminCompanyRetrieveResponses = {
+    200: AdminCompanyResponse;
+};
+type AdminCompanyRetrieveResponse = AdminCompanyRetrieveResponses[keyof AdminCompanyRetrieveResponses];
+type AdminCompanyPartialUpdateData = {
+    body?: PatchedAdminCompanyWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+type AdminCompanyPartialUpdateResponses = {
+    200: AdminCompanyResponse;
+};
+type AdminCompanyPartialUpdateResponse = AdminCompanyPartialUpdateResponses[keyof AdminCompanyPartialUpdateResponses];
+type AdminCompanyUpdateData = {
+    body?: AdminCompanyWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+type AdminCompanyUpdateResponses = {
+    200: AdminCompanyResponse;
+};
+type AdminCompanyUpdateResponse = AdminCompanyUpdateResponses[keyof AdminCompanyUpdateResponses];
+type AdminCurrenciesListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        code?: string;
+        /**
+         * 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: PaginatedCurrencyListResponse;
+};
+type AdminCurrenciesListResponse = AdminCurrenciesListResponses[keyof AdminCurrenciesListResponses];
+type AdminCurrenciesRetrieveData = {
+    body?: never;
+    path: {
+        code: string;
+    };
+    query?: never;
+    url: '/admin/currencies/{code}/';
+};
+type AdminCurrenciesRetrieveResponses = {
+    200: CurrencyResponse;
+};
+type AdminCurrenciesRetrieveResponse = AdminCurrenciesRetrieveResponses[keyof AdminCurrenciesRetrieveResponses];
+type AdminRewardsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        campaign?: string;
+        currency?: string;
+        id?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        status?: string;
+        status__in?: string;
+        type?: string;
+        user?: string;
+    };
+    url: '/admin/rewards/';
+};
+type AdminRewardsListResponses = {
+    200: PaginatedAdminRewardListResponse;
+};
+type AdminRewardsListResponse = AdminRewardsListResponses[keyof AdminRewardsListResponses];
+type AdminRewardsCreateData = {
+    body: AdminCreateRewardWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/rewards/';
+};
+type AdminRewardsCreateResponses = {
+    201: AdminRewardResponse;
+};
+type AdminRewardsCreateResponse = AdminRewardsCreateResponses[keyof AdminRewardsCreateResponses];
+type AdminRewardsRetrieveData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/rewards/{id}/';
+};
+type AdminRewardsRetrieveResponses = {
+    200: AdminRewardResponse;
+};
+type AdminRewardsRetrieveResponse = AdminRewardsRetrieveResponses[keyof AdminRewardsRetrieveResponses];
+type AdminRewardsPartialUpdateData = {
+    body?: PatchedAdminRewardWritable;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/rewards/{id}/';
+};
+type AdminRewardsPartialUpdateResponses = {
+    200: AdminRewardResponse;
+};
+type AdminRewardsPartialUpdateResponse = AdminRewardsPartialUpdateResponses[keyof AdminRewardsPartialUpdateResponses];
+type AdminRewardsUpdateData = {
+    body?: AdminRewardWritable;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/rewards/{id}/';
+};
+type AdminRewardsUpdateResponses = {
+    200: AdminRewardResponse;
+};
+type AdminRewardsUpdateResponse = AdminRewardsUpdateResponses[keyof AdminRewardsUpdateResponses];
+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;
+        referee_code?: string;
+        referral_code?: string;
+    };
+    url: '/admin/users/';
+};
+type AdminUsersListResponses = {
+    200: PaginatedAdminUserListResponse;
+};
+type AdminUsersListResponse = AdminUsersListResponses[keyof AdminUsersListResponses];
+type AdminUsersRetrieveData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/users/{id}/';
+};
+type AdminUsersRetrieveResponses = {
+    200: AdminUserResponse;
+};
+type AdminUsersRetrieveResponse = AdminUsersRetrieveResponses[keyof AdminUsersRetrieveResponses];
+type AdminWebhookCreateData = {
+    body: Webhook;
+    path?: never;
+    query?: never;
+    url: '/admin/webhook/';
+};
+type AdminWebhookCreateResponses = {
+    200: ActionResponse;
+};
+type AdminWebhookCreateResponse = AdminWebhookCreateResponses[keyof AdminWebhookCreateResponses];
+type DeactivateCreateData = {
+    body: Deactivate;
+    path?: never;
+    query?: never;
+    url: '/deactivate/';
+};
+type DeactivateCreateResponses = {
+    200: ActionResponse;
+};
+type DeactivateCreateResponse = DeactivateCreateResponses[keyof DeactivateCreateResponses];
+type UserRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/user/';
+};
+type UserRetrieveResponses = {
+    200: UserResponse;
+};
+type UserRetrieveResponse = UserRetrieveResponses[keyof UserRetrieveResponses];
+type UserPartialUpdateData = {
+    body?: PatchedUserUpdateReferralWritable;
+    path?: never;
+    query?: never;
+    url: '/user/';
+};
+type UserPartialUpdateResponses = {
+    200: UserResponse;
+};
+type UserPartialUpdateResponse = UserPartialUpdateResponses[keyof UserPartialUpdateResponses];
+type UserUpdateData = {
+    body: UserUpdateReferralWritable;
+    path?: never;
+    query?: never;
+    url: '/user/';
+};
+type UserUpdateResponses = {
+    200: UserResponse;
+};
+type UserUpdateResponse = UserUpdateResponses[keyof UserUpdateResponses];
+type UserCampaignsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        active?: boolean;
+        available?: string;
+        currency?: string;
+        end_date?: string;
+        end_date__gt?: string;
+        end_date__lt?: string;
+        id?: string;
+        name__contains?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        search?: string;
+        start_date?: string;
+        start_date__gt?: string;
+        start_date__lt?: string;
+        type?: string;
+        visible?: boolean;
+    };
+    url: '/user/campaigns/';
+};
+type UserCampaignsListResponses = {
+    200: PaginatedUserCampaignListResponse;
+};
+type UserCampaignsListResponse = UserCampaignsListResponses[keyof UserCampaignsListResponses];
+type UserCampaignsRetrieveData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/user/campaigns/{id}/';
+};
+type UserCampaignsRetrieveResponses = {
+    200: UserCampaignResponse;
+};
+type UserCampaignsRetrieveResponse = UserCampaignsRetrieveResponses[keyof UserCampaignsRetrieveResponses];
+type UserRewardsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        campaign?: string;
+        currency?: string;
+        id?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        status?: string;
+        status__in?: string;
+        type?: string;
+    };
+    url: '/user/rewards/';
+};
+type UserRewardsListResponses = {
+    200: PaginatedUserRewardListResponse;
+};
+type UserRewardsListResponse = UserRewardsListResponses[keyof UserRewardsListResponses];
+type UserRewardsCreateData = {
+    body: UserCreateRewardWritable;
+    path?: never;
+    query?: never;
+    url: '/user/rewards/';
+};
+type UserRewardsCreateResponses = {
+    201: UserRewardResponse;
+};
+type UserRewardsCreateResponse = UserRewardsCreateResponses[keyof UserRewardsCreateResponses];
+type UserRewardsRetrieveData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/user/rewards/{id}/';
+};
+type UserRewardsRetrieveResponses = {
+    200: UserRewardResponse;
+};
+type UserRewardsRetrieveResponse = UserRewardsRetrieveResponses[keyof UserRewardsRetrieveResponses];
+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> = Options$1<TData, ThrowOnError> & {
+    /**
+     * 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?: Record<string, unknown>;
+};
+/**
+ * Activate service
+ */
+declare const activateCreate: <ThrowOnError extends boolean = false>(options: Options<ActivateCreateData, ThrowOnError>) => RequestResult<ActivateCreateResponses, unknown, ThrowOnError, "data">;
+/**
+ * List campaign
+ */
+declare const adminCampaignsList: <ThrowOnError extends boolean = false>(options?: Options<AdminCampaignsListData, ThrowOnError>) => RequestResult<AdminCampaignsListResponses, unknown, ThrowOnError, "data">;
+/**
+ * Create campaign
+ */
+declare const adminCampaignsCreate: <ThrowOnError extends boolean = false>(options: Options<AdminCampaignsCreateData, ThrowOnError>) => RequestResult<AdminCampaignsCreateResponses, unknown, ThrowOnError, "data">;
+/**
+ * Delete campaign
+ */
+declare const adminCampaignsDestroy: <ThrowOnError extends boolean = false>(options: Options<AdminCampaignsDestroyData, ThrowOnError>) => RequestResult<AdminCampaignsDestroyResponses, unknown, ThrowOnError, "data">;
+/**
+ * Retrieve campaign
+ */
+declare const adminCampaignsRetrieve: <ThrowOnError extends boolean = false>(options: Options<AdminCampaignsRetrieveData, ThrowOnError>) => RequestResult<AdminCampaignsRetrieveResponses, unknown, ThrowOnError, "data">;
+/**
+ * Partially update campaign
+ */
+declare const adminCampaignsPartialUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminCampaignsPartialUpdateData, ThrowOnError>) => RequestResult<AdminCampaignsPartialUpdateResponses, unknown, ThrowOnError, "data">;
+/**
+ * Update campaign
+ */
+declare const adminCampaignsUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminCampaignsUpdateData, ThrowOnError>) => RequestResult<AdminCampaignsUpdateResponses, unknown, ThrowOnError, "data">;
+/**
+ * Retrieve company
+ */
+declare const adminCompanyRetrieve: <ThrowOnError extends boolean = false>(options?: Options<AdminCompanyRetrieveData, ThrowOnError>) => RequestResult<AdminCompanyRetrieveResponses, unknown, ThrowOnError, "data">;
+/**
+ * Partially update company
+ */
+declare const adminCompanyPartialUpdate: <ThrowOnError extends boolean = false>(options?: Options<AdminCompanyPartialUpdateData, ThrowOnError>) => RequestResult<AdminCompanyPartialUpdateResponses, unknown, ThrowOnError, "data">;
+/**
+ * Update company
+ */
+declare const adminCompanyUpdate: <ThrowOnError extends boolean = false>(options?: Options<AdminCompanyUpdateData, ThrowOnError>) => RequestResult<AdminCompanyUpdateResponses, unknown, ThrowOnError, "data">;
+/**
+ * List currencies
+ */
+declare const adminCurrenciesList: <ThrowOnError extends boolean = false>(options?: Options<AdminCurrenciesListData, ThrowOnError>) => RequestResult<AdminCurrenciesListResponses, unknown, ThrowOnError, "data">;
+/**
+ * Retrieve currency
+ */
+declare const adminCurrenciesRetrieve: <ThrowOnError extends boolean = false>(options: Options<AdminCurrenciesRetrieveData, ThrowOnError>) => RequestResult<AdminCurrenciesRetrieveResponses, unknown, ThrowOnError, "data">;
+/**
+ * List rewards
+ */
+declare const adminRewardsList: <ThrowOnError extends boolean = false>(options?: Options<AdminRewardsListData, ThrowOnError>) => RequestResult<AdminRewardsListResponses, unknown, ThrowOnError, "data">;
+/**
+ * Create reward
+ */
+declare const adminRewardsCreate: <ThrowOnError extends boolean = false>(options: Options<AdminRewardsCreateData, ThrowOnError>) => RequestResult<AdminRewardsCreateResponses, unknown, ThrowOnError, "data">;
+/**
+ * Retrieve reward
+ */
+declare const adminRewardsRetrieve: <ThrowOnError extends boolean = false>(options: Options<AdminRewardsRetrieveData, ThrowOnError>) => RequestResult<AdminRewardsRetrieveResponses, unknown, ThrowOnError, "data">;
+/**
+ * Partially update reward
+ */
+declare const adminRewardsPartialUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminRewardsPartialUpdateData, ThrowOnError>) => RequestResult<AdminRewardsPartialUpdateResponses, unknown, ThrowOnError, "data">;
+/**
+ * Update reward
+ */
+declare const adminRewardsUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminRewardsUpdateData, ThrowOnError>) => RequestResult<AdminRewardsUpdateResponses, unknown, ThrowOnError, "data">;
+/**
+ * List users
+ */
+declare const adminUsersList: <ThrowOnError extends boolean = false>(options?: Options<AdminUsersListData, ThrowOnError>) => RequestResult<AdminUsersListResponses, unknown, ThrowOnError, "data">;
+/**
+ * Retrieve user
+ */
+declare const adminUsersRetrieve: <ThrowOnError extends boolean = false>(options: Options<AdminUsersRetrieveData, ThrowOnError>) => RequestResult<AdminUsersRetrieveResponses, unknown, ThrowOnError, "data">;
+/**
+ * Receive Platform webhook
+ */
+declare const adminWebhookCreate: <ThrowOnError extends boolean = false>(options: Options<AdminWebhookCreateData, ThrowOnError>) => RequestResult<AdminWebhookCreateResponses, unknown, ThrowOnError, "data">;
+/**
+ * Deactivate service
+ */
+declare const deactivateCreate: <ThrowOnError extends boolean = false>(options: Options<DeactivateCreateData, ThrowOnError>) => RequestResult<DeactivateCreateResponses, unknown, ThrowOnError, "data">;
+/**
+ * Retrieve user
+ */
+declare const userRetrieve: <ThrowOnError extends boolean = false>(options?: Options<UserRetrieveData, ThrowOnError>) => RequestResult<UserRetrieveResponses, unknown, ThrowOnError, "data">;
+/**
+ * Partially update user
+ */
+declare const userPartialUpdate: <ThrowOnError extends boolean = false>(options?: Options<UserPartialUpdateData, ThrowOnError>) => RequestResult<UserPartialUpdateResponses, unknown, ThrowOnError, "data">;
+/**
+ * Update user
+ */
+declare const userUpdate: <ThrowOnError extends boolean = false>(options: Options<UserUpdateData, ThrowOnError>) => RequestResult<UserUpdateResponses, unknown, ThrowOnError, "data">;
+/**
+ * List campaigns
+ */
+declare const userCampaignsList: <ThrowOnError extends boolean = false>(options?: Options<UserCampaignsListData, ThrowOnError>) => RequestResult<UserCampaignsListResponses, unknown, ThrowOnError, "data">;
+/**
+ * Retrieve campaign
+ */
+declare const userCampaignsRetrieve: <ThrowOnError extends boolean = false>(options: Options<UserCampaignsRetrieveData, ThrowOnError>) => RequestResult<UserCampaignsRetrieveResponses, unknown, ThrowOnError, "data">;
+/**
+ * List rewards
+ */
+declare const userRewardsList: <ThrowOnError extends boolean = false>(options?: Options<UserRewardsListData, ThrowOnError>) => RequestResult<UserRewardsListResponses, unknown, ThrowOnError, "data">;
+/**
+ * Create reward
+ */
+declare const userRewardsCreate: <ThrowOnError extends boolean = false>(options: Options<UserRewardsCreateData, ThrowOnError>) => RequestResult<UserRewardsCreateResponses, unknown, ThrowOnError, "data">;
+/**
+ * Retrieve user
+ */
+declare const userRewardsRetrieve: <ThrowOnError extends boolean = false>(options: Options<UserRewardsRetrieveData, ThrowOnError>) => RequestResult<UserRewardsRetrieveResponses, unknown, ThrowOnError, "data">;
+/**
+ * Receive Platform webhook
+ */
+declare const webhookCreate: <ThrowOnError extends boolean = false>(options: Options<WebhookCreateData, ThrowOnError>) => RequestResult<WebhookCreateResponses, unknown, ThrowOnError, "data">;
+
+type sdk_Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options<TData, ThrowOnError>;
+declare const sdk_activateCreate: typeof activateCreate;
+declare const sdk_adminCampaignsCreate: typeof adminCampaignsCreate;
+declare const sdk_adminCampaignsDestroy: typeof adminCampaignsDestroy;
+declare const sdk_adminCampaignsList: typeof adminCampaignsList;
+declare const sdk_adminCampaignsPartialUpdate: typeof adminCampaignsPartialUpdate;
+declare const sdk_adminCampaignsRetrieve: typeof adminCampaignsRetrieve;
+declare const sdk_adminCampaignsUpdate: typeof adminCampaignsUpdate;
+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_adminCurrenciesRetrieve: typeof adminCurrenciesRetrieve;
+declare const sdk_adminRewardsCreate: typeof adminRewardsCreate;
+declare const sdk_adminRewardsList: typeof adminRewardsList;
+declare const sdk_adminRewardsPartialUpdate: typeof adminRewardsPartialUpdate;
+declare const sdk_adminRewardsRetrieve: typeof adminRewardsRetrieve;
+declare const sdk_adminRewardsUpdate: typeof adminRewardsUpdate;
+declare const sdk_adminUsersList: typeof adminUsersList;
+declare const sdk_adminUsersRetrieve: typeof adminUsersRetrieve;
+declare const sdk_adminWebhookCreate: typeof adminWebhookCreate;
+declare const sdk_deactivateCreate: typeof deactivateCreate;
+declare const sdk_userCampaignsList: typeof userCampaignsList;
+declare const sdk_userCampaignsRetrieve: typeof userCampaignsRetrieve;
+declare const sdk_userPartialUpdate: typeof userPartialUpdate;
+declare const sdk_userRetrieve: typeof userRetrieve;
+declare const sdk_userRewardsCreate: typeof userRewardsCreate;
+declare const sdk_userRewardsList: typeof userRewardsList;
+declare const sdk_userRewardsRetrieve: typeof userRewardsRetrieve;
+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_adminCampaignsCreate as adminCampaignsCreate, sdk_adminCampaignsDestroy as adminCampaignsDestroy, sdk_adminCampaignsList as adminCampaignsList, sdk_adminCampaignsPartialUpdate as adminCampaignsPartialUpdate, sdk_adminCampaignsRetrieve as adminCampaignsRetrieve, sdk_adminCampaignsUpdate as adminCampaignsUpdate, sdk_adminCompanyPartialUpdate as adminCompanyPartialUpdate, sdk_adminCompanyRetrieve as adminCompanyRetrieve, sdk_adminCompanyUpdate as adminCompanyUpdate, sdk_adminCurrenciesList as adminCurrenciesList, sdk_adminCurrenciesRetrieve as adminCurrenciesRetrieve, sdk_adminRewardsCreate as adminRewardsCreate, sdk_adminRewardsList as adminRewardsList, sdk_adminRewardsPartialUpdate as adminRewardsPartialUpdate, sdk_adminRewardsRetrieve as adminRewardsRetrieve, sdk_adminRewardsUpdate as adminRewardsUpdate, sdk_adminUsersList as adminUsersList, sdk_adminUsersRetrieve as adminUsersRetrieve, sdk_adminWebhookCreate as adminWebhookCreate, sdk_deactivateCreate as deactivateCreate, sdk_userCampaignsList as userCampaignsList, sdk_userCampaignsRetrieve as userCampaignsRetrieve, sdk_userPartialUpdate as userPartialUpdate, sdk_userRetrieve as userRetrieve, sdk_userRewardsCreate as userRewardsCreate, sdk_userRewardsList as userRewardsList, sdk_userRewardsRetrieve as userRewardsRetrieve, sdk_userUpdate as userUpdate, sdk_webhookCreate as webhookCreate };
+}
+
+type RewardsApi = BoundSdk<typeof sdk>;
+declare function createRewardsApi(config: ApiFactoryConfig): RewardsApi;
+
+export { type ActionResponse, type Activate, type ActivateCreateData, type ActivateCreateResponse, type ActivateCreateResponses, type AdminCampaign, type AdminCampaignResponse, type AdminCampaignResponseWritable, type AdminCampaignWritable, type AdminCampaignsCreateData, type AdminCampaignsCreateResponse, type AdminCampaignsCreateResponses, type AdminCampaignsDestroyData, type AdminCampaignsDestroyResponse, type AdminCampaignsDestroyResponses, type AdminCampaignsListData, type AdminCampaignsListResponse, type AdminCampaignsListResponses, type AdminCampaignsPartialUpdateData, type AdminCampaignsPartialUpdateResponse, type AdminCampaignsPartialUpdateResponses, type AdminCampaignsRetrieveData, type AdminCampaignsRetrieveResponse, type AdminCampaignsRetrieveResponses, type AdminCampaignsUpdateData, type AdminCampaignsUpdateResponse, type AdminCampaignsUpdateResponses, 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 AdminCreateReward, type AdminCreateRewardWritable, type AdminCreateUpdateCampaign, type AdminCreateUpdateCampaignWritable, type AdminCurrenciesListData, type AdminCurrenciesListResponse, type AdminCurrenciesListResponses, type AdminCurrenciesRetrieveData, type AdminCurrenciesRetrieveResponse, type AdminCurrenciesRetrieveResponses, type AdminReward, type AdminRewardResponse, type AdminRewardResponseWritable, type AdminRewardWritable, type AdminRewardsCreateData, type AdminRewardsCreateResponse, type AdminRewardsCreateResponses, type AdminRewardsListData, type AdminRewardsListResponse, type AdminRewardsListResponses, type AdminRewardsPartialUpdateData, type AdminRewardsPartialUpdateResponse, type AdminRewardsPartialUpdateResponses, type AdminRewardsRetrieveData, type AdminRewardsRetrieveResponse, type AdminRewardsRetrieveResponses, type AdminRewardsUpdateData, type AdminRewardsUpdateResponse, type AdminRewardsUpdateResponses, type AdminUser, type AdminUserResponse, type AdminUserResponseWritable, type AdminUsersListData, type AdminUsersListResponse, type AdminUsersListResponses, type AdminUsersRetrieveData, type AdminUsersRetrieveResponse, type AdminUsersRetrieveResponses, type AdminWebhookCreateData, type AdminWebhookCreateResponse, type AdminWebhookCreateResponses, type Campaign, type CampaignWritable, type ClientOptions, type Currency, type CurrencyResponse, type Deactivate, type DeactivateCreateData, type DeactivateCreateResponse, type DeactivateCreateResponses, type PaginatedAdminCampaignList, type PaginatedAdminCampaignListResponse, type PaginatedAdminCampaignListResponseWritable, type PaginatedAdminCampaignListWritable, type PaginatedAdminRewardList, type PaginatedAdminRewardListResponse, type PaginatedAdminRewardListResponseWritable, type PaginatedAdminRewardListWritable, type PaginatedAdminUserList, type PaginatedAdminUserListResponse, type PaginatedAdminUserListResponseWritable, type PaginatedAdminUserListWritable, type PaginatedCurrencyList, type PaginatedCurrencyListResponse, type PaginatedUserCampaignList, type PaginatedUserCampaignListResponse, type PaginatedUserCampaignListResponseWritable, type PaginatedUserCampaignListWritable, type PaginatedUserRewardList, type PaginatedUserRewardListResponse, type PaginatedUserRewardListResponseWritable, type PaginatedUserRewardListWritable, type PatchedAdminCompany, type PatchedAdminCompanyWritable, type PatchedAdminCreateUpdateCampaign, type PatchedAdminCreateUpdateCampaignWritable, type PatchedAdminReward, type PatchedAdminRewardWritable, type PatchedUserUpdateReferral, type PatchedUserUpdateReferralWritable, type RewardsApi, type User, type UserCampaign, type UserCampaignResponse, type UserCampaignResponseWritable, type UserCampaignWritable, type UserCampaignsListData, type UserCampaignsListResponse, type UserCampaignsListResponses, type UserCampaignsRetrieveData, type UserCampaignsRetrieveResponse, type UserCampaignsRetrieveResponses, type UserCreateReward, type UserCreateRewardWritable, type UserPartialUpdateData, type UserPartialUpdateResponse, type UserPartialUpdateResponses, type UserResponse, type UserResponseWritable, type UserRetrieveData, type UserRetrieveResponse, type UserRetrieveResponses, type UserReward, type UserRewardResponse, type UserRewardResponseWritable, type UserRewardWritable, type UserRewardsCreateData, type UserRewardsCreateResponse, type UserRewardsCreateResponses, type UserRewardsListData, type UserRewardsListResponse, type UserRewardsListResponses, type UserRewardsRetrieveData, type UserRewardsRetrieveResponse, type UserRewardsRetrieveResponses, type UserUpdateData, type UserUpdateReferral, type UserUpdateReferralWritable, type UserUpdateResponse, type UserUpdateResponses, type Webhook, type WebhookCreateData, type WebhookCreateResponse, type WebhookCreateResponses, createRewardsApi };