@superlikers/microsites-api 0.1.0

package/types/superlikers-microsites-api.d.ts

@@ -0,0 +1,1958 @@
+import { HttpErrorResponse } from '@angular/common/http';
+import * as i0 from '@angular/core';
+import { EnvironmentProviders } from '@angular/core';
+import { Observable } from 'rxjs';
+
+/**
+ * Error thrown by every `@superlikers/microsites-api` request.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   await firstValueFrom(sessionService.login(data))
+ * } catch (error) {
+ *   if (isApiError(error)) this.message.set(error.message)
+ * }
+ * ```
+ */
+declare class ApiError extends Error {
+    readonly name = "ApiError";
+    /** HTTP status. `0` means the request never reached the server (network, CORS, offline). */
+    readonly status: number;
+    /** Backend error code (`code_error`), e.g. `140`. `null` when the backend did not send one. */
+    readonly code: number | null;
+    /** Validation errors by field name, e.g. `{ email: 'is invalid' }`. Empty when there are none. */
+    readonly fieldErrors: Readonly<Record<string, string>>;
+    /** URL of the failed request. */
+    readonly url: string | null;
+    /**
+     * `true` when the server answered with something that is not JSON (e.g. an HTML page).
+     * Happens when a module is disabled for the campaign: the backend redirects to the site instead of answering.
+     */
+    readonly isInvalidResponse: boolean;
+    constructor(response: HttpErrorResponse);
+    get isNetworkError(): boolean;
+    get isUnauthorized(): boolean;
+}
+declare function isApiError(error: unknown): error is ApiError;
+
+/**
+ * Configuration for `@superlikers/microsites-api`, passed to {@link provideMicrositesApi}.
+ */
+interface MicrositesApiConfig {
+    /**
+     * Absolute URL of the microsite backend, e.g. `https://4x.superlikerslabs.com`.
+     * A trailing slash is removed automatically.
+     */
+    baseUrl: string;
+    /**
+     * Called when a request fails with `401 Unauthorized` (the error is still thrown to the caller).
+     * Runs in an injection context, so `inject()` can be used.
+     *
+     * @example
+     * ```ts
+     * provideMicrositesApi({
+     *   baseUrl: environment.baseUrl,
+     *   onUnauthorized: () => inject(Router).navigate(['/login'])
+     * })
+     * ```
+     */
+    onUnauthorized?: (error: ApiError) => void;
+}
+
+/**
+ * Configures `@superlikers/microsites-api` for the application.
+ *
+ * @example
+ * ```ts
+ * // app.config.ts
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [provideMicrositesApi({ baseUrl: environment.baseUrl })]
+ * }
+ * ```
+ */
+declare function provideMicrositesApi(config: MicrositesApiConfig): EnvironmentProviders;
+
+/** Points of one point type (coin). */
+interface Coin {
+    /** Point type id. */
+    pt_id: string;
+    name: string;
+    total: number;
+}
+/**
+ * Fields every participant has, in every campaign. Extend it with the campaign fields:
+ *
+ * @example
+ * ```ts
+ * interface Participant extends BaseParticipant {
+ *   codigo_sap: string
+ *   'codigo-de-cliente': string // keys with hyphens must be quoted
+ * }
+ * ```
+ */
+interface BaseParticipant {
+    id: string;
+    uid: string;
+    uid_type: string | null;
+    /** e.g. `active`. */
+    state: string;
+    name: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+    /** Empty when there is no email pending confirmation. */
+    unconfirmed_email: string;
+    email_verified: boolean;
+    cellphone_verified: boolean;
+    avatar: string;
+    picture_url: string;
+    large_picture_url: string;
+    points: number;
+    total_points: number;
+    coins: Coin[];
+    total_coins: Coin[];
+    level: Record<string, unknown>;
+    next_level: Record<string, unknown>;
+    tags: string[];
+    sector: string | null;
+    sector_b: string | null;
+    sector_c: string | null;
+    /** Empty when the participant has no team. */
+    team: string;
+    team_id: string;
+    /** Unix timestamp in seconds. */
+    created_at: number;
+    /** ISO date. */
+    last_activity_at: string;
+}
+/** The logged participant, as returned by `/sconfig`. */
+interface BaseCurrentParticipant extends BaseParticipant {
+    authenticated: boolean;
+}
+interface Campaign {
+    id: string;
+    /** Microsite id, e.g. `4x`. */
+    unique_id: string;
+    domain: string;
+    has_custom_domain: boolean;
+    language: string;
+    login_for: string;
+    permissions: string;
+    /** Comma-separated enabled modules, e.g. `SignupModule,PhotosModule,BlogModule`. */
+    modules: string;
+    facebook_id: string | null;
+}
+/** `GET /sconfig` — site config and the logged participant. */
+interface CurrentParticipantResponse<T = BaseCurrentParticipant> {
+    global: {
+        env: string;
+        ask_login: boolean;
+    };
+    campaign: Campaign;
+    participation: T;
+}
+/** `GET /participants/show` */
+interface ParticipantResponse<T = BaseParticipant> {
+    state: string;
+    data: T;
+}
+/** Filters for `GET /participants/list`. */
+interface ParticipantListParams {
+    page?: number;
+    limit?: number;
+    q?: string;
+    tags?: string[];
+    exact_tags?: boolean;
+    with_admins?: boolean;
+}
+/** `GET /participants/list` */
+interface ParticipantListResponse<T = BaseParticipant> {
+    state: string;
+    data: T[];
+}
+/** Fields always present in {@link ParticipantRank.data}. Extend it with the campaign fields. */
+interface BaseParticipantRankData {
+    email: string;
+    unconfirmed_email: string;
+    avatar: string;
+    tags: string[];
+}
+interface ParticipantRank<T = BaseParticipantRankData> {
+    name: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+    avatar: string;
+    tags: string[];
+    points: number;
+    votes: number;
+    /** Level number (unlike `BaseParticipant.level`, which is an object). */
+    level: number;
+    /** Position in the ranking. */
+    ranking: number;
+    /** Points by point type id, e.g. `{ '6a2302881bf9ca74293ffa67': 358 }`. */
+    points_by_ptype: Record<string, number>;
+    colour: string | null;
+    /** Participant data: common fields plus the campaign ones. */
+    data: T;
+}
+/** `GET /participant_rank` */
+interface ParticipantRankResponse<T = BaseParticipantRankData> {
+    state: string;
+    data: ParticipantRank<T>;
+}
+/** Web Push subscription as returned by the browser (`PushSubscription.toJSON()`). */
+interface PushSubscriptionPayload {
+    endpoint: string;
+    expirationTime?: number | null;
+    keys: {
+        p256dh: string;
+        auth: string;
+    };
+}
+/** `POST /participants/save_push_subscription` */
+interface SavePushSubscriptionResponse {
+    state?: string;
+    data: {
+        success: boolean;
+    };
+}
+/** `POST /participants/remove_push_subscriptions` */
+interface RemovePushSubscriptionsResponse {
+    state: string;
+    data: {
+        success: boolean;
+    };
+}
+
+/**
+ * Participant embedded in activities (entries, blog posts, comments, achievements).
+ * Same shape in every campaign; it carries no campaign-specific fields.
+ */
+interface ActivityParticipant {
+    _id: string;
+    uid: string;
+    name: string;
+    email: string;
+    bad_email: boolean;
+    email_verified: boolean;
+    avatar: string;
+    state: string;
+    points: number;
+    total_points: number;
+    level: number;
+    coins: Coin[];
+    total_coins: Coin[];
+    badges: unknown[];
+    tags: string[];
+    total_activities: number;
+    form_id: string;
+    facebook_uid: string | null;
+    facebook_link: string;
+    connection: {
+        tw: boolean;
+        fb: boolean;
+        pw: boolean;
+    };
+    /** ISO date. */
+    last_activity_at: string;
+    /** Unix timestamp in seconds. */
+    created_at: number;
+    /** Unix timestamp in seconds. */
+    updated_at: number;
+}
+
+/** Date range filter. Dates as `yyyy-mm-dd`; send the same date twice for a single day. */
+interface DateFilter {
+    sdate: string;
+    edate: string;
+}
+
+/** Backend type of a form field (`_type`). */
+type FieldType = 'UserEmailField' | 'PasswordField' | 'SelectField' | 'TextField' | 'NumberField' | 'PhoneField' | 'HiddenField' | 'CheckBoxGroupField' | 'CheckBoxField';
+interface FieldChoice {
+    label: string;
+    value: string;
+}
+/** A form field as described by the backend (login form, registration form, external forms…). */
+interface Field {
+    _id: string;
+    _type: FieldType;
+    /** Key to send the value with, e.g. `codigo_sap`. */
+    name: string;
+    label: string;
+    /** HTML-like input type, e.g. `text`, `password`, `email`. */
+    field_type: string;
+    /** Value type, e.g. `String`. */
+    typeval: string;
+    placeholder: string | null;
+    default_value: string | null;
+    help_text: string | null;
+    /** Regular expression the value must match. Empty or `null` when there is none. */
+    pattern: string | null;
+    choices?: FieldChoice[];
+    required_field: boolean;
+    hidden_field: boolean | null;
+    is_public: boolean;
+    is_readonly: boolean;
+    unique_field: boolean;
+    /** Name of the confirmation field (e.g. `password_confirm`), when the field must be typed twice. */
+    confirm?: string;
+    confirm_label?: string;
+    minimum_length?: number;
+    must_have_number?: boolean | null;
+    must_have_special_characters?: boolean | null;
+    messages: {
+        blank?: string | null;
+        taken?: string | null;
+    };
+}
+
+type AchievementType = 'GoalAchievement' | 'BadgeAchievement';
+/** Filters for `GET /achievements/index`. */
+interface AchievementsParams {
+    date_filter?: DateFilter;
+    /** @default 'list' */
+    view?: 'list' | 'show';
+    _type?: AchievementType;
+    tags?: string[];
+    after?: string;
+    before?: string;
+    cursor_paginated?: boolean;
+    index_page?: string;
+    skip?: number;
+    limit?: number;
+    participant_uid?: string;
+    uid_type?: string;
+    goal_id?: string;
+    order?: 'asc' | 'desc';
+}
+interface BaseAchievement {
+    _id: string;
+    _type: string;
+    tags: string[];
+    name: string;
+    created_at: number;
+    participant_filter: string[];
+}
+interface GoalAchievement extends BaseAchievement {
+    state: string;
+    activity_filter: string[];
+    activity_target: string;
+    period: string | null;
+    primary_reward_id: string | null;
+    total_primary_reward: number | null;
+    conditions_snapshot: unknown[];
+    /** Participant who earned the achievement. */
+    participant: ActivityParticipant;
+    reward_name: string;
+    reward_type: string;
+    total_reward: number;
+    goal_start_period?: string | null;
+    goal_end_period?: string | null;
+    goal: {
+        _id: string;
+        activity_target: string;
+        name: string;
+        reward_id: string | null;
+    };
+}
+interface BadgeAchievement extends BaseAchievement {
+    badge_handler_id: string;
+    badge_handler_type: string;
+    badge_remover_id: string | null;
+    badge_remover_type: string | null;
+    campaign_id: string;
+    participation_id: string;
+    removed: boolean;
+    removed_date: string | null;
+    team_id: string | null;
+    badge_handler_name: string;
+    badge: {
+        _id: string;
+        name: string;
+    };
+}
+interface AchievementsMetadata {
+    view: string;
+    /** Pagination fields are only sent for some views (`view: 'list'` sends just `view`). */
+    total?: number;
+    partial?: boolean;
+    page?: number;
+    page_size?: number;
+    total_pages?: number;
+}
+/** `GET /achievements/index` */
+interface AchievementsListResponse<T = GoalAchievement | BadgeAchievement> {
+    data: T[];
+    metadata: AchievementsMetadata;
+}
+
+/** Achievements earned by participants (goal and badge achievements). */
+declare class AchievementsService {
+    #private;
+    list<T = GoalAchievement | BadgeAchievement>(params?: AchievementsParams): Observable<AchievementsListResponse<T>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AchievementsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+interface UploadPhotoParams {
+    file: File | Blob;
+    filename?: string;
+    category?: string;
+}
+/** `POST /mod/photos` */
+interface UploadPhotoResponse {
+    state: string;
+    message: string;
+    location?: string;
+    errors?: Record<string, unknown>;
+}
+interface UploadDocumentParams {
+    file: File;
+    category?: string;
+}
+/** `POST /mod/documents` */
+interface UploadDocumentResponse {
+    state: string;
+    message: string;
+    location?: string;
+    errors?: Record<string, unknown>;
+}
+
+/** Photo and document uploads. */
+declare class ActivitiesService {
+    #private;
+    uploadPhoto({ file, filename, category }: UploadPhotoParams): Observable<UploadPhotoResponse>;
+    uploadDocument({ file, category }: UploadDocumentParams): Observable<UploadDocumentResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ActivitiesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+interface BadgesParams {
+    page?: number;
+    q?: string;
+}
+interface BadgeConditions {
+    points: number;
+    level: number;
+    actions: Record<string, unknown>;
+    other_badges_required: Record<string, unknown>;
+}
+interface Badge {
+    _id: string;
+    name: string;
+    slug: string;
+    description: string;
+    color: string;
+    conditions: BadgeConditions;
+    tags: string[];
+    enabled: boolean;
+    granted: number;
+    limit: number;
+    image: {
+        url: string | null;
+    };
+    image_url: string;
+    image_default: string;
+    can_be_removed: boolean;
+    allow_admin_handling: boolean;
+    participant_filter: string[];
+    campaign_id: string;
+    created_at: string;
+    updated_at: string;
+}
+/** `GET /badges/index` */
+interface BadgesListResponse {
+    state: string;
+    data: Badge[];
+}
+/** `GET /badges/:id/show` */
+interface BadgeResponse {
+    state: string;
+    data: Badge;
+}
+interface ParticipantBadge {
+    _id: string;
+    badge_id: string;
+    badge_name: string;
+    image_url: string;
+    tags: string[];
+    total: number;
+}
+/** `GET /badges/stats` */
+interface ParticipantBadgesResponse {
+    state: string;
+    data: ParticipantBadge[];
+}
+
+/** Badges and the badges earned by a participant. */
+declare class BadgesService {
+    #private;
+    list(params?: BadgesParams): Observable<BadgesListResponse>;
+    get(id: string): Observable<BadgeResponse>;
+    /** Badges earned by the logged participant, or by `uid` when given. */
+    getStats(uid?: string): Observable<ParticipantBadgesResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BadgesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+/** Filters for `GET /mod/blog`. */
+interface BlogPostsParams {
+    /** @default 1 */
+    page?: number;
+    limit?: number;
+    q?: string;
+    tags?: string[];
+    category?: string;
+}
+interface BlogPost<T = ActivityParticipant> {
+    _id: string;
+    title: string;
+    body: string;
+    format: string;
+    state: string;
+    moderation: string;
+    atype: string;
+    category: string | null;
+    admin: boolean;
+    archived: boolean;
+    points: number;
+    extra_points: number;
+    execute_date: string | null;
+    owner_name: string | null;
+    team: string | null;
+    permalink: string;
+    short_url: string | null;
+    facebook_tab_url: string | null;
+    cover_url?: string;
+    video_cover_url?: string;
+    tags: string[];
+    participants_tags: string[];
+    editable_by: string | null;
+    deleteable_by: string | null;
+    votes_count: number;
+    votes_average: number;
+    votes_up: number;
+    votes_down: number;
+    voted: boolean;
+    created_at: number;
+    participant: T;
+}
+interface BlogsMetadata {
+    data_method: string;
+    data_method_params?: string;
+    total: number;
+    partial: boolean;
+    page: number;
+    page_size: number;
+    total_pages: number;
+}
+/** `GET /mod/blog` */
+interface BlogPostsResponse<T = ActivityParticipant> {
+    data: BlogPost<T>[];
+    metadata: BlogsMetadata;
+}
+/** `GET /mod/blog/:id/show` */
+interface BlogPostResponse<T = ActivityParticipant> {
+    state: string;
+    data: BlogPost<T>;
+}
+interface CreateBlogPostParams {
+    title: string;
+    body: string;
+    /** @default 'text' */
+    format?: 'text' | 'markdown';
+    attached_file?: File;
+    category?: string;
+    tags?: string[];
+    push_redirect_url?: string;
+}
+interface CreatedBlogPost<T = ActivityParticipant> {
+    _id: string;
+    _type: string;
+    name: string;
+    title: string;
+    format: string;
+    state: string;
+    moderation: string;
+    atype: string;
+    category: string | null;
+    points: number;
+    activity_count: number;
+    execute_date: number;
+    module: string;
+    team: string | null;
+    point_type: string | null;
+    votes_count?: number;
+    created_at: number;
+    participant: T;
+}
+/** `POST /mod/blogs` */
+interface CreateBlogPostResponse<T = ActivityParticipant> {
+    state: string;
+    activity_state: string;
+    activity_points: number;
+    message: string;
+    execution_error: string;
+    object: CreatedBlogPost<T>;
+}
+
+/** Blog posts (mod/blog activity). */
+declare class BlogsService {
+    #private;
+    list<T = ActivityParticipant>(params?: BlogPostsParams): Observable<BlogPostsResponse<T>>;
+    get<T = ActivityParticipant>(id: string): Observable<BlogPostResponse<T>>;
+    create<T = ActivityParticipant>({ title, body, format, attached_file, category, tags, push_redirect_url }: CreateBlogPostParams): Observable<CreateBlogPostResponse<T>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BlogsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+interface BoardsParams {
+    page?: number;
+    q?: string;
+}
+interface BoardsFilter {
+    _id: string;
+    field: string;
+    operator: string;
+    val: string;
+}
+interface Board {
+    _id: string;
+    campaign_id: string;
+    name: string;
+    desc: string;
+    is_private: boolean;
+    owner_id: string;
+    shared_with: string[];
+}
+interface BoardsMetadata {
+    total: number;
+    partial: boolean;
+    page: number;
+    page_size: number;
+    total_pages: number;
+}
+/** `GET /boards/index` */
+interface BoardsListResponse {
+    data: Board[];
+    metadata: BoardsMetadata;
+}
+interface Report {
+    _id: string;
+    name: string;
+    coll: string;
+    target_property: string | null;
+    analysis_type: string;
+    desc: string | null;
+    filter: BoardsFilter[];
+}
+/** `GET /boards/:board/reports` */
+interface BoardReportsResponse {
+    data: Report[];
+    metadata: BoardsMetadata;
+}
+interface ExecuteReportParams {
+    timeframe?: string;
+    start_date?: string;
+    end_date?: string;
+}
+/** `GET /boards/:board/reports/:report/exec` */
+interface ExecuteReportResponse {
+    state: string;
+    message: string;
+    since: number;
+    /** `null` while the report is still being generated (see `report_state` and `message`). */
+    result: {
+        value: number;
+    }[] | null;
+    report_data: Report;
+    report_params: {
+        timeframe?: string;
+    };
+    report_state: string;
+}
+
+/** Dashboards (boards) and their reports. */
+declare class BoardsService {
+    #private;
+    list(params?: BoardsParams): Observable<BoardsListResponse>;
+    listReports(board: string, page?: number): Observable<BoardReportsResponse>;
+    /** Either `timeframe` or `start_date`/`end_date` is used, never both. */
+    executeReport(board: string, report: string, params?: ExecuteReportParams): Observable<ExecuteReportResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BoardsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+interface CommentsParams {
+    page?: number;
+    q?: string;
+    limit?: number;
+    category?: string;
+}
+interface Comment<T = ActivityParticipant> {
+    _id: string;
+    body: string;
+    state: string;
+    category: string | null;
+    moderation: string;
+    atype: string;
+    admin: boolean;
+    archived: boolean;
+    points: number;
+    extra_points: number;
+    execute_date: string;
+    owner_name: string;
+    team: string | null;
+    editable_by: string | null;
+    deleteable_by: string;
+    voted: boolean;
+    tags: string[];
+    participants_tags: string[];
+    push_redirect_url: string | null;
+    created_at: number;
+    participant: T;
+}
+interface CommentsMetadata {
+    data_method: string;
+    data_method_params?: unknown[];
+    total: number;
+    partial: boolean;
+    page: number;
+    page_size: number;
+    total_pages: number;
+}
+/** `GET /mod/comments/:targetId` */
+interface CommentsListResponse<T = ActivityParticipant> {
+    data: Comment<T>[];
+    metadata: CommentsMetadata;
+}
+interface CreateCommentParams {
+    body: string;
+    category?: string;
+}
+interface CreatedComment<T = ActivityParticipant> {
+    _id: string;
+    _type: string;
+    name: string;
+    category: string | null;
+    point_type: string | null;
+    state: string;
+    moderation: string;
+    atype: string;
+    points: number;
+    activity_count: number;
+    execute_date: number;
+    module: string;
+    team: string | null;
+    votes_count?: number;
+    created_at: number;
+    participant: T;
+}
+/** `POST /mod/comments/:targetId` */
+interface CreateCommentResponse<T = ActivityParticipant> {
+    state: string;
+    activity_state: string;
+    activity_points: number;
+    message: string;
+    execution_error: string;
+    object: CreatedComment<T>;
+}
+
+/** Comments on an activity (target). */
+declare class CommentsService {
+    #private;
+    list<T = ActivityParticipant>(targetId: string, params?: CommentsParams): Observable<CommentsListResponse<T>>;
+    create<T = ActivityParticipant>(targetId: string, { body, category }: CreateCommentParams): Observable<CreateCommentResponse<T>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CommentsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+type PrizeType = 'CouponPrize' | 'ExternalCouponPrize' | 'Prize';
+/** Filters for `GET /prizes/index`. */
+interface PrizesParams {
+    tags?: string[];
+    /** @default 1 */
+    page?: number;
+    redeemable?: boolean;
+    fits_points?: boolean;
+    sort?: {
+        active: string;
+        direction: 'asc' | 'desc';
+    };
+    limit?: number;
+    /** @default 'show' */
+    view?: 'show' | 'list';
+}
+interface PrizeDetails {
+    value: string;
+    description: string;
+}
+interface PrizeMetadata {
+    name?: string;
+    description?: string;
+    terms_and_conditions?: string;
+    buyer_conditions?: string;
+    image?: string;
+    localizable?: boolean;
+    cities?: string[];
+    exchange_type?: string;
+    processing_days?: string;
+    validity_time?: number;
+    prize_details?: PrizeDetails;
+    extra_fields?: unknown[];
+}
+interface Prize {
+    _id: string;
+    _type: PrizeType;
+    name: string;
+    description: string;
+    category: string;
+    points: number;
+    quantity: number | null;
+    quantity_available: number;
+    tags: string[];
+    filter: string[];
+    available: boolean;
+    redeemable: boolean;
+    unlimited: boolean;
+    use_point_type: boolean;
+    user_limit: number;
+    user_limit_timeframe: string | null;
+    point_type: string | null;
+    point_type_id: string | null;
+    allowed_point_type_ids: string[];
+    image_url: string | null;
+    prize_image_url: string;
+    prize_details?: PrizeDetails;
+    extra_fields?: unknown[];
+    require_redemption_token: boolean;
+    use_codes_vault?: boolean;
+    quantity_limit_timeframe: string | null;
+    shipping?: boolean;
+    is_custom_prize?: boolean;
+    custom_data?: unknown[];
+    tc: string | null;
+    eid?: string;
+    size?: number;
+    expiration_days: number;
+    can_redeem: boolean;
+    missing_points: number;
+    missing_level: string | null;
+    missing_badges: string | null;
+    missing_rule: string | null;
+    user_overlimit: boolean;
+    humanize_missing_conditions: string | null;
+    redeem_url: string;
+    is_coupon_prize?: boolean;
+    is_external_coupon_prize?: boolean;
+    is_prize?: boolean;
+    addon_id?: string;
+    metadata?: PrizeMetadata;
+    sponsor: string | null;
+    sponsor_id: string | null;
+}
+interface PrizesMetadata {
+    data_method: string;
+    data_method_params?: string[];
+    total: number;
+    partial: boolean;
+    page: number;
+    page_size: number;
+    total_pages: number;
+}
+/** `GET /prizes/index` */
+interface PrizesListResponse {
+    data: Prize[];
+    metadata: PrizesMetadata;
+}
+/** `GET /prizes/:id/redeem/check` */
+interface CheckRedeemResponse {
+    state: string;
+    success: boolean;
+    prize: Prize;
+    kind: PrizeType;
+    extra_form: string;
+}
+/** `POST /prizes/:id/redeem` */
+interface RedeemedPrize {
+    _id: string;
+    redeem_id: string;
+    prize_name: string;
+    prize_description: string;
+    image_url: string;
+    points: number;
+    point_type: string | null;
+    state: string;
+    is_redemption_coupon: boolean;
+    success: boolean;
+    code: string;
+    barcode_url: string;
+    qrcode_url: string;
+    url: string;
+    link: string;
+    pdf: string;
+    created_at: number;
+    updated_at: number;
+}
+/** `GET /prizes/whislist` */
+interface WishlistResponse {
+    data: Prize[];
+    metadata: PrizesMetadata;
+}
+/** `GET /prizes/:id/whislist_toggle` */
+interface ToggleWishlistResponse {
+    state: string;
+    message?: string;
+}
+interface ExternalCouponData {
+    name: string;
+    value: string;
+}
+/** `GET /prizes/:id/redeem/external/:key` */
+type ExternalCouponDataResponse = ExternalCouponData[];
+
+/** Campaign-specific data of an `External` entry. Each microsite can pass its own interface. */
+type EntryData = Record<string, unknown>;
+/** Fields every entry has, whatever its `_type`. */
+interface BaseEntry {
+    _id: string;
+    /** Kind of activity: `External`, `Redeem`, `UploadPhoto`… (see {@link EntryTypes}). */
+    _type: string;
+    /** External action slug for `External` entries; equal to `_type` for the others. */
+    atype: string;
+    name: string;
+    category: string | null;
+    points: number;
+    point_type: string | null;
+    state: string;
+    moderation: string;
+    team: string | null;
+    activity_count: number;
+    /** Unix timestamp in seconds. */
+    created_at: number;
+    participant: ActivityParticipant;
+}
+interface ExternalEntry<T = EntryData> extends BaseEntry {
+    _type: 'External';
+    /** Campaign-specific data (the external form / event values). */
+    data: T;
+    as_form: boolean | null;
+    module: string;
+    execute_date: number;
+}
+/** Prize as embedded in a redemption entry (a subset of `Prize`). */
+interface EntryPrize {
+    _id: string;
+    _type: PrizeType;
+    name: string;
+    description: string;
+    category: string;
+    points: number;
+    image_url: string;
+    prize_image_url: string;
+    tags: string[];
+    tc: string;
+    filter: string[];
+    redeemable: boolean;
+    unlimited: boolean;
+    quantity: number | null;
+    quantity_available: number;
+    quantity_limit_timeframe: string | null;
+    user_limit: number;
+    user_limit_timeframe: string;
+    expiration_days: number;
+    use_point_type: boolean;
+    point_type: string | null;
+    point_type_id: string | null;
+    allowed_point_type_ids: string[];
+    require_redemption_token: boolean;
+    sponsor: string | null;
+    sponsor_id: string | null;
+    eid?: string;
+    addon_id?: string;
+    size?: number;
+    use_codes_vault?: boolean;
+    extra_fields?: unknown[];
+    prize_details?: PrizeDetails;
+    metadata?: PrizeMetadata;
+}
+interface Redemption {
+    _id: string;
+    redeem_id: string;
+    prize_name: string;
+    image_url: string;
+    points: number;
+    point_type: string | null;
+    state: string;
+    url?: string;
+    /** Unix timestamp in seconds. */
+    expires_at?: number;
+    created_at: number;
+    updated_at: number;
+}
+interface RedeemEntry extends BaseEntry {
+    _type: 'Redeem';
+    prize: EntryPrize;
+    redemption: Redemption;
+    redemption_state: string;
+    gift: boolean;
+    source: string;
+}
+interface PhotoEntry extends BaseEntry {
+    _type: 'UploadPhoto';
+    photo_url: string;
+    sha1: string;
+    votes_count: number;
+    module: string;
+    execute_date?: number;
+}
+interface DocumentEntry extends BaseEntry {
+    _type: 'UploadDocument';
+    document_url: string;
+    sha1: string;
+    module: string;
+    execute_date?: number;
+}
+interface InvoiceProduct {
+    ref: string;
+    price: string;
+    quantity: string;
+    points: number;
+    provider: string | null;
+    line: string | null;
+}
+interface Invoice {
+    _id: string;
+    ref: string;
+    /** ISO date. */
+    date: string;
+    category: string | null;
+    total: number;
+    quantity: number;
+    discount: number;
+    points: number;
+    products: InvoiceProduct[];
+    promotions: Record<string, unknown>;
+    promotions_points: number;
+    refunds: Record<string, unknown>;
+    data: Record<string, unknown>;
+}
+/** A purchase (retail module). */
+interface PurchaseEntry extends BaseEntry {
+    _type: 'Retail::Buy';
+    invoice: Invoice;
+    module: string;
+    execute_date: number;
+}
+interface EntryFile {
+    _id: string;
+    name: string;
+    type: string;
+    mime_type: string;
+    size: number;
+    url: string;
+}
+interface BlogPostEntry extends BaseEntry {
+    _type: 'BlogPost';
+    title: string;
+    body: string;
+    format: string;
+    avatar: string;
+    permalink: string;
+    short_url: string | null;
+    push_redirect_url: string | null;
+    tags: string[];
+    participants_tags: string[];
+    files: EntryFile[];
+    votes_count: number;
+    module: string;
+    execute_date: number;
+}
+interface CommentEntry extends BaseEntry {
+    _type: 'Comment';
+    body: string;
+    push_redirect_url: string | null;
+    tags: string[];
+    participants_tags: string[];
+    votes_count: number;
+    module: string;
+    execute_date: number;
+}
+/** Admin who assigned extra points. */
+interface EntryAdmin {
+    _id: string;
+    name: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+    state: string;
+    language: string;
+    phone: string | null;
+    city: string | null;
+    country: string | null;
+    unconfirmed_email: string | null;
+    expired_password: boolean;
+    created_at: number;
+}
+interface ExtraPointsEntry extends BaseEntry {
+    _type: 'ExtraPoints';
+    concept: string;
+    assigned_by: EntryAdmin;
+    execute_date: number;
+}
+/** Entries that only add the module and execution date. */
+interface ModuleEntry<K extends 'Vote' | 'Signup' | 'VerifyEmail' | 'CompleteProfile' = 'Vote' | 'Signup' | 'VerifyEmail' | 'CompleteProfile'> extends BaseEntry {
+    _type: K;
+    module: string;
+    execute_date: number;
+}
+interface PreRegistrationEntry extends BaseEntry {
+    _type: 'PreRegistration';
+    execute_date: number;
+}
+/** Known entry types by `_type`. Campaigns can have others (see {@link UnknownEntry}). */
+interface EntryTypes {
+    External: ExternalEntry;
+    Redeem: RedeemEntry;
+    UploadPhoto: PhotoEntry;
+    UploadDocument: DocumentEntry;
+    'Retail::Buy': PurchaseEntry;
+    BlogPost: BlogPostEntry;
+    Comment: CommentEntry;
+    ExtraPoints: ExtraPointsEntry;
+    Vote: ModuleEntry<'Vote'>;
+    Signup: ModuleEntry<'Signup'>;
+    VerifyEmail: ModuleEntry<'VerifyEmail'>;
+    CompleteProfile: ModuleEntry<'CompleteProfile'>;
+    PreRegistration: PreRegistrationEntry;
+}
+type KnownEntryType = keyof EntryTypes;
+/** An entry of a type the library doesn't model yet: only the common fields are typed. */
+type UnknownEntry = BaseEntry & Record<string, unknown>;
+/** Any entry. Narrow it with {@link isEntryType}. */
+type Entry = EntryTypes[KnownEntryType] | UnknownEntry;
+/** Filters shared by every entries method. */
+interface EntriesParams {
+    category?: string;
+    /** External action slug(s). Only for `External` entries. */
+    atype?: string | string[];
+    date_filter?: DateFilter;
+    /** Another participant's entries (admins only); the logged participant's by default. */
+    participant_uid?: string;
+    /** Page to fetch (50 entries per page). */
+    index_page?: number;
+    /** Skips entries; disables pagination. */
+    skip?: number;
+    /** Max entries; disables pagination (and the pagination metadata). */
+    limit?: number;
+    /** Hides undone entries. @default true */
+    hide_undo?: boolean;
+}
+/** Filters for {@link EntriesService.list}: any `_type`, including the ones without a method of their own. */
+interface EntriesListParams extends EntriesParams {
+    _type?: string;
+}
+interface EntriesMetadata {
+    view: 'show';
+    /** Pagination fields are missing when `limit` or `skip` is sent. */
+    total?: number;
+    partial?: boolean;
+    page?: number;
+    page_size?: number;
+    total_pages?: number;
+}
+/** `GET /participant_entries` and `GET /entries/search` */
+interface EntriesResponse<E = Entry> {
+    data: E[];
+    metadata: EntriesMetadata;
+}
+interface CreateExternalOptions {
+    category?: string;
+    points_type?: string;
+}
+/** `POST /mod/external` */
+interface CreateExternalResponse {
+    state: string;
+    activity_state: string;
+    activity_points: number;
+    message: string;
+    execution_error: string;
+}
+
+/**
+ * Entries (activities) of the logged participant, or of another one with `participant_uid` (admins).
+ * Every method uses the detailed `show` view. Types without a method of their own are listed with `list({ _type })`.
+ */
+declare class EntriesService {
+    #private;
+    /** `T`: shape of `data` (the campaign's external action fields). */
+    listExternals<T = EntryData>(params?: EntriesParams): Observable<EntriesResponse<ExternalEntry<T>>>;
+    listRedemptions(params?: EntriesParams): Observable<EntriesResponse<RedeemEntry>>;
+    listPhotos(params?: EntriesParams): Observable<EntriesResponse<PhotoEntry>>;
+    listDocuments(params?: EntriesParams): Observable<EntriesResponse<DocumentEntry>>;
+    listPurchases(params?: EntriesParams): Observable<EntriesResponse<PurchaseEntry>>;
+    /** Every entry, or one `_type` (including the ones without a method of their own). Narrow each item with `isEntryType`. */
+    list(params?: EntriesListParams): Observable<EntriesResponse<Entry>>;
+    /** Entries of several participants at once (admins only, 100 per page). `uids` is required by the backend. */
+    search(uids: string[], params?: EntriesListParams): Observable<EntriesResponse<Entry>>;
+    /**
+     * Records an external action event.
+     * @param event An external action configured in the campaign (otherwise `code_error: 30`).
+     * @param properties Event data. Must not be empty (otherwise `code_error: 11`).
+     */
+    createExternal(event: string, properties: Record<string, unknown>, { category, points_type }?: CreateExternalOptions): Observable<CreateExternalResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EntriesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+/**
+ * Narrows an entry to its type.
+ *
+ * @example
+ * ```ts
+ * for (const entry of response.data) {
+ *   if (isEntryType(entry, 'Redeem')) console.log(entry.prize.name)
+ * }
+ * ```
+ */
+declare function isEntryType<K extends KnownEntryType>(entry: Entry, type: K): entry is EntryTypes[K];
+
+/** Filters for `GET /external_forms/actions/list`. */
+interface ExternalFormsListParams {
+    page?: number;
+    category?: string;
+    limit?: number;
+    /** @default true */
+    participant_match_rules?: boolean;
+}
+interface ExternalFormFilter {
+    _id: string;
+    field: string;
+    operator: string;
+    val: string;
+}
+interface ExternalForm {
+    _id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    category: string;
+    color: string;
+    enabled: boolean;
+    point_type: string | null;
+    point_type_id: string | null;
+    use_point_type: boolean | null;
+    formula: string;
+    filter: ExternalFormFilter[];
+    auto_acceptation: boolean;
+    moderation_update: boolean;
+    use_as_form: boolean;
+    use_prize_form: boolean;
+    use_retail_form: boolean;
+    use_signup_form: boolean;
+    fast_import: boolean;
+    codes_vault_loader: boolean;
+    create_from_panel: boolean;
+    campaign_limit: number;
+    daily_limit: number;
+    global_campaign_limit: number;
+    global_daily_limit: number;
+    icon_url: string | null;
+    tracking_action: boolean;
+    reevaluate_on_repeat: boolean;
+    sponsor: string | null;
+    sponsor_id: string | null;
+    pocket: string | null;
+    pocket_id: string | null;
+    form_id: string;
+    created_at: number;
+    updated_at: number;
+}
+interface ExternalFormsMetadata {
+    total: number;
+    partial?: boolean;
+    page: number;
+    page_size: number;
+    total_pages: number;
+}
+/** `GET /external_forms/actions/list` */
+interface ExternalFormsListResponse {
+    state: string;
+    data: ExternalForm[];
+    metadata: ExternalFormsMetadata;
+}
+interface ExternalFormFieldChoice {
+    label: string;
+    value: string;
+}
+/** A field of an external form, as described by `fields_info`. */
+interface ExternalFormField {
+    name: string;
+    label: string;
+    help_text: string | null;
+    placeholder: string | null;
+    default_value: string | null;
+    field_type: string;
+    type_value: string;
+    required_field: boolean;
+    unique_field: boolean;
+    choices?: ExternalFormFieldChoice[];
+}
+/** `GET /external_forms/actions/:id/fields_info` */
+interface ExternalFormFieldsResponse {
+    state: string;
+    object: {
+        id: string;
+        external_action: string;
+        total_fields: number;
+        fields: ExternalFormField[];
+    };
+}
+/** `POST /external_forms/actions/:id/fillup` and `PATCH /external_forms/:id` */
+interface ExternalFormSubmissionResponse {
+    state: string;
+    message: string;
+}
+/** Filters for `POST /external_forms/list` (submitted forms, i.e. `External` entries). */
+interface ExternalFormSubmissionsParams {
+    category?: string;
+    atype?: string[];
+    date_filter?: DateFilter;
+    /** Another participant's submissions (admins only). */
+    participant_uid?: string;
+    /** 30 submissions per page. */
+    page?: number;
+    skip?: number;
+    limit?: number;
+    /** @default true */
+    hide_undo?: boolean;
+}
+/** `POST /external_forms/list` */
+interface ExternalFormSubmissionsResponse<T = EntryData> {
+    data: ExternalEntry<T>[];
+    metadata: EntriesMetadata;
+}
+
+/** External forms (custom actions configured per campaign) and their submissions. */
+declare class ExternalFormsService {
+    #private;
+    listForms(params?: ExternalFormsListParams): Observable<ExternalFormsListResponse>;
+    getFormFields(id: string): Observable<ExternalFormFieldsResponse>;
+    submit(id: string, values: Record<string, unknown>, category?: string): Observable<ExternalFormSubmissionResponse>;
+    /** Submitted forms (`External` entries), paginated. It is a read, but the backend only accepts POST. `T`: shape of `data`. */
+    listSubmissions<T = EntryData>(params?: ExternalFormSubmissionsParams): Observable<ExternalFormSubmissionsResponse<T>>;
+    /** @param id The submission (entry) `_id`. */
+    getSubmission<T = EntryData>(id: string): Observable<ExternalEntry<T>>;
+    updateSubmission(id: string, values: Record<string, unknown>): Observable<ExternalFormSubmissionResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ExternalFormsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+/** Campaign-specific data configured on each goal (e.g. `{ badge: 'gold', coins: 10 }`). */
+type GoalData = Record<string, unknown>;
+interface GoalCondition {
+    metric_id: string;
+    metric_name: string;
+    operator: string;
+    value: number | null;
+    value_ref: string | null;
+    timeframe: string;
+}
+interface GoalFilter {
+    _id: string;
+    field: string;
+    operator: string;
+    val: string | number | boolean | unknown[];
+}
+/** Fields every goal has, both in the campaign catalog and in the participant's goals. */
+interface BaseGoal {
+    name: string;
+    desc: string;
+    tags: string[];
+    enabled: boolean;
+    deleted: boolean;
+    image: {
+        url: string | null;
+    };
+    /** ISO date, `null` when the goal has no start. */
+    starts_at: string | null;
+    /** ISO date, `null` when the goal has no end. */
+    ends_at: string | null;
+    ended_at: string | null;
+    evaluate_since: string | null;
+    period: string | null;
+    interval: string | null;
+    interval_samples: number;
+    recurrent: boolean;
+    requires_acceptance: boolean;
+    acceptances_count: number;
+    activity_target: string;
+    activity_times: number;
+    formula: string;
+    conditions: GoalCondition[];
+    conditions_failure: boolean;
+    limit: number;
+    global_limit: number;
+    global_awarded_count: number;
+    give_normal_points: boolean;
+    reward_type: string | null;
+    reward_name: string | null;
+    consolation_reward_id: string | null;
+    consolation_reward_type: string | null;
+    consolation_reward_amount: number;
+    always_award_consolation_reward: boolean;
+    sponsor_id: string | null;
+    sponsor_percentage: number;
+    pocket_id: string | null;
+    use_participant_metrics: boolean;
+    participant_metric_id: string | null;
+    participant_metric_timeframe: string | null;
+    participant_metric_value: number | null;
+    participant_metric_value_ref: string | null;
+    secondary_metric_extra_percentage: number;
+    secondary_participant_metric_id: string | null;
+    secondary_participant_metric_timeframe: string | null;
+    secondary_pocket_id: string | null;
+    secondary_reward_id: string | null;
+    secondary_reward_type: string | null;
+    secondary_sponsor_id: string | null;
+    secondary_sponsor_percentage: number;
+    campaign_id: string | null;
+    created_by_id: string | null;
+    created_by_type: string | null;
+    created_via_chat: boolean;
+    created_via_chat_message_id: string | null;
+    created_via_owner_id: string | null;
+    created_via_owner_type: string | null;
+    created_at: string;
+    updated_at: string;
+}
+/** A goal as configured in the campaign (`POST /goals/index`). */
+interface Goal<T = GoalData> extends BaseGoal {
+    /** Goal id. */
+    _id: string;
+    brand_id: string;
+    reward_id: string | null;
+    filter: GoalFilter[];
+    participant_filter: GoalFilter[];
+    /** Campaign-specific data. Not every catalog goal has it. */
+    goal_data?: T;
+    start_period?: string | null;
+    end_period?: string | null;
+    sponsor_name: string | null;
+    pocket_name: string | null;
+    consolation_reward_name: string | null;
+    participant_metric_name: string | null;
+    secondary_reward_name: string | null;
+    secondary_sponsor_name: string | null;
+    secondary_pocket_name: string | null;
+    secondary_participant_metric_name: string | null;
+}
+interface GoalConditionProgress {
+    metric_id: string;
+    metric_slug: string;
+    result: number;
+    ratio: number;
+    met: boolean;
+}
+/** A goal of the logged participant, with their progress (`GET /participants/goals`). */
+interface ParticipantGoal<T = GoalData> extends BaseGoal {
+    /** Id of the participant ↔ goal record, **not** the goal id. */
+    _id: string;
+    /** Goal id. Use this one for `accept` / `decline`. */
+    goal_id: string;
+    /** Campaign-specific data. */
+    goal_data: T;
+    participation_id: string;
+    /** Progress as a percentage, e.g. `'6%'`. */
+    status: string;
+    conditions_progress: GoalConditionProgress[];
+    /** Times the goal was won. */
+    winned: number;
+    winning_dates: string[];
+    /** Current period of a recurrent goal. Only sent by some campaigns. */
+    period_begins?: string;
+    period_ends?: string;
+}
+/** Filters for `GET /participants/goals`. 30 goals per page. */
+interface ParticipantGoalsParams {
+    page?: number;
+    tags?: string[];
+    skip?: number;
+    limit?: number;
+    /** Another participant's goals (same shape, with their progress); the logged participant's by default. Unknown uids fail with `code_error: 20`. */
+    participant_uid?: string;
+}
+/** `GET /participants/goals` */
+interface ParticipantGoalsResponse<T = GoalData> {
+    state: string;
+    data: ParticipantGoal<T>[];
+}
+/** Filters for `POST /goals/index`. */
+interface GoalsListParams {
+    page?: number;
+    limit?: number;
+    /** `false` lists only the disabled goals; enabled ones are listed by default. */
+    enabled?: boolean;
+    tags?: string[];
+    sponsor_id?: string;
+    trending?: boolean;
+    /** @default true */
+    include_ended?: boolean;
+}
+/** `POST /goals/index` */
+interface GoalsListResponse<T = GoalData> {
+    state: string;
+    data: {
+        page: number;
+        page_size: number;
+        total_pages: number;
+        total_data: number;
+        goals: Goal<T>[];
+    };
+}
+/** `POST /participants/goals/accept` and `/unaccept` */
+interface GoalAcceptanceResponse {
+    state: string;
+    message: string;
+}
+
+/** Campaign goals: the participant's goals with progress, the campaign catalog, and accepting goals. */
+declare class GoalsService {
+    #private;
+    /** Goals that apply to the logged participant (or `participant_uid`), with their progress. `T`: shape of `goal_data`. */
+    listParticipantGoals<T = GoalData>(params?: ParticipantGoalsParams): Observable<ParticipantGoalsResponse<T>>;
+    /** Every goal of the campaign (no progress), paginated. It is a read, but the backend only accepts POST. */
+    list<T = GoalData>(params?: GoalsListParams): Observable<GoalsListResponse<T>>;
+    /** @param goalId The goal id (`ParticipantGoal.goal_id`, not its `_id`). */
+    accept(goalId: string): Observable<GoalAcceptanceResponse>;
+    /** @param goalId The goal id (`ParticipantGoal.goal_id`, not its `_id`). */
+    decline(goalId: string): Observable<GoalAcceptanceResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GoalsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+interface MetricsParams {
+    page?: number;
+    q?: string;
+}
+interface MetricFilter {
+    _id: string;
+    field: string;
+    operator: string;
+    val: string;
+}
+interface Metric {
+    _id: string;
+    name: string;
+    slug: string;
+    description: string;
+    coll: string;
+    target_property: string;
+    analysis_type: string;
+    category: string | null;
+    filter: MetricFilter[];
+    use_goals: boolean;
+    goals_related_info: unknown[];
+}
+/** `GET /metrics/index` */
+interface MetricsListResponse {
+    state: string;
+    data: Metric[];
+}
+interface CalculateMetricParams {
+    slug: string;
+    timeframe: string;
+    uid?: string;
+}
+/** `GET /metrics/exec` */
+interface CalculateMetricResponse {
+    state: string;
+    result: number;
+}
+
+/** Campaign metrics (custom aggregations configured per campaign). */
+declare class MetricsService {
+    #private;
+    list(params?: MetricsParams): Observable<MetricsListResponse>;
+    calculate(params: CalculateMetricParams): Observable<CalculateMetricResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MetricsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+/** Logged participant, participant lists and push notification subscriptions. */
+declare class ParticipantService {
+    #private;
+    /** Logged participant and site config. `T`: your participant interface (`extends BaseCurrentParticipant`). */
+    getCurrent<T = BaseCurrentParticipant>(): Observable<CurrentParticipantResponse<T>>;
+    /** Points, level and position of the logged participant. `T`: shape of `data.data` (`extends BaseParticipantRankData`). */
+    getRank<T = BaseParticipantRankData>(): Observable<ParticipantRankResponse<T>>;
+    /** `T`: your participant interface (`extends BaseParticipant`). */
+    list<T = BaseParticipant>(params?: ParticipantListParams): Observable<ParticipantListResponse<T>>;
+    /** `T`: your participant interface (`extends BaseParticipant`). */
+    getByUid<T = BaseParticipant>(uid: string): Observable<ParticipantResponse<T>>;
+    /** Sends the browser subscription as the request body, unwrapped. */
+    savePushSubscription(subscription: PushSubscriptionPayload): Observable<SavePushSubscriptionResponse>;
+    removePushSubscriptions(): Observable<RemovePushSubscriptionsResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ParticipantService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+type NotificationChannel = 'email' | 'cellphone';
+interface ChangePasswordParams {
+    current_password: string;
+    password: string;
+    password_confirmation: string;
+}
+/** `PUT /password/change` */
+interface ChangePasswordResponse {
+    state: string;
+    message: string;
+}
+/** `POST /password/validate_channel` */
+interface ValidateChannelResponse {
+    state: string;
+    message: string;
+}
+interface SendResetTokenParams {
+    channel: NotificationChannel;
+    /** Value of the channel keyed by the field name the backend expects, e.g. `{ email: 'ana@mail.com' }`. */
+    data: Record<string, string>;
+    edit_password_url: string;
+    uid?: string;
+}
+/** `POST /password` */
+interface SendResetTokenResponse {
+    state: string;
+    message: string;
+}
+interface ResetPasswordParams {
+    password: string;
+    password_confirmation: string;
+    token: string;
+    channel: NotificationChannel;
+}
+/** `POST /password/update` */
+interface ResetPasswordResponse {
+    state: string;
+    message: string;
+}
+
+/** Change password (logged participant) and the password recovery flow. */
+declare class PasswordService {
+    #private;
+    changePassword(params: ChangePasswordParams): Observable<ChangePasswordResponse>;
+    /** Checks that a participant exists for the given channel value (e.g. an email or a phone number). */
+    validateChannel(channel: NotificationChannel, value: string): Observable<ValidateChannelResponse>;
+    sendResetToken({ channel, data, edit_password_url, uid }: SendResetTokenParams): Observable<SendResetTokenResponse>;
+    resetPassword({ password, password_confirmation, token, channel }: ResetPasswordParams): Observable<ResetPasswordResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PasswordService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+/** Prizes and redemptions. */
+declare class PrizesService {
+    #private;
+    list(params?: PrizesParams): Observable<PrizesListResponse>;
+    checkRedeem(id: string): Observable<CheckRedeemResponse>;
+    redeem(id: string, opts?: Record<string, unknown>): Observable<RedeemedPrize>;
+    getWishlist(page?: number): Observable<WishlistResponse>;
+    toggleWishlist(id: string): Observable<ToggleWishlistResponse>;
+    getExternalCouponData(id: string, key: string, city?: string): Observable<ExternalCouponDataResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PrizesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+interface SegmentRankingParams {
+    activity_type?: string;
+    point_type?: string;
+    page?: number;
+    per_page?: number;
+}
+/** One segment of `GET /participants/ranks/segment`. */
+interface SegmentRanking {
+    /** Segment values (e.g. `['norte']`). */
+    segment: string[];
+    participants: number;
+    ranking: number;
+    ranking_points: number;
+    latest_created_at: string;
+    oldest_last_points_received_at: string;
+    last_activity_at: string | null;
+}
+/** `GET /participants/ranks/segment` */
+interface SegmentRankingResponse {
+    state: string;
+    data: SegmentRanking[];
+}
+interface AdvancedRankingParams {
+    categories?: string[];
+    exact_categories?: boolean;
+    sector?: string;
+    sector_b?: string;
+    sector_c?: string;
+    activity_type?: string;
+    point_type?: string;
+    starting_points?: number;
+    limit_points?: number;
+    ranking_size?: number;
+    page?: number;
+    per_page?: number;
+    include_logged_participant?: boolean;
+}
+interface AdvancedRanking<T = Record<string, unknown>> {
+    name: string;
+    first_name: string;
+    last_name: string;
+    votes: number;
+    points: number;
+    ranking_points: number;
+    level: number;
+    ranking: number;
+    points_by_ptype: Record<string, number>;
+    colour: string | null;
+    /** Participant data (fields depend on the query). */
+    data: T;
+}
+/** `GET /participants/ranks/advanced` */
+interface AdvancedRankingResponse<T = Record<string, unknown>> {
+    state: string;
+    data: AdvancedRanking<T>[];
+}
+
+/** Segment and advanced participant rankings. */
+declare class RankingService {
+    #private;
+    getSegment(params?: SegmentRankingParams): Observable<SegmentRankingResponse>;
+    getAdvanced<T = Record<string, unknown>>(params?: AdvancedRankingParams): Observable<AdvancedRankingResponse<T>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RankingService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+/**
+ * `POST /mod/referrals`. Validation errors (e.g. the code must have 10 letters/numbers) come back with
+ * HTTP 200 and `state: 'error'`; they are thrown as an `ApiError` like any other error.
+ */
+interface ChangeReferralCodeResponse {
+    state: string;
+    /** The new code. */
+    code: string;
+}
+
+/** The participant's referral code. */
+declare class ReferralsService {
+    #private;
+    changeCode(code: string): Observable<ChangeReferralCodeResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ReferralsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+/** `GET /registrations/signupform` */
+interface SignupFormResponse {
+    _id: string;
+    fields: Field[];
+}
+/** Values keyed by the signup form field names. */
+type SignupData = Record<string, unknown>;
+/** `POST /registrations/fillup` */
+interface SignupResponse {
+    state: string;
+    message: string;
+    code_error?: number;
+    errors?: Record<string, string>;
+}
+/** `POST /registrations/update` */
+interface UpdateParticipantResponse {
+    state?: string;
+    success?: boolean;
+    message?: string;
+    code_error?: number;
+    errors?: Record<string, string>;
+}
+/** `POST /registrations/reset_email_verify_token` */
+interface SendEmailVerificationTokenResponse {
+    state: string;
+    message: string;
+}
+/** `POST /registrations/validate_email_token` */
+interface ValidateEmailTokenResponse {
+    state: string;
+    valid: boolean;
+}
+/** `POST /registrations/confirm_email` */
+interface ConfirmEmailResponse {
+    state: string;
+    message: string;
+}
+
+/** Signup and email verification. */
+declare class RegistrationsService {
+    #private;
+    getSignupForm(): Observable<SignupFormResponse>;
+    signup(data: SignupData): Observable<SignupResponse>;
+    updateParticipant(data: SignupData): Observable<UpdateParticipantResponse>;
+    /** Sends (or resends) the email verification token to the given address. */
+    sendEmailVerificationToken(email: string): Observable<SendEmailVerificationTokenResponse>;
+    validateEmailToken(token: string): Observable<ValidateEmailTokenResponse>;
+    confirmEmail(token: string): Observable<ConfirmEmailResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RegistrationsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+/** `GET /sessions/loginform` */
+interface LoginFormResponse {
+    fields: Field[];
+}
+/** Credentials keyed by the login form field names, e.g. `{ email: 'ana@mail.com', password: '…' }`. */
+type LoginCredentials = Record<string, string>;
+/** `POST /sessions/login` */
+interface LoginResponse {
+    state: string;
+    message: string;
+    code_error?: number;
+}
+/** `GET /sessions/logout` */
+interface LogoutResponse {
+    state: string;
+    message: string;
+    code_error?: number;
+}
+/** `GET /auth/sso_login` */
+interface SsoLoginResponse {
+    state: string;
+    data: {
+        azure_login_url: string;
+    };
+    message?: string;
+    code_error?: number;
+}
+/** `GET /participant_login_requirements` */
+interface LoginRequirementsResponse {
+    state: string;
+    allowed: boolean;
+    redirect_page: string;
+    message: string;
+}
+
+/** Participant session: login form, login/logout, SSO and login requirements. */
+declare class SessionService {
+    #private;
+    /** Fields the microsite asks for on login (the login identifier varies: email, code, document…). */
+    getLoginForm(): Observable<LoginFormResponse>;
+    login(credentials: LoginCredentials): Observable<LoginResponse>;
+    logout(): Observable<LogoutResponse>;
+    /** URL to redirect the participant to the SSO provider. */
+    getSsoLoginUrl(provider: string): Observable<SsoLoginResponse>;
+    /** Whether the logged participant can use the site or must complete something first (`redirect_page`). */
+    checkLoginRequirements(): Observable<LoginRequirementsResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SessionService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+interface TeamsParams {
+    page?: number;
+    q?: string;
+}
+interface ParticipantFilter {
+    _id?: string;
+    field: string;
+    operator: string;
+    val: string;
+}
+interface Team {
+    _id: string;
+    name: string;
+    desc: string;
+    slug: string;
+    color: string;
+    open: boolean;
+    admin_id: string | null;
+    participant_filter: ParticipantFilter[];
+    teams_module_id: string;
+    total_points: number;
+    total_coins: Coin[];
+    image_url: string | null;
+    created_at: number;
+    updated_at: number;
+}
+/** `GET /mod/teams` */
+interface TeamsListResponse {
+    state: string;
+    data: Team[];
+}
+/** `GET /mod/teams/:id/show` */
+interface TeamResponse {
+    state: string;
+    data: Team;
+}
+interface CreateTeamParams {
+    name: string;
+    desc: string;
+    open: boolean;
+    participant_filter: ParticipantFilter[];
+}
+/** `POST /mod/teams` */
+interface CreateTeamResponse {
+    state: string;
+    message?: string;
+    data: Team;
+}
+/** `POST /mod/teams/:id/remove_member` */
+interface RemoveMemberResponse {
+    state: string;
+    message: string;
+}
+
+/** Teams. */
+declare class TeamsService {
+    #private;
+    list(params?: TeamsParams): Observable<TeamsListResponse>;
+    get(id: string): Observable<TeamResponse>;
+    create(params: CreateTeamParams): Observable<CreateTeamResponse>;
+    /** Removes the logged participant, or `uid` when given, from the team. */
+    removeMember(id: string, uid?: string): Observable<RemoveMemberResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TeamsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+type VoteCategory = 'like' | 'support' | 'interest' | 'curiosity';
+/** `GET /mod/votes/:targetId` — vote counts by category and the logged participant's vote. */
+interface VotesResponse {
+    state: string;
+    data: {
+        likes: number;
+        supports: number;
+        interests: number;
+        curiosities: number;
+        current_participant_voted_category: VoteCategory | null;
+    };
+}
+interface CreateVoteParams {
+    category?: VoteCategory;
+    toggle?: boolean;
+}
+interface UpdateVoteParams {
+    category?: VoteCategory;
+}
+/** `POST` / `PATCH` / `DELETE` `/mod/votes/:targetId` */
+interface VoteResponse {
+    state: string;
+    message?: string;
+}
+
+/** Votes on an activity (target): like, support, interest, curiosity. */
+declare class VotesService {
+    #private;
+    get(targetId: string): Observable<VotesResponse>;
+    create(targetId: string, params?: CreateVoteParams): Observable<VoteResponse>;
+    update(targetId: string, params?: UpdateVoteParams): Observable<VoteResponse>;
+    delete(targetId: string): Observable<VoteResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<VotesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+
+export { AchievementsService, ActivitiesService, ApiError, BadgesService, BlogsService, BoardsService, CommentsService, EntriesService, ExternalFormsService, GoalsService, MetricsService, ParticipantService, PasswordService, PrizesService, RankingService, ReferralsService, RegistrationsService, SessionService, TeamsService, VotesService, isApiError, isEntryType, provideMicrositesApi };
+export type { AchievementType, AchievementsListResponse, AchievementsMetadata, AchievementsParams, ActivityParticipant, AdvancedRanking, AdvancedRankingParams, AdvancedRankingResponse, Badge, BadgeAchievement, BadgeConditions, BadgeResponse, BadgesListResponse, BadgesParams, BaseAchievement, BaseCurrentParticipant, BaseEntry, BaseGoal, BaseParticipant, BaseParticipantRankData, BlogPost, BlogPostEntry, BlogPostResponse, BlogPostsParams, BlogPostsResponse, BlogsMetadata, Board, BoardReportsResponse, BoardsFilter, BoardsListResponse, BoardsMetadata, BoardsParams, CalculateMetricParams, CalculateMetricResponse, Campaign, ChangePasswordParams, ChangePasswordResponse, ChangeReferralCodeResponse, CheckRedeemResponse, Coin, Comment, CommentEntry, CommentsListResponse, CommentsMetadata, CommentsParams, ConfirmEmailResponse, CreateBlogPostParams, CreateBlogPostResponse, CreateCommentParams, CreateCommentResponse, CreateExternalOptions, CreateExternalResponse, CreateTeamParams, CreateTeamResponse, CreateVoteParams, CreatedBlogPost, CreatedComment, CurrentParticipantResponse, DateFilter, DocumentEntry, EntriesListParams, EntriesMetadata, EntriesParams, EntriesResponse, Entry, EntryAdmin, EntryData, EntryFile, EntryPrize, EntryTypes, ExecuteReportParams, ExecuteReportResponse, ExternalCouponData, ExternalCouponDataResponse, ExternalEntry, ExternalForm, ExternalFormField, ExternalFormFieldChoice, ExternalFormFieldsResponse, ExternalFormFilter, ExternalFormSubmissionResponse, ExternalFormSubmissionsParams, ExternalFormSubmissionsResponse, ExternalFormsListParams, ExternalFormsListResponse, ExternalFormsMetadata, ExtraPointsEntry, Field, FieldChoice, FieldType, Goal, GoalAcceptanceResponse, GoalAchievement, GoalCondition, GoalConditionProgress, GoalData, GoalFilter, GoalsListParams, GoalsListResponse, Invoice, InvoiceProduct, KnownEntryType, LoginCredentials, LoginFormResponse, LoginRequirementsResponse, LoginResponse, LogoutResponse, Metric, MetricFilter, MetricsListResponse, MetricsParams, MicrositesApiConfig, ModuleEntry, NotificationChannel, ParticipantBadge, ParticipantBadgesResponse, ParticipantFilter, ParticipantGoal, ParticipantGoalsParams, ParticipantGoalsResponse, ParticipantListParams, ParticipantListResponse, ParticipantRank, ParticipantRankResponse, ParticipantResponse, PhotoEntry, PreRegistrationEntry, Prize, PrizeDetails, PrizeMetadata, PrizeType, PrizesListResponse, PrizesMetadata, PrizesParams, PurchaseEntry, PushSubscriptionPayload, RedeemEntry, RedeemedPrize, Redemption, RemoveMemberResponse, RemovePushSubscriptionsResponse, Report, ResetPasswordParams, ResetPasswordResponse, SavePushSubscriptionResponse, SegmentRanking, SegmentRankingParams, SegmentRankingResponse, SendEmailVerificationTokenResponse, SendResetTokenParams, SendResetTokenResponse, SignupData, SignupFormResponse, SignupResponse, SsoLoginResponse, Team, TeamResponse, TeamsListResponse, TeamsParams, ToggleWishlistResponse, UnknownEntry, UpdateParticipantResponse, UpdateVoteParams, UploadDocumentParams, UploadDocumentResponse, UploadPhotoParams, UploadPhotoResponse, ValidateChannelResponse, ValidateEmailTokenResponse, VoteCategory, VoteResponse, VotesResponse, WishlistResponse };