@platzio/sdk 0.6.0-beta.2 → 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 (7) hide show
  1. package/dist/index.d.mts +338 -1
  2. package/dist/index.d.ts +338 -1
  3. package/dist/index.js +283 -0
  4. package/dist/index.mjs +279 -0
  5. package/openapi.yaml +180 -0
  6. package/package.json +1 -1
  7. package/src/api.ts +532 -0
package/openapi.yaml CHANGED
@@ -51,6 +51,145 @@ 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: []
54
193
  /api/v2/bots:
55
194
  get:
56
195
  tags:
@@ -2668,6 +2807,26 @@ components:
2668
2807
  format: date-time
2669
2808
  display_name:
2670
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
2671
2830
  CancelDeploymentTask:
2672
2831
  type: object
2673
2832
  required:
@@ -3086,6 +3245,14 @@ components:
3086
3245
  git_provider:
3087
3246
  type: string
3088
3247
  nullable: true
3248
+ CreateBotToken:
3249
+ type: object
3250
+ required:
3251
+ - bot_id
3252
+ properties:
3253
+ bot_id:
3254
+ type: string
3255
+ format: uuid
3089
3256
  CreateDeploymentTask:
3090
3257
  type: object
3091
3258
  required:
@@ -3110,6 +3277,13 @@ components:
3110
3277
  type: string
3111
3278
  format: uuid
3112
3279
  nullable: true
3280
+ CreatedBotToken:
3281
+ type: object
3282
+ required:
3283
+ - created_token
3284
+ properties:
3285
+ created_token:
3286
+ type: string
3113
3287
  CreatedUserToken:
3114
3288
  type: object
3115
3289
  required:
@@ -4559,6 +4733,12 @@ tags:
4559
4733
  description: This collection contains all users in Platz.
4560
4734
  - name: Bots
4561
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.
4562
4742
  - name: Events
4563
4743
  description: Events sent through the Websocket.
4564
4744
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@platzio/sdk",
3
- "version": "0.6.0-beta.2",
3
+ "version": "0.6.0-beta.3",
4
4
  "description": "Platz.io SDK",
5
5
  "homepage": "https://platz.io",
6
6
  "repository": {