@esolve/ng-esolve-connect 0.72.0 → 0.73.1

package/fesm2022/esolve-ng-esolve-connect.mjs

@@ -7504,6 +7504,7 @@ class EsolveWalletTransaction {
         this.description = record.description ?? '';
         this.cart_id = record.cart_id ?? 0;
         this.amount = record.amount ?? 0;
+        this.reliable = !!+(record.reliable ?? false);
         if (record.type &&
             (record.type === 'credit' || record.type === 'debit')) {
             this.type = record.type;
@@ -7571,6 +7572,9 @@ class EsolveWalletService {
             if (options.rows) {
                 params = params.set('rows', options.rows);
             }
+            if (options.transaction_id) {
+                params = params.set('transaction_id', options.transaction_id);
+            }
             if (options.from_date) {
                 params = params.set('from_date', options.from_date);
             }
@@ -7790,6 +7794,263 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImpor
                 }]
         }] });
 
+class EsolveCompetitionDates {
+    constructor(
+    /**
+     * Competition start date
+     */
+    start, 
+    /**
+     * Competition end date
+     */
+    end) {
+        this.start = start;
+        this.end = end;
+    }
+}
+
+class EsolveCompetitionEntryResult extends EsolveResponseResult {
+    constructor(response) {
+        super(response);
+        this.id = 0;
+        this.id = +response.esolve_id;
+    }
+}
+
+class EsolveCompetitionWinner {
+    constructor(record) {
+        /**
+         * eSolve Generated ID
+         */
+        this.esolve_id = 0;
+        /**
+         * Competition winner's first name
+         */
+        this.first_name = '';
+        /**
+         * Competition winner's surname
+         */
+        this.surname = '';
+        if (record) {
+            this.esolve_id = +(record.userid ?? 0);
+            this.first_name = record.firstname ?? '';
+            this.surname = record.surname ?? '';
+        }
+    }
+}
+
+class EsolveCompetition {
+    constructor(record) {
+        /**
+         * eSolve Generated ID
+         */
+        this.id = 0;
+        /**
+         * Identifier linking competition to a media article
+         */
+        this.identifier = '';
+        /**
+         * Identifier linking an active competition to a media article
+         */
+        this.active_identifier = '';
+        /**
+         * Identifier linking an expired competition to a media article
+         */
+        this.expired_identifier = '';
+        /**
+         * Identifier linking a finished competition to a media article
+         */
+        this.completed_identifier = '';
+        /**
+         * Competition run interval
+         */
+        this.dates = new EsolveCompetitionDates(new Date(0), new Date(0));
+        /**
+         * Competition Description
+         */
+        this.description = '';
+        /**
+         * Caption used by the submit button of the competition form
+         */
+        this.button_caption = '';
+        /**
+         * Competition's terms and conditions article
+         */
+        this.terms_and_conditions = '';
+        /**
+         * Competition featured image url
+         */
+        this.image_url = '';
+        /**
+         * Requires audio submission
+         */
+        this.require_audio = false;
+        /**
+         * Requires video submission
+         */
+        this.require_video = false;
+        /**
+         * Requires image submission
+         */
+        this.require_image = false;
+        /**
+         * Competition requires text submission
+         */
+        this.require_text = false;
+        /**
+         * List of competition winners
+         */
+        this.winners = [];
+        if (record) {
+            this.id = +(record.id ?? 0);
+            this.identifier = record.identifier ?? '';
+            this.active_identifier = record.active_identifier ?? '';
+            this.expired_identifier = record.expired_identifier ?? '';
+            this.completed_identifier = record.completed_identifier ?? '';
+            const start_date_timestamp = (record.from_date_timestamp ?? 0) * 1000;
+            const end_date_timestamp = (record.to_date_timestamp ?? 0) * 1000;
+            const start_date = new Date(start_date_timestamp);
+            const end_date = new Date(end_date_timestamp);
+            this.dates = new EsolveCompetitionDates(start_date, end_date);
+            this.description = record.description ?? '';
+            this.button_caption = record.button_caption ?? '';
+            this.terms_and_conditions = record.terms_and_conditions ?? '';
+            this.image_url = record.image_url ?? '';
+            if (this.image_url !== '' && record.image_checksum) {
+                this.image_url =
+                    this.image_url + '?cs=' + record.image_checksum;
+            }
+            this.require_audio = !!+(record.audio_attachment ?? false);
+            this.require_video = !!+(record.video_attachment ?? false);
+            this.require_image = !!+(record.image_attachment ?? false);
+            this.require_text = !!+(record.text ?? false);
+            const winners = record.winners;
+            if (winners && winners.length > 0) {
+                for (const winner of winners) {
+                    this.winners.push(new EsolveCompetitionWinner(winner));
+                }
+            }
+        }
+    }
+}
+
+class EsolveCompetitionsService {
+    constructor() {
+        this.http = inject(HttpClient);
+        this.config = inject(EsolveConfigService);
+        this.errorHandler = inject(EsolveErrorHandlerService);
+        this.responseHandler = inject(EsolveResponseHandlerService);
+    }
+    /**
+     * 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) {
+        const params = new HttpParams({
+            fromObject: { competition_id },
+        });
+        return this.getCompetitionSingle(params);
+    }
+    /**
+     * 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) {
+        const params = new HttpParams({
+            fromObject: { identifier },
+        });
+        return this.getCompetitionSingle(params);
+    }
+    /**
+     * 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) {
+        let params = new HttpParams();
+        if (options?.competition_id) {
+            params = params.set('competition_id', options.competition_id);
+        }
+        if (options?.identifier) {
+            params = params.set('identifier', options.identifier);
+        }
+        return this.getCompetitionRecords(params).pipe(map((records) => {
+            const competitions = [];
+            for (const record of records) {
+                competitions.push(this.processCompetition(record));
+            }
+            return competitions;
+        }), catchError$1(() => {
+            return of([]);
+        }));
+    }
+    /**
+     * 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, form_data) {
+        if (!form_data.has('email')) {
+            return this.errorHandler.emitError('email_required', 'Email is required');
+        }
+        const params = new HttpParams({
+            fromObject: { competitions_id },
+        });
+        return this.http
+            .post(`${this.config.api_url}/set-competition-entry.php`, form_data, {
+            responseType: 'json',
+            observe: 'body',
+            params,
+        })
+            .pipe(map((http_response) => this.responseHandler.validateSingleHttpResponse(http_response, (response) => new EsolveCompetitionEntryResult(response))), catchError$1((errorRes) => {
+            return this.errorHandler.handleHttpPostError('set-competition-entry', errorRes);
+        }));
+    }
+    getCompetitionSingle(params) {
+        return this.getCompetitionRecords(params).pipe(map((records) => {
+            const record = records[0];
+            return this.processCompetition(record);
+        }));
+    }
+    getCompetitionRecords(params) {
+        return this.http
+            .get(`${this.config.api_url}/get-competitions.php`, { params })
+            .pipe(map((response) => {
+            if (response.records === undefined ||
+                response.records.length <= 0) {
+                throw response;
+            }
+            return response.records;
+        }));
+    }
+    processCompetition(record) {
+        return new EsolveCompetition(record);
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: EsolveCompetitionsService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: EsolveCompetitionsService, providedIn: 'root' }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: EsolveCompetitionsService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root',
+                }]
+        }] });
+
+// Classes
+
 /*
  * Public API Surface of ng-esolve-connect
  */
@@ -7798,5 +8059,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { ESOLVE_CONNECT_CONFIG, ESOLVE_EURUS_AUTO_LOGIN, EsolveAccountConfirmationResult, EsolveAccountService, EsolveAdditionalStockImage, EsolveAddress, EsolveAddressResult, EsolveAsset, EsolveAssetsService, EsolveAuthInterceptorService, EsolveAuthService, EsolveBankingDetails, EsolveBanner, EsolveBannerImage, EsolveBannerImageHotspot, EsolveBannerService, EsolveCartAlternative, EsolveCartItem, EsolveCartService, EsolveCartStockItem, EsolveCartTotals, EsolveCategoryTreeItem, EsolveCategoryTreeService, EsolveCdnSrcDirective, EsolveChangePasswordResult, EsolveCheckoutResult, EsolveColour, EsolveConfigService, EsolveCookieService, EsolveCoupon, EsolveCouponsService, EsolveDeliveriesService, EsolveDelivery, EsolveDeliveryCategoryTotals, EsolveDeliveryStatus, EsolveDependantItem, EsolveDeviceService, EsolveEmptyCartResult, EsolveEmptyWishlistResult, EsolveEnquiryResult, EsolveEnquiryService, EsolveErrorHandlerService, esolveFilterFactory as EsolveFilterFactory, EsolveGenericFilter, EsolveGeocodeAddressResult, EsolveGeocodeCoordsResult, EsolveGeocodeResult, EsolveGeocoderService, EsolveHttpError, EsolveLinkedAsset, EsolveLinkedStockItem, EsolveList, EsolveLocation, EsolveLocationAddress, EsolveLocationContactInfo, EsolveLocationGEO, EsolveLocationList, EsolveLocationPOBoxAddress, EsolveLocationTradingDay, EsolveLocationTradingTimes, EsolveLocationUpdateResult, EsolveLocationsService, EsolveManufacturer, EsolveManufacturersService, EsolveMediaStockItem, EsolveMenuItem, EsolveMenuService, EsolveMultipleSelectFilter, EsolveNewsArticle, EsolveNewsArticleAuthor, EsolveNewsArticleList, EsolveNewsGroup, EsolveNewsService, EsolveNewsletterResult, EsolveOtp, EsolveOtpService, EsolveOtpValidation, EsolvePaymentMethod, EsolvePaymentResult, EsolvePaymentService, EsolveRange, EsolveRangeFilter, EsolveRangesService, EsolveRecipeStockItem, EsolveRegistrationResult, EsolveResetPasswordResult, EsolveResponseHandlerService, EsolveResponseResult, EsolveResult, EsolveSeoInfo, EsolveSeoService, EsolveSessionAddressUpdateResult, EsolveSessionMetadataService, EsolveSessionService, EsolveSessionShippingUpdateResult, EsolveSetDeviceResult, EsolveSetNotifyResult, EsolveShippingCost, EsolveShippingMethod, EsolveShippingService, EsolveShippingTotals, EsolveSingleSelectFilter, EsolveSpecial, EsolveSpecialDates, EsolveSpecialImage, EsolveSpecialImageCollection, EsolveSpecialsService, EsolveStatement, EsolveStatementAgeing, EsolveStatementBalances, EsolveStatementTransaction, EsolveStockBadge, EsolveStockGroup, EsolveStockGroupItem, EsolveStockImage, EsolveStockImageCollection, EsolveStockItem, EsolveStockItemBase, EsolveStockItemList, EsolveStockLeadTimes, EsolveStockPrice, EsolveStockService, EsolveSupplier, EsolveSuppliersService, EsolveTag, EsolveTagsService, EsolveTimeSlot, EsolveTimeSlotConfig, EsolveTimeSlotDate, EsolveTimeSlotDays, EsolveTimeSlotTimes, EsolveToggleFilter, EsolveTopic, EsolveTopicService, EsolveTransaction, EsolveTransactionAddress, EsolveTransactionAnalyticsData, EsolveTransactionClient, EsolveTransactionDelivery, EsolveTransactionItem, EsolveTransactionItemPrice, EsolveTransactionList, EsolveTransactionLocation, EsolveTransactionPaymentMethod, EsolveTransactionPick, EsolveTransactionShippingMethod, EsolveTransactionTimeSlot, EsolveTransactionUser, EsolveTransactionsService, EsolveUserAccount, EsolveUserAccountBusiness, EsolveUserAccountContact, EsolveUserAccountResult, EsolveUserClientAccount, EsolveUserClientAccountBalances, EsolveUserDevice, EsolveVaultItem, EsolveVaultItemResult, EsolveVoucher, EsolveVouchersService, EsolveWalletBalances, EsolveWalletService, EsolveWalletTransaction, EsolveWalletTransactionsList, EsolveWishlistItem, EsolveWishlistService, NgEsolveConnectModule, esolveHexHash, isEsolveCdnPath, isFtgCdnPath, isLegacyEsolveCdnPath, processEsolveImageSrc, provideEsolveImageLoader, provideNgEsolveConnect };
+export { ESOLVE_CONNECT_CONFIG, ESOLVE_EURUS_AUTO_LOGIN, EsolveAccountConfirmationResult, EsolveAccountService, EsolveAdditionalStockImage, EsolveAddress, EsolveAddressResult, EsolveAsset, EsolveAssetsService, EsolveAuthInterceptorService, EsolveAuthService, EsolveBankingDetails, EsolveBanner, EsolveBannerImage, EsolveBannerImageHotspot, EsolveBannerService, EsolveCartAlternative, EsolveCartItem, EsolveCartService, EsolveCartStockItem, EsolveCartTotals, EsolveCategoryTreeItem, EsolveCategoryTreeService, EsolveCdnSrcDirective, EsolveChangePasswordResult, EsolveCheckoutResult, EsolveColour, EsolveCompetition, EsolveCompetitionDates, EsolveCompetitionEntryResult, EsolveCompetitionWinner, EsolveCompetitionsService, EsolveConfigService, EsolveCookieService, EsolveCoupon, EsolveCouponsService, EsolveDeliveriesService, EsolveDelivery, EsolveDeliveryCategoryTotals, EsolveDeliveryStatus, EsolveDependantItem, EsolveDeviceService, EsolveEmptyCartResult, EsolveEmptyWishlistResult, EsolveEnquiryResult, EsolveEnquiryService, EsolveErrorHandlerService, esolveFilterFactory as EsolveFilterFactory, EsolveGenericFilter, EsolveGeocodeAddressResult, EsolveGeocodeCoordsResult, EsolveGeocodeResult, EsolveGeocoderService, EsolveHttpError, EsolveLinkedAsset, EsolveLinkedStockItem, EsolveList, EsolveLocation, EsolveLocationAddress, EsolveLocationContactInfo, EsolveLocationGEO, EsolveLocationList, EsolveLocationPOBoxAddress, EsolveLocationTradingDay, EsolveLocationTradingTimes, EsolveLocationUpdateResult, EsolveLocationsService, EsolveManufacturer, EsolveManufacturersService, EsolveMediaStockItem, EsolveMenuItem, EsolveMenuService, EsolveMultipleSelectFilter, EsolveNewsArticle, EsolveNewsArticleAuthor, EsolveNewsArticleList, EsolveNewsGroup, EsolveNewsService, EsolveNewsletterResult, EsolveOtp, EsolveOtpService, EsolveOtpValidation, EsolvePaymentMethod, EsolvePaymentResult, EsolvePaymentService, EsolveRange, EsolveRangeFilter, EsolveRangesService, EsolveRecipeStockItem, EsolveRegistrationResult, EsolveResetPasswordResult, EsolveResponseHandlerService, EsolveResponseResult, EsolveResult, EsolveSeoInfo, EsolveSeoService, EsolveSessionAddressUpdateResult, EsolveSessionMetadataService, EsolveSessionService, EsolveSessionShippingUpdateResult, EsolveSetDeviceResult, EsolveSetNotifyResult, EsolveShippingCost, EsolveShippingMethod, EsolveShippingService, EsolveShippingTotals, EsolveSingleSelectFilter, EsolveSpecial, EsolveSpecialDates, EsolveSpecialImage, EsolveSpecialImageCollection, EsolveSpecialsService, EsolveStatement, EsolveStatementAgeing, EsolveStatementBalances, EsolveStatementTransaction, EsolveStockBadge, EsolveStockGroup, EsolveStockGroupItem, EsolveStockImage, EsolveStockImageCollection, EsolveStockItem, EsolveStockItemBase, EsolveStockItemList, EsolveStockLeadTimes, EsolveStockPrice, EsolveStockService, EsolveSupplier, EsolveSuppliersService, EsolveTag, EsolveTagsService, EsolveTimeSlot, EsolveTimeSlotConfig, EsolveTimeSlotDate, EsolveTimeSlotDays, EsolveTimeSlotTimes, EsolveToggleFilter, EsolveTopic, EsolveTopicService, EsolveTransaction, EsolveTransactionAddress, EsolveTransactionAnalyticsData, EsolveTransactionClient, EsolveTransactionDelivery, EsolveTransactionItem, EsolveTransactionItemPrice, EsolveTransactionList, EsolveTransactionLocation, EsolveTransactionPaymentMethod, EsolveTransactionPick, EsolveTransactionShippingMethod, EsolveTransactionTimeSlot, EsolveTransactionUser, EsolveTransactionsService, EsolveUserAccount, EsolveUserAccountBusiness, EsolveUserAccountContact, EsolveUserAccountResult, EsolveUserClientAccount, EsolveUserClientAccountBalances, EsolveUserDevice, EsolveVaultItem, EsolveVaultItemResult, EsolveVoucher, EsolveVouchersService, EsolveWalletBalances, EsolveWalletService, EsolveWalletTransaction, EsolveWalletTransactionsList, EsolveWishlistItem, EsolveWishlistService, NgEsolveConnectModule, esolveHexHash, isEsolveCdnPath, isFtgCdnPath, isLegacyEsolveCdnPath, processEsolveImageSrc, provideEsolveImageLoader, provideNgEsolveConnect };
 //# sourceMappingURL=esolve-ng-esolve-connect.mjs.map