@maxim_mazurok/gapi.client.fcmdata-v1beta1 0.0.20230425 → 0.0.20230427

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +81 -41
  2. package/package.json +1 -1
  3. package/tests.ts +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://fcmdata.googleapis.com/$discovery/rest?version=v1beta1
12
- // Revision: 20230425
12
+ // Revision: 20230427
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -24,139 +24,179 @@ declare namespace gapi.client {
24
24
  namespace fcmdata {
25
25
  interface GoogleFirebaseFcmDataV1beta1AndroidDeliveryData {
26
26
  /** The analytics label associated with the messages sent. All messages sent without an analytics label will be grouped together in a single entry. */
27
- analyticsLabel?: string;
27
+ analyticsLabel?:
28
+ string;
28
29
  /** The app ID to which the messages were sent. */
29
- appId?: string;
30
+ appId?:
31
+ string;
30
32
  /** The data for the specified appId, date, and analyticsLabel. */
31
- data?: GoogleFirebaseFcmDataV1beta1Data;
33
+ data?:
34
+ GoogleFirebaseFcmDataV1beta1Data;
32
35
  /** The date represented by this entry. */
33
- date?: GoogleTypeDate;
36
+ date?:
37
+ GoogleTypeDate;
34
38
  }
35
39
  interface GoogleFirebaseFcmDataV1beta1Data {
36
40
  /** 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. */
37
- countMessagesAccepted?: string;
41
+ countMessagesAccepted?:
42
+ string;
38
43
  /** Additional information about delivery performance for messages that were successfully delivered. */
39
- deliveryPerformancePercents?: GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents;
44
+ deliveryPerformancePercents?:
45
+ GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents;
40
46
  /** Additional general insights about message delivery. */
41
- messageInsightPercents?: GoogleFirebaseFcmDataV1beta1MessageInsightPercents;
47
+ messageInsightPercents?:
48
+ GoogleFirebaseFcmDataV1beta1MessageInsightPercents;
42
49
  /** Mutually exclusive breakdown of message delivery outcomes. */
43
- messageOutcomePercents?: GoogleFirebaseFcmDataV1beta1MessageOutcomePercents;
50
+ messageOutcomePercents?:
51
+ GoogleFirebaseFcmDataV1beta1MessageOutcomePercents;
44
52
  }
45
53
  interface GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents {
46
54
  /**
47
55
  * The percentage of accepted messages that were delayed because the device was in doze mode. Only [normal priority
48
56
  * messages](https://firebase.google.com/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message) should be delayed due to doze mode.
49
57
  */
50
- delayedDeviceDoze?: number;
58
+ delayedDeviceDoze?:
59
+ number;
51
60
  /**
52
61
  * 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
53
62
  * reconnected.
54
63
  */
55
- delayedDeviceOffline?: number;
64
+ delayedDeviceOffline?:
65
+ number;
56
66
  /**
57
67
  * The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message
58
68
  * throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_throttling) or [maximum message rate
59
69
  * throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#device_throttling).
60
70
  */
61
- delayedMessageThrottled?: number;
71
+ delayedMessageThrottled?:
72
+ number;
62
73
  /**
63
74
  * The percentage of accepted messages that were delayed because the intended device user-profile was
64
75
  * [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
65
76
  * when the user-profile was started again.
66
77
  */
67
- delayedUserStopped?: number;
78
+ delayedUserStopped?:
79
+ number;
68
80
  /** The percentage of accepted messages that were delivered to the device without delay from the FCM system. */
69
- deliveredNoDelay?: number;
81
+ deliveredNoDelay?:
82
+ number;
70
83
  }
71
84
  interface GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse {
72
85
  /** The delivery data for the provided app. There will be one entry per combination of app, date, and analytics label. */
73
- androidDeliveryData?: GoogleFirebaseFcmDataV1beta1AndroidDeliveryData[];
86
+ androidDeliveryData?:
87
+ GoogleFirebaseFcmDataV1beta1AndroidDeliveryData[];
74
88
  /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
75
- nextPageToken?: string;
89
+ nextPageToken?:
90
+ string;
76
91
  }
77
92
  interface GoogleFirebaseFcmDataV1beta1MessageInsightPercents {
78
93
  /**
79
94
  * The percentage of accepted messages that had their priority lowered from high to normal. See [documentation for setting message
80
95
  * priority](https://firebase.google.com/docs/cloud-messaging/android/message-priority).
81
96
  */
82
- priorityLowered?: number;
97
+ priorityLowered?:
98
+ number;
83
99
  }
84
100
  interface GoogleFirebaseFcmDataV1beta1MessageOutcomePercents {
85
101
  /** The percentage of all accepted messages that were successfully delivered to the device. */
86
- delivered?: number;
102
+ delivered?:
103
+ number;
87
104
  /** 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. */
88
- droppedAppForceStopped?: number;
105
+ droppedAppForceStopped?:
106
+ number;
89
107
  /**
90
108
  * 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
91
109
  * device does reconnect, we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud-messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering
92
110
  * the messages.
93
111
  */
94
- droppedDeviceInactive?: number;
112
+ droppedDeviceInactive?:
113
+ number;
95
114
  /**
96
115
  * The percentage of accepted messages that were dropped due to [too many undelivered non-collapsible
97
116
  * messages](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages). Specifically, each app instance can only have 100 pending
98
117
  * 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,
99
118
  * we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud-messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering the messages.
100
119
  */
101
- droppedTooManyPendingMessages?: number;
120
+ droppedTooManyPendingMessages?:
121
+ number;
102
122
  /**
103
123
  * 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
104
124
  * 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.
105
125
  */
106
- pending?: number;
126
+ pending?:
127
+ number;
107
128
  }
108
129
  interface GoogleTypeDate {
109
130
  /** 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. */
110
- day?: number;
131
+ day?:
132
+ number;
111
133
  /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
112
- month?: number;
134
+ month?:
135
+ number;
113
136
  /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
114
- year?: number;
137
+ year?:
138
+ number;
115
139
  }
116
140
  interface DeliveryDataResource {
117
141
  /** List aggregate delivery data for the given Android application. */
118
142
  list(request?: {
119
143
  /** V1 error format. */
120
- "$.xgafv"?: string;
144
+ "$.xgafv"?:
145
+ string;
121
146
  /** OAuth access token. */
122
- access_token?: string;
147
+ access_token?:
148
+ string;
123
149
  /** Data format for response. */
124
- alt?: string;
150
+ alt?:
151
+ string;
125
152
  /** JSONP */
126
- callback?: string;
153
+ callback?:
154
+ string;
127
155
  /** Selector specifying which fields to include in a partial response. */
128
- fields?: string;
156
+ fields?:
157
+ string;
129
158
  /** 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. */
130
- key?: string;
159
+ key?:
160
+ string;
131
161
  /** OAuth 2.0 token for the current user. */
132
- oauth_token?: string;
162
+ oauth_token?:
163
+ string;
133
164
  /**
134
165
  * 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;
135
166
  * values above 10,000 will be capped to 10,000. This default may change over time.
136
167
  */
137
- pageSize?: number;
168
+ pageSize?:
169
+ number;
138
170
  /**
139
171
  * A page token, received from a previous `ListAndroidDeliveryDataRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
140
172
  * `ListAndroidDeliveryDataRequest` must match the call that provided the page token.
141
173
  */
142
- pageToken?: string;
174
+ pageToken?:
175
+ string;
143
176
  /** Required. The application for which to list delivery data. Format: `projects/{project_id}/androidApps/{app_id}` */
144
- parent: string;
177
+ parent:
178
+ string;
145
179
  /** Returns response with indentations and line breaks. */
146
- prettyPrint?: boolean;
180
+ prettyPrint?:
181
+ boolean;
147
182
  /** 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. */
148
- quotaUser?: string;
183
+ quotaUser?:
184
+ string;
149
185
  /** Upload protocol for media (e.g. "raw", "multipart"). */
150
- upload_protocol?: string;
186
+ upload_protocol?:
187
+ string;
151
188
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
152
- uploadType?: string;
189
+ uploadType?:
190
+ string;
153
191
  }): Request<GoogleFirebaseFcmDataV1beta1ListAndroidDeliveryDataResponse>;
154
192
  }
155
193
  interface AndroidAppsResource {
156
- deliveryData: DeliveryDataResource;
194
+ deliveryData:
195
+ DeliveryDataResource;
157
196
  }
158
197
  interface ProjectsResource {
159
- androidApps: AndroidAppsResource;
198
+ androidApps:
199
+ AndroidAppsResource;
160
200
  }
161
201
 
162
202
  const projects: ProjectsResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.fcmdata-v1beta1",
3
- "version": "0.0.20230425",
3
+ "version": "0.0.20230427",
4
4
  "description": "TypeScript typings for Firebase Cloud Messaging Data API v1beta1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230425
6
+ // Revision: 20230427
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */