@maxim_mazurok/gapi.client.slides-v1 0.0.20220802

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/package.json ADDED
@@ -0,0 +1,20 @@
1
+ {
2
+ "name": "@maxim_mazurok/gapi.client.slides-v1",
3
+ "version": "0.0.20220802",
4
+ "description": "TypeScript typings for Google Slides API v1",
5
+ "license": "MIT",
6
+ "author": {
7
+ "email": "maxim@mazurok.com",
8
+ "name": "Maxim Mazurok",
9
+ "url": "https://maxim.mazurok.com"
10
+ },
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
14
+ },
15
+ "types": "index.d.ts",
16
+ "dependencies": {
17
+ "@types/gapi.client": "*",
18
+ "@types/gapi.client.discovery": "*"
19
+ }
20
+ }
package/readme.md ADDED
@@ -0,0 +1,101 @@
1
+ # TypeScript typings for Google Slides API v1
2
+
3
+ Reads and writes Google Slides presentations.
4
+ For detailed description please check [documentation](https://developers.google.com/slides/).
5
+
6
+ ## Installing
7
+
8
+ Install typings for Google Slides API:
9
+
10
+ ```
11
+ npm install @types/gapi.client.slides-v1 --save-dev
12
+ ```
13
+
14
+ ## Usage
15
+
16
+ You need to initialize Google API client in your code:
17
+
18
+ ```typescript
19
+ gapi.load('client', () => {
20
+ // now we can use gapi.client
21
+ // ...
22
+ });
23
+ ```
24
+
25
+ Then load api client wrapper:
26
+
27
+ ```typescript
28
+ gapi.client.load('https://slides.googleapis.com/$discovery/rest?version=v1', () => {
29
+ // now we can use:
30
+ // gapi.client.slides
31
+ });
32
+ ```
33
+
34
+ ```typescript
35
+ // Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
36
+ gapi.client.load('slides', 'v1', () => {
37
+ // now we can use:
38
+ // gapi.client.slides
39
+ });
40
+ ```
41
+
42
+ Don't forget to authenticate your client before sending any request to resources:
43
+
44
+ ```typescript
45
+ // declare client_id registered in Google Developers Console
46
+ var client_id = '',
47
+ scope = [
48
+ // See, edit, create, and delete all of your Google Drive files
49
+ 'https://www.googleapis.com/auth/drive',
50
+
51
+ // See, edit, create, and delete only the specific Google Drive files you use with this app
52
+ 'https://www.googleapis.com/auth/drive.file',
53
+
54
+ // See and download all your Google Drive files
55
+ 'https://www.googleapis.com/auth/drive.readonly',
56
+
57
+ // See, edit, create, and delete all your Google Slides presentations
58
+ 'https://www.googleapis.com/auth/presentations',
59
+
60
+ // See all your Google Slides presentations
61
+ 'https://www.googleapis.com/auth/presentations.readonly',
62
+
63
+ // See, edit, create, and delete all your Google Sheets spreadsheets
64
+ 'https://www.googleapis.com/auth/spreadsheets',
65
+
66
+ // See all your Google Sheets spreadsheets
67
+ 'https://www.googleapis.com/auth/spreadsheets.readonly',
68
+ ],
69
+ immediate = true;
70
+ // ...
71
+
72
+ gapi.auth.authorize(
73
+ { client_id: client_id, scope: scope, immediate: immediate },
74
+ authResult => {
75
+ if (authResult && !authResult.error) {
76
+ /* handle successful authorization */
77
+ } else {
78
+ /* handle authorization error */
79
+ }
80
+ });
81
+ ```
82
+
83
+ After that you can use Google Slides API resources: <!-- TODO: make this work for multiple namespaces -->
84
+
85
+ ```typescript
86
+
87
+ /*
88
+ Applies one or more updates to the presentation. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies: the reply to the third request, and another empty reply, in that order. Because other users may be editing the presentation, the presentation might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the presentation should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.
89
+ */
90
+ await gapi.client.slides.presentations.batchUpdate({ presentationId: "presentationId", });
91
+
92
+ /*
93
+ Creates a blank presentation using the title given in the request. If a `presentationId` is provided, it is used as the ID of the new presentation. Otherwise, a new ID is generated. Other fields in the request, including any provided content, are ignored. Returns the created presentation.
94
+ */
95
+ await gapi.client.slides.presentations.create({ });
96
+
97
+ /*
98
+ Gets the latest version of the specified presentation.
99
+ */
100
+ await gapi.client.slides.presentations.get({ presentationId: "presentationId", });
101
+ ```