@zilfu/sdk 0.1.1 → 0.1.3
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.
- package/dist/index.cjs +51 -74
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +98 -190
- package/dist/index.d.ts +98 -190
- package/dist/index.js +51 -74
- package/dist/index.js.map +1 -1
- package/package.json +3 -4
package/dist/index.d.cts
CHANGED
|
@@ -392,6 +392,12 @@ type PostResource = {
|
|
|
392
392
|
* PostStatus
|
|
393
393
|
*/
|
|
394
394
|
type PostStatus = 0 | 1 | 2 | 3 | 4;
|
|
395
|
+
/**
|
|
396
|
+
* SignMediaRequest
|
|
397
|
+
*/
|
|
398
|
+
type SignMediaRequest = {
|
|
399
|
+
mime: 'image/jpeg' | 'image/png' | 'image/webp' | 'video/mp4' | 'video/quicktime';
|
|
400
|
+
};
|
|
395
401
|
/**
|
|
396
402
|
* SlotResource
|
|
397
403
|
*/
|
|
@@ -439,7 +445,7 @@ type StorePostRequest = {
|
|
|
439
445
|
children?: Array<{
|
|
440
446
|
content: string;
|
|
441
447
|
media?: Array<{
|
|
442
|
-
|
|
448
|
+
url: string;
|
|
443
449
|
type: 'image' | 'video';
|
|
444
450
|
}> | null;
|
|
445
451
|
}> | null;
|
|
@@ -460,7 +466,7 @@ type StorePostRequest = {
|
|
|
460
466
|
main?: {
|
|
461
467
|
content: string;
|
|
462
468
|
media?: Array<{
|
|
463
|
-
|
|
469
|
+
url: string;
|
|
464
470
|
type: 'image' | 'video';
|
|
465
471
|
}> | null;
|
|
466
472
|
};
|
|
@@ -516,7 +522,7 @@ type UpdateClusterRequest = {
|
|
|
516
522
|
children?: Array<{
|
|
517
523
|
content: string;
|
|
518
524
|
media?: Array<{
|
|
519
|
-
|
|
525
|
+
url: string;
|
|
520
526
|
type: 'image' | 'video';
|
|
521
527
|
}> | null;
|
|
522
528
|
}> | null;
|
|
@@ -537,7 +543,7 @@ type UpdateClusterRequest = {
|
|
|
537
543
|
main?: {
|
|
538
544
|
content: string;
|
|
539
545
|
media?: Array<{
|
|
540
|
-
|
|
546
|
+
url: string;
|
|
541
547
|
type: 'image' | 'video';
|
|
542
548
|
}> | null;
|
|
543
549
|
};
|
|
@@ -550,8 +556,24 @@ type UpdatePostRequest = {
|
|
|
550
556
|
content?: string;
|
|
551
557
|
status?: PostStatus;
|
|
552
558
|
scheduled_at?: string | null;
|
|
553
|
-
metadata?:
|
|
554
|
-
|
|
559
|
+
metadata?: {
|
|
560
|
+
topic_tag?: string | null;
|
|
561
|
+
post_type?: string | null;
|
|
562
|
+
link?: string | null;
|
|
563
|
+
privacy_level?: string | null;
|
|
564
|
+
allow_comments?: boolean | null;
|
|
565
|
+
allow_duet?: boolean | null;
|
|
566
|
+
allow_stitch?: boolean | null;
|
|
567
|
+
branded_content?: boolean | null;
|
|
568
|
+
brand_organic?: boolean | null;
|
|
569
|
+
board_id?: string | null;
|
|
570
|
+
title?: string | null;
|
|
571
|
+
cover_image_url?: string | null;
|
|
572
|
+
};
|
|
573
|
+
media?: Array<{
|
|
574
|
+
url: string;
|
|
575
|
+
type: 'image' | 'video';
|
|
576
|
+
}> | null;
|
|
555
577
|
};
|
|
556
578
|
/**
|
|
557
579
|
* UpdateSpaceRequest
|
|
@@ -579,70 +601,6 @@ type WebhookResource = {
|
|
|
579
601
|
created_at: string | null;
|
|
580
602
|
updated_at: string | null;
|
|
581
603
|
};
|
|
582
|
-
type DeleteSpacesBySpaceAccountsData = {
|
|
583
|
-
body?: never;
|
|
584
|
-
path: {
|
|
585
|
-
/**
|
|
586
|
-
* The space ID
|
|
587
|
-
*/
|
|
588
|
-
space: number;
|
|
589
|
-
};
|
|
590
|
-
query?: {
|
|
591
|
-
'ids[]'?: Array<number>;
|
|
592
|
-
};
|
|
593
|
-
url: '/spaces/{space}/accounts';
|
|
594
|
-
};
|
|
595
|
-
type DeleteSpacesBySpaceAccountsErrors = {
|
|
596
|
-
/**
|
|
597
|
-
* Unauthenticated
|
|
598
|
-
*/
|
|
599
|
-
401: {
|
|
600
|
-
/**
|
|
601
|
-
* Error overview.
|
|
602
|
-
*/
|
|
603
|
-
message: string;
|
|
604
|
-
};
|
|
605
|
-
/**
|
|
606
|
-
* Authorization error
|
|
607
|
-
*/
|
|
608
|
-
403: {
|
|
609
|
-
/**
|
|
610
|
-
* Error overview.
|
|
611
|
-
*/
|
|
612
|
-
message: string;
|
|
613
|
-
};
|
|
614
|
-
/**
|
|
615
|
-
* Not found
|
|
616
|
-
*/
|
|
617
|
-
404: {
|
|
618
|
-
/**
|
|
619
|
-
* Error overview.
|
|
620
|
-
*/
|
|
621
|
-
message: string;
|
|
622
|
-
};
|
|
623
|
-
/**
|
|
624
|
-
* Validation error
|
|
625
|
-
*/
|
|
626
|
-
422: {
|
|
627
|
-
/**
|
|
628
|
-
* Errors overview.
|
|
629
|
-
*/
|
|
630
|
-
message: string;
|
|
631
|
-
/**
|
|
632
|
-
* A detailed description of each field that failed validation.
|
|
633
|
-
*/
|
|
634
|
-
errors: {
|
|
635
|
-
[key: string]: Array<string>;
|
|
636
|
-
};
|
|
637
|
-
};
|
|
638
|
-
};
|
|
639
|
-
type DeleteSpacesBySpaceAccountsError = DeleteSpacesBySpaceAccountsErrors[keyof DeleteSpacesBySpaceAccountsErrors];
|
|
640
|
-
type DeleteSpacesBySpaceAccountsResponses = {
|
|
641
|
-
200: {
|
|
642
|
-
[key: string]: unknown;
|
|
643
|
-
};
|
|
644
|
-
};
|
|
645
|
-
type DeleteSpacesBySpaceAccountsResponse = DeleteSpacesBySpaceAccountsResponses[keyof DeleteSpacesBySpaceAccountsResponses];
|
|
646
604
|
type GetSpacesBySpaceAccountsData = {
|
|
647
605
|
body?: never;
|
|
648
606
|
path: {
|
|
@@ -1481,62 +1439,13 @@ type GetHealthResponses = {
|
|
|
1481
1439
|
};
|
|
1482
1440
|
};
|
|
1483
1441
|
type GetHealthResponse = GetHealthResponses[keyof GetHealthResponses];
|
|
1484
|
-
type
|
|
1485
|
-
body:
|
|
1486
|
-
file: Blob | File;
|
|
1487
|
-
};
|
|
1442
|
+
type PostMediaSignData = {
|
|
1443
|
+
body: SignMediaRequest;
|
|
1488
1444
|
path?: never;
|
|
1489
1445
|
query?: never;
|
|
1490
|
-
url: '/media';
|
|
1446
|
+
url: '/media/sign';
|
|
1491
1447
|
};
|
|
1492
|
-
type
|
|
1493
|
-
/**
|
|
1494
|
-
* Unauthenticated
|
|
1495
|
-
*/
|
|
1496
|
-
401: {
|
|
1497
|
-
/**
|
|
1498
|
-
* Error overview.
|
|
1499
|
-
*/
|
|
1500
|
-
message: string;
|
|
1501
|
-
};
|
|
1502
|
-
/**
|
|
1503
|
-
* Validation error
|
|
1504
|
-
*/
|
|
1505
|
-
422: {
|
|
1506
|
-
/**
|
|
1507
|
-
* Errors overview.
|
|
1508
|
-
*/
|
|
1509
|
-
message: string;
|
|
1510
|
-
/**
|
|
1511
|
-
* A detailed description of each field that failed validation.
|
|
1512
|
-
*/
|
|
1513
|
-
errors: {
|
|
1514
|
-
[key: string]: Array<string>;
|
|
1515
|
-
};
|
|
1516
|
-
};
|
|
1517
|
-
};
|
|
1518
|
-
type PostMediaError = PostMediaErrors[keyof PostMediaErrors];
|
|
1519
|
-
type PostMediaResponses = {
|
|
1520
|
-
/**
|
|
1521
|
-
* `MediaResource`
|
|
1522
|
-
*/
|
|
1523
|
-
201: {
|
|
1524
|
-
data: MediaResource;
|
|
1525
|
-
};
|
|
1526
|
-
};
|
|
1527
|
-
type PostMediaResponse = PostMediaResponses[keyof PostMediaResponses];
|
|
1528
|
-
type DeleteMediaByMediaData = {
|
|
1529
|
-
body?: never;
|
|
1530
|
-
path: {
|
|
1531
|
-
/**
|
|
1532
|
-
* The media ID
|
|
1533
|
-
*/
|
|
1534
|
-
media: number;
|
|
1535
|
-
};
|
|
1536
|
-
query?: never;
|
|
1537
|
-
url: '/media/{media}';
|
|
1538
|
-
};
|
|
1539
|
-
type DeleteMediaByMediaErrors = {
|
|
1448
|
+
type PostMediaSignErrors = {
|
|
1540
1449
|
/**
|
|
1541
1450
|
* Unauthenticated
|
|
1542
1451
|
*/
|
|
@@ -1556,22 +1465,31 @@ type DeleteMediaByMediaErrors = {
|
|
|
1556
1465
|
message: string;
|
|
1557
1466
|
};
|
|
1558
1467
|
/**
|
|
1559
|
-
*
|
|
1468
|
+
* Validation error
|
|
1560
1469
|
*/
|
|
1561
|
-
|
|
1470
|
+
422: {
|
|
1562
1471
|
/**
|
|
1563
|
-
*
|
|
1472
|
+
* Errors overview.
|
|
1564
1473
|
*/
|
|
1565
1474
|
message: string;
|
|
1475
|
+
/**
|
|
1476
|
+
* A detailed description of each field that failed validation.
|
|
1477
|
+
*/
|
|
1478
|
+
errors: {
|
|
1479
|
+
[key: string]: Array<string>;
|
|
1480
|
+
};
|
|
1566
1481
|
};
|
|
1567
1482
|
};
|
|
1568
|
-
type
|
|
1569
|
-
type
|
|
1483
|
+
type PostMediaSignError = PostMediaSignErrors[keyof PostMediaSignErrors];
|
|
1484
|
+
type PostMediaSignResponses = {
|
|
1570
1485
|
200: {
|
|
1571
|
-
|
|
1486
|
+
upload_url: string;
|
|
1487
|
+
url: string;
|
|
1488
|
+
path: string;
|
|
1489
|
+
expires_at: string;
|
|
1572
1490
|
};
|
|
1573
1491
|
};
|
|
1574
|
-
type
|
|
1492
|
+
type PostMediaSignResponse = PostMediaSignResponses[keyof PostMediaSignResponses];
|
|
1575
1493
|
type GetSpacesBySpacePostsData = {
|
|
1576
1494
|
body?: never;
|
|
1577
1495
|
path: {
|
|
@@ -2711,180 +2629,176 @@ declare class HeyApiRegistry<T> {
|
|
|
2711
2629
|
set(value: T, key?: string): void;
|
|
2712
2630
|
}
|
|
2713
2631
|
declare class Accounts extends HeyApiClient {
|
|
2714
|
-
/**
|
|
2715
|
-
* Disconnect multiple accounts
|
|
2716
|
-
*
|
|
2717
|
-
* Removes several social account connections in a single request and dispatches a webhook event for each.
|
|
2718
|
-
*/
|
|
2719
|
-
deleteMany<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceAccountsData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceAccountsResponses, DeleteSpacesBySpaceAccountsErrors, ThrowOnError, "fields">;
|
|
2720
2632
|
/**
|
|
2721
2633
|
* List accounts
|
|
2722
|
-
*
|
|
2723
|
-
* Returns all connected social accounts for the given space.
|
|
2724
2634
|
*/
|
|
2725
2635
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceAccountsData, ThrowOnError>): RequestResult<GetSpacesBySpaceAccountsResponses, GetSpacesBySpaceAccountsErrors, ThrowOnError, "fields">;
|
|
2726
2636
|
/**
|
|
2727
2637
|
* Activate an account
|
|
2728
2638
|
*
|
|
2729
|
-
*
|
|
2639
|
+
* Deactivates other accounts on the same platform within the space.
|
|
2730
2640
|
*/
|
|
2731
2641
|
activate<ThrowOnError extends boolean = false>(options: Options<PatchSpacesBySpaceAccountsByAccountActivateData, ThrowOnError>): RequestResult<PatchSpacesBySpaceAccountsByAccountActivateResponses, PatchSpacesBySpaceAccountsByAccountActivateErrors, ThrowOnError, "fields">;
|
|
2732
2642
|
/**
|
|
2733
2643
|
* List Pinterest boards
|
|
2734
|
-
*
|
|
2735
|
-
* Returns the Pinterest boards available for the given account.
|
|
2736
2644
|
*/
|
|
2737
2645
|
boards<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceAccountsByAccountBoardsData, ThrowOnError>): RequestResult<GetSpacesBySpaceAccountsByAccountBoardsResponses, GetSpacesBySpaceAccountsByAccountBoardsErrors, ThrowOnError, "fields">;
|
|
2738
2646
|
/**
|
|
2739
2647
|
* Disconnect an account
|
|
2740
2648
|
*
|
|
2741
|
-
* Removes the
|
|
2649
|
+
* Removes every account on the same platform within the space and fires an AccountDisconnected webhook for each.
|
|
2742
2650
|
*/
|
|
2743
2651
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceAccountsByAccountData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceAccountsByAccountResponses, DeleteSpacesBySpaceAccountsByAccountErrors, ThrowOnError, "fields">;
|
|
2744
2652
|
}
|
|
2745
2653
|
declare class ApiTokens extends HeyApiClient {
|
|
2746
2654
|
/**
|
|
2747
2655
|
* Create an API token
|
|
2748
|
-
*
|
|
2749
|
-
* Generates a new personal access token for the authenticated user.
|
|
2750
2656
|
*/
|
|
2751
2657
|
create<ThrowOnError extends boolean = false>(options: Options<PostApiTokensData, ThrowOnError>): RequestResult<PostApiTokensResponses, PostApiTokensErrors, ThrowOnError, "fields">;
|
|
2752
2658
|
/**
|
|
2753
2659
|
* Revoke an API token
|
|
2754
|
-
*
|
|
2755
|
-
* Deletes the specified personal access token.
|
|
2756
2660
|
*/
|
|
2757
2661
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiTokensByTokenIdData, ThrowOnError>): RequestResult<DeleteApiTokensByTokenIdResponses, DeleteApiTokensByTokenIdErrors, ThrowOnError, "fields">;
|
|
2758
2662
|
}
|
|
2759
2663
|
declare class Blocks extends HeyApiClient {
|
|
2664
|
+
/**
|
|
2665
|
+
* List bio blocks
|
|
2666
|
+
*/
|
|
2760
2667
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceBioBlocksData, ThrowOnError>): RequestResult<GetSpacesBySpaceBioBlocksResponses, GetSpacesBySpaceBioBlocksErrors, ThrowOnError, "fields">;
|
|
2668
|
+
/**
|
|
2669
|
+
* Create a bio block
|
|
2670
|
+
*/
|
|
2761
2671
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioBlocksData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioBlocksResponses, PostSpacesBySpaceBioBlocksErrors, ThrowOnError, "fields">;
|
|
2672
|
+
/**
|
|
2673
|
+
* Delete a bio block
|
|
2674
|
+
*/
|
|
2762
2675
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceBioBlocksByBlockData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceBioBlocksByBlockResponses, DeleteSpacesBySpaceBioBlocksByBlockErrors, ThrowOnError, "fields">;
|
|
2676
|
+
/**
|
|
2677
|
+
* Update a bio block
|
|
2678
|
+
*/
|
|
2763
2679
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceBioBlocksByBlockData, ThrowOnError>): RequestResult<PutSpacesBySpaceBioBlocksByBlockResponses, PutSpacesBySpaceBioBlocksByBlockErrors, ThrowOnError, "fields">;
|
|
2680
|
+
/**
|
|
2681
|
+
* Reorder a bio block
|
|
2682
|
+
*
|
|
2683
|
+
* Moves the block up or down by swapping with its neighbour.
|
|
2684
|
+
*/
|
|
2764
2685
|
reorder<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioBlocksByBlockReorderData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioBlocksByBlockReorderResponses, PostSpacesBySpaceBioBlocksByBlockReorderErrors, ThrowOnError, "fields">;
|
|
2765
2686
|
}
|
|
2766
2687
|
declare class Bio extends HeyApiClient {
|
|
2688
|
+
/**
|
|
2689
|
+
* Get the bio page
|
|
2690
|
+
*/
|
|
2767
2691
|
get<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceBioData, ThrowOnError>): RequestResult<GetSpacesBySpaceBioResponses, GetSpacesBySpaceBioErrors, ThrowOnError, "fields">;
|
|
2692
|
+
/**
|
|
2693
|
+
* Create the bio page
|
|
2694
|
+
*
|
|
2695
|
+
* Seeds a social icons block from the space's active accounts.
|
|
2696
|
+
*/
|
|
2768
2697
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioResponses, PostSpacesBySpaceBioErrors, ThrowOnError, "fields">;
|
|
2698
|
+
/**
|
|
2699
|
+
* Update the bio page
|
|
2700
|
+
*/
|
|
2769
2701
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceBioData, ThrowOnError>): RequestResult<PutSpacesBySpaceBioResponses, PutSpacesBySpaceBioErrors, ThrowOnError, "fields">;
|
|
2702
|
+
/**
|
|
2703
|
+
* Upload a bio page avatar
|
|
2704
|
+
*/
|
|
2770
2705
|
uploadAvatar<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioAvatarData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioAvatarResponses, PostSpacesBySpaceBioAvatarErrors, ThrowOnError, "fields">;
|
|
2771
2706
|
private _blocks?;
|
|
2772
2707
|
get blocks(): Blocks;
|
|
2773
2708
|
}
|
|
2774
2709
|
declare class Health extends HeyApiClient {
|
|
2710
|
+
/**
|
|
2711
|
+
* Health check
|
|
2712
|
+
*/
|
|
2775
2713
|
check<ThrowOnError extends boolean = false>(options?: Options<GetHealthData, ThrowOnError>): RequestResult<GetHealthResponses, GetHealthErrors, ThrowOnError, "fields">;
|
|
2776
2714
|
}
|
|
2777
2715
|
declare class Media extends HeyApiClient {
|
|
2778
2716
|
/**
|
|
2779
|
-
*
|
|
2780
|
-
*
|
|
2781
|
-
* Accepts images (JPEG, PNG, WebP) and videos (MP4, QuickTime). Images are auto-optimized.
|
|
2782
|
-
*/
|
|
2783
|
-
create<ThrowOnError extends boolean = false>(options: Options<PostMediaData, ThrowOnError>): RequestResult<PostMediaResponses, PostMediaErrors, ThrowOnError, "fields">;
|
|
2784
|
-
/**
|
|
2785
|
-
* Delete a media file
|
|
2717
|
+
* Get an upload URL
|
|
2786
2718
|
*
|
|
2787
|
-
*
|
|
2719
|
+
* PUT the file to the returned `upload_url` with `Content-Type: <mime>`, then send `url` back when creating or updating a post.
|
|
2788
2720
|
*/
|
|
2789
|
-
|
|
2721
|
+
sign<ThrowOnError extends boolean = false>(options: Options<PostMediaSignData, ThrowOnError>): RequestResult<PostMediaSignResponses, PostMediaSignErrors, ThrowOnError, "fields">;
|
|
2790
2722
|
}
|
|
2791
2723
|
declare class Posts extends HeyApiClient {
|
|
2792
2724
|
/**
|
|
2793
2725
|
* List posts
|
|
2794
2726
|
*
|
|
2795
|
-
*
|
|
2727
|
+
* Filterable by status, account, and date range.
|
|
2796
2728
|
*/
|
|
2797
2729
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpacePostsData, ThrowOnError>): RequestResult<GetSpacesBySpacePostsResponses, GetSpacesBySpacePostsErrors, ThrowOnError, "fields">;
|
|
2798
2730
|
/**
|
|
2799
2731
|
* Create posts
|
|
2800
2732
|
*
|
|
2801
|
-
* Creates one or more posts as a cluster. Supports draft, scheduled, or immediate publishing
|
|
2733
|
+
* Creates one or more posts as a cluster. Supports draft, scheduled, or immediate publishing.
|
|
2802
2734
|
*/
|
|
2803
2735
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpacePostsData, ThrowOnError>): RequestResult<PostSpacesBySpacePostsResponses, PostSpacesBySpacePostsErrors, ThrowOnError, "fields">;
|
|
2804
2736
|
/**
|
|
2805
2737
|
* Delete a post
|
|
2806
|
-
*
|
|
2807
|
-
* Permanently deletes the given post.
|
|
2808
2738
|
*/
|
|
2809
2739
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpacePostsByPostData, ThrowOnError>): RequestResult<DeleteSpacesBySpacePostsByPostResponses, DeleteSpacesBySpacePostsByPostErrors, ThrowOnError, "fields">;
|
|
2810
2740
|
/**
|
|
2811
2741
|
* Get a post
|
|
2812
|
-
*
|
|
2813
|
-
* Returns a single post with its account, children, and media.
|
|
2814
2742
|
*/
|
|
2815
2743
|
get<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpacePostsByPostData, ThrowOnError>): RequestResult<GetSpacesBySpacePostsByPostResponses, GetSpacesBySpacePostsByPostErrors, ThrowOnError, "fields">;
|
|
2816
2744
|
/**
|
|
2817
2745
|
* Update a post
|
|
2818
|
-
*
|
|
2819
|
-
* Updates a single post's content, schedule, and media attachments.
|
|
2820
2746
|
*/
|
|
2821
2747
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpacePostsByPostData, ThrowOnError>): RequestResult<PutSpacesBySpacePostsByPostResponses, PutSpacesBySpacePostsByPostErrors, ThrowOnError, "fields">;
|
|
2822
2748
|
}
|
|
2823
2749
|
declare class Clusters extends HeyApiClient {
|
|
2824
2750
|
/**
|
|
2825
|
-
* Update a cluster
|
|
2751
|
+
* Update a cluster
|
|
2826
2752
|
*
|
|
2827
|
-
* Updates all posts
|
|
2753
|
+
* Updates all posts in the cluster, including adding or removing accounts and re-scheduling.
|
|
2828
2754
|
*/
|
|
2829
2755
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceClustersByClusterIdData, ThrowOnError>): RequestResult<PutSpacesBySpaceClustersByClusterIdResponses, PutSpacesBySpaceClustersByClusterIdErrors, ThrowOnError, "fields">;
|
|
2830
2756
|
}
|
|
2831
2757
|
declare class Queue extends HeyApiClient {
|
|
2832
2758
|
/**
|
|
2833
|
-
*
|
|
2759
|
+
* List available queue slots
|
|
2834
2760
|
*
|
|
2835
|
-
* Returns up to 9 upcoming
|
|
2761
|
+
* Returns up to 9 upcoming free slots from the space's schedule.
|
|
2836
2762
|
*/
|
|
2837
2763
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceQueueData, ThrowOnError>): RequestResult<GetSpacesBySpaceQueueResponses, GetSpacesBySpaceQueueErrors, ThrowOnError, "fields">;
|
|
2838
2764
|
}
|
|
2839
2765
|
declare class Slots extends HeyApiClient {
|
|
2840
2766
|
/**
|
|
2841
2767
|
* List slots
|
|
2842
|
-
*
|
|
2843
|
-
* Returns all scheduling slots for the space, ordered by day and time.
|
|
2844
2768
|
*/
|
|
2845
2769
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceSlotsData, ThrowOnError>): RequestResult<GetSpacesBySpaceSlotsResponses, GetSpacesBySpaceSlotsErrors, ThrowOnError, "fields">;
|
|
2846
2770
|
/**
|
|
2847
2771
|
* Create slots
|
|
2848
2772
|
*
|
|
2849
|
-
* Creates
|
|
2773
|
+
* Creates a slot at the given time for each day of the week.
|
|
2850
2774
|
*/
|
|
2851
2775
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceSlotsData, ThrowOnError>): RequestResult<PostSpacesBySpaceSlotsResponses, PostSpacesBySpaceSlotsErrors, ThrowOnError, "fields">;
|
|
2852
2776
|
/**
|
|
2853
2777
|
* Delete a slot
|
|
2854
|
-
*
|
|
2855
|
-
* Removes a scheduling slot from the space.
|
|
2856
2778
|
*/
|
|
2857
2779
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceSlotsBySlotData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceSlotsBySlotResponses, DeleteSpacesBySpaceSlotsBySlotErrors, ThrowOnError, "fields">;
|
|
2858
2780
|
}
|
|
2859
2781
|
declare class Spaces extends HeyApiClient {
|
|
2860
2782
|
/**
|
|
2861
2783
|
* List spaces
|
|
2862
|
-
*
|
|
2863
|
-
* Returns all spaces belonging to the authenticated user, ordered by most recent.
|
|
2864
2784
|
*/
|
|
2865
2785
|
list<ThrowOnError extends boolean = false>(options?: Options<GetSpacesData, ThrowOnError>): RequestResult<GetSpacesResponses, GetSpacesErrors, ThrowOnError, "fields">;
|
|
2866
2786
|
/**
|
|
2867
2787
|
* Create a space
|
|
2868
|
-
*
|
|
2869
|
-
* Creates a new space for the authenticated user.
|
|
2870
2788
|
*/
|
|
2871
2789
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesData, ThrowOnError>): RequestResult<PostSpacesResponses, PostSpacesErrors, ThrowOnError, "fields">;
|
|
2872
2790
|
/**
|
|
2873
2791
|
* Delete a space
|
|
2874
2792
|
*
|
|
2875
|
-
*
|
|
2793
|
+
* Cascades to all accounts, posts, slots, and other associated data.
|
|
2876
2794
|
*/
|
|
2877
2795
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceResponses, DeleteSpacesBySpaceErrors, ThrowOnError, "fields">;
|
|
2878
2796
|
/**
|
|
2879
2797
|
* Get a space
|
|
2880
|
-
*
|
|
2881
|
-
* Returns a single space by ID.
|
|
2882
2798
|
*/
|
|
2883
2799
|
get<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceData, ThrowOnError>): RequestResult<GetSpacesBySpaceResponses, GetSpacesBySpaceErrors, ThrowOnError, "fields">;
|
|
2884
2800
|
/**
|
|
2885
2801
|
* Update a space
|
|
2886
|
-
*
|
|
2887
|
-
* Updates the given space's settings.
|
|
2888
2802
|
*/
|
|
2889
2803
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceData, ThrowOnError>): RequestResult<PutSpacesBySpaceResponses, PutSpacesBySpaceErrors, ThrowOnError, "fields">;
|
|
2890
2804
|
}
|
|
@@ -2892,33 +2806,27 @@ declare class Subscription extends HeyApiClient {
|
|
|
2892
2806
|
/**
|
|
2893
2807
|
* Get subscription details
|
|
2894
2808
|
*
|
|
2895
|
-
*
|
|
2809
|
+
* Includes plan, usage limits, trial state, and cancellation state.
|
|
2896
2810
|
*/
|
|
2897
2811
|
get<ThrowOnError extends boolean = false>(options?: Options<GetSubscriptionData, ThrowOnError>): RequestResult<GetSubscriptionResponses, GetSubscriptionErrors, ThrowOnError, "fields">;
|
|
2898
2812
|
}
|
|
2899
2813
|
declare class Webhooks extends HeyApiClient {
|
|
2900
2814
|
/**
|
|
2901
2815
|
* List webhooks
|
|
2902
|
-
*
|
|
2903
|
-
* Returns all webhooks configured for the given space.
|
|
2904
2816
|
*/
|
|
2905
2817
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceWebhooksData, ThrowOnError>): RequestResult<GetSpacesBySpaceWebhooksResponses, GetSpacesBySpaceWebhooksErrors, ThrowOnError, "fields">;
|
|
2906
2818
|
/**
|
|
2907
2819
|
* Create a webhook
|
|
2908
2820
|
*
|
|
2909
|
-
*
|
|
2821
|
+
* Returns an auto-generated signing secret on the response.
|
|
2910
2822
|
*/
|
|
2911
2823
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceWebhooksData, ThrowOnError>): RequestResult<PostSpacesBySpaceWebhooksResponses, PostSpacesBySpaceWebhooksErrors, ThrowOnError, "fields">;
|
|
2912
2824
|
/**
|
|
2913
2825
|
* Delete a webhook
|
|
2914
|
-
*
|
|
2915
|
-
* Permanently removes the webhook endpoint.
|
|
2916
2826
|
*/
|
|
2917
2827
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceWebhooksByWebhookData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceWebhooksByWebhookResponses, DeleteSpacesBySpaceWebhooksByWebhookErrors, ThrowOnError, "fields">;
|
|
2918
2828
|
/**
|
|
2919
2829
|
* Update a webhook
|
|
2920
|
-
*
|
|
2921
|
-
* Updates the webhook's URL, events, or active status.
|
|
2922
2830
|
*/
|
|
2923
2831
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceWebhooksByWebhookData, ThrowOnError>): RequestResult<PutSpacesBySpaceWebhooksByWebhookResponses, PutSpacesBySpaceWebhooksByWebhookErrors, ThrowOnError, "fields">;
|
|
2924
2832
|
}
|
|
@@ -2984,4 +2892,4 @@ declare class ZilfuApiError extends Error {
|
|
|
2984
2892
|
constructor(init: ZilfuApiErrorInit);
|
|
2985
2893
|
}
|
|
2986
2894
|
|
|
2987
|
-
export { type AccountResource, type BioBlockResource, type BioPageResource, type ClientOptions, type CreateZilfuClientOptions, type DeleteApiTokensByTokenIdData, type DeleteApiTokensByTokenIdError, type DeleteApiTokensByTokenIdErrors, type DeleteApiTokensByTokenIdResponses, type
|
|
2895
|
+
export { type AccountResource, type BioBlockResource, type BioPageResource, type ClientOptions, type CreateZilfuClientOptions, type DeleteApiTokensByTokenIdData, type DeleteApiTokensByTokenIdError, type DeleteApiTokensByTokenIdErrors, type DeleteApiTokensByTokenIdResponses, type DeleteSpacesBySpaceAccountsByAccountData, type DeleteSpacesBySpaceAccountsByAccountError, type DeleteSpacesBySpaceAccountsByAccountErrors, type DeleteSpacesBySpaceAccountsByAccountResponse, type DeleteSpacesBySpaceAccountsByAccountResponses, type DeleteSpacesBySpaceBioBlocksByBlockData, type DeleteSpacesBySpaceBioBlocksByBlockError, type DeleteSpacesBySpaceBioBlocksByBlockErrors, type DeleteSpacesBySpaceBioBlocksByBlockResponse, type DeleteSpacesBySpaceBioBlocksByBlockResponses, type DeleteSpacesBySpaceData, type DeleteSpacesBySpaceError, type DeleteSpacesBySpaceErrors, type DeleteSpacesBySpacePostsByPostData, type DeleteSpacesBySpacePostsByPostError, type DeleteSpacesBySpacePostsByPostErrors, type DeleteSpacesBySpacePostsByPostResponse, type DeleteSpacesBySpacePostsByPostResponses, type DeleteSpacesBySpaceResponse, type DeleteSpacesBySpaceResponses, type DeleteSpacesBySpaceSlotsBySlotData, type DeleteSpacesBySpaceSlotsBySlotError, type DeleteSpacesBySpaceSlotsBySlotErrors, type DeleteSpacesBySpaceSlotsBySlotResponse, type DeleteSpacesBySpaceSlotsBySlotResponses, type DeleteSpacesBySpaceWebhooksByWebhookData, type DeleteSpacesBySpaceWebhooksByWebhookError, type DeleteSpacesBySpaceWebhooksByWebhookErrors, type DeleteSpacesBySpaceWebhooksByWebhookResponse, type DeleteSpacesBySpaceWebhooksByWebhookResponses, type GetHealthData, type GetHealthError, type GetHealthErrors, type GetHealthResponse, type GetHealthResponses, type GetSpacesBySpaceAccountsByAccountBoardsData, type GetSpacesBySpaceAccountsByAccountBoardsError, type GetSpacesBySpaceAccountsByAccountBoardsErrors, type GetSpacesBySpaceAccountsByAccountBoardsResponse, type GetSpacesBySpaceAccountsByAccountBoardsResponses, type GetSpacesBySpaceAccountsData, type GetSpacesBySpaceAccountsError, type GetSpacesBySpaceAccountsErrors, type GetSpacesBySpaceAccountsResponse, type GetSpacesBySpaceAccountsResponses, type GetSpacesBySpaceBioBlocksData, type GetSpacesBySpaceBioBlocksError, type GetSpacesBySpaceBioBlocksErrors, type GetSpacesBySpaceBioBlocksResponse, type GetSpacesBySpaceBioBlocksResponses, type GetSpacesBySpaceBioData, type GetSpacesBySpaceBioError, type GetSpacesBySpaceBioErrors, type GetSpacesBySpaceBioResponse, type GetSpacesBySpaceBioResponses, type GetSpacesBySpaceData, type GetSpacesBySpaceError, type GetSpacesBySpaceErrors, type GetSpacesBySpacePostsByPostData, type GetSpacesBySpacePostsByPostError, type GetSpacesBySpacePostsByPostErrors, type GetSpacesBySpacePostsByPostResponse, type GetSpacesBySpacePostsByPostResponses, type GetSpacesBySpacePostsData, type GetSpacesBySpacePostsError, type GetSpacesBySpacePostsErrors, type GetSpacesBySpacePostsResponse, type GetSpacesBySpacePostsResponses, type GetSpacesBySpaceQueueData, type GetSpacesBySpaceQueueError, type GetSpacesBySpaceQueueErrors, type GetSpacesBySpaceQueueResponse, type GetSpacesBySpaceQueueResponses, type GetSpacesBySpaceResponse, type GetSpacesBySpaceResponses, type GetSpacesBySpaceSlotsData, type GetSpacesBySpaceSlotsError, type GetSpacesBySpaceSlotsErrors, type GetSpacesBySpaceSlotsResponse, type GetSpacesBySpaceSlotsResponses, type GetSpacesBySpaceWebhooksData, type GetSpacesBySpaceWebhooksError, type GetSpacesBySpaceWebhooksErrors, type GetSpacesBySpaceWebhooksResponse, type GetSpacesBySpaceWebhooksResponses, type GetSpacesData, type GetSpacesError, type GetSpacesErrors, type GetSpacesResponse, type GetSpacesResponses, type GetSubscriptionData, type GetSubscriptionError, type GetSubscriptionErrors, type GetSubscriptionResponse, type GetSubscriptionResponses, type MediaResource, type PatchSpacesBySpaceAccountsByAccountActivateData, type PatchSpacesBySpaceAccountsByAccountActivateError, type PatchSpacesBySpaceAccountsByAccountActivateErrors, type PatchSpacesBySpaceAccountsByAccountActivateResponse, type PatchSpacesBySpaceAccountsByAccountActivateResponses, type PostApiTokensData, type PostApiTokensError, type PostApiTokensErrors, type PostApiTokensResponses, type PostMediaSignData, type PostMediaSignError, type PostMediaSignErrors, type PostMediaSignResponse, type PostMediaSignResponses, type PostResource, type PostSpacesBySpaceBioAvatarData, type PostSpacesBySpaceBioAvatarError, type PostSpacesBySpaceBioAvatarErrors, type PostSpacesBySpaceBioAvatarResponse, type PostSpacesBySpaceBioAvatarResponses, type PostSpacesBySpaceBioBlocksByBlockReorderData, type PostSpacesBySpaceBioBlocksByBlockReorderError, type PostSpacesBySpaceBioBlocksByBlockReorderErrors, type PostSpacesBySpaceBioBlocksByBlockReorderResponse, type PostSpacesBySpaceBioBlocksByBlockReorderResponses, type PostSpacesBySpaceBioBlocksData, type PostSpacesBySpaceBioBlocksError, type PostSpacesBySpaceBioBlocksErrors, type PostSpacesBySpaceBioBlocksResponse, type PostSpacesBySpaceBioBlocksResponses, type PostSpacesBySpaceBioData, type PostSpacesBySpaceBioError, type PostSpacesBySpaceBioErrors, type PostSpacesBySpaceBioResponse, type PostSpacesBySpaceBioResponses, type PostSpacesBySpacePostsData, type PostSpacesBySpacePostsError, type PostSpacesBySpacePostsErrors, type PostSpacesBySpacePostsResponse, type PostSpacesBySpacePostsResponses, type PostSpacesBySpaceSlotsData, type PostSpacesBySpaceSlotsError, type PostSpacesBySpaceSlotsErrors, type PostSpacesBySpaceSlotsResponse, type PostSpacesBySpaceSlotsResponses, type PostSpacesBySpaceWebhooksData, type PostSpacesBySpaceWebhooksError, type PostSpacesBySpaceWebhooksErrors, type PostSpacesBySpaceWebhooksResponse, type PostSpacesBySpaceWebhooksResponses, type PostSpacesData, type PostSpacesError, type PostSpacesErrors, type PostSpacesResponse, type PostSpacesResponses, type PostStatus, type PutSpacesBySpaceBioBlocksByBlockData, type PutSpacesBySpaceBioBlocksByBlockError, type PutSpacesBySpaceBioBlocksByBlockErrors, type PutSpacesBySpaceBioBlocksByBlockResponse, type PutSpacesBySpaceBioBlocksByBlockResponses, type PutSpacesBySpaceBioData, type PutSpacesBySpaceBioError, type PutSpacesBySpaceBioErrors, type PutSpacesBySpaceBioResponse, type PutSpacesBySpaceBioResponses, type PutSpacesBySpaceClustersByClusterIdData, type PutSpacesBySpaceClustersByClusterIdError, type PutSpacesBySpaceClustersByClusterIdErrors, type PutSpacesBySpaceClustersByClusterIdResponse, type PutSpacesBySpaceClustersByClusterIdResponses, type PutSpacesBySpaceData, type PutSpacesBySpaceError, type PutSpacesBySpaceErrors, type PutSpacesBySpacePostsByPostData, type PutSpacesBySpacePostsByPostError, type PutSpacesBySpacePostsByPostErrors, type PutSpacesBySpacePostsByPostResponse, type PutSpacesBySpacePostsByPostResponses, type PutSpacesBySpaceResponse, type PutSpacesBySpaceResponses, type PutSpacesBySpaceWebhooksByWebhookData, type PutSpacesBySpaceWebhooksByWebhookError, type PutSpacesBySpaceWebhooksByWebhookErrors, type PutSpacesBySpaceWebhooksByWebhookResponse, type PutSpacesBySpaceWebhooksByWebhookResponses, type SignMediaRequest, type SlotResource, type SpaceResource, type StoreBioBlockRequest, type StoreBioPageRequest, type StorePostRequest, type StoreSlotRequest, type StoreSpaceRequest, type StoreWebhookRequest, type UpdateBioBlockRequest, type UpdateBioPageRequest, type UpdateClusterRequest, type UpdatePostRequest, type UpdateSpaceRequest, type UpdateWebhookRequest, type WebhookResource, ZilfuApiError, type ZilfuApiErrorInit, type ZilfuClient, type ZilfuFetch, type ZilfuToken, createZilfuClient };
|