@maxim_mazurok/gapi.client.gmailpostmastertools-v1beta1 0.0.20230420 → 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 +171 -86
  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://gmailpostmastertools.googleapis.com/$discovery/rest?version=v1beta1
12
- // Revision: 20230420
12
+ // Revision: 20230427
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -24,196 +24,267 @@ declare namespace gapi.client {
24
24
  namespace gmailpostmastertools {
25
25
  interface DeliveryError {
26
26
  /** The class of delivery error. */
27
- errorClass?: string;
27
+ errorClass?:
28
+ string;
28
29
  /** The ratio of messages where the error occurred vs all authenticated traffic. */
29
- errorRatio?: number;
30
+ errorRatio?:
31
+ number;
30
32
  /** The type of delivery error. */
31
- errorType?: string;
33
+ errorType?:
34
+ string;
32
35
  }
33
36
  interface Domain {
34
37
  /** Timestamp when the user registered this domain. Assigned by the server. */
35
- createTime?: string;
38
+ createTime?:
39
+ string;
36
40
  /** The resource name of the Domain. Domain names have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com). */
37
- name?: string;
41
+ name?:
42
+ string;
38
43
  /** User’s permission for this domain. Assigned by the server. */
39
- permission?: string;
44
+ permission?:
45
+ string;
40
46
  }
41
47
  interface FeedbackLoop {
42
48
  /** Feedback loop identifier that uniquely identifies individual campaigns. */
43
- id?: string;
49
+ id?:
50
+ string;
44
51
  /** The ratio of user marked spam messages with the identifier vs the total number of inboxed messages with that identifier. */
45
- spamRatio?: number;
52
+ spamRatio?:
53
+ number;
46
54
  }
47
55
  interface IpReputation {
48
56
  /** Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/). */
49
- ipCount?: string;
57
+ ipCount?:
58
+ string;
50
59
  /**
51
60
  * Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/). Deprecated
52
61
  * to be complied with ApiLinter for Quantities. Use ip_count instead.
53
62
  */
54
- numIps?: string;
63
+ numIps?:
64
+ string;
55
65
  /** The reputation category this IP reputation represents. */
56
- reputation?: string;
66
+ reputation?:
67
+ string;
57
68
  /** A sample of IPs in this reputation category. */
58
- sampleIps?: string[];
69
+ sampleIps?:
70
+ string[];
59
71
  }
60
72
  interface ListDomainsResponse {
61
73
  /** The list of domains. */
62
- domains?: Domain[];
74
+ domains?:
75
+ Domain[];
63
76
  /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
64
- nextPageToken?: string;
77
+ nextPageToken?:
78
+ string;
65
79
  }
66
80
  interface ListTrafficStatsResponse {
67
81
  /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
68
- nextPageToken?: string;
82
+ nextPageToken?:
83
+ string;
69
84
  /** The list of TrafficStats. */
70
- trafficStats?: TrafficStats[];
85
+ trafficStats?:
86
+ TrafficStats[];
71
87
  }
72
88
  interface TrafficStats {
73
89
  /** Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/). */
74
- deliveryErrors?: DeliveryError[];
90
+ deliveryErrors?:
91
+ DeliveryError[];
75
92
  /** The ratio of mail that successfully authenticated with DKIM vs. all mail that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is excluded. */
76
- dkimSuccessRatio?: number;
93
+ dkimSuccessRatio?:
94
+ number;
77
95
  /**
78
96
  * The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs all mail received from the domain that successfully authenticated with either of
79
97
  * [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
80
98
  */
81
- dmarcSuccessRatio?: number;
99
+ dmarcSuccessRatio?:
100
+ number;
82
101
  /** Reputation of the domain. */
83
- domainReputation?: string;
102
+ domainReputation?:
103
+ string;
84
104
  /**
85
105
  * The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain. This metric only pertains to traffic that passed
86
106
  * [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
87
107
  */
88
- inboundEncryptionRatio?: number;
108
+ inboundEncryptionRatio?:
109
+ number;
89
110
  /**
90
111
  * Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except
91
112
  * REPUTATION_CATEGORY_UNSPECIFIED.
92
113
  */
93
- ipReputations?: IpReputation[];
114
+ ipReputations?:
115
+ IpReputation[];
94
116
  /**
95
117
  * The resource name of the traffic statistics. Traffic statistic names have the form `domains/{domain}/trafficStats/{date}`, where domain_name is the fully qualified domain name
96
118
  * (i.e., mymail.mydomain.com) of the domain this traffic statistics pertains to and date is the date in yyyymmdd format that these statistics corresponds to. For example:
97
119
  * domains/mymail.mydomain.com/trafficStats/20160807
98
120
  */
99
- name?: string;
121
+ name?:
122
+ string;
100
123
  /** The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS). */
101
- outboundEncryptionRatio?: number;
124
+ outboundEncryptionRatio?:
125
+ number;
102
126
  /**
103
127
  * Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/6254652) with their individual spam rates. This metric only pertains to traffic that is authenticated by
104
128
  * [DKIM](http://www.dkim.org/).
105
129
  */
106
- spammyFeedbackLoops?: FeedbackLoop[];
130
+ spammyFeedbackLoops?:
131
+ FeedbackLoop[];
107
132
  /** The ratio of mail that successfully authenticated with SPF vs. all mail that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is excluded. */
108
- spfSuccessRatio?: number;
133
+ spfSuccessRatio?:
134
+ number;
109
135
  /** The ratio of user-report spam vs. email that was sent to the inbox. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/). */
110
- userReportedSpamRatio?: number;
136
+ userReportedSpamRatio?:
137
+ number;
111
138
  }
112
139
  interface TrafficStatsResource {
113
140
  /** Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain. */
114
141
  get(request?: {
115
142
  /** V1 error format. */
116
- "$.xgafv"?: string;
143
+ "$.xgafv"?:
144
+ string;
117
145
  /** OAuth access token. */
118
- access_token?: string;
146
+ access_token?:
147
+ string;
119
148
  /** Data format for response. */
120
- alt?: string;
149
+ alt?:
150
+ string;
121
151
  /** JSONP */
122
- callback?: string;
152
+ callback?:
153
+ string;
123
154
  /** Selector specifying which fields to include in a partial response. */
124
- fields?: string;
155
+ fields?:
156
+ string;
125
157
  /** 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. */
126
- key?: string;
158
+ key?:
159
+ string;
127
160
  /** The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807. */
128
- name: string;
161
+ name:
162
+ string;
129
163
  /** OAuth 2.0 token for the current user. */
130
- oauth_token?: string;
164
+ oauth_token?:
165
+ string;
131
166
  /** Returns response with indentations and line breaks. */
132
- prettyPrint?: boolean;
167
+ prettyPrint?:
168
+ boolean;
133
169
  /** 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. */
134
- quotaUser?: string;
170
+ quotaUser?:
171
+ string;
135
172
  /** Upload protocol for media (e.g. "raw", "multipart"). */
136
- upload_protocol?: string;
173
+ upload_protocol?:
174
+ string;
137
175
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
138
- uploadType?: string;
176
+ uploadType?:
177
+ string;
139
178
  }): Request<TrafficStats>;
140
179
  /** List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain. */
141
180
  list(request?: {
142
181
  /** V1 error format. */
143
- "$.xgafv"?: string;
182
+ "$.xgafv"?:
183
+ string;
144
184
  /** OAuth access token. */
145
- access_token?: string;
185
+ access_token?:
186
+ string;
146
187
  /** Data format for response. */
147
- alt?: string;
188
+ alt?:
189
+ string;
148
190
  /** JSONP */
149
- callback?: string;
191
+ callback?:
192
+ string;
150
193
  /** 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. */
151
- "endDate.day"?: number;
194
+ "endDate.day"?:
195
+ number;
152
196
  /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
153
- "endDate.month"?: number;
197
+ "endDate.month"?:
198
+ number;
154
199
  /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
155
- "endDate.year"?: number;
200
+ "endDate.year"?:
201
+ number;
156
202
  /** Selector specifying which fields to include in a partial response. */
157
- fields?: string;
203
+ fields?:
204
+ string;
158
205
  /** 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. */
159
- key?: string;
206
+ key?:
207
+ string;
160
208
  /** OAuth 2.0 token for the current user. */
161
- oauth_token?: string;
209
+ oauth_token?:
210
+ string;
162
211
  /** Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default. */
163
- pageSize?: number;
212
+ pageSize?:
213
+ number;
164
214
  /**
165
215
  * The next_page_token value returned from a previous List request, if any. This is the value of ListTrafficStatsResponse.next_page_token returned from the previous call to
166
216
  * `ListTrafficStats` method.
167
217
  */
168
- pageToken?: string;
218
+ pageToken?:
219
+ string;
169
220
  /**
170
221
  * The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain
171
222
  * name.
172
223
  */
173
- parent: string;
224
+ parent:
225
+ string;
174
226
  /** Returns response with indentations and line breaks. */
175
- prettyPrint?: boolean;
227
+ prettyPrint?:
228
+ boolean;
176
229
  /** 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. */
177
- quotaUser?: string;
230
+ quotaUser?:
231
+ string;
178
232
  /** 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. */
179
- "startDate.day"?: number;
233
+ "startDate.day"?:
234
+ number;
180
235
  /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
181
- "startDate.month"?: number;
236
+ "startDate.month"?:
237
+ number;
182
238
  /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
183
- "startDate.year"?: number;
239
+ "startDate.year"?:
240
+ number;
184
241
  /** Upload protocol for media (e.g. "raw", "multipart"). */
185
- upload_protocol?: string;
242
+ upload_protocol?:
243
+ string;
186
244
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
187
- uploadType?: string;
245
+ uploadType?:
246
+ string;
188
247
  }): Request<ListTrafficStatsResponse>;
189
248
  }
190
249
  interface DomainsResource {
191
250
  /** Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist. */
192
251
  get(request?: {
193
252
  /** V1 error format. */
194
- "$.xgafv"?: string;
253
+ "$.xgafv"?:
254
+ string;
195
255
  /** OAuth access token. */
196
- access_token?: string;
256
+ access_token?:
257
+ string;
197
258
  /** Data format for response. */
198
- alt?: string;
259
+ alt?:
260
+ string;
199
261
  /** JSONP */
200
- callback?: string;
262
+ callback?:
263
+ string;
201
264
  /** Selector specifying which fields to include in a partial response. */
202
- fields?: string;
265
+ fields?:
266
+ string;
203
267
  /** 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. */
204
- key?: string;
268
+ key?:
269
+ string;
205
270
  /** The resource name of the domain. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name. */
206
- name: string;
271
+ name:
272
+ string;
207
273
  /** OAuth 2.0 token for the current user. */
208
- oauth_token?: string;
274
+ oauth_token?:
275
+ string;
209
276
  /** Returns response with indentations and line breaks. */
210
- prettyPrint?: boolean;
277
+ prettyPrint?:
278
+ boolean;
211
279
  /** 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. */
212
- quotaUser?: string;
280
+ quotaUser?:
281
+ string;
213
282
  /** Upload protocol for media (e.g. "raw", "multipart"). */
214
- upload_protocol?: string;
283
+ upload_protocol?:
284
+ string;
215
285
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
216
- uploadType?: string;
286
+ uploadType?:
287
+ string;
217
288
  }): Request<Domain>;
218
289
  /**
219
290
  * Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be
@@ -221,36 +292,50 @@ declare namespace gapi.client {
221
292
  */
222
293
  list(request?: {
223
294
  /** V1 error format. */
224
- "$.xgafv"?: string;
295
+ "$.xgafv"?:
296
+ string;
225
297
  /** OAuth access token. */
226
- access_token?: string;
298
+ access_token?:
299
+ string;
227
300
  /** Data format for response. */
228
- alt?: string;
301
+ alt?:
302
+ string;
229
303
  /** JSONP */
230
- callback?: string;
304
+ callback?:
305
+ string;
231
306
  /** Selector specifying which fields to include in a partial response. */
232
- fields?: string;
307
+ fields?:
308
+ string;
233
309
  /** 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. */
234
- key?: string;
310
+ key?:
311
+ string;
235
312
  /** OAuth 2.0 token for the current user. */
236
- oauth_token?: string;
313
+ oauth_token?:
314
+ string;
237
315
  /** Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default. */
238
- pageSize?: number;
316
+ pageSize?:
317
+ number;
239
318
  /**
240
319
  * The next_page_token value returned from a previous List request, if any. This is the value of ListDomainsResponse.next_page_token returned from the previous call to
241
320
  * `ListDomains` method.
242
321
  */
243
- pageToken?: string;
322
+ pageToken?:
323
+ string;
244
324
  /** Returns response with indentations and line breaks. */
245
- prettyPrint?: boolean;
325
+ prettyPrint?:
326
+ boolean;
246
327
  /** 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. */
247
- quotaUser?: string;
328
+ quotaUser?:
329
+ string;
248
330
  /** Upload protocol for media (e.g. "raw", "multipart"). */
249
- upload_protocol?: string;
331
+ upload_protocol?:
332
+ string;
250
333
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
251
- uploadType?: string;
334
+ uploadType?:
335
+ string;
252
336
  }): Request<ListDomainsResponse>;
253
- trafficStats: TrafficStatsResource;
337
+ trafficStats:
338
+ TrafficStatsResource;
254
339
  }
255
340
 
256
341
  const domains: DomainsResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.gmailpostmastertools-v1beta1",
3
- "version": "0.0.20230420",
3
+ "version": "0.0.20230427",
4
4
  "description": "TypeScript typings for Gmail Postmaster Tools 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: 20230420
6
+ // Revision: 20230427
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */