@platzio/sdk 0.6.0-beta.1-1 → 0.6.0-beta.3

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 (8) hide show
  1. package/dist/index.d.mts +642 -8
  2. package/dist/index.d.ts +642 -8
  3. package/dist/index.js +508 -0
  4. package/dist/index.mjs +500 -0
  5. package/openapi.yaml +337 -0
  6. package/package.json +1 -1
  7. package/src/api.ts +998 -7
  8. package/version-override.txt +0 -1
package/openapi.yaml CHANGED
@@ -51,6 +51,265 @@ paths:
51
51
  security:
52
52
  - access_token: []
53
53
  - user_token: []
54
+ /api/v2/bot-tokens:
55
+ get:
56
+ tags:
57
+ - Bot Tokens
58
+ operationId: allBotTokens
59
+ parameters:
60
+ - name: bot_id
61
+ in: query
62
+ required: false
63
+ schema:
64
+ type: string
65
+ format: uuid
66
+ nullable: true
67
+ - name: created_by_user_id
68
+ in: query
69
+ required: false
70
+ schema:
71
+ type: string
72
+ format: uuid
73
+ nullable: true
74
+ - name: page
75
+ in: query
76
+ required: false
77
+ schema:
78
+ type: integer
79
+ format: int64
80
+ nullable: true
81
+ - name: per_page
82
+ in: query
83
+ required: false
84
+ schema:
85
+ type: integer
86
+ format: int64
87
+ nullable: true
88
+ responses:
89
+ '200':
90
+ description: ''
91
+ content:
92
+ application/json:
93
+ schema:
94
+ type: object
95
+ required:
96
+ - page
97
+ - per_page
98
+ - items
99
+ - num_total
100
+ properties:
101
+ page:
102
+ type: integer
103
+ format: int64
104
+ example: '1'
105
+ per_page:
106
+ type: integer
107
+ format: int64
108
+ example: '50'
109
+ items:
110
+ type: array
111
+ items:
112
+ type: object
113
+ required:
114
+ - id
115
+ - bot_id
116
+ - created_at
117
+ - created_by_user_id
118
+ properties:
119
+ id:
120
+ type: string
121
+ format: uuid
122
+ bot_id:
123
+ type: string
124
+ format: uuid
125
+ created_at:
126
+ type: string
127
+ format: date-time
128
+ created_by_user_id:
129
+ type: string
130
+ format: uuid
131
+ num_total:
132
+ type: integer
133
+ format: int64
134
+ example: '1'
135
+ security:
136
+ - access_token: []
137
+ post:
138
+ tags:
139
+ - Bot Tokens
140
+ operationId: createBotToken
141
+ requestBody:
142
+ content:
143
+ application/json:
144
+ schema:
145
+ $ref: '#/components/schemas/CreateBotToken'
146
+ required: true
147
+ responses:
148
+ '201':
149
+ description: ''
150
+ content:
151
+ application/json:
152
+ schema:
153
+ $ref: '#/components/schemas/CreatedBotToken'
154
+ security:
155
+ - access_token: []
156
+ /api/v2/bot-tokens/{id}:
157
+ get:
158
+ tags:
159
+ - Bot Tokens
160
+ operationId: getBotToken
161
+ parameters:
162
+ - name: id
163
+ in: path
164
+ required: true
165
+ schema:
166
+ type: string
167
+ format: uuid
168
+ responses:
169
+ '200':
170
+ description: ''
171
+ content:
172
+ application/json:
173
+ schema:
174
+ $ref: '#/components/schemas/BotToken'
175
+ security:
176
+ - access_token: []
177
+ delete:
178
+ tags:
179
+ - Bot Tokens
180
+ operationId: deleteBotToken
181
+ parameters:
182
+ - name: id
183
+ in: path
184
+ required: true
185
+ schema:
186
+ type: string
187
+ format: uuid
188
+ responses:
189
+ '204':
190
+ description: ''
191
+ security:
192
+ - access_token: []
193
+ /api/v2/bots:
194
+ get:
195
+ tags:
196
+ - Bots
197
+ operationId: allBots
198
+ parameters:
199
+ - name: display_name
200
+ in: query
201
+ required: false
202
+ schema:
203
+ type: string
204
+ nullable: true
205
+ - name: page
206
+ in: query
207
+ required: false
208
+ schema:
209
+ type: integer
210
+ format: int64
211
+ nullable: true
212
+ - name: per_page
213
+ in: query
214
+ required: false
215
+ schema:
216
+ type: integer
217
+ format: int64
218
+ nullable: true
219
+ responses:
220
+ '200':
221
+ description: ''
222
+ content:
223
+ application/json:
224
+ schema:
225
+ type: object
226
+ required:
227
+ - page
228
+ - per_page
229
+ - items
230
+ - num_total
231
+ properties:
232
+ page:
233
+ type: integer
234
+ format: int64
235
+ example: '1'
236
+ per_page:
237
+ type: integer
238
+ format: int64
239
+ example: '50'
240
+ items:
241
+ type: array
242
+ items:
243
+ type: object
244
+ required:
245
+ - id
246
+ - created_at
247
+ - display_name
248
+ properties:
249
+ id:
250
+ type: string
251
+ format: uuid
252
+ created_at:
253
+ type: string
254
+ format: date-time
255
+ display_name:
256
+ type: string
257
+ num_total:
258
+ type: integer
259
+ format: int64
260
+ example: '1'
261
+ security:
262
+ - access_token: []
263
+ - user_token: []
264
+ /api/v2/bots/{id}:
265
+ get:
266
+ tags:
267
+ - Bots
268
+ operationId: getBot
269
+ parameters:
270
+ - name: id
271
+ in: path
272
+ required: true
273
+ schema:
274
+ type: string
275
+ format: uuid
276
+ responses:
277
+ '200':
278
+ description: ''
279
+ content:
280
+ application/json:
281
+ schema:
282
+ $ref: '#/components/schemas/Bot'
283
+ security:
284
+ - access_token: []
285
+ - user_token: []
286
+ put:
287
+ tags:
288
+ - Bots
289
+ operationId: updateBot
290
+ parameters:
291
+ - name: id
292
+ in: path
293
+ required: true
294
+ schema:
295
+ type: string
296
+ format: uuid
297
+ requestBody:
298
+ content:
299
+ application/json:
300
+ schema:
301
+ $ref: '#/components/schemas/UpdateBot'
302
+ required: true
303
+ responses:
304
+ '200':
305
+ description: ''
306
+ content:
307
+ application/json:
308
+ schema:
309
+ $ref: '#/components/schemas/Bot'
310
+ security:
311
+ - access_token: []
312
+ - user_token: []
54
313
  /api/v2/deployment-kinds:
55
314
  get:
56
315
  tags:
@@ -2533,6 +2792,41 @@ paths:
2533
2792
  - user_token: []
2534
2793
  components:
2535
2794
  schemas:
2795
+ Bot:
2796
+ type: object
2797
+ required:
2798
+ - id
2799
+ - created_at
2800
+ - display_name
2801
+ properties:
2802
+ id:
2803
+ type: string
2804
+ format: uuid
2805
+ created_at:
2806
+ type: string
2807
+ format: date-time
2808
+ display_name:
2809
+ type: string
2810
+ BotToken:
2811
+ type: object
2812
+ required:
2813
+ - id
2814
+ - bot_id
2815
+ - created_at
2816
+ - created_by_user_id
2817
+ properties:
2818
+ id:
2819
+ type: string
2820
+ format: uuid
2821
+ bot_id:
2822
+ type: string
2823
+ format: uuid
2824
+ created_at:
2825
+ type: string
2826
+ format: date-time
2827
+ created_by_user_id:
2828
+ type: string
2829
+ format: uuid
2536
2830
  CancelDeploymentTask:
2537
2831
  type: object
2538
2832
  required:
@@ -2951,6 +3245,14 @@ components:
2951
3245
  git_provider:
2952
3246
  type: string
2953
3247
  nullable: true
3248
+ CreateBotToken:
3249
+ type: object
3250
+ required:
3251
+ - bot_id
3252
+ properties:
3253
+ bot_id:
3254
+ type: string
3255
+ format: uuid
2954
3256
  CreateDeploymentTask:
2955
3257
  type: object
2956
3258
  required:
@@ -2975,6 +3277,13 @@ components:
2975
3277
  type: string
2976
3278
  format: uuid
2977
3279
  nullable: true
3280
+ CreatedBotToken:
3281
+ type: object
3282
+ required:
3283
+ - created_token
3284
+ properties:
3285
+ created_token:
3286
+ type: string
2978
3287
  CreatedUserToken:
2979
3288
  type: object
2980
3289
  required:
@@ -3012,6 +3321,7 @@ components:
3012
3321
  DbTable:
3013
3322
  type: string
3014
3323
  enum:
3324
+ - bots
3015
3325
  - deployment_kinds
3016
3326
  - deployment_resources
3017
3327
  - deployment_resource_types
@@ -3808,6 +4118,12 @@ components:
3808
4118
  properties:
3809
4119
  User:
3810
4120
  $ref: '#/components/schemas/User'
4121
+ - type: object
4122
+ required:
4123
+ - Bot
4124
+ properties:
4125
+ Bot:
4126
+ $ref: '#/components/schemas/Bot'
3811
4127
  - type: object
3812
4128
  required:
3813
4129
  - Deployment
@@ -3823,6 +4139,13 @@ components:
3823
4139
  format: uuid
3824
4140
  name:
3825
4141
  type: string
4142
+ NewBot:
4143
+ type: object
4144
+ required:
4145
+ - display_name
4146
+ properties:
4147
+ display_name:
4148
+ type: string
3826
4149
  NewDeployment:
3827
4150
  type: object
3828
4151
  required:
@@ -4204,6 +4527,12 @@ components:
4204
4527
  $ref: '#/components/schemas/ChartExtVersionV1Beta1'
4205
4528
  kind:
4206
4529
  $ref: '#/components/schemas/ChartExtKindValuesUi'
4530
+ UpdateBot:
4531
+ type: object
4532
+ properties:
4533
+ display_name:
4534
+ type: string
4535
+ nullable: true
4207
4536
  UpdateDeployment:
4208
4537
  type: object
4209
4538
  properties:
@@ -4402,6 +4731,14 @@ tags:
4402
4731
  User tokens are passed in the `x-platz-token` header.
4403
4732
  - name: Users
4404
4733
  description: This collection contains all users in Platz.
4734
+ - name: Bots
4735
+ description: This collection contains all bots in Platz.
4736
+ - name: Bot Tokens
4737
+ description: |
4738
+ Bot tokens allow bots to authenticate using a long-lived token that can be
4739
+ used in direct API calls, CLI, etc.
4740
+
4741
+ Bot tokens are passed in the `x-platz-token` header.
4405
4742
  - name: Events
4406
4743
  description: Events sent through the Websocket.
4407
4744
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@platzio/sdk",
3
- "version": "0.6.0-beta.1-1",
3
+ "version": "0.6.0-beta.3",
4
4
  "description": "Platz.io SDK",
5
5
  "homepage": "https://platz.io",
6
6
  "repository": {