@commercelayer/sdk-utils/lib/resources/webhooks.d.ts

Commerce Layer Javascript SDK Utils library

import { Resource, Address, Authorization, AvalaraAccount, Bundle, BuyXPayYPromotion, Capture, Cleanup, Coupon, CustomerAddress, CustomerPasswordReset, CustomerSubscription, Customer, Export, ExternalPromotion, FixedAmountPromotion, FixedPricePromotion, FreeGiftPromotion, FreeShippingPromotion, GiftCard, Import, InStockSubscription, LineItem, LineItemOption, Order, OrderCopy, OrderSubscription, Parcel, PercentageDiscountPromotion, PriceFrequencyTier, PriceVolumeTier, Promotion, RecurringOrderCopy, Refund, Return, Shipment, ShippingWeightTier, Sku, SkuOption, StockTransfer, Transaction, Void } from '@commercelayer/sdk';

declare const denormalizePayload: <R extends Resource>(payload: string) => R | R[];
type CheckStatus = {
    ok: boolean;
    topic?: string;
    message?: string;
};
/**
 *
 * @param body the webhook body
 * @param headers all headers map or value of the signature header
 * @param secret the shared secret string
 * @returns
 */
declare const checkSignature: (body: string, headers: Record<string, string> | string, secret: string) => CheckStatus;
declare const webhooks: {
    denormalizePayload: <R extends Resource>(payload: string) => R | R[];
    checkSignature: (body: string, headers: Record<string, string> | string, secret: string) => CheckStatus;
    parse: {
        addresses(payload: string): Address;
        authorizations(payload: string): Authorization;
        avalara_accounts(payload: string): AvalaraAccount;
        bundles(payload: string): Bundle;
        buy_x_pay_y_promotions(payload: string): BuyXPayYPromotion;
        captures(payload: string): Capture;
        cleanups(payload: string): Cleanup;
        coupons(payload: string): Coupon;
        customer_addresses(payload: string): CustomerAddress;
        customer_password_resets(payload: string): CustomerPasswordReset;
        customer_subscriptions(payload: string): CustomerSubscription;
        customers(payload: string): Customer;
        exports(payload: string): Export;
        external_promotions(payload: string): ExternalPromotion;
        fixed_amount_promotions(payload: string): FixedAmountPromotion;
        fixed_price_promotions(payload: string): FixedPricePromotion;
        free_gift_promotions(payload: string): FreeGiftPromotion;
        free_shipping_promotions(payload: string): FreeShippingPromotion;
        gift_cards(payload: string): GiftCard;
        imports(payload: string): Import;
        in_stock_subscriptions(payload: string): InStockSubscription;
        line_items(payload: string): LineItem;
        line_items_options(payload: string): LineItemOption;
        orders(payload: string): Order;
        order_copies(payload: string): OrderCopy;
        order_subscriptions(payload: string): OrderSubscription;
        parcels(payload: string): Parcel | Parcel[];
        percentage_discount_promotions(payload: string): PercentageDiscountPromotion;
        price_frequency_tiers(payload: string): PriceFrequencyTier;
        price_volume_tiers(payload: string): PriceVolumeTier;
        promotions(payload: string): Promotion;
        recurring_order_copies(payload: string): RecurringOrderCopy;
        refunds(payload: string): Refund;
        returns(payload: string): Return;
        shipments(payload: string): Shipment;
        shipping_weight_tiers(payload: string): ShippingWeightTier;
        skus(payload: string): Sku;
        sku_options(payload: string): SkuOption;
        stock_transfers(payload: string): StockTransfer;
        transactions(payload: string): Transaction;
        voids(payload: string): Void;
    };
};

export { checkSignature, denormalizePayload, webhooks };