@deadair/sdk 0.50.1 → 0.50.2

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 (45) hide show
  1. package/dist/activity/types/activity.types.d.ts +5 -5
  2. package/dist/art/art.client.d.ts +30 -0
  3. package/dist/art/art.client.d.ts.map +1 -1
  4. package/dist/art/types/art.types.d.ts +6 -6
  5. package/dist/authentication/types/authentication.types.d.ts +70 -70
  6. package/dist/authentication/types/registration.types.d.ts +30 -30
  7. package/dist/catalog/types/catalog.types.d.ts +49 -46
  8. package/dist/catalog/types/catalog.types.d.ts.map +1 -1
  9. package/dist/charts/types/charts.types.d.ts +5 -5
  10. package/dist/director/types/clock.types.d.ts +2 -2
  11. package/dist/director/types/director.types.d.ts +17 -17
  12. package/dist/director/types/rules.types.d.ts +5 -5
  13. package/dist/history/types/history.types.d.ts +3 -3
  14. package/dist/index.js +57 -1
  15. package/dist/index.js.map +1 -1
  16. package/dist/languages/types/languages.types.d.ts +4 -4
  17. package/dist/messaging/types/messaging.types.d.ts +3 -3
  18. package/dist/narrations/types/narrations.types.d.ts +5 -5
  19. package/dist/news/types/news.types.d.ts +5 -5
  20. package/dist/nowplaying/types/nowplaying.types.d.ts +5 -5
  21. package/dist/nowplaying/types/nowplaying.types.d.ts.map +1 -1
  22. package/dist/oauth/types/oauth.types.d.ts +17 -17
  23. package/dist/onboarding/types/onboarding.types.d.ts +4 -4
  24. package/dist/outputs/types/outputs.types.d.ts +7 -7
  25. package/dist/personas/types/personas.types.d.ts +40 -40
  26. package/dist/playlists/types/playlists.types.d.ts +7 -7
  27. package/dist/playlists/types/station.playlists.types.d.ts +13 -13
  28. package/dist/playout/types/playout.types.d.ts +16 -16
  29. package/dist/playout/types/playout.types.d.ts.map +1 -1
  30. package/dist/plugins/plugins.client.d.ts +1 -1
  31. package/dist/plugins/types/plugins.types.d.ts +33 -33
  32. package/dist/podcasts/types/podcasts.types.d.ts +8 -8
  33. package/dist/productions/types/productions.types.d.ts +4 -4
  34. package/dist/render/types/render.types.d.ts +38 -38
  35. package/dist/requests/types/requests.types.d.ts +9 -9
  36. package/dist/schedule/types/schedule.types.d.ts +8 -8
  37. package/dist/settings/types/settings.types.d.ts +6 -6
  38. package/dist/shared/types/pagination.d.ts +2 -2
  39. package/dist/station/types/logs.types.d.ts +6 -6
  40. package/dist/station/types/station.types.d.ts +10 -10
  41. package/dist/station/types/traces.types.d.ts +6 -6
  42. package/dist/storage/types/storage.types.d.ts +3 -3
  43. package/dist/stream/types/stream.types.d.ts +4 -4
  44. package/dist/topics/types/topics.types.d.ts +5 -5
  45. package/package.json +2 -2
@@ -1,32 +1,32 @@
1
1
  import { DateTime } from 'luxon';
2
2
  /**
3
3
  * Denotes the authorization flow to use
4
- * generated from [AuthenticationGrantType](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L7)
4
+ * generated from [AuthenticationGrantType](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
5
5
  */
6
6
  export type AuthenticationGrantType = 'client_credentials' | 'password' | 'refresh_token' | 'link' | 'code' | 'fido' | 'authenticator' | 'oidc';
7
7
  /**
8
8
  * Denotes the authorization flow to use
9
- * generated from [PasswordlessAuthenticationGrantType](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L18)
9
+ * generated from [PasswordlessAuthenticationGrantType](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
10
10
  */
11
11
  export type PasswordlessAuthenticationGrantType = 'link' | 'code' | 'fido' | 'oidc';
12
12
  /**
13
13
  * The type of the factor
14
- * generated from [AuthenticationFactorMethod](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L20)
14
+ * generated from [AuthenticationFactorMethod](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
15
15
  */
16
16
  export type AuthenticationFactorMethod = 'phone' | 'password' | 'email' | 'authenticator' | 'fido' | 'oidc';
17
17
  /**
18
18
  * The kind of the factor
19
- * generated from [AuthenticationFactorKind](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L22)
19
+ * generated from [AuthenticationFactorKind](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
20
20
  */
21
21
  export type AuthenticationFactorKind = 'knowledge' | 'possession' | 'biometric';
22
22
  /**
23
23
  * The name of an identity provider the station offers, as the operator set it under Settings, Sign-in and security. `GET /auth/login/oidc/providers` lists them
24
- * generated from [OidcProvider](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L24)
24
+ * generated from [OidcProvider](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
25
25
  */
26
26
  export type OidcProvider = string;
27
27
  /**
28
28
  * Represents an authentication token
29
- * generated from [AuthenticationToken](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L84)
29
+ * generated from [AuthenticationToken](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
30
30
  */
31
31
  export interface AuthenticationToken {
32
32
  /** The access token string as issued by the authorization server */
@@ -54,7 +54,7 @@ export interface AuthenticationTokenOutput {
54
54
  }
55
55
  /**
56
56
  * Issued-token arm of /auth/token response
57
- * generated from [AuthenticationTokenIssued](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L92)
57
+ * generated from [AuthenticationTokenIssued](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
58
58
  */
59
59
  export interface AuthenticationTokenIssued {
60
60
  /** Discriminator */
@@ -86,7 +86,7 @@ export interface AuthenticationTokenIssuedOutput {
86
86
  }
87
87
  /**
88
88
  * Returned by /auth/step-up/start when no enrolled factor satisfies the requirement. The SPA should drive the user through enrollment and retry the gated action afterwards.
89
- * generated from [EnrollmentRequiredResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L115)
89
+ * generated from [EnrollmentRequiredResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
90
90
  */
91
91
  export interface EnrollmentRequiredResponse {
92
92
  /** Discriminator */
@@ -98,7 +98,7 @@ export interface EnrollmentRequiredResponseOutput {
98
98
  }
99
99
  /**
100
100
  * Represents a common shape of a `PublicKeyCredential` after the client serializes the `id` and `rawId` fields to base64 strings for transport
101
- * generated from [PublicKeyCredential](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L123)
101
+ * generated from [PublicKeyCredential](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
102
102
  */
103
103
  export interface PublicKeyCredential {
104
104
  /** The base64url encoding of `rawId` */
@@ -112,7 +112,7 @@ export interface PublicKeyCredential {
112
112
  }
113
113
  /**
114
114
  * Subset of the WebAuthn client extension results the service round-trips
115
- * generated from [SimpleClientExtensionResults](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L130)
115
+ * generated from [SimpleClientExtensionResults](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
116
116
  */
117
117
  export interface SimpleClientExtensionResults {
118
118
  /** Whether the client is an application */
@@ -124,7 +124,7 @@ export interface SimpleClientExtensionResults {
124
124
  };
125
125
  }
126
126
  /**
127
- * generated from [FidoAuthenticatorAssertionResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L138)
127
+ * generated from [FidoAuthenticatorAssertionResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
128
128
  */
129
129
  export interface FidoAuthenticatorAssertionResponse {
130
130
  /** The client data JSON */
@@ -137,7 +137,7 @@ export interface FidoAuthenticatorAssertionResponse {
137
137
  userHandle?: string;
138
138
  }
139
139
  /**
140
- * generated from [AuthenticationRegistration](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L150)
140
+ * generated from [AuthenticationRegistration](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
141
141
  */
142
142
  export interface AuthenticationRegistration {
143
143
  /** The registration identifier */
@@ -154,7 +154,7 @@ export interface AuthenticationRegistrationInput {
154
154
  /** Rehydrates every wire-encoded scalar in a AuthenticationRegistration into its runtime type. Mutates and returns `raw`. */
155
155
  export declare function reviveAuthenticationRegistration(raw: AuthenticationRegistration): AuthenticationRegistration;
156
156
  /**
157
- * generated from [AuthenticationRegistrationVerification](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L157)
157
+ * generated from [AuthenticationRegistrationVerification](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
158
158
  */
159
159
  export interface AuthenticationRegistrationVerification {
160
160
  /** The registration identifier */
@@ -164,7 +164,7 @@ export interface AuthenticationRegistrationVerification {
164
164
  }
165
165
  /**
166
166
  * A credential the relying party expects the user to be able to present
167
- * generated from [PublicKeyCredentialDescriptor](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L192)
167
+ * generated from [PublicKeyCredentialDescriptor](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
168
168
  */
169
169
  export interface PublicKeyCredentialDescriptor {
170
170
  /** The credential type — currently always `public-key` */
@@ -176,12 +176,12 @@ export interface PublicKeyCredentialDescriptor {
176
176
  }
177
177
  /**
178
178
  * The transport used by the authenticator
179
- * generated from [FidoAuthenticatorTransport](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L236)
179
+ * generated from [FidoAuthenticatorTransport](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
180
180
  */
181
181
  export type FidoAuthenticatorTransport = 'hybrid' | 'ble' | 'internal' | 'nfc' | 'usb';
182
182
  /**
183
183
  * Request to complete an OIDC sign-in flow
184
- * generated from [OidcLoginCallback](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L261)
184
+ * generated from [OidcLoginCallback](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
185
185
  */
186
186
  export interface OidcLoginCallback {
187
187
  /** The issuer of the token */
@@ -207,7 +207,7 @@ export interface OidcLoginCallback {
207
207
  }
208
208
  /**
209
209
  * Issue a phone SMS challenge during a pending MFA round
210
- * generated from [FactorChallengePhoneStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L274)
210
+ * generated from [FactorChallengePhoneStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
211
211
  */
212
212
  export interface FactorChallengePhoneStart {
213
213
  /** Discriminator */
@@ -219,7 +219,7 @@ export interface FactorChallengePhoneStart {
219
219
  }
220
220
  /**
221
221
  * Issue a WebAuthn assertion challenge during a pending MFA round
222
- * generated from [FactorChallengeFidoStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L280)
222
+ * generated from [FactorChallengeFidoStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
223
223
  */
224
224
  export interface FactorChallengeFidoStart {
225
225
  /** Discriminator */
@@ -229,7 +229,7 @@ export interface FactorChallengeFidoStart {
229
229
  }
230
230
  /**
231
231
  * Issue an email one-time-code challenge during a pending MFA round. Always a code: a magic link cannot complete an MFA round, since the `code` grant that redeems one takes `code(min=6, max=10)` and a link token is 43 characters
232
- * generated from [FactorChallengeEmailStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L285)
232
+ * generated from [FactorChallengeEmailStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
233
233
  */
234
234
  export interface FactorChallengeEmailStart {
235
235
  /** Discriminator */
@@ -239,7 +239,7 @@ export interface FactorChallengeEmailStart {
239
239
  }
240
240
  /**
241
241
  * Response for a phone SMS challenge
242
- * generated from [FactorChallengePhoneStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L292)
242
+ * generated from [FactorChallengePhoneStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
243
243
  */
244
244
  export interface FactorChallengePhoneStartResponse {
245
245
  /** Discriminator */
@@ -267,7 +267,7 @@ export declare function reviveFactorChallengePhoneStartResponse(raw: FactorChall
267
267
  export declare function reviveFactorChallengePhoneStartResponseOutput(raw: FactorChallengePhoneStartResponseOutput): FactorChallengePhoneStartResponseOutput;
268
268
  /**
269
269
  * Response for an email one-time-code challenge
270
- * generated from [FactorChallengeEmailStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L306)
270
+ * generated from [FactorChallengeEmailStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
271
271
  */
272
272
  export interface FactorChallengeEmailStartResponse {
273
273
  /** Discriminator */
@@ -291,7 +291,7 @@ export declare function reviveFactorChallengeEmailStartResponse(raw: FactorChall
291
291
  export declare function reviveFactorChallengeEmailStartResponseOutput(raw: FactorChallengeEmailStartResponseOutput): FactorChallengeEmailStartResponseOutput;
292
292
  /**
293
293
  * A factor satisfied by the session
294
- * generated from [SessionFactor](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L320)
294
+ * generated from [SessionFactor](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
295
295
  */
296
296
  export interface SessionFactor {
297
297
  /** The verification method */
@@ -317,7 +317,7 @@ export interface SessionFactorInput {
317
317
  export declare function reviveSessionFactor(raw: SessionFactor): SessionFactor;
318
318
  /**
319
319
  * Optional metadata supplied to a revoke action
320
- * generated from [SessionRevoke](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L340)
320
+ * generated from [SessionRevoke](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
321
321
  */
322
322
  export interface SessionRevoke {
323
323
  /** Free-form reason recorded with the revoke */
@@ -325,12 +325,12 @@ export interface SessionRevoke {
325
325
  }
326
326
  /**
327
327
  * A platform-wide role held on `platform:main`. `admin` grants every operation; `listener` grants the reads
328
- * generated from [PlatformRole](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L345)
328
+ * generated from [PlatformRole](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
329
329
  */
330
330
  export type PlatformRole = 'admin' | 'listener';
331
331
  /**
332
332
  * A successful authentication record
333
- * generated from [Login](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L352)
333
+ * generated from [Login](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
334
334
  */
335
335
  export interface Login {
336
336
  /** The login event identifier */
@@ -358,7 +358,7 @@ export interface LoginInput {
358
358
  export declare function reviveLogin(raw: Login): Login;
359
359
  /**
360
360
  * The current user's display preferences, auto-detected by the SPA from the browser (Intl timezone + navigator.language). Omitted fields are left unchanged (absent = never set).
361
- * generated from [ActorPreferences](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L372)
361
+ * generated from [ActorPreferences](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
362
362
  */
363
363
  export interface ActorPreferences {
364
364
  /** RFC 5646 locale, e.g. "en-US" */
@@ -368,11 +368,11 @@ export interface ActorPreferences {
368
368
  }
369
369
  /**
370
370
  * What an API key may be granted. `view` covers every route a listener may read; `manage` covers the rest, and includes `view`
371
- * generated from [ApiKeyScope](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L378)
371
+ * generated from [ApiKeyScope](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
372
372
  */
373
373
  export type ApiKeyScope = 'view' | 'manage';
374
374
  /**
375
- * generated from [BaseAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L26)
375
+ * generated from [BaseAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
376
376
  */
377
377
  export interface BaseAuthenticationRequest {
378
378
  /** The grant type for the request */
@@ -383,7 +383,7 @@ export interface BaseAuthenticationRequest {
383
383
  client_id?: string;
384
384
  }
385
385
  /**
386
- * generated from [BaseAuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L162)
386
+ * generated from [BaseAuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
387
387
  */
388
388
  export interface BaseAuthenticationLoginStart {
389
389
  /** The grant type for the request */
@@ -392,7 +392,7 @@ export interface BaseAuthenticationLoginStart {
392
392
  client_id?: string;
393
393
  }
394
394
  /**
395
- * generated from [BaseAuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L198)
395
+ * generated from [BaseAuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
396
396
  */
397
397
  export interface BaseAuthenticationLoginStartResponse {
398
398
  /** The grant type for the response */
@@ -406,7 +406,7 @@ export interface BaseAuthenticationLoginStartResponse {
406
406
  export declare function reviveBaseAuthenticationLoginStartResponse(raw: BaseAuthenticationLoginStartResponse): BaseAuthenticationLoginStartResponse;
407
407
  /**
408
408
  * A factor the SPA may use to satisfy the MFA challenge
409
- * generated from [MfaChallengeFactor](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L101)
409
+ * generated from [MfaChallengeFactor](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
410
410
  */
411
411
  export interface MfaChallengeFactor {
412
412
  /** The factor method */
@@ -429,7 +429,7 @@ export interface MfaChallengeFactorOutput {
429
429
  label?: string;
430
430
  }
431
431
  /**
432
- * generated from [AuthenticationFactor](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L249)
432
+ * generated from [AuthenticationFactor](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
433
433
  */
434
434
  export interface AuthenticationFactor {
435
435
  /** The method of the factor */
@@ -443,7 +443,7 @@ export interface AuthenticationFactor {
443
443
  }
444
444
  /**
445
445
  * Mint a fresh MFA challenge for the current session so the SPA can satisfy a `step_up_required` denial. Filters mirror `StepUpRequirement` from `@maroonedsoftware/policies`.
446
- * generated from [StepUpStartRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L314)
446
+ * generated from [StepUpStartRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
447
447
  */
448
448
  export interface StepUpStartRequest {
449
449
  /** If set, only these factor methods are listed as eligible */
@@ -455,7 +455,7 @@ export interface StepUpStartRequest {
455
455
  }
456
456
  /**
457
457
  * An identity provider the sign-in page can offer
458
- * generated from [OidcProviderSummary](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L256)
458
+ * generated from [OidcProviderSummary](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
459
459
  */
460
460
  export interface OidcProviderSummary {
461
461
  /** What to start a sign-in with */
@@ -464,7 +464,7 @@ export interface OidcProviderSummary {
464
464
  label: string;
465
465
  }
466
466
  /**
467
- * generated from [PublicKeyCredentialWithAssertion](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L145)
467
+ * generated from [PublicKeyCredentialWithAssertion](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
468
468
  */
469
469
  export interface PublicKeyCredentialWithAssertion extends PublicKeyCredential {
470
470
  /** The client extension results */
@@ -473,7 +473,7 @@ export interface PublicKeyCredentialWithAssertion extends PublicKeyCredential {
473
473
  response: FidoAuthenticatorAssertionResponse;
474
474
  }
475
475
  /**
476
- * generated from [FidoPublicKeyCredentialRequestOptions](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L212)
476
+ * generated from [FidoPublicKeyCredentialRequestOptions](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
477
477
  */
478
478
  export interface FidoPublicKeyCredentialRequestOptions {
479
479
  challenge: string;
@@ -491,7 +491,7 @@ export interface FidoPublicKeyCredentialRequestOptions {
491
491
  }
492
492
  /**
493
493
  * Serialized form of `AuthenticatorAttestationResponse` — produced by the browser at registration; all binary fields are base64-encoded for transport
494
- * generated from [FidoAuthenticatorAttestationResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L238)
494
+ * generated from [FidoAuthenticatorAttestationResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
495
495
  */
496
496
  export interface FidoAuthenticatorAttestationResponse {
497
497
  /** The client data JSON */
@@ -502,12 +502,12 @@ export interface FidoAuthenticatorAttestationResponse {
502
502
  transports?: FidoAuthenticatorTransport[];
503
503
  }
504
504
  /**
505
- * generated from [FactorChallengeStartRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L290)
505
+ * generated from [FactorChallengeStartRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
506
506
  */
507
507
  export type FactorChallengeStartRequest = FactorChallengePhoneStart | FactorChallengeFidoStart | FactorChallengeEmailStart;
508
508
  /**
509
509
  * An active authentication session
510
- * generated from [Session](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L328)
510
+ * generated from [Session](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
511
511
  */
512
512
  export interface Session {
513
513
  /** Opaque session token used as the cache key and embedded in JWTs */
@@ -535,7 +535,7 @@ export interface SessionInput {
535
535
  export declare function reviveSession(raw: Session): Session;
536
536
  /**
537
537
  * Who the caller is, as the station sees them
538
- * generated from [AuthSession](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L347)
538
+ * generated from [AuthSession](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
539
539
  */
540
540
  export interface AuthSession {
541
541
  /** The actor the session belongs to */
@@ -545,7 +545,7 @@ export interface AuthSession {
545
545
  }
546
546
  /**
547
547
  * A personal API key, as its owner sees it in a list. The token itself is never returned after it is issued
548
- * generated from [ApiKey](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L380)
548
+ * generated from [ApiKey](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
549
549
  */
550
550
  export interface ApiKey {
551
551
  /** The key's identifier, for rotating or revoking it */
@@ -569,7 +569,7 @@ export interface ApiKey {
569
569
  export declare function reviveApiKey(raw: ApiKey): ApiKey;
570
570
  /**
571
571
  * A new API key
572
- * generated from [ApiKeyCreate](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L395)
572
+ * generated from [ApiKeyCreate](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
573
573
  */
574
574
  export interface ApiKeyCreate {
575
575
  /** What to call the key, so a list of several says which is which */
@@ -583,7 +583,7 @@ export interface ApiKeyCreate {
583
583
  export declare function reviveApiKeyCreate(raw: ApiKeyCreate): ApiKeyCreate;
584
584
  /**
585
585
  * Represents an application authentication request
586
- * generated from [ClientCredentialsAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L32)
586
+ * generated from [ClientCredentialsAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
587
587
  */
588
588
  export interface ClientCredentialsAuthenticationRequest extends Omit<BaseAuthenticationRequest, 'grant_type' | 'client_id'> {
589
589
  /** The grant type for the request */
@@ -595,7 +595,7 @@ export interface ClientCredentialsAuthenticationRequest extends Omit<BaseAuthent
595
595
  }
596
596
  /**
597
597
  * Represents an authentication password request
598
- * generated from [PasswordAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L38)
598
+ * generated from [PasswordAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
599
599
  */
600
600
  export interface PasswordAuthenticationRequest extends Omit<BaseAuthenticationRequest, 'grant_type'> {
601
601
  /** The grant type for the request */
@@ -607,7 +607,7 @@ export interface PasswordAuthenticationRequest extends Omit<BaseAuthenticationRe
607
607
  }
608
608
  /**
609
609
  * Represents an authentication refresh request
610
- * generated from [RefreshTokenAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L44)
610
+ * generated from [RefreshTokenAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
611
611
  */
612
612
  export interface RefreshTokenAuthenticationRequest extends Omit<BaseAuthenticationRequest, 'grant_type'> {
613
613
  /** The grant type for the request */
@@ -617,7 +617,7 @@ export interface RefreshTokenAuthenticationRequest extends Omit<BaseAuthenticati
617
617
  }
618
618
  /**
619
619
  * Represents an authentication magic link request
620
- * generated from [LinkAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L49)
620
+ * generated from [LinkAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
621
621
  */
622
622
  export interface LinkAuthenticationRequest extends Omit<BaseAuthenticationRequest, 'grant_type'> {
623
623
  /** The grant type for the request */
@@ -629,7 +629,7 @@ export interface LinkAuthenticationRequest extends Omit<BaseAuthenticationReques
629
629
  }
630
630
  /**
631
631
  * Represents an authentication one-time-code request
632
- * generated from [CodeAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L55)
632
+ * generated from [CodeAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
633
633
  */
634
634
  export interface CodeAuthenticationRequest extends Omit<BaseAuthenticationRequest, 'grant_type'> {
635
635
  /** The grant type for the request */
@@ -645,7 +645,7 @@ export interface CodeAuthenticationRequest extends Omit<BaseAuthenticationReques
645
645
  }
646
646
  /**
647
647
  * Submit a TOTP code as a second factor against a pending MFA challenge
648
- * generated from [AuthenticatorAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L70)
648
+ * generated from [AuthenticatorAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
649
649
  */
650
650
  export interface AuthenticatorAuthenticationRequest extends Omit<BaseAuthenticationRequest, 'grant_type'> {
651
651
  /** The grant type for the request */
@@ -659,7 +659,7 @@ export interface AuthenticatorAuthenticationRequest extends Omit<BaseAuthenticat
659
659
  }
660
660
  /**
661
661
  * Redeem a completed OIDC authorization that the callback stashed under a one-time id
662
- * generated from [OidcAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L77)
662
+ * generated from [OidcAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
663
663
  */
664
664
  export interface OidcAuthenticationRequest extends Omit<BaseAuthenticationRequest, 'grant_type'> {
665
665
  /** The grant type for the request */
@@ -668,7 +668,7 @@ export interface OidcAuthenticationRequest extends Omit<BaseAuthenticationReques
668
668
  challenge_id: string;
669
669
  }
670
670
  /**
671
- * generated from [BaseAuthenticationLoginStartWithEmail](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L167)
671
+ * generated from [BaseAuthenticationLoginStartWithEmail](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
672
672
  */
673
673
  export interface BaseAuthenticationLoginStartWithEmail extends BaseAuthenticationLoginStart {
674
674
  /** User's email address */
@@ -676,7 +676,7 @@ export interface BaseAuthenticationLoginStartWithEmail extends BaseAuthenticatio
676
676
  }
677
677
  /**
678
678
  * Request to begin an OIDC sign-in flow
679
- * generated from [OidcAuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L184)
679
+ * generated from [OidcAuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
680
680
  */
681
681
  export interface OidcAuthenticationLoginStart extends Omit<BaseAuthenticationLoginStart, 'grant_type'> {
682
682
  /** The grant type for the request */
@@ -687,7 +687,7 @@ export interface OidcAuthenticationLoginStart extends Omit<BaseAuthenticationLog
687
687
  redirect_after?: string;
688
688
  }
689
689
  /**
690
- * generated from [CodeAuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L204)
690
+ * generated from [CodeAuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
691
691
  */
692
692
  export interface CodeAuthenticationLoginStartResponse extends Omit<BaseAuthenticationLoginStartResponse, 'grant_type'> {
693
693
  /** The grant type for the response */
@@ -696,7 +696,7 @@ export interface CodeAuthenticationLoginStartResponse extends Omit<BaseAuthentic
696
696
  /** Rehydrates every wire-encoded scalar in a CodeAuthenticationLoginStartResponse into its runtime type. Mutates and returns `raw`. */
697
697
  export declare function reviveCodeAuthenticationLoginStartResponse(raw: CodeAuthenticationLoginStartResponse): CodeAuthenticationLoginStartResponse;
698
698
  /**
699
- * generated from [LinkAuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L208)
699
+ * generated from [LinkAuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
700
700
  */
701
701
  export interface LinkAuthenticationLoginStartResponse extends Omit<BaseAuthenticationLoginStartResponse, 'grant_type'> {
702
702
  /** The grant type for the response */
@@ -706,7 +706,7 @@ export interface LinkAuthenticationLoginStartResponse extends Omit<BaseAuthentic
706
706
  export declare function reviveLinkAuthenticationLoginStartResponse(raw: LinkAuthenticationLoginStartResponse): LinkAuthenticationLoginStartResponse;
707
707
  /**
708
708
  * Response from `/auth/login/oidc/start` instructing the client to navigate to `authorize_url`
709
- * generated from [OidcAuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L228)
709
+ * generated from [OidcAuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
710
710
  */
711
711
  export interface OidcAuthenticationLoginStartResponse extends Omit<BaseAuthenticationLoginStartResponse, 'grant_type'> {
712
712
  /** The grant type for the response */
@@ -720,7 +720,7 @@ export interface OidcAuthenticationLoginStartResponse extends Omit<BaseAuthentic
720
720
  export declare function reviveOidcAuthenticationLoginStartResponse(raw: OidcAuthenticationLoginStartResponse): OidcAuthenticationLoginStartResponse;
721
721
  /**
722
722
  * MFA-required arm of /auth/token response
723
- * generated from [MfaRequiredResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L108)
723
+ * generated from [MfaRequiredResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
724
724
  */
725
725
  export interface MfaRequiredResponse {
726
726
  /** Discriminator */
@@ -748,7 +748,7 @@ export declare function reviveMfaRequiredResponse(raw: MfaRequiredResponse): Mfa
748
748
  export declare function reviveMfaRequiredResponseOutput(raw: MfaRequiredResponseOutput): MfaRequiredResponseOutput;
749
749
  /**
750
750
  * Represents an authentication passkey request
751
- * generated from [FidoAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L63)
751
+ * generated from [FidoAuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
752
752
  */
753
753
  export interface FidoAuthenticationRequest extends Omit<BaseAuthenticationRequest, 'grant_type'> {
754
754
  /** The grant type for the request */
@@ -762,7 +762,7 @@ export interface FidoAuthenticationRequest extends Omit<BaseAuthenticationReques
762
762
  }
763
763
  /**
764
764
  * WebAuthn assertion options for `navigator.credentials.get`
765
- * generated from [FidoAuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L223)
765
+ * generated from [FidoAuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
766
766
  */
767
767
  export interface FidoAuthenticationLoginStartResponse extends Omit<BaseAuthenticationLoginStartResponse, 'grant_type'> {
768
768
  /** The grant type for the response */
@@ -774,7 +774,7 @@ export interface FidoAuthenticationLoginStartResponse extends Omit<BaseAuthentic
774
774
  export declare function reviveFidoAuthenticationLoginStartResponse(raw: FidoAuthenticationLoginStartResponse): FidoAuthenticationLoginStartResponse;
775
775
  /**
776
776
  * Response for a FIDO assertion challenge
777
- * generated from [FactorChallengeFidoStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L299)
777
+ * generated from [FactorChallengeFidoStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
778
778
  */
779
779
  export interface FactorChallengeFidoStartResponse {
780
780
  /** Discriminator */
@@ -802,7 +802,7 @@ export declare function reviveFactorChallengeFidoStartResponse(raw: FactorChalle
802
802
  export declare function reviveFactorChallengeFidoStartResponseOutput(raw: FactorChallengeFidoStartResponseOutput): FactorChallengeFidoStartResponseOutput;
803
803
  /**
804
804
  * The credential the client posts back to complete registration
805
- * generated from [PublicKeyCredentialWithAttestation](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L244)
805
+ * generated from [PublicKeyCredentialWithAttestation](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
806
806
  */
807
807
  export interface PublicKeyCredentialWithAttestation extends PublicKeyCredential {
808
808
  /** The client extension results */
@@ -812,7 +812,7 @@ export interface PublicKeyCredentialWithAttestation extends PublicKeyCredential
812
812
  }
813
813
  /**
814
814
  * Every API key the account holds, newest first, revoked and expired keys included
815
- * generated from [ApiKeyList](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L391)
815
+ * generated from [ApiKeyList](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
816
816
  */
817
817
  export interface ApiKeyList {
818
818
  keys: ApiKey[];
@@ -821,7 +821,7 @@ export interface ApiKeyList {
821
821
  export declare function reviveApiKeyList(raw: ApiKeyList): ApiKeyList;
822
822
  /**
823
823
  * A key and its token. The only time the token is ever returned: store it now, because nothing can show it again
824
- * generated from [ApiKeyIssued](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L401)
824
+ * generated from [ApiKeyIssued](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
825
825
  */
826
826
  export interface ApiKeyIssued {
827
827
  /** The key as it will appear in the list */
@@ -832,14 +832,14 @@ export interface ApiKeyIssued {
832
832
  /** Rehydrates every wire-encoded scalar in a ApiKeyIssued into its runtime type. Mutates and returns `raw`. */
833
833
  export declare function reviveApiKeyIssued(raw: ApiKeyIssued): ApiKeyIssued;
834
834
  /**
835
- * generated from [LinkAuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L171)
835
+ * generated from [LinkAuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
836
836
  */
837
837
  export interface LinkAuthenticationLoginStart extends Omit<BaseAuthenticationLoginStartWithEmail, 'grant_type'> {
838
838
  /** The grant type for the request */
839
839
  grant_type: 'link';
840
840
  }
841
841
  /**
842
- * generated from [CodeAuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L175)
842
+ * generated from [CodeAuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
843
843
  */
844
844
  export interface CodeAuthenticationLoginStart extends Omit<BaseAuthenticationLoginStartWithEmail, 'grant_type'> {
845
845
  /** The grant type for the request */
@@ -848,14 +848,14 @@ export interface CodeAuthenticationLoginStart extends Omit<BaseAuthenticationLog
848
848
  code_challenge: string;
849
849
  }
850
850
  /**
851
- * generated from [FidoAuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L180)
851
+ * generated from [FidoAuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
852
852
  */
853
853
  export interface FidoAuthenticationLoginStart extends Omit<BaseAuthenticationLoginStartWithEmail, 'grant_type'> {
854
854
  /** The grant type for the request */
855
855
  grant_type: 'fido';
856
856
  }
857
857
  /**
858
- * generated from [StepUpStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L119)
858
+ * generated from [StepUpStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
859
859
  */
860
860
  export type StepUpStartResponse = MfaRequiredResponse | EnrollmentRequiredResponse;
861
861
  export type StepUpStartResponseOutput = MfaRequiredResponseOutput | EnrollmentRequiredResponseOutput;
@@ -864,7 +864,7 @@ export declare function reviveStepUpStartResponse(raw: StepUpStartResponse): Ste
864
864
  /** Rehydrates every wire-encoded scalar in a StepUpStartResponseOutput into its runtime type. Mutates and returns `raw`. */
865
865
  export declare function reviveStepUpStartResponseOutput(raw: StepUpStartResponseOutput): StepUpStartResponseOutput;
866
866
  /**
867
- * generated from [AuthenticationTokenResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L121)
867
+ * generated from [AuthenticationTokenResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
868
868
  */
869
869
  export type AuthenticationTokenResponse = AuthenticationTokenIssued | MfaRequiredResponse;
870
870
  export type AuthenticationTokenResponseOutput = AuthenticationTokenIssuedOutput | MfaRequiredResponseOutput;
@@ -873,17 +873,17 @@ export declare function reviveAuthenticationTokenResponse(raw: AuthenticationTok
873
873
  /** Rehydrates every wire-encoded scalar in a AuthenticationTokenResponseOutput into its runtime type. Mutates and returns `raw`. */
874
874
  export declare function reviveAuthenticationTokenResponseOutput(raw: AuthenticationTokenResponseOutput): AuthenticationTokenResponseOutput;
875
875
  /**
876
- * generated from [AuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L82)
876
+ * generated from [AuthenticationRequest](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
877
877
  */
878
878
  export type AuthenticationRequest = PasswordAuthenticationRequest | ClientCredentialsAuthenticationRequest | RefreshTokenAuthenticationRequest | LinkAuthenticationRequest | CodeAuthenticationRequest | FidoAuthenticationRequest | AuthenticatorAuthenticationRequest | OidcAuthenticationRequest;
879
879
  /**
880
- * generated from [AuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L234)
880
+ * generated from [AuthenticationLoginStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
881
881
  */
882
882
  export type AuthenticationLoginStartResponse = CodeAuthenticationLoginStartResponse | LinkAuthenticationLoginStartResponse | FidoAuthenticationLoginStartResponse | OidcAuthenticationLoginStartResponse;
883
883
  /** Rehydrates every wire-encoded scalar in a AuthenticationLoginStartResponse into its runtime type. Mutates and returns `raw`. */
884
884
  export declare function reviveAuthenticationLoginStartResponse(raw: AuthenticationLoginStartResponse): AuthenticationLoginStartResponse;
885
885
  /**
886
- * generated from [FactorChallengeStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L312)
886
+ * generated from [FactorChallengeStartResponse](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
887
887
  */
888
888
  export type FactorChallengeStartResponse = FactorChallengePhoneStartResponse | FactorChallengeFidoStartResponse | FactorChallengeEmailStartResponse;
889
889
  export type FactorChallengeStartResponseOutput = FactorChallengePhoneStartResponseOutput | FactorChallengeFidoStartResponseOutput | FactorChallengeEmailStartResponseOutput;
@@ -892,7 +892,7 @@ export declare function reviveFactorChallengeStartResponse(raw: FactorChallengeS
892
892
  /** Rehydrates every wire-encoded scalar in a FactorChallengeStartResponseOutput into its runtime type. Mutates and returns `raw`. */
893
893
  export declare function reviveFactorChallengeStartResponseOutput(raw: FactorChallengeStartResponseOutput): FactorChallengeStartResponseOutput;
894
894
  /**
895
- * generated from [AuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck#L190)
895
+ * generated from [AuthenticationLoginStart](../../../../../apps/api/data/contracts/authentication/authentication.types.ck)
896
896
  */
897
897
  export type AuthenticationLoginStart = LinkAuthenticationLoginStart | CodeAuthenticationLoginStart | FidoAuthenticationLoginStart | OidcAuthenticationLoginStart;
898
898
  //# sourceMappingURL=authentication.types.d.ts.map