Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
import { applyDecorators, UseInterceptors } from '@nestjs/common';
import { ApiHeader, ApiResponse } from '@nestjs/swagger';
import { SendIdempotencyInterceptor } from './send-idempotency.interceptor';
export const IDEMPOTENCY_KEY_HEADER_DESCRIPTION =
'Optional. Makes the send safe to retry: within 24 hours, a retry with the same key and body replays ' +
'the first response (marked `Idempotent-Replayed: true`) instead of sending again. 1-255 visible ' +
'ASCII characters, unique per session. While the first request runs a retry gets 409 ' +
'`IDEMPOTENCY_KEY_IN_PROGRESS`; after a failure that may have sent the message it gets 409 ' +
'`IDEMPOTENCY_OUTCOME_UNKNOWN`. A 4xx or 501 refusal before the engine call frees the key. ' +
'Errors from an engine send keep it taken regardless of HTTP status, including 409.';
/**
* Marks a send route as accepting the opt-in `Idempotency-Key` header: wires the interceptor and
* documents the header and the 422 it can add. The 409 codes share the route's existing 409 entry,
* since the contract keeps one entry per status.
*/
export const IdempotentSend = (): MethodDecorator =>
applyDecorators(
UseInterceptors(SendIdempotencyInterceptor),
ApiHeader({ name: 'Idempotency-Key', required: false, description: IDEMPOTENCY_KEY_HEADER_DESCRIPTION }),
ApiResponse({
status: 422,
description: '`IDEMPOTENCY_KEY_REUSED`: the Idempotency-Key was already used with a different route or body.',
}),
);