Papier
Get started
InterfaceSDK v0.3.0

BuiltPushPayload

import type { BuiltPushPayload } from '@usepapier/client/base';

Declaration #

types.tsTypeScript
export interface BuiltPushPayload<TData = Record<string, unknown>> extends PushUserInput<TData> {
    type: "push_notification";
    templateName: string;
    projectName: string;
    resolvedVersion?: string;
    baselineVersion?: string;
    contractMajor?: number;
    versionRange?: string;
    environmentId?: string;
    schemaHash: string;
    locale: string;
    environment: string;
}

Source: packages/client/src/push/types.ts:73

Members 17

type

type: "push_notification";

packages/client/src/push/types.ts:74

templateName

templateName: string;

packages/client/src/push/types.ts:75

projectName

projectName: string;

packages/client/src/push/types.ts:76

resolvedVersion

Optional
resolvedVersion?: string;

packages/client/src/push/types.ts:77

baselineVersion

Optional
baselineVersion?: string;

packages/client/src/push/types.ts:78

contractMajor

Optional
contractMajor?: number;

packages/client/src/push/types.ts:79

versionRange

Optional
versionRange?: string;

packages/client/src/push/types.ts:80

environmentId

Optional
environmentId?: string;

packages/client/src/push/types.ts:81

schemaHash

schemaHash: string;

packages/client/src/push/types.ts:82

locale

locale: string;

packages/client/src/push/types.ts:83

environment

environment: string;

packages/client/src/push/types.ts:84

to

From PushUserInput
to: PushTarget;

packages/client/src/push/types.ts:36

data

From PushUserInput
data: TData;

packages/client/src/push/types.ts:37

ttl

OptionalFrom PushDeliveryOptions
ttl?: number | undefined;

packages/client/src/push/types.ts:27

urgency

OptionalFrom PushDeliveryOptions
urgency?: "very-low" | "low" | "normal" | "high" | undefined;

packages/client/src/push/types.ts:28

topic

OptionalFrom PushDeliveryOptions

RFC 8030 replacement topic, at most 32 URL-safe characters (Web Push only).

topic?: string | undefined;

packages/client/src/push/types.ts:30

idempotencyKey

OptionalFrom PushDeliveryOptions

Makes a retried send safe when delivering through Papier.

idempotencyKey?: string | undefined;

packages/client/src/push/types.ts:32

Generated from TypeScript source.b1e9ee529902