@inneropen/marvin-sdk 4.1.0 → 4.3.0

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.
@@ -1579,7 +1579,7 @@ interface components {
1579
1579
  * Retries
1580
1580
  * @default []
1581
1581
  */
1582
- retries: components["schemas"]["IntegrationRetryRead"][];
1582
+ retries: components["schemas"]["marvin__schemas__group__automation__IntegrationRetryRead"][];
1583
1583
  };
1584
1584
  /**
1585
1585
  * AutomationExecutionRead
@@ -2808,6 +2808,30 @@ interface components {
2808
2808
  /** Message */
2809
2809
  message?: string | null;
2810
2810
  };
2811
+ /** EmbedProviderInfo */
2812
+ EmbedProviderInfo: {
2813
+ /** Key */
2814
+ key: string;
2815
+ /** Name */
2816
+ name: string;
2817
+ /** Kinds */
2818
+ kinds: string[];
2819
+ /** Hosts */
2820
+ hosts: string[];
2821
+ /** Examples */
2822
+ examples: string[];
2823
+ /** Linkonly */
2824
+ linkOnly: boolean;
2825
+ /** Notes */
2826
+ notes?: string | null;
2827
+ };
2828
+ /** EmbedProvidersResponse */
2829
+ EmbedProvidersResponse: {
2830
+ /** Providers */
2831
+ providers: components["schemas"]["EmbedProviderInfo"][];
2832
+ /** Framesources */
2833
+ frameSources: string[];
2834
+ };
2811
2835
  /**
2812
2836
  * EntryAssetRead
2813
2837
  * @description Asset metadata plus entry-specific placement details.
@@ -3944,6 +3968,78 @@ interface components {
3944
3968
  /** Detail */
3945
3969
  detail?: components["schemas"]["ValidationError"][];
3946
3970
  };
3971
+ /** HandledFailurePage */
3972
+ HandledFailurePage: {
3973
+ /** Items */
3974
+ items: components["schemas"]["HandledFailureRead"][];
3975
+ /** Page */
3976
+ page: number;
3977
+ /** Perpage */
3978
+ perPage: number;
3979
+ /** Total */
3980
+ total: number;
3981
+ /**
3982
+ * Since
3983
+ * Format: date-time
3984
+ */
3985
+ since: string;
3986
+ };
3987
+ /**
3988
+ * HandledFailureRead
3989
+ * @description A failed integration step that the provider's error policy took in hand.
3990
+ */
3991
+ HandledFailureRead: {
3992
+ /**
3993
+ * Id
3994
+ * Format: uuid
3995
+ */
3996
+ id: string;
3997
+ /**
3998
+ * Executionid
3999
+ * Format: uuid
4000
+ */
4001
+ executionId: string;
4002
+ /** Runstatus */
4003
+ runStatus: string;
4004
+ /**
4005
+ * Isretry
4006
+ * @default false
4007
+ */
4008
+ isRetry: boolean;
4009
+ /** At */
4010
+ at?: string | null;
4011
+ /** Automationid */
4012
+ automationId?: string | null;
4013
+ /** Automationname */
4014
+ automationName?: string | null;
4015
+ /** Entryid */
4016
+ entryId?: string | null;
4017
+ /** Entrytitle */
4018
+ entryTitle?: string | null;
4019
+ /**
4020
+ * Entryexists
4021
+ * @default false
4022
+ */
4023
+ entryExists: boolean;
4024
+ /** Integrationid */
4025
+ integrationId?: string | null;
4026
+ /** Integrationslug */
4027
+ integrationSlug?: string | null;
4028
+ /** Provider */
4029
+ provider?: string | null;
4030
+ /** Providername */
4031
+ providerName?: string | null;
4032
+ /** Action */
4033
+ action?: string | null;
4034
+ /** Code */
4035
+ code?: string | null;
4036
+ /** Error */
4037
+ error?: string | null;
4038
+ /** Outcome */
4039
+ outcome: string;
4040
+ /** Retrystatus */
4041
+ retryStatus?: string | null;
4042
+ };
3947
4043
  /**
3948
4044
  * HealthCheck
3949
4045
  * @description Response model for the health check endpoint.
@@ -4083,6 +4179,70 @@ interface components {
4083
4179
  [key: string]: unknown;
4084
4180
  };
4085
4181
  };
4182
+ /** IntegrationAlertPage */
4183
+ IntegrationAlertPage: {
4184
+ /** Items */
4185
+ items: components["schemas"]["IntegrationAlertRead"][];
4186
+ /** Page */
4187
+ page: number;
4188
+ /** Perpage */
4189
+ perPage: number;
4190
+ /** Total */
4191
+ total: number;
4192
+ };
4193
+ /**
4194
+ * IntegrationAlertRead
4195
+ * @description One connection alert, open or resolved, with how long it was open and how it ended.
4196
+ */
4197
+ IntegrationAlertRead: {
4198
+ /**
4199
+ * Id
4200
+ * Format: uuid
4201
+ */
4202
+ id: string;
4203
+ /**
4204
+ * Integrationid
4205
+ * Format: uuid
4206
+ */
4207
+ integrationId: string;
4208
+ /** Integrationname */
4209
+ integrationName?: string | null;
4210
+ /** Integrationslug */
4211
+ integrationSlug: string;
4212
+ /** Provider */
4213
+ provider: string;
4214
+ /** Providername */
4215
+ providerName: string;
4216
+ /** Code */
4217
+ code: string;
4218
+ /** Message */
4219
+ message?: string | null;
4220
+ /** Count */
4221
+ count: number;
4222
+ /** Status */
4223
+ status: string;
4224
+ /** Firstat */
4225
+ firstAt?: string | null;
4226
+ /** Lastat */
4227
+ lastAt?: string | null;
4228
+ /** Notifiedat */
4229
+ notifiedAt?: string | null;
4230
+ /** Remindafter */
4231
+ remindAfter?: string | null;
4232
+ /**
4233
+ * Reminderhours
4234
+ * @default 0
4235
+ */
4236
+ reminderHours: number;
4237
+ /** Resolvedat */
4238
+ resolvedAt?: string | null;
4239
+ /** Resolution */
4240
+ resolution?: string | null;
4241
+ /** Resolvedbyname */
4242
+ resolvedByName?: string | null;
4243
+ /** Openseconds */
4244
+ openSeconds?: number | null;
4245
+ };
4086
4246
  /**
4087
4247
  * IntegrationAttention
4088
4248
  * @description An open alert on a connection — "Needs attention" on its card. One per error code, counted.
@@ -4209,6 +4369,52 @@ interface components {
4209
4369
  [key: string]: unknown;
4210
4370
  } | null;
4211
4371
  };
4372
+ /**
4373
+ * IntegrationHealthRow
4374
+ * @description One connection at a glance.
4375
+ */
4376
+ IntegrationHealthRow: {
4377
+ /**
4378
+ * Id
4379
+ * Format: uuid
4380
+ */
4381
+ id: string;
4382
+ /** Name */
4383
+ name: string;
4384
+ /** Slug */
4385
+ slug: string;
4386
+ /** Provider */
4387
+ provider: string;
4388
+ /** Providername */
4389
+ providerName: string;
4390
+ /** Enabled */
4391
+ enabled: boolean;
4392
+ /** Status */
4393
+ status: string;
4394
+ /** Lastcheckedat */
4395
+ lastCheckedAt?: string | null;
4396
+ /** Lasterror */
4397
+ lastError?: string | null;
4398
+ /** Lastsuccessat */
4399
+ lastSuccessAt?: string | null;
4400
+ /**
4401
+ * Failures7D
4402
+ * @default 0
4403
+ */
4404
+ failures7d: number;
4405
+ /**
4406
+ * Openalerts
4407
+ * @default 0
4408
+ */
4409
+ openAlerts: number;
4410
+ /** Alertcodes */
4411
+ alertCodes?: string[];
4412
+ /**
4413
+ * Liveretries
4414
+ * @default 0
4415
+ */
4416
+ liveRetries: number;
4417
+ };
4212
4418
  /**
4213
4419
  * IntegrationOption
4214
4420
  * @description One choice for an action input: the value stored, and what people see.
@@ -4338,47 +4544,6 @@ interface components {
4338
4544
  /** Resolved */
4339
4545
  resolved: number;
4340
4546
  };
4341
- /**
4342
- * IntegrationRetryRead
4343
- * @description A failed integration step's retry chain — pending, parked (waiting for the connection), or done.
4344
- */
4345
- IntegrationRetryRead: {
4346
- /**
4347
- * Id
4348
- * Format: uuid4
4349
- */
4350
- id: string;
4351
- /** Status */
4352
- status: string;
4353
- /** Integrationslug */
4354
- integrationSlug: string;
4355
- /** Action */
4356
- action: string;
4357
- /** Code */
4358
- code: string;
4359
- /** Stepindex */
4360
- stepIndex: number;
4361
- /** Entryid */
4362
- entryId?: string | null;
4363
- /**
4364
- * Attempt
4365
- * @default 0
4366
- */
4367
- attempt: number;
4368
- /**
4369
- * Maxattempts
4370
- * @default 0
4371
- */
4372
- maxAttempts: number;
4373
- /** Nextattemptat */
4374
- nextAttemptAt?: string | null;
4375
- /** Finishedat */
4376
- finishedAt?: string | null;
4377
- /** Lasterror */
4378
- lastError?: string | null;
4379
- /** Originexecutionid */
4380
- originExecutionId?: string | null;
4381
- };
4382
4547
  /**
4383
4548
  * IntegrationUpdate
4384
4549
  * @description Patch an integration. A present `credential` rotates the stored secret.
@@ -4990,6 +5155,38 @@ interface components {
4990
5155
  data: components["schemas"]["PublishedAssetRead"][];
4991
5156
  meta: components["schemas"]["PaginationMeta"];
4992
5157
  };
5158
+ /**
5159
+ * PublishedCollectionExpandedRead
5160
+ * @description A published collection read with ``?expand=full``.
5161
+ *
5162
+ * Same collection fields as ``PublishedCollectionRead``; each entry has the shape of the
5163
+ * single-entry read (``PublishedEntryRead``).
5164
+ */
5165
+ PublishedCollectionExpandedRead: {
5166
+ /** Slug */
5167
+ slug: string;
5168
+ /** Name */
5169
+ name: string;
5170
+ /** Description */
5171
+ description?: string | null;
5172
+ /**
5173
+ * Issmart
5174
+ * @default false
5175
+ */
5176
+ isSmart: boolean;
5177
+ /** Smartrules */
5178
+ smartRules?: {
5179
+ [key: string]: unknown;
5180
+ } | null;
5181
+ /** Metadatajson */
5182
+ metadataJson?: {
5183
+ [key: string]: unknown;
5184
+ } | null;
5185
+ /** Entrycount */
5186
+ entryCount: number;
5187
+ /** Entries */
5188
+ entries: components["schemas"]["PublishedEntryRead"][];
5189
+ };
4993
5190
  /**
4994
5191
  * PublishedCollectionRead
4995
5192
  * @description Schema for published collections in the publishing API.
@@ -5051,6 +5248,85 @@ interface components {
5051
5248
  data: components["schemas"]["PublishedCollectionSummary"][];
5052
5249
  meta: components["schemas"]["PaginationMeta"];
5053
5250
  };
5251
+ /**
5252
+ * PublishedEmbed
5253
+ * @description A media link in an entry (a bare provider URL in a markdown field, or an ``embed`` field) resolved
5254
+ * to a player. Keyed in ``embeds`` by the URL exactly as written in the field.
5255
+ */
5256
+ PublishedEmbed: {
5257
+ /** Url */
5258
+ url: string;
5259
+ /** Canonicalurl */
5260
+ canonicalUrl: string;
5261
+ /** Provider */
5262
+ provider: string;
5263
+ /** Providername */
5264
+ providerName: string;
5265
+ /**
5266
+ * Kind
5267
+ * @enum {string}
5268
+ */
5269
+ kind: "video" | "audio" | "podcast" | "playlist";
5270
+ /**
5271
+ * Status
5272
+ * @enum {string}
5273
+ */
5274
+ status: "ok" | "link" | "unavailable";
5275
+ /** Title */
5276
+ title?: string | null;
5277
+ /** Authorname */
5278
+ authorName?: string | null;
5279
+ /** Thumbnailurl */
5280
+ thumbnailUrl?: string | null;
5281
+ iframe?: components["schemas"]["PublishedEmbedIframe"] | null;
5282
+ link: components["schemas"]["PublishedEmbedLink"];
5283
+ /** Html */
5284
+ html: string;
5285
+ };
5286
+ /**
5287
+ * PublishedEmbedIframe
5288
+ * @description A Marvin-built player: every attribute comes from Marvin's provider registry, never from the provider.
5289
+ */
5290
+ PublishedEmbedIframe: {
5291
+ /** Src */
5292
+ src: string;
5293
+ /** Title */
5294
+ title: string;
5295
+ /** Allow */
5296
+ allow: string;
5297
+ /** Sandbox */
5298
+ sandbox: string;
5299
+ /** Referrerpolicy */
5300
+ referrerpolicy: string;
5301
+ /** Aspectratio */
5302
+ aspectRatio?: string | null;
5303
+ /** Height */
5304
+ height?: number | null;
5305
+ };
5306
+ /**
5307
+ * PublishedEmbedLink
5308
+ * @description The plain link to the media on its provider — the fallback and the link card.
5309
+ */
5310
+ PublishedEmbedLink: {
5311
+ /** Href */
5312
+ href: string;
5313
+ /** Title */
5314
+ title: string;
5315
+ /** Providername */
5316
+ providerName: string;
5317
+ };
5318
+ /**
5319
+ * PublishedEntriesExpandedResponse
5320
+ * @description Paginated response for listing published entries with ``?expand=full``.
5321
+ *
5322
+ * Each item has the shape of the single-entry read (``PublishedEntryRead``), so a site can
5323
+ * render a page of entries without re-reading each one.
5324
+ */
5325
+ PublishedEntriesExpandedResponse: {
5326
+ /** Data */
5327
+ data: components["schemas"]["PublishedEntryRead"][];
5328
+ meta: components["schemas"]["PaginationMeta"];
5329
+ };
5054
5330
  /**
5055
5331
  * PublishedEntriesResponse
5056
5332
  * @description Paginated response for listing published entries.
@@ -5151,6 +5427,10 @@ interface components {
5151
5427
  [key: string]: unknown;
5152
5428
  } | null;
5153
5429
  featuredAsset?: components["schemas"]["PublishedAssetRead"] | null;
5430
+ /** Embeds */
5431
+ embeds?: {
5432
+ [key: string]: components["schemas"]["PublishedEmbed"];
5433
+ };
5154
5434
  /** Order */
5155
5435
  order?: number | null;
5156
5436
  };
@@ -5208,6 +5488,10 @@ interface components {
5208
5488
  * @default []
5209
5489
  */
5210
5490
  tags: string[];
5491
+ /** Embeds */
5492
+ embeds?: {
5493
+ [key: string]: components["schemas"]["PublishedEmbed"];
5494
+ };
5211
5495
  /** Order */
5212
5496
  order?: number | null;
5213
5497
  };
@@ -5399,6 +5683,27 @@ interface components {
5399
5683
  /** Passwordconfirm */
5400
5684
  passwordConfirm: string;
5401
5685
  };
5686
+ /** ResolveEmbedRequest */
5687
+ ResolveEmbedRequest: {
5688
+ /** Input */
5689
+ input: string;
5690
+ /**
5691
+ * Mode
5692
+ * @default direct
5693
+ * @enum {string}
5694
+ */
5695
+ mode: "direct" | "click_to_load";
5696
+ };
5697
+ /** ResolveEmbedResponse */
5698
+ ResolveEmbedResponse: {
5699
+ /** Input */
5700
+ input: string;
5701
+ /** Url */
5702
+ url?: string | null;
5703
+ embed?: components["schemas"]["PublishedEmbed"] | null;
5704
+ /** Error */
5705
+ error?: string | null;
5706
+ };
5402
5707
  /** ResourceAttachment */
5403
5708
  ResourceAttachment: {
5404
5709
  /**
@@ -5865,11 +6170,32 @@ interface components {
5865
6170
  [key: string]: unknown;
5866
6171
  } | null;
5867
6172
  seo?: components["schemas"]["SiteSeo"] | null;
6173
+ embeds?: components["schemas"]["SiteEmbeds"];
5868
6174
  /** Metadatajson */
5869
6175
  metadataJson?: {
5870
6176
  [key: string]: unknown;
5871
6177
  } | null;
5872
6178
  };
6179
+ /**
6180
+ * SiteEmbeds
6181
+ * @description How a site shows media embeds. Stored under ``group_preferences.site_metadata_json['embeds']``
6182
+ * (``mode``, ``consentText``); ``frame_sources`` is computed from Marvin's provider registry.
6183
+ */
6184
+ SiteEmbeds: {
6185
+ /**
6186
+ * Mode
6187
+ * @default click_to_load
6188
+ * @enum {string}
6189
+ */
6190
+ mode: "direct" | "click_to_load";
6191
+ /**
6192
+ * Consenttext
6193
+ * @default Loading this player connects to {provider}, which may set cookies.
6194
+ */
6195
+ consentText: string;
6196
+ /** Framesources */
6197
+ frameSources?: string[];
6198
+ };
5873
6199
  /**
5874
6200
  * SiteRebuildChange
5875
6201
  * @description One content change a coalesced site rebuild covers (marvin.services.site_rebuild).
@@ -7455,6 +7781,107 @@ interface components {
7455
7781
  /** Isactive */
7456
7782
  isActive: boolean;
7457
7783
  };
7784
+ /**
7785
+ * IntegrationRetryRead
7786
+ * @description A failed integration step's retry chain — pending, parked (waiting for the connection), or done.
7787
+ */
7788
+ marvin__schemas__group__automation__IntegrationRetryRead: {
7789
+ /**
7790
+ * Id
7791
+ * Format: uuid4
7792
+ */
7793
+ id: string;
7794
+ /** Status */
7795
+ status: string;
7796
+ /** Integrationslug */
7797
+ integrationSlug: string;
7798
+ /** Action */
7799
+ action: string;
7800
+ /** Code */
7801
+ code: string;
7802
+ /** Stepindex */
7803
+ stepIndex: number;
7804
+ /** Entryid */
7805
+ entryId?: string | null;
7806
+ /**
7807
+ * Attempt
7808
+ * @default 0
7809
+ */
7810
+ attempt: number;
7811
+ /**
7812
+ * Maxattempts
7813
+ * @default 0
7814
+ */
7815
+ maxAttempts: number;
7816
+ /** Nextattemptat */
7817
+ nextAttemptAt?: string | null;
7818
+ /** Finishedat */
7819
+ finishedAt?: string | null;
7820
+ /** Lasterror */
7821
+ lastError?: string | null;
7822
+ /** Originexecutionid */
7823
+ originExecutionId?: string | null;
7824
+ };
7825
+ /**
7826
+ * IntegrationRetryRead
7827
+ * @description A failed workflow step that is waiting to be retried (or running right now).
7828
+ */
7829
+ marvin__schemas__group__integration__IntegrationRetryRead: {
7830
+ /**
7831
+ * Id
7832
+ * Format: uuid
7833
+ */
7834
+ id: string;
7835
+ /** Status */
7836
+ status: string;
7837
+ /**
7838
+ * Automationid
7839
+ * Format: uuid
7840
+ */
7841
+ automationId: string;
7842
+ /** Automationname */
7843
+ automationName?: string | null;
7844
+ /**
7845
+ * Automationenabled
7846
+ * @default true
7847
+ */
7848
+ automationEnabled: boolean;
7849
+ /** Entryid */
7850
+ entryId?: string | null;
7851
+ /** Entrytitle */
7852
+ entryTitle?: string | null;
7853
+ /**
7854
+ * Entryexists
7855
+ * @default false
7856
+ */
7857
+ entryExists: boolean;
7858
+ /** Integrationid */
7859
+ integrationId?: string | null;
7860
+ /** Integrationname */
7861
+ integrationName?: string | null;
7862
+ /** Integrationslug */
7863
+ integrationSlug: string;
7864
+ /** Provider */
7865
+ provider: string;
7866
+ /** Providername */
7867
+ providerName: string;
7868
+ /** Action */
7869
+ action: string;
7870
+ /** Code */
7871
+ code: string;
7872
+ /** Attempt */
7873
+ attempt: number;
7874
+ /** Maxattempts */
7875
+ maxAttempts: number;
7876
+ /** Nextattemptat */
7877
+ nextAttemptAt?: string | null;
7878
+ /** Leaseuntil */
7879
+ leaseUntil?: string | null;
7880
+ /** Lasterror */
7881
+ lastError?: string | null;
7882
+ /** Createdat */
7883
+ createdAt?: string | null;
7884
+ };
7458
7885
  };
7459
7886
  responses: never;
7460
7887
  parameters: never;
@@ -7479,6 +7906,8 @@ type MarvinEntry = components['schemas']['PublishedEntryRead'];
7479
7906
  type MarvinEntryListItem = components['schemas']['PublishedEntryListItem'];
7480
7907
  type PublishedEntryType = components['schemas']['PublishedEntryTypeRead'];
7481
7908
  type MarvinCollection = components['schemas']['PublishedCollectionRead'];
7909
+ /** A collection read with `?expand=full`: each entry in the single-read shape (`MarvinEntry`). */
7910
+ type MarvinCollectionExpanded = components['schemas']['PublishedCollectionExpandedRead'];
7482
7911
  type PublishedCollectionSummary = components['schemas']['PublishedCollectionSummary'];
7483
7912
  type PublishedEntryCollection = components['schemas']['PublishedEntryCollection'];
7484
7913
  type MarvinAsset = components['schemas']['PublishedAssetRead'];
@@ -7548,6 +7977,15 @@ interface EntryAsset extends PublishedAssetRead {
7548
7977
  interface EntryResource extends PublishedResourceSummary {
7549
7978
  entryMetadata: CollectionEntryMetadata;
7550
7979
  }
7980
+ /**
7981
+ * `expand: 'full'` asks a publishing list endpoint for full entries (the single-entry read:
7982
+ * `assets[]`, `resources[]`, every collection membership) instead of list items, so a site needs
7983
+ * no per-entry reads. Needs a Marvin server with `expand` support; an older one ignores it and
7984
+ * returns list items, which the SDK passes through in their usual shape.
7985
+ */
7986
+ interface ExpandOptions {
7987
+ expand?: 'full';
7988
+ }
7551
7989
  interface AssetUploadRequest {
7552
7990
  slug: string;
7553
7991
  name: string;
@@ -7590,4 +8028,4 @@ interface AuthToken {
7590
8028
  tokenType: string;
7591
8029
  }
7592
8030
 
7593
- export type { AuthToken as A, SiteSeoVerification as B, CollectionContext as C, EntryAsset as E, GetAssetsOptions as G, ListEntry as L, MarvinAsset as M, PublishedAssetRead as P, ResourceAttachment as R, SiteConfiguration as S, WorkspaceInfo as W, CollectionEntry as a, CollectionEntryMetadata as b, EntryCollectionContext as c, EntryResource as d, GetEntriesOptions as e, GetResourcesOptions as f, MarvinCollection as g, MarvinEntry as h, MarvinEntryListItem as i, MarvinEntryType as j, MarvinPublishResponse as k, MarvinResource as l, MarvinSite as m, PublishedCollectionSummary as n, PublishedEntryAsset as o, PublishedEntryResource as p, PublishedEntryType as q, components as r, AssetAttachment as s, AssetUploadRequest as t, CollectionAttachment as u, EntryCollectionRead as v, MarvinClientConfig as w, PublishedEntryCollection as x, PublishedResourceSummary as y, SiteSeo as z };
8031
+ export type { AuthToken as A, PublishedResourceSummary as B, CollectionContext as C, SiteSeo as D, EntryAsset as E, SiteSeoVerification as F, GetAssetsOptions as G, ListEntry as L, MarvinAsset as M, PublishedAssetRead as P, ResourceAttachment as R, SiteConfiguration as S, WorkspaceInfo as W, CollectionEntry as a, CollectionEntryMetadata as b, EntryCollectionContext as c, EntryResource as d, ExpandOptions as e, GetEntriesOptions as f, GetResourcesOptions as g, MarvinCollection as h, MarvinCollectionExpanded as i, MarvinEntry as j, MarvinEntryListItem as k, MarvinEntryType as l, MarvinPublishResponse as m, MarvinResource as n, MarvinSite as o, PublishedCollectionSummary as p, PublishedEntryAsset as q, PublishedEntryResource as r, PublishedEntryType as s, components as t, AssetAttachment as u, AssetUploadRequest as v, CollectionAttachment as w, EntryCollectionRead as x, MarvinClientConfig as y, PublishedEntryCollection as z };