@mathrunet/masamune

import * as data from "./lib/src/functions_data"; /** * Define a list of applicable Functions for FirebaseFunctions. * * FirebaseFunctions用の適用可能なFunctionの一覧を定義します。 */ export declare const Functions: { /** * Delete the FirebaseAuthentication user. * * FirebaseAuthenticationのユーザーを削除するようにします。 */ readonly deleteUser: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * When a document is deleted, the related collections should be deleted together. * * ドキュメントが削除された場合関連するコレクションをまとめて削除するようにします。 */ readonly deleteDocuments: (options?: data.RelationPathFunctionsOptions) => data.FunctionsData; /** * Synchronize data to Algolia. * * Algoliaにデータを同期します。 */ readonly algolia: (options?: data.PathFunctionsOptions) => data.FunctionsData; /** * Get latitude and longitude with GeocodingAPI. * * GeocodingAPIで緯度経度を取得します。 */ readonly geocoding: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Function for sending PUSH notifications. * * PUSH通知を送信するためのFunction。 */ readonly sendNotification: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Function for periodic processing. * * 定期的に処理するためのFunction。 */ readonly scheduler: (options?: data.SchedulerFunctionsOptions) => data.FunctionsData; /** * The text is generated using Open AI's GPT. * * Open AIのChat GPTを利用して文章を生成します。 */ readonly openAIChatGPT: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Obtain an Agora.io security token. * * Agora.ioのセキュリティトークンを取得します。 */ readonly agoraToken: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Convert files generated by Agora.io's cloud recording into an easy-to-handle format from within the app. * * It is executed when the file is saved to FirebaseStorage. * * Agora.ioのクラウドレコーディングで生成されたファイルをアプリ上から扱いやすい形式に変換します。 * * FirebaseStorageにファイルが保存されたタイミングで実行されます。 */ readonly agoraCloudRecording: (options?: data.StorageFunctionsOptions) => data.FunctionsData; /** * Performs various Stripe processes. * * Firestore integration is a must; please make Firestore available as well. * * Stripeの各種処理を実行します。 * * Firestoreとの連携が必須です。Firestoreも利用可能にしてください。 */ readonly stripe: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Receives and processes webhooks from Stripe. * * Please register the URL when you deploy this in your Stripe webhook settings. * * Firestore integration is a must; please make Firestore available as well. * * StripeからのWebhookを受け取り処理を行います。 * * こちらをデプロイした際のURLをStripeのWebhook設定に登録してください。 * * Firestoreとの連携が必須です。Firestoreも利用可能にしてください。 */ readonly stripeWebhook: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Receive and process webhooks for Stripe Connect. * * If you do not use Stripe Connect, do not configure it as a Webhook. * * Please register the URL when you deploy this in your Stripe webhook settings. * * Firestore integration is a must; please make Firestore available as well. * * Stripe Connect用のWebhookを受信して処理します。 * * Stripe Connectを利用しない場合はWebhookとして設定しないでください。 * * こちらをデプロイした際のURLをStripeのWebhook設定に登録してください。 * * Firestoreとの連携が必須です。Firestoreも利用可能にしてください。 */ readonly stripeWebhookConnect: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Webhook for proper redirection when 3D Secure authentication is required. * * It is used by accessing the URL directly. * * Please set here for [returnUrl]. * * 3Dセキュア認証が必要な場合、適切なリダイレクトを行うためのWebhookです。 * * 直接URLにアクセスすることで利用します。 * * [returnUrl]にこちらを設定してください。 */ readonly stripeWebhookSecure: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Send email via Gmail. * * Gmailでメールを送信します。 */ readonly gmail: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Send mail through SendGrid. * * SendGridでメールを送信します。 */ readonly sendGrid: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * After being redirected from [android_auth_code], you will get a refresh token to connect to Google's API. Applications Library System Users Volumes bin cores dev etc home opt private sbin tmp usr var Execute [android_auth_code] after registering the required information. * * [android_auth_code]からリダイレクトされた後、GoogleのAPIに接続するためのリフレッシュトークンを取得します。 * 必要情報を登録した後[android_auth_code]を実行してください。 */ readonly androidAuthCode: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * After being redirected from [android_auth_code], you will get a refresh token to connect to Google's API. Applications Library System Users Volumes bin cores dev etc home opt private sbin tmp usr var Execute [android_auth_code] after registering the required information. * * [android_auth_code]からリダイレクトされた後、GoogleのAPIに接続するためのリフレッシュトークンを取得します。 * 必要情報を登録した後[android_auth_code]を実行してください。 */ readonly androidToken: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Performs a consumption-type in-app purchase. The value of the field in the document specified in [path] is added to [value]. * * 消費型のアプリ内課金を行います。[path]に指定したドキュメント内のフィールドの値を[value]に加算します。 */ readonly consumableVerifyAndroid: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Performs a consumption-type in-app purchase. The value of the field in the document specified in [path] is added to [value]. * * 消費型のアプリ内課金を行います。[path]に指定したドキュメント内のフィールドの値を[value]に加算します。 */ readonly consumableVerifyIOS: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Performs non-consumable in-app purchases. Unlock by setting the value of the field in the document specified in [path] to `true`. * * 非消費型のアプリ内課金を行います。[path]に指定したドキュメント内のフィールドの値を`true`にすることでアンロックを行います。 */ readonly nonconsumableVerifyAndroid: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Performs non-consumable in-app purchases. Unlock by setting the value of the field in the document specified in [path] to `true`. * * 非消費型のアプリ内課金を行います。[path]に指定したドキュメント内のフィールドの値を`true`にすることでアンロックを行います。 */ readonly nonconsumableVerifyIOS: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * This is a webhook endpoint for Android. you can create a `purchasing` topic in GCP's pub/sub and set the principal to "google-play-developer-notifications@system.gserviceaccount.com" to receive notifications. * * Android用のWebhookのエンドポイントです。GCPのpub/subに`purchasing`のトピックを作成しプリンシパルに「google-play-developer-notifications@system.gserviceaccount.com」を設定することで通知を受け取ることができるようになります。 */ readonly purchaseWebhookAndroid: (options?: data.PubsubFunctionsOptions) => data.FunctionsData; /** * Webhook endpoint for IOS, which allows you to receive notifications by setting the endpoint in AppStoreConnect's [App]->[App Information]->[App Store Server Notification]. * * IOS用のWebhookのエンドポイントです。AppStoreConnectの[App]->[App情報]->[App Storeサーバ通知]にエンドポイントを設定することで通知を受け取ることができるようになります。 */ readonly purchaseWebhookIOS: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Verify subscriptions and add data. * * サブスクリプションの検証とデータの追加を行います。 */ readonly subscriptionVerifyAndroid: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Verify subscriptions and add data. * * サブスクリプションの検証とデータの追加を行います。 */ readonly subscriptionVerifyIOS: (options?: data.HttpFunctionsOptions) => data.FunctionsData; /** * Endpoints for testing. * * テストを行うためのエンドポイントです。 */ readonly test: (options?: data.HttpFunctionsOptions) => data.FunctionsData; };