@meshery/schemas 1.3.20 → 1.3.21

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 (36) hide show
  1. package/dist/cloudApi.d.mts +431 -17
  2. package/dist/cloudApi.d.ts +431 -17
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta2/key/Key.d.ts +18 -3
  6. package/dist/constructs/v1beta2/key/KeySchema.js +1 -1
  7. package/dist/constructs/v1beta2/key/KeySchema.mjs +1 -1
  8. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +18 -3
  9. package/dist/constructs/v1beta2/keychain/KeychainSchema.js +1 -1
  10. package/dist/constructs/v1beta2/keychain/KeychainSchema.mjs +1 -1
  11. package/dist/constructs/v1beta2/view/View.d.ts +12 -2
  12. package/dist/constructs/v1beta2/view/ViewSchema.js +2 -2
  13. package/dist/constructs/v1beta2/view/ViewSchema.mjs +2 -2
  14. package/dist/constructs/v1beta3/academy/Academy.d.ts +10 -0
  15. package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
  16. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
  17. package/dist/constructs/v1beta3/connection/Connection.d.ts +793 -11
  18. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
  19. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
  20. package/dist/constructs/v1beta3/environment/Environment.d.ts +18 -3
  21. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
  22. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
  23. package/dist/constructs/v1beta3/event/Event.d.ts +19 -2
  24. package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
  25. package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
  26. package/dist/constructs/v1beta3/token/Token.d.ts +12 -2
  27. package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
  28. package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
  29. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +36 -6
  30. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
  31. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
  32. package/dist/mesheryApi.d.mts +406 -10
  33. package/dist/mesheryApi.d.ts +406 -10
  34. package/dist/mesheryApi.js +1 -1
  35. package/dist/mesheryApi.mjs +1 -1
  36. package/package.json +1 -1
@@ -578,7 +578,9 @@ type GetUserKeysApiArg = {
578
578
  orgId: string;
579
579
  /** Get responses by page */
580
580
  page?: string;
581
- /** Get responses by pagesize */
581
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
582
+ pageSize?: number;
583
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
582
584
  pagesize?: string;
583
585
  };
584
586
  type GetKeysApiResponse = {
@@ -613,7 +615,9 @@ type GetKeysApiResponse = {
613
615
  type GetKeysApiArg = {
614
616
  /** Get responses by page */
615
617
  page?: string;
616
- /** Get responses by pagesize */
618
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
619
+ pageSize?: number;
620
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
617
621
  pagesize?: string;
618
622
  /** Get responses that match search param value */
619
623
  search?: string;
@@ -709,7 +713,9 @@ type GetKeychainsApiResponse = {
709
713
  type GetKeychainsApiArg = {
710
714
  /** Get responses by page */
711
715
  page?: string;
712
- /** Get responses by pagesize */
716
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
717
+ pageSize?: number;
718
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
713
719
  pagesize?: string;
714
720
  /** Get responses that match search param value */
715
721
  search?: string;
@@ -833,7 +839,9 @@ type GetKeysOfKeychainApiArg = {
833
839
  keychainId: string;
834
840
  /** Get responses by page */
835
841
  page?: string;
836
- /** Get responses by pagesize */
842
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
843
+ pageSize?: number;
844
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
837
845
  pagesize?: string;
838
846
  /** Get responses that match search param value */
839
847
  search?: string;
@@ -3000,7 +3008,9 @@ type GetViewsApiArg = {
3000
3008
  order?: string;
3001
3009
  /** Get responses by page */
3002
3010
  page?: string;
3003
- /** Get responses by pagesize */
3011
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
3012
+ pageSize?: number;
3013
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
3004
3014
  pagesize?: string;
3005
3015
  /** JSON-encoded filter string for assignment and soft-delete filters. */
3006
3016
  filter?: string;
@@ -3480,6 +3490,8 @@ type GetAcademyCurriculaApiArg = {
3480
3490
  /** Order of sorting (asc or desc) */
3481
3491
  order?: "asc" | "desc";
3482
3492
  /** Number of results per page */
3493
+ pageSize?: number;
3494
+ /** Number of results per page. Deprecated alias of pageSize. */
3483
3495
  pagesize?: number;
3484
3496
  /** Page number */
3485
3497
  page?: number;
@@ -4808,6 +4820,8 @@ type GetAcademyAdminRegistrationsApiResponse = {
4808
4820
  };
4809
4821
  type GetAcademyAdminRegistrationsApiArg = {
4810
4822
  /** Number of results per page */
4823
+ pageSize?: number;
4824
+ /** Number of results per page. Deprecated alias of pageSize. */
4811
4825
  pagesize?: number;
4812
4826
  /** Page number */
4813
4827
  page?: number;
@@ -6157,7 +6171,197 @@ type ListConnectionDefinitionsApiArg = {
6157
6171
  };
6158
6172
  type RegisterConnectionDefinitionApiResponse = any;
6159
6173
  type RegisterConnectionDefinitionApiArg = {
6160
- body: any;
6174
+ body: {
6175
+ /** Existing connection definition ID for updates; omit on create. */
6176
+ id?: string;
6177
+ /** Specifies the version of the schema the definition conforms to. */
6178
+ schemaVersion?: string;
6179
+ /** Connection definition name */
6180
+ name: string;
6181
+ /** Human-readable description of the connection definition and its purpose. */
6182
+ description?: string;
6183
+ /** URL of the remote resource connections of this kind point to. */
6184
+ url?: string;
6185
+ /** Connection kind (e.g., kubernetes, prometheus, grafana) */
6186
+ kind: string;
6187
+ /** Connection type (platform, telemetry, collaboration) */
6188
+ type: string;
6189
+ /** Connection sub-type (cloud, identity, metrics, chat, git, orchestration) */
6190
+ subType: string;
6191
+ /** Connection Status Value */
6192
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
6193
+ /** Reference to the registered model that owns this connection definition. */
6194
+ modelReference?: {
6195
+ /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
6196
+ id: string;
6197
+ /** The unique name for the model within the scope of a registrant. */
6198
+ name: string;
6199
+ /** Version of the model definition. */
6200
+ version: string;
6201
+ /** Human-readable name for the model. */
6202
+ displayName: string;
6203
+ /** Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
6204
+ model: {
6205
+ /** Version of the model as defined by the registrant. */
6206
+ version: string;
6207
+ };
6208
+ registrant: {
6209
+ /** Kind of the registrant. */
6210
+ kind: string;
6211
+ };
6212
+ };
6213
+ /** Kind-specific connection metadata */
6214
+ metadata?: object;
6215
+ /** Schema for the credential associated with connections of this kind. */
6216
+ credentialSchema?: object;
6217
+ /** Schema for connections of this kind. */
6218
+ connectionSchema?: object;
6219
+ /** Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
6220
+ styles?: {
6221
+ /** Primary color of the component used for UI representation. */
6222
+ primaryColor: string;
6223
+ /** Secondary color of the entity used for UI representation. */
6224
+ secondaryColor?: string;
6225
+ /** White SVG of the entity used for UI representation on dark background. */
6226
+ svgWhite: string;
6227
+ /** Colored SVG of the entity used for UI representation on light background. */
6228
+ svgColor: string;
6229
+ /** Complete SVG of the entity used for UI representation, often inclusive of background. */
6230
+ svgComplete: string;
6231
+ /** The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
6232
+ color?: string;
6233
+ /** The opacity of the label text, including its outline. */
6234
+ textOpacity?: number;
6235
+ /** A comma-separated list of font names to use on the label text. */
6236
+ fontFamily?: string;
6237
+ /** The size of the label text. */
6238
+ fontSize?: string;
6239
+ /** A CSS font style to be applied to the label text. */
6240
+ fontStyle?: string;
6241
+ /** A CSS font weight to be applied to the label text. */
6242
+ fontWeight?: string;
6243
+ /** A transformation to apply to the label text */
6244
+ textTransform?: "none" | "uppercase" | "lowercase";
6245
+ /** The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
6246
+ opacity?: number;
6247
+ /** An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
6248
+ zIndex?: number;
6249
+ /** The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
6250
+ label?: string;
6251
+ /** The animation to apply to the element. example ripple,bounce,etc */
6252
+ animation?: object;
6253
+ [key: string]: any;
6254
+ } & {
6255
+ /** The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes) */
6256
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
6257
+ /** The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
6258
+ position?: {
6259
+ /** The x-coordinate of the node. */
6260
+ x: number;
6261
+ /** The y-coordinate of the node. */
6262
+ y: number;
6263
+ };
6264
+ /** The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
6265
+ bodyText?: string;
6266
+ /** How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'. */
6267
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
6268
+ /** The maximum width for wrapping text in the node. */
6269
+ bodyTextMaxWidth?: string;
6270
+ /** The opacity of the node's body text, including its outline. */
6271
+ bodyTextOpacity?: number;
6272
+ /** The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
6273
+ bodyTextBackgroundColor?: string;
6274
+ /** The size of the node's body text. */
6275
+ bodyTextFontSize?: number;
6276
+ /** The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
6277
+ bodyTextColor?: string;
6278
+ /** A CSS font weight to be applied to the node's body text. */
6279
+ bodyTextFontWeight?: string;
6280
+ /** A CSS horizontal alignment to be applied to the node's body text. */
6281
+ bodyTextHorizontalAlign?: string;
6282
+ /** A CSS text decoration to be applied to the node's body text. */
6283
+ bodyTextDecoration?: string;
6284
+ /** A CSS vertical alignment to be applied to the node's body text. */
6285
+ bodyTextVerticalAlign?: string;
6286
+ /** The width of the node's body or the width of an edge's line. */
6287
+ width?: number;
6288
+ /** The height of the node's body */
6289
+ height?: number;
6290
+ /** The URL that points to the image to show in the node. */
6291
+ backgroundImage?: string;
6292
+ /** The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
6293
+ backgroundColor?: string;
6294
+ /** Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
6295
+ backgroundBlacken?: number;
6296
+ /** The opacity level of the node's background colour */
6297
+ backgroundOpacity?: number;
6298
+ /** The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
6299
+ backgroundPositionX?: string;
6300
+ /** The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
6301
+ backgroundPositionY?: string;
6302
+ /** The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
6303
+ backgroundOffsetX?: string;
6304
+ /** The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
6305
+ backgroundOffsetY?: string;
6306
+ /** How the background image is fit to the node. Can be 'none', 'contain', or 'cover'. */
6307
+ backgroundFit?: "none" | "contain" | "cover";
6308
+ /** How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'. */
6309
+ backgroundClip?: "none" | "node" | "node-border";
6310
+ /** How the background image's width is determined. Can be 'none', 'inner', or 'outer'. */
6311
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
6312
+ /** How the background image's height is determined. Can be 'none', 'inner', or 'outer'. */
6313
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
6314
+ /** The size of the node's border. */
6315
+ borderWidth?: number;
6316
+ /** The style of the node's border */
6317
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
6318
+ /** The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
6319
+ borderColor?: string;
6320
+ /** The opacity of the node's border */
6321
+ borderOpacity?: number;
6322
+ /** The amount of padding around all sides of the node. */
6323
+ padding?: number;
6324
+ /** The horizontal alignment of a node's label */
6325
+ textHalign?: "left" | "center" | "right";
6326
+ /** The vertical alignment of a node's label */
6327
+ textValign?: "top" | "center" | "bottom";
6328
+ /** Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset. */
6329
+ ghost?: "yes" | "no";
6330
+ /** The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
6331
+ activeBgColor?: string;
6332
+ /** The opacity of the active background indicator. Selector needs to be *core*. */
6333
+ activeBgOpacity?: string;
6334
+ /** The opacity of the active background indicator. Selector needs to be *core*. */
6335
+ activeBgSize?: string;
6336
+ /** The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
6337
+ selectionBoxColor?: string;
6338
+ /** The size of the border on the selection box. Selector needs to be *core* */
6339
+ selectionBoxBorderWidth?: number;
6340
+ /** The opacity of the selection box. Selector needs to be *core* */
6341
+ selectionBoxOpacity?: number;
6342
+ /** The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
6343
+ outsideTextureBgColor?: string;
6344
+ /** The opacity of the area outside the viewport texture. Selector needs to be *core* */
6345
+ outsideTextureBgOpacity?: number;
6346
+ /** An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
6347
+ shapePolygonPoints?: string;
6348
+ /** The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
6349
+ menuBackgroundColor?: string;
6350
+ /** The opacity of the background of the component menu. */
6351
+ menuBackgroundOpacity?: number;
6352
+ /** The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
6353
+ menuForgroundColor?: string;
6354
+ };
6355
+ /** Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status. */
6356
+ transitionMap?: {
6357
+ [key: string]: {
6358
+ /** Connection Status Value */
6359
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
6360
+ /** Human-readable explanation of when or why this transition occurs. */
6361
+ description?: string;
6362
+ }[];
6363
+ };
6364
+ };
6161
6365
  };
6162
6366
  type GetConnectionDefinitionApiResponse = any;
6163
6367
  type GetConnectionDefinitionApiArg = {
@@ -6168,7 +6372,197 @@ type UpdateConnectionDefinitionApiResponse = any;
6168
6372
  type UpdateConnectionDefinitionApiArg = {
6169
6373
  /** Connection definition ID */
6170
6374
  connectionDefinitionId: string;
6171
- body: any;
6375
+ body: {
6376
+ /** Existing connection definition ID for updates; omit on create. */
6377
+ id?: string;
6378
+ /** Specifies the version of the schema the definition conforms to. */
6379
+ schemaVersion?: string;
6380
+ /** Connection definition name */
6381
+ name: string;
6382
+ /** Human-readable description of the connection definition and its purpose. */
6383
+ description?: string;
6384
+ /** URL of the remote resource connections of this kind point to. */
6385
+ url?: string;
6386
+ /** Connection kind (e.g., kubernetes, prometheus, grafana) */
6387
+ kind: string;
6388
+ /** Connection type (platform, telemetry, collaboration) */
6389
+ type: string;
6390
+ /** Connection sub-type (cloud, identity, metrics, chat, git, orchestration) */
6391
+ subType: string;
6392
+ /** Connection Status Value */
6393
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
6394
+ /** Reference to the registered model that owns this connection definition. */
6395
+ modelReference?: {
6396
+ /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
6397
+ id: string;
6398
+ /** The unique name for the model within the scope of a registrant. */
6399
+ name: string;
6400
+ /** Version of the model definition. */
6401
+ version: string;
6402
+ /** Human-readable name for the model. */
6403
+ displayName: string;
6404
+ /** Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
6405
+ model: {
6406
+ /** Version of the model as defined by the registrant. */
6407
+ version: string;
6408
+ };
6409
+ registrant: {
6410
+ /** Kind of the registrant. */
6411
+ kind: string;
6412
+ };
6413
+ };
6414
+ /** Kind-specific connection metadata */
6415
+ metadata?: object;
6416
+ /** Schema for the credential associated with connections of this kind. */
6417
+ credentialSchema?: object;
6418
+ /** Schema for connections of this kind. */
6419
+ connectionSchema?: object;
6420
+ /** Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
6421
+ styles?: {
6422
+ /** Primary color of the component used for UI representation. */
6423
+ primaryColor: string;
6424
+ /** Secondary color of the entity used for UI representation. */
6425
+ secondaryColor?: string;
6426
+ /** White SVG of the entity used for UI representation on dark background. */
6427
+ svgWhite: string;
6428
+ /** Colored SVG of the entity used for UI representation on light background. */
6429
+ svgColor: string;
6430
+ /** Complete SVG of the entity used for UI representation, often inclusive of background. */
6431
+ svgComplete: string;
6432
+ /** The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
6433
+ color?: string;
6434
+ /** The opacity of the label text, including its outline. */
6435
+ textOpacity?: number;
6436
+ /** A comma-separated list of font names to use on the label text. */
6437
+ fontFamily?: string;
6438
+ /** The size of the label text. */
6439
+ fontSize?: string;
6440
+ /** A CSS font style to be applied to the label text. */
6441
+ fontStyle?: string;
6442
+ /** A CSS font weight to be applied to the label text. */
6443
+ fontWeight?: string;
6444
+ /** A transformation to apply to the label text */
6445
+ textTransform?: "none" | "uppercase" | "lowercase";
6446
+ /** The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
6447
+ opacity?: number;
6448
+ /** An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
6449
+ zIndex?: number;
6450
+ /** The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
6451
+ label?: string;
6452
+ /** The animation to apply to the element. example ripple,bounce,etc */
6453
+ animation?: object;
6454
+ [key: string]: any;
6455
+ } & {
6456
+ /** The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes) */
6457
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
6458
+ /** The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
6459
+ position?: {
6460
+ /** The x-coordinate of the node. */
6461
+ x: number;
6462
+ /** The y-coordinate of the node. */
6463
+ y: number;
6464
+ };
6465
+ /** The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
6466
+ bodyText?: string;
6467
+ /** How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'. */
6468
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
6469
+ /** The maximum width for wrapping text in the node. */
6470
+ bodyTextMaxWidth?: string;
6471
+ /** The opacity of the node's body text, including its outline. */
6472
+ bodyTextOpacity?: number;
6473
+ /** The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
6474
+ bodyTextBackgroundColor?: string;
6475
+ /** The size of the node's body text. */
6476
+ bodyTextFontSize?: number;
6477
+ /** The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
6478
+ bodyTextColor?: string;
6479
+ /** A CSS font weight to be applied to the node's body text. */
6480
+ bodyTextFontWeight?: string;
6481
+ /** A CSS horizontal alignment to be applied to the node's body text. */
6482
+ bodyTextHorizontalAlign?: string;
6483
+ /** A CSS text decoration to be applied to the node's body text. */
6484
+ bodyTextDecoration?: string;
6485
+ /** A CSS vertical alignment to be applied to the node's body text. */
6486
+ bodyTextVerticalAlign?: string;
6487
+ /** The width of the node's body or the width of an edge's line. */
6488
+ width?: number;
6489
+ /** The height of the node's body */
6490
+ height?: number;
6491
+ /** The URL that points to the image to show in the node. */
6492
+ backgroundImage?: string;
6493
+ /** The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
6494
+ backgroundColor?: string;
6495
+ /** Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
6496
+ backgroundBlacken?: number;
6497
+ /** The opacity level of the node's background colour */
6498
+ backgroundOpacity?: number;
6499
+ /** The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
6500
+ backgroundPositionX?: string;
6501
+ /** The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
6502
+ backgroundPositionY?: string;
6503
+ /** The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
6504
+ backgroundOffsetX?: string;
6505
+ /** The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
6506
+ backgroundOffsetY?: string;
6507
+ /** How the background image is fit to the node. Can be 'none', 'contain', or 'cover'. */
6508
+ backgroundFit?: "none" | "contain" | "cover";
6509
+ /** How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'. */
6510
+ backgroundClip?: "none" | "node" | "node-border";
6511
+ /** How the background image's width is determined. Can be 'none', 'inner', or 'outer'. */
6512
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
6513
+ /** How the background image's height is determined. Can be 'none', 'inner', or 'outer'. */
6514
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
6515
+ /** The size of the node's border. */
6516
+ borderWidth?: number;
6517
+ /** The style of the node's border */
6518
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
6519
+ /** The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
6520
+ borderColor?: string;
6521
+ /** The opacity of the node's border */
6522
+ borderOpacity?: number;
6523
+ /** The amount of padding around all sides of the node. */
6524
+ padding?: number;
6525
+ /** The horizontal alignment of a node's label */
6526
+ textHalign?: "left" | "center" | "right";
6527
+ /** The vertical alignment of a node's label */
6528
+ textValign?: "top" | "center" | "bottom";
6529
+ /** Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset. */
6530
+ ghost?: "yes" | "no";
6531
+ /** The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
6532
+ activeBgColor?: string;
6533
+ /** The opacity of the active background indicator. Selector needs to be *core*. */
6534
+ activeBgOpacity?: string;
6535
+ /** The opacity of the active background indicator. Selector needs to be *core*. */
6536
+ activeBgSize?: string;
6537
+ /** The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
6538
+ selectionBoxColor?: string;
6539
+ /** The size of the border on the selection box. Selector needs to be *core* */
6540
+ selectionBoxBorderWidth?: number;
6541
+ /** The opacity of the selection box. Selector needs to be *core* */
6542
+ selectionBoxOpacity?: number;
6543
+ /** The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
6544
+ outsideTextureBgColor?: string;
6545
+ /** The opacity of the area outside the viewport texture. Selector needs to be *core* */
6546
+ outsideTextureBgOpacity?: number;
6547
+ /** An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
6548
+ shapePolygonPoints?: string;
6549
+ /** The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
6550
+ menuBackgroundColor?: string;
6551
+ /** The opacity of the background of the component menu. */
6552
+ menuBackgroundOpacity?: number;
6553
+ /** The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
6554
+ menuForgroundColor?: string;
6555
+ };
6556
+ /** Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status. */
6557
+ transitionMap?: {
6558
+ [key: string]: {
6559
+ /** Connection Status Value */
6560
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
6561
+ /** Human-readable explanation of when or why this transition occurs. */
6562
+ description?: string;
6563
+ }[];
6564
+ };
6565
+ };
6172
6566
  };
6173
6567
  type DeleteConnectionDefinitionApiResponse = unknown;
6174
6568
  type DeleteConnectionDefinitionApiArg = {
@@ -7770,7 +8164,9 @@ type GetEnvironmentsApiArg = {
7770
8164
  order?: string;
7771
8165
  /** Get responses by page */
7772
8166
  page?: string;
7773
- /** Get responses by pagesize */
8167
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
8168
+ pageSize?: number;
8169
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
7774
8170
  pagesize?: string;
7775
8171
  /** User's organization ID */
7776
8172
  orgId: string;
@@ -7882,7 +8278,9 @@ type GetEnvironmentConnectionsApiArg = {
7882
8278
  order?: string;
7883
8279
  /** Get responses by page */
7884
8280
  page?: string;
7885
- /** Get responses by pagesize */
8281
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
8282
+ pageSize?: number;
8283
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
7886
8284
  pagesize?: string;
7887
8285
  /** JSON-encoded filter string used to scope the connection listing. */
7888
8286
  filter?: string;
@@ -7980,7 +8378,9 @@ type GetEventsOfWorkspaceApiArg = {
7980
8378
  workspaceId: string;
7981
8379
  /** Get responses by page */
7982
8380
  page?: string;
7983
- /** Get responses by pagesize */
8381
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
8382
+ pageSize?: number;
8383
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
7984
8384
  pagesize?: string;
7985
8385
  /** Get responses that match search param value */
7986
8386
  search?: string;
@@ -8072,7 +8472,9 @@ type GetEventTypesApiResponse = {
8072
8472
  type GetEventTypesApiArg = {
8073
8473
  /** Get responses by page */
8074
8474
  page?: string;
8075
- /** Get responses by pagesize */
8475
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
8476
+ pageSize?: number;
8477
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
8076
8478
  pagesize?: string;
8077
8479
  };
8078
8480
  type GetFiltersApiResponse = {
@@ -9474,7 +9876,9 @@ type GetUserTokensApiArg = {
9474
9876
  isOauth?: boolean;
9475
9877
  /** Get responses by page */
9476
9878
  page?: string;
9477
- /** Get responses by pagesize */
9879
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
9880
+ pageSize?: number;
9881
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
9478
9882
  pagesize?: string;
9479
9883
  /** Get responses that match search param value */
9480
9884
  search?: string;
@@ -9661,7 +10065,9 @@ type GetWorkspacesApiArg = {
9661
10065
  order?: string;
9662
10066
  /** Get responses by page */
9663
10067
  page?: string;
9664
- /** Get responses by pagesize */
10068
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
10069
+ pageSize?: number;
10070
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
9665
10071
  pagesize?: string;
9666
10072
  /** JSON-encoded filter string used for assignment and soft-delete filters. */
9667
10073
  filter?: string;
@@ -9791,7 +10197,9 @@ type GetTeamsOfWorkspaceApiArg = {
9791
10197
  order?: string;
9792
10198
  /** Get responses by page */
9793
10199
  page?: string;
9794
- /** Get responses by pagesize */
10200
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
10201
+ pageSize?: number;
10202
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
9795
10203
  pagesize?: string;
9796
10204
  /** JSON-encoded filter string used for assignment and soft-delete filters. */
9797
10205
  filter?: string;
@@ -9871,7 +10279,9 @@ type GetEnvironmentsOfWorkspaceApiArg = {
9871
10279
  order?: string;
9872
10280
  /** Get responses by page */
9873
10281
  page?: string;
9874
- /** Get responses by pagesize */
10282
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
10283
+ pageSize?: number;
10284
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
9875
10285
  pagesize?: string;
9876
10286
  /** JSON-encoded filter string used for assignment and soft-delete filters. */
9877
10287
  filter?: string;
@@ -10788,7 +11198,9 @@ type GetDesignsOfWorkspaceApiArg = {
10788
11198
  order?: string;
10789
11199
  /** Get responses by page */
10790
11200
  page?: string;
10791
- /** Get responses by pagesize */
11201
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
11202
+ pageSize?: number;
11203
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
10792
11204
  pagesize?: string;
10793
11205
  /** JSON-encoded filter string used for assignment and soft-delete filters. */
10794
11206
  filter?: string;
@@ -10870,7 +11282,9 @@ type GetViewsOfWorkspaceApiArg = {
10870
11282
  order?: string;
10871
11283
  /** Get responses by page */
10872
11284
  page?: string;
10873
- /** Get responses by pagesize */
11285
+ /** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
11286
+ pageSize?: number;
11287
+ /** Get responses by pagesize. Deprecated alias of pageSize. */
10874
11288
  pagesize?: string;
10875
11289
  /** JSON-encoded filter string used for assignment and soft-delete filters. */
10876
11290
  filter?: string;