From 60ea0eef669787e83474b4a659c4d306b2215006 Mon Sep 17 00:00:00 2001 From: Marcos Rodriguez Velez Date: Sun, 27 Oct 2024 12:08:28 -0400 Subject: [PATCH] ADD: content-available, category and interrupt level --- openapi.yaml | 64 ++++- src/openapi/api.ts | 663 ++++++++++++++++++++++++++++++--------------- 2 files changed, 499 insertions(+), 228 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index f17a8c0..cc77ae4 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: GroundControl push server API description: Push notifications server for BlueWallet - version: 0.0.13 + version: 0.0.14 servers: - url: http://localhost:3001 - url: https://groundcontrol-bluewallet-stg.herokuapp.com @@ -250,6 +250,13 @@ components: type: "integer" level: $ref: "#/components/schemas/NotificationLevel" + aps: + type: object + properties: + content-available: + type: integer + enum: [1] + description: "To send a background notification, include only this key in the aps dictionary for types 1, 2, 3, and 4. Custom keys may also be added outside the aps dictionary." PushNotificationLightningInvoicePaid: allOf: # Combines PushNotificationBase and the inline model @@ -275,6 +282,17 @@ components: memo: type: "string" description: text attached to bolt11 + aps: + type: object + properties: + content-available: + type: integer + enum: [1] + interruption-level: + type: "string" + enum: + - "time-sensitive" + default: "time-sensitive" PushNotificationOnchainAddressGotPaid: allOf: # Combines PushNotificationBase and the inline model @@ -300,6 +318,20 @@ components: txid: type: "string" description: txid of the transaction where this address is one of the outputs + aps: + type: object + properties: + content-available: + type: integer + enum: [1] + category: + type: "string" + default: "TRANSACTION_CATEGORY" + interruption-level: + type: "string" + enum: + - "active" + default: "active" PushNotificationOnchainAddressGotUnconfirmedTransaction: allOf: # Combines PushNotificationBase and the inline model @@ -325,6 +357,20 @@ components: txid: type: "string" description: txid of the transaction where this address is one of the outputs + aps: + type: object + properties: + content-available: + type: integer + enum: [1] + category: + type: "string" + default: "TRANSACTION_CATEGORY" + interruption-level: + type: "string" + enum: + - "active" + default: "active" PushNotificationTxidGotConfirmed: allOf: # Combines PushNotificationBase and the inline model @@ -342,6 +388,20 @@ components: txid: type: "string" description: txid of the transaction that got confirmed + aps: + type: object + properties: + content-available: + type: integer + enum: [1] + category: + type: "string" + default: "TRANSACTION_CATEGORY" + interruption-level: + type: "string" + enum: + - "time-sensitive" + default: "time-sensitive" PushNotificationMessage: allOf: # Combines PushNotificationBase and the inline model @@ -355,4 +415,4 @@ components: enum: [5] text: type: "string" - description: custom text thats displayed on push notification buble + description: custom text thats displayed on push notification bubble \ No newline at end of file diff --git a/src/openapi/api.ts b/src/openapi/api.ts index 9596e83..01d52a2 100644 --- a/src/openapi/api.ts +++ b/src/openapi/api.ts @@ -3,237 +3,448 @@ * Do not make direct changes to the file. */ -export type paths = { - "/lightningInvoiceGotSettled": { - post: { - responses: { - /** OK */ - 200: unknown; - }; - requestBody: { - content: { - "application/json": components["schemas"]["LightningInvoiceSettledNotification"]; - }; - }; +export interface paths { + "/lightningInvoiceGotSettled": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["LightningInvoiceSettledNotification"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - }; - "/majorTomToGroundControl": { - post: { - responses: { - /** Created */ - 201: unknown; - }; - requestBody: { - content: { - "application/json": { - addresses?: string[]; - hashes?: string[]; - txids?: string[]; - token?: string; - os?: string; - } & { [key: string]: unknown }; - }; - }; + "/majorTomToGroundControl": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Associate bitcoin addressess / ln preimage hashes / txids that you wish to be notified about to specific push token. Token serves as unique identifier of a device/user. Also, OS of the token */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + addresses?: string[]; + hashes?: string[]; + txids?: string[]; + token?: string; + os?: string; + }; + }; + }; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - }; - "/unsubscribe": { - post: { - responses: { - /** Created */ - 201: unknown; - }; - requestBody: { - content: { - "application/json": { - addresses?: string[]; - hashes?: string[]; - txids?: string[]; - token?: string; - os?: string; - } & { [key: string]: unknown }; - }; - }; + "/unsubscribe": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** This call is a reverse call for /majorTomToGroundControl. In case user doesnt want to track addresses/txids/ln invoice hashes, he makes this call along with his token/os so GroundControl can remove them from the database */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + addresses?: string[]; + hashes?: string[]; + txids?: string[]; + token?: string; + os?: string; + }; + }; + }; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - }; - "/ping": { - get: { - responses: { - /** OK */ - 200: { - content: { - "application/json": components["schemas"]["ServerInfo"]; - }; - }; - }; + "/ping": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ServerInfo"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - }; - "/getTokenConfiguration": { - post: { - responses: { - /** OK */ - 200: { - content: { - "application/json": components["schemas"]["TokenConfiguration"]; - }; - }; - }; - requestBody: { - content: { - "application/json": { - token?: string; - os?: string; - } & { [key: string]: unknown }; - }; - }; + "/getTokenConfiguration": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Returns levels of notifications user currently subscribed to */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + token?: string; + os?: string; + }; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["TokenConfiguration"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - }; - "/setTokenConfiguration": { - post: { - responses: { - /** OK */ - 200: unknown; - }; - requestBody: { - content: { - "application/json": components["schemas"]["TokenConfiguration"] & - ({ - token: string; - os: string; - } & { [key: string]: unknown }) & { [key: string]: unknown }; - }; - }; + "/setTokenConfiguration": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Sets levels of notifications user is subscribed to; also saves some user info, like lang or app version */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["TokenConfiguration"] & { + token: string; + os: string; + }; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - }; - "/enqueue": { - post: { - responses: { - /** OK */ - 200: unknown; - }; - requestBody: { - content: { - "application/json": ( - | components["schemas"]["PushNotificationLightningInvoicePaid"] - | components["schemas"]["PushNotificationOnchainAddressGotPaid"] - | components["schemas"]["PushNotificationOnchainAddressGotUnconfirmedTransaction"] - | components["schemas"]["PushNotificationTxidGotConfirmed"] - ) & { [key: string]: unknown }; - }; - }; + "/enqueue": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Puts push in send queue. Push body should be any descendant of `/components/schemas/PushNotificationBase` */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["PushNotificationLightningInvoicePaid"] | components["schemas"]["PushNotificationOnchainAddressGotPaid"] | components["schemas"]["PushNotificationOnchainAddressGotUnconfirmedTransaction"] | components["schemas"]["PushNotificationTxidGotConfirmed"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - }; -}; - -export type components = { - schemas: { - ServerInfo: { - name?: string; - description?: string; - version?: string; - uptime?: number; - last_processed_block?: number; - send_queue_size?: number; - sent_24h?: number; - } & { [key: string]: unknown }; - /** @enum {string} */ - NotificationLevel: "transactions" | "news" | "price" | "tips"; - TokenConfiguration: { - level_all?: boolean; - level_transactions?: boolean; - level_news?: boolean; - level_price?: boolean; - level_tips?: boolean; - lang?: string; - app_version?: string; - } & { [key: string]: unknown }; - /** @description object thats posted to GroundControl to notify end-user that his specific invoice was paid by someone */ - LightningInvoiceSettledNotification: { - /** @description text that was embedded in invoice paid */ - memo?: string; - /** @description hex string preimage */ - preimage?: string; - /** @description hex string preimage hash */ - hash?: string; - /** @description exactly how much satoshis was paid to make this invoice settked (>= invoice amount) */ - amt_paid_sat?: number; - } & { [key: string]: unknown }; - /** @description payload for push notification delivered to phone */ - PushNotificationBase: { - /** - * @description type: - * * `1` - Your lightning invoice was paid - * * `2` - New transaction to one of your addresses - * * `3` - New unconfirmed transaction to one of your addresses - * * `4` - Transaction confirmed - * * `5` - Arbitrary text message - * - * @enum {integer} - */ - type: 1 | 2 | 3 | 4 | 5; - token: string; - /** @enum {string} */ - os: "android" | "ios"; - badge?: number; - level: components["schemas"]["NotificationLevel"]; - } & { [key: string]: unknown }; - PushNotificationLightningInvoicePaid: components["schemas"]["PushNotificationBase"] & - ({ - /** @enum {integer} */ - type?: 1; - /** @enum {string} */ - level?: "transactions"; - /** @description amount of satoshis */ - sat: number; - /** @description hash of specific ln invoice preimage */ - hash: string; - /** @description text attached to bolt11 */ - memo: string; - } & { [key: string]: unknown }) & { [key: string]: unknown }; - PushNotificationOnchainAddressGotPaid: components["schemas"]["PushNotificationBase"] & - ({ - /** @enum {integer} */ - type?: 2; - /** @enum {string} */ - level?: "transactions"; - /** @description amount of satoshis */ - sat: number; - /** @description user's onchain address that has incoming transaction */ - address: string; - /** @description txid of the transaction where this address is one of the outputs */ - txid: string; - } & { [key: string]: unknown }) & { [key: string]: unknown }; - PushNotificationOnchainAddressGotUnconfirmedTransaction: components["schemas"]["PushNotificationBase"] & - ({ - /** @enum {integer} */ - type?: 3; - /** @enum {string} */ - level?: "transactions"; - /** @description amount of satoshis */ - sat: number; - /** @description user's onchain address that has incoming transaction */ - address: string; - /** @description txid of the transaction where this address is one of the outputs */ - txid: string; - } & { [key: string]: unknown }) & { [key: string]: unknown }; - PushNotificationTxidGotConfirmed: components["schemas"]["PushNotificationBase"] & - ({ - /** @enum {integer} */ - type?: 4; +} +export type webhooks = Record; +export interface components { + schemas: { + ServerInfo: { + name?: string; + description?: string; + version?: string; + uptime?: number; + last_processed_block?: number; + send_queue_size?: number; + sent_24h?: number; + }; /** @enum {string} */ - level?: "transactions"; - /** @description txid of the transaction that got confirmed */ - txid: string; - } & { [key: string]: unknown }) & { [key: string]: unknown }; - PushNotificationMessage: components["schemas"]["PushNotificationBase"] & - ({ - /** @enum {integer} */ - type?: 5; - /** @description custom text thats displayed on push notification buble */ - text: string; - } & { [key: string]: unknown }) & { [key: string]: unknown }; - }; -}; - -export type operations = {}; - -export type external = {}; + NotificationLevel: "transactions" | "news" | "price" | "tips"; + TokenConfiguration: { + level_all?: boolean; + level_transactions?: boolean; + level_news?: boolean; + level_price?: boolean; + level_tips?: boolean; + lang?: string; + app_version?: string; + }; + /** @description object thats posted to GroundControl to notify end-user that his specific invoice was paid by someone */ + LightningInvoiceSettledNotification: { + /** @description text that was embedded in invoice paid */ + memo?: string; + /** @description hex string preimage */ + preimage?: string; + /** @description hex string preimage hash */ + hash?: string; + /** @description exactly how much satoshis was paid to make this invoice settked (>= invoice amount) */ + amt_paid_sat?: number; + }; + /** @description payload for push notification delivered to phone */ + PushNotificationBase: { + /** + * @description type: + * * `1` - Your lightning invoice was paid + * * `2` - New transaction to one of your addresses + * * `3` - New unconfirmed transaction to one of your addresses + * * `4` - Transaction confirmed + * * `5` - Arbitrary text message + * + * @enum {integer} + */ + type: 1 | 2 | 3 | 4 | 5; + token: string; + /** @enum {string} */ + os: "android" | "ios"; + badge?: number; + level: components["schemas"]["NotificationLevel"]; + aps?: { + /** + * @description To send a background notification, include only this key in the aps dictionary for types 1, 2, 3, and 4. Custom keys may also be added outside the aps dictionary. + * @enum {integer} + */ + "content-available"?: 1; + }; + }; + PushNotificationLightningInvoicePaid: components["schemas"]["PushNotificationBase"] & { + /** @enum {integer} */ + type?: 1; + /** @enum {string} */ + level?: "transactions"; + /** @description amount of satoshis */ + sat: number; + /** @description hash of specific ln invoice preimage */ + hash: string; + /** @description text attached to bolt11 */ + memo: string; + aps?: { + /** @enum {integer} */ + "content-available"?: 1; + }; + /** + * @default time-sensitive + * @enum {string} + */ + "interruption-level": "time-sensitive"; + }; + PushNotificationOnchainAddressGotPaid: components["schemas"]["PushNotificationBase"] & { + /** @enum {integer} */ + type?: 2; + /** @enum {string} */ + level?: "transactions"; + /** @description amount of satoshis */ + sat: number; + /** @description user's onchain address that has incoming transaction */ + address: string; + /** @description txid of the transaction where this address is one of the outputs */ + txid: string; + aps?: { + /** @enum {integer} */ + "content-available"?: 1; + }; + /** @default TRANSACTION_CATEGORY */ + category: string; + /** + * @default active + * @enum {string} + */ + "interruption-level": "active"; + }; + PushNotificationOnchainAddressGotUnconfirmedTransaction: components["schemas"]["PushNotificationBase"] & { + /** @enum {integer} */ + type?: 3; + /** @enum {string} */ + level?: "transactions"; + /** @description amount of satoshis */ + sat: number; + /** @description user's onchain address that has incoming transaction */ + address: string; + /** @description txid of the transaction where this address is one of the outputs */ + txid: string; + aps?: { + /** @enum {integer} */ + "content-available"?: 1; + }; + /** @default TRANSACTION_CATEGORY */ + category: string; + /** + * @default active + * @enum {string} + */ + "interruption-level": "active"; + }; + PushNotificationTxidGotConfirmed: components["schemas"]["PushNotificationBase"] & { + /** @enum {integer} */ + type?: 4; + /** @enum {string} */ + level?: "transactions"; + /** @description txid of the transaction that got confirmed */ + txid: string; + aps?: { + /** @enum {integer} */ + "content-available"?: 1; + }; + /** @default TRANSACTION_CATEGORY */ + category: string; + /** + * @default time-sensitive + * @enum {string} + */ + "interruption-level": "time-sensitive"; + }; + PushNotificationMessage: components["schemas"]["PushNotificationBase"] & { + /** @enum {integer} */ + type?: 5; + /** @description custom text thats displayed on push notification bubble */ + text: string; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export type operations = Record;