@deepraxis/sdk 0.1.1-dev.69cffcf → 0.1.1-dev.78b913a

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.
@@ -30322,6 +30322,801 @@ export type UnblockEndUserResponses = {
30322
30322
  };
30323
30323
  };
30324
30324
  export type UnblockEndUserResponse = UnblockEndUserResponses[keyof UnblockEndUserResponses];
30325
+ export type ListCustomersData = {
30326
+ body?: never;
30327
+ path: {
30328
+ /**
30329
+ * Active service agent id from agent creation or listing.
30330
+ */
30331
+ agent_id: string;
30332
+ };
30333
+ query?: {
30334
+ /**
30335
+ * Maximum customers per page, 1 to 100; defaults to 20.
30336
+ */
30337
+ limit?: number;
30338
+ /**
30339
+ * next_page from the previous response with the same q, type, blocked and limit.
30340
+ */
30341
+ page?: string;
30342
+ /**
30343
+ * Case-sensitive literal prefix of the customer id; omit for all customers.
30344
+ */
30345
+ q?: string;
30346
+ /**
30347
+ * Only identified or only anonymous customers; omit for both.
30348
+ */
30349
+ type?: 'identified' | 'anonymous';
30350
+ /**
30351
+ * true for blocked customers only, false for customers who are not blocked; omit for both.
30352
+ */
30353
+ blocked?: boolean;
30354
+ };
30355
+ url: '/agent/v1/agents/{agent_id}/customers';
30356
+ };
30357
+ export type ListCustomersErrors = {
30358
+ /**
30359
+ * INVALID_PARAMS: limit outside 1 to 100, type other than identified or anonymous, blocked other than true or false, or an unknown query parameter. INVALID_PAGE_TOKEN: next_page from another query; restart without page.
30360
+ */
30361
+ 400: unknown;
30362
+ /**
30363
+ * Authenticate with your API key or a console session.
30364
+ */
30365
+ 401: unknown;
30366
+ /**
30367
+ * permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
30368
+ */
30369
+ 403: AgentError;
30370
+ /**
30371
+ * The agent is not an active service agent of your organization, or the caller is a customer access token.
30372
+ */
30373
+ 404: unknown;
30374
+ };
30375
+ export type ListCustomersError = ListCustomersErrors[keyof ListCustomersErrors];
30376
+ export type ListCustomersResponses = {
30377
+ /**
30378
+ * Matching customers and the next page cursor.
30379
+ */
30380
+ 200: {
30381
+ /**
30382
+ * Items of this page, in the order requested by the call.
30383
+ */
30384
+ data: Array<{
30385
+ /**
30386
+ * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
30387
+ */
30388
+ id: string;
30389
+ /**
30390
+ * identified: signed in through a grant code from your backend, or seen under your own id before customer sign-in existed. anonymous: a visitor admitted with the publishable key.
30391
+ */
30392
+ type: 'identified' | 'anonymous';
30393
+ /**
30394
+ * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
30395
+ */
30396
+ merged_into: string | null;
30397
+ /**
30398
+ * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
30399
+ */
30400
+ blocked: boolean;
30401
+ /**
30402
+ * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
30403
+ */
30404
+ first_seen_at: string | null;
30405
+ /**
30406
+ * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
30407
+ */
30408
+ last_seen_at: string | null;
30409
+ /**
30410
+ * Sessions of this customer on this agent, including those of anonymous customers merged into it.
30411
+ */
30412
+ session_count: number;
30413
+ /**
30414
+ * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
30415
+ */
30416
+ cost: {
30417
+ /**
30418
+ * Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
30419
+ */
30420
+ amount: string;
30421
+ /**
30422
+ * Always USD.
30423
+ */
30424
+ currency: 'USD';
30425
+ };
30426
+ }>;
30427
+ /**
30428
+ * Cursor for the next page with the same agent, q, type, blocked and limit; null when exhausted.
30429
+ */
30430
+ next_page: string | null;
30431
+ };
30432
+ };
30433
+ export type ListCustomersResponse = ListCustomersResponses[keyof ListCustomersResponses];
30434
+ export type DeleteCustomerData = {
30435
+ body?: never;
30436
+ path: {
30437
+ /**
30438
+ * Active service agent id from agent creation or listing.
30439
+ */
30440
+ agent_id: string;
30441
+ /**
30442
+ * Customer id from customer listing, or your own customer_id.
30443
+ */
30444
+ customer_id: string;
30445
+ };
30446
+ query: {
30447
+ /**
30448
+ * Must equal the customer_id path parameter exactly, confirming the destructive deletion.
30449
+ */
30450
+ confirm: string;
30451
+ };
30452
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}';
30453
+ };
30454
+ export type DeleteCustomerErrors = {
30455
+ /**
30456
+ * INVALID_PARAMS: confirm is missing or differs from customer_id; send ?confirm=<customer_id>.
30457
+ */
30458
+ 400: unknown;
30459
+ /**
30460
+ * Authenticate with your API key or a console session.
30461
+ */
30462
+ 401: unknown;
30463
+ /**
30464
+ * permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
30465
+ */
30466
+ 403: AgentError;
30467
+ /**
30468
+ * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30469
+ */
30470
+ 404: unknown;
30471
+ };
30472
+ export type DeleteCustomerError = DeleteCustomerErrors[keyof DeleteCustomerErrors];
30473
+ export type DeleteCustomerResponses = {
30474
+ /**
30475
+ * Deletion accepted; poll the deletion endpoint until done or failed.
30476
+ */
30477
+ 202: {
30478
+ /**
30479
+ * Deletion task identifier.
30480
+ */
30481
+ id: string;
30482
+ /**
30483
+ * Accepted for asynchronous processing; poll deletion for progress.
30484
+ */
30485
+ status: 'pending';
30486
+ };
30487
+ };
30488
+ export type DeleteCustomerResponse = DeleteCustomerResponses[keyof DeleteCustomerResponses];
30489
+ export type GetCustomerData = {
30490
+ body?: never;
30491
+ path: {
30492
+ /**
30493
+ * Active service agent id from agent creation or listing.
30494
+ */
30495
+ agent_id: string;
30496
+ /**
30497
+ * Customer id from customer listing, or your own customer_id.
30498
+ */
30499
+ customer_id: string;
30500
+ };
30501
+ query?: never;
30502
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}';
30503
+ };
30504
+ export type GetCustomerErrors = {
30505
+ /**
30506
+ * Authenticate with your API key or a console session.
30507
+ */
30508
+ 401: unknown;
30509
+ /**
30510
+ * permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
30511
+ */
30512
+ 403: AgentError;
30513
+ /**
30514
+ * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30515
+ */
30516
+ 404: unknown;
30517
+ };
30518
+ export type GetCustomerError = GetCustomerErrors[keyof GetCustomerErrors];
30519
+ export type GetCustomerResponses = {
30520
+ /**
30521
+ * The customer with its recent sessions.
30522
+ */
30523
+ 200: {
30524
+ /**
30525
+ * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
30526
+ */
30527
+ id: string;
30528
+ /**
30529
+ * identified: signed in through a grant code from your backend, or seen under your own id before customer sign-in existed. anonymous: a visitor admitted with the publishable key.
30530
+ */
30531
+ type: 'identified' | 'anonymous';
30532
+ /**
30533
+ * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
30534
+ */
30535
+ merged_into: string | null;
30536
+ /**
30537
+ * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
30538
+ */
30539
+ blocked: boolean;
30540
+ /**
30541
+ * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
30542
+ */
30543
+ first_seen_at: string | null;
30544
+ /**
30545
+ * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
30546
+ */
30547
+ last_seen_at: string | null;
30548
+ /**
30549
+ * Sessions of this customer on this agent, including those of anonymous customers merged into it.
30550
+ */
30551
+ session_count: number;
30552
+ /**
30553
+ * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
30554
+ */
30555
+ cost: {
30556
+ /**
30557
+ * Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
30558
+ */
30559
+ amount: string;
30560
+ /**
30561
+ * Always USD.
30562
+ */
30563
+ currency: 'USD';
30564
+ };
30565
+ /**
30566
+ * Up to twenty sessions of the customer, and of anonymous customers merged into it, most recently updated first.
30567
+ */
30568
+ recent_sessions: Array<{
30569
+ /**
30570
+ * Public sesn_ session identifier, usable with session retrieval.
30571
+ */
30572
+ id: string;
30573
+ /**
30574
+ * Session title, or null when unset.
30575
+ */
30576
+ title: string | null;
30577
+ /**
30578
+ * Session entry surface, or null when no surface was recorded.
30579
+ */
30580
+ source: string | null;
30581
+ /**
30582
+ * Session creation time in UTC.
30583
+ */
30584
+ created_at: string;
30585
+ /**
30586
+ * Most recent session update time in UTC.
30587
+ */
30588
+ updated_at: string;
30589
+ }>;
30590
+ };
30591
+ };
30592
+ export type GetCustomerResponse = GetCustomerResponses[keyof GetCustomerResponses];
30593
+ export type GetCustomerDeletionData = {
30594
+ body?: never;
30595
+ path: {
30596
+ /**
30597
+ * Active service agent id from agent creation or listing.
30598
+ */
30599
+ agent_id: string;
30600
+ /**
30601
+ * Customer id from customer listing, or your own customer_id.
30602
+ */
30603
+ customer_id: string;
30604
+ };
30605
+ query?: never;
30606
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion';
30607
+ };
30608
+ export type GetCustomerDeletionErrors = {
30609
+ /**
30610
+ * Authenticate with your API key or a console session.
30611
+ */
30612
+ 401: unknown;
30613
+ /**
30614
+ * permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
30615
+ */
30616
+ 403: AgentError;
30617
+ /**
30618
+ * CUSTOMER_NOT_FOUND or no deletion task: the customer or task is unknown, or the caller is a customer access token.
30619
+ */
30620
+ 404: unknown;
30621
+ };
30622
+ export type GetCustomerDeletionError = GetCustomerDeletionErrors[keyof GetCustomerDeletionErrors];
30623
+ export type GetCustomerDeletionResponses = {
30624
+ /**
30625
+ * The latest deletion task and its snapshot counts.
30626
+ */
30627
+ 200: {
30628
+ /**
30629
+ * Deletion task identifier.
30630
+ */
30631
+ id: string;
30632
+ /**
30633
+ * pending: accepted; snapshotting: exporting recovery data; deleting: verified snapshot exists and erasure is running; done: erasure completed; failed: stopped safely, retry DELETE to resume the same task.
30634
+ */
30635
+ status: 'pending' | 'snapshotting' | 'deleting' | 'done' | 'failed';
30636
+ /**
30637
+ * Counts from the verified snapshot; empty until snapshotting completes.
30638
+ */
30639
+ counts: {
30640
+ /**
30641
+ * Number of primary and child sessions in the snapshot.
30642
+ */
30643
+ sessions?: number;
30644
+ /**
30645
+ * Number of durable session events captured without changing the history.
30646
+ */
30647
+ events?: number;
30648
+ /**
30649
+ * Number of stored transcript messages in the snapshot.
30650
+ */
30651
+ messages?: number;
30652
+ /**
30653
+ * Number of backed-up directory, authorization, feedback and projection rows.
30654
+ */
30655
+ d1_rows?: number;
30656
+ /**
30657
+ * Number of session attachment references; their file bytes are retained.
30658
+ */
30659
+ attachments?: number;
30660
+ };
30661
+ /**
30662
+ * Operator recovery snapshot key, retained for seven days. Attachment bytes are not copied or deleted.
30663
+ */
30664
+ snapshot_key?: string;
30665
+ /**
30666
+ * Content-free failure summary; retry the confirmed deletion to resume.
30667
+ */
30668
+ error?: string;
30669
+ /**
30670
+ * Task creation time in RFC 3339 format.
30671
+ */
30672
+ created_at: string;
30673
+ /**
30674
+ * Latest task update time in RFC 3339 format.
30675
+ */
30676
+ updated_at: string;
30677
+ };
30678
+ };
30679
+ export type GetCustomerDeletionResponse = GetCustomerDeletionResponses[keyof GetCustomerDeletionResponses];
30680
+ export type BlockCustomerData = {
30681
+ body?: never;
30682
+ path: {
30683
+ /**
30684
+ * Active service agent id from agent creation or listing.
30685
+ */
30686
+ agent_id: string;
30687
+ /**
30688
+ * Customer id from customer listing, or your own customer_id.
30689
+ */
30690
+ customer_id: string;
30691
+ };
30692
+ query?: never;
30693
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/block';
30694
+ };
30695
+ export type BlockCustomerErrors = {
30696
+ /**
30697
+ * Authenticate with your API key or a console session.
30698
+ */
30699
+ 401: unknown;
30700
+ /**
30701
+ * permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
30702
+ */
30703
+ 403: AgentError;
30704
+ /**
30705
+ * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30706
+ */
30707
+ 404: unknown;
30708
+ /**
30709
+ * Credential revocation failed; the customer stays blocked if you asked to block it. Retry to finish revoking.
30710
+ */
30711
+ 502: unknown;
30712
+ };
30713
+ export type BlockCustomerError = BlockCustomerErrors[keyof BlockCustomerErrors];
30714
+ export type BlockCustomerResponses = {
30715
+ /**
30716
+ * The customer after the change.
30717
+ */
30718
+ 200: {
30719
+ /**
30720
+ * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
30721
+ */
30722
+ id: string;
30723
+ /**
30724
+ * identified: signed in through a grant code from your backend, or seen under your own id before customer sign-in existed. anonymous: a visitor admitted with the publishable key.
30725
+ */
30726
+ type: 'identified' | 'anonymous';
30727
+ /**
30728
+ * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
30729
+ */
30730
+ merged_into: string | null;
30731
+ /**
30732
+ * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
30733
+ */
30734
+ blocked: boolean;
30735
+ /**
30736
+ * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
30737
+ */
30738
+ first_seen_at: string | null;
30739
+ /**
30740
+ * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
30741
+ */
30742
+ last_seen_at: string | null;
30743
+ /**
30744
+ * Sessions of this customer on this agent, including those of anonymous customers merged into it.
30745
+ */
30746
+ session_count: number;
30747
+ /**
30748
+ * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
30749
+ */
30750
+ cost: {
30751
+ /**
30752
+ * Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
30753
+ */
30754
+ amount: string;
30755
+ /**
30756
+ * Always USD.
30757
+ */
30758
+ currency: 'USD';
30759
+ };
30760
+ };
30761
+ };
30762
+ export type BlockCustomerResponse = BlockCustomerResponses[keyof BlockCustomerResponses];
30763
+ export type UnblockCustomerData = {
30764
+ body?: never;
30765
+ path: {
30766
+ /**
30767
+ * Active service agent id from agent creation or listing.
30768
+ */
30769
+ agent_id: string;
30770
+ /**
30771
+ * Customer id from customer listing, or your own customer_id.
30772
+ */
30773
+ customer_id: string;
30774
+ };
30775
+ query?: never;
30776
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock';
30777
+ };
30778
+ export type UnblockCustomerErrors = {
30779
+ /**
30780
+ * Authenticate with your API key or a console session.
30781
+ */
30782
+ 401: unknown;
30783
+ /**
30784
+ * permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
30785
+ */
30786
+ 403: AgentError;
30787
+ /**
30788
+ * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30789
+ */
30790
+ 404: unknown;
30791
+ };
30792
+ export type UnblockCustomerError = UnblockCustomerErrors[keyof UnblockCustomerErrors];
30793
+ export type UnblockCustomerResponses = {
30794
+ /**
30795
+ * The customer after the change.
30796
+ */
30797
+ 200: {
30798
+ /**
30799
+ * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
30800
+ */
30801
+ id: string;
30802
+ /**
30803
+ * identified: signed in through a grant code from your backend, or seen under your own id before customer sign-in existed. anonymous: a visitor admitted with the publishable key.
30804
+ */
30805
+ type: 'identified' | 'anonymous';
30806
+ /**
30807
+ * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
30808
+ */
30809
+ merged_into: string | null;
30810
+ /**
30811
+ * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
30812
+ */
30813
+ blocked: boolean;
30814
+ /**
30815
+ * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
30816
+ */
30817
+ first_seen_at: string | null;
30818
+ /**
30819
+ * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
30820
+ */
30821
+ last_seen_at: string | null;
30822
+ /**
30823
+ * Sessions of this customer on this agent, including those of anonymous customers merged into it.
30824
+ */
30825
+ session_count: number;
30826
+ /**
30827
+ * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
30828
+ */
30829
+ cost: {
30830
+ /**
30831
+ * Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
30832
+ */
30833
+ amount: string;
30834
+ /**
30835
+ * Always USD.
30836
+ */
30837
+ currency: 'USD';
30838
+ };
30839
+ };
30840
+ };
30841
+ export type UnblockCustomerResponse = UnblockCustomerResponses[keyof UnblockCustomerResponses];
30842
+ export type RevokeCustomerTokensData = {
30843
+ body?: never;
30844
+ path: {
30845
+ /**
30846
+ * Active service agent id from agent creation or listing.
30847
+ */
30848
+ agent_id: string;
30849
+ /**
30850
+ * Customer id from customer listing, or your own customer_id.
30851
+ */
30852
+ customer_id: string;
30853
+ };
30854
+ query?: never;
30855
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens';
30856
+ };
30857
+ export type RevokeCustomerTokensErrors = {
30858
+ /**
30859
+ * Authenticate with your API key or a console session.
30860
+ */
30861
+ 401: unknown;
30862
+ /**
30863
+ * permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
30864
+ */
30865
+ 403: AgentError;
30866
+ /**
30867
+ * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30868
+ */
30869
+ 404: unknown;
30870
+ /**
30871
+ * Credential revocation failed; the customer stays blocked if you asked to block it. Retry to finish revoking.
30872
+ */
30873
+ 502: unknown;
30874
+ };
30875
+ export type RevokeCustomerTokensError = RevokeCustomerTokensErrors[keyof RevokeCustomerTokensErrors];
30876
+ export type RevokeCustomerTokensResponses = {
30877
+ /**
30878
+ * How many access tokens this request revoked.
30879
+ */
30880
+ 200: {
30881
+ /**
30882
+ * Number of access tokens this request revoked; 0 when none was live.
30883
+ */
30884
+ revoked: number;
30885
+ };
30886
+ };
30887
+ export type RevokeCustomerTokensResponse = RevokeCustomerTokensResponses[keyof RevokeCustomerTokensResponses];
30888
+ export type GetAgentAppearanceData = {
30889
+ body?: never;
30890
+ path: {
30891
+ /**
30892
+ * Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for.
30893
+ */
30894
+ agent_id: string;
30895
+ };
30896
+ query?: never;
30897
+ url: '/agent/v1/agents/{agent_id}/appearance';
30898
+ };
30899
+ export type GetAgentAppearanceErrors = {
30900
+ /**
30901
+ * Authenticate with a customer access token of this agent, your API key or a console session.
30902
+ */
30903
+ 401: unknown;
30904
+ /**
30905
+ * permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
30906
+ */
30907
+ 403: AgentError;
30908
+ /**
30909
+ * AGENT_NOT_FOUND: the agent is absent, archived or not a service agent, or the customer access token belongs to another agent.
30910
+ */
30911
+ 404: unknown;
30912
+ /**
30913
+ * Appearance is temporarily unavailable; use the default appearance and continue the conversation.
30914
+ */
30915
+ 503: unknown;
30916
+ };
30917
+ export type GetAgentAppearanceError = GetAgentAppearanceErrors[keyof GetAgentAppearanceErrors];
30918
+ export type GetAgentAppearanceResponses = {
30919
+ /**
30920
+ * Saved Kit options, at most 8192 UTF-8 JSON bytes. Omitted groups use Kit defaults; an unconfigured agent returns an empty object.
30921
+ */
30922
+ 200: {
30923
+ /**
30924
+ * Public identity displayed on the chat page, independent of the internal agent name.
30925
+ */
30926
+ agent?: {
30927
+ /**
30928
+ * Display name; omission keeps the neutral browser-language default.
30929
+ */
30930
+ name?: string;
30931
+ /**
30932
+ * Optional HTTPS avatar image URL; non-HTTPS images are rejected.
30933
+ */
30934
+ avatar?: string;
30935
+ };
30936
+ /**
30937
+ * Loader default: inline stays in the page, sidebar attaches to the edge, popup floats above its launcher, modal centers an overlay. A script data-layout overrides it; Hosted always uses inline.
30938
+ */
30939
+ layout?: 'inline' | 'sidebar' | 'popup' | 'modal';
30940
+ /**
30941
+ * Default entry button for the loader; an explicit script data-launcher takes precedence.
30942
+ */
30943
+ launcher?: {
30944
+ /**
30945
+ * Entry control: none hides the launcher, bubble shows a button, mascot shows a character that reacts while the visitor types and the agent thinks and answers. A mascot needs pack.
30946
+ */
30947
+ type: 'none' | 'bubble' | 'mascot';
30948
+ /**
30949
+ * Mascot images: exactly one of preset or images. Send pack, not image.
30950
+ */
30951
+ pack?: {
30952
+ /**
30953
+ * Built-in character: mint (mint support girl), cat (cat-eared girl) or bot (small robot).
30954
+ */
30955
+ preset?: 'mint' | 'cat' | 'bot';
30956
+ /**
30957
+ * One HTTPS image per slot; only idle is required and a missing slot shows idle. Use 2:3 canvases with the feet bottom-centered on a transparent background; PNG or WebP stay still, GIF, WebP and APNG play as they are.
30958
+ */
30959
+ images?: {
30960
+ /**
30961
+ * Resting state.
30962
+ */
30963
+ idle: string;
30964
+ /**
30965
+ * Page open and while the greeting bubble shows.
30966
+ */
30967
+ greet?: string;
30968
+ /**
30969
+ * The visitor is typing in the composer.
30970
+ */
30971
+ listening?: string;
30972
+ /**
30973
+ * After the visitor sends, before the first reply text.
30974
+ */
30975
+ thinking?: string;
30976
+ /**
30977
+ * While the reply streams; alternates with talking-2 every 220 ms.
30978
+ */
30979
+ talking?: string;
30980
+ /**
30981
+ * Second mouth frame of talking, mouth closed; without it talking alternates with idle.
30982
+ */
30983
+ 'talking-2'?: string;
30984
+ /**
30985
+ * The last turn failed or was refused.
30986
+ */
30987
+ sorry?: string;
30988
+ /**
30989
+ * No interaction for 60 seconds; hover or click wakes the mascot.
30990
+ */
30991
+ sleep?: string;
30992
+ };
30993
+ };
30994
+ /**
30995
+ * Legacy single mascot image, read as pack.images.idle. When pack is present, pack wins.
30996
+ */
30997
+ image?: string;
30998
+ /**
30999
+ * float (default) gently floats the mascot, bounces on hover and waves with the greeting; none keeps it still. Reduced-motion settings always win.
31000
+ */
31001
+ motion?: 'float' | 'none';
31002
+ /**
31003
+ * Launcher corner: bottom-right is the default; bottom-left uses the opposite corner.
31004
+ */
31005
+ position?: 'bottom-right' | 'bottom-left';
31006
+ /**
31007
+ * Accessible entry button label and bubble text; omission uses the default chat label.
31008
+ */
31009
+ label?: string;
31010
+ };
31011
+ /**
31012
+ * Visible chat heading; omitted title uses the public agent name.
31013
+ */
31014
+ header?: {
31015
+ /**
31016
+ * Optional heading text shown instead of the public agent name.
31017
+ */
31018
+ title?: string;
31019
+ /**
31020
+ * Optional secondary line beneath the heading.
31021
+ */
31022
+ subtitle?: string;
31023
+ /**
31024
+ * Optional HTTPS image shown in the heading avatar position.
31025
+ */
31026
+ icon?: string;
31027
+ };
31028
+ /**
31029
+ * Visual tokens applied to the conversation and header; omitted fields use Kit defaults.
31030
+ */
31031
+ theme?: {
31032
+ /**
31033
+ * light or dark selects a fixed scheme; system follows the device preference.
31034
+ */
31035
+ colorScheme?: 'light' | 'dark' | 'system';
31036
+ /**
31037
+ * Explicit opaque CSS accent color, for example #167A43.
31038
+ */
31039
+ accent?: string;
31040
+ /**
31041
+ * Explicit opaque CSS background color, for example #ffffff.
31042
+ */
31043
+ surface?: string;
31044
+ /**
31045
+ * neutral uses grayscale surfaces, warm uses warm tones, cool uses cool tones.
31046
+ */
31047
+ grayscale?: 'neutral' | 'warm' | 'cool';
31048
+ /**
31049
+ * Corner rounding: none is square, sm is small, md is medium, lg is large, full is fully rounded.
31050
+ */
31051
+ radius?: 'none' | 'sm' | 'md' | 'lg' | 'full';
31052
+ /**
31053
+ * Spacing: compact reduces gaps, normal uses defaults, spacious increases gaps.
31054
+ */
31055
+ density?: 'compact' | 'normal' | 'spacious';
31056
+ /**
31057
+ * CSS font family list using fonts available on the device; external font loading is not configured here.
31058
+ */
31059
+ fontFamily?: string;
31060
+ /**
31061
+ * Positive base font size in CSS pixels; omission preserves Kit sizing.
31062
+ */
31063
+ fontSize?: number;
31064
+ };
31065
+ /**
31066
+ * Reserved Kit locale preference: zh for Chinese, en for English. Kit currently passes this option through without translating all controls.
31067
+ */
31068
+ locale?: 'zh' | 'en';
31069
+ /**
31070
+ * Content displayed before the first message in a conversation.
31071
+ */
31072
+ startScreen?: {
31073
+ /**
31074
+ * Optional welcome text on the empty conversation.
31075
+ */
31076
+ greeting?: string;
31077
+ /**
31078
+ * Up to four suggested questions; clicking a label sends its prompt text.
31079
+ */
31080
+ prompts?: Array<{
31081
+ /**
31082
+ * Visible suggested-question button text.
31083
+ */
31084
+ label: string;
31085
+ /**
31086
+ * User message sent when this suggestion is selected.
31087
+ */
31088
+ prompt: string;
31089
+ }>;
31090
+ };
31091
+ /**
31092
+ * Message input appearance; transport and attachment settings are excluded.
31093
+ */
31094
+ composer?: {
31095
+ /**
31096
+ * Hint shown when the message input is empty.
31097
+ */
31098
+ placeholder?: string;
31099
+ };
31100
+ /**
31101
+ * Optional notice displayed beside the conversation composer.
31102
+ */
31103
+ disclaimer?: string;
31104
+ /**
31105
+ * Optional text below the conversation.
31106
+ */
31107
+ footer?: string;
31108
+ /**
31109
+ * Availability of the conversation history control.
31110
+ */
31111
+ history?: {
31112
+ /**
31113
+ * False hides history; omission uses the default enabled state.
31114
+ */
31115
+ enabled?: boolean;
31116
+ };
31117
+ };
31118
+ };
31119
+ export type GetAgentAppearanceResponse = GetAgentAppearanceResponses[keyof GetAgentAppearanceResponses];
30325
31120
  export type CreateCustomerGrantCodeData = {
30326
31121
  body: {
30327
31122
  /**