@zilfu/sdk 0.1.2 → 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 -62
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +98 -120
- package/dist/index.d.ts +98 -120
- package/dist/index.js +51 -62
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
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
|
|
@@ -1417,62 +1439,13 @@ type GetHealthResponses = {
|
|
|
1417
1439
|
};
|
|
1418
1440
|
};
|
|
1419
1441
|
type GetHealthResponse = GetHealthResponses[keyof GetHealthResponses];
|
|
1420
|
-
type
|
|
1421
|
-
body:
|
|
1422
|
-
file: Blob | File;
|
|
1423
|
-
};
|
|
1442
|
+
type PostMediaSignData = {
|
|
1443
|
+
body: SignMediaRequest;
|
|
1424
1444
|
path?: never;
|
|
1425
1445
|
query?: never;
|
|
1426
|
-
url: '/media';
|
|
1427
|
-
};
|
|
1428
|
-
type PostMediaErrors = {
|
|
1429
|
-
/**
|
|
1430
|
-
* Unauthenticated
|
|
1431
|
-
*/
|
|
1432
|
-
401: {
|
|
1433
|
-
/**
|
|
1434
|
-
* Error overview.
|
|
1435
|
-
*/
|
|
1436
|
-
message: string;
|
|
1437
|
-
};
|
|
1438
|
-
/**
|
|
1439
|
-
* Validation error
|
|
1440
|
-
*/
|
|
1441
|
-
422: {
|
|
1442
|
-
/**
|
|
1443
|
-
* Errors overview.
|
|
1444
|
-
*/
|
|
1445
|
-
message: string;
|
|
1446
|
-
/**
|
|
1447
|
-
* A detailed description of each field that failed validation.
|
|
1448
|
-
*/
|
|
1449
|
-
errors: {
|
|
1450
|
-
[key: string]: Array<string>;
|
|
1451
|
-
};
|
|
1452
|
-
};
|
|
1453
|
-
};
|
|
1454
|
-
type PostMediaError = PostMediaErrors[keyof PostMediaErrors];
|
|
1455
|
-
type PostMediaResponses = {
|
|
1456
|
-
/**
|
|
1457
|
-
* `MediaResource`
|
|
1458
|
-
*/
|
|
1459
|
-
201: {
|
|
1460
|
-
data: MediaResource;
|
|
1461
|
-
};
|
|
1462
|
-
};
|
|
1463
|
-
type PostMediaResponse = PostMediaResponses[keyof PostMediaResponses];
|
|
1464
|
-
type DeleteMediaByMediaData = {
|
|
1465
|
-
body?: never;
|
|
1466
|
-
path: {
|
|
1467
|
-
/**
|
|
1468
|
-
* The media ID
|
|
1469
|
-
*/
|
|
1470
|
-
media: number;
|
|
1471
|
-
};
|
|
1472
|
-
query?: never;
|
|
1473
|
-
url: '/media/{media}';
|
|
1446
|
+
url: '/media/sign';
|
|
1474
1447
|
};
|
|
1475
|
-
type
|
|
1448
|
+
type PostMediaSignErrors = {
|
|
1476
1449
|
/**
|
|
1477
1450
|
* Unauthenticated
|
|
1478
1451
|
*/
|
|
@@ -1492,22 +1465,31 @@ type DeleteMediaByMediaErrors = {
|
|
|
1492
1465
|
message: string;
|
|
1493
1466
|
};
|
|
1494
1467
|
/**
|
|
1495
|
-
*
|
|
1468
|
+
* Validation error
|
|
1496
1469
|
*/
|
|
1497
|
-
|
|
1470
|
+
422: {
|
|
1498
1471
|
/**
|
|
1499
|
-
*
|
|
1472
|
+
* Errors overview.
|
|
1500
1473
|
*/
|
|
1501
1474
|
message: string;
|
|
1475
|
+
/**
|
|
1476
|
+
* A detailed description of each field that failed validation.
|
|
1477
|
+
*/
|
|
1478
|
+
errors: {
|
|
1479
|
+
[key: string]: Array<string>;
|
|
1480
|
+
};
|
|
1502
1481
|
};
|
|
1503
1482
|
};
|
|
1504
|
-
type
|
|
1505
|
-
type
|
|
1483
|
+
type PostMediaSignError = PostMediaSignErrors[keyof PostMediaSignErrors];
|
|
1484
|
+
type PostMediaSignResponses = {
|
|
1506
1485
|
200: {
|
|
1507
|
-
|
|
1486
|
+
upload_url: string;
|
|
1487
|
+
url: string;
|
|
1488
|
+
path: string;
|
|
1489
|
+
expires_at: string;
|
|
1508
1490
|
};
|
|
1509
1491
|
};
|
|
1510
|
-
type
|
|
1492
|
+
type PostMediaSignResponse = PostMediaSignResponses[keyof PostMediaSignResponses];
|
|
1511
1493
|
type GetSpacesBySpacePostsData = {
|
|
1512
1494
|
body?: never;
|
|
1513
1495
|
path: {
|
|
@@ -2649,172 +2631,174 @@ declare class HeyApiRegistry<T> {
|
|
|
2649
2631
|
declare class Accounts extends HeyApiClient {
|
|
2650
2632
|
/**
|
|
2651
2633
|
* List accounts
|
|
2652
|
-
*
|
|
2653
|
-
* Returns all connected social accounts for the given space.
|
|
2654
2634
|
*/
|
|
2655
2635
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceAccountsData, ThrowOnError>): RequestResult<GetSpacesBySpaceAccountsResponses, GetSpacesBySpaceAccountsErrors, ThrowOnError, "fields">;
|
|
2656
2636
|
/**
|
|
2657
2637
|
* Activate an account
|
|
2658
2638
|
*
|
|
2659
|
-
*
|
|
2639
|
+
* Deactivates other accounts on the same platform within the space.
|
|
2660
2640
|
*/
|
|
2661
2641
|
activate<ThrowOnError extends boolean = false>(options: Options<PatchSpacesBySpaceAccountsByAccountActivateData, ThrowOnError>): RequestResult<PatchSpacesBySpaceAccountsByAccountActivateResponses, PatchSpacesBySpaceAccountsByAccountActivateErrors, ThrowOnError, "fields">;
|
|
2662
2642
|
/**
|
|
2663
2643
|
* List Pinterest boards
|
|
2664
|
-
*
|
|
2665
|
-
* Returns the Pinterest boards available for the given account.
|
|
2666
2644
|
*/
|
|
2667
2645
|
boards<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceAccountsByAccountBoardsData, ThrowOnError>): RequestResult<GetSpacesBySpaceAccountsByAccountBoardsResponses, GetSpacesBySpaceAccountsByAccountBoardsErrors, ThrowOnError, "fields">;
|
|
2668
2646
|
/**
|
|
2669
2647
|
* Disconnect an account
|
|
2670
2648
|
*
|
|
2671
|
-
* Removes
|
|
2649
|
+
* Removes every account on the same platform within the space and fires an AccountDisconnected webhook for each.
|
|
2672
2650
|
*/
|
|
2673
2651
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceAccountsByAccountData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceAccountsByAccountResponses, DeleteSpacesBySpaceAccountsByAccountErrors, ThrowOnError, "fields">;
|
|
2674
2652
|
}
|
|
2675
2653
|
declare class ApiTokens extends HeyApiClient {
|
|
2676
2654
|
/**
|
|
2677
2655
|
* Create an API token
|
|
2678
|
-
*
|
|
2679
|
-
* Generates a new personal access token for the authenticated user.
|
|
2680
2656
|
*/
|
|
2681
2657
|
create<ThrowOnError extends boolean = false>(options: Options<PostApiTokensData, ThrowOnError>): RequestResult<PostApiTokensResponses, PostApiTokensErrors, ThrowOnError, "fields">;
|
|
2682
2658
|
/**
|
|
2683
2659
|
* Revoke an API token
|
|
2684
|
-
*
|
|
2685
|
-
* Deletes the specified personal access token.
|
|
2686
2660
|
*/
|
|
2687
2661
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiTokensByTokenIdData, ThrowOnError>): RequestResult<DeleteApiTokensByTokenIdResponses, DeleteApiTokensByTokenIdErrors, ThrowOnError, "fields">;
|
|
2688
2662
|
}
|
|
2689
2663
|
declare class Blocks extends HeyApiClient {
|
|
2664
|
+
/**
|
|
2665
|
+
* List bio blocks
|
|
2666
|
+
*/
|
|
2690
2667
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceBioBlocksData, ThrowOnError>): RequestResult<GetSpacesBySpaceBioBlocksResponses, GetSpacesBySpaceBioBlocksErrors, ThrowOnError, "fields">;
|
|
2668
|
+
/**
|
|
2669
|
+
* Create a bio block
|
|
2670
|
+
*/
|
|
2691
2671
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioBlocksData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioBlocksResponses, PostSpacesBySpaceBioBlocksErrors, ThrowOnError, "fields">;
|
|
2672
|
+
/**
|
|
2673
|
+
* Delete a bio block
|
|
2674
|
+
*/
|
|
2692
2675
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceBioBlocksByBlockData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceBioBlocksByBlockResponses, DeleteSpacesBySpaceBioBlocksByBlockErrors, ThrowOnError, "fields">;
|
|
2676
|
+
/**
|
|
2677
|
+
* Update a bio block
|
|
2678
|
+
*/
|
|
2693
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
|
+
*/
|
|
2694
2685
|
reorder<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioBlocksByBlockReorderData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioBlocksByBlockReorderResponses, PostSpacesBySpaceBioBlocksByBlockReorderErrors, ThrowOnError, "fields">;
|
|
2695
2686
|
}
|
|
2696
2687
|
declare class Bio extends HeyApiClient {
|
|
2688
|
+
/**
|
|
2689
|
+
* Get the bio page
|
|
2690
|
+
*/
|
|
2697
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
|
+
*/
|
|
2698
2697
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioResponses, PostSpacesBySpaceBioErrors, ThrowOnError, "fields">;
|
|
2698
|
+
/**
|
|
2699
|
+
* Update the bio page
|
|
2700
|
+
*/
|
|
2699
2701
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceBioData, ThrowOnError>): RequestResult<PutSpacesBySpaceBioResponses, PutSpacesBySpaceBioErrors, ThrowOnError, "fields">;
|
|
2702
|
+
/**
|
|
2703
|
+
* Upload a bio page avatar
|
|
2704
|
+
*/
|
|
2700
2705
|
uploadAvatar<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioAvatarData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioAvatarResponses, PostSpacesBySpaceBioAvatarErrors, ThrowOnError, "fields">;
|
|
2701
2706
|
private _blocks?;
|
|
2702
2707
|
get blocks(): Blocks;
|
|
2703
2708
|
}
|
|
2704
2709
|
declare class Health extends HeyApiClient {
|
|
2710
|
+
/**
|
|
2711
|
+
* Health check
|
|
2712
|
+
*/
|
|
2705
2713
|
check<ThrowOnError extends boolean = false>(options?: Options<GetHealthData, ThrowOnError>): RequestResult<GetHealthResponses, GetHealthErrors, ThrowOnError, "fields">;
|
|
2706
2714
|
}
|
|
2707
2715
|
declare class Media extends HeyApiClient {
|
|
2708
2716
|
/**
|
|
2709
|
-
*
|
|
2710
|
-
*
|
|
2711
|
-
* Accepts images (JPEG, PNG, WebP) and videos (MP4, QuickTime). Images are auto-optimized.
|
|
2712
|
-
*/
|
|
2713
|
-
create<ThrowOnError extends boolean = false>(options: Options<PostMediaData, ThrowOnError>): RequestResult<PostMediaResponses, PostMediaErrors, ThrowOnError, "fields">;
|
|
2714
|
-
/**
|
|
2715
|
-
* Delete a media file
|
|
2717
|
+
* Get an upload URL
|
|
2716
2718
|
*
|
|
2717
|
-
*
|
|
2719
|
+
* PUT the file to the returned `upload_url` with `Content-Type: <mime>`, then send `url` back when creating or updating a post.
|
|
2718
2720
|
*/
|
|
2719
|
-
|
|
2721
|
+
sign<ThrowOnError extends boolean = false>(options: Options<PostMediaSignData, ThrowOnError>): RequestResult<PostMediaSignResponses, PostMediaSignErrors, ThrowOnError, "fields">;
|
|
2720
2722
|
}
|
|
2721
2723
|
declare class Posts extends HeyApiClient {
|
|
2722
2724
|
/**
|
|
2723
2725
|
* List posts
|
|
2724
2726
|
*
|
|
2725
|
-
*
|
|
2727
|
+
* Filterable by status, account, and date range.
|
|
2726
2728
|
*/
|
|
2727
2729
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpacePostsData, ThrowOnError>): RequestResult<GetSpacesBySpacePostsResponses, GetSpacesBySpacePostsErrors, ThrowOnError, "fields">;
|
|
2728
2730
|
/**
|
|
2729
2731
|
* Create posts
|
|
2730
2732
|
*
|
|
2731
|
-
* 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.
|
|
2732
2734
|
*/
|
|
2733
2735
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpacePostsData, ThrowOnError>): RequestResult<PostSpacesBySpacePostsResponses, PostSpacesBySpacePostsErrors, ThrowOnError, "fields">;
|
|
2734
2736
|
/**
|
|
2735
2737
|
* Delete a post
|
|
2736
|
-
*
|
|
2737
|
-
* Permanently deletes the given post.
|
|
2738
2738
|
*/
|
|
2739
2739
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpacePostsByPostData, ThrowOnError>): RequestResult<DeleteSpacesBySpacePostsByPostResponses, DeleteSpacesBySpacePostsByPostErrors, ThrowOnError, "fields">;
|
|
2740
2740
|
/**
|
|
2741
2741
|
* Get a post
|
|
2742
|
-
*
|
|
2743
|
-
* Returns a single post with its account, children, and media.
|
|
2744
2742
|
*/
|
|
2745
2743
|
get<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpacePostsByPostData, ThrowOnError>): RequestResult<GetSpacesBySpacePostsByPostResponses, GetSpacesBySpacePostsByPostErrors, ThrowOnError, "fields">;
|
|
2746
2744
|
/**
|
|
2747
2745
|
* Update a post
|
|
2748
|
-
*
|
|
2749
|
-
* Updates a single post's content, schedule, and media attachments.
|
|
2750
2746
|
*/
|
|
2751
2747
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpacePostsByPostData, ThrowOnError>): RequestResult<PutSpacesBySpacePostsByPostResponses, PutSpacesBySpacePostsByPostErrors, ThrowOnError, "fields">;
|
|
2752
2748
|
}
|
|
2753
2749
|
declare class Clusters extends HeyApiClient {
|
|
2754
2750
|
/**
|
|
2755
|
-
* Update a cluster
|
|
2751
|
+
* Update a cluster
|
|
2756
2752
|
*
|
|
2757
|
-
* Updates all posts
|
|
2753
|
+
* Updates all posts in the cluster, including adding or removing accounts and re-scheduling.
|
|
2758
2754
|
*/
|
|
2759
2755
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceClustersByClusterIdData, ThrowOnError>): RequestResult<PutSpacesBySpaceClustersByClusterIdResponses, PutSpacesBySpaceClustersByClusterIdErrors, ThrowOnError, "fields">;
|
|
2760
2756
|
}
|
|
2761
2757
|
declare class Queue extends HeyApiClient {
|
|
2762
2758
|
/**
|
|
2763
|
-
*
|
|
2759
|
+
* List available queue slots
|
|
2764
2760
|
*
|
|
2765
|
-
* Returns up to 9 upcoming
|
|
2761
|
+
* Returns up to 9 upcoming free slots from the space's schedule.
|
|
2766
2762
|
*/
|
|
2767
2763
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceQueueData, ThrowOnError>): RequestResult<GetSpacesBySpaceQueueResponses, GetSpacesBySpaceQueueErrors, ThrowOnError, "fields">;
|
|
2768
2764
|
}
|
|
2769
2765
|
declare class Slots extends HeyApiClient {
|
|
2770
2766
|
/**
|
|
2771
2767
|
* List slots
|
|
2772
|
-
*
|
|
2773
|
-
* Returns all scheduling slots for the space, ordered by day and time.
|
|
2774
2768
|
*/
|
|
2775
2769
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceSlotsData, ThrowOnError>): RequestResult<GetSpacesBySpaceSlotsResponses, GetSpacesBySpaceSlotsErrors, ThrowOnError, "fields">;
|
|
2776
2770
|
/**
|
|
2777
2771
|
* Create slots
|
|
2778
2772
|
*
|
|
2779
|
-
* Creates
|
|
2773
|
+
* Creates a slot at the given time for each day of the week.
|
|
2780
2774
|
*/
|
|
2781
2775
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceSlotsData, ThrowOnError>): RequestResult<PostSpacesBySpaceSlotsResponses, PostSpacesBySpaceSlotsErrors, ThrowOnError, "fields">;
|
|
2782
2776
|
/**
|
|
2783
2777
|
* Delete a slot
|
|
2784
|
-
*
|
|
2785
|
-
* Removes a scheduling slot from the space.
|
|
2786
2778
|
*/
|
|
2787
2779
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceSlotsBySlotData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceSlotsBySlotResponses, DeleteSpacesBySpaceSlotsBySlotErrors, ThrowOnError, "fields">;
|
|
2788
2780
|
}
|
|
2789
2781
|
declare class Spaces extends HeyApiClient {
|
|
2790
2782
|
/**
|
|
2791
2783
|
* List spaces
|
|
2792
|
-
*
|
|
2793
|
-
* Returns all spaces belonging to the authenticated user, ordered by most recent.
|
|
2794
2784
|
*/
|
|
2795
2785
|
list<ThrowOnError extends boolean = false>(options?: Options<GetSpacesData, ThrowOnError>): RequestResult<GetSpacesResponses, GetSpacesErrors, ThrowOnError, "fields">;
|
|
2796
2786
|
/**
|
|
2797
2787
|
* Create a space
|
|
2798
|
-
*
|
|
2799
|
-
* Creates a new space for the authenticated user.
|
|
2800
2788
|
*/
|
|
2801
2789
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesData, ThrowOnError>): RequestResult<PostSpacesResponses, PostSpacesErrors, ThrowOnError, "fields">;
|
|
2802
2790
|
/**
|
|
2803
2791
|
* Delete a space
|
|
2804
2792
|
*
|
|
2805
|
-
*
|
|
2793
|
+
* Cascades to all accounts, posts, slots, and other associated data.
|
|
2806
2794
|
*/
|
|
2807
2795
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceResponses, DeleteSpacesBySpaceErrors, ThrowOnError, "fields">;
|
|
2808
2796
|
/**
|
|
2809
2797
|
* Get a space
|
|
2810
|
-
*
|
|
2811
|
-
* Returns a single space by ID.
|
|
2812
2798
|
*/
|
|
2813
2799
|
get<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceData, ThrowOnError>): RequestResult<GetSpacesBySpaceResponses, GetSpacesBySpaceErrors, ThrowOnError, "fields">;
|
|
2814
2800
|
/**
|
|
2815
2801
|
* Update a space
|
|
2816
|
-
*
|
|
2817
|
-
* Updates the given space's settings.
|
|
2818
2802
|
*/
|
|
2819
2803
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceData, ThrowOnError>): RequestResult<PutSpacesBySpaceResponses, PutSpacesBySpaceErrors, ThrowOnError, "fields">;
|
|
2820
2804
|
}
|
|
@@ -2822,33 +2806,27 @@ declare class Subscription extends HeyApiClient {
|
|
|
2822
2806
|
/**
|
|
2823
2807
|
* Get subscription details
|
|
2824
2808
|
*
|
|
2825
|
-
*
|
|
2809
|
+
* Includes plan, usage limits, trial state, and cancellation state.
|
|
2826
2810
|
*/
|
|
2827
2811
|
get<ThrowOnError extends boolean = false>(options?: Options<GetSubscriptionData, ThrowOnError>): RequestResult<GetSubscriptionResponses, GetSubscriptionErrors, ThrowOnError, "fields">;
|
|
2828
2812
|
}
|
|
2829
2813
|
declare class Webhooks extends HeyApiClient {
|
|
2830
2814
|
/**
|
|
2831
2815
|
* List webhooks
|
|
2832
|
-
*
|
|
2833
|
-
* Returns all webhooks configured for the given space.
|
|
2834
2816
|
*/
|
|
2835
2817
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceWebhooksData, ThrowOnError>): RequestResult<GetSpacesBySpaceWebhooksResponses, GetSpacesBySpaceWebhooksErrors, ThrowOnError, "fields">;
|
|
2836
2818
|
/**
|
|
2837
2819
|
* Create a webhook
|
|
2838
2820
|
*
|
|
2839
|
-
*
|
|
2821
|
+
* Returns an auto-generated signing secret on the response.
|
|
2840
2822
|
*/
|
|
2841
2823
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceWebhooksData, ThrowOnError>): RequestResult<PostSpacesBySpaceWebhooksResponses, PostSpacesBySpaceWebhooksErrors, ThrowOnError, "fields">;
|
|
2842
2824
|
/**
|
|
2843
2825
|
* Delete a webhook
|
|
2844
|
-
*
|
|
2845
|
-
* Permanently removes the webhook endpoint.
|
|
2846
2826
|
*/
|
|
2847
2827
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceWebhooksByWebhookData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceWebhooksByWebhookResponses, DeleteSpacesBySpaceWebhooksByWebhookErrors, ThrowOnError, "fields">;
|
|
2848
2828
|
/**
|
|
2849
2829
|
* Update a webhook
|
|
2850
|
-
*
|
|
2851
|
-
* Updates the webhook's URL, events, or active status.
|
|
2852
2830
|
*/
|
|
2853
2831
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceWebhooksByWebhookData, ThrowOnError>): RequestResult<PutSpacesBySpaceWebhooksByWebhookResponses, PutSpacesBySpaceWebhooksByWebhookErrors, ThrowOnError, "fields">;
|
|
2854
2832
|
}
|
|
@@ -2914,4 +2892,4 @@ declare class ZilfuApiError extends Error {
|
|
|
2914
2892
|
constructor(init: ZilfuApiErrorInit);
|
|
2915
2893
|
}
|
|
2916
2894
|
|
|
2917
|
-
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 };
|