@maxim_mazurok/gapi.client.gmailpostmastertools-v1 0.0.20230424 → 0.0.20230429

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 +169 -85
  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=v1
12
- // Revision: 20230424
12
+ // Revision: 20230429
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -24,191 +24,261 @@ 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
  /** The reputation category this IP reputation represents. */
51
- reputation?: string;
60
+ reputation?:
61
+ string;
52
62
  /** A sample of IPs in this reputation category. */
53
- sampleIps?: string[];
63
+ sampleIps?:
64
+ string[];
54
65
  }
55
66
  interface ListDomainsResponse {
56
67
  /** The list of domains. */
57
- domains?: Domain[];
68
+ domains?:
69
+ Domain[];
58
70
  /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
59
- nextPageToken?: string;
71
+ nextPageToken?:
72
+ string;
60
73
  }
61
74
  interface ListTrafficStatsResponse {
62
75
  /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
63
- nextPageToken?: string;
76
+ nextPageToken?:
77
+ string;
64
78
  /** The list of TrafficStats. */
65
- trafficStats?: TrafficStats[];
79
+ trafficStats?:
80
+ TrafficStats[];
66
81
  }
67
82
  interface TrafficStats {
68
83
  /** Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/). */
69
- deliveryErrors?: DeliveryError[];
84
+ deliveryErrors?:
85
+ DeliveryError[];
70
86
  /** 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. */
71
- dkimSuccessRatio?: number;
87
+ dkimSuccessRatio?:
88
+ number;
72
89
  /**
73
90
  * 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
74
91
  * [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
75
92
  */
76
- dmarcSuccessRatio?: number;
93
+ dmarcSuccessRatio?:
94
+ number;
77
95
  /** Reputation of the domain. */
78
- domainReputation?: string;
96
+ domainReputation?:
97
+ string;
79
98
  /**
80
99
  * 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
81
100
  * [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
82
101
  */
83
- inboundEncryptionRatio?: number;
102
+ inboundEncryptionRatio?:
103
+ number;
84
104
  /**
85
105
  * Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except
86
106
  * REPUTATION_CATEGORY_UNSPECIFIED.
87
107
  */
88
- ipReputations?: IpReputation[];
108
+ ipReputations?:
109
+ IpReputation[];
89
110
  /**
90
111
  * 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
91
112
  * (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:
92
113
  * domains/mymail.mydomain.com/trafficStats/20160807
93
114
  */
94
- name?: string;
115
+ name?:
116
+ string;
95
117
  /** The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS). */
96
- outboundEncryptionRatio?: number;
118
+ outboundEncryptionRatio?:
119
+ number;
97
120
  /**
98
121
  * 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
99
122
  * [DKIM](http://www.dkim.org/).
100
123
  */
101
- spammyFeedbackLoops?: FeedbackLoop[];
124
+ spammyFeedbackLoops?:
125
+ FeedbackLoop[];
102
126
  /** 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. */
103
- spfSuccessRatio?: number;
127
+ spfSuccessRatio?:
128
+ number;
104
129
  /** 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/). */
105
- userReportedSpamRatio?: number;
130
+ userReportedSpamRatio?:
131
+ number;
106
132
  }
107
133
  interface TrafficStatsResource {
108
134
  /** 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. */
109
135
  get(request?: {
110
136
  /** V1 error format. */
111
- "$.xgafv"?: string;
137
+ "$.xgafv"?:
138
+ string;
112
139
  /** OAuth access token. */
113
- access_token?: string;
140
+ access_token?:
141
+ string;
114
142
  /** Data format for response. */
115
- alt?: string;
143
+ alt?:
144
+ string;
116
145
  /** JSONP */
117
- callback?: string;
146
+ callback?:
147
+ string;
118
148
  /** Selector specifying which fields to include in a partial response. */
119
- fields?: string;
149
+ fields?:
150
+ string;
120
151
  /** 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. */
121
- key?: string;
152
+ key?:
153
+ string;
122
154
  /** The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807. */
123
- name: string;
155
+ name:
156
+ string;
124
157
  /** OAuth 2.0 token for the current user. */
125
- oauth_token?: string;
158
+ oauth_token?:
159
+ string;
126
160
  /** Returns response with indentations and line breaks. */
127
- prettyPrint?: boolean;
161
+ prettyPrint?:
162
+ boolean;
128
163
  /** 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. */
129
- quotaUser?: string;
164
+ quotaUser?:
165
+ string;
130
166
  /** Upload protocol for media (e.g. "raw", "multipart"). */
131
- upload_protocol?: string;
167
+ upload_protocol?:
168
+ string;
132
169
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
133
- uploadType?: string;
170
+ uploadType?:
171
+ string;
134
172
  }): Request<TrafficStats>;
135
173
  /** List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain. */
136
174
  list(request?: {
137
175
  /** V1 error format. */
138
- "$.xgafv"?: string;
176
+ "$.xgafv"?:
177
+ string;
139
178
  /** OAuth access token. */
140
- access_token?: string;
179
+ access_token?:
180
+ string;
141
181
  /** Data format for response. */
142
- alt?: string;
182
+ alt?:
183
+ string;
143
184
  /** JSONP */
144
- callback?: string;
185
+ callback?:
186
+ string;
145
187
  /** 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. */
146
- "endDate.day"?: number;
188
+ "endDate.day"?:
189
+ number;
147
190
  /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
148
- "endDate.month"?: number;
191
+ "endDate.month"?:
192
+ number;
149
193
  /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
150
- "endDate.year"?: number;
194
+ "endDate.year"?:
195
+ number;
151
196
  /** Selector specifying which fields to include in a partial response. */
152
- fields?: string;
197
+ fields?:
198
+ string;
153
199
  /** 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. */
154
- key?: string;
200
+ key?:
201
+ string;
155
202
  /** OAuth 2.0 token for the current user. */
156
- oauth_token?: string;
203
+ oauth_token?:
204
+ string;
157
205
  /** Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default. */
158
- pageSize?: number;
206
+ pageSize?:
207
+ number;
159
208
  /**
160
209
  * 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
161
210
  * `ListTrafficStats` method.
162
211
  */
163
- pageToken?: string;
212
+ pageToken?:
213
+ string;
164
214
  /**
165
215
  * 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
166
216
  * name.
167
217
  */
168
- parent: string;
218
+ parent:
219
+ string;
169
220
  /** Returns response with indentations and line breaks. */
170
- prettyPrint?: boolean;
221
+ prettyPrint?:
222
+ boolean;
171
223
  /** 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. */
172
- quotaUser?: string;
224
+ quotaUser?:
225
+ string;
173
226
  /** 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. */
174
- "startDate.day"?: number;
227
+ "startDate.day"?:
228
+ number;
175
229
  /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
176
- "startDate.month"?: number;
230
+ "startDate.month"?:
231
+ number;
177
232
  /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
178
- "startDate.year"?: number;
233
+ "startDate.year"?:
234
+ number;
179
235
  /** Upload protocol for media (e.g. "raw", "multipart"). */
180
- upload_protocol?: string;
236
+ upload_protocol?:
237
+ string;
181
238
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
182
- uploadType?: string;
239
+ uploadType?:
240
+ string;
183
241
  }): Request<ListTrafficStatsResponse>;
184
242
  }
185
243
  interface DomainsResource {
186
244
  /** Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist. */
187
245
  get(request?: {
188
246
  /** V1 error format. */
189
- "$.xgafv"?: string;
247
+ "$.xgafv"?:
248
+ string;
190
249
  /** OAuth access token. */
191
- access_token?: string;
250
+ access_token?:
251
+ string;
192
252
  /** Data format for response. */
193
- alt?: string;
253
+ alt?:
254
+ string;
194
255
  /** JSONP */
195
- callback?: string;
256
+ callback?:
257
+ string;
196
258
  /** Selector specifying which fields to include in a partial response. */
197
- fields?: string;
259
+ fields?:
260
+ string;
198
261
  /** 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. */
199
- key?: string;
262
+ key?:
263
+ string;
200
264
  /** The resource name of the domain. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name. */
201
- name: string;
265
+ name:
266
+ string;
202
267
  /** OAuth 2.0 token for the current user. */
203
- oauth_token?: string;
268
+ oauth_token?:
269
+ string;
204
270
  /** Returns response with indentations and line breaks. */
205
- prettyPrint?: boolean;
271
+ prettyPrint?:
272
+ boolean;
206
273
  /** 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. */
207
- quotaUser?: string;
274
+ quotaUser?:
275
+ string;
208
276
  /** Upload protocol for media (e.g. "raw", "multipart"). */
209
- upload_protocol?: string;
277
+ upload_protocol?:
278
+ string;
210
279
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
211
- uploadType?: string;
280
+ uploadType?:
281
+ string;
212
282
  }): Request<Domain>;
213
283
  /**
214
284
  * 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
@@ -216,36 +286,50 @@ declare namespace gapi.client {
216
286
  */
217
287
  list(request?: {
218
288
  /** V1 error format. */
219
- "$.xgafv"?: string;
289
+ "$.xgafv"?:
290
+ string;
220
291
  /** OAuth access token. */
221
- access_token?: string;
292
+ access_token?:
293
+ string;
222
294
  /** Data format for response. */
223
- alt?: string;
295
+ alt?:
296
+ string;
224
297
  /** JSONP */
225
- callback?: string;
298
+ callback?:
299
+ string;
226
300
  /** Selector specifying which fields to include in a partial response. */
227
- fields?: string;
301
+ fields?:
302
+ string;
228
303
  /** 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. */
229
- key?: string;
304
+ key?:
305
+ string;
230
306
  /** OAuth 2.0 token for the current user. */
231
- oauth_token?: string;
307
+ oauth_token?:
308
+ string;
232
309
  /** Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default. */
233
- pageSize?: number;
310
+ pageSize?:
311
+ number;
234
312
  /**
235
313
  * 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
236
314
  * `ListDomains` method.
237
315
  */
238
- pageToken?: string;
316
+ pageToken?:
317
+ string;
239
318
  /** Returns response with indentations and line breaks. */
240
- prettyPrint?: boolean;
319
+ prettyPrint?:
320
+ boolean;
241
321
  /** 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. */
242
- quotaUser?: string;
322
+ quotaUser?:
323
+ string;
243
324
  /** Upload protocol for media (e.g. "raw", "multipart"). */
244
- upload_protocol?: string;
325
+ upload_protocol?:
326
+ string;
245
327
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
246
- uploadType?: string;
328
+ uploadType?:
329
+ string;
247
330
  }): Request<ListDomainsResponse>;
248
- trafficStats: TrafficStatsResource;
331
+ trafficStats:
332
+ TrafficStatsResource;
249
333
  }
250
334
 
251
335
  const domains: DomainsResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.gmailpostmastertools-v1",
3
- "version": "0.0.20230424",
3
+ "version": "0.0.20230429",
4
4
  "description": "TypeScript typings for Gmail Postmaster Tools API v1",
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: 20230424
6
+ // Revision: 20230429
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */