@crmcom/self-service-sdk 2.1.2

package/index.d.ts

@@ -0,0 +1,527 @@
+// CRM.COM SDK Type Definitions
+
+// ============================================================================
+// Result Types
+// ============================================================================
+
+export interface SDKResult<T = any> {
+    code: string;
+    data: T;
+}
+
+export declare const ErrorCodes: {
+    OK: 'OK';
+    UNKNOWN: 'UNKNOWN';
+    UNCLASSIFIED_ERROR: 'UNCLASSIFIED_ERROR';
+    REGISTRATION_FAIL_CONTACT_EXISTS: 'REGISTRATION_FAIL_CONTACT_EXISTS';
+    INVALID_LOGIN: 'INVALID_LOGIN';
+    ACCOUNT_NOT_FOUND: 'ACCOUNT_NOT_FOUND';
+    ADD_ADDRESS_ALREADY_TYPE: 'ADD_ADDRESS_ALREADY_TYPE';
+    FORGOT_EMAIL_NOT_FOUND_EXCEPTION: 'FORGOT_EMAIL_NOT_FOUND_EXCEPTION';
+    PHONE_NUMBER_ALREADY_EXIST: 'PHONE_NUMBER_ALREADY_EXIST';
+    CAN_NOT_FULFILL_ORDER_EXCEPTION: 'CAN_NOT_FULFILL_ORDER_EXCEPTION';
+    MINIMUM_ORDER_AMOUNT_NOT_REACHED: 'MINIMUM_ORDER_AMOUNT_NOT_REACHED';
+    SIGN_UP_ORGANISATION_ALREADY: 'SIGN_UP_ORGANISATION_ALREADY';
+    CONTACTUNIQUELYIDENTIFYEXCEPTION: 'CONTACTUNIQUELYIDENTIFYEXCEPTION';
+    NOTFOUNDEXCEPTION: 'NOTFOUNDEXCEPTION';
+    EMAIL_NOT_VERIFIED: 'EMAIL_NOT_VERIFIED';
+    CARD_ALREADY_EXIT: 'CARD_ALREADY_EXIT';
+    CARD_NOT_FOUND: 'CARD_NOT_FOUND';
+    INVALID_PASSWORD_EXCEPTION: 'INVALID_PASSWORD_EXCEPTION';
+    PASSWORD_LENGTH_EXCEPTION: 'PASSWORD_LENGTH_EXCEPTION';
+    PAYMENT_GATEWAY_EXCEPTION: 'PAYMENT_GATEWAY_EXCEPTION';
+    CUSTOMER_EMAIL_ALREADY_EXIST: 'CUSTOMER_EMAIL_ALREADY_EXIST';
+    TOO_MANY_REQUESTS: 'TOO_MANY_REQUESTS';
+    TOO_MANY_RECIPIENTS_EXCEPTION: 'TOO_MANY_RECIPIENTS_EXCEPTION';
+    SPEND_AMOUNT_NOT_FULLY_COVERED_EXCEPTION: 'SPEND_AMOUNT_NOT_FULLY_COVERED_EXCEPTION';
+    REDEEM_PASS_INVALID: 'REDEEM_PASS_INVALID';
+    REDEEM_PASS_NOT_ACTIVE: 'REDEEM_PASS_NOT_ACTIVE';
+    REDEEM_PASS_PIN_MANDATORY: 'REDEEM_PASS_PIN_MANDATORY';
+    REDEEM_PASS_USED: 'REDEEM_PASS_USED';
+    SERVICE_ALREADY_EXIST: 'SERVICE_ALREADY_EXIST';
+    CANNOTEXECUTEACTIONCREDITLIMITEXCEPTION: 'CANNOTEXECUTEACTIONCREDITLIMITEXCEPTION';
+    CANNOTSPENDAMOUNTWALLETBALANCENOTENOUGHEXCEPTION: 'CANNOTSPENDAMOUNTWALLETBALANCENOTENOUGHEXCEPTION';
+    CANNOTUNREGISTERCONTACTEXCEPTION: 'CANNOTUNREGISTERCONTACTEXCEPTION';
+    CANNOTEXECUTESUBSCRIPTIONACTIONEXCEPTION: 'CANNOTEXECUTESUBSCRIPTIONACTIONEXCEPTION';
+    INVALIDVALUEEXCEPTION: 'INVALIDVALUEEXCEPTION';
+    MULTIPLECONTACTSSAMEPHONEEXCEPTION: 'MULTIPLECONTACTSSAMEPHONEEXCEPTION';
+    COMMUNITYPARENTCHILDEXCEPTION: 'COMMUNITYPARENTCHILDEXCEPTION';
+    CIMALREADYEXISTSFORANOTHERCONTACTEXCEPTION: 'CIMALREADYEXISTSFORANOTHERCONTACTEXCEPTION';
+};
+
+export declare function createResult(errorCode: string, data: any): SDKResult;
+export declare function createCommonResult(response: any, requestType?: string): SDKResult;
+
+// ============================================================================
+// Logger
+// ============================================================================
+
+export declare const logger: {
+    setLevel(level: 'none' | 'error' | 'warn' | 'info' | 'debug'): void;
+    getLevel(): string;
+    debug(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+};
+
+// ============================================================================
+// HTTP Utilities
+// ============================================================================
+
+interface SetupChannelOptions {
+    storeKVFn: (key: string, value: any) => void | Promise<void>;
+    getKVFn: (key: string) => any | Promise<any>;
+    sessionInvalidCallback: (shouldLogout: boolean) => void | Promise<void>;
+    apiKey: string;
+    host: string;
+    fetchFn?: typeof fetch;
+    sslPinningOptions?: Record<string, any>;
+    enableSslPinning?: boolean;
+    isBackend?: boolean;
+    middlewareHost?: string;
+    middlewareApiKey?: string;
+    mwNodejsHost?: string;
+    mwNodejsApiKey?: string;
+}
+
+interface SessionData {
+    sub: string;
+    current_organisation_id?: string;
+    groups?: string[];
+    exp: number;
+    [key: string]: any;
+}
+
+interface HttpRequestOptions {
+    resourcePath: string;
+    queryParams?: Record<string, any>;
+    body?: Record<string, any>;
+    withAccessToken?: boolean;
+    withoutApikey?: boolean;
+    isBackend?: boolean;
+    logOutIfSessionInvalid?: boolean;
+    isRefreshToken?: boolean;
+    accessToken?: string;
+    returnText?: boolean;
+    returnBlob?: boolean;
+    isMiddleware?: boolean;
+    isMwNodejs?: boolean;
+    plugin?: string;
+    unauthorize?: boolean;
+    apiKey?: string;
+}
+
+interface UploadFileOptions {
+    resourcePath: string;
+    fileData: any;
+    body?: Record<string, any>;
+    queryParams?: Record<string, any>;
+    withAccessToken?: boolean;
+    withoutApikey?: boolean;
+    isBackend?: boolean;
+    logOutIfSessionInvalid?: boolean;
+    accessToken?: string;
+    isMiddleware?: boolean;
+    method?: string;
+    keyParam?: string;
+    disalbedContentType?: boolean;
+}
+
+export declare const httpUtil: {
+    setupChannel(options: SetupChannelOptions): Promise<void>;
+    setupApiKey(apiKey: string): Promise<void>;
+    post(options: HttpRequestOptions): Promise<SDKResult>;
+    get(options: HttpRequestOptions): Promise<SDKResult>;
+    put(options: HttpRequestOptions): Promise<SDKResult>;
+    sendDelete(options: HttpRequestOptions): Promise<SDKResult>;
+    uploadFile(options: UploadFileOptions): Promise<SDKResult>;
+    uploadFileNew(options: UploadFileOptions): Promise<SDKResult>;
+    is200OK(result: any): boolean;
+    startSession(data: { access_token: string; refresh_token: string; exp?: number; communities?: any[] }): void;
+    startSessionUnregister(data: { access_token: string; refresh_token: string }): void;
+    getSession(): SessionData | undefined;
+    getToken(): string | undefined;
+    cleanSession(): void;
+    switchSession(data: { access_token: string; refresh_token: string; exp?: number; contact: any; initial_contact?: any; communities?: any[] }, isCommunity: boolean): void;
+    refreshToken(logOutIfSessionInvalid?: boolean): Promise<any>;
+    getURI(isBackend: boolean, resourcePath: string, isMiddleware?: boolean, isMwNodejs?: boolean, plugin?: string): string;
+    storeOrganisation(data: { organisations: any[] }): void;
+    getOrganisation(): Promise<string | null>;
+    cleanObj(obj: Record<string, any>): Record<string, any>;
+};
+
+export declare const httpBackOfficeUtil: {
+    setupChannel(options: Pick<SetupChannelOptions, 'storeKVFn' | 'getKVFn' | 'sessionInvalidCallback' | 'apiKey' | 'host' | 'fetchFn'>): Promise<void>;
+    post(options: HttpRequestOptions): Promise<SDKResult>;
+    get(options: HttpRequestOptions): Promise<SDKResult>;
+    put(options: HttpRequestOptions): Promise<SDKResult>;
+    sendDelete(options: HttpRequestOptions): Promise<SDKResult>;
+    is200OK(result: any): boolean;
+    startSession(data: { access_token: string; refresh_token: string; exp?: number; organisations?: any[] }): void;
+    getSession(): SessionData | undefined;
+    cleanSession(): void;
+    switchSession(data: { access_token: string; refresh_token: string; exp?: number }, isMerchant: boolean): void;
+    cleanObj(obj: Record<string, any>): Record<string, any>;
+};
+
+// ============================================================================
+// Authentication
+// ============================================================================
+
+export declare const authentication: {
+    authenticatePhone(params: { phone_number: string; country_code: string; application_id?: string }, startSession?: boolean): Promise<SDKResult>;
+    authenticateEmail(params: { username: string; password: string; application_id?: string }, startSession?: boolean): Promise<SDKResult>;
+    authenticateGuest(params: {}, startSession?: boolean): Promise<SDKResult>;
+    authenticateFacebook(params: { token: string; application_id?: string }, startSession?: boolean): Promise<SDKResult>;
+    authenticateFacebookOIDC(params: { state: string; code: string }, startSession?: boolean): Promise<SDKResult>;
+    authenticateSSOOIDC(params: { state: string; code: string }, startSession?: boolean): Promise<SDKResult>;
+    sendEmailVerification(email: string): Promise<SDKResult>;
+    validateOTP(params: { auth_otp: string; otp: string }, startSession?: boolean): Promise<SDKResult>;
+    registerByPhone(params: {
+        first_name: string; last_name: string; phone: string; country_code: string;
+        referral_code?: string; sms_opt_out?: boolean; email_opt_out?: boolean;
+        country_agreement?: string; language_code?: string; custom_fields?: any[];
+        accept_term_conditions?: boolean; validation_required?: boolean; pass_code?: string;
+    }, startSession?: boolean): Promise<SDKResult>;
+    registerByEmail(params: {
+        first_name: string; last_name: string; email: string; password: string;
+        referral_code?: string; sms_opt_out?: boolean; email_opt_out?: boolean;
+        country_agreement?: string; language_code?: string; custom_fields?: any[];
+        accept_term_conditions?: boolean; validation_required?: boolean; pass_code?: string;
+    }, startSession?: boolean): Promise<SDKResult>;
+    registerByFacebook(params: {
+        accept_term_conditions?: boolean; application_id?: string;
+        sms_opt_out?: boolean; email_opt_out?: boolean; token: string;
+    }, startSession?: boolean): Promise<SDKResult>;
+    requestOTP(params: { method: string; phone?: string; email?: string; id_number?: string; loyalty_identifier?: string; statutory_id?: string }): Promise<SDKResult>;
+    addContactIdentityEmail(params: { email: string; password: string; validation_required?: boolean; contact_id: string; access_token?: string }): Promise<SDKResult>;
+    addContactIdentityPhone(params: { phone: string; country_code: string; contact_id: string; access_token?: string }): Promise<SDKResult>;
+    forgotPassword(email: string): Promise<SDKResult>;
+    contactAuthenticate(type: string, redirectUri: string): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Contacts
+// ============================================================================
+
+interface PaginationParams {
+    page?: number;
+    size?: number;
+    sort?: string;
+    order?: 'ASC' | 'DESC';
+    include_total?: boolean;
+}
+
+export declare const contacts: {
+    getContact(): Promise<SDKResult>;
+    updateContact(params: {
+        first_name?: string; middle_name?: string; last_name?: string;
+        language_code?: string; email?: string; phone?: any;
+        gender?: string; date_of_birth?: string; name_day?: string;
+        custom_fields?: any[]; statutory_number?: string;
+        id_number?: string; id_issuing_country_code?: string; id_expiration_date?: string;
+        passport_number?: string; passport_issuing_country_code?: string; passport_expiration_date?: string;
+    }): Promise<SDKResult>;
+    verifyContactExist(params?: { email_address?: string; phone?: string }): Promise<SDKResult>;
+    getContactAddresses(): Promise<SDKResult>;
+    addContactAddress(params: {
+        type?: string; name?: string; is_primary?: boolean;
+        address_line_1?: string; address_line_2?: string;
+        state_province_county?: string; town_city?: string;
+        postal_code?: string; country_code?: string;
+        lat?: number; lon?: number; google_place_id?: string;
+    }): Promise<SDKResult>;
+    updateContactAddress(params: {
+        type?: string; name?: string; is_primary?: boolean;
+        address_line_1?: string; address_line_2?: string;
+        state_province_county?: string; town_city?: string;
+        postal_code?: string; country_code?: string;
+        lat?: number; lon?: number; google_place_id?: string;
+    }, addressId: string): Promise<SDKResult>;
+    updateContactOnboardingCards(params: { viewed?: any }, addId?: string): Promise<SDKResult>;
+    deleteContactAddress(addressId: string): Promise<SDKResult>;
+    setMarketingPreferences(params?: { sms_opt_out?: boolean; email_opt_out?: boolean; contact_id?: string; access_token?: string }): Promise<SDKResult>;
+    submitReferralCode(params: { referral_code: string }): Promise<SDKResult>;
+    reclaimPurchase(params: { purchase_id?: string; merchant_tap_code?: string; venue_tap_code?: string; total_amount?: number; transaction_code?: string }, extra: {}): Promise<SDKResult>;
+    referFriend(params: { recipients: any[] }, extra: {}): Promise<SDKResult>;
+    redeemPass(params: { code: string; contact_id?: string; wallet_id?: string; pin?: string }, extra: {}): Promise<SDKResult>;
+    getContactPreferredOrganisation(): Promise<SDKResult>;
+    addContactPreferredOrganisation(params?: { organisation_id?: string; type?: string }): Promise<SDKResult>;
+    unregisterContact(): Promise<SDKResult>;
+    signOutContact(params?: { redirect_url?: string }): Promise<SDKResult>;
+    getContactPurchases(params?: PaginationParams & { date?: string; date_gt?: string; date_gte?: string; date_lt?: string; date_lte?: string; is_ad_hoc_returned?: boolean }): Promise<SDKResult>;
+    getPurchase(purchaseId: string): Promise<SDKResult>;
+    requestOTPSpend(params?: { intent?: string; spend_amount?: number }): Promise<SDKResult>;
+    getOTPSpend(params?: { intent?: string; community_id?: string }): Promise<SDKResult>;
+    onChangePassword(params: { password: string }): Promise<SDKResult>;
+    getNameDayRules(params?: { first_name?: string }): Promise<SDKResult>;
+    addApplicationUsage(applicationId: string, platform: string): Promise<SDKResult>;
+    requestContactToken(params: { intent?: string; spend_amount?: number; community_id?: string }): Promise<SDKResult>;
+    getContactTokens(params?: { intent?: string; community_id?: string }): Promise<SDKResult>;
+    addPNDeviceToken(params?: { serial_number?: string; registration_token?: string; mac_address?: string; platform?: string; product_id?: string; application_id?: string; electronic_id?: string }): Promise<SDKResult>;
+    deleteDeviceToken(params?: { registration_token?: string }): Promise<SDKResult>;
+    uploadProfileImage(params?: { file: any; disalbedContentType?: boolean }): Promise<SDKResult>;
+    deleteProfileImage(): Promise<SDKResult>;
+    getApplePass(orgId?: string): Promise<SDKResult>;
+    getAndroidWalletPass(orgId?: string): Promise<SDKResult>;
+    getGooglePass(orgId?: string): Promise<SDKResult>;
+    exportStatements(params: { account_id?: string; from_month?: number; to_month?: number; from_year?: number; to_year?: number; format?: string }): Promise<SDKResult>;
+    getContactDonationsOffer(params: { contact_id?: string; page?: number; size?: number; include_opt_out?: boolean; include_total?: boolean; order?: string; sort?: string; donation_offer_id?: string }): Promise<SDKResult>;
+    getDonationHistory(params: { contact_id?: string; include_total?: boolean; order?: string; organisation_id?: string; page?: number; size?: number; sort?: string }): Promise<SDKResult>;
+    donationActions(params: { contact_id?: string; donation_offer_id: string; multiplier?: number; amount?: number }): Promise<SDKResult>;
+    updateDonation(params: { contact_id?: string; donation_id: string; donation_offer_id: string; multiplier?: number; amount?: number }): Promise<SDKResult>;
+    removeDonation(params: { contact_id?: string; donation_id: string }): Promise<SDKResult>;
+    getDonationOffers(params?: PaginationParams & { organisations?: string; owner?: string; search_value?: string; types?: string; donated_to?: string; donation_offer_id?: string; donation_types?: string }): Promise<SDKResult>;
+    getDonationOrganisations(params: { include_creatives?: boolean; type?: string }): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Orders
+// ============================================================================
+
+export declare const orders: {
+    getMyOrders(params?: PaginationParams & { custom_fields?: string; include_custom_fields?: boolean; completed_on_gte?: string; completed_on_lte?: string; state?: string; supply_method?: string }): Promise<SDKResult>;
+    getOrder(id: string): Promise<SDKResult>;
+    getOrderCatalogues(params?: { search_value?: string; fulfilled_by?: string; supply_method?: string; ordering_time?: string; page?: number; size?: number; sort?: string; order?: string }): Promise<SDKResult>;
+    getOrderCatalogueCategories(params: { search_value?: string; parent_id?: string; return_all?: boolean; include_total?: boolean; page?: number; size?: number; sort?: string; order?: string }, catalogId: string): Promise<SDKResult>;
+    getProductCategories(params?: { available_in_order_menus?: boolean; include_total?: boolean; organisation_id?: string; parent_id?: string; return_all?: boolean; page?: number; size?: number; sort?: string; order?: string }): Promise<SDKResult>;
+    getProducts(params?: { product_ids?: string; product_skus?: string; brand_id?: string; category_id?: string; classification?: string; composition?: string; country?: string; currency?: string; custom_fields?: string; family_id?: string; fulfilled_by?: string; include_custom_fields?: boolean; include_total?: boolean; is_modifier?: boolean; name?: string; order_catalog_id?: string; order_category_id?: string; owned_by?: string; search_value?: string; supply_method?: string; type_id?: string; page?: number; size?: number; sort?: string; order?: string }): Promise<SDKResult>;
+    getProductsWithFacets(params?: Record<string, any>): Promise<SDKResult>;
+    getProduct(id: string, params: { fulfilled_by?: string; supply_method?: string }): Promise<SDKResult>;
+    getProductVariants(params: { fulfilled_by?: string; supply_method?: string; include_characteristics?: boolean }, productId: string): Promise<SDKResult>;
+    getProductComponents(productId: string, params: { fulfilled_by?: string; supply_method?: string }): Promise<SDKResult>;
+    estimateOrderFulfillment(params: { supply_method?: string; postal_code?: string; lat_lot?: any; address_id?: string; requested_delivery_at?: string; requested_organisation_id?: string; is_open?: boolean; country_code?: string; contact_id?: string }): Promise<SDKResult>;
+    estimateOrder(params?: { account_id?: string; supply_method?: string; fulfilled_by?: string; requested_delivery_at?: string; address_id?: string; notes?: string; queue_id?: string; use_wallet_funds?: boolean; wallet_funds_amount?: number; payment_method_type?: string; discount?: any; milestones?: any; line_items?: any[]; current_location?: any; estimation_id?: string }): Promise<SDKResult>;
+    makeOrder(params: { estimation_id: string; use_wallet_funds?: boolean; wallet_funds_amount?: number; notes?: string; intent_id?: string; use_account_funds?: boolean; account_funds_amount?: number; payments?: any[]; devices?: any[]; custom_fields?: any[]; pass?: any }): Promise<SDKResult>;
+    getOrdersRecommendation(params?: { estimation_id?: string; include_creatives?: boolean; include_cross_sells?: boolean; include_upsells?: boolean; include_reward_offers?: boolean; include_promotions?: boolean; order_catalogue_ids?: string }): Promise<SDKResult>;
+    getServicesRecommendation(params?: Record<string, any>): Promise<SDKResult>;
+    getProductTypes(params?: PaginationParams & { classifications?: string; name?: string; search_value?: string }): Promise<SDKResult>;
+    getProductBrands(params?: PaginationParams & { brand_ids?: string; search_value?: string }): Promise<SDKResult>;
+    getProductsRecommendation(params?: { contact_id?: string; size?: number; category_type?: string; category_id?: string }): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Wallet
+// ============================================================================
+
+export declare const wallet: {
+    getWallet(walletId?: string): Promise<SDKResult>;
+    getWalletId(): Promise<string | null>;
+    getWalletCode(walletId?: string): Promise<SDKResult>;
+    createCRMWallet(params: { type: string; value: string; country_code?: string }): Promise<SDKResult>;
+    requestWalletOtp(params: { type: string; value: string; country_code?: string }): Promise<SDKResult>;
+    linkCRMWallet(otp: string): Promise<SDKResult>;
+    getWalletConditionsBalances(params?: { page?: number; size?: number; order?: string; sort?: string; commerce_pool_id?: string; include_expiration?: boolean; include_total?: boolean; is_active?: boolean }, walletId?: string): Promise<SDKResult>;
+    getWalletTransactions(params?: PaginationParams & { pocket?: string; type?: string; posted_on?: string; posted_on_gt?: string; posted_on_gte?: string; posted_on_lt?: string; posted_on_lte?: string; commerce_pool_id?: string }, walletId?: string): Promise<SDKResult>;
+    topupWallet(params: { payment_method_id: string; amount: number; wallet_id?: string; client_secret?: string; commerce_pool_id?: string }): Promise<SDKResult>;
+    updateWallet(params?: { auto_topup?: any; termed_topup?: any; wallet_id?: string }): Promise<SDKResult>;
+    getWalletTopupSetting(walletId?: string): Promise<SDKResult>;
+    getWalletLimit(walletId?: string): Promise<SDKResult>;
+    updateWalletLimit(params?: { limit_rules?: any; wallet_id?: string }): Promise<SDKResult>;
+    transferMoney(params: { origin_wallet_id: string; destination_wallet_id: string; amount: number; cash_pocket?: string }): Promise<SDKResult>;
+    getWalletJounals(params?: PaginationParams & { commerce_pool_id?: string; is_commerce?: boolean; is_open?: boolean; is_wallet_fee?: boolean; posted_on?: string; posted_on_gt?: string; posted_on_gte?: string; posted_on_lt?: string; posted_on_lte?: string; include_unallocated_credit?: boolean; type?: string }, walletId?: string): Promise<SDKResult>;
+    getWalletSummarisedTotals(params?: { posted_on?: string; posted_on_gt?: string; posted_on_gte?: string; posted_on_lt?: string; posted_on_lte?: string }, walletId?: string): Promise<SDKResult>;
+    activateDeactivateCommercePool(params: { commerce_pool_id: string; action: string }): Promise<SDKResult>;
+    verifyWalletExists(params?: { type?: string; value?: string }): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Payment
+// ============================================================================
+
+export declare const payment: {
+    getListPaymentMethods(params?: PaginationParams & { support_payouts?: boolean; financial_types?: string; is_rewards?: boolean }): Promise<SDKResult>;
+    addPaymentMethod(params: { name?: string; contact_id?: string; is_primary?: boolean; is_backup?: boolean; payment_method_type: string; notes?: string; email?: string; phone?: string; country_code?: string; card_info?: any; gateway_name?: string; gateway_token: string; integration_id: string }, extra: {}): Promise<SDKResult>;
+    addPaymentMethodV2(params: { name?: string; is_primary?: boolean; payment_method_type: string; account_debit?: any; wallet?: any; card?: any; contact_id?: string }): Promise<SDKResult>;
+    removePaymentMethod(paymentMethodId: string): Promise<SDKResult>;
+    createPaymentForm(params: { topup_amount?: number; payment_method_id?: string; redirect_url?: string; estimation_id?: string }): Promise<SDKResult>;
+    createFormToAddCard(redirectUrl?: string): Promise<SDKResult>;
+    setPrimaryCard(paymentMethodId: string): Promise<SDKResult>;
+    getFormAddCard(params: { integration_id?: string; device_type?: string; redirect_url?: string; currency_code?: string; back_url?: string; back_url_name?: string }): Promise<SDKResult>;
+    getPaymentForm(params: Record<string, any>): Promise<SDKResult>;
+    createTopup(params: { amount: number; wallet_id?: string; code?: string; payment_method?: any; client_secret?: string; commerce_pool_id?: string }): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Subscriptions
+// ============================================================================
+
+export declare const subscriptions: {
+    getListSubscriptions(params?: { page?: number; size?: number; include_terms?: boolean; include_billing_info?: boolean }): Promise<SDKResult>;
+    getListContactServices(params?: PaginationParams & { classification?: string; include_future_info?: boolean; include_order_info?: boolean; include_subscription?: boolean; subscription_id?: string }): Promise<SDKResult>;
+    getListContactDevices(params?: PaginationParams & { owned_by_contact?: boolean; search_value?: string; serial_number?: string; include_custom_fields?: boolean; include_subscription?: boolean; include_characteristics?: boolean }): Promise<SDKResult>;
+    getListContactSharedDevices(params?: PaginationParams & { search_value?: string; serial_number?: string; include_custom_fields?: boolean; include_subscription?: boolean; include_characteristics?: boolean }): Promise<SDKResult>;
+    updateDevice(body: Record<string, any>, id: string): Promise<SDKResult>;
+    updateServices(params: { action: string; category_id?: string; scheduled_date?: string; use_proposed_date?: boolean; number_of_days?: number; quantity?: number; renewal_opt_in?: boolean; price_terms_id?: string; extend_contract?: boolean; change_to_service?: any; components?: any[]; trial_end_date?: string; enabled_devices?: any[] }, id: string): Promise<SDKResult>;
+    getProductsTier(params: { prodId: string; change_type?: string; page?: number; size?: number; contact_id?: string }): Promise<SDKResult>;
+    onServiceDelivery(params: { action: string; services_to_change: any[]; subscription_id?: string }): Promise<SDKResult>;
+    onEstimateBilling(params: { account_id: string; upcoming_billing_cycles?: number }): Promise<SDKResult>;
+    onUpdateServiceWithBody(serviceId: string, body: Record<string, any>): Promise<SDKResult>;
+    updateSubscription(params?: { action?: string; payment_method_id?: string; billing_day?: number; funding_source?: string }, id?: string): Promise<SDKResult>;
+    getServiceRescommendation(params: Record<string, any>): Promise<SDKResult>;
+    getSubscriptionAction(params: { action_id: string }): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Rewards
+// ============================================================================
+
+export declare const rewards: {
+    getRewards(): Promise<SDKResult>;
+    getOffers(params?: PaginationParams & { countries?: string; industry?: string; industry_sector?: string; organisations?: string; owner?: string; performance_enabled?: boolean; tags?: string; towns_cities?: string; reward_offer_tags?: string; lat?: number; lon?: number; is_featured?: boolean; search_value?: string; types?: string }): Promise<SDKResult>;
+    getPerformanceOffer(offerId: string): Promise<SDKResult>;
+    getListPromotions(params?: PaginationParams & { organisations?: string; promotion_tags?: string; search_value?: string }): Promise<SDKResult>;
+    getPromotion(id: string): Promise<SDKResult>;
+    searchRewardSchemes(params?: PaginationParams & { is_signed?: boolean; name?: string }): Promise<SDKResult>;
+    verifyClosedLoopScheme(params: { sign_up_code: string }): Promise<SDKResult>;
+    sendRefferals(params?: { recipients?: any[]; action?: string }): Promise<SDKResult>;
+    redeemPass(params?: { code?: string; pin?: string; wallet_id?: string }): Promise<SDKResult>;
+    reclaimPurchase(params?: { purchase_id?: string; merchant_tap?: string; venue_tap?: string; net_amount?: number; tax_amount?: number; discount_amount?: number; total_amount?: number; transaction_code?: string }): Promise<SDKResult>;
+    signUpRewardScheme(params: { reward_scheme_id: string; email_address?: string; sign_up_code?: string }): Promise<SDKResult>;
+    signOutRewardScheme(params: { reward_scheme_id: string }): Promise<SDKResult>;
+    getOfferDetail(offerId: string): Promise<SDKResult>;
+    getDonationDetail(donationId: string): Promise<SDKResult>;
+    getPassPlans(params?: { page?: number; size?: number }): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Account
+// ============================================================================
+
+export declare const account: {
+    getPrimaryAccount(): Promise<SDKResult>;
+    getAccount(accountId: string): Promise<SDKResult>;
+    getAccountJournals(params?: PaginationParams & { from_date?: string; to_date?: string; transaction_type?: string; type?: string }, accountId?: string): Promise<SDKResult>;
+    getAccountJournal(id: string): Promise<SDKResult>;
+    getAccountRewards(accountId?: string, includeRewards?: boolean): Promise<SDKResult>;
+    getAccountBalance(): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Communications
+// ============================================================================
+
+export declare const communications: {
+    getCommunications(params?: PaginationParams & { archived?: boolean; channel?: string; viewed?: boolean; created_on_gte?: string; created_on_lte?: string }): Promise<SDKResult>;
+    getCommunication(id: string): Promise<SDKResult>;
+    markReadCommunication(id: string): Promise<SDKResult>;
+    deleteCommunication(commId: string): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Community
+// ============================================================================
+
+export declare const community: {
+    getListJoinedCommunities(params?: PaginationParams, contactId?: string): Promise<SDKResult>;
+    getListCommunityPeople(params?: PaginationParams, contactId?: string): Promise<SDKResult>;
+    getCommunityPeople(peopleId: string): Promise<SDKResult>;
+    addCommunityPeople(params: { email?: string; phone_number?: string; country_code?: string; relation_id?: string; is_admin?: boolean; permissions?: any; group?: any; contact?: any }, contactId?: string): Promise<SDKResult>;
+    updateCommunityPeople(params: { relation_id?: string; is_admin?: boolean; permissions?: any; wallet_sharing?: any; usage_allowance?: any; group?: any; devices?: any[] }, peopleId: string): Promise<SDKResult>;
+    deleteCommunityPeople(peopleId: string): Promise<SDKResult>;
+    getCommunityRelations(params?: PaginationParams & { name?: string }): Promise<SDKResult>;
+    switchRole(communityId: string, isMerchant?: boolean): Promise<SDKResult>;
+    leaveCommunity(communityId: string): Promise<SDKResult>;
+    getContactGroups(): Promise<SDKResult>;
+    updateContactGroups(body: Record<string, any>, name: string): Promise<SDKResult>;
+    getCommunityMembers(params?: PaginationParams & { owner_id?: string; group?: string }): Promise<SDKResult>;
+    getCommunityMember(ownerId: string, memberId: string): Promise<SDKResult>;
+    acceptRejectCommunityInvitation(body: Record<string, any>, ownerId: string, relationId: string): Promise<SDKResult>;
+    deleteCommunityRelationship(ownerId: string, relationId: string): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Config
+// ============================================================================
+
+export declare const config: {
+    getAppCfg(params?: { app_id?: string; use_cname?: boolean; cname?: string }): Promise<SDKResult>;
+    getApplicationTranslations(params: { application_id: string }): Promise<SDKResult>;
+    getIndustries(params?: PaginationParams & { name?: string }): Promise<SDKResult>;
+    getIndustrySectors(params?: PaginationParams & { industry_name?: string; industry_sector_ids?: string; name?: string }): Promise<SDKResult>;
+    getTownCities(): Promise<SDKResult>;
+    getOrganisationTags(params?: PaginationParams & { industry?: string; industry_sector?: string }): Promise<SDKResult>;
+    getTags(params?: PaginationParams & { entity?: string; search_value?: string }): Promise<SDKResult>;
+    getLanguages(params: { unauthorize?: boolean }): Promise<SDKResult>;
+    findAddress(params?: { integration?: string; input?: string; session_id?: string }): Promise<SDKResult>;
+    getAddress(params?: { integration?: string; google_place_id?: string; session_id?: string; latlng?: string }): Promise<SDKResult>;
+    findAddressV1(params?: { integration?: string; address?: string; latlng?: string }): Promise<SDKResult>;
+    getIntegrations(params: { connector?: string; finance?: string; payment_method?: string; rewards?: string; transactions?: string; type?: string }, id: string): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Organisations
+// ============================================================================
+
+export declare const organisations: {
+    searchOrganisations(params?: PaginationParams & Record<string, any>, orgId?: string): Promise<SDKResult>;
+    getLocations(params?: PaginationParams & { lat?: number; lon?: number; business_activities?: string; include_creatives?: boolean; include_opening_hours?: boolean; industries?: string; industry_sectors?: string; is_open?: boolean; name?: string; supply_method?: string; tags?: string; town_cities?: string; within?: number; include_custom_fields?: boolean; custom_fields?: string; organisation_id?: string }): Promise<SDKResult>;
+    getOrganisation(id: string): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Service Requests
+// ============================================================================
+
+export declare const servicerequest: {
+    getListServiceRequests(params?: PaginationParams & { search_value?: string; states?: string; queue_id?: string }): Promise<SDKResult>;
+    createServiceRequest(params: { description: string; queue_id?: string; categories?: any[]; address_id?: string; other_address?: any }): Promise<SDKResult>;
+    addServiceRequestAttachment(params: { file_id: string; description?: string; service_request_id: string }): Promise<SDKResult>;
+    deleteServiceRequestAttachment(params: { file_id: string; service_request_id: string }): Promise<SDKResult>;
+    getListServiceRequestAttachment(params?: PaginationParams, id?: string): Promise<SDKResult>;
+    uploadFiles(params?: { file: any; disalbedContentType?: boolean }): Promise<SDKResult>;
+    getListServiceRequestQueues(params?: { state?: string; name?: string; search_value?: string }): Promise<SDKResult>;
+    getListServiceRequestNotes(params?: PaginationParams, id?: string): Promise<SDKResult>;
+    createServiceRequestNote(params: { note: string; service_request_id: string }): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Specialized Modules
+// ============================================================================
+
+export declare const connectx: {
+    getBuckets(serialNumber: string): Promise<SDKResult>;
+    simConfirmation(body: Record<string, any>, serialNumber: string): Promise<SDKResult>;
+    simActivation(body: Record<string, any>, serialNumber: string): Promise<SDKResult>;
+    simDownload(body?: Record<string, any>): Promise<SDKResult>;
+    portIn(body: Record<string, any>): Promise<SDKResult>;
+};
+
+export declare const jcccards: {
+    addCard(number: string): Promise<SDKResult>;
+};
+
+export declare const mobilepass: {
+    getGooglePass(params: { contact_id?: string; organisation_id?: string }, extra: {}): Promise<SDKResult>;
+    getApplePass(params: { contact_id?: string; organisation_id?: string }, extra: {}): Promise<SDKResult>;
+    getAndroidWalletPass(params: { contact_id?: string; organisation_id?: string }, extra: {}): Promise<SDKResult>;
+};
+
+export declare const paymentgateway: {
+    getClientToken(params?: { integration_id?: string }): Promise<SDKResult>;
+};
+
+export declare const payouts: {
+    createPayout(params: { wallet_id?: string; amount: number; payment_method: any }): Promise<SDKResult>;
+};
+
+// ============================================================================
+// Event Listener
+// ============================================================================
+
+export declare const eventTypes: {
+    kochava: 'KOCHAVA';
+};
+
+export declare const eventListener: {
+    handleEvent(params: { type: string; code: string; data: any; object_type: string }): Promise<void>;
+};
+
+// ============================================================================
+// Data Utilities
+// ============================================================================
+
+export declare const dataUtil: {
+    [key: string]: (...args: any[]) => any;
+};

package/index.js

@@ -0,0 +1,24 @@
+export { httpUtil } from './httpUtil.js';
+export { httpBackOfficeUtil } from './httpBackOfficeUtil.js';
+export { authentication } from './authentication.js';
+export { contacts } from './contacts.js';
+export { orders } from './orders.js';
+export { wallet } from './wallet.js';
+export { payment } from './payment.js';
+export { subscriptions } from './subscriptions.js';
+export { rewards } from './rewards.js';
+export { account } from './account.js';
+export { communications } from './communications.js';
+export { community } from './community.js';
+export { config } from './config.js';
+export { connectx } from './connectx.js';
+export { organisations } from './organisations.js';
+export { servicerequest } from './servicerequest.js';
+export { jcccards } from './jcccards.js';
+export { mobilepass } from './mobilepass.js';
+export { paymentgateway } from './paymentgateway.js';
+export { payouts } from './payouts.js';
+export { dataUtil } from './dataUtil.js';
+export { ErrorCodes, createResult, createCommonResult } from './resultUtil.js';
+export { eventListener, eventTypes } from './eventListener.js';
+export { logger } from './logger.js';