@maxim_mazurok/gapi.client.dataportability-v1beta 0.0.20240220 → 0.0.20240221
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 +10 -10
- package/package.json +1 -1
- package/readme.md +3 -3
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://dataportability.googleapis.com/$discovery/rest?version=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240221
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -34,13 +34,13 @@ declare namespace gapi.client {
|
|
|
34
34
|
resources?: string[];
|
|
35
35
|
}
|
|
36
36
|
interface InitiatePortabilityArchiveResponse {
|
|
37
|
-
/** The archive job ID that is initiated in the
|
|
37
|
+
/** The archive job ID that is initiated in the API. This can be used to get the state of the job. */
|
|
38
38
|
archiveJobId?: string;
|
|
39
39
|
}
|
|
40
40
|
interface PortabilityArchiveState {
|
|
41
41
|
/** The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request. */
|
|
42
42
|
name?: string;
|
|
43
|
-
/** Resource that represents the state of the
|
|
43
|
+
/** Resource that represents the state of the Archive job. */
|
|
44
44
|
state?: string;
|
|
45
45
|
/** If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket. */
|
|
46
46
|
urls?: string[];
|
|
@@ -48,11 +48,11 @@ declare namespace gapi.client {
|
|
|
48
48
|
interface ResetAuthorizationRequest {}
|
|
49
49
|
interface RetryPortabilityArchiveRequest {}
|
|
50
50
|
interface RetryPortabilityArchiveResponse {
|
|
51
|
-
/** The archive job ID that is initiated by the retry endpoint. This can be used to get the state of the new job */
|
|
51
|
+
/** The archive job ID that is initiated by the retry endpoint. This can be used to get the state of the new job. */
|
|
52
52
|
archiveJobId?: string;
|
|
53
53
|
}
|
|
54
54
|
interface ArchiveJobsResource {
|
|
55
|
-
/** Retrieves the state of
|
|
55
|
+
/** Retrieves the state of an Archive job for the Portability API. */
|
|
56
56
|
getPortabilityArchiveState(request?: {
|
|
57
57
|
/** V1 error format. */
|
|
58
58
|
'$.xgafv'?: string;
|
|
@@ -66,7 +66,7 @@ declare namespace gapi.client {
|
|
|
66
66
|
fields?: string;
|
|
67
67
|
/** 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. */
|
|
68
68
|
key?: string;
|
|
69
|
-
/** Required. The archive job ID that is returned when you request the state of the job
|
|
69
|
+
/** Required. The archive job ID that is returned when you request the state of the job. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID returned by the InitiatePortabilityArchiveResponse. */
|
|
70
70
|
name: string;
|
|
71
71
|
/** OAuth 2.0 token for the current user. */
|
|
72
72
|
oauth_token?: string;
|
|
@@ -93,7 +93,7 @@ declare namespace gapi.client {
|
|
|
93
93
|
fields?: string;
|
|
94
94
|
/** 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. */
|
|
95
95
|
key?: string;
|
|
96
|
-
/** Required. The
|
|
96
|
+
/** Required. The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed. */
|
|
97
97
|
name: string;
|
|
98
98
|
/** OAuth 2.0 token for the current user. */
|
|
99
99
|
oauth_token?: string;
|
|
@@ -122,7 +122,7 @@ declare namespace gapi.client {
|
|
|
122
122
|
fields?: string;
|
|
123
123
|
/** 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. */
|
|
124
124
|
key?: string;
|
|
125
|
-
/** Required. The
|
|
125
|
+
/** Required. The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed. */
|
|
126
126
|
name: string;
|
|
127
127
|
/** OAuth 2.0 token for the current user. */
|
|
128
128
|
oauth_token?: string;
|
|
@@ -139,7 +139,7 @@ declare namespace gapi.client {
|
|
|
139
139
|
): Request<RetryPortabilityArchiveResponse>;
|
|
140
140
|
}
|
|
141
141
|
interface AuthorizationResource {
|
|
142
|
-
/** Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a
|
|
142
|
+
/** Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a request after a new consent is granted. This method also indicates that previous archives can be garbage collected. You should call this method when all jobs are complete and all archives are downloaded. Do not call it only when you start a new job. */
|
|
143
143
|
reset(request: {
|
|
144
144
|
/** V1 error format. */
|
|
145
145
|
'$.xgafv'?: string;
|
|
@@ -195,7 +195,7 @@ declare namespace gapi.client {
|
|
|
195
195
|
): Request<{}>;
|
|
196
196
|
}
|
|
197
197
|
interface PortabilityArchiveResource {
|
|
198
|
-
/** Initiates a new
|
|
198
|
+
/** Initiates a new Archive job for the Portability API. */
|
|
199
199
|
initiate(request: {
|
|
200
200
|
/** V1 error format. */
|
|
201
201
|
'$.xgafv'?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -145,7 +145,7 @@ After that you can use Data Portability API resources: <!-- TODO: make this work
|
|
|
145
145
|
|
|
146
146
|
```typescript
|
|
147
147
|
/*
|
|
148
|
-
Retrieves the state of
|
|
148
|
+
Retrieves the state of an Archive job for the Portability API.
|
|
149
149
|
*/
|
|
150
150
|
await gapi.client.dataportability.archiveJobs.getPortabilityArchiveState({
|
|
151
151
|
name: 'name',
|
|
@@ -157,12 +157,12 @@ Retries a failed Portability Archive job.
|
|
|
157
157
|
await gapi.client.dataportability.archiveJobs.retry({name: 'name'});
|
|
158
158
|
|
|
159
159
|
/*
|
|
160
|
-
Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a
|
|
160
|
+
Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a request after a new consent is granted. This method also indicates that previous archives can be garbage collected. You should call this method when all jobs are complete and all archives are downloaded. Do not call it only when you start a new job.
|
|
161
161
|
*/
|
|
162
162
|
await gapi.client.dataportability.authorization.reset({});
|
|
163
163
|
|
|
164
164
|
/*
|
|
165
|
-
Initiates a new
|
|
165
|
+
Initiates a new Archive job for the Portability API.
|
|
166
166
|
*/
|
|
167
167
|
await gapi.client.dataportability.portabilityArchive.initiate({});
|
|
168
168
|
```
|