@pyric/cli 0.1.0-alpha.11 → 0.1.0-alpha.12

package/dist/serve/docs-ui/docs/pyric-admin-messaging-reference-api.md

@@ -0,0 +1,706 @@
+<!-- Generated from published package declarations via TypeDoc. Rendered by the api-reference content loader. -->
+
+## Classes
+
+<a id="firebasemessagingerror"></a>
+
+### FirebaseMessagingError
+
+#### Extends
+
+- `Error`
+
+#### Constructors
+
+<a id="constructor"></a>
+
+##### Constructor
+
+```ts
+new FirebaseMessagingError(info: ErrorCodeInfo, message?: string): FirebaseMessagingError;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `info` | `ErrorCodeInfo` |
+| `message?` | `string` |
+
+###### Returns
+
+[`FirebaseMessagingError`](#firebasemessagingerror)
+
+###### Overrides
+
+```ts
+Error.constructor
+```
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="code"></a> `code` | `readonly` | `string` |
+
+***
+
+<a id="messaging"></a>
+
+### Messaging
+
+The sandbox `Messaging` service mirror, implementing the send plane over
+the broker.
+
+#### Constructors
+
+<a id="constructor-1"></a>
+
+##### Constructor
+
+```ts
+new Messaging(app: SandboxAdminApp): Messaging;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app` | [`SandboxAdminApp`](pyric-admin-app-reference-api.md#sandboxadminapp) |
+
+###### Returns
+
+[`Messaging`](#messaging)
+
+#### Accessors
+
+<a id="app"></a>
+
+##### app
+
+###### Get Signature
+
+```ts
+get app(): SandboxAdminApp;
+```
+
+The app this `Messaging` instance is bound to (upstream `get app(): App`).
+
+###### Returns
+
+[`SandboxAdminApp`](pyric-admin-app-reference-api.md#sandboxadminapp)
+
+#### Methods
+
+<a id="enablelegacyhttptransport"></a>
+
+##### enableLegacyHttpTransport()
+
+```ts
+enableLegacyHttpTransport(): void;
+```
+
+Force HTTP/1.1 for batch sends — deprecated upstream; the sandbox has
+no HTTP transport, so this is a recorded no-op.
+
+###### Returns
+
+`void`
+
+<a id="send"></a>
+
+##### send()
+
+```ts
+send(message: Message, dryRun?: boolean): Promise<string>;
+```
+
+Send one message. Resolves the FCM resource name
+`projects/<projectId>/messages/<id>` — numeric id for topic/condition
+targets, UUID-form for token targets. `dryRun` validates on the
+identical path and returns the SAME shape with a fake id (captured
+`dryRunSameShapeAsReal` / `realSendEnvelopeIdentical` parity).
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `message` | [`Message`](#message) |
+| `dryRun?` | `boolean` |
+
+###### Returns
+
+`Promise`\<`string`\>
+
+<a id="sendeach"></a>
+
+##### sendEach()
+
+```ts
+sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
+```
+
+Send up to 500 messages; the resolved `BatchResponse.responses` array is
+ordered to match the input, one entry per message.
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `messages` | [`Message`](#message)[] |
+| `dryRun?` | `boolean` |
+
+###### Returns
+
+`Promise`\<[`BatchResponse`](#batchresponse)\>
+
+<a id="sendeachformulticast"></a>
+
+##### sendEachForMulticast()
+
+```ts
+sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
+```
+
+Fan a `MulticastMessage` (up to 500 tokens) out through [sendEach](#sendeach).
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `message` | [`MulticastMessage`](#multicastmessage) |
+| `dryRun?` | `boolean` |
+
+###### Returns
+
+`Promise`\<[`BatchResponse`](#batchresponse)\>
+
+<a id="subscribetotopic"></a>
+
+##### subscribeToTopic()
+
+```ts
+subscribeToTopic(tokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
+```
+
+Subscribe one or many registration tokens to a topic.
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `tokenOrTokens` | `string` \| `string`[] |
+| `topic` | `string` |
+
+###### Returns
+
+`Promise`\<[`MessagingTopicManagementResponse`](#messagingtopicmanagementresponse)\>
+
+<a id="unsubscribefromtopic"></a>
+
+##### unsubscribeFromTopic()
+
+```ts
+unsubscribeFromTopic(tokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
+```
+
+Unsubscribe one or many registration tokens from a topic.
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `tokenOrTokens` | `string` \| `string`[] |
+| `topic` | `string` |
+
+###### Returns
+
+`Promise`\<[`MessagingTopicManagementResponse`](#messagingtopicmanagementresponse)\>
+
+***
+
+<a id="messagingclienterrorcode"></a>
+
+### MessagingClientErrorCode
+
+#### Constructors
+
+<a id="constructor-2"></a>
+
+##### Constructor
+
+```ts
+new MessagingClientErrorCode(): MessagingClientErrorCode;
+```
+
+###### Returns
+
+[`MessagingClientErrorCode`](#messagingclienterrorcode)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="invalid_argument"></a> `INVALID_ARGUMENT` | `readonly` | \{ `code`: `string`; `message`: `string`; \} |
+| `INVALID_ARGUMENT.code` | `public` | `string` |
+| `INVALID_ARGUMENT.message` | `public` | `string` |
+| <a id="invalid_registration_token"></a> `INVALID_REGISTRATION_TOKEN` | `readonly` | \{ `code`: `string`; `message`: `string`; \} |
+| `INVALID_REGISTRATION_TOKEN.code` | `public` | `string` |
+| `INVALID_REGISTRATION_TOKEN.message` | `public` | `string` |
+| <a id="registration_token_not_registered"></a> `REGISTRATION_TOKEN_NOT_REGISTERED` | `readonly` | \{ `code`: `string`; `message`: `string`; \} |
+| `REGISTRATION_TOKEN_NOT_REGISTERED.code` | `public` | `string` |
+| `REGISTRATION_TOKEN_NOT_REGISTERED.message` | `public` | `string` |
+
+## Interfaces
+
+<a id="basemessage"></a>
+
+### BaseMessage
+
+#### Extends
+
+- `Omit`\<`BrokerMessage`, `"token"` \| `"topic"` \| `"condition"`\>
+
+#### Extended by
+
+- [`TokenMessage`](#tokenmessage)
+- [`TopicMessage`](#topicmessage)
+- [`ConditionMessage`](#conditionmessage)
+- [`MulticastMessage`](#multicastmessage)
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="android"></a> `android?` | `Record`\<`string`, `unknown`\> |
+| <a id="apns"></a> `apns?` | `Record`\<`string`, `unknown`\> |
+| <a id="data"></a> `data?` | `Record`\<`string`, `string`\> |
+| <a id="fcmoptions"></a> `fcmOptions?` | \{ `analyticsLabel?`: `string`; \} |
+| `fcmOptions.analyticsLabel?` | `string` |
+| <a id="notification"></a> `notification?` | \{ `body?`: `string`; `imageUrl?`: `string`; `title?`: `string`; \} |
+| `notification.body?` | `string` |
+| `notification.imageUrl?` | `string` |
+| `notification.title?` | `string` |
+| <a id="webpush"></a> `webpush?` | \{ `data?`: `Record`\<`string`, `string`\>; `fcmOptions?`: \{ `link?`: `string`; \}; `headers?`: `Record`\<`string`, `string`\>; `notification?`: `Record`\<`string`, `unknown`\>; \} |
+| `webpush.data?` | `Record`\<`string`, `string`\> |
+| `webpush.fcmOptions?` | \{ `link?`: `string`; \} |
+| `webpush.fcmOptions.link?` | `string` |
+| `webpush.headers?` | `Record`\<`string`, `string`\> |
+| `webpush.notification?` | `Record`\<`string`, `unknown`\> |
+
+***
+
+<a id="batchresponse"></a>
+
+### BatchResponse
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="failurecount"></a> `failureCount` | `number` |
+| <a id="responses"></a> `responses` | [`SendResponse`](#sendresponse)[] |
+| <a id="successcount"></a> `successCount` | `number` |
+
+***
+
+<a id="conditionmessage"></a>
+
+### ConditionMessage
+
+#### Extends
+
+- [`BaseMessage`](#basemessage)
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="android-1"></a> `android?` | `Record`\<`string`, `unknown`\> |
+| <a id="apns-1"></a> `apns?` | `Record`\<`string`, `unknown`\> |
+| <a id="condition"></a> `condition` | `string` |
+| <a id="data-1"></a> `data?` | `Record`\<`string`, `string`\> |
+| <a id="fcmoptions-1"></a> `fcmOptions?` | \{ `analyticsLabel?`: `string`; \} |
+| `fcmOptions.analyticsLabel?` | `string` |
+| <a id="notification-1"></a> `notification?` | \{ `body?`: `string`; `imageUrl?`: `string`; `title?`: `string`; \} |
+| `notification.body?` | `string` |
+| `notification.imageUrl?` | `string` |
+| `notification.title?` | `string` |
+| <a id="webpush-1"></a> `webpush?` | \{ `data?`: `Record`\<`string`, `string`\>; `fcmOptions?`: \{ `link?`: `string`; \}; `headers?`: `Record`\<`string`, `string`\>; `notification?`: `Record`\<`string`, `unknown`\>; \} |
+| `webpush.data?` | `Record`\<`string`, `string`\> |
+| `webpush.fcmOptions?` | \{ `link?`: `string`; \} |
+| `webpush.fcmOptions.link?` | `string` |
+| `webpush.headers?` | `Record`\<`string`, `string`\> |
+| `webpush.notification?` | `Record`\<`string`, `unknown`\> |
+
+***
+
+<a id="messagingtopicmanagementresponse"></a>
+
+### MessagingTopicManagementResponse
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="errors"></a> `errors` | \{ `error`: [`FirebaseMessagingError`](#firebasemessagingerror); `index`: `number`; \}[] |
+| <a id="failurecount-1"></a> `failureCount` | `number` |
+| <a id="successcount-1"></a> `successCount` | `number` |
+
+***
+
+<a id="multicastmessage"></a>
+
+### MulticastMessage
+
+#### Extends
+
+- [`BaseMessage`](#basemessage)
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="android-2"></a> `android?` | `Record`\<`string`, `unknown`\> |
+| <a id="apns-2"></a> `apns?` | `Record`\<`string`, `unknown`\> |
+| <a id="data-2"></a> `data?` | `Record`\<`string`, `string`\> |
+| <a id="fcmoptions-2"></a> `fcmOptions?` | \{ `analyticsLabel?`: `string`; \} |
+| `fcmOptions.analyticsLabel?` | `string` |
+| <a id="notification-2"></a> `notification?` | \{ `body?`: `string`; `imageUrl?`: `string`; `title?`: `string`; \} |
+| `notification.body?` | `string` |
+| `notification.imageUrl?` | `string` |
+| `notification.title?` | `string` |
+| <a id="tokens"></a> `tokens` | `string`[] |
+| <a id="webpush-2"></a> `webpush?` | \{ `data?`: `Record`\<`string`, `string`\>; `fcmOptions?`: \{ `link?`: `string`; \}; `headers?`: `Record`\<`string`, `string`\>; `notification?`: `Record`\<`string`, `unknown`\>; \} |
+| `webpush.data?` | `Record`\<`string`, `string`\> |
+| `webpush.fcmOptions?` | \{ `link?`: `string`; \} |
+| `webpush.fcmOptions.link?` | `string` |
+| `webpush.headers?` | `Record`\<`string`, `string`\> |
+| `webpush.notification?` | `Record`\<`string`, `unknown`\> |
+
+***
+
+<a id="sendresponse"></a>
+
+### SendResponse
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="error"></a> `error?` | [`FirebaseMessagingError`](#firebasemessagingerror) |
+| <a id="messageid"></a> `messageId?` | `string` |
+| <a id="success"></a> `success` | `boolean` |
+
+***
+
+<a id="tokenmessage"></a>
+
+### TokenMessage
+
+#### Extends
+
+- [`BaseMessage`](#basemessage)
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="android-3"></a> `android?` | `Record`\<`string`, `unknown`\> |
+| <a id="apns-3"></a> `apns?` | `Record`\<`string`, `unknown`\> |
+| <a id="data-3"></a> `data?` | `Record`\<`string`, `string`\> |
+| <a id="fcmoptions-3"></a> `fcmOptions?` | \{ `analyticsLabel?`: `string`; \} |
+| `fcmOptions.analyticsLabel?` | `string` |
+| <a id="notification-3"></a> `notification?` | \{ `body?`: `string`; `imageUrl?`: `string`; `title?`: `string`; \} |
+| `notification.body?` | `string` |
+| `notification.imageUrl?` | `string` |
+| `notification.title?` | `string` |
+| <a id="token"></a> `token` | `string` |
+| <a id="webpush-3"></a> `webpush?` | \{ `data?`: `Record`\<`string`, `string`\>; `fcmOptions?`: \{ `link?`: `string`; \}; `headers?`: `Record`\<`string`, `string`\>; `notification?`: `Record`\<`string`, `unknown`\>; \} |
+| `webpush.data?` | `Record`\<`string`, `string`\> |
+| `webpush.fcmOptions?` | \{ `link?`: `string`; \} |
+| `webpush.fcmOptions.link?` | `string` |
+| `webpush.headers?` | `Record`\<`string`, `string`\> |
+| `webpush.notification?` | `Record`\<`string`, `unknown`\> |
+
+***
+
+<a id="topicmessage"></a>
+
+### TopicMessage
+
+#### Extends
+
+- [`BaseMessage`](#basemessage)
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="android-4"></a> `android?` | `Record`\<`string`, `unknown`\> |
+| <a id="apns-4"></a> `apns?` | `Record`\<`string`, `unknown`\> |
+| <a id="data-4"></a> `data?` | `Record`\<`string`, `string`\> |
+| <a id="fcmoptions-4"></a> `fcmOptions?` | \{ `analyticsLabel?`: `string`; \} |
+| `fcmOptions.analyticsLabel?` | `string` |
+| <a id="notification-4"></a> `notification?` | \{ `body?`: `string`; `imageUrl?`: `string`; `title?`: `string`; \} |
+| `notification.body?` | `string` |
+| `notification.imageUrl?` | `string` |
+| `notification.title?` | `string` |
+| <a id="topic"></a> `topic` | `string` |
+| <a id="webpush-4"></a> `webpush?` | \{ `data?`: `Record`\<`string`, `string`\>; `fcmOptions?`: \{ `link?`: `string`; \}; `headers?`: `Record`\<`string`, `string`\>; `notification?`: `Record`\<`string`, `unknown`\>; \} |
+| `webpush.data?` | `Record`\<`string`, `string`\> |
+| `webpush.fcmOptions?` | \{ `link?`: `string`; \} |
+| `webpush.fcmOptions.link?` | `string` |
+| `webpush.headers?` | `Record`\<`string`, `string`\> |
+| `webpush.notification?` | `Record`\<`string`, `unknown`\> |
+
+## Type Aliases
+
+<a id="androidconfig"></a>
+
+### AndroidConfig
+
+```ts
+type AndroidConfig = Record<string, unknown>;
+```
+
+***
+
+<a id="androidfcmoptions"></a>
+
+### AndroidFcmOptions
+
+```ts
+type AndroidFcmOptions = Record<string, unknown>;
+```
+
+***
+
+<a id="androidnotification"></a>
+
+### AndroidNotification
+
+```ts
+type AndroidNotification = Record<string, unknown>;
+```
+
+***
+
+<a id="apnsconfig"></a>
+
+### ApnsConfig
+
+```ts
+type ApnsConfig = Record<string, unknown>;
+```
+
+***
+
+<a id="apnsfcmoptions"></a>
+
+### ApnsFcmOptions
+
+```ts
+type ApnsFcmOptions = Record<string, unknown>;
+```
+
+***
+
+<a id="apnspayload"></a>
+
+### ApnsPayload
+
+```ts
+type ApnsPayload = Record<string, unknown>;
+```
+
+***
+
+<a id="aps"></a>
+
+### Aps
+
+```ts
+type Aps = Record<string, unknown>;
+```
+
+***
+
+<a id="apsalert"></a>
+
+### ApsAlert
+
+```ts
+type ApsAlert = string | Record<string, unknown>;
+```
+
+***
+
+<a id="criticalsound"></a>
+
+### CriticalSound
+
+```ts
+type CriticalSound = Record<string, unknown>;
+```
+
+***
+
+<a id="datamessagepayload"></a>
+
+### DataMessagePayload
+
+```ts
+type DataMessagePayload = Record<string, string>;
+```
+
+***
+
+<a id="fcmoptions-5"></a>
+
+### FcmOptions
+
+```ts
+type FcmOptions = NonNullable<BrokerMessage["fcmOptions"]>;
+```
+
+***
+
+<a id="lightsettings"></a>
+
+### LightSettings
+
+```ts
+type LightSettings = Record<string, unknown>;
+```
+
+***
+
+<a id="message"></a>
+
+### Message
+
+```ts
+type Message =
+  | TokenMessage
+  | TopicMessage
+  | ConditionMessage;
+```
+
+***
+
+<a id="messagingoptions"></a>
+
+### MessagingOptions
+
+```ts
+type MessagingOptions = Record<string, unknown>;
+```
+
+***
+
+<a id="messagingpayload"></a>
+
+### MessagingPayload
+
+```ts
+type MessagingPayload = Record<string, unknown>;
+```
+
+***
+
+<a id="notification-5"></a>
+
+### Notification
+
+```ts
+type Notification = NonNullable<BrokerMessage["notification"]>;
+```
+
+Mirror-owned structural messaging types.
+
+***
+
+<a id="notificationmessagepayload"></a>
+
+### NotificationMessagePayload
+
+```ts
+type NotificationMessagePayload = Record<string, string>;
+```
+
+***
+
+<a id="webpushconfig"></a>
+
+### WebpushConfig
+
+```ts
+type WebpushConfig = NonNullable<BrokerMessage["webpush"]>;
+```
+
+***
+
+<a id="webpushfcmoptions"></a>
+
+### WebpushFcmOptions
+
+```ts
+type WebpushFcmOptions = NonNullable<WebpushConfig["fcmOptions"]>;
+```
+
+***
+
+<a id="webpushnotification"></a>
+
+### WebpushNotification
+
+```ts
+type WebpushNotification = Record<string, unknown>;
+```
+
+## Functions
+
+<a id="getmessaging"></a>
+
+### getMessaging()
+
+```ts
+function getMessaging(app?: SandboxAdminApp): Messaging;
+```
+
+Return the broker-backed `Messaging` service for the default or given
+sandbox admin app.
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`SandboxAdminApp`](pyric-admin-app-reference-api.md#sandboxadminapp) |
+
+#### Returns
+
+[`Messaging`](#messaging)
+
+***
+
+<a id="messaging-1"></a>
+
+### messaging()
+
+```ts
+function messaging(app?: SandboxAdminApp): Messaging;
+```
+
+Namespaced / legacy accessor — the `admin.messaging(app?)` equivalent of
+[getMessaging](#getmessaging).
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`SandboxAdminApp`](pyric-admin-app-reference-api.md#sandboxadminapp) |
+
+#### Returns
+
+[`Messaging`](#messaging)