@maxim_mazurok/gapi.client.fcmdata-v1beta1 0.0.20231127 → 0.0.20231130

package/index.d.ts

@@ -9,196 +9,123 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://fcmdata.googleapis.com/$discovery/rest?version=v1beta1
-// Revision: 20231127
+// Revision: 20231130
 
 /// <reference types="gapi.client" />
 
 declare namespace gapi.client {
-    /** Load Firebase Cloud Messaging Data API v1beta1 */
-    function load(urlOrObject: "https://fcmdata.googleapis.com/$discovery/rest?version=v1beta1"): Promise<void>;
-    /** @deprecated Please load APIs with discovery documents. */
-    function load(name: "fcmdata", version: "v1beta1"): Promise<void>;
-    /** @deprecated Please load APIs with discovery documents. */
-    function load(name: "fcmdata", version: "v1beta1", callback: () => any): void;
+  /** Load Firebase Cloud Messaging Data API v1beta1 */
+  function load(
+    urlOrObject: 'https://fcmdata.googleapis.com/$discovery/rest?version=v1beta1'
+  ): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'fcmdata', version: 'v1beta1'): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'fcmdata', version: 'v1beta1', callback: () => any): void;
 
-    namespace fcmdata {
-        interface GoogleFirebaseFcmDataV1beta1AndroidDeliveryData {
-            /** The analytics label associated with the messages sent. All messages sent without an analytics label will be grouped together in a single entry. */
-            analyticsLabel?:
-                string;
-            /** The app ID to which the messages were sent. */
-            appId?:
-                string;
-            /** The data for the specified appId, date, and analyticsLabel. */
-            data?:
-                GoogleFirebaseFcmDataV1beta1Data;
-            /** The date represented by this entry. */
-            date?:
-                GoogleTypeDate;
-        }
-        interface GoogleFirebaseFcmDataV1beta1Data {
-            /** Count of messages accepted by FCM intended to Android devices. The targeted device must have opted in to the collection of usage and diagnostic information. */
-            countMessagesAccepted?:
-                string;
-            /** Additional information about delivery performance for messages that were successfully delivered. */
-            deliveryPerformancePercents?:
-                GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents;
-            /** Additional general insights about message delivery. */
-            messageInsightPercents?:
-                GoogleFirebaseFcmDataV1beta1MessageInsightPercents;
-            /** Mutually exclusive breakdown of message delivery outcomes. */
-            messageOutcomePercents?:
-                GoogleFirebaseFcmDataV1beta1MessageOutcomePercents;
-        }
-        interface GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents {
-            /**
-             * The percentage of accepted messages that were delayed because the device was in doze mode. Only [normal priority
-             * messages](https://firebase.google.com/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message) should be delayed due to doze mode.
-             */
-            delayedDeviceDoze?:
-                number;
-            /**
-             * The percentage of accepted messages that were delayed because the target device was not connected at the time of sending. These messages were eventually delivered when the device
-             * reconnected.
-             */
-            delayedDeviceOffline?:
-                number;
-            /**
-             * The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message
-             * throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_throttling) or [maximum message rate
-             * throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#device_throttling).
-             */
-            delayedMessageThrottled?:
-                number;
-            /**
-             * The percentage of accepted messages that were delayed because the intended device user-profile was
-             * [stopped](https://firebase.google.com/docs/cloud-messaging/android/receive#handling_messages) on the target device at the time of the send. The messages were eventually delivered
-             * when the user-profile was started again.
-             */
-            delayedUserStopped?:
-                number;
-            /** The percentage of accepted messages that were delivered to the device without delay from the FCM system. */
-            deliveredNoDelay?:
-                number;
-        }
-        interface GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse {
-            /** The delivery data for the provided app. There will be one entry per combination of app, date, and analytics label. */
-            androidDeliveryData?:
-                GoogleFirebaseFcmDataV1beta1AndroidDeliveryData[];
-            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
-            nextPageToken?:
-                string;
-        }
-        interface GoogleFirebaseFcmDataV1beta1MessageInsightPercents {
-            /**
-             * The percentage of accepted messages that had their priority lowered from high to normal. See [documentation for setting message
-             * priority](https://firebase.google.com/docs/cloud-messaging/android/message-priority).
-             */
-            priorityLowered?:
-                number;
-        }
-        interface GoogleFirebaseFcmDataV1beta1MessageOutcomePercents {
-            /** The percentage of all accepted messages that were successfully delivered to the device. */
-            delivered?:
-                number;
-            /** The percentage of accepted messages that were dropped because the application was force stopped on the device at the time of delivery and retries were unsuccessful. */
-            droppedAppForceStopped?:
-                number;
-            /**
-             * The percentage of accepted messages that were dropped because the target device is inactive. FCM will drop messages if the target device is deemed inactive by our servers. If a
-             * device does reconnect, we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud-messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering
-             * the messages.
-             */
-            droppedDeviceInactive?:
-                number;
-            /**
-             * The percentage of accepted messages that were dropped due to [too many undelivered non-collapsible
-             * messages](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages). Specifically, each app instance can only have 100 pending
-             * messages stored on our servers for a device which is disconnected. When that device reconnects, those messages are delivered. When there are more than the maximum pending messages,
-             * we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud-messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering the messages.
-             */
-            droppedTooManyPendingMessages?:
-                number;
-            /**
-             * The percentage of messages accepted on this day that were not dropped and not delivered, due to the device being disconnected (as of the end of the America/Los_Angeles day when the
-             * message was sent to FCM). A portion of these messages will be delivered the next day when the device connects but others may be destined to devices that ultimately never reconnect.
-             */
-            pending?:
-                number;
-        }
-        interface GoogleTypeDate {
-            /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
-            day?:
-                number;
-            /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
-            month?:
-                number;
-            /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
-            year?:
-                number;
-        }
-        interface DeliveryDataResource {
-            /** List aggregate delivery data for the given Android application. */
-            list(request?: {
-                /** V1 error format. */
-                "$.xgafv"?:
-                    string;
-                /** OAuth access token. */
-                access_token?:
-                    string;
-                /** Data format for response. */
-                alt?:
-                    string;
-                /** JSONP */
-                callback?:
-                    string;
-                /** Selector specifying which fields to include in a partial response. */
-                fields?:
-                    string;
-                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
-                key?:
-                    string;
-                /** OAuth 2.0 token for the current user. */
-                oauth_token?:
-                    string;
-                /**
-                 * The maximum number of entries to return. The service may return fewer than this value. If unspecified, at most 1,000 entries will be returned. The maximum value is 10,000;
-                 * values above 10,000 will be capped to 10,000. This default may change over time.
-                 */
-                pageSize?:
-                    number;
-                /**
-                 * A page token, received from a previous `ListAndroidDeliveryDataRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
-                 * `ListAndroidDeliveryDataRequest` must match the call that provided the page token.
-                 */
-                pageToken?:
-                    string;
-                /** Required. The application for which to list delivery data. Format: `projects/{project_id}/androidApps/{app_id}` */
-                parent:
-                    string;
-                /** Returns response with indentations and line breaks. */
-                prettyPrint?:
-                    boolean;
-                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
-                quotaUser?:
-                    string;
-                /** Upload protocol for media (e.g. "raw", "multipart"). */
-                upload_protocol?:
-                    string;
-                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
-                uploadType?:
-                    string;
-            }): Request<GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse>;
-        }
-        interface AndroidAppsResource {
-            deliveryData:
-                DeliveryDataResource;
-        }
-        interface ProjectsResource {
-            androidApps:
-                AndroidAppsResource;
-        }
-
-        const projects: ProjectsResource;
+  namespace fcmdata {
+    interface GoogleFirebaseFcmDataV1beta1AndroidDeliveryData {
+      /** The analytics label associated with the messages sent. All messages sent without an analytics label will be grouped together in a single entry. */
+      analyticsLabel?: string;
+      /** The app ID to which the messages were sent. */
+      appId?: string;
+      /** The data for the specified appId, date, and analyticsLabel. */
+      data?: GoogleFirebaseFcmDataV1beta1Data;
+      /** The date represented by this entry. */
+      date?: GoogleTypeDate;
+    }
+    interface GoogleFirebaseFcmDataV1beta1Data {
+      /** Count of messages accepted by FCM intended to Android devices. The targeted device must have opted in to the collection of usage and diagnostic information. */
+      countMessagesAccepted?: string;
+      /** Additional information about delivery performance for messages that were successfully delivered. */
+      deliveryPerformancePercents?: GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents;
+      /** Additional general insights about message delivery. */
+      messageInsightPercents?: GoogleFirebaseFcmDataV1beta1MessageInsightPercents;
+      /** Mutually exclusive breakdown of message delivery outcomes. */
+      messageOutcomePercents?: GoogleFirebaseFcmDataV1beta1MessageOutcomePercents;
+    }
+    interface GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents {
+      /** The percentage of accepted messages that were delayed because the device was in doze mode. Only [normal priority messages](https://firebase.google.com/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message) should be delayed due to doze mode. */
+      delayedDeviceDoze?: number;
+      /** The percentage of accepted messages that were delayed because the target device was not connected at the time of sending. These messages were eventually delivered when the device reconnected. */
+      delayedDeviceOffline?: number;
+      /** The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_throttling) or [maximum message rate throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#device_throttling). */
+      delayedMessageThrottled?: number;
+      /** The percentage of accepted messages that were delayed because the intended device user-profile was [stopped](https://firebase.google.com/docs/cloud-messaging/android/receive#handling_messages) on the target device at the time of the send. The messages were eventually delivered when the user-profile was started again. */
+      delayedUserStopped?: number;
+      /** The percentage of accepted messages that were delivered to the device without delay from the FCM system. */
+      deliveredNoDelay?: number;
+    }
+    interface GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse {
+      /** The delivery data for the provided app. There will be one entry per combination of app, date, and analytics label. */
+      androidDeliveryData?: GoogleFirebaseFcmDataV1beta1AndroidDeliveryData[];
+      /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+      nextPageToken?: string;
+    }
+    interface GoogleFirebaseFcmDataV1beta1MessageInsightPercents {
+      /** The percentage of accepted messages that had their priority lowered from high to normal. See [documentation for setting message priority](https://firebase.google.com/docs/cloud-messaging/android/message-priority). */
+      priorityLowered?: number;
+    }
+    interface GoogleFirebaseFcmDataV1beta1MessageOutcomePercents {
+      /** The percentage of all accepted messages that were successfully delivered to the device. */
+      delivered?: number;
+      /** The percentage of accepted messages that were dropped because the application was force stopped on the device at the time of delivery and retries were unsuccessful. */
+      droppedAppForceStopped?: number;
+      /** The percentage of accepted messages that were dropped because the target device is inactive. FCM will drop messages if the target device is deemed inactive by our servers. If a device does reconnect, we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud-messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering the messages. */
+      droppedDeviceInactive?: number;
+      /** The percentage of accepted messages that were dropped due to [too many undelivered non-collapsible messages](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages). Specifically, each app instance can only have 100 pending messages stored on our servers for a device which is disconnected. When that device reconnects, those messages are delivered. When there are more than the maximum pending messages, we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud-messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering the messages. */
+      droppedTooManyPendingMessages?: number;
+      /** The percentage of messages accepted on this day that were not dropped and not delivered, due to the device being disconnected (as of the end of the America/Los_Angeles day when the message was sent to FCM). A portion of these messages will be delivered the next day when the device connects but others may be destined to devices that ultimately never reconnect. */
+      pending?: number;
     }
+    interface GoogleTypeDate {
+      /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
+      day?: number;
+      /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
+      month?: number;
+      /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
+      year?: number;
+    }
+    interface DeliveryDataResource {
+      /** List aggregate delivery data for the given Android application. */
+      list(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** The maximum number of entries to return. The service may return fewer than this value. If unspecified, at most 1,000 entries will be returned. The maximum value is 10,000; values above 10,000 will be capped to 10,000. This default may change over time. */
+        pageSize?: number;
+        /** A page token, received from a previous `ListAndroidDeliveryDataRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAndroidDeliveryDataRequest` must match the call that provided the page token. */
+        pageToken?: string;
+        /** Required. The application for which to list delivery data. Format: `projects/{project_id}/androidApps/{app_id}` */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse>;
+    }
+    interface AndroidAppsResource {
+      deliveryData: DeliveryDataResource;
+    }
+    interface ProjectsResource {
+      androidApps: AndroidAppsResource;
+    }
+
+    const projects: ProjectsResource;
+  }
 }

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@maxim_mazurok/gapi.client.fcmdata-v1beta1",
-  "version": "0.0.20231127",
+  "version": "0.0.20231130",
   "description": "TypeScript typings for Firebase Cloud Messaging Data API v1beta1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
   "license": "MIT",
   "author": {
-    "email": "maxim@mazurok.com",
     "name": "Maxim Mazurok",
+    "email": "maxim@mazurok.com",
     "url": "https://maxim.mazurok.com"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
-  },
   "types": "index.d.ts",
   "dependencies": {
     "@types/gapi.client": "*",

package/readme.md

@@ -25,10 +25,13 @@ gapi.load('client', () => {
 Then load api client wrapper:
 
 ```typescript
-gapi.client.load('https://fcmdata.googleapis.com/$discovery/rest?version=v1beta1', () => {
-  // now we can use:
-  // gapi.client.fcmdata
-});
+gapi.client.load(
+  'https://fcmdata.googleapis.com/$discovery/rest?version=v1beta1',
+  () => {
+    // now we can use:
+    // gapi.client.fcmdata
+  }
+);
 ```
 
 ```typescript
@@ -45,24 +48,26 @@ Don't forget to authenticate your client before sending any request to resources
 // declare client_id registered in Google Developers Console
 var client_id = '',
   scope = [
-      // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
-      'https://www.googleapis.com/auth/cloud-platform',
-    ],
-    immediate = true;
+    // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
+    'https://www.googleapis.com/auth/cloud-platform',
+  ],
+  immediate = true;
 // ...
 
 gapi.auth.authorize(
-  { client_id: client_id, scope: scope, immediate: immediate },
+  {client_id: client_id, scope: scope, immediate: immediate},
   authResult => {
     if (authResult && !authResult.error) {
-        /* handle successful authorization */
+      /* handle successful authorization */
     } else {
-        /* handle authorization error */
+      /* handle authorization error */
     }
-});
+  }
+);
 ```
 
 After that you can use Firebase Cloud Messaging Data API resources: <!-- TODO: make this work for multiple namespaces -->
 
 ```typescript
+
 ```

package/tests.ts

@@ -1,39 +0,0 @@
-/* This is stub file for gapi.client.fcmdata-v1beta1 definition tests */
-// IMPORTANT
-// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
-// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
-
-// Revision: 20231127
-
-gapi.load('client', async () => {
-    /** now we can use gapi.client */
-
-    await gapi.client.load('https://fcmdata.googleapis.com/$discovery/rest?version=v1beta1');
-    /** now we can use gapi.client.fcmdata */
-
-    /** don't forget to authenticate your client before sending any request to resources: */
-    /** declare client_id registered in Google Developers Console */
-    const client_id = '<<PUT YOUR CLIENT ID HERE>>';
-    const scope = [
-        /** See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. */
-        'https://www.googleapis.com/auth/cloud-platform',
-    ];
-    const immediate = false;
-    gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
-        if (authResult && !authResult.error) {
-            /** handle successful authorization */
-            run();
-        } else {
-            /** handle authorization error */
-        }
-    });
-
-    async function run() {
-        /** List aggregate delivery data for the given Android application. */
-        await gapi.client.fcmdata.projects.androidApps.deliveryData.list({
-            pageSize: 42,
-            pageToken: "Test string",
-            parent: "Test string",
-        });
-    }
-});

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-    "compilerOptions": {
-        "module": "commonjs",
-        "lib": ["es6", "dom"],
-        "noImplicitAny": true,
-        "noImplicitThis": true,
-        "strictNullChecks": true,
-        "baseUrl": "../",
-        "typeRoots": [
-            "../"
-        ],
-        "types": [],
-        "noEmit": true,
-        "forceConsistentCasingInFileNames": true,
-        "strictFunctionTypes": true
-    },
-    "files": ["index.d.ts", "tests.ts"]
-}

package/tslint.json

@@ -1,6 +0,0 @@
-{
-    "extends": "dtslint/dtslint.json",
-    "rules": {
-        "no-redundant-jsdoc": false
-    }
-}