-
Notifications
You must be signed in to change notification settings - Fork 8
/
widgetDataOutput.ts
258 lines (252 loc) · 10.4 KB
/
widgetDataOutput.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/**
* Miro Developer Platform
* <img src=\"https://content.pstmn.io/47449ea6-0ef7-4af2-bac1-e58a70e61c58/aW1hZ2UucG5n\" width=\"1685\" height=\"593\"> ### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? [Read our introduction page](https://beta.developers.miro.com/docs/introduction) and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - [Quickstart (video):](https://beta.developers.miro.com/docs/try-out-the-rest-api-in-less-than-3-minutes) try the REST API in less than 3 minutes. - [Quickstart (article):](https://beta.developers.miro.com/docs/build-your-first-hello-world-app-1) get started and try the REST API in less than 3 minutes. ### Miro REST API tutorials Check out our how-to articles with step-by-step instructions and code examples so you can: - [Get started with OAuth 2.0 and Miro](https://beta.developers.miro.com/docs/getting-started-with-oauth) ### Miro App Examples Clone our [Miro App Examples repository](https://github.com/miroapp/app-examples) to get inspiration, customize, and explore apps built on top of Miro\'s Developer Platform 2.0.
*
* The version of the OpenAPI document: v2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import {AppCardData} from './appCardData'
import {CardData} from './cardData'
import {CustomField} from './customField'
import {DocumentData} from './documentData'
import {EmbedData} from './embedData'
import {FrameData} from './frameData'
import {ImageData} from './imageData'
import {ShapeData} from './shapeData'
import {StickyNoteData} from './stickyNoteData'
import {TextData} from './textData'
/**
* @internal
* Contains the item data, such as the item title, content, or description.
*/
export class WidgetDataOutput {
/**
* The actual text (content) that appears in the sticky note item.
*/
'content': string
/**
* Type of the embedded item\'s content.
*/
'contentType'?: string
/**
* A short text description to add context about the app card.
*/
'description'?: string
/**
* Html code of the embedded item.
*/
'html'?: string
/**
* Defines how the content in the embed item is displayed on the board. `inline`: The embedded content is displayed directly on the board. `modal`: The embedded content is displayed inside a modal overlay on the board.
*/
'mode'?: string | (typeof WidgetDataOutput.ModeEnum)[keyof typeof WidgetDataOutput.ModeEnum]
/**
* The URL to download the resource. You must use your access token to access the URL. The URL contains the `redirect` parameter and the `format` parameter to control the request execution as described in the following parameters: `format` parameter: By default, the image format is set to the preview image. If you want to download the original image, set the `format` parameter in the URL to `original`. `redirect`: By default, the `redirect` parameter is set to `false` and the resource object containing the URL and the resource type is returned with a 200 OK HTTP code. This URL is valid for 60 seconds. You can use this URL to retrieve the resource file. If the `redirect` parameter is set to `true`, a 307 TEMPORARY_REDIRECT HTTP response is returned. If you follow HTTP 3xx responses as redirects, you will automatically be redirected to the resource file and the content type returned can be `image/png`, \'image/svg\', or \'image/jpg\', depending on the original image type.
*/
'previewUrl'?: string
/**
* Name of the content\'s provider.
*/
'providerName'?: string
/**
* Url of the content\'s provider.
*/
'providerUrl'?: string
/**
* Title of the frame. This title appears at the top of the frame.
*/
'title'?: string
/**
* A [valid URL](https://developers.miro.com/reference/data#embeddata) pointing to the content resource that you want to embed in the board. Possible transport protocols: HTTP, HTTPS.
*/
'url'?: string
/**
* Unique user identifier. In the GUI, the user ID is mapped to the name of the user who is assigned as the owner of the task or activity described in the card. The identifier is numeric, and it is automatically assigned to a user when they first sign up.
*/
'assigneeId'?: string
/**
* The date when the task or activity described in the card is due to be completed. In the GUI, users can select the due date from a calendar. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
*/
'dueDate'?: Date
/**
* Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.
*/
'fields'?: Array<CustomField>
/**
* Defines whether the card is owned by the application making the call.
*/
'owned'?: boolean
/**
* Status indicating whether an app card is connected and in sync with the source. When the source for the app card is deleted, the status returns `disabled`.
*/
'status'?: string | (typeof WidgetDataOutput.StatusEnum)[keyof typeof WidgetDataOutput.StatusEnum]
/**
* The URL to download the resource. You must use your access token to access the URL. The URL contains the `redirect` parameter and the `format` parameter to control the request execution as described in the following parameters: `format` parameter: By default, the image format is set to the preview image. If you want to download the original image, set the `format` parameter in the URL to `original`. `redirect`: By default, the `redirect` parameter is set to `false` and the resource object containing the URL and the resource type is returned with a 200 OK HTTP code. This URL is valid for 60 seconds. You can use this URL to retrieve the resource file. If the `redirect` parameter is set to `true`, a 307 TEMPORARY_REDIRECT HTTP response is returned. If you follow HTTP 3xx responses as redirects, you will automatically be redirected to the resource file and the content type returned can be `image/png`, \'image/svg\', or \'image/jpg\', depending on the original image type.
*/
'imageUrl'?: string
/**
* The URL to download the resource. You must use your access token to access the URL. The URL contains the `redirect` parameter to control the request execution. `redirect`: By default, the `redirect` parameter is set to `false` and the resource object containing the URL and the resource type is returned with a 200 OK HTTP code. This URL is valid for 60 seconds. You can use this URL to retrieve the resource file. If the `redirect` parameter is set to `true`, a 307 TEMPORARY_REDIRECT HTTP response is returned. If you follow HTTP 3xx responses as redirects, you will automatically be redirected to the resource file and the content type returned is `application/octet-stream`.
*/
'documentUrl'?: string
/**
* Defines the geometric shape of the sticky note and aspect ratio for its dimensions.
*/
'shape'?: string | (typeof WidgetDataOutput.ShapeEnum)[keyof typeof WidgetDataOutput.ShapeEnum] =
WidgetDataOutput.ShapeEnum.Square
/**
* Only custom frames are supported at the moment.
*/
'format'?: string | (typeof WidgetDataOutput.FormatEnum)[keyof typeof WidgetDataOutput.FormatEnum] =
WidgetDataOutput.FormatEnum.Custom
/**
* Only free form frames are supported at the moment.
*/
'type'?: string | (typeof WidgetDataOutput.TypeEnum)[keyof typeof WidgetDataOutput.TypeEnum] =
WidgetDataOutput.TypeEnum.Freeform
/** @ignore */
static discriminator: string | undefined = undefined
/** @ignore */
static attributeTypeMap: Array<{name: string; baseName: string; type: string}> = [
{
name: 'content',
baseName: 'content',
type: 'string',
},
{
name: 'contentType',
baseName: 'contentType',
type: 'string',
},
{
name: 'description',
baseName: 'description',
type: 'string',
},
{
name: 'html',
baseName: 'html',
type: 'string',
},
{
name: 'mode',
baseName: 'mode',
type: 'WidgetDataOutput.ModeEnum',
},
{
name: 'previewUrl',
baseName: 'previewUrl',
type: 'string',
},
{
name: 'providerName',
baseName: 'providerName',
type: 'string',
},
{
name: 'providerUrl',
baseName: 'providerUrl',
type: 'string',
},
{
name: 'title',
baseName: 'title',
type: 'string',
},
{
name: 'url',
baseName: 'url',
type: 'string',
},
{
name: 'assigneeId',
baseName: 'assigneeId',
type: 'string',
},
{
name: 'dueDate',
baseName: 'dueDate',
type: 'Date',
},
{
name: 'fields',
baseName: 'fields',
type: 'Array<CustomField>',
},
{
name: 'owned',
baseName: 'owned',
type: 'boolean',
},
{
name: 'status',
baseName: 'status',
type: 'WidgetDataOutput.StatusEnum',
},
{
name: 'imageUrl',
baseName: 'imageUrl',
type: 'string',
},
{
name: 'documentUrl',
baseName: 'documentUrl',
type: 'string',
},
{
name: 'shape',
baseName: 'shape',
type: 'WidgetDataOutput.ShapeEnum',
},
{
name: 'format',
baseName: 'format',
type: 'WidgetDataOutput.FormatEnum',
},
{
name: 'type',
baseName: 'type',
type: 'WidgetDataOutput.TypeEnum',
},
]
/** @ignore */
static getAttributeTypeMap() {
return WidgetDataOutput.attributeTypeMap
}
}
export namespace WidgetDataOutput {
export const ModeEnum = {
Inline: 'inline',
Modal: 'modal',
} as const
export const StatusEnum = {
Disconnected: 'disconnected',
Connected: 'connected',
Disabled: 'disabled',
} as const
export const ShapeEnum = {
Square: 'square',
Rectangle: 'rectangle',
} as const
export const FormatEnum = {
Custom: 'custom',
Desktop: 'desktop',
Phone: 'phone',
Tablet: 'tablet',
A4: 'a4',
Letter: 'letter',
Ratio1x1: 'ratio_1x1',
Ratio4x3: 'ratio_4x3',
Ratio16x9: 'ratio_16x9',
} as const
export const TypeEnum = {
Freeform: 'freeform',
Heap: 'heap',
Grid: 'grid',
Rows: 'rows',
Columns: 'columns',
} as const
}