@maxim_mazurok/gapi.client.gmailpostmastertools-v2 0.0.20260312 → 0.1.20260604
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.
- package/index.d.ts +59 -24
- package/package.json +1 -1
- package/readme.md +17 -0
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=v2
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260604
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -30,7 +30,16 @@ declare namespace gapi.client {
|
|
|
30
30
|
namespace gmailpostmastertools {
|
|
31
31
|
interface BaseMetric {
|
|
32
32
|
/** A predefined standard metric. */
|
|
33
|
-
standardMetric?:
|
|
33
|
+
standardMetric?:
|
|
34
|
+
| 'STANDARD_METRIC_UNSPECIFIED'
|
|
35
|
+
| 'FEEDBACK_LOOP_ID'
|
|
36
|
+
| 'FEEDBACK_LOOP_SPAM_RATE'
|
|
37
|
+
| 'SPAM_RATE'
|
|
38
|
+
| 'AUTH_SUCCESS_RATE'
|
|
39
|
+
| 'TLS_ENCRYPTION_MESSAGE_COUNT'
|
|
40
|
+
| 'TLS_ENCRYPTION_RATE'
|
|
41
|
+
| 'DELIVERY_ERROR_COUNT'
|
|
42
|
+
| 'DELIVERY_ERROR_RATE';
|
|
34
43
|
}
|
|
35
44
|
interface BatchQueryDomainStatsRequest {
|
|
36
45
|
/** Required. A list of individual query requests. Each request can be for a different domain. A maximum of 100 requests can be included in a single batch. */
|
|
@@ -48,13 +57,25 @@ declare namespace gapi.client {
|
|
|
48
57
|
}
|
|
49
58
|
interface ComplianceRowData {
|
|
50
59
|
/** The compliance requirement. */
|
|
51
|
-
requirement?:
|
|
60
|
+
requirement?:
|
|
61
|
+
| 'COMPLIANCE_REQUIREMENT_UNSPECIFIED'
|
|
62
|
+
| 'SPF'
|
|
63
|
+
| 'DKIM'
|
|
64
|
+
| 'SPF_AND_DKIM'
|
|
65
|
+
| 'DMARC_POLICY'
|
|
66
|
+
| 'DMARC_ALIGNMENT'
|
|
67
|
+
| 'MESSAGE_FORMATTING'
|
|
68
|
+
| 'DNS_RECORDS'
|
|
69
|
+
| 'ENCRYPTION'
|
|
70
|
+
| 'USER_REPORTED_SPAM_RATE'
|
|
71
|
+
| 'ONE_CLICK_UNSUBSCRIBE'
|
|
72
|
+
| 'HONOR_UNSUBSCRIBE';
|
|
52
73
|
/** The compliance status for the requirement. */
|
|
53
74
|
status?: ComplianceStatus;
|
|
54
75
|
}
|
|
55
76
|
interface ComplianceStatus {
|
|
56
77
|
/** Output only. The compliance status. */
|
|
57
|
-
status?:
|
|
78
|
+
status?: 'STATE_UNSPECIFIED' | 'COMPLIANT' | 'NEEDS_WORK';
|
|
58
79
|
}
|
|
59
80
|
interface Date {
|
|
60
81
|
/** 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. */
|
|
@@ -86,9 +107,12 @@ declare namespace gapi.client {
|
|
|
86
107
|
/** Identifier. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com). */
|
|
87
108
|
name?: string;
|
|
88
109
|
/** Output only. User's permission of this domain. */
|
|
89
|
-
permission?:
|
|
110
|
+
permission?: 'PERMISSION_UNSPECIFIED' | 'READER' | 'OWNER' | 'NONE';
|
|
90
111
|
/** Output only. Information about a user's verification history and properties for the domain. */
|
|
91
|
-
verificationState?:
|
|
112
|
+
verificationState?:
|
|
113
|
+
| 'VERIFICATION_STATE_UNSPECIFIED'
|
|
114
|
+
| 'UNVERIFIED'
|
|
115
|
+
| 'VERIFIED';
|
|
92
116
|
}
|
|
93
117
|
interface DomainComplianceData {
|
|
94
118
|
/** Domain that this data is for. */
|
|
@@ -120,7 +144,11 @@ declare namespace gapi.client {
|
|
|
120
144
|
}
|
|
121
145
|
interface HonorUnsubscribeVerdict {
|
|
122
146
|
/** The specific reason for the compliance verdict. Must be empty if the status is compliant. */
|
|
123
|
-
reason?:
|
|
147
|
+
reason?:
|
|
148
|
+
| 'REASON_UNSPECIFIED'
|
|
149
|
+
| 'NOT_HONORING'
|
|
150
|
+
| 'NOT_HONORING_TOO_FEW_CAMPAIGNS'
|
|
151
|
+
| 'NOT_HONORING_TOO_MANY_CAMPAIGNS';
|
|
124
152
|
/** The compliance status. */
|
|
125
153
|
status?: ComplianceStatus;
|
|
126
154
|
}
|
|
@@ -140,13 +168,20 @@ declare namespace gapi.client {
|
|
|
140
168
|
}
|
|
141
169
|
interface OneClickUnsubscribeVerdict {
|
|
142
170
|
/** The specific reason for the compliance verdict. Must be empty if the status is compliant. */
|
|
143
|
-
reason?:
|
|
171
|
+
reason?:
|
|
172
|
+
| 'REASON_UNSPECIFIED'
|
|
173
|
+
| 'NO_UNSUB_GENERAL'
|
|
174
|
+
| 'NO_UNSUB_SPAM_REPORTS'
|
|
175
|
+
| 'NO_UNSUB_PROMO_SPAM_REPORTS';
|
|
144
176
|
/** The compliance status. */
|
|
145
177
|
status?: ComplianceStatus;
|
|
146
178
|
}
|
|
147
179
|
interface QueryDomainStatsRequest {
|
|
148
180
|
/** Optional. The granularity at which to aggregate the statistics. If unspecified, defaults to DAILY. */
|
|
149
|
-
aggregationGranularity?:
|
|
181
|
+
aggregationGranularity?:
|
|
182
|
+
| 'AGGREGATION_GRANULARITY_UNSPECIFIED'
|
|
183
|
+
| 'DAILY'
|
|
184
|
+
| 'OVERALL';
|
|
150
185
|
/** Required. The specific metrics to query. You can define a custom name for each metric, which will be used in the response. */
|
|
151
186
|
metricDefinitions?: MetricDefinition[];
|
|
152
187
|
/** Optional. The maximum number of DomainStats resources to return in the response. The server may return fewer than this value. If unspecified, a default value of 10 will be used. The maximum value is 200. */
|
|
@@ -180,7 +215,7 @@ declare namespace gapi.client {
|
|
|
180
215
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
181
216
|
code?: number;
|
|
182
217
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
183
|
-
details?:
|
|
218
|
+
details?: {[P in string]: any}[];
|
|
184
219
|
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
185
220
|
message?: string;
|
|
186
221
|
}
|
|
@@ -198,11 +233,11 @@ declare namespace gapi.client {
|
|
|
198
233
|
/** Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates where data is available. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for the domain. */
|
|
199
234
|
query(request: {
|
|
200
235
|
/** V1 error format. */
|
|
201
|
-
'$.xgafv'?:
|
|
236
|
+
'$.xgafv'?: '1' | '2';
|
|
202
237
|
/** OAuth access token. */
|
|
203
238
|
access_token?: string;
|
|
204
239
|
/** Data format for response. */
|
|
205
|
-
alt?:
|
|
240
|
+
alt?: 'json' | 'media' | 'proto';
|
|
206
241
|
/** JSONP */
|
|
207
242
|
callback?: string;
|
|
208
243
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -227,11 +262,11 @@ declare namespace gapi.client {
|
|
|
227
262
|
query(
|
|
228
263
|
request: {
|
|
229
264
|
/** V1 error format. */
|
|
230
|
-
'$.xgafv'?:
|
|
265
|
+
'$.xgafv'?: '1' | '2';
|
|
231
266
|
/** OAuth access token. */
|
|
232
267
|
access_token?: string;
|
|
233
268
|
/** Data format for response. */
|
|
234
|
-
alt?:
|
|
269
|
+
alt?: 'json' | 'media' | 'proto';
|
|
235
270
|
/** JSONP */
|
|
236
271
|
callback?: string;
|
|
237
272
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -258,11 +293,11 @@ declare namespace gapi.client {
|
|
|
258
293
|
/** Retrieves detailed information about a domain registered by you. Returns NOT_FOUND if the domain is not registered by you. Domain represents the metadata of a domain that has been registered within the system and linked to a user. */
|
|
259
294
|
get(request?: {
|
|
260
295
|
/** V1 error format. */
|
|
261
|
-
'$.xgafv'?:
|
|
296
|
+
'$.xgafv'?: '1' | '2';
|
|
262
297
|
/** OAuth access token. */
|
|
263
298
|
access_token?: string;
|
|
264
299
|
/** Data format for response. */
|
|
265
|
-
alt?:
|
|
300
|
+
alt?: 'json' | 'media' | 'proto';
|
|
266
301
|
/** JSONP */
|
|
267
302
|
callback?: string;
|
|
268
303
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -285,11 +320,11 @@ declare namespace gapi.client {
|
|
|
285
320
|
/** Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don't have permission to access compliance status for the domain. */
|
|
286
321
|
getComplianceStatus(request?: {
|
|
287
322
|
/** V1 error format. */
|
|
288
|
-
'$.xgafv'?:
|
|
323
|
+
'$.xgafv'?: '1' | '2';
|
|
289
324
|
/** OAuth access token. */
|
|
290
325
|
access_token?: string;
|
|
291
326
|
/** Data format for response. */
|
|
292
|
-
alt?:
|
|
327
|
+
alt?: 'json' | 'media' | 'proto';
|
|
293
328
|
/** JSONP */
|
|
294
329
|
callback?: string;
|
|
295
330
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -312,11 +347,11 @@ declare namespace gapi.client {
|
|
|
312
347
|
/** Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and non-deterministic. Newly registered domains will not necessarily be added to the end of this list. */
|
|
313
348
|
list(request?: {
|
|
314
349
|
/** V1 error format. */
|
|
315
|
-
'$.xgafv'?:
|
|
350
|
+
'$.xgafv'?: '1' | '2';
|
|
316
351
|
/** OAuth access token. */
|
|
317
352
|
access_token?: string;
|
|
318
353
|
/** Data format for response. */
|
|
319
|
-
alt?:
|
|
354
|
+
alt?: 'json' | 'media' | 'proto';
|
|
320
355
|
/** JSONP */
|
|
321
356
|
callback?: string;
|
|
322
357
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -344,11 +379,11 @@ declare namespace gapi.client {
|
|
|
344
379
|
/** Executes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for any of the requested domains. */
|
|
345
380
|
batchQuery(request: {
|
|
346
381
|
/** V1 error format. */
|
|
347
|
-
'$.xgafv'?:
|
|
382
|
+
'$.xgafv'?: '1' | '2';
|
|
348
383
|
/** OAuth access token. */
|
|
349
384
|
access_token?: string;
|
|
350
385
|
/** Data format for response. */
|
|
351
|
-
alt?:
|
|
386
|
+
alt?: 'json' | 'media' | 'proto';
|
|
352
387
|
/** JSONP */
|
|
353
388
|
callback?: string;
|
|
354
389
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -371,11 +406,11 @@ declare namespace gapi.client {
|
|
|
371
406
|
batchQuery(
|
|
372
407
|
request: {
|
|
373
408
|
/** V1 error format. */
|
|
374
|
-
'$.xgafv'?:
|
|
409
|
+
'$.xgafv'?: '1' | '2';
|
|
375
410
|
/** OAuth access token. */
|
|
376
411
|
access_token?: string;
|
|
377
412
|
/** Data format for response. */
|
|
378
|
-
alt?:
|
|
413
|
+
alt?: 'json' | 'media' | 'proto';
|
|
379
414
|
/** JSONP */
|
|
380
415
|
callback?: string;
|
|
381
416
|
/** Selector specifying which fields to include in a partial response. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for Gmail Postmaster Tools API:
|
|
|
11
11
|
npm install @types/gapi.client.gmailpostmastertools-v2 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.gmailpostmastertools-v2"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|