@esolve/ng-esolve-connect 0.72.0 → 0.73.0

package/index.d.ts

@@ -31,3 +31,4 @@ export * from './lib/transactions';
 export * from './lib/device';
 export * from './lib/wallet';
 export * from './lib/deliveries';
+export * from './lib/competitions';

package/lib/competitions/classes/esolve-competition-dates.model.d.ts

@@ -0,0 +1,19 @@
+export declare class EsolveCompetitionDates {
+    /**
+     * Competition start date
+     */
+    start: Date;
+    /**
+     * Competition end date
+     */
+    end: Date;
+    constructor(
+    /**
+     * Competition start date
+     */
+    start: Date, 
+    /**
+     * Competition end date
+     */
+    end: Date);
+}

package/lib/competitions/classes/esolve-competition-entry-result.model.d.ts

@@ -0,0 +1,6 @@
+import { EsolveResponseResult } from '../../shared/response';
+import { EsolveCompetitionEntryResponse } from '../types';
+export declare class EsolveCompetitionEntryResult extends EsolveResponseResult {
+    id: number;
+    constructor(response: EsolveCompetitionEntryResponse);
+}

package/lib/competitions/classes/esolve-competition-winner.model.d.ts

@@ -0,0 +1,16 @@
+import { EsolveCompetitionWinnerRecord } from '../interfaces';
+export declare class EsolveCompetitionWinner {
+    /**
+     * eSolve Generated ID
+     */
+    esolve_id: number;
+    /**
+     * Competition winner's first name
+     */
+    first_name: string;
+    /**
+     * Competition winner's surname
+     */
+    surname: string;
+    constructor(record?: Partial<EsolveCompetitionWinnerRecord>);
+}

package/lib/competitions/classes/esolve-competition.model.d.ts

@@ -0,0 +1,66 @@
+import { EsolveCompetitionRecord } from '../interfaces';
+import { EsolveCompetitionDates } from './esolve-competition-dates.model';
+import { EsolveCompetitionWinner } from './esolve-competition-winner.model';
+export declare class EsolveCompetition {
+    /**
+     * eSolve Generated ID
+     */
+    id: number;
+    /**
+     * Identifier linking competition to a media article
+     */
+    identifier: string;
+    /**
+     * Identifier linking an active competition to a media article
+     */
+    active_identifier: string;
+    /**
+     * Identifier linking an expired competition to a media article
+     */
+    expired_identifier: string;
+    /**
+     * Identifier linking a finished competition to a media article
+     */
+    completed_identifier: string;
+    /**
+     * Competition run interval
+     */
+    dates: EsolveCompetitionDates;
+    /**
+     * Competition Description
+     */
+    description: string;
+    /**
+     * Caption used by the submit button of the competition form
+     */
+    button_caption: string;
+    /**
+     * Competition's terms and conditions article
+     */
+    terms_and_conditions: string;
+    /**
+     * Competition featured image url
+     */
+    image_url: string;
+    /**
+     * Requires audio submission
+     */
+    require_audio: boolean;
+    /**
+     * Requires video submission
+     */
+    require_video: boolean;
+    /**
+     * Requires image submission
+     */
+    require_image: boolean;
+    /**
+     * Competition requires text submission
+     */
+    require_text: boolean;
+    /**
+     * List of competition winners
+     */
+    winners: EsolveCompetitionWinner[];
+    constructor(record?: Partial<EsolveCompetitionRecord>);
+}

package/lib/competitions/classes/index.d.ts

@@ -0,0 +1,4 @@
+export * from './esolve-competition-dates.model';
+export * from './esolve-competition-entry-result.model';
+export * from './esolve-competition-winner.model';
+export * from './esolve-competition.model';

package/lib/competitions/index.d.ts

@@ -0,0 +1,3 @@
+export * from './classes';
+export * from './interfaces';
+export * from './services';

package/lib/competitions/interfaces/esolve-competition-options.interface.d.ts

@@ -0,0 +1,4 @@
+export interface EsolveCompetitionOptions {
+    competition_id?: number;
+    identifier?: string;
+}

package/lib/competitions/interfaces/esolve-competition-record.interface.d.ts

@@ -0,0 +1,25 @@
+import { EsolveCompetitionWinnerRecord } from './esolve-competition-winner-record.interface';
+export interface EsolveCompetitionRecord {
+    id: number;
+    identifier: string;
+    active_identifier: string;
+    expired_identifier: string;
+    completed_identifier: string;
+    from_date: string;
+    from_date_timestamp: number;
+    to_date: string;
+    to_date_timestamp: number;
+    description: string;
+    button_caption: string;
+    terms_and_conditions: string;
+    coupon_percentage: string;
+    coupon_valid_from_date: string;
+    coupon_valid_to_date: string;
+    image_url: string;
+    image_checksum: string;
+    audio_attachment: boolean;
+    video_attachment: boolean;
+    image_attachment: boolean;
+    text: boolean;
+    winners: EsolveCompetitionWinnerRecord[];
+}

package/lib/competitions/interfaces/esolve-competition-winner-record.interface.d.ts

@@ -0,0 +1,5 @@
+export interface EsolveCompetitionWinnerRecord {
+    userid: number;
+    firstname: string;
+    surname: string;
+}

package/lib/competitions/interfaces/index.d.ts

@@ -0,0 +1,3 @@
+export * from './esolve-competition-options.interface';
+export * from './esolve-competition-record.interface';
+export * from './esolve-competition-winner-record.interface';

package/lib/competitions/services/esolve-competitions.service.d.ts

@@ -0,0 +1,50 @@
+import { Observable } from 'rxjs';
+import { EsolveCompetitionOptions } from '../interfaces';
+import { EsolveCompetition, EsolveCompetitionEntryResult } from '../classes';
+import * as i0 from "@angular/core";
+export declare class EsolveCompetitionsService {
+    private readonly http;
+    private readonly config;
+    private readonly errorHandler;
+    private readonly responseHandler;
+    /**
+     * Retrieve a competition based on its ID.
+     *
+     * @param competition_id - number that represents the unique
+     * id of a competition.
+     *
+     * @returns an Observable of type EsolveCompetition
+     */
+    getCompetition(competition_id: number): Observable<EsolveCompetition>;
+    /**
+     * Retrieves a competition based on its identifier.
+     *
+     * @param identifier - string that represents the identifier of the competition.
+     *
+     * @returns an Observable of type EsolveCompetition.
+     */
+    getCompetitionFromIdentifier(identifier: string): Observable<EsolveCompetition>;
+    /**
+     * Retrieve a list of competitions based on the provided options
+     *
+     * @param options - Optional options for filtering competitions
+     *
+     * @returns an Observable of type EsolveCompetition[].
+     */
+    getCompetitions(options?: EsolveCompetitionOptions): Observable<EsolveCompetition[]>;
+    /**
+     * Submit a competition entry
+     *
+     * @param competitions_id - eSolve id of competition.
+     *
+     * @param form_data - competition entry data
+     *
+     * @returns an Observable of type EsolveCompetitionEntryResult
+     */
+    setCompetitionEntry(competitions_id: number, form_data: FormData): Observable<EsolveCompetitionEntryResult>;
+    private getCompetitionSingle;
+    private getCompetitionRecords;
+    private processCompetition;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EsolveCompetitionsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EsolveCompetitionsService>;
+}

package/lib/competitions/services/index.d.ts

@@ -0,0 +1 @@
+export * from './esolve-competitions.service';

package/lib/competitions/types/esolve-competition-entry-response.type.d.ts

@@ -0,0 +1,2 @@
+import { EsolvePostResponseItem } from '../../shared/response';
+export type EsolveCompetitionEntryResponse = EsolvePostResponseItem;

package/lib/competitions/types/index.d.ts

@@ -0,0 +1 @@
+export * from './esolve-competition-entry-response.type';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esolve/ng-esolve-connect",
-  "version": "0.72.0",
+  "version": "0.73.0",
   "homepage": "https://www.esolve.co.za/",
   "description": "An Angular library that speaks to an eSolve instance's API",
   "peerDependencies": {