@zilfu/sdk 0.1.2 → 0.1.4
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 +50 -81
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +104 -235
- package/dist/index.d.ts +104 -235
- package/dist/index.js +50 -81
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
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
|
};
|
|
@@ -503,55 +509,38 @@ type UpdateBioPageRequest = {
|
|
|
503
509
|
theme?: 'minimal' | 'bold' | 'neon' | 'soft' | 'classic';
|
|
504
510
|
is_enabled?: boolean;
|
|
505
511
|
};
|
|
506
|
-
/**
|
|
507
|
-
* UpdateClusterRequest
|
|
508
|
-
*/
|
|
509
|
-
type UpdateClusterRequest = {
|
|
510
|
-
at?: number | null;
|
|
511
|
-
is_draft?: boolean;
|
|
512
|
-
space_id: number;
|
|
513
|
-
items: Array<{
|
|
514
|
-
account_id: number;
|
|
515
|
-
social: string;
|
|
516
|
-
children?: Array<{
|
|
517
|
-
content: string;
|
|
518
|
-
media?: Array<{
|
|
519
|
-
id: number;
|
|
520
|
-
type: 'image' | 'video';
|
|
521
|
-
}> | null;
|
|
522
|
-
}> | null;
|
|
523
|
-
metadata?: {
|
|
524
|
-
topic_tag?: string | null;
|
|
525
|
-
post_type?: string | null;
|
|
526
|
-
link?: string | null;
|
|
527
|
-
privacy_level?: string | null;
|
|
528
|
-
allow_comments?: boolean | null;
|
|
529
|
-
allow_duet?: boolean | null;
|
|
530
|
-
allow_stitch?: boolean | null;
|
|
531
|
-
branded_content?: boolean | null;
|
|
532
|
-
brand_organic?: boolean | null;
|
|
533
|
-
board_id?: string | null;
|
|
534
|
-
title?: string | null;
|
|
535
|
-
cover_image_url?: string | null;
|
|
536
|
-
} | null;
|
|
537
|
-
main?: {
|
|
538
|
-
content: string;
|
|
539
|
-
media?: Array<{
|
|
540
|
-
id: number;
|
|
541
|
-
type: 'image' | 'video';
|
|
542
|
-
}> | null;
|
|
543
|
-
};
|
|
544
|
-
}>;
|
|
545
|
-
};
|
|
546
512
|
/**
|
|
547
513
|
* UpdatePostRequest
|
|
548
514
|
*/
|
|
549
515
|
type UpdatePostRequest = {
|
|
516
|
+
at?: number | null;
|
|
517
|
+
is_draft?: boolean;
|
|
550
518
|
content?: string;
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
519
|
+
metadata?: {
|
|
520
|
+
topic_tag?: string | null;
|
|
521
|
+
post_type?: string | null;
|
|
522
|
+
link?: string | null;
|
|
523
|
+
privacy_level?: string | null;
|
|
524
|
+
allow_comments?: boolean | null;
|
|
525
|
+
allow_duet?: boolean | null;
|
|
526
|
+
allow_stitch?: boolean | null;
|
|
527
|
+
branded_content?: boolean | null;
|
|
528
|
+
brand_organic?: boolean | null;
|
|
529
|
+
board_id?: string | null;
|
|
530
|
+
title?: string | null;
|
|
531
|
+
cover_image_url?: string | null;
|
|
532
|
+
};
|
|
533
|
+
media?: Array<{
|
|
534
|
+
url: string;
|
|
535
|
+
type: 'image' | 'video';
|
|
536
|
+
}> | null;
|
|
537
|
+
children?: Array<{
|
|
538
|
+
content: string;
|
|
539
|
+
media?: Array<{
|
|
540
|
+
url: string;
|
|
541
|
+
type: 'image' | 'video';
|
|
542
|
+
}> | null;
|
|
543
|
+
}> | null;
|
|
555
544
|
};
|
|
556
545
|
/**
|
|
557
546
|
* UpdateSpaceRequest
|
|
@@ -1417,62 +1406,13 @@ type GetHealthResponses = {
|
|
|
1417
1406
|
};
|
|
1418
1407
|
};
|
|
1419
1408
|
type GetHealthResponse = GetHealthResponses[keyof GetHealthResponses];
|
|
1420
|
-
type
|
|
1421
|
-
body:
|
|
1422
|
-
file: Blob | File;
|
|
1423
|
-
};
|
|
1409
|
+
type PostMediaSignData = {
|
|
1410
|
+
body: SignMediaRequest;
|
|
1424
1411
|
path?: never;
|
|
1425
1412
|
query?: never;
|
|
1426
|
-
url: '/media';
|
|
1413
|
+
url: '/media/sign';
|
|
1427
1414
|
};
|
|
1428
|
-
type
|
|
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}';
|
|
1474
|
-
};
|
|
1475
|
-
type DeleteMediaByMediaErrors = {
|
|
1415
|
+
type PostMediaSignErrors = {
|
|
1476
1416
|
/**
|
|
1477
1417
|
* Unauthenticated
|
|
1478
1418
|
*/
|
|
@@ -1492,22 +1432,31 @@ type DeleteMediaByMediaErrors = {
|
|
|
1492
1432
|
message: string;
|
|
1493
1433
|
};
|
|
1494
1434
|
/**
|
|
1495
|
-
*
|
|
1435
|
+
* Validation error
|
|
1496
1436
|
*/
|
|
1497
|
-
|
|
1437
|
+
422: {
|
|
1498
1438
|
/**
|
|
1499
|
-
*
|
|
1439
|
+
* Errors overview.
|
|
1500
1440
|
*/
|
|
1501
1441
|
message: string;
|
|
1442
|
+
/**
|
|
1443
|
+
* A detailed description of each field that failed validation.
|
|
1444
|
+
*/
|
|
1445
|
+
errors: {
|
|
1446
|
+
[key: string]: Array<string>;
|
|
1447
|
+
};
|
|
1502
1448
|
};
|
|
1503
1449
|
};
|
|
1504
|
-
type
|
|
1505
|
-
type
|
|
1450
|
+
type PostMediaSignError = PostMediaSignErrors[keyof PostMediaSignErrors];
|
|
1451
|
+
type PostMediaSignResponses = {
|
|
1506
1452
|
200: {
|
|
1507
|
-
|
|
1453
|
+
upload_url: string;
|
|
1454
|
+
url: string;
|
|
1455
|
+
path: string;
|
|
1456
|
+
expires_at: string;
|
|
1508
1457
|
};
|
|
1509
1458
|
};
|
|
1510
|
-
type
|
|
1459
|
+
type PostMediaSignResponse = PostMediaSignResponses[keyof PostMediaSignResponses];
|
|
1511
1460
|
type GetSpacesBySpacePostsData = {
|
|
1512
1461
|
body?: never;
|
|
1513
1462
|
path: {
|
|
@@ -1824,74 +1773,6 @@ type PutSpacesBySpacePostsByPostResponses = {
|
|
|
1824
1773
|
};
|
|
1825
1774
|
};
|
|
1826
1775
|
type PutSpacesBySpacePostsByPostResponse = PutSpacesBySpacePostsByPostResponses[keyof PutSpacesBySpacePostsByPostResponses];
|
|
1827
|
-
type PutSpacesBySpaceClustersByClusterIdData = {
|
|
1828
|
-
body: UpdateClusterRequest;
|
|
1829
|
-
path: {
|
|
1830
|
-
/**
|
|
1831
|
-
* The space ID
|
|
1832
|
-
*/
|
|
1833
|
-
space: number;
|
|
1834
|
-
cluster_id: string;
|
|
1835
|
-
};
|
|
1836
|
-
query?: never;
|
|
1837
|
-
url: '/spaces/{space}/clusters/{cluster_id}';
|
|
1838
|
-
};
|
|
1839
|
-
type PutSpacesBySpaceClustersByClusterIdErrors = {
|
|
1840
|
-
/**
|
|
1841
|
-
* Unauthenticated
|
|
1842
|
-
*/
|
|
1843
|
-
401: {
|
|
1844
|
-
/**
|
|
1845
|
-
* Error overview.
|
|
1846
|
-
*/
|
|
1847
|
-
message: string;
|
|
1848
|
-
};
|
|
1849
|
-
/**
|
|
1850
|
-
* Authorization error
|
|
1851
|
-
*/
|
|
1852
|
-
403: {
|
|
1853
|
-
/**
|
|
1854
|
-
* Error overview.
|
|
1855
|
-
*/
|
|
1856
|
-
message: string;
|
|
1857
|
-
};
|
|
1858
|
-
/**
|
|
1859
|
-
* Not found
|
|
1860
|
-
*/
|
|
1861
|
-
404: {
|
|
1862
|
-
/**
|
|
1863
|
-
* Error overview.
|
|
1864
|
-
*/
|
|
1865
|
-
message: string;
|
|
1866
|
-
};
|
|
1867
|
-
/**
|
|
1868
|
-
* Validation error
|
|
1869
|
-
*/
|
|
1870
|
-
422: {
|
|
1871
|
-
/**
|
|
1872
|
-
* Errors overview.
|
|
1873
|
-
*/
|
|
1874
|
-
message: string;
|
|
1875
|
-
/**
|
|
1876
|
-
* A detailed description of each field that failed validation.
|
|
1877
|
-
*/
|
|
1878
|
-
errors: {
|
|
1879
|
-
[key: string]: Array<string>;
|
|
1880
|
-
};
|
|
1881
|
-
};
|
|
1882
|
-
};
|
|
1883
|
-
type PutSpacesBySpaceClustersByClusterIdError = PutSpacesBySpaceClustersByClusterIdErrors[keyof PutSpacesBySpaceClustersByClusterIdErrors];
|
|
1884
|
-
type PutSpacesBySpaceClustersByClusterIdResponses = {
|
|
1885
|
-
/**
|
|
1886
|
-
* Array of items
|
|
1887
|
-
*/
|
|
1888
|
-
200: {
|
|
1889
|
-
data: Array<string>;
|
|
1890
|
-
} | {
|
|
1891
|
-
[key: string]: unknown;
|
|
1892
|
-
};
|
|
1893
|
-
};
|
|
1894
|
-
type PutSpacesBySpaceClustersByClusterIdResponse = PutSpacesBySpaceClustersByClusterIdResponses[keyof PutSpacesBySpaceClustersByClusterIdResponses];
|
|
1895
1776
|
type GetSpacesBySpaceQueueData = {
|
|
1896
1777
|
body?: never;
|
|
1897
1778
|
path: {
|
|
@@ -2649,172 +2530,168 @@ declare class HeyApiRegistry<T> {
|
|
|
2649
2530
|
declare class Accounts extends HeyApiClient {
|
|
2650
2531
|
/**
|
|
2651
2532
|
* List accounts
|
|
2652
|
-
*
|
|
2653
|
-
* Returns all connected social accounts for the given space.
|
|
2654
2533
|
*/
|
|
2655
2534
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceAccountsData, ThrowOnError>): RequestResult<GetSpacesBySpaceAccountsResponses, GetSpacesBySpaceAccountsErrors, ThrowOnError, "fields">;
|
|
2656
2535
|
/**
|
|
2657
2536
|
* Activate an account
|
|
2658
2537
|
*
|
|
2659
|
-
*
|
|
2538
|
+
* Deactivates other accounts on the same platform within the space.
|
|
2660
2539
|
*/
|
|
2661
2540
|
activate<ThrowOnError extends boolean = false>(options: Options<PatchSpacesBySpaceAccountsByAccountActivateData, ThrowOnError>): RequestResult<PatchSpacesBySpaceAccountsByAccountActivateResponses, PatchSpacesBySpaceAccountsByAccountActivateErrors, ThrowOnError, "fields">;
|
|
2662
2541
|
/**
|
|
2663
2542
|
* List Pinterest boards
|
|
2664
|
-
*
|
|
2665
|
-
* Returns the Pinterest boards available for the given account.
|
|
2666
2543
|
*/
|
|
2667
2544
|
boards<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceAccountsByAccountBoardsData, ThrowOnError>): RequestResult<GetSpacesBySpaceAccountsByAccountBoardsResponses, GetSpacesBySpaceAccountsByAccountBoardsErrors, ThrowOnError, "fields">;
|
|
2668
2545
|
/**
|
|
2669
2546
|
* Disconnect an account
|
|
2670
2547
|
*
|
|
2671
|
-
* Removes
|
|
2548
|
+
* Removes every account on the same platform within the space and fires an AccountDisconnected webhook for each.
|
|
2672
2549
|
*/
|
|
2673
2550
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceAccountsByAccountData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceAccountsByAccountResponses, DeleteSpacesBySpaceAccountsByAccountErrors, ThrowOnError, "fields">;
|
|
2674
2551
|
}
|
|
2675
2552
|
declare class ApiTokens extends HeyApiClient {
|
|
2676
2553
|
/**
|
|
2677
2554
|
* Create an API token
|
|
2678
|
-
*
|
|
2679
|
-
* Generates a new personal access token for the authenticated user.
|
|
2680
2555
|
*/
|
|
2681
2556
|
create<ThrowOnError extends boolean = false>(options: Options<PostApiTokensData, ThrowOnError>): RequestResult<PostApiTokensResponses, PostApiTokensErrors, ThrowOnError, "fields">;
|
|
2682
2557
|
/**
|
|
2683
2558
|
* Revoke an API token
|
|
2684
|
-
*
|
|
2685
|
-
* Deletes the specified personal access token.
|
|
2686
2559
|
*/
|
|
2687
2560
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiTokensByTokenIdData, ThrowOnError>): RequestResult<DeleteApiTokensByTokenIdResponses, DeleteApiTokensByTokenIdErrors, ThrowOnError, "fields">;
|
|
2688
2561
|
}
|
|
2689
2562
|
declare class Blocks extends HeyApiClient {
|
|
2563
|
+
/**
|
|
2564
|
+
* List bio blocks
|
|
2565
|
+
*/
|
|
2690
2566
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceBioBlocksData, ThrowOnError>): RequestResult<GetSpacesBySpaceBioBlocksResponses, GetSpacesBySpaceBioBlocksErrors, ThrowOnError, "fields">;
|
|
2567
|
+
/**
|
|
2568
|
+
* Create a bio block
|
|
2569
|
+
*/
|
|
2691
2570
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioBlocksData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioBlocksResponses, PostSpacesBySpaceBioBlocksErrors, ThrowOnError, "fields">;
|
|
2571
|
+
/**
|
|
2572
|
+
* Delete a bio block
|
|
2573
|
+
*/
|
|
2692
2574
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceBioBlocksByBlockData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceBioBlocksByBlockResponses, DeleteSpacesBySpaceBioBlocksByBlockErrors, ThrowOnError, "fields">;
|
|
2575
|
+
/**
|
|
2576
|
+
* Update a bio block
|
|
2577
|
+
*/
|
|
2693
2578
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceBioBlocksByBlockData, ThrowOnError>): RequestResult<PutSpacesBySpaceBioBlocksByBlockResponses, PutSpacesBySpaceBioBlocksByBlockErrors, ThrowOnError, "fields">;
|
|
2579
|
+
/**
|
|
2580
|
+
* Reorder a bio block
|
|
2581
|
+
*
|
|
2582
|
+
* Moves the block up or down by swapping with its neighbour.
|
|
2583
|
+
*/
|
|
2694
2584
|
reorder<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioBlocksByBlockReorderData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioBlocksByBlockReorderResponses, PostSpacesBySpaceBioBlocksByBlockReorderErrors, ThrowOnError, "fields">;
|
|
2695
2585
|
}
|
|
2696
2586
|
declare class Bio extends HeyApiClient {
|
|
2587
|
+
/**
|
|
2588
|
+
* Get the bio page
|
|
2589
|
+
*/
|
|
2697
2590
|
get<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceBioData, ThrowOnError>): RequestResult<GetSpacesBySpaceBioResponses, GetSpacesBySpaceBioErrors, ThrowOnError, "fields">;
|
|
2591
|
+
/**
|
|
2592
|
+
* Create the bio page
|
|
2593
|
+
*
|
|
2594
|
+
* Seeds a social icons block from the space's active accounts.
|
|
2595
|
+
*/
|
|
2698
2596
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioResponses, PostSpacesBySpaceBioErrors, ThrowOnError, "fields">;
|
|
2597
|
+
/**
|
|
2598
|
+
* Update the bio page
|
|
2599
|
+
*/
|
|
2699
2600
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceBioData, ThrowOnError>): RequestResult<PutSpacesBySpaceBioResponses, PutSpacesBySpaceBioErrors, ThrowOnError, "fields">;
|
|
2601
|
+
/**
|
|
2602
|
+
* Upload a bio page avatar
|
|
2603
|
+
*/
|
|
2700
2604
|
uploadAvatar<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceBioAvatarData, ThrowOnError>): RequestResult<PostSpacesBySpaceBioAvatarResponses, PostSpacesBySpaceBioAvatarErrors, ThrowOnError, "fields">;
|
|
2701
2605
|
private _blocks?;
|
|
2702
2606
|
get blocks(): Blocks;
|
|
2703
2607
|
}
|
|
2704
2608
|
declare class Health extends HeyApiClient {
|
|
2609
|
+
/**
|
|
2610
|
+
* Health check
|
|
2611
|
+
*/
|
|
2705
2612
|
check<ThrowOnError extends boolean = false>(options?: Options<GetHealthData, ThrowOnError>): RequestResult<GetHealthResponses, GetHealthErrors, ThrowOnError, "fields">;
|
|
2706
2613
|
}
|
|
2707
2614
|
declare class Media extends HeyApiClient {
|
|
2708
2615
|
/**
|
|
2709
|
-
*
|
|
2616
|
+
* Get an upload URL
|
|
2710
2617
|
*
|
|
2711
|
-
*
|
|
2618
|
+
* PUT the file to the returned `upload_url` with `Content-Type: <mime>`, then send `url` back when creating or updating a post.
|
|
2712
2619
|
*/
|
|
2713
|
-
|
|
2714
|
-
/**
|
|
2715
|
-
* Delete a media file
|
|
2716
|
-
*
|
|
2717
|
-
* Removes the media file from storage and deletes the record.
|
|
2718
|
-
*/
|
|
2719
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeleteMediaByMediaData, ThrowOnError>): RequestResult<DeleteMediaByMediaResponses, DeleteMediaByMediaErrors, ThrowOnError, "fields">;
|
|
2620
|
+
sign<ThrowOnError extends boolean = false>(options: Options<PostMediaSignData, ThrowOnError>): RequestResult<PostMediaSignResponses, PostMediaSignErrors, ThrowOnError, "fields">;
|
|
2720
2621
|
}
|
|
2721
2622
|
declare class Posts extends HeyApiClient {
|
|
2722
2623
|
/**
|
|
2723
2624
|
* List posts
|
|
2724
2625
|
*
|
|
2725
|
-
*
|
|
2626
|
+
* Filterable by status, account, and date range.
|
|
2726
2627
|
*/
|
|
2727
2628
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpacePostsData, ThrowOnError>): RequestResult<GetSpacesBySpacePostsResponses, GetSpacesBySpacePostsErrors, ThrowOnError, "fields">;
|
|
2728
2629
|
/**
|
|
2729
2630
|
* Create posts
|
|
2730
2631
|
*
|
|
2731
|
-
* Creates one or more posts as a cluster. Supports draft, scheduled, or immediate publishing
|
|
2632
|
+
* Creates one or more posts as a cluster. Supports draft, scheduled, or immediate publishing.
|
|
2732
2633
|
*/
|
|
2733
2634
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpacePostsData, ThrowOnError>): RequestResult<PostSpacesBySpacePostsResponses, PostSpacesBySpacePostsErrors, ThrowOnError, "fields">;
|
|
2734
2635
|
/**
|
|
2735
2636
|
* Delete a post
|
|
2736
|
-
*
|
|
2737
|
-
* Permanently deletes the given post.
|
|
2738
2637
|
*/
|
|
2739
2638
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpacePostsByPostData, ThrowOnError>): RequestResult<DeleteSpacesBySpacePostsByPostResponses, DeleteSpacesBySpacePostsByPostErrors, ThrowOnError, "fields">;
|
|
2740
2639
|
/**
|
|
2741
2640
|
* Get a post
|
|
2742
|
-
*
|
|
2743
|
-
* Returns a single post with its account, children, and media.
|
|
2744
2641
|
*/
|
|
2745
2642
|
get<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpacePostsByPostData, ThrowOnError>): RequestResult<GetSpacesBySpacePostsByPostResponses, GetSpacesBySpacePostsByPostErrors, ThrowOnError, "fields">;
|
|
2746
2643
|
/**
|
|
2747
2644
|
* Update a post
|
|
2748
2645
|
*
|
|
2749
|
-
* Updates
|
|
2646
|
+
* Updates content, media, thread replies, schedule, status, and metadata for a single post.
|
|
2750
2647
|
*/
|
|
2751
2648
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpacePostsByPostData, ThrowOnError>): RequestResult<PutSpacesBySpacePostsByPostResponses, PutSpacesBySpacePostsByPostErrors, ThrowOnError, "fields">;
|
|
2752
2649
|
}
|
|
2753
|
-
declare class Clusters extends HeyApiClient {
|
|
2754
|
-
/**
|
|
2755
|
-
* Update a cluster of posts
|
|
2756
|
-
*
|
|
2757
|
-
* Updates all posts sharing the given cluster ID. Handles adding/removing accounts and re-scheduling.
|
|
2758
|
-
*/
|
|
2759
|
-
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceClustersByClusterIdData, ThrowOnError>): RequestResult<PutSpacesBySpaceClustersByClusterIdResponses, PutSpacesBySpaceClustersByClusterIdErrors, ThrowOnError, "fields">;
|
|
2760
|
-
}
|
|
2761
2650
|
declare class Queue extends HeyApiClient {
|
|
2762
2651
|
/**
|
|
2763
|
-
*
|
|
2652
|
+
* List available queue slots
|
|
2764
2653
|
*
|
|
2765
|
-
* Returns up to 9 upcoming
|
|
2654
|
+
* Returns up to 9 upcoming free slots from the space's schedule.
|
|
2766
2655
|
*/
|
|
2767
2656
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceQueueData, ThrowOnError>): RequestResult<GetSpacesBySpaceQueueResponses, GetSpacesBySpaceQueueErrors, ThrowOnError, "fields">;
|
|
2768
2657
|
}
|
|
2769
2658
|
declare class Slots extends HeyApiClient {
|
|
2770
2659
|
/**
|
|
2771
2660
|
* List slots
|
|
2772
|
-
*
|
|
2773
|
-
* Returns all scheduling slots for the space, ordered by day and time.
|
|
2774
2661
|
*/
|
|
2775
2662
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceSlotsData, ThrowOnError>): RequestResult<GetSpacesBySpaceSlotsResponses, GetSpacesBySpaceSlotsErrors, ThrowOnError, "fields">;
|
|
2776
2663
|
/**
|
|
2777
2664
|
* Create slots
|
|
2778
2665
|
*
|
|
2779
|
-
* Creates
|
|
2666
|
+
* Creates a slot at the given time for each day of the week.
|
|
2780
2667
|
*/
|
|
2781
2668
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceSlotsData, ThrowOnError>): RequestResult<PostSpacesBySpaceSlotsResponses, PostSpacesBySpaceSlotsErrors, ThrowOnError, "fields">;
|
|
2782
2669
|
/**
|
|
2783
2670
|
* Delete a slot
|
|
2784
|
-
*
|
|
2785
|
-
* Removes a scheduling slot from the space.
|
|
2786
2671
|
*/
|
|
2787
2672
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceSlotsBySlotData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceSlotsBySlotResponses, DeleteSpacesBySpaceSlotsBySlotErrors, ThrowOnError, "fields">;
|
|
2788
2673
|
}
|
|
2789
2674
|
declare class Spaces extends HeyApiClient {
|
|
2790
2675
|
/**
|
|
2791
2676
|
* List spaces
|
|
2792
|
-
*
|
|
2793
|
-
* Returns all spaces belonging to the authenticated user, ordered by most recent.
|
|
2794
2677
|
*/
|
|
2795
2678
|
list<ThrowOnError extends boolean = false>(options?: Options<GetSpacesData, ThrowOnError>): RequestResult<GetSpacesResponses, GetSpacesErrors, ThrowOnError, "fields">;
|
|
2796
2679
|
/**
|
|
2797
2680
|
* Create a space
|
|
2798
|
-
*
|
|
2799
|
-
* Creates a new space for the authenticated user.
|
|
2800
2681
|
*/
|
|
2801
2682
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesData, ThrowOnError>): RequestResult<PostSpacesResponses, PostSpacesErrors, ThrowOnError, "fields">;
|
|
2802
2683
|
/**
|
|
2803
2684
|
* Delete a space
|
|
2804
2685
|
*
|
|
2805
|
-
*
|
|
2686
|
+
* Cascades to all accounts, posts, slots, and other associated data.
|
|
2806
2687
|
*/
|
|
2807
2688
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceResponses, DeleteSpacesBySpaceErrors, ThrowOnError, "fields">;
|
|
2808
2689
|
/**
|
|
2809
2690
|
* Get a space
|
|
2810
|
-
*
|
|
2811
|
-
* Returns a single space by ID.
|
|
2812
2691
|
*/
|
|
2813
2692
|
get<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceData, ThrowOnError>): RequestResult<GetSpacesBySpaceResponses, GetSpacesBySpaceErrors, ThrowOnError, "fields">;
|
|
2814
2693
|
/**
|
|
2815
2694
|
* Update a space
|
|
2816
|
-
*
|
|
2817
|
-
* Updates the given space's settings.
|
|
2818
2695
|
*/
|
|
2819
2696
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceData, ThrowOnError>): RequestResult<PutSpacesBySpaceResponses, PutSpacesBySpaceErrors, ThrowOnError, "fields">;
|
|
2820
2697
|
}
|
|
@@ -2822,33 +2699,27 @@ declare class Subscription extends HeyApiClient {
|
|
|
2822
2699
|
/**
|
|
2823
2700
|
* Get subscription details
|
|
2824
2701
|
*
|
|
2825
|
-
*
|
|
2702
|
+
* Includes plan, usage limits, trial state, and cancellation state.
|
|
2826
2703
|
*/
|
|
2827
2704
|
get<ThrowOnError extends boolean = false>(options?: Options<GetSubscriptionData, ThrowOnError>): RequestResult<GetSubscriptionResponses, GetSubscriptionErrors, ThrowOnError, "fields">;
|
|
2828
2705
|
}
|
|
2829
2706
|
declare class Webhooks extends HeyApiClient {
|
|
2830
2707
|
/**
|
|
2831
2708
|
* List webhooks
|
|
2832
|
-
*
|
|
2833
|
-
* Returns all webhooks configured for the given space.
|
|
2834
2709
|
*/
|
|
2835
2710
|
list<ThrowOnError extends boolean = false>(options: Options<GetSpacesBySpaceWebhooksData, ThrowOnError>): RequestResult<GetSpacesBySpaceWebhooksResponses, GetSpacesBySpaceWebhooksErrors, ThrowOnError, "fields">;
|
|
2836
2711
|
/**
|
|
2837
2712
|
* Create a webhook
|
|
2838
2713
|
*
|
|
2839
|
-
*
|
|
2714
|
+
* Returns an auto-generated signing secret on the response.
|
|
2840
2715
|
*/
|
|
2841
2716
|
create<ThrowOnError extends boolean = false>(options: Options<PostSpacesBySpaceWebhooksData, ThrowOnError>): RequestResult<PostSpacesBySpaceWebhooksResponses, PostSpacesBySpaceWebhooksErrors, ThrowOnError, "fields">;
|
|
2842
2717
|
/**
|
|
2843
2718
|
* Delete a webhook
|
|
2844
|
-
*
|
|
2845
|
-
* Permanently removes the webhook endpoint.
|
|
2846
2719
|
*/
|
|
2847
2720
|
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSpacesBySpaceWebhooksByWebhookData, ThrowOnError>): RequestResult<DeleteSpacesBySpaceWebhooksByWebhookResponses, DeleteSpacesBySpaceWebhooksByWebhookErrors, ThrowOnError, "fields">;
|
|
2848
2721
|
/**
|
|
2849
2722
|
* Update a webhook
|
|
2850
|
-
*
|
|
2851
|
-
* Updates the webhook's URL, events, or active status.
|
|
2852
2723
|
*/
|
|
2853
2724
|
update<ThrowOnError extends boolean = false>(options: Options<PutSpacesBySpaceWebhooksByWebhookData, ThrowOnError>): RequestResult<PutSpacesBySpaceWebhooksByWebhookResponses, PutSpacesBySpaceWebhooksByWebhookErrors, ThrowOnError, "fields">;
|
|
2854
2725
|
}
|
|
@@ -2870,8 +2741,6 @@ declare class ZilfuApi extends HeyApiClient {
|
|
|
2870
2741
|
get media(): Media;
|
|
2871
2742
|
private _posts?;
|
|
2872
2743
|
get posts(): Posts;
|
|
2873
|
-
private _clusters?;
|
|
2874
|
-
get clusters(): Clusters;
|
|
2875
2744
|
private _queue?;
|
|
2876
2745
|
get queue(): Queue;
|
|
2877
2746
|
private _slots?;
|
|
@@ -2914,4 +2783,4 @@ declare class ZilfuApiError extends Error {
|
|
|
2914
2783
|
constructor(init: ZilfuApiErrorInit);
|
|
2915
2784
|
}
|
|
2916
2785
|
|
|
2917
|
-
export { type AccountResource, type BioBlockResource, type BioPageResource, type ClientOptions, type CreateZilfuClientOptions, type DeleteApiTokensByTokenIdData, type DeleteApiTokensByTokenIdError, type DeleteApiTokensByTokenIdErrors, type DeleteApiTokensByTokenIdResponses, type
|
|
2786
|
+
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 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 UpdatePostRequest, type UpdateSpaceRequest, type UpdateWebhookRequest, type WebhookResource, ZilfuApiError, type ZilfuApiErrorInit, type ZilfuClient, type ZilfuFetch, type ZilfuToken, createZilfuClient };
|