@raba7ni/raba7ni 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -26,6 +26,7 @@ interface ApiResponse<T = any> {
     success: boolean;
     data?: T;
     message?: string;
+    error?: string;
 }
 /**
  * API error response structure
@@ -34,6 +35,8 @@ interface ApiError {
     error: string;
     message: string;
     errors?: Record<string, string[]>;
+    remaining_attempts?: number;
+    retry_after_minutes?: number;
 }
 /**
  * Rate limit information from response headers
@@ -45,13 +48,23 @@ interface RateLimitInfo {
     dailyRemaining: number;
     resetTime?: string;
 }
+/**
+ * Member information
+ */
+interface Member {
+    id: number;
+    name: string;
+    email?: string;
+    phone?: string;
+    created_at: string;
+}
 /**
  * Member validation request
  */
 interface ValidateMemberRequest {
     card_id: number;
     phone_number: string;
-    include_member_data?: boolean | undefined;
+    include_member_data?: boolean;
 }
 /**
  * Member validation response
@@ -70,12 +83,38 @@ interface MemberDetailsRequest {
     card_id: number;
     phone_number: string;
 }
+/**
+ * Card relationship information
+ */
+interface CardRelationship {
+    card_id: number;
+    points: number;
+    joined_at: string | null;
+    last_updated: string | null;
+}
 /**
  * Member details response
  */
 interface MemberDetailsResponse {
     member: Member;
     card_relationship: CardRelationship;
+    validated_at: string;
+}
+/**
+ * Request OTP request
+ */
+interface RequestOTPRequest {
+    email: string;
+    card_id: number;
+}
+/**
+ * Request OTP response
+ */
+interface RequestOTPResponse {
+    expires_at?: string;
+    expires_in_minutes?: number;
+    member_exists?: boolean;
+    message?: string;
 }
 /**
  * Find or create member request
@@ -85,6 +124,7 @@ interface FindOrCreateMemberRequest {
     name: string;
     email: string;
     phone_number: string;
+    verification_code?: string;
     create_order?: boolean;
     order?: Order;
 }
@@ -94,7 +134,6 @@ interface FindOrCreateMemberRequest {
 interface Order {
     award_points?: boolean;
     total_amount: number;
-    delivery_cost?: number;
     items?: OrderItem[];
 }
 /**
@@ -105,6 +144,27 @@ interface OrderItem {
     amount: number;
     metadata?: Record<string, any>;
 }
+/**
+ * Order response
+ */
+interface OrderResponse {
+    id: number;
+    total_amount: number;
+    items?: OrderItem[];
+    points_awarded: boolean;
+    status: string;
+    created_at: string;
+}
+/**
+ * Transaction information
+ */
+interface Transaction {
+    id: number;
+    points?: number;
+    stamps?: number;
+    event: string;
+    created_at: string;
+}
 /**
  * Find or create member response
  */
@@ -117,62 +177,199 @@ interface FindOrCreateMemberResponse {
     transaction?: Transaction;
 }
 /**
- * Order response
+ * Card information (summary for list)
  */
-interface OrderResponse {
+interface CardSummary {
     id: number;
-    total_amount: string;
-    delivery_cost?: string;
-    items?: OrderItem[];
-    points_awarded: boolean;
-    status: string;
-    created_at: string;
+    unique_identifier: string;
+    name: string;
+    head: string;
+    is_active: boolean;
+    initial_bonus_points?: number;
+    points_per_currency?: number;
+    currency_unit_amount?: number;
+    min_points_per_purchase?: number;
+    max_points_per_purchase?: number;
+    points_expiration_months?: number;
+    club_id: number;
 }
 /**
- * Card information
+ * Card information (detailed)
  */
 interface Card {
     id: number;
+    unique_identifier: string;
     name: string;
+    head?: string;
     description?: string;
     club_id: number;
-    club_name: string;
-    reward_type: 'points' | 'stamps';
+    club_name?: string;
+    reward_type?: 'points' | 'stamps';
     is_active: boolean;
-    created_at: string;
+    initial_bonus_points?: number;
+    points_per_currency?: number;
+    currency_unit_amount?: number;
+    created_at?: string;
 }
 /**
- * Member information
+ * List cards response
  */
-interface Member {
+interface ListCardsResponse {
+    cards: CardSummary[];
+    total: number;
+}
+/**
+ * Reward information
+ */
+interface Reward {
     id: number;
-    first_name?: string;
-    last_name?: string;
-    name?: string;
-    email?: string;
-    phone?: string;
+    name: string;
+    title?: Record<string, string>;
+    description?: Record<string, string>;
+    points?: number;
+    stamps_required?: number;
+    reward_type?: string;
+    is_active: boolean;
+    active_from?: string;
+    expiration_date?: string;
+    images?: any;
+}
+/**
+ * List rewards response
+ */
+interface ListRewardsResponse {
+    card_id: number;
+    rewards: Reward[];
+    total: number;
+}
+/**
+ * Claim request status
+ */
+type ClaimRequestStatus = 'pending' | 'approved' | 'rejected' | 'expired';
+/**
+ * Claim request
+ */
+interface ClaimRequest {
+    id: number;
+    code?: string;
+    unique_code?: string;
+    status: ClaimRequestStatus;
+    member?: Member;
+    reward?: Reward;
+    card_id?: number;
+    member_note?: string;
+    staff_note?: string;
+    expires_at?: string;
     created_at: string;
+    processed_at?: string;
 }
 /**
- * Card relationship information
+ * List claim requests response
  */
-interface CardRelationship {
+interface ListClaimRequestsResponse {
+    claim_requests: ClaimRequest[];
+    total: number;
+}
+/**
+ * Request claim OTP request
+ */
+interface RequestClaimOTPRequest {
+    member_email: string;
     card_id: number;
-    points: number;
-    stamps: number;
-    joined_at: string;
-    last_updated: string;
+    reward_id?: number;
 }
 /**
- * Transaction information
+ * Create claim request
  */
-interface Transaction {
+interface CreateClaimRequestRequest {
+    member_email: string;
+    card_id: number;
+    reward_id: number;
+    verification_code: string;
+    member_note?: string;
+    fulfillment_details?: Record<string, any>;
+}
+/**
+ * Approve/Reject claim request
+ */
+interface ProcessClaimRequestRequest {
+    staff_note?: string;
+}
+/**
+ * Referral stats response
+ */
+interface ReferralStatsResponse {
+    total_referrals: number;
+    successful_referrals: number;
+    pending_referrals: number;
+    top_referrers: Referrer[];
+}
+/**
+ * Referrer info
+ */
+interface Referrer {
+    member_id: number;
+    member_name: string;
+    referral_count: number;
+    successful_count: number;
+}
+/**
+ * List referrers response
+ */
+interface ListReferrersResponse {
+    referrers: Referrer[];
+    total: number;
+}
+/**
+ * Referral info
+ */
+interface Referral {
     id: number;
-    points?: number;
-    stamps?: number;
-    event: string;
+    referrer_id: number;
+    referee_id?: number;
+    referee_email?: string;
+    status: string;
+    bonus_awarded?: number;
     created_at: string;
 }
+/**
+ * List referrals response
+ */
+interface ListReferralsResponse {
+    referrals: Referral[];
+    total: number;
+}
+/**
+ * Validate referral code request
+ */
+interface ValidateReferralCodeRequest {
+    referral_code: string;
+    card_id: number;
+}
+/**
+ * Validate referral code response
+ */
+interface ValidateReferralCodeResponse {
+    is_valid: boolean;
+    referrer?: {
+        id: number;
+        name: string;
+    };
+}
+/**
+ * Apply referral request
+ */
+interface ApplyReferralRequest {
+    referral_code: string;
+    card_id: number;
+    referee_email: string;
+}
+/**
+ * Apply referral response
+ */
+interface ApplyReferralResponse {
+    referral: Referral;
+}
 /**
  * Available API scope
  */
@@ -181,6 +378,16 @@ interface Scope {
     name: string;
     description: string;
 }
+/**
+ * Scopes response
+ */
+interface ScopesResponse {
+    scopes: string[];
+    application: {
+        id: string;
+        name: string;
+    };
+}
 /**
  * Available webhook event
  */
@@ -214,31 +421,27 @@ interface MemberLeftWebhookData {
     card: Card;
 }
 /**
- * Points earned webhook data
+ * Claim request created webhook data
  */
-interface PointsEarnedWebhookData {
+interface ClaimRequestCreatedWebhookData {
+    claim_request: ClaimRequest;
     member: Member;
     card: Card;
-    transaction: Transaction;
+    reward: Reward;
 }
 /**
- * Points redeemed webhook data
+ * Claim request processed webhook data
  */
-interface PointsRedeemedWebhookData {
+interface ClaimRequestProcessedWebhookData {
+    claim_request: ClaimRequest;
     member: Member;
     card: Card;
-    transaction: Transaction;
+    reward: Reward;
+    status: 'approved' | 'rejected';
+    processed_at: string;
 }
 /**
- * Transaction created webhook data
- */
-interface TransactionCreatedWebhookData {
-    transaction: Transaction;
-    member: Member;
-    card: Card;
-}
-/**
- * SDK initialization error
+ * SDK error base class
  */
 declare class Raba7niError extends Error {
     code?: string | undefined;
@@ -276,10 +479,24 @@ declare class NetworkError extends Raba7niError {
 
 /**
  * Main Raba7ni SDK class
+ *
+ * Provides methods for all Developer API endpoints.
  */
 declare class Raba7niSDK {
     private client;
     constructor(config: Raba7niConfig);
+    /**
+     * Test API connection and get available scopes
+     */
+    testConnection(): Promise<ScopesResponse>;
+    /**
+     * Alias for testConnection - Get available API scopes
+     */
+    getScopes(): Promise<ScopesResponse>;
+    /**
+     * Get available webhook events
+     */
+    getWebhookEvents(): Promise<WebhookEvent[]>;
     /**
      * Validate if a phone number is a member of a specific card
      */
@@ -290,23 +507,92 @@ declare class Raba7niSDK {
      * Get detailed information about a member for a specific card
      */
     getMemberDetails(cardId: number | string, phoneNumber: string): Promise<MemberDetailsResponse>;
+    /**
+     * Request OTP for new member registration
+     *
+     * @param email - Email address to send OTP to
+     * @param cardId - The loyalty card ID
+     * @returns OTP info or member_exists flag if already registered
+     */
+    requestMemberOTP(email: string, cardId: number | string): Promise<RequestOTPResponse>;
     /**
      * Find an existing member by email/phone, or create a new account.
      * Optionally create an online order and/or award points.
      */
     findOrCreateMember(request: FindOrCreateMemberRequest): Promise<FindOrCreateMemberResponse>;
     /**
-     * Get card information
+     * Get all loyalty cards available for your API key
+     */
+    listCards(): Promise<ListCardsResponse>;
+    /**
+     * Get details about a specific loyalty card
      */
     getCardInfo(cardId: number | string): Promise<Card>;
     /**
-     * Get available API scopes
+     * Get all rewards available for a specific card
      */
-    getScopes(): Promise<Scope[]>;
+    listCardRewards(cardId: number | string): Promise<ListRewardsResponse>;
     /**
-     * Get available webhook events
+     * Get all claim requests for a card
+     *
+     * @param cardId - The loyalty card ID
+     * @param status - Optional filter by status
      */
-    getWebhookEvents(): Promise<WebhookEvent[]>;
+    listClaimRequests(cardId: number | string, status?: ClaimRequestStatus): Promise<ListClaimRequestsResponse>;
+    /**
+     * Request OTP for claiming a reward
+     *
+     * @param memberEmail - Member's email address
+     * @param cardId - The loyalty card ID
+     * @param rewardId - Optional specific reward ID
+     */
+    requestClaimOTP(memberEmail: string, cardId: number | string, rewardId?: number): Promise<RequestOTPResponse>;
+    /**
+     * Create a new claim request for a reward
+     *
+     * @param request - Claim request details including OTP verification
+     */
+    createClaimRequest(request: CreateClaimRequestRequest): Promise<{
+        claim_request: ClaimRequest;
+    }>;
+    /**
+     * Get details of a specific claim request
+     */
+    getClaimRequest(requestId: number): Promise<{
+        claim_request: ClaimRequest;
+    }>;
+    /**
+     * Approve a pending claim request
+     */
+    approveClaimRequest(requestId: number, staffNote?: string): Promise<{
+        claim_request: ClaimRequest;
+    }>;
+    /**
+     * Reject a pending claim request
+     */
+    rejectClaimRequest(requestId: number, staffNote?: string): Promise<{
+        claim_request: ClaimRequest;
+    }>;
+    /**
+     * Get referral statistics for a card
+     */
+    getReferralStats(cardId: number | string): Promise<ReferralStatsResponse>;
+    /**
+     * Get list of top referrers for a card
+     */
+    listReferrers(cardId: number | string): Promise<ListReferrersResponse>;
+    /**
+     * Get all referrals made by a specific member
+     */
+    listReferrerReferrals(cardId: number | string, memberId: number): Promise<ListReferralsResponse>;
+    /**
+     * Validate a referral code
+     */
+    validateReferralCode(referralCode: string, cardId: number | string): Promise<ValidateReferralCodeResponse>;
+    /**
+     * Apply a referral code to a new member
+     */
+    applyReferral(referralCode: string, cardId: number | string, refereeEmail: string): Promise<ApplyReferralResponse>;
     /**
      * Get current rate limit information
      */
@@ -386,26 +672,6 @@ declare function verifyWebhookSignature(payload: string, signature: string, secr
  * Parse webhook payload with type safety
  */
 declare function parseWebhookPayload<T = any>(payload: string): WebhookPayload<T>;
-/**
- * Type guard for member joined webhook
- */
-declare function isMemberJoinedWebhook(payload: WebhookPayload): payload is WebhookPayload<MemberJoinedWebhookData>;
-/**
- * Type guard for member left webhook
- */
-declare function isMemberLeftWebhook(payload: WebhookPayload): payload is WebhookPayload<MemberLeftWebhookData>;
-/**
- * Type guard for points earned webhook
- */
-declare function isPointsEarnedWebhook(payload: WebhookPayload): payload is WebhookPayload<PointsEarnedWebhookData>;
-/**
- * Type guard for points redeemed webhook
- */
-declare function isPointsRedeemedWebhook(payload: WebhookPayload): payload is WebhookPayload<PointsRedeemedWebhookData>;
-/**
- * Type guard for transaction created webhook
- */
-declare function isTransactionCreatedWebhook(payload: WebhookPayload): payload is WebhookPayload<TransactionCreatedWebhookData>;
 /**
  * Webhook handler class
  */
@@ -430,9 +696,8 @@ declare class WebhookHandler {
     handleWebhook(payload: string, signature: string, handlers: {
         onMemberJoined?: (data: MemberJoinedWebhookData) => Promise<void> | void;
         onMemberLeft?: (data: MemberLeftWebhookData) => Promise<void> | void;
-        onPointsEarned?: (data: PointsEarnedWebhookData) => Promise<void> | void;
-        onPointsRedeemed?: (data: PointsRedeemedWebhookData) => Promise<void> | void;
-        onTransactionCreated?: (data: TransactionCreatedWebhookData) => Promise<void> | void;
+        onClaimRequestCreated?: (data: ClaimRequestCreatedWebhookData) => Promise<void> | void;
+        onClaimRequestProcessed?: (data: ClaimRequestProcessedWebhookData) => Promise<void> | void;
         onUnknownEvent?: (event: string, data: any) => Promise<void> | void;
     }): Promise<void>;
     /**
@@ -472,26 +737,6 @@ declare function sanitizeString(input: string, maxLength?: number): string;
  * Validate name field
  */
 declare function validateName(name: string): string;
-/**
- * Deep clone object
- */
-declare function deepClone<T>(obj: T): T;
-/**
- * Retry delay calculation with exponential backoff
- */
-declare function calculateRetryDelay(attempt: number, baseDelay?: number): number;
-/**
- * Generate random string for request tracking
- */
-declare function generateRequestId(): string;
-/**
- * Check if a value is a valid ISO date string
- */
-declare function isValidISODate(dateString: string): boolean;
-/**
- * Format date to ISO string
- */
-declare function formatDate(date: Date | string): string;
 
-export { AuthenticationError, NetworkError, Raba7niClient, Raba7niError, Raba7niSDK, RateLimitError, ValidationError, WebhookHandler, calculateRetryDelay, deepClone, Raba7niSDK as default, formatDate, generateRequestId, isMemberJoinedWebhook, isMemberLeftWebhook, isPointsEarnedWebhook, isPointsRedeemedWebhook, isTransactionCreatedWebhook, isValidISODate, normalizePhoneNumber, parseWebhookPayload, sanitizeString, validateAmount, validateCardId, validateEmail, validateName, verifyWebhookSignature };
-export type { ApiError, ApiResponse, Card, CardRelationship, FindOrCreateMemberRequest, FindOrCreateMemberResponse, Member, MemberDetailsRequest, MemberDetailsResponse, MemberJoinedWebhookData, MemberLeftWebhookData, Order, OrderItem, OrderResponse, PointsEarnedWebhookData, PointsRedeemedWebhookData, Raba7niConfig, RateLimitInfo, Scope, Transaction, TransactionCreatedWebhookData, ValidateMemberRequest, ValidateMemberResponse, WebhookEvent, WebhookPayload };
+export { AuthenticationError, NetworkError, Raba7niClient, Raba7niError, Raba7niSDK, RateLimitError, ValidationError, WebhookHandler, normalizePhoneNumber, parseWebhookPayload, sanitizeString, validateAmount, validateCardId, validateEmail, validateName, verifyWebhookSignature };
+export type { ApiError, ApiResponse, ApplyReferralRequest, ApplyReferralResponse, Card, CardRelationship, CardSummary, ClaimRequest, ClaimRequestCreatedWebhookData, ClaimRequestProcessedWebhookData, ClaimRequestStatus, CreateClaimRequestRequest, FindOrCreateMemberRequest, FindOrCreateMemberResponse, ListCardsResponse, ListClaimRequestsResponse, ListReferralsResponse, ListReferrersResponse, ListRewardsResponse, Member, MemberDetailsRequest, MemberDetailsResponse, MemberJoinedWebhookData, MemberLeftWebhookData, Order, OrderItem, OrderResponse, ProcessClaimRequestRequest, Raba7niConfig, RateLimitInfo, Referral, ReferralStatsResponse, Referrer, RequestClaimOTPRequest, RequestOTPRequest, RequestOTPResponse, Reward, Scope, ScopesResponse, Transaction, ValidateMemberRequest, ValidateMemberResponse, ValidateReferralCodeRequest, ValidateReferralCodeResponse, WebhookEvent, WebhookPayload };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAGnC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,2BAA2B,EAC5B,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,cAAc,EACd,YAAY,EACZ,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,iBAAiB,EACjB,cAAc,EACd,UAAU,EACX,MAAM,SAAS,CAAC;AAGjB,YAAY,EACV,aAAa,EACb,WAAW,EACX,QAAQ,EACR,aAAa,EACb,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC1B,KAAK,EACL,SAAS,EACT,aAAa,EACb,IAAI,EACJ,MAAM,EACN,gBAAgB,EAChB,WAAW,EACX,KAAK,EACL,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,yBAAyB,EACzB,6BAA6B,EAC9B,MAAM,SAAS,CAAC;AAGjB,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,cAAc,EACd,eAAe,EACf,YAAY,EACb,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,UAAU,IAAI,OAAO,EAAE,MAAM,OAAO,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAGnC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAGzF,OAAO,EACL,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,cAAc,EACd,YAAY,EACZ,cAAc,EACf,MAAM,SAAS,CAAC;AAGjB,YAAY,EAEV,aAAa,EACb,WAAW,EACX,QAAQ,EACR,aAAa,EAGb,MAAM,EACN,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EACzB,0BAA0B,EAC1B,KAAK,EACL,SAAS,EACT,aAAa,EACb,WAAW,EAGX,IAAI,EACJ,WAAW,EACX,iBAAiB,EACjB,MAAM,EACN,mBAAmB,EAGnB,YAAY,EACZ,kBAAkB,EAClB,yBAAyB,EACzB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAG1B,qBAAqB,EACrB,QAAQ,EACR,qBAAqB,EACrB,QAAQ,EACR,qBAAqB,EACrB,2BAA2B,EAC3B,4BAA4B,EAC5B,oBAAoB,EACpB,qBAAqB,EAGrB,KAAK,EACL,cAAc,EACd,YAAY,EACZ,cAAc,EAGd,uBAAuB,EACvB,qBAAqB,EACrB,8BAA8B,EAC9B,gCAAgC,EACjC,MAAM,SAAS,CAAC;AAGjB,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,cAAc,EACd,eAAe,EACf,YAAY,EACb,MAAM,SAAS,CAAC"}