@heymantle/core-api-client 0.2.4 → 0.3.0
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.d.mts +788 -72
- package/dist/index.d.ts +788 -72
- package/dist/index.js +35 -14
- package/dist/index.mjs +35 -14
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -472,6 +472,8 @@ type paths = {
|
|
|
472
472
|
get: {
|
|
473
473
|
parameters: {
|
|
474
474
|
query?: {
|
|
475
|
+
/** @description Comma-separated list of affiliate IDs to filter by */
|
|
476
|
+
affiliateIds?: string;
|
|
475
477
|
/** @description Filter by affiliate program ID */
|
|
476
478
|
affiliateProgramId?: string;
|
|
477
479
|
/** @description Filter by app ID */
|
|
@@ -576,6 +578,112 @@ type paths = {
|
|
|
576
578
|
patch?: never;
|
|
577
579
|
trace?: never;
|
|
578
580
|
};
|
|
581
|
+
"/agents": {
|
|
582
|
+
parameters: {
|
|
583
|
+
query?: never;
|
|
584
|
+
header?: never;
|
|
585
|
+
path?: never;
|
|
586
|
+
cookie?: never;
|
|
587
|
+
};
|
|
588
|
+
/**
|
|
589
|
+
* List agents
|
|
590
|
+
* @description Get a list of helpdesk agents with optional filters by email or search term.
|
|
591
|
+
*/
|
|
592
|
+
get: {
|
|
593
|
+
parameters: {
|
|
594
|
+
query?: {
|
|
595
|
+
/** @description Filter by exact email address */
|
|
596
|
+
email?: string;
|
|
597
|
+
/** @description Search agents by email or name */
|
|
598
|
+
search?: string;
|
|
599
|
+
};
|
|
600
|
+
header?: never;
|
|
601
|
+
path?: never;
|
|
602
|
+
cookie?: never;
|
|
603
|
+
};
|
|
604
|
+
requestBody?: never;
|
|
605
|
+
responses: {
|
|
606
|
+
/** @description A list of agents. */
|
|
607
|
+
200: {
|
|
608
|
+
headers: {
|
|
609
|
+
[name: string]: unknown;
|
|
610
|
+
};
|
|
611
|
+
content: {
|
|
612
|
+
"application/json": {
|
|
613
|
+
agents: components["schemas"]["Agent"][];
|
|
614
|
+
};
|
|
615
|
+
};
|
|
616
|
+
};
|
|
617
|
+
401: components["responses"]["401"];
|
|
618
|
+
403: components["responses"]["403"];
|
|
619
|
+
};
|
|
620
|
+
};
|
|
621
|
+
put?: never;
|
|
622
|
+
/**
|
|
623
|
+
* Create an agent
|
|
624
|
+
* @description Find or create a helpdesk agent by email. If an agent with the given email
|
|
625
|
+
* already exists, returns the existing agent. Otherwise, creates a new one.
|
|
626
|
+
*
|
|
627
|
+
* If a user with the email exists in the organization, the agent will be
|
|
628
|
+
* linked to that user.
|
|
629
|
+
*/
|
|
630
|
+
post: {
|
|
631
|
+
parameters: {
|
|
632
|
+
query?: never;
|
|
633
|
+
header?: never;
|
|
634
|
+
path?: never;
|
|
635
|
+
cookie?: never;
|
|
636
|
+
};
|
|
637
|
+
requestBody: {
|
|
638
|
+
content: {
|
|
639
|
+
"application/json": {
|
|
640
|
+
/** @description The email address of the agent */
|
|
641
|
+
email: string;
|
|
642
|
+
/** @description The name of the agent. Falls back to the linked user's name if not provided. */
|
|
643
|
+
name?: string;
|
|
644
|
+
};
|
|
645
|
+
};
|
|
646
|
+
};
|
|
647
|
+
responses: {
|
|
648
|
+
/** @description An existing agent was found. */
|
|
649
|
+
200: {
|
|
650
|
+
headers: {
|
|
651
|
+
[name: string]: unknown;
|
|
652
|
+
};
|
|
653
|
+
content: {
|
|
654
|
+
"application/json": {
|
|
655
|
+
agent?: components["schemas"]["Agent"];
|
|
656
|
+
};
|
|
657
|
+
};
|
|
658
|
+
};
|
|
659
|
+
/** @description The created agent. */
|
|
660
|
+
201: {
|
|
661
|
+
headers: {
|
|
662
|
+
[name: string]: unknown;
|
|
663
|
+
};
|
|
664
|
+
content: {
|
|
665
|
+
"application/json": {
|
|
666
|
+
agent?: components["schemas"]["Agent"];
|
|
667
|
+
};
|
|
668
|
+
};
|
|
669
|
+
};
|
|
670
|
+
/** @description Validation error (missing email) */
|
|
671
|
+
400: {
|
|
672
|
+
headers: {
|
|
673
|
+
[name: string]: unknown;
|
|
674
|
+
};
|
|
675
|
+
content?: never;
|
|
676
|
+
};
|
|
677
|
+
401: components["responses"]["401"];
|
|
678
|
+
403: components["responses"]["403"];
|
|
679
|
+
};
|
|
680
|
+
};
|
|
681
|
+
delete?: never;
|
|
682
|
+
options?: never;
|
|
683
|
+
head?: never;
|
|
684
|
+
patch?: never;
|
|
685
|
+
trace?: never;
|
|
686
|
+
};
|
|
579
687
|
"/ai/agents/{agentId}/runs": {
|
|
580
688
|
parameters: {
|
|
581
689
|
query?: never;
|
|
@@ -2758,14 +2866,18 @@ type paths = {
|
|
|
2758
2866
|
get: {
|
|
2759
2867
|
parameters: {
|
|
2760
2868
|
query?: {
|
|
2761
|
-
/** @description
|
|
2869
|
+
/** @description Base64-encoded cursor from a previous response's nextCursor. Omit for the first page. */
|
|
2870
|
+
cursor?: string;
|
|
2871
|
+
/** @description [Deprecated] Use cursor instead. Legacy 1-based page number. */
|
|
2762
2872
|
page?: number;
|
|
2763
|
-
/** @description
|
|
2873
|
+
/** @description [Deprecated] Use take instead. */
|
|
2764
2874
|
perPage?: number;
|
|
2765
2875
|
/** @description Filter plans by public visibility. */
|
|
2766
2876
|
public?: boolean;
|
|
2767
2877
|
/** @description Search term to filter plans by name. */
|
|
2768
2878
|
search?: string;
|
|
2879
|
+
/** @description The number of plans to return (max 100). Alias "perPage" is also accepted for backwards compatibility. */
|
|
2880
|
+
take?: number;
|
|
2769
2881
|
};
|
|
2770
2882
|
header?: never;
|
|
2771
2883
|
path: {
|
|
@@ -2783,11 +2895,17 @@ type paths = {
|
|
|
2783
2895
|
};
|
|
2784
2896
|
content: {
|
|
2785
2897
|
"application/json": {
|
|
2786
|
-
/** @description
|
|
2898
|
+
/** @description Alias for hasNextPage (backwards compatibility). */
|
|
2787
2899
|
hasMore?: boolean;
|
|
2788
|
-
/** @description
|
|
2789
|
-
|
|
2900
|
+
/** @description Indicates if there are more plans. */
|
|
2901
|
+
hasNextPage?: boolean;
|
|
2902
|
+
/** @description Indicates if there is a previous page. */
|
|
2903
|
+
hasPreviousPage?: boolean;
|
|
2904
|
+
/** @description Base64-encoded cursor for the next page. */
|
|
2905
|
+
nextCursor?: string | null;
|
|
2790
2906
|
plans?: components["schemas"]["Plan"][];
|
|
2907
|
+
/** @description Base64-encoded cursor for the previous page. */
|
|
2908
|
+
previousCursor?: string | null;
|
|
2791
2909
|
/** @description Total number of plans. */
|
|
2792
2910
|
total?: number;
|
|
2793
2911
|
};
|
|
@@ -7401,7 +7519,7 @@ type paths = {
|
|
|
7401
7519
|
};
|
|
7402
7520
|
/**
|
|
7403
7521
|
* List documentation pages
|
|
7404
|
-
* @description Retrieve a list of documentation pages
|
|
7522
|
+
* @description Retrieve a list of documentation pages. At least one of repositoryId, collectionId, or groupId is required.
|
|
7405
7523
|
*/
|
|
7406
7524
|
get: {
|
|
7407
7525
|
parameters: {
|
|
@@ -7412,6 +7530,8 @@ type paths = {
|
|
|
7412
7530
|
groupId?: string;
|
|
7413
7531
|
/** @description Locale for localized content */
|
|
7414
7532
|
locale?: string;
|
|
7533
|
+
/** @description Filter by parent page ID. Use to get only root pages (null) or children of a specific page. */
|
|
7534
|
+
parentPageId?: string;
|
|
7415
7535
|
/** @description The ID of the repository to filter by */
|
|
7416
7536
|
repositoryId?: string;
|
|
7417
7537
|
};
|
|
@@ -7569,102 +7689,498 @@ type paths = {
|
|
|
7569
7689
|
};
|
|
7570
7690
|
};
|
|
7571
7691
|
/**
|
|
7572
|
-
* Update a documentation page
|
|
7573
|
-
* @description Update an existing documentation page.
|
|
7692
|
+
* Update a documentation page
|
|
7693
|
+
* @description Update an existing documentation page.
|
|
7694
|
+
*/
|
|
7695
|
+
put: {
|
|
7696
|
+
parameters: {
|
|
7697
|
+
query?: never;
|
|
7698
|
+
header?: never;
|
|
7699
|
+
path: {
|
|
7700
|
+
/** @description The ID of the page to update */
|
|
7701
|
+
page_id: string;
|
|
7702
|
+
};
|
|
7703
|
+
cookie?: never;
|
|
7704
|
+
};
|
|
7705
|
+
requestBody: {
|
|
7706
|
+
content: {
|
|
7707
|
+
"application/json": {
|
|
7708
|
+
/** @description Content of the page (markdown or HTML) */
|
|
7709
|
+
content?: string;
|
|
7710
|
+
/** @description Display order for sorting */
|
|
7711
|
+
displayOrder?: number;
|
|
7712
|
+
/** @description ID of the group */
|
|
7713
|
+
groupId?: string;
|
|
7714
|
+
/** @description Unique handle for the page */
|
|
7715
|
+
handle?: string;
|
|
7716
|
+
/** @description Locale for localized content */
|
|
7717
|
+
locale?: string;
|
|
7718
|
+
/** @description Open Graph image URL for the page */
|
|
7719
|
+
openGraphImage?: string;
|
|
7720
|
+
/** @description ID of the parent page (for nested pages) */
|
|
7721
|
+
parentPageId?: string;
|
|
7722
|
+
/** @description SEO description for the page */
|
|
7723
|
+
seoDescription?: string;
|
|
7724
|
+
/** @description SEO title for the page */
|
|
7725
|
+
seoTitle?: string;
|
|
7726
|
+
/** @description Title of the page */
|
|
7727
|
+
title?: string;
|
|
7728
|
+
};
|
|
7729
|
+
};
|
|
7730
|
+
};
|
|
7731
|
+
responses: {
|
|
7732
|
+
/** @description Page updated successfully */
|
|
7733
|
+
200: {
|
|
7734
|
+
headers: {
|
|
7735
|
+
[name: string]: unknown;
|
|
7736
|
+
};
|
|
7737
|
+
content: {
|
|
7738
|
+
"application/json": components["schemas"]["DocsPageResponse"];
|
|
7739
|
+
};
|
|
7740
|
+
};
|
|
7741
|
+
/** @description Bad request */
|
|
7742
|
+
400: {
|
|
7743
|
+
headers: {
|
|
7744
|
+
[name: string]: unknown;
|
|
7745
|
+
};
|
|
7746
|
+
content: {
|
|
7747
|
+
"application/json": {
|
|
7748
|
+
error?: string;
|
|
7749
|
+
};
|
|
7750
|
+
};
|
|
7751
|
+
};
|
|
7752
|
+
401: components["responses"]["401"];
|
|
7753
|
+
403: components["responses"]["403"];
|
|
7754
|
+
};
|
|
7755
|
+
};
|
|
7756
|
+
post?: never;
|
|
7757
|
+
/**
|
|
7758
|
+
* Delete a documentation page
|
|
7759
|
+
* @description Delete an existing documentation page.
|
|
7760
|
+
*/
|
|
7761
|
+
delete: {
|
|
7762
|
+
parameters: {
|
|
7763
|
+
query?: never;
|
|
7764
|
+
header?: never;
|
|
7765
|
+
path: {
|
|
7766
|
+
/** @description The ID of the page to delete */
|
|
7767
|
+
page_id: string;
|
|
7768
|
+
};
|
|
7769
|
+
cookie?: never;
|
|
7770
|
+
};
|
|
7771
|
+
requestBody?: never;
|
|
7772
|
+
responses: {
|
|
7773
|
+
/** @description Page deleted successfully */
|
|
7774
|
+
200: {
|
|
7775
|
+
headers: {
|
|
7776
|
+
[name: string]: unknown;
|
|
7777
|
+
};
|
|
7778
|
+
content: {
|
|
7779
|
+
"application/json": {
|
|
7780
|
+
success?: boolean;
|
|
7781
|
+
};
|
|
7782
|
+
};
|
|
7783
|
+
};
|
|
7784
|
+
401: components["responses"]["401"];
|
|
7785
|
+
403: components["responses"]["403"];
|
|
7786
|
+
};
|
|
7787
|
+
};
|
|
7788
|
+
options?: never;
|
|
7789
|
+
head?: never;
|
|
7790
|
+
patch?: never;
|
|
7791
|
+
trace?: never;
|
|
7792
|
+
};
|
|
7793
|
+
"/docs/pages/{page_id}/archive": {
|
|
7794
|
+
parameters: {
|
|
7795
|
+
query?: never;
|
|
7796
|
+
header?: never;
|
|
7797
|
+
path?: never;
|
|
7798
|
+
cookie?: never;
|
|
7799
|
+
};
|
|
7800
|
+
get?: never;
|
|
7801
|
+
put?: never;
|
|
7802
|
+
/**
|
|
7803
|
+
* Archive a documentation page
|
|
7804
|
+
* @description Archive a documentation page. Archived pages are unpublished and hidden from the docs site.
|
|
7805
|
+
*/
|
|
7806
|
+
post: {
|
|
7807
|
+
parameters: {
|
|
7808
|
+
query?: never;
|
|
7809
|
+
header?: never;
|
|
7810
|
+
path: {
|
|
7811
|
+
/** @description The ID of the page to archive */
|
|
7812
|
+
page_id: string;
|
|
7813
|
+
};
|
|
7814
|
+
cookie?: never;
|
|
7815
|
+
};
|
|
7816
|
+
requestBody?: never;
|
|
7817
|
+
responses: {
|
|
7818
|
+
/** @description Page archived successfully. */
|
|
7819
|
+
200: {
|
|
7820
|
+
headers: {
|
|
7821
|
+
[name: string]: unknown;
|
|
7822
|
+
};
|
|
7823
|
+
content: {
|
|
7824
|
+
"application/json": {
|
|
7825
|
+
success?: boolean;
|
|
7826
|
+
};
|
|
7827
|
+
};
|
|
7828
|
+
};
|
|
7829
|
+
401: components["responses"]["401"];
|
|
7830
|
+
403: components["responses"]["403"];
|
|
7831
|
+
/** @description Page not found */
|
|
7832
|
+
404: {
|
|
7833
|
+
headers: {
|
|
7834
|
+
[name: string]: unknown;
|
|
7835
|
+
};
|
|
7836
|
+
content?: never;
|
|
7837
|
+
};
|
|
7838
|
+
};
|
|
7839
|
+
};
|
|
7840
|
+
/**
|
|
7841
|
+
* Unarchive a documentation page
|
|
7842
|
+
* @description Restore an archived documentation page.
|
|
7843
|
+
*/
|
|
7844
|
+
delete: {
|
|
7845
|
+
parameters: {
|
|
7846
|
+
query?: never;
|
|
7847
|
+
header?: never;
|
|
7848
|
+
path: {
|
|
7849
|
+
/** @description The ID of the page to unarchive */
|
|
7850
|
+
page_id: string;
|
|
7851
|
+
};
|
|
7852
|
+
cookie?: never;
|
|
7853
|
+
};
|
|
7854
|
+
requestBody?: never;
|
|
7855
|
+
responses: {
|
|
7856
|
+
/** @description Page unarchived successfully. */
|
|
7857
|
+
200: {
|
|
7858
|
+
headers: {
|
|
7859
|
+
[name: string]: unknown;
|
|
7860
|
+
};
|
|
7861
|
+
content: {
|
|
7862
|
+
"application/json": {
|
|
7863
|
+
success?: boolean;
|
|
7864
|
+
};
|
|
7865
|
+
};
|
|
7866
|
+
};
|
|
7867
|
+
401: components["responses"]["401"];
|
|
7868
|
+
403: components["responses"]["403"];
|
|
7869
|
+
/** @description Page not found */
|
|
7870
|
+
404: {
|
|
7871
|
+
headers: {
|
|
7872
|
+
[name: string]: unknown;
|
|
7873
|
+
};
|
|
7874
|
+
content?: never;
|
|
7875
|
+
};
|
|
7876
|
+
};
|
|
7877
|
+
};
|
|
7878
|
+
options?: never;
|
|
7879
|
+
head?: never;
|
|
7880
|
+
patch?: never;
|
|
7881
|
+
trace?: never;
|
|
7882
|
+
};
|
|
7883
|
+
"/docs/pages/{page_id}/generate": {
|
|
7884
|
+
parameters: {
|
|
7885
|
+
query?: never;
|
|
7886
|
+
header?: never;
|
|
7887
|
+
path?: never;
|
|
7888
|
+
cookie?: never;
|
|
7889
|
+
};
|
|
7890
|
+
get?: never;
|
|
7891
|
+
put?: never;
|
|
7892
|
+
/**
|
|
7893
|
+
* Generate AI content for an existing documentation page
|
|
7894
|
+
* @description Use AI to generate or regenerate content fields for an existing page.
|
|
7895
|
+
* Uses the page's current content as context for generation.
|
|
7896
|
+
* Returns a job key for polling the generation status.
|
|
7897
|
+
*
|
|
7898
|
+
* This endpoint does not update the page - use PUT /docs/pages/{page_id}
|
|
7899
|
+
* to save the generated content.
|
|
7900
|
+
*/
|
|
7901
|
+
post: {
|
|
7902
|
+
parameters: {
|
|
7903
|
+
query?: never;
|
|
7904
|
+
header?: never;
|
|
7905
|
+
path: {
|
|
7906
|
+
/** @description The page ID */
|
|
7907
|
+
page_id: string;
|
|
7908
|
+
};
|
|
7909
|
+
cookie?: never;
|
|
7910
|
+
};
|
|
7911
|
+
requestBody: {
|
|
7912
|
+
content: {
|
|
7913
|
+
"application/json": {
|
|
7914
|
+
/** @description Fields to generate (defaults to all) */
|
|
7915
|
+
fields?: ("title" | "seoTitle" | "seoDescription" | "summary" | "content")[];
|
|
7916
|
+
/** @description Description of what content to generate */
|
|
7917
|
+
prompt: string;
|
|
7918
|
+
};
|
|
7919
|
+
};
|
|
7920
|
+
};
|
|
7921
|
+
responses: {
|
|
7922
|
+
/** @description Generation job started */
|
|
7923
|
+
202: {
|
|
7924
|
+
headers: {
|
|
7925
|
+
[name: string]: unknown;
|
|
7926
|
+
};
|
|
7927
|
+
content: {
|
|
7928
|
+
"application/json": components["schemas"]["DocsGenerateJobResponse"];
|
|
7929
|
+
};
|
|
7930
|
+
};
|
|
7931
|
+
/** @description Invalid request */
|
|
7932
|
+
400: {
|
|
7933
|
+
headers: {
|
|
7934
|
+
[name: string]: unknown;
|
|
7935
|
+
};
|
|
7936
|
+
content?: never;
|
|
7937
|
+
};
|
|
7938
|
+
401: components["responses"]["401"];
|
|
7939
|
+
403: components["responses"]["403"];
|
|
7940
|
+
/** @description Page not found */
|
|
7941
|
+
404: {
|
|
7942
|
+
headers: {
|
|
7943
|
+
[name: string]: unknown;
|
|
7944
|
+
};
|
|
7945
|
+
content?: never;
|
|
7946
|
+
};
|
|
7947
|
+
};
|
|
7948
|
+
};
|
|
7949
|
+
delete?: never;
|
|
7950
|
+
options?: never;
|
|
7951
|
+
head?: never;
|
|
7952
|
+
patch?: never;
|
|
7953
|
+
trace?: never;
|
|
7954
|
+
};
|
|
7955
|
+
"/docs/pages/{page_id}/publish": {
|
|
7956
|
+
parameters: {
|
|
7957
|
+
query?: never;
|
|
7958
|
+
header?: never;
|
|
7959
|
+
path?: never;
|
|
7960
|
+
cookie?: never;
|
|
7961
|
+
};
|
|
7962
|
+
get?: never;
|
|
7963
|
+
put?: never;
|
|
7964
|
+
/**
|
|
7965
|
+
* Publish a documentation page
|
|
7966
|
+
* @description Publish a documentation page to make it visible on the docs site.
|
|
7967
|
+
*/
|
|
7968
|
+
post: {
|
|
7969
|
+
parameters: {
|
|
7970
|
+
query?: never;
|
|
7971
|
+
header?: never;
|
|
7972
|
+
path: {
|
|
7973
|
+
/** @description The ID of the page to publish */
|
|
7974
|
+
page_id: string;
|
|
7975
|
+
};
|
|
7976
|
+
cookie?: never;
|
|
7977
|
+
};
|
|
7978
|
+
requestBody: {
|
|
7979
|
+
content: {
|
|
7980
|
+
"application/json": {
|
|
7981
|
+
/** @description The ID of the repository the page belongs to */
|
|
7982
|
+
repositoryId: string;
|
|
7983
|
+
};
|
|
7984
|
+
};
|
|
7985
|
+
};
|
|
7986
|
+
responses: {
|
|
7987
|
+
/** @description Page published successfully. */
|
|
7988
|
+
200: {
|
|
7989
|
+
headers: {
|
|
7990
|
+
[name: string]: unknown;
|
|
7991
|
+
};
|
|
7992
|
+
content: {
|
|
7993
|
+
"application/json": {
|
|
7994
|
+
success?: boolean;
|
|
7995
|
+
};
|
|
7996
|
+
};
|
|
7997
|
+
};
|
|
7998
|
+
/** @description Validation error (missing repositoryId) */
|
|
7999
|
+
400: {
|
|
8000
|
+
headers: {
|
|
8001
|
+
[name: string]: unknown;
|
|
8002
|
+
};
|
|
8003
|
+
content?: never;
|
|
8004
|
+
};
|
|
8005
|
+
401: components["responses"]["401"];
|
|
8006
|
+
403: components["responses"]["403"];
|
|
8007
|
+
/** @description Repository or page not found */
|
|
8008
|
+
404: {
|
|
8009
|
+
headers: {
|
|
8010
|
+
[name: string]: unknown;
|
|
8011
|
+
};
|
|
8012
|
+
content?: never;
|
|
8013
|
+
};
|
|
8014
|
+
};
|
|
8015
|
+
};
|
|
8016
|
+
/**
|
|
8017
|
+
* Unpublish a documentation page
|
|
8018
|
+
* @description Unpublish a documentation page to hide it from the docs site.
|
|
8019
|
+
*/
|
|
8020
|
+
delete: {
|
|
8021
|
+
parameters: {
|
|
8022
|
+
query?: never;
|
|
8023
|
+
header?: never;
|
|
8024
|
+
path: {
|
|
8025
|
+
/** @description The ID of the page to unpublish */
|
|
8026
|
+
page_id: string;
|
|
8027
|
+
};
|
|
8028
|
+
cookie?: never;
|
|
8029
|
+
};
|
|
8030
|
+
requestBody?: never;
|
|
8031
|
+
responses: {
|
|
8032
|
+
/** @description Page unpublished successfully. */
|
|
8033
|
+
200: {
|
|
8034
|
+
headers: {
|
|
8035
|
+
[name: string]: unknown;
|
|
8036
|
+
};
|
|
8037
|
+
content: {
|
|
8038
|
+
"application/json": {
|
|
8039
|
+
success?: boolean;
|
|
8040
|
+
};
|
|
8041
|
+
};
|
|
8042
|
+
};
|
|
8043
|
+
401: components["responses"]["401"];
|
|
8044
|
+
403: components["responses"]["403"];
|
|
8045
|
+
/** @description Page not found */
|
|
8046
|
+
404: {
|
|
8047
|
+
headers: {
|
|
8048
|
+
[name: string]: unknown;
|
|
8049
|
+
};
|
|
8050
|
+
content?: never;
|
|
8051
|
+
};
|
|
8052
|
+
};
|
|
8053
|
+
};
|
|
8054
|
+
options?: never;
|
|
8055
|
+
head?: never;
|
|
8056
|
+
patch?: never;
|
|
8057
|
+
trace?: never;
|
|
8058
|
+
};
|
|
8059
|
+
"/docs/pages/generate": {
|
|
8060
|
+
parameters: {
|
|
8061
|
+
query?: never;
|
|
8062
|
+
header?: never;
|
|
8063
|
+
path?: never;
|
|
8064
|
+
cookie?: never;
|
|
8065
|
+
};
|
|
8066
|
+
get?: never;
|
|
8067
|
+
put?: never;
|
|
8068
|
+
/**
|
|
8069
|
+
* Generate AI content for a new documentation page
|
|
8070
|
+
* @description Use AI to generate content fields for a new page that doesn't exist yet.
|
|
8071
|
+
* Generates all fields: title, seoTitle, seoDescription, summary, and content.
|
|
8072
|
+
* Returns a job key for polling the generation status.
|
|
8073
|
+
*
|
|
8074
|
+
* This endpoint does not create the page - use POST /docs/pages to create
|
|
8075
|
+
* the page with the generated content.
|
|
7574
8076
|
*/
|
|
7575
|
-
|
|
8077
|
+
post: {
|
|
7576
8078
|
parameters: {
|
|
7577
8079
|
query?: never;
|
|
7578
8080
|
header?: never;
|
|
7579
|
-
path
|
|
7580
|
-
/** @description The ID of the page to update */
|
|
7581
|
-
page_id: string;
|
|
7582
|
-
};
|
|
8081
|
+
path?: never;
|
|
7583
8082
|
cookie?: never;
|
|
7584
8083
|
};
|
|
7585
8084
|
requestBody: {
|
|
7586
8085
|
content: {
|
|
7587
8086
|
"application/json": {
|
|
7588
|
-
/** @description
|
|
7589
|
-
|
|
7590
|
-
/** @description
|
|
7591
|
-
displayOrder?: number;
|
|
7592
|
-
/** @description ID of the group */
|
|
8087
|
+
/** @description Target collection ID for context */
|
|
8088
|
+
collectionId?: string;
|
|
8089
|
+
/** @description Target group ID for context */
|
|
7593
8090
|
groupId?: string;
|
|
7594
|
-
/** @description
|
|
7595
|
-
|
|
7596
|
-
/** @description
|
|
7597
|
-
|
|
7598
|
-
/** @description Open Graph image URL for the page */
|
|
7599
|
-
openGraphImage?: string;
|
|
7600
|
-
/** @description ID of the parent page (for nested pages) */
|
|
7601
|
-
parentPageId?: string;
|
|
7602
|
-
/** @description SEO description for the page */
|
|
7603
|
-
seoDescription?: string;
|
|
7604
|
-
/** @description SEO title for the page */
|
|
7605
|
-
seoTitle?: string;
|
|
7606
|
-
/** @description Title of the page */
|
|
7607
|
-
title?: string;
|
|
8091
|
+
/** @description Description of what content to generate */
|
|
8092
|
+
prompt: string;
|
|
8093
|
+
/** @description The docs repository ID */
|
|
8094
|
+
repositoryId: string;
|
|
7608
8095
|
};
|
|
7609
8096
|
};
|
|
7610
8097
|
};
|
|
7611
8098
|
responses: {
|
|
7612
|
-
/** @description
|
|
7613
|
-
|
|
8099
|
+
/** @description Generation job started */
|
|
8100
|
+
202: {
|
|
7614
8101
|
headers: {
|
|
7615
8102
|
[name: string]: unknown;
|
|
7616
8103
|
};
|
|
7617
8104
|
content: {
|
|
7618
|
-
"application/json": components["schemas"]["
|
|
8105
|
+
"application/json": components["schemas"]["DocsGenerateJobResponse"];
|
|
7619
8106
|
};
|
|
7620
8107
|
};
|
|
7621
|
-
/** @description
|
|
8108
|
+
/** @description Invalid request */
|
|
7622
8109
|
400: {
|
|
7623
8110
|
headers: {
|
|
7624
8111
|
[name: string]: unknown;
|
|
7625
8112
|
};
|
|
7626
|
-
content
|
|
7627
|
-
"application/json": {
|
|
7628
|
-
error?: string;
|
|
7629
|
-
};
|
|
7630
|
-
};
|
|
8113
|
+
content?: never;
|
|
7631
8114
|
};
|
|
7632
8115
|
401: components["responses"]["401"];
|
|
7633
8116
|
403: components["responses"]["403"];
|
|
8117
|
+
/** @description Repository not found */
|
|
8118
|
+
404: {
|
|
8119
|
+
headers: {
|
|
8120
|
+
[name: string]: unknown;
|
|
8121
|
+
};
|
|
8122
|
+
content?: never;
|
|
8123
|
+
};
|
|
7634
8124
|
};
|
|
7635
8125
|
};
|
|
7636
|
-
|
|
8126
|
+
delete?: never;
|
|
8127
|
+
options?: never;
|
|
8128
|
+
head?: never;
|
|
8129
|
+
patch?: never;
|
|
8130
|
+
trace?: never;
|
|
8131
|
+
};
|
|
8132
|
+
"/docs/pages/generate/status/{jobKey}": {
|
|
8133
|
+
parameters: {
|
|
8134
|
+
query?: never;
|
|
8135
|
+
header?: never;
|
|
8136
|
+
path?: never;
|
|
8137
|
+
cookie?: never;
|
|
8138
|
+
};
|
|
7637
8139
|
/**
|
|
7638
|
-
*
|
|
7639
|
-
* @description
|
|
8140
|
+
* Get status of a content generation job
|
|
8141
|
+
* @description Poll this endpoint to check if AI content generation has completed.
|
|
7640
8142
|
*/
|
|
7641
|
-
|
|
8143
|
+
get: {
|
|
7642
8144
|
parameters: {
|
|
7643
8145
|
query?: never;
|
|
7644
8146
|
header?: never;
|
|
7645
8147
|
path: {
|
|
7646
|
-
/** @description The
|
|
7647
|
-
|
|
8148
|
+
/** @description The job key returned from the generate endpoint */
|
|
8149
|
+
jobKey: string;
|
|
7648
8150
|
};
|
|
7649
8151
|
cookie?: never;
|
|
7650
8152
|
};
|
|
7651
8153
|
requestBody?: never;
|
|
7652
8154
|
responses: {
|
|
7653
|
-
/** @description
|
|
8155
|
+
/** @description Job status */
|
|
7654
8156
|
200: {
|
|
7655
8157
|
headers: {
|
|
7656
8158
|
[name: string]: unknown;
|
|
7657
8159
|
};
|
|
7658
8160
|
content: {
|
|
7659
|
-
"application/json":
|
|
7660
|
-
success?: boolean;
|
|
7661
|
-
};
|
|
8161
|
+
"application/json": components["schemas"]["DocsGenerateStatusPending"] | components["schemas"]["DocsGenerateStatusCompleted"] | components["schemas"]["DocsGenerateStatusFailed"];
|
|
7662
8162
|
};
|
|
7663
8163
|
};
|
|
8164
|
+
/** @description Invalid job key */
|
|
8165
|
+
400: {
|
|
8166
|
+
headers: {
|
|
8167
|
+
[name: string]: unknown;
|
|
8168
|
+
};
|
|
8169
|
+
content?: never;
|
|
8170
|
+
};
|
|
7664
8171
|
401: components["responses"]["401"];
|
|
7665
|
-
|
|
8172
|
+
/** @description Job not found or expired */
|
|
8173
|
+
404: {
|
|
8174
|
+
headers: {
|
|
8175
|
+
[name: string]: unknown;
|
|
8176
|
+
};
|
|
8177
|
+
content?: never;
|
|
8178
|
+
};
|
|
7666
8179
|
};
|
|
7667
8180
|
};
|
|
8181
|
+
put?: never;
|
|
8182
|
+
post?: never;
|
|
8183
|
+
delete?: never;
|
|
7668
8184
|
options?: never;
|
|
7669
8185
|
head?: never;
|
|
7670
8186
|
patch?: never;
|
|
@@ -7776,6 +8292,65 @@ type paths = {
|
|
|
7776
8292
|
patch?: never;
|
|
7777
8293
|
trace?: never;
|
|
7778
8294
|
};
|
|
8295
|
+
"/docs/tree": {
|
|
8296
|
+
parameters: {
|
|
8297
|
+
query?: never;
|
|
8298
|
+
header?: never;
|
|
8299
|
+
path?: never;
|
|
8300
|
+
cookie?: never;
|
|
8301
|
+
};
|
|
8302
|
+
/**
|
|
8303
|
+
* Get documentation tree
|
|
8304
|
+
* @description Retrieve the full documentation tree structure for a repository, including collections, groups, and pages.
|
|
8305
|
+
*/
|
|
8306
|
+
get: {
|
|
8307
|
+
parameters: {
|
|
8308
|
+
query: {
|
|
8309
|
+
/** @description Include archived pages in the tree */
|
|
8310
|
+
includeArchived?: "true" | "false";
|
|
8311
|
+
/** @description Locale for localized content (defaults to repository default) */
|
|
8312
|
+
locale?: string;
|
|
8313
|
+
/** @description The ID of the repository */
|
|
8314
|
+
repositoryId: string;
|
|
8315
|
+
};
|
|
8316
|
+
header?: never;
|
|
8317
|
+
path?: never;
|
|
8318
|
+
cookie?: never;
|
|
8319
|
+
};
|
|
8320
|
+
requestBody?: never;
|
|
8321
|
+
responses: {
|
|
8322
|
+
/** @description Documentation tree structure */
|
|
8323
|
+
200: {
|
|
8324
|
+
headers: {
|
|
8325
|
+
[name: string]: unknown;
|
|
8326
|
+
};
|
|
8327
|
+
content: {
|
|
8328
|
+
"application/json": components["schemas"]["DocsRepository"];
|
|
8329
|
+
};
|
|
8330
|
+
};
|
|
8331
|
+
/** @description Bad request */
|
|
8332
|
+
400: {
|
|
8333
|
+
headers: {
|
|
8334
|
+
[name: string]: unknown;
|
|
8335
|
+
};
|
|
8336
|
+
content: {
|
|
8337
|
+
"application/json": {
|
|
8338
|
+
error?: string;
|
|
8339
|
+
};
|
|
8340
|
+
};
|
|
8341
|
+
};
|
|
8342
|
+
401: components["responses"]["401"];
|
|
8343
|
+
403: components["responses"]["403"];
|
|
8344
|
+
};
|
|
8345
|
+
};
|
|
8346
|
+
put?: never;
|
|
8347
|
+
post?: never;
|
|
8348
|
+
delete?: never;
|
|
8349
|
+
options?: never;
|
|
8350
|
+
head?: never;
|
|
8351
|
+
patch?: never;
|
|
8352
|
+
trace?: never;
|
|
8353
|
+
};
|
|
7779
8354
|
"/email/unsubscribe_groups": {
|
|
7780
8355
|
parameters: {
|
|
7781
8356
|
query?: never;
|
|
@@ -14081,6 +14656,20 @@ type components = {
|
|
|
14081
14656
|
name?: string;
|
|
14082
14657
|
};
|
|
14083
14658
|
};
|
|
14659
|
+
Agent: {
|
|
14660
|
+
/** Format: date-time */
|
|
14661
|
+
createdAt?: string;
|
|
14662
|
+
email?: string;
|
|
14663
|
+
/** Format: uuid */
|
|
14664
|
+
id?: string;
|
|
14665
|
+
name?: string | null;
|
|
14666
|
+
/** Format: uuid */
|
|
14667
|
+
organizationId?: string;
|
|
14668
|
+
/** Format: date-time */
|
|
14669
|
+
updatedAt?: string;
|
|
14670
|
+
/** Format: uuid */
|
|
14671
|
+
userId?: string | null;
|
|
14672
|
+
};
|
|
14084
14673
|
AgentRun: {
|
|
14085
14674
|
/** @description The ID of the agent that was run. */
|
|
14086
14675
|
agentId: string;
|
|
@@ -14941,6 +15530,32 @@ type components = {
|
|
|
14941
15530
|
/** Format: date-time */
|
|
14942
15531
|
updatedAt?: string;
|
|
14943
15532
|
};
|
|
15533
|
+
DocsGenerateJobResponse: {
|
|
15534
|
+
/** @description Unique key to poll for job status */
|
|
15535
|
+
jobKey?: string;
|
|
15536
|
+
/** @description URL to poll for job status */
|
|
15537
|
+
statusUrl?: string;
|
|
15538
|
+
};
|
|
15539
|
+
DocsGenerateStatusCompleted: {
|
|
15540
|
+
result?: {
|
|
15541
|
+
content?: string;
|
|
15542
|
+
seoDescription?: string;
|
|
15543
|
+
seoTitle?: string;
|
|
15544
|
+
summary?: string;
|
|
15545
|
+
title?: string;
|
|
15546
|
+
};
|
|
15547
|
+
/** @enum {string} */
|
|
15548
|
+
status?: "completed";
|
|
15549
|
+
};
|
|
15550
|
+
DocsGenerateStatusFailed: {
|
|
15551
|
+
error?: string;
|
|
15552
|
+
/** @enum {string} */
|
|
15553
|
+
status?: "failed";
|
|
15554
|
+
};
|
|
15555
|
+
DocsGenerateStatusPending: {
|
|
15556
|
+
/** @enum {string} */
|
|
15557
|
+
status?: "pending";
|
|
15558
|
+
};
|
|
14944
15559
|
/** @description A documentation group within a collection */
|
|
14945
15560
|
DocsGroup: {
|
|
14946
15561
|
/** Format: date-time */
|
|
@@ -18094,7 +18709,9 @@ declare class AppsResource extends BaseResource {
|
|
|
18094
18709
|
}>;
|
|
18095
18710
|
listPlans(appId: string, params?: paths['/apps/{id}/plans']['get']['parameters']['query']): Promise<{
|
|
18096
18711
|
hasMore?: boolean | undefined;
|
|
18097
|
-
|
|
18712
|
+
hasNextPage?: boolean | undefined;
|
|
18713
|
+
hasPreviousPage?: boolean | undefined;
|
|
18714
|
+
nextCursor?: string | null | undefined;
|
|
18098
18715
|
plans?: {
|
|
18099
18716
|
activeTrialCount?: number | undefined;
|
|
18100
18717
|
amount?: number | undefined;
|
|
@@ -18146,6 +18763,7 @@ declare class AppsResource extends BaseResource {
|
|
|
18146
18763
|
updatedAt?: string | undefined;
|
|
18147
18764
|
visible?: boolean | undefined;
|
|
18148
18765
|
}[] | undefined;
|
|
18766
|
+
previousCursor?: string | null | undefined;
|
|
18149
18767
|
total?: number | undefined;
|
|
18150
18768
|
}>;
|
|
18151
18769
|
createPlan(appId: string, data: NonNullable<paths['/apps/{id}/plans']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
@@ -20881,6 +21499,43 @@ declare class DealsResource extends BaseResource {
|
|
|
20881
21499
|
}
|
|
20882
21500
|
|
|
20883
21501
|
declare class DocsResource extends BaseResource {
|
|
21502
|
+
getTree(params: paths['/docs/tree']['get']['parameters']['query']): Promise<{
|
|
21503
|
+
collections?: {
|
|
21504
|
+
createdAt?: string | undefined;
|
|
21505
|
+
description?: string | undefined;
|
|
21506
|
+
displayOrder?: number | undefined;
|
|
21507
|
+
groups?: {
|
|
21508
|
+
createdAt?: string | undefined;
|
|
21509
|
+
displayOrder?: number | undefined;
|
|
21510
|
+
handle?: string | undefined;
|
|
21511
|
+
id?: string | undefined;
|
|
21512
|
+
pages?: {
|
|
21513
|
+
children?: /*elided*/ any[] | undefined;
|
|
21514
|
+
depth?: number | undefined;
|
|
21515
|
+
displayOrder?: number | undefined;
|
|
21516
|
+
handle?: string | undefined;
|
|
21517
|
+
id?: string | undefined;
|
|
21518
|
+
path?: string | undefined;
|
|
21519
|
+
publishedAt?: string | undefined;
|
|
21520
|
+
title?: string | undefined;
|
|
21521
|
+
}[] | undefined;
|
|
21522
|
+
status?: "draft" | "published" | undefined;
|
|
21523
|
+
title?: string | undefined;
|
|
21524
|
+
updatedAt?: string | undefined;
|
|
21525
|
+
}[] | undefined;
|
|
21526
|
+
handles?: string[] | undefined;
|
|
21527
|
+
id?: string | undefined;
|
|
21528
|
+
status?: "draft" | "published" | undefined;
|
|
21529
|
+
title?: string | undefined;
|
|
21530
|
+
updatedAt?: string | undefined;
|
|
21531
|
+
}[] | undefined;
|
|
21532
|
+
defaultLocale?: string | undefined;
|
|
21533
|
+
handle?: string | undefined;
|
|
21534
|
+
id?: string | undefined;
|
|
21535
|
+
supportedLocales?: string[] | undefined;
|
|
21536
|
+
title?: string | undefined;
|
|
21537
|
+
visibility?: "public" | "internal" | undefined;
|
|
21538
|
+
}>;
|
|
20884
21539
|
listCollections(params: paths['/docs/collections']['get']['parameters']['query']): Promise<{
|
|
20885
21540
|
collections?: {
|
|
20886
21541
|
createdAt?: string | undefined;
|
|
@@ -20951,6 +21606,10 @@ declare class DocsResource extends BaseResource {
|
|
|
20951
21606
|
title?: string | undefined;
|
|
20952
21607
|
updatedAt?: string | undefined;
|
|
20953
21608
|
}>;
|
|
21609
|
+
generatePage(data: NonNullable<paths['/docs/pages/generate']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
21610
|
+
jobKey?: string | undefined;
|
|
21611
|
+
statusUrl?: string | undefined;
|
|
21612
|
+
}>;
|
|
20954
21613
|
listPages(params?: paths['/docs/pages']['get']['parameters']['query']): Promise<{
|
|
20955
21614
|
pages?: {
|
|
20956
21615
|
children?: /*elided*/ any[] | undefined;
|
|
@@ -21011,6 +21670,18 @@ declare class DocsResource extends BaseResource {
|
|
|
21011
21670
|
visibility?: "public" | "internal" | undefined;
|
|
21012
21671
|
}[] | undefined;
|
|
21013
21672
|
}>;
|
|
21673
|
+
archivePage(pageId: string): Promise<{
|
|
21674
|
+
success?: boolean | undefined;
|
|
21675
|
+
}>;
|
|
21676
|
+
unarchivePage(pageId: string): Promise<{
|
|
21677
|
+
success?: boolean | undefined;
|
|
21678
|
+
}>;
|
|
21679
|
+
publishPage(pageId: string, data: NonNullable<paths['/docs/pages/{page_id}/publish']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
21680
|
+
success?: boolean | undefined;
|
|
21681
|
+
}>;
|
|
21682
|
+
unpublishPage(pageId: string): Promise<{
|
|
21683
|
+
success?: boolean | undefined;
|
|
21684
|
+
}>;
|
|
21014
21685
|
updateCollection(collectionId: string, data: NonNullable<paths['/docs/collections/{collection_id}']['put']['requestBody']>['content']['application/json']): Promise<{
|
|
21015
21686
|
createdAt?: string | undefined;
|
|
21016
21687
|
displayOrder?: number | undefined;
|
|
@@ -21101,6 +21772,21 @@ declare class DocsResource extends BaseResource {
|
|
|
21101
21772
|
deletePage(pageId: string): Promise<{
|
|
21102
21773
|
success?: boolean | undefined;
|
|
21103
21774
|
}>;
|
|
21775
|
+
getStatus(jobKey: string): Promise<{
|
|
21776
|
+
status?: "pending" | undefined;
|
|
21777
|
+
} | {
|
|
21778
|
+
result?: {
|
|
21779
|
+
content?: string | undefined;
|
|
21780
|
+
seoDescription?: string | undefined;
|
|
21781
|
+
seoTitle?: string | undefined;
|
|
21782
|
+
summary?: string | undefined;
|
|
21783
|
+
title?: string | undefined;
|
|
21784
|
+
} | undefined;
|
|
21785
|
+
status?: "completed" | undefined;
|
|
21786
|
+
} | {
|
|
21787
|
+
error?: string | undefined;
|
|
21788
|
+
status?: "failed" | undefined;
|
|
21789
|
+
}>;
|
|
21104
21790
|
getRepository(docId: string, params?: paths['/docs/repositories/{id}']['get']['parameters']['query']): Promise<{
|
|
21105
21791
|
repository?: {
|
|
21106
21792
|
collections?: {
|
|
@@ -21140,6 +21826,10 @@ declare class DocsResource extends BaseResource {
|
|
|
21140
21826
|
visibility?: "public" | "internal" | undefined;
|
|
21141
21827
|
} | undefined;
|
|
21142
21828
|
}>;
|
|
21829
|
+
regeneratePage(pageId: string, data: NonNullable<paths['/docs/pages/{page_id}/generate']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
21830
|
+
jobKey?: string | undefined;
|
|
21831
|
+
statusUrl?: string | undefined;
|
|
21832
|
+
}>;
|
|
21143
21833
|
}
|
|
21144
21834
|
|
|
21145
21835
|
declare class EmailUnsubscribeGroupsResource extends BaseResource {
|
|
@@ -21151,7 +21841,7 @@ declare class EmailUnsubscribeGroupsResource extends BaseResource {
|
|
|
21151
21841
|
name?: string | undefined;
|
|
21152
21842
|
}[];
|
|
21153
21843
|
}>;
|
|
21154
|
-
|
|
21844
|
+
deleteMember(groupId: string, memberId: string): Promise<{
|
|
21155
21845
|
success?: boolean | undefined;
|
|
21156
21846
|
}>;
|
|
21157
21847
|
listMembers(groupId: string): Promise<{
|
|
@@ -21164,6 +21854,9 @@ declare class EmailUnsubscribeGroupsResource extends BaseResource {
|
|
|
21164
21854
|
createMember(groupId: string, data: NonNullable<paths['/email/unsubscribe_groups/{id}/members']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
21165
21855
|
success?: boolean | undefined;
|
|
21166
21856
|
}>;
|
|
21857
|
+
deleteMembers(groupId: string, params: paths['/email/unsubscribe_groups/{id}/members']['delete']['parameters']['query']): Promise<{
|
|
21858
|
+
success?: boolean | undefined;
|
|
21859
|
+
}>;
|
|
21167
21860
|
}
|
|
21168
21861
|
|
|
21169
21862
|
declare class EntitiesResource extends BaseResource {
|
|
@@ -21425,7 +22118,7 @@ declare class FlowExtensionsResource extends BaseResource {
|
|
|
21425
22118
|
version?: number | undefined;
|
|
21426
22119
|
}[] | undefined;
|
|
21427
22120
|
}>;
|
|
21428
|
-
|
|
22121
|
+
createTriggerByHandle(data: NonNullable<paths['/flow/extensions/triggers']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
21429
22122
|
trigger?: {
|
|
21430
22123
|
address?: string | undefined;
|
|
21431
22124
|
allVersions?: /*elided*/ any[] | undefined;
|
|
@@ -22331,7 +23024,7 @@ declare class MeetingsResource extends BaseResource {
|
|
|
22331
23024
|
wordCount?: number | undefined;
|
|
22332
23025
|
} | undefined;
|
|
22333
23026
|
}>;
|
|
22334
|
-
|
|
23027
|
+
getTranscription(meetingId: string): Promise<{
|
|
22335
23028
|
meetingId?: string | undefined;
|
|
22336
23029
|
recordingStatus?: string | undefined;
|
|
22337
23030
|
transcript?: {
|
|
@@ -22340,7 +23033,7 @@ declare class MeetingsResource extends BaseResource {
|
|
|
22340
23033
|
status?: string | undefined;
|
|
22341
23034
|
} | null | undefined;
|
|
22342
23035
|
}>;
|
|
22343
|
-
|
|
23036
|
+
transcribe(meetingId: string, data: NonNullable<paths['/meetings/{id}/transcribe']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
22344
23037
|
aiDealInsights?: {} | null | undefined;
|
|
22345
23038
|
aiDecisions?: {
|
|
22346
23039
|
context?: string | null | undefined;
|
|
@@ -24648,21 +25341,39 @@ declare class WebhooksResource extends BaseResource {
|
|
|
24648
25341
|
}>;
|
|
24649
25342
|
}
|
|
24650
25343
|
|
|
24651
|
-
/**
|
|
24652
|
-
* Resource for CX support agents.
|
|
24653
|
-
* Note: /agents is not yet in the OpenAPI spec.
|
|
24654
|
-
*/
|
|
24655
25344
|
declare class AgentsResource extends BaseResource {
|
|
24656
|
-
list(): Promise<
|
|
24657
|
-
|
|
24658
|
-
|
|
24659
|
-
|
|
24660
|
-
|
|
24661
|
-
|
|
24662
|
-
|
|
24663
|
-
|
|
24664
|
-
|
|
24665
|
-
|
|
25345
|
+
list(params?: paths['/agents']['get']['parameters']['query']): Promise<{
|
|
25346
|
+
agents: {
|
|
25347
|
+
createdAt?: string | undefined;
|
|
25348
|
+
email?: string | undefined;
|
|
25349
|
+
id?: string | undefined;
|
|
25350
|
+
name?: string | null | undefined;
|
|
25351
|
+
organizationId?: string | undefined;
|
|
25352
|
+
updatedAt?: string | undefined;
|
|
25353
|
+
userId?: string | null | undefined;
|
|
25354
|
+
}[];
|
|
25355
|
+
}>;
|
|
25356
|
+
findOrCreate(data: NonNullable<paths['/agents']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
25357
|
+
agent?: {
|
|
25358
|
+
createdAt?: string | undefined;
|
|
25359
|
+
email?: string | undefined;
|
|
25360
|
+
id?: string | undefined;
|
|
25361
|
+
name?: string | null | undefined;
|
|
25362
|
+
organizationId?: string | undefined;
|
|
25363
|
+
updatedAt?: string | undefined;
|
|
25364
|
+
userId?: string | null | undefined;
|
|
25365
|
+
} | undefined;
|
|
25366
|
+
} | {
|
|
25367
|
+
agent?: {
|
|
25368
|
+
createdAt?: string | undefined;
|
|
25369
|
+
email?: string | undefined;
|
|
25370
|
+
id?: string | undefined;
|
|
25371
|
+
name?: string | null | undefined;
|
|
25372
|
+
organizationId?: string | undefined;
|
|
25373
|
+
updatedAt?: string | undefined;
|
|
25374
|
+
userId?: string | null | undefined;
|
|
25375
|
+
} | undefined;
|
|
25376
|
+
}>;
|
|
24666
25377
|
}
|
|
24667
25378
|
|
|
24668
25379
|
/**
|
|
@@ -24764,6 +25475,7 @@ type AffiliateReferral = components['schemas']['AffiliateReferral'];
|
|
|
24764
25475
|
type AffiliateRules = components['schemas']['AffiliateRules'];
|
|
24765
25476
|
type AffiliateRulesWebhook = components['schemas']['AffiliateRulesWebhook'];
|
|
24766
25477
|
type AffiliateWebhook = components['schemas']['AffiliateWebhook'];
|
|
25478
|
+
type Agent = components['schemas']['Agent'];
|
|
24767
25479
|
type AgentRun = components['schemas']['AgentRun'];
|
|
24768
25480
|
type App = components['schemas']['App'];
|
|
24769
25481
|
type AppChargeWebhook = components['schemas']['AppChargeWebhook'];
|
|
@@ -24810,6 +25522,10 @@ type DetailedAffiliate = components['schemas']['DetailedAffiliate'];
|
|
|
24810
25522
|
type DetailedFlow = components['schemas']['DetailedFlow'];
|
|
24811
25523
|
type DocsCollection = components['schemas']['DocsCollection'];
|
|
24812
25524
|
type DocsCollectionResponse = components['schemas']['DocsCollectionResponse'];
|
|
25525
|
+
type DocsGenerateJobResponse = components['schemas']['DocsGenerateJobResponse'];
|
|
25526
|
+
type DocsGenerateStatusCompleted = components['schemas']['DocsGenerateStatusCompleted'];
|
|
25527
|
+
type DocsGenerateStatusFailed = components['schemas']['DocsGenerateStatusFailed'];
|
|
25528
|
+
type DocsGenerateStatusPending = components['schemas']['DocsGenerateStatusPending'];
|
|
24813
25529
|
type DocsGroup = components['schemas']['DocsGroup'];
|
|
24814
25530
|
type DocsGroupResponse = components['schemas']['DocsGroupResponse'];
|
|
24815
25531
|
type DocsPage = components['schemas']['DocsPage'];
|
|
@@ -25020,4 +25736,4 @@ interface RateLimitOptions {
|
|
|
25020
25736
|
*/
|
|
25021
25737
|
declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
|
|
25022
25738
|
|
|
25023
|
-
export { type AccountOwner, type AccountOwnerType, type Action, type ActiveSubscriptionsResponse, type Affiliate, type AffiliateAttributionWebhook, type AffiliateCommission, AffiliateCommissionsResource, type AffiliateMembershipWebhook, type AffiliatePayout, type AffiliatePayoutWebhook, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramGroup, type AffiliateProgramMembership, type AffiliateProgramWebhook, AffiliateProgramsResource, type AffiliateReferral, AffiliateReferralsResource, type AffiliateRules, type AffiliateRulesWebhook, type AffiliateWebhook, AffiliatesResource, type AgentRun, AgentsResource, AiAgentRunsResource, type App, type AppChargeWebhook, type AppEvent, type AppInstallation, type AppInstallationWebhook, type AppWebhook, AppsResource, type AuthRefreshOptions, type BaseCustomerWebhook, BaseResource, ChannelsResource, type Charge, ChargesResource, type Checklist, type ChecklistStep, CompaniesResource, type Company, type Contact, type ContactWebhook, ContactsResource, type CursorPagination, CustomDataResource, type CustomField, type CustomFieldDefaultValue, type Customer, type CustomerContact, type CustomerContactWebhook, type CustomerSegment, CustomerSegmentsResource, type CustomerWebhook, type CustomerWithoutSubscriptionWebhook, CustomersResource, type Deal, type DealAcquirer, DealActivitiesResource, type DealActivity, type DealAffiliate, type DealApp, type DealContact, type DealCustomData, type DealCustomer, type DealEvent, type DealFlow, type DealFlowAffiliate, type DealFlowDefaultSource, type DealFlowPartnership, type DealFlowStage, type DealFlowUser, DealFlowsResource, type DealOwner, type DealPartnership, type DealPlan, type DealStage, DealsResource, type DetailedAffiliate, type DetailedFlow, type DocsCollection, type DocsCollectionResponse, type DocsGroup, type DocsGroupResponse, type DocsPage, type DocsPageResponse, type DocsPageSummary, type DocsRepository, DocsResource, type EmailUnsubscribeGroup, type EmailUnsubscribeGroupMember, EmailUnsubscribeGroupsResource, EntitiesResource, type EventWebhook, type ExtensionUninstallPayload, type ExtensionWebhook, type Feature, type Flow, type FlowActionRun, FlowExtensionsResource, FlowsResource, type InvalidTokenError, type Invoice, type InvoiceWebhook, JournalEntriesResource, type JournalEntry, type JournalEntryApp, type JournalEntryFile, type List, ListsResource, type LogoChurnResponse, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type Meeting, type MeetingAttendee, type MeetingAttendeeRef, type MeetingContactRef, type MeetingCustomer, type MeetingDeal, type MeetingTaskSuggestion, type MeetingTranscript, type MeetingUser, type MeetingUtterance, MeetingsResource, MetricsResource, type MissingScopesError, type MrrResponse, type NetInstallsResponse, type NetRevenueResponse, type NetRevenueRetentionResponse, type Organization, OrganizationResource, type Pagination, type PayoutResponse, type Plan, type PlanFeature, type PlanFeatureWebhook, type PlanUsageChargeWebhook, type PlanWebhook, type PredictedLtvResponse, type RateLimitOptions, type RevenueRetentionResponse, type Review, type ReviewWebhook, type StandardMetricResponse, type Subscription, type SubscriptionWebhook, SubscriptionsResource, type SyncedEmail, type SyncedEmailContact, type SyncedEmailCustomer, type SyncedEmailDeal, type SyncedEmailMessage, type SyncedEmailUser, SyncedEmailsResource, type Task, type TaskTodoItem, TasksResource, type ThreadEventType, type ThreadMessageWebhook, type ThreadWebhook, type Ticket, type TicketAgent, type TicketApp, type TicketAttachment, type TicketChannel, type TicketContact, type TicketCustomer, type TicketEvent, type TicketLoop, type TicketMessage, TicketsResource, type TimeSeriesDataPoint, type TimelineComment, TimelineCommentsResource, type Transaction, type TransactionWebhook, TransactionsResource, type Trigger, type UninstallEventWebhook, type UsageEvent, type UsageEventResponse, UsageEventsResource, type UsageMetric, type UsageMetricResponse, type User, UsersResource, type Webhook, WebhooksResource, type components, createAuthRefreshMiddleware, createRateLimitMiddleware, type paths };
|
|
25739
|
+
export { type AccountOwner, type AccountOwnerType, type Action, type ActiveSubscriptionsResponse, type Affiliate, type AffiliateAttributionWebhook, type AffiliateCommission, AffiliateCommissionsResource, type AffiliateMembershipWebhook, type AffiliatePayout, type AffiliatePayoutWebhook, AffiliatePayoutsResource, type AffiliateProgram, type AffiliateProgramGroup, type AffiliateProgramMembership, type AffiliateProgramWebhook, AffiliateProgramsResource, type AffiliateReferral, AffiliateReferralsResource, type AffiliateRules, type AffiliateRulesWebhook, type AffiliateWebhook, AffiliatesResource, type Agent, type AgentRun, AgentsResource, AiAgentRunsResource, type App, type AppChargeWebhook, type AppEvent, type AppInstallation, type AppInstallationWebhook, type AppWebhook, AppsResource, type AuthRefreshOptions, type BaseCustomerWebhook, BaseResource, ChannelsResource, type Charge, ChargesResource, type Checklist, type ChecklistStep, CompaniesResource, type Company, type Contact, type ContactWebhook, ContactsResource, type CursorPagination, CustomDataResource, type CustomField, type CustomFieldDefaultValue, type Customer, type CustomerContact, type CustomerContactWebhook, type CustomerSegment, CustomerSegmentsResource, type CustomerWebhook, type CustomerWithoutSubscriptionWebhook, CustomersResource, type Deal, type DealAcquirer, DealActivitiesResource, type DealActivity, type DealAffiliate, type DealApp, type DealContact, type DealCustomData, type DealCustomer, type DealEvent, type DealFlow, type DealFlowAffiliate, type DealFlowDefaultSource, type DealFlowPartnership, type DealFlowStage, type DealFlowUser, DealFlowsResource, type DealOwner, type DealPartnership, type DealPlan, type DealStage, DealsResource, type DetailedAffiliate, type DetailedFlow, type DocsCollection, type DocsCollectionResponse, type DocsGenerateJobResponse, type DocsGenerateStatusCompleted, type DocsGenerateStatusFailed, type DocsGenerateStatusPending, type DocsGroup, type DocsGroupResponse, type DocsPage, type DocsPageResponse, type DocsPageSummary, type DocsRepository, DocsResource, type EmailUnsubscribeGroup, type EmailUnsubscribeGroupMember, EmailUnsubscribeGroupsResource, EntitiesResource, type EventWebhook, type ExtensionUninstallPayload, type ExtensionWebhook, type Feature, type Flow, type FlowActionRun, FlowExtensionsResource, FlowsResource, type InvalidTokenError, type Invoice, type InvoiceWebhook, JournalEntriesResource, type JournalEntry, type JournalEntryApp, type JournalEntryFile, type List, ListsResource, type LogoChurnResponse, MantleAPIError, MantleAuthenticationError, MantleCoreClient, type MantleCoreClientConfig, MantleNotFoundError, MantlePermissionError, MantleRateLimitError, MantleValidationError, MeResource, type Meeting, type MeetingAttendee, type MeetingAttendeeRef, type MeetingContactRef, type MeetingCustomer, type MeetingDeal, type MeetingTaskSuggestion, type MeetingTranscript, type MeetingUser, type MeetingUtterance, MeetingsResource, MetricsResource, type MissingScopesError, type MrrResponse, type NetInstallsResponse, type NetRevenueResponse, type NetRevenueRetentionResponse, type Organization, OrganizationResource, type Pagination, type PayoutResponse, type Plan, type PlanFeature, type PlanFeatureWebhook, type PlanUsageChargeWebhook, type PlanWebhook, type PredictedLtvResponse, type RateLimitOptions, type RevenueRetentionResponse, type Review, type ReviewWebhook, type StandardMetricResponse, type Subscription, type SubscriptionWebhook, SubscriptionsResource, type SyncedEmail, type SyncedEmailContact, type SyncedEmailCustomer, type SyncedEmailDeal, type SyncedEmailMessage, type SyncedEmailUser, SyncedEmailsResource, type Task, type TaskTodoItem, TasksResource, type ThreadEventType, type ThreadMessageWebhook, type ThreadWebhook, type Ticket, type TicketAgent, type TicketApp, type TicketAttachment, type TicketChannel, type TicketContact, type TicketCustomer, type TicketEvent, type TicketLoop, type TicketMessage, TicketsResource, type TimeSeriesDataPoint, type TimelineComment, TimelineCommentsResource, type Transaction, type TransactionWebhook, TransactionsResource, type Trigger, type UninstallEventWebhook, type UsageEvent, type UsageEventResponse, UsageEventsResource, type UsageMetric, type UsageMetricResponse, type User, UsersResource, type Webhook, WebhooksResource, type components, createAuthRefreshMiddleware, createRateLimitMiddleware, type paths };
|