@smartico/public-api 0.0.379 → 0.0.380

package/dist/WSAPI/WSAPIRaffles.d.ts

@@ -0,0 +1,119 @@
+import { TRaffle, TRaffleDraw, TRaffleDrawRun, TransformedRaffleClaimPrizeResponse, TRaffleOptinResponse } from './WSAPITypes';
+import { WSAPIJackpots } from './WSAPIJackpots';
+/** @group Raffles */
+export declare class WSAPIRaffles extends WSAPIJackpots {
+    protected updateRaffles(): Promise<void>;
+    /**
+     * Returns the list of Raffles available for user
+     * The returned list of Raffles is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getRaffles with a new onUpdate callback, the old one will be overwritten by the new one.
+     * The onUpdate callback will be called on claiming prize.  Updated Raffles will be passed to onUpdate callback.
+     *
+     * **Example**:
+     *
+     * ```
+     * _smartico.api.getRaffles().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     * **Example in the Visitor mode**:
+     *
+     * ```
+     * _smartico.vapi('EN').getRaffles().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     */
+    getRaffles({ onUpdate }?: {
+        onUpdate?: (data: TRaffle[]) => void;
+    }): Promise<TRaffle[]>;
+    /**
+     * Returns draw run for provided raffle_id and run_id.
+     * You can pass winners_from and winners_to parameters to get a specific range of winners. Default is 0-20.
+     *
+     *
+     * **Example**:
+     *
+     * ```javascript
+     * _smartico.api.getRaffleDrawRun({raffle_id: 156, run_id: 145}).then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     * **Example in the Visitor mode**:
+     *
+     *
+     * ```javascript
+     * _smartico.vapi('EN').getRaffleDrawRun({ raffle_id: 156, run_id: 145 }).then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     */
+    getRaffleDrawRun(props: {
+        raffle_id: number;
+        run_id: number;
+        winners_from?: number;
+        winners_to?: number;
+    }): Promise<TRaffleDraw>;
+    /**
+     * Returns history of draw runs for the provided raffle_id and draw_id, if the draw_id is not provided will return history of all the draws for the provided raffle_id
+     *
+     *
+     * **Example**:
+     *
+     * ```javascript
+     * _smartico.api.getRaffleDrawRunsHistory({ raffle_id: 156, draw_id: 432 }).then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     * **Example in the Visitor mode**:
+     *
+     * ```javascript
+     * _smartico.vapi('EN').getRaffleDrawRunsHistory({ raffle_id: 156, draw_id: 432 }).then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     */
+    getRaffleDrawRunsHistory(props: {
+        raffle_id: number;
+        draw_id?: number;
+    }): Promise<TRaffleDrawRun[]>;
+    /**
+     * Returns `err_code` and `err_message` after the call; `err_code` 0 means the request succeeded.
+     *
+     *
+     * **Example**:
+     *
+     * ```javascript
+     * _smartico.api.claimRafflePrize({won_id:251}).then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     * **Example in the Visitor mode**:
+     *
+     * ```javascript
+     * _smartico.vapi('EN').claimRafflePrize({ won_id: 251 }).then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     */
+    claimRafflePrize(props: {
+        won_id: number;
+    }): Promise<TransformedRaffleClaimPrizeResponse>;
+    /**
+     * Requests an opt-in for the specified raffle. Returns the err_code.
+     *
+     * **Visitor mode: not supported**
+     */
+    requestRaffleOptin(props: {
+        raffle_id: number;
+        draw_id: number;
+        raffle_run_id: number;
+    }): Promise<TRaffleOptinResponse>;
+}