@heymantle/core-api-client 0.2.4 → 0.3.1
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 +1669 -200
- package/dist/index.d.ts +1669 -200
- package/dist/index.js +59 -14
- package/dist/index.mjs +59 -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
|
};
|
|
@@ -7670,217 +7790,246 @@ type paths = {
|
|
|
7670
7790
|
patch?: never;
|
|
7671
7791
|
trace?: never;
|
|
7672
7792
|
};
|
|
7673
|
-
"/docs/
|
|
7793
|
+
"/docs/pages/{page_id}/archive": {
|
|
7674
7794
|
parameters: {
|
|
7675
7795
|
query?: never;
|
|
7676
7796
|
header?: never;
|
|
7677
7797
|
path?: never;
|
|
7678
7798
|
cookie?: never;
|
|
7679
7799
|
};
|
|
7800
|
+
get?: never;
|
|
7801
|
+
put?: never;
|
|
7680
7802
|
/**
|
|
7681
|
-
*
|
|
7682
|
-
* @description
|
|
7803
|
+
* Archive a documentation page
|
|
7804
|
+
* @description Archive a documentation page. Archived pages are unpublished and hidden from the docs site.
|
|
7683
7805
|
*/
|
|
7684
|
-
|
|
7806
|
+
post: {
|
|
7685
7807
|
parameters: {
|
|
7686
|
-
query?:
|
|
7687
|
-
/** @description Locale for localized content (defaults to repository default) */
|
|
7688
|
-
locale?: string;
|
|
7689
|
-
};
|
|
7808
|
+
query?: never;
|
|
7690
7809
|
header?: never;
|
|
7691
|
-
path
|
|
7810
|
+
path: {
|
|
7811
|
+
/** @description The ID of the page to archive */
|
|
7812
|
+
page_id: string;
|
|
7813
|
+
};
|
|
7692
7814
|
cookie?: never;
|
|
7693
7815
|
};
|
|
7694
7816
|
requestBody?: never;
|
|
7695
7817
|
responses: {
|
|
7696
|
-
/** @description
|
|
7818
|
+
/** @description Page archived successfully. */
|
|
7697
7819
|
200: {
|
|
7698
7820
|
headers: {
|
|
7699
7821
|
[name: string]: unknown;
|
|
7700
7822
|
};
|
|
7701
7823
|
content: {
|
|
7702
7824
|
"application/json": {
|
|
7703
|
-
|
|
7825
|
+
success?: boolean;
|
|
7704
7826
|
};
|
|
7705
7827
|
};
|
|
7706
7828
|
};
|
|
7707
7829
|
401: components["responses"]["401"];
|
|
7708
7830
|
403: components["responses"]["403"];
|
|
7831
|
+
/** @description Page not found */
|
|
7832
|
+
404: {
|
|
7833
|
+
headers: {
|
|
7834
|
+
[name: string]: unknown;
|
|
7835
|
+
};
|
|
7836
|
+
content?: never;
|
|
7837
|
+
};
|
|
7709
7838
|
};
|
|
7710
7839
|
};
|
|
7711
|
-
put?: never;
|
|
7712
|
-
post?: never;
|
|
7713
|
-
delete?: never;
|
|
7714
|
-
options?: never;
|
|
7715
|
-
head?: never;
|
|
7716
|
-
patch?: never;
|
|
7717
|
-
trace?: never;
|
|
7718
|
-
};
|
|
7719
|
-
"/docs/repositories/{id}": {
|
|
7720
|
-
parameters: {
|
|
7721
|
-
query?: never;
|
|
7722
|
-
header?: never;
|
|
7723
|
-
path?: never;
|
|
7724
|
-
cookie?: never;
|
|
7725
|
-
};
|
|
7726
7840
|
/**
|
|
7727
|
-
*
|
|
7728
|
-
* @description
|
|
7841
|
+
* Unarchive a documentation page
|
|
7842
|
+
* @description Restore an archived documentation page.
|
|
7729
7843
|
*/
|
|
7730
|
-
|
|
7844
|
+
delete: {
|
|
7731
7845
|
parameters: {
|
|
7732
|
-
query?:
|
|
7733
|
-
/** @description Locale for localized content (defaults to repository default) */
|
|
7734
|
-
locale?: string;
|
|
7735
|
-
};
|
|
7846
|
+
query?: never;
|
|
7736
7847
|
header?: never;
|
|
7737
7848
|
path: {
|
|
7738
|
-
/** @description The ID of the
|
|
7739
|
-
|
|
7849
|
+
/** @description The ID of the page to unarchive */
|
|
7850
|
+
page_id: string;
|
|
7740
7851
|
};
|
|
7741
7852
|
cookie?: never;
|
|
7742
7853
|
};
|
|
7743
7854
|
requestBody?: never;
|
|
7744
7855
|
responses: {
|
|
7745
|
-
/** @description
|
|
7856
|
+
/** @description Page unarchived successfully. */
|
|
7746
7857
|
200: {
|
|
7747
7858
|
headers: {
|
|
7748
7859
|
[name: string]: unknown;
|
|
7749
7860
|
};
|
|
7750
7861
|
content: {
|
|
7751
7862
|
"application/json": {
|
|
7752
|
-
|
|
7863
|
+
success?: boolean;
|
|
7753
7864
|
};
|
|
7754
7865
|
};
|
|
7755
7866
|
};
|
|
7756
7867
|
401: components["responses"]["401"];
|
|
7757
7868
|
403: components["responses"]["403"];
|
|
7758
|
-
/** @description
|
|
7869
|
+
/** @description Page not found */
|
|
7759
7870
|
404: {
|
|
7760
7871
|
headers: {
|
|
7761
7872
|
[name: string]: unknown;
|
|
7762
7873
|
};
|
|
7763
|
-
content
|
|
7764
|
-
"application/json": {
|
|
7765
|
-
error?: string;
|
|
7766
|
-
};
|
|
7767
|
-
};
|
|
7874
|
+
content?: never;
|
|
7768
7875
|
};
|
|
7769
7876
|
};
|
|
7770
7877
|
};
|
|
7771
|
-
put?: never;
|
|
7772
|
-
post?: never;
|
|
7773
|
-
delete?: never;
|
|
7774
7878
|
options?: never;
|
|
7775
7879
|
head?: never;
|
|
7776
7880
|
patch?: never;
|
|
7777
7881
|
trace?: never;
|
|
7778
7882
|
};
|
|
7779
|
-
"/
|
|
7883
|
+
"/docs/pages/{page_id}/generate": {
|
|
7780
7884
|
parameters: {
|
|
7781
7885
|
query?: never;
|
|
7782
7886
|
header?: never;
|
|
7783
7887
|
path?: never;
|
|
7784
7888
|
cookie?: never;
|
|
7785
7889
|
};
|
|
7890
|
+
get?: never;
|
|
7891
|
+
put?: never;
|
|
7786
7892
|
/**
|
|
7787
|
-
*
|
|
7788
|
-
* @description
|
|
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.
|
|
7789
7900
|
*/
|
|
7790
|
-
|
|
7901
|
+
post: {
|
|
7791
7902
|
parameters: {
|
|
7792
7903
|
query?: never;
|
|
7793
7904
|
header?: never;
|
|
7794
|
-
path
|
|
7905
|
+
path: {
|
|
7906
|
+
/** @description The page ID */
|
|
7907
|
+
page_id: string;
|
|
7908
|
+
};
|
|
7795
7909
|
cookie?: never;
|
|
7796
7910
|
};
|
|
7797
|
-
requestBody
|
|
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
|
+
};
|
|
7798
7921
|
responses: {
|
|
7799
|
-
/** @description
|
|
7800
|
-
|
|
7922
|
+
/** @description Generation job started */
|
|
7923
|
+
202: {
|
|
7801
7924
|
headers: {
|
|
7802
7925
|
[name: string]: unknown;
|
|
7803
7926
|
};
|
|
7804
7927
|
content: {
|
|
7805
|
-
"application/json":
|
|
7806
|
-
|
|
7807
|
-
|
|
7928
|
+
"application/json": components["schemas"]["DocsGenerateJobResponse"];
|
|
7929
|
+
};
|
|
7930
|
+
};
|
|
7931
|
+
/** @description Invalid request */
|
|
7932
|
+
400: {
|
|
7933
|
+
headers: {
|
|
7934
|
+
[name: string]: unknown;
|
|
7808
7935
|
};
|
|
7936
|
+
content?: never;
|
|
7809
7937
|
};
|
|
7810
7938
|
401: components["responses"]["401"];
|
|
7811
7939
|
403: components["responses"]["403"];
|
|
7940
|
+
/** @description Page not found */
|
|
7941
|
+
404: {
|
|
7942
|
+
headers: {
|
|
7943
|
+
[name: string]: unknown;
|
|
7944
|
+
};
|
|
7945
|
+
content?: never;
|
|
7946
|
+
};
|
|
7812
7947
|
};
|
|
7813
7948
|
};
|
|
7814
|
-
put?: never;
|
|
7815
|
-
post?: never;
|
|
7816
7949
|
delete?: never;
|
|
7817
7950
|
options?: never;
|
|
7818
7951
|
head?: never;
|
|
7819
7952
|
patch?: never;
|
|
7820
7953
|
trace?: never;
|
|
7821
7954
|
};
|
|
7822
|
-
"/
|
|
7955
|
+
"/docs/pages/{page_id}/publish": {
|
|
7823
7956
|
parameters: {
|
|
7824
7957
|
query?: never;
|
|
7825
7958
|
header?: never;
|
|
7826
7959
|
path?: never;
|
|
7827
7960
|
cookie?: never;
|
|
7828
7961
|
};
|
|
7962
|
+
get?: never;
|
|
7963
|
+
put?: never;
|
|
7829
7964
|
/**
|
|
7830
|
-
*
|
|
7831
|
-
* @description
|
|
7965
|
+
* Publish a documentation page
|
|
7966
|
+
* @description Publish a documentation page to make it visible on the docs site.
|
|
7832
7967
|
*/
|
|
7833
|
-
|
|
7968
|
+
post: {
|
|
7834
7969
|
parameters: {
|
|
7835
7970
|
query?: never;
|
|
7836
7971
|
header?: never;
|
|
7837
7972
|
path: {
|
|
7838
|
-
/** @description The ID of the
|
|
7839
|
-
|
|
7973
|
+
/** @description The ID of the page to publish */
|
|
7974
|
+
page_id: string;
|
|
7840
7975
|
};
|
|
7841
7976
|
cookie?: never;
|
|
7842
7977
|
};
|
|
7843
|
-
requestBody
|
|
7978
|
+
requestBody: {
|
|
7979
|
+
content: {
|
|
7980
|
+
"application/json": {
|
|
7981
|
+
/** @description The ID of the repository the page belongs to */
|
|
7982
|
+
repositoryId: string;
|
|
7983
|
+
};
|
|
7984
|
+
};
|
|
7985
|
+
};
|
|
7844
7986
|
responses: {
|
|
7845
|
-
/** @description
|
|
7987
|
+
/** @description Page published successfully. */
|
|
7846
7988
|
200: {
|
|
7847
7989
|
headers: {
|
|
7848
7990
|
[name: string]: unknown;
|
|
7849
7991
|
};
|
|
7850
7992
|
content: {
|
|
7851
7993
|
"application/json": {
|
|
7852
|
-
|
|
7994
|
+
success?: boolean;
|
|
7853
7995
|
};
|
|
7854
7996
|
};
|
|
7855
7997
|
};
|
|
7998
|
+
/** @description Validation error (missing repositoryId) */
|
|
7999
|
+
400: {
|
|
8000
|
+
headers: {
|
|
8001
|
+
[name: string]: unknown;
|
|
8002
|
+
};
|
|
8003
|
+
content?: never;
|
|
8004
|
+
};
|
|
7856
8005
|
401: components["responses"]["401"];
|
|
7857
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
|
+
};
|
|
7858
8014
|
};
|
|
7859
8015
|
};
|
|
7860
|
-
put?: never;
|
|
7861
8016
|
/**
|
|
7862
|
-
*
|
|
7863
|
-
* @description
|
|
8017
|
+
* Unpublish a documentation page
|
|
8018
|
+
* @description Unpublish a documentation page to hide it from the docs site.
|
|
7864
8019
|
*/
|
|
7865
|
-
|
|
8020
|
+
delete: {
|
|
7866
8021
|
parameters: {
|
|
7867
8022
|
query?: never;
|
|
7868
8023
|
header?: never;
|
|
7869
8024
|
path: {
|
|
7870
|
-
/** @description The ID of the
|
|
7871
|
-
|
|
8025
|
+
/** @description The ID of the page to unpublish */
|
|
8026
|
+
page_id: string;
|
|
7872
8027
|
};
|
|
7873
8028
|
cookie?: never;
|
|
7874
8029
|
};
|
|
7875
|
-
requestBody
|
|
7876
|
-
content: {
|
|
7877
|
-
"application/json": {
|
|
7878
|
-
emails: string[];
|
|
7879
|
-
};
|
|
7880
|
-
};
|
|
7881
|
-
};
|
|
8030
|
+
requestBody?: never;
|
|
7882
8031
|
responses: {
|
|
7883
|
-
/** @description
|
|
8032
|
+
/** @description Page unpublished successfully. */
|
|
7884
8033
|
200: {
|
|
7885
8034
|
headers: {
|
|
7886
8035
|
[name: string]: unknown;
|
|
@@ -7893,11 +8042,437 @@ type paths = {
|
|
|
7893
8042
|
};
|
|
7894
8043
|
401: components["responses"]["401"];
|
|
7895
8044
|
403: components["responses"]["403"];
|
|
7896
|
-
|
|
7897
|
-
|
|
7898
|
-
|
|
7899
|
-
|
|
7900
|
-
|
|
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.
|
|
8076
|
+
*/
|
|
8077
|
+
post: {
|
|
8078
|
+
parameters: {
|
|
8079
|
+
query?: never;
|
|
8080
|
+
header?: never;
|
|
8081
|
+
path?: never;
|
|
8082
|
+
cookie?: never;
|
|
8083
|
+
};
|
|
8084
|
+
requestBody: {
|
|
8085
|
+
content: {
|
|
8086
|
+
"application/json": {
|
|
8087
|
+
/** @description Target collection ID for context */
|
|
8088
|
+
collectionId?: string;
|
|
8089
|
+
/** @description Target group ID for context */
|
|
8090
|
+
groupId?: string;
|
|
8091
|
+
/** @description Description of what content to generate */
|
|
8092
|
+
prompt: string;
|
|
8093
|
+
/** @description The docs repository ID */
|
|
8094
|
+
repositoryId: string;
|
|
8095
|
+
};
|
|
8096
|
+
};
|
|
8097
|
+
};
|
|
8098
|
+
responses: {
|
|
8099
|
+
/** @description Generation job started */
|
|
8100
|
+
202: {
|
|
8101
|
+
headers: {
|
|
8102
|
+
[name: string]: unknown;
|
|
8103
|
+
};
|
|
8104
|
+
content: {
|
|
8105
|
+
"application/json": components["schemas"]["DocsGenerateJobResponse"];
|
|
8106
|
+
};
|
|
8107
|
+
};
|
|
8108
|
+
/** @description Invalid request */
|
|
8109
|
+
400: {
|
|
8110
|
+
headers: {
|
|
8111
|
+
[name: string]: unknown;
|
|
8112
|
+
};
|
|
8113
|
+
content?: never;
|
|
8114
|
+
};
|
|
8115
|
+
401: components["responses"]["401"];
|
|
8116
|
+
403: components["responses"]["403"];
|
|
8117
|
+
/** @description Repository not found */
|
|
8118
|
+
404: {
|
|
8119
|
+
headers: {
|
|
8120
|
+
[name: string]: unknown;
|
|
8121
|
+
};
|
|
8122
|
+
content?: never;
|
|
8123
|
+
};
|
|
8124
|
+
};
|
|
8125
|
+
};
|
|
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
|
+
};
|
|
8139
|
+
/**
|
|
8140
|
+
* Get status of a content generation job
|
|
8141
|
+
* @description Poll this endpoint to check if AI content generation has completed.
|
|
8142
|
+
*/
|
|
8143
|
+
get: {
|
|
8144
|
+
parameters: {
|
|
8145
|
+
query?: never;
|
|
8146
|
+
header?: never;
|
|
8147
|
+
path: {
|
|
8148
|
+
/** @description The job key returned from the generate endpoint */
|
|
8149
|
+
jobKey: string;
|
|
8150
|
+
};
|
|
8151
|
+
cookie?: never;
|
|
8152
|
+
};
|
|
8153
|
+
requestBody?: never;
|
|
8154
|
+
responses: {
|
|
8155
|
+
/** @description Job status */
|
|
8156
|
+
200: {
|
|
8157
|
+
headers: {
|
|
8158
|
+
[name: string]: unknown;
|
|
8159
|
+
};
|
|
8160
|
+
content: {
|
|
8161
|
+
"application/json": components["schemas"]["DocsGenerateStatusPending"] | components["schemas"]["DocsGenerateStatusCompleted"] | components["schemas"]["DocsGenerateStatusFailed"];
|
|
8162
|
+
};
|
|
8163
|
+
};
|
|
8164
|
+
/** @description Invalid job key */
|
|
8165
|
+
400: {
|
|
8166
|
+
headers: {
|
|
8167
|
+
[name: string]: unknown;
|
|
8168
|
+
};
|
|
8169
|
+
content?: never;
|
|
8170
|
+
};
|
|
8171
|
+
401: components["responses"]["401"];
|
|
8172
|
+
/** @description Job not found or expired */
|
|
8173
|
+
404: {
|
|
8174
|
+
headers: {
|
|
8175
|
+
[name: string]: unknown;
|
|
8176
|
+
};
|
|
8177
|
+
content?: never;
|
|
8178
|
+
};
|
|
8179
|
+
};
|
|
8180
|
+
};
|
|
8181
|
+
put?: never;
|
|
8182
|
+
post?: never;
|
|
8183
|
+
delete?: never;
|
|
8184
|
+
options?: never;
|
|
8185
|
+
head?: never;
|
|
8186
|
+
patch?: never;
|
|
8187
|
+
trace?: never;
|
|
8188
|
+
};
|
|
8189
|
+
"/docs/repositories": {
|
|
8190
|
+
parameters: {
|
|
8191
|
+
query?: never;
|
|
8192
|
+
header?: never;
|
|
8193
|
+
path?: never;
|
|
8194
|
+
cookie?: never;
|
|
8195
|
+
};
|
|
8196
|
+
/**
|
|
8197
|
+
* List documentation repositories
|
|
8198
|
+
* @description Retrieve a list of documentation repositories for the authenticated organization.
|
|
8199
|
+
*/
|
|
8200
|
+
get: {
|
|
8201
|
+
parameters: {
|
|
8202
|
+
query?: {
|
|
8203
|
+
/** @description Locale for localized content (defaults to repository default) */
|
|
8204
|
+
locale?: string;
|
|
8205
|
+
};
|
|
8206
|
+
header?: never;
|
|
8207
|
+
path?: never;
|
|
8208
|
+
cookie?: never;
|
|
8209
|
+
};
|
|
8210
|
+
requestBody?: never;
|
|
8211
|
+
responses: {
|
|
8212
|
+
/** @description List of documentation repositories */
|
|
8213
|
+
200: {
|
|
8214
|
+
headers: {
|
|
8215
|
+
[name: string]: unknown;
|
|
8216
|
+
};
|
|
8217
|
+
content: {
|
|
8218
|
+
"application/json": {
|
|
8219
|
+
repositories?: components["schemas"]["DocsRepository"][];
|
|
8220
|
+
};
|
|
8221
|
+
};
|
|
8222
|
+
};
|
|
8223
|
+
401: components["responses"]["401"];
|
|
8224
|
+
403: components["responses"]["403"];
|
|
8225
|
+
};
|
|
8226
|
+
};
|
|
8227
|
+
put?: never;
|
|
8228
|
+
post?: never;
|
|
8229
|
+
delete?: never;
|
|
8230
|
+
options?: never;
|
|
8231
|
+
head?: never;
|
|
8232
|
+
patch?: never;
|
|
8233
|
+
trace?: never;
|
|
8234
|
+
};
|
|
8235
|
+
"/docs/repositories/{id}": {
|
|
8236
|
+
parameters: {
|
|
8237
|
+
query?: never;
|
|
8238
|
+
header?: never;
|
|
8239
|
+
path?: never;
|
|
8240
|
+
cookie?: never;
|
|
8241
|
+
};
|
|
8242
|
+
/**
|
|
8243
|
+
* Get a documentation repository
|
|
8244
|
+
* @description Retrieve a single documentation repository by ID.
|
|
8245
|
+
*/
|
|
8246
|
+
get: {
|
|
8247
|
+
parameters: {
|
|
8248
|
+
query?: {
|
|
8249
|
+
/** @description Locale for localized content (defaults to repository default) */
|
|
8250
|
+
locale?: string;
|
|
8251
|
+
};
|
|
8252
|
+
header?: never;
|
|
8253
|
+
path: {
|
|
8254
|
+
/** @description The ID of the repository to retrieve */
|
|
8255
|
+
id: string;
|
|
8256
|
+
};
|
|
8257
|
+
cookie?: never;
|
|
8258
|
+
};
|
|
8259
|
+
requestBody?: never;
|
|
8260
|
+
responses: {
|
|
8261
|
+
/** @description Documentation repository retrieved successfully */
|
|
8262
|
+
200: {
|
|
8263
|
+
headers: {
|
|
8264
|
+
[name: string]: unknown;
|
|
8265
|
+
};
|
|
8266
|
+
content: {
|
|
8267
|
+
"application/json": {
|
|
8268
|
+
repository?: components["schemas"]["DocsRepository"];
|
|
8269
|
+
};
|
|
8270
|
+
};
|
|
8271
|
+
};
|
|
8272
|
+
401: components["responses"]["401"];
|
|
8273
|
+
403: components["responses"]["403"];
|
|
8274
|
+
/** @description Repository not found */
|
|
8275
|
+
404: {
|
|
8276
|
+
headers: {
|
|
8277
|
+
[name: string]: unknown;
|
|
8278
|
+
};
|
|
8279
|
+
content: {
|
|
8280
|
+
"application/json": {
|
|
8281
|
+
error?: string;
|
|
8282
|
+
};
|
|
8283
|
+
};
|
|
8284
|
+
};
|
|
8285
|
+
};
|
|
8286
|
+
};
|
|
8287
|
+
put?: never;
|
|
8288
|
+
post?: never;
|
|
8289
|
+
delete?: never;
|
|
8290
|
+
options?: never;
|
|
8291
|
+
head?: never;
|
|
8292
|
+
patch?: never;
|
|
8293
|
+
trace?: never;
|
|
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
|
+
};
|
|
8354
|
+
"/email/unsubscribe_groups": {
|
|
8355
|
+
parameters: {
|
|
8356
|
+
query?: never;
|
|
8357
|
+
header?: never;
|
|
8358
|
+
path?: never;
|
|
8359
|
+
cookie?: never;
|
|
8360
|
+
};
|
|
8361
|
+
/**
|
|
8362
|
+
* List all email unsubscribe groups
|
|
8363
|
+
* @description Get a list of email unsubscribe groups.
|
|
8364
|
+
*/
|
|
8365
|
+
get: {
|
|
8366
|
+
parameters: {
|
|
8367
|
+
query?: never;
|
|
8368
|
+
header?: never;
|
|
8369
|
+
path?: never;
|
|
8370
|
+
cookie?: never;
|
|
8371
|
+
};
|
|
8372
|
+
requestBody?: never;
|
|
8373
|
+
responses: {
|
|
8374
|
+
/** @description A list of email unsubscribe groups. */
|
|
8375
|
+
200: {
|
|
8376
|
+
headers: {
|
|
8377
|
+
[name: string]: unknown;
|
|
8378
|
+
};
|
|
8379
|
+
content: {
|
|
8380
|
+
"application/json": {
|
|
8381
|
+
unsubscribeGroups: components["schemas"]["EmailUnsubscribeGroup"][];
|
|
8382
|
+
};
|
|
8383
|
+
};
|
|
8384
|
+
};
|
|
8385
|
+
401: components["responses"]["401"];
|
|
8386
|
+
403: components["responses"]["403"];
|
|
8387
|
+
};
|
|
8388
|
+
};
|
|
8389
|
+
put?: never;
|
|
8390
|
+
post?: never;
|
|
8391
|
+
delete?: never;
|
|
8392
|
+
options?: never;
|
|
8393
|
+
head?: never;
|
|
8394
|
+
patch?: never;
|
|
8395
|
+
trace?: never;
|
|
8396
|
+
};
|
|
8397
|
+
"/email/unsubscribe_groups/{id}/members": {
|
|
8398
|
+
parameters: {
|
|
8399
|
+
query?: never;
|
|
8400
|
+
header?: never;
|
|
8401
|
+
path?: never;
|
|
8402
|
+
cookie?: never;
|
|
8403
|
+
};
|
|
8404
|
+
/**
|
|
8405
|
+
* List all email unsubscribe group members
|
|
8406
|
+
* @description Get a list of email unsubscribe group members.
|
|
8407
|
+
*/
|
|
8408
|
+
get: {
|
|
8409
|
+
parameters: {
|
|
8410
|
+
query?: never;
|
|
8411
|
+
header?: never;
|
|
8412
|
+
path: {
|
|
8413
|
+
/** @description The ID of the email unsubscribe group */
|
|
8414
|
+
id: string;
|
|
8415
|
+
};
|
|
8416
|
+
cookie?: never;
|
|
8417
|
+
};
|
|
8418
|
+
requestBody?: never;
|
|
8419
|
+
responses: {
|
|
8420
|
+
/** @description A list of email unsubscribe group members. */
|
|
8421
|
+
200: {
|
|
8422
|
+
headers: {
|
|
8423
|
+
[name: string]: unknown;
|
|
8424
|
+
};
|
|
8425
|
+
content: {
|
|
8426
|
+
"application/json": {
|
|
8427
|
+
members: components["schemas"]["EmailUnsubscribeGroupMember"][];
|
|
8428
|
+
};
|
|
8429
|
+
};
|
|
8430
|
+
};
|
|
8431
|
+
401: components["responses"]["401"];
|
|
8432
|
+
403: components["responses"]["403"];
|
|
8433
|
+
};
|
|
8434
|
+
};
|
|
8435
|
+
put?: never;
|
|
8436
|
+
/**
|
|
8437
|
+
* Add email unsubscribe group members
|
|
8438
|
+
* @description Add email unsubscribe group members to a group.
|
|
8439
|
+
*/
|
|
8440
|
+
post: {
|
|
8441
|
+
parameters: {
|
|
8442
|
+
query?: never;
|
|
8443
|
+
header?: never;
|
|
8444
|
+
path: {
|
|
8445
|
+
/** @description The ID of the email unsubscribe group */
|
|
8446
|
+
id: string;
|
|
8447
|
+
};
|
|
8448
|
+
cookie?: never;
|
|
8449
|
+
};
|
|
8450
|
+
requestBody: {
|
|
8451
|
+
content: {
|
|
8452
|
+
"application/json": {
|
|
8453
|
+
emails: string[];
|
|
8454
|
+
};
|
|
8455
|
+
};
|
|
8456
|
+
};
|
|
8457
|
+
responses: {
|
|
8458
|
+
/** @description A list of email unsubscribe group members. */
|
|
8459
|
+
200: {
|
|
8460
|
+
headers: {
|
|
8461
|
+
[name: string]: unknown;
|
|
8462
|
+
};
|
|
8463
|
+
content: {
|
|
8464
|
+
"application/json": {
|
|
8465
|
+
success?: boolean;
|
|
8466
|
+
};
|
|
8467
|
+
};
|
|
8468
|
+
};
|
|
8469
|
+
401: components["responses"]["401"];
|
|
8470
|
+
403: components["responses"]["403"];
|
|
8471
|
+
};
|
|
8472
|
+
};
|
|
8473
|
+
/**
|
|
8474
|
+
* Delete email unsubscribe group members by email addresses
|
|
8475
|
+
* @description Delete email unsubscribe group members from a group.
|
|
7901
8476
|
*/
|
|
7902
8477
|
delete: {
|
|
7903
8478
|
parameters: {
|
|
@@ -10297,8 +10872,175 @@ type paths = {
|
|
|
10297
10872
|
};
|
|
10298
10873
|
};
|
|
10299
10874
|
};
|
|
10300
|
-
post?: never;
|
|
10301
|
-
delete?: never;
|
|
10875
|
+
post?: never;
|
|
10876
|
+
delete?: never;
|
|
10877
|
+
options?: never;
|
|
10878
|
+
head?: never;
|
|
10879
|
+
patch?: never;
|
|
10880
|
+
trace?: never;
|
|
10881
|
+
};
|
|
10882
|
+
"/meetings/{id}/permissions": {
|
|
10883
|
+
parameters: {
|
|
10884
|
+
query?: never;
|
|
10885
|
+
header?: never;
|
|
10886
|
+
path?: never;
|
|
10887
|
+
cookie?: never;
|
|
10888
|
+
};
|
|
10889
|
+
/**
|
|
10890
|
+
* List meeting permissions
|
|
10891
|
+
* @description Get a list of users who have been granted explicit access to a meeting.
|
|
10892
|
+
*/
|
|
10893
|
+
get: {
|
|
10894
|
+
parameters: {
|
|
10895
|
+
query?: never;
|
|
10896
|
+
header?: never;
|
|
10897
|
+
path: {
|
|
10898
|
+
/** @description The meeting ID */
|
|
10899
|
+
id: string;
|
|
10900
|
+
};
|
|
10901
|
+
cookie?: never;
|
|
10902
|
+
};
|
|
10903
|
+
requestBody?: never;
|
|
10904
|
+
responses: {
|
|
10905
|
+
/** @description List of permissions. */
|
|
10906
|
+
200: {
|
|
10907
|
+
headers: {
|
|
10908
|
+
[name: string]: unknown;
|
|
10909
|
+
};
|
|
10910
|
+
content: {
|
|
10911
|
+
"application/json": {
|
|
10912
|
+
permissions?: components["schemas"]["MeetingPermission"][];
|
|
10913
|
+
};
|
|
10914
|
+
};
|
|
10915
|
+
};
|
|
10916
|
+
401: components["responses"]["401"];
|
|
10917
|
+
403: components["responses"]["403"];
|
|
10918
|
+
/** @description Meeting not found. */
|
|
10919
|
+
404: {
|
|
10920
|
+
headers: {
|
|
10921
|
+
[name: string]: unknown;
|
|
10922
|
+
};
|
|
10923
|
+
content?: never;
|
|
10924
|
+
};
|
|
10925
|
+
};
|
|
10926
|
+
};
|
|
10927
|
+
put?: never;
|
|
10928
|
+
/**
|
|
10929
|
+
* Grant meeting permission
|
|
10930
|
+
* @description Grant a user explicit access to view a private meeting.
|
|
10931
|
+
*/
|
|
10932
|
+
post: {
|
|
10933
|
+
parameters: {
|
|
10934
|
+
query?: never;
|
|
10935
|
+
header?: never;
|
|
10936
|
+
path: {
|
|
10937
|
+
/** @description The meeting ID */
|
|
10938
|
+
id: string;
|
|
10939
|
+
};
|
|
10940
|
+
cookie?: never;
|
|
10941
|
+
};
|
|
10942
|
+
requestBody: {
|
|
10943
|
+
content: {
|
|
10944
|
+
"application/json": {
|
|
10945
|
+
/** @description The user ID to grant access to. */
|
|
10946
|
+
userId: string;
|
|
10947
|
+
};
|
|
10948
|
+
};
|
|
10949
|
+
};
|
|
10950
|
+
responses: {
|
|
10951
|
+
/** @description Permission granted. */
|
|
10952
|
+
201: {
|
|
10953
|
+
headers: {
|
|
10954
|
+
[name: string]: unknown;
|
|
10955
|
+
};
|
|
10956
|
+
content: {
|
|
10957
|
+
"application/json": {
|
|
10958
|
+
permission?: components["schemas"]["MeetingPermission"];
|
|
10959
|
+
};
|
|
10960
|
+
};
|
|
10961
|
+
};
|
|
10962
|
+
/** @description Bad request. */
|
|
10963
|
+
400: {
|
|
10964
|
+
headers: {
|
|
10965
|
+
[name: string]: unknown;
|
|
10966
|
+
};
|
|
10967
|
+
content?: never;
|
|
10968
|
+
};
|
|
10969
|
+
401: components["responses"]["401"];
|
|
10970
|
+
/** @description Not authorized to manage meeting permissions. */
|
|
10971
|
+
403: {
|
|
10972
|
+
headers: {
|
|
10973
|
+
[name: string]: unknown;
|
|
10974
|
+
};
|
|
10975
|
+
content?: never;
|
|
10976
|
+
};
|
|
10977
|
+
/** @description Meeting not found. */
|
|
10978
|
+
404: {
|
|
10979
|
+
headers: {
|
|
10980
|
+
[name: string]: unknown;
|
|
10981
|
+
};
|
|
10982
|
+
content?: never;
|
|
10983
|
+
};
|
|
10984
|
+
};
|
|
10985
|
+
};
|
|
10986
|
+
/**
|
|
10987
|
+
* Revoke meeting permission
|
|
10988
|
+
* @description Revoke a user's explicit access to a meeting.
|
|
10989
|
+
*/
|
|
10990
|
+
delete: {
|
|
10991
|
+
parameters: {
|
|
10992
|
+
query?: never;
|
|
10993
|
+
header?: never;
|
|
10994
|
+
path: {
|
|
10995
|
+
/** @description The meeting ID */
|
|
10996
|
+
id: string;
|
|
10997
|
+
};
|
|
10998
|
+
cookie?: never;
|
|
10999
|
+
};
|
|
11000
|
+
requestBody: {
|
|
11001
|
+
content: {
|
|
11002
|
+
"application/json": {
|
|
11003
|
+
/** @description The user ID to revoke access from. */
|
|
11004
|
+
userId: string;
|
|
11005
|
+
};
|
|
11006
|
+
};
|
|
11007
|
+
};
|
|
11008
|
+
responses: {
|
|
11009
|
+
/** @description Permission revoked. */
|
|
11010
|
+
200: {
|
|
11011
|
+
headers: {
|
|
11012
|
+
[name: string]: unknown;
|
|
11013
|
+
};
|
|
11014
|
+
content: {
|
|
11015
|
+
"application/json": {
|
|
11016
|
+
success?: boolean;
|
|
11017
|
+
};
|
|
11018
|
+
};
|
|
11019
|
+
};
|
|
11020
|
+
/** @description Bad request. */
|
|
11021
|
+
400: {
|
|
11022
|
+
headers: {
|
|
11023
|
+
[name: string]: unknown;
|
|
11024
|
+
};
|
|
11025
|
+
content?: never;
|
|
11026
|
+
};
|
|
11027
|
+
401: components["responses"]["401"];
|
|
11028
|
+
/** @description Not authorized to manage meeting permissions. */
|
|
11029
|
+
403: {
|
|
11030
|
+
headers: {
|
|
11031
|
+
[name: string]: unknown;
|
|
11032
|
+
};
|
|
11033
|
+
content?: never;
|
|
11034
|
+
};
|
|
11035
|
+
/** @description Meeting or permission not found. */
|
|
11036
|
+
404: {
|
|
11037
|
+
headers: {
|
|
11038
|
+
[name: string]: unknown;
|
|
11039
|
+
};
|
|
11040
|
+
content?: never;
|
|
11041
|
+
};
|
|
11042
|
+
};
|
|
11043
|
+
};
|
|
10302
11044
|
options?: never;
|
|
10303
11045
|
head?: never;
|
|
10304
11046
|
patch?: never;
|
|
@@ -10713,6 +11455,80 @@ type paths = {
|
|
|
10713
11455
|
patch?: never;
|
|
10714
11456
|
trace?: never;
|
|
10715
11457
|
};
|
|
11458
|
+
"/meetings/{id}/visibility": {
|
|
11459
|
+
parameters: {
|
|
11460
|
+
query?: never;
|
|
11461
|
+
header?: never;
|
|
11462
|
+
path?: never;
|
|
11463
|
+
cookie?: never;
|
|
11464
|
+
};
|
|
11465
|
+
get?: never;
|
|
11466
|
+
/**
|
|
11467
|
+
* Update meeting visibility
|
|
11468
|
+
* @description Update the visibility of a meeting. Only the meeting creator or organization owner can change visibility.
|
|
11469
|
+
*/
|
|
11470
|
+
put: {
|
|
11471
|
+
parameters: {
|
|
11472
|
+
query?: never;
|
|
11473
|
+
header?: never;
|
|
11474
|
+
path: {
|
|
11475
|
+
/** @description The meeting ID */
|
|
11476
|
+
id: string;
|
|
11477
|
+
};
|
|
11478
|
+
cookie?: never;
|
|
11479
|
+
};
|
|
11480
|
+
requestBody: {
|
|
11481
|
+
content: {
|
|
11482
|
+
"application/json": {
|
|
11483
|
+
/**
|
|
11484
|
+
* @description The visibility setting for the meeting.
|
|
11485
|
+
* @enum {string}
|
|
11486
|
+
*/
|
|
11487
|
+
visibility: "private" | "organization";
|
|
11488
|
+
};
|
|
11489
|
+
};
|
|
11490
|
+
};
|
|
11491
|
+
responses: {
|
|
11492
|
+
/** @description The updated meeting. */
|
|
11493
|
+
200: {
|
|
11494
|
+
headers: {
|
|
11495
|
+
[name: string]: unknown;
|
|
11496
|
+
};
|
|
11497
|
+
content: {
|
|
11498
|
+
"application/json": components["schemas"]["Meeting"];
|
|
11499
|
+
};
|
|
11500
|
+
};
|
|
11501
|
+
/** @description Bad request. */
|
|
11502
|
+
400: {
|
|
11503
|
+
headers: {
|
|
11504
|
+
[name: string]: unknown;
|
|
11505
|
+
};
|
|
11506
|
+
content?: never;
|
|
11507
|
+
};
|
|
11508
|
+
401: components["responses"]["401"];
|
|
11509
|
+
/** @description Not authorized to manage meeting visibility. */
|
|
11510
|
+
403: {
|
|
11511
|
+
headers: {
|
|
11512
|
+
[name: string]: unknown;
|
|
11513
|
+
};
|
|
11514
|
+
content?: never;
|
|
11515
|
+
};
|
|
11516
|
+
/** @description Meeting not found. */
|
|
11517
|
+
404: {
|
|
11518
|
+
headers: {
|
|
11519
|
+
[name: string]: unknown;
|
|
11520
|
+
};
|
|
11521
|
+
content?: never;
|
|
11522
|
+
};
|
|
11523
|
+
};
|
|
11524
|
+
};
|
|
11525
|
+
post?: never;
|
|
11526
|
+
delete?: never;
|
|
11527
|
+
options?: never;
|
|
11528
|
+
head?: never;
|
|
11529
|
+
patch?: never;
|
|
11530
|
+
trace?: never;
|
|
11531
|
+
};
|
|
10716
11532
|
"/metrics/sales": {
|
|
10717
11533
|
parameters: {
|
|
10718
11534
|
query?: never;
|
|
@@ -11449,33 +12265,222 @@ type paths = {
|
|
|
11449
12265
|
};
|
|
11450
12266
|
};
|
|
11451
12267
|
responses: {
|
|
11452
|
-
/** @description The created task */
|
|
11453
|
-
201: {
|
|
12268
|
+
/** @description The created task */
|
|
12269
|
+
201: {
|
|
12270
|
+
headers: {
|
|
12271
|
+
[name: string]: unknown;
|
|
12272
|
+
};
|
|
12273
|
+
content: {
|
|
12274
|
+
"application/json": components["schemas"]["Task"];
|
|
12275
|
+
};
|
|
12276
|
+
};
|
|
12277
|
+
/** @description Bad request */
|
|
12278
|
+
400: {
|
|
12279
|
+
headers: {
|
|
12280
|
+
[name: string]: unknown;
|
|
12281
|
+
};
|
|
12282
|
+
content?: never;
|
|
12283
|
+
};
|
|
12284
|
+
401: components["responses"]["401"];
|
|
12285
|
+
403: components["responses"]["403"];
|
|
12286
|
+
};
|
|
12287
|
+
};
|
|
12288
|
+
delete?: never;
|
|
12289
|
+
options?: never;
|
|
12290
|
+
head?: never;
|
|
12291
|
+
patch?: never;
|
|
12292
|
+
trace?: never;
|
|
12293
|
+
};
|
|
12294
|
+
"/tasks/{id}": {
|
|
12295
|
+
parameters: {
|
|
12296
|
+
query?: never;
|
|
12297
|
+
header?: never;
|
|
12298
|
+
path?: never;
|
|
12299
|
+
cookie?: never;
|
|
12300
|
+
};
|
|
12301
|
+
/**
|
|
12302
|
+
* Get a task by ID
|
|
12303
|
+
* @description Retrieve a task by its ID.
|
|
12304
|
+
*/
|
|
12305
|
+
get: {
|
|
12306
|
+
parameters: {
|
|
12307
|
+
query?: never;
|
|
12308
|
+
header?: never;
|
|
12309
|
+
path: {
|
|
12310
|
+
id: string;
|
|
12311
|
+
};
|
|
12312
|
+
cookie?: never;
|
|
12313
|
+
};
|
|
12314
|
+
requestBody?: never;
|
|
12315
|
+
responses: {
|
|
12316
|
+
/** @description The requested task. */
|
|
12317
|
+
200: {
|
|
12318
|
+
headers: {
|
|
12319
|
+
[name: string]: unknown;
|
|
12320
|
+
};
|
|
12321
|
+
content: {
|
|
12322
|
+
"application/json": {
|
|
12323
|
+
task?: components["schemas"]["Task"];
|
|
12324
|
+
};
|
|
12325
|
+
};
|
|
12326
|
+
};
|
|
12327
|
+
401: components["responses"]["401"];
|
|
12328
|
+
403: components["responses"]["403"];
|
|
12329
|
+
/** @description Task not found. */
|
|
12330
|
+
404: {
|
|
12331
|
+
headers: {
|
|
12332
|
+
[name: string]: unknown;
|
|
12333
|
+
};
|
|
12334
|
+
content?: never;
|
|
12335
|
+
};
|
|
12336
|
+
};
|
|
12337
|
+
};
|
|
12338
|
+
/**
|
|
12339
|
+
* Update a task by ID
|
|
12340
|
+
* @description Update an existing task by its ID. When status is set to 'complete' and the task is associated with a deal and activity, the deal may automatically progress to the next stage.
|
|
12341
|
+
*/
|
|
12342
|
+
put: {
|
|
12343
|
+
parameters: {
|
|
12344
|
+
query?: never;
|
|
12345
|
+
header?: never;
|
|
12346
|
+
path: {
|
|
12347
|
+
id: string;
|
|
12348
|
+
};
|
|
12349
|
+
cookie?: never;
|
|
12350
|
+
};
|
|
12351
|
+
requestBody: {
|
|
12352
|
+
content: {
|
|
12353
|
+
"application/json": {
|
|
12354
|
+
assigneeId?: string;
|
|
12355
|
+
dealActivityId?: string;
|
|
12356
|
+
description?: string;
|
|
12357
|
+
descriptionHtml?: string;
|
|
12358
|
+
/** Format: date-time */
|
|
12359
|
+
dueDate?: string;
|
|
12360
|
+
/** @enum {string} */
|
|
12361
|
+
priority?: "low" | "medium" | "high";
|
|
12362
|
+
reminders?: {
|
|
12363
|
+
destination?: string;
|
|
12364
|
+
/** @enum {string} */
|
|
12365
|
+
method?: "email" | "slack";
|
|
12366
|
+
/** @description Naive datetime string (e.g., "2025-01-22 12:00:00") */
|
|
12367
|
+
sendAt?: string;
|
|
12368
|
+
/** @description IANA timezone for the reminder */
|
|
12369
|
+
timezone?: string;
|
|
12370
|
+
}[];
|
|
12371
|
+
/** @enum {string} */
|
|
12372
|
+
status?: "new" | "in_progress" | "complete";
|
|
12373
|
+
tags?: string[];
|
|
12374
|
+
/** @description IANA timezone (e.g., "America/New_York") */
|
|
12375
|
+
timezone?: string;
|
|
12376
|
+
title?: string;
|
|
12377
|
+
/** @description Array of todo items. Sending this field replaces all existing items. Omit to leave items unchanged. */
|
|
12378
|
+
todoItems?: {
|
|
12379
|
+
/**
|
|
12380
|
+
* @description Whether the item is completed
|
|
12381
|
+
* @default false
|
|
12382
|
+
*/
|
|
12383
|
+
completed?: boolean;
|
|
12384
|
+
/** @description Content of the todo item */
|
|
12385
|
+
content: string;
|
|
12386
|
+
/** @description Display order */
|
|
12387
|
+
displayOrder?: number;
|
|
12388
|
+
/** @description ID of existing item to update (omit for new items) */
|
|
12389
|
+
id?: string;
|
|
12390
|
+
}[];
|
|
12391
|
+
};
|
|
12392
|
+
};
|
|
12393
|
+
};
|
|
12394
|
+
responses: {
|
|
12395
|
+
/** @description The updated task. */
|
|
12396
|
+
200: {
|
|
12397
|
+
headers: {
|
|
12398
|
+
[name: string]: unknown;
|
|
12399
|
+
};
|
|
12400
|
+
content: {
|
|
12401
|
+
"application/json": {
|
|
12402
|
+
task?: components["schemas"]["Task"];
|
|
12403
|
+
} | {
|
|
12404
|
+
dealProgressed?: boolean;
|
|
12405
|
+
dealProgression?: {
|
|
12406
|
+
dealId?: string;
|
|
12407
|
+
dealName?: string;
|
|
12408
|
+
nextStage?: {
|
|
12409
|
+
id?: string;
|
|
12410
|
+
name?: string;
|
|
12411
|
+
};
|
|
12412
|
+
previousStage?: {
|
|
12413
|
+
id?: string;
|
|
12414
|
+
name?: string;
|
|
12415
|
+
};
|
|
12416
|
+
};
|
|
12417
|
+
success?: boolean;
|
|
12418
|
+
task?: components["schemas"]["Task"];
|
|
12419
|
+
};
|
|
12420
|
+
};
|
|
12421
|
+
};
|
|
12422
|
+
/** @description Bad request (invalid status, priority, or reminder time). */
|
|
12423
|
+
400: {
|
|
12424
|
+
headers: {
|
|
12425
|
+
[name: string]: unknown;
|
|
12426
|
+
};
|
|
12427
|
+
content?: never;
|
|
12428
|
+
};
|
|
12429
|
+
401: components["responses"]["401"];
|
|
12430
|
+
403: components["responses"]["403"];
|
|
12431
|
+
/** @description Task not found. */
|
|
12432
|
+
404: {
|
|
12433
|
+
headers: {
|
|
12434
|
+
[name: string]: unknown;
|
|
12435
|
+
};
|
|
12436
|
+
content?: never;
|
|
12437
|
+
};
|
|
12438
|
+
};
|
|
12439
|
+
};
|
|
12440
|
+
post?: never;
|
|
12441
|
+
/**
|
|
12442
|
+
* Delete a task by ID
|
|
12443
|
+
* @description Delete an existing task by its ID (soft delete).
|
|
12444
|
+
*/
|
|
12445
|
+
delete: {
|
|
12446
|
+
parameters: {
|
|
12447
|
+
query?: never;
|
|
12448
|
+
header?: never;
|
|
12449
|
+
path: {
|
|
12450
|
+
id: string;
|
|
12451
|
+
};
|
|
12452
|
+
cookie?: never;
|
|
12453
|
+
};
|
|
12454
|
+
requestBody?: never;
|
|
12455
|
+
responses: {
|
|
12456
|
+
/** @description Task successfully deleted. */
|
|
12457
|
+
200: {
|
|
11454
12458
|
headers: {
|
|
11455
12459
|
[name: string]: unknown;
|
|
11456
12460
|
};
|
|
11457
12461
|
content: {
|
|
11458
|
-
"application/json":
|
|
12462
|
+
"application/json": {
|
|
12463
|
+
success?: boolean;
|
|
12464
|
+
};
|
|
11459
12465
|
};
|
|
11460
12466
|
};
|
|
11461
|
-
|
|
11462
|
-
|
|
12467
|
+
401: components["responses"]["401"];
|
|
12468
|
+
403: components["responses"]["403"];
|
|
12469
|
+
/** @description Task not found. */
|
|
12470
|
+
404: {
|
|
11463
12471
|
headers: {
|
|
11464
12472
|
[name: string]: unknown;
|
|
11465
12473
|
};
|
|
11466
12474
|
content?: never;
|
|
11467
12475
|
};
|
|
11468
|
-
401: components["responses"]["401"];
|
|
11469
|
-
403: components["responses"]["403"];
|
|
11470
12476
|
};
|
|
11471
12477
|
};
|
|
11472
|
-
delete?: never;
|
|
11473
12478
|
options?: never;
|
|
11474
12479
|
head?: never;
|
|
11475
12480
|
patch?: never;
|
|
11476
12481
|
trace?: never;
|
|
11477
12482
|
};
|
|
11478
|
-
"/tasks/{id}": {
|
|
12483
|
+
"/tasks/{id}/comments": {
|
|
11479
12484
|
parameters: {
|
|
11480
12485
|
query?: never;
|
|
11481
12486
|
header?: never;
|
|
@@ -11483,34 +12488,36 @@ type paths = {
|
|
|
11483
12488
|
cookie?: never;
|
|
11484
12489
|
};
|
|
11485
12490
|
/**
|
|
11486
|
-
*
|
|
11487
|
-
* @description Retrieve a task by
|
|
12491
|
+
* List comments for a task
|
|
12492
|
+
* @description Retrieve all comments associated with a task, ordered by creation date.
|
|
11488
12493
|
*/
|
|
11489
12494
|
get: {
|
|
11490
12495
|
parameters: {
|
|
11491
12496
|
query?: never;
|
|
11492
12497
|
header?: never;
|
|
11493
12498
|
path: {
|
|
12499
|
+
/** @description The task ID */
|
|
11494
12500
|
id: string;
|
|
11495
12501
|
};
|
|
11496
12502
|
cookie?: never;
|
|
11497
12503
|
};
|
|
11498
12504
|
requestBody?: never;
|
|
11499
12505
|
responses: {
|
|
11500
|
-
/** @description
|
|
12506
|
+
/** @description List of comments */
|
|
11501
12507
|
200: {
|
|
11502
12508
|
headers: {
|
|
11503
12509
|
[name: string]: unknown;
|
|
11504
12510
|
};
|
|
11505
12511
|
content: {
|
|
11506
12512
|
"application/json": {
|
|
11507
|
-
|
|
12513
|
+
comments?: components["schemas"]["TaskComment"][];
|
|
12514
|
+
total?: number;
|
|
11508
12515
|
};
|
|
11509
12516
|
};
|
|
11510
12517
|
};
|
|
11511
12518
|
401: components["responses"]["401"];
|
|
11512
12519
|
403: components["responses"]["403"];
|
|
11513
|
-
/** @description Task not found
|
|
12520
|
+
/** @description Task not found */
|
|
11514
12521
|
404: {
|
|
11515
12522
|
headers: {
|
|
11516
12523
|
[name: string]: unknown;
|
|
@@ -11519,15 +12526,17 @@ type paths = {
|
|
|
11519
12526
|
};
|
|
11520
12527
|
};
|
|
11521
12528
|
};
|
|
12529
|
+
put?: never;
|
|
11522
12530
|
/**
|
|
11523
|
-
*
|
|
11524
|
-
* @description
|
|
12531
|
+
* Create a comment on a task
|
|
12532
|
+
* @description Create a new comment on a task. At least one of comment or commentHtml is required.
|
|
11525
12533
|
*/
|
|
11526
|
-
|
|
12534
|
+
post: {
|
|
11527
12535
|
parameters: {
|
|
11528
12536
|
query?: never;
|
|
11529
12537
|
header?: never;
|
|
11530
12538
|
path: {
|
|
12539
|
+
/** @description The task ID */
|
|
11531
12540
|
id: string;
|
|
11532
12541
|
};
|
|
11533
12542
|
cookie?: never;
|
|
@@ -11535,75 +12544,31 @@ type paths = {
|
|
|
11535
12544
|
requestBody: {
|
|
11536
12545
|
content: {
|
|
11537
12546
|
"application/json": {
|
|
11538
|
-
|
|
11539
|
-
|
|
11540
|
-
description
|
|
11541
|
-
|
|
11542
|
-
/**
|
|
11543
|
-
|
|
11544
|
-
|
|
11545
|
-
|
|
11546
|
-
reminders?: {
|
|
11547
|
-
destination?: string;
|
|
11548
|
-
/** @enum {string} */
|
|
11549
|
-
method?: "email" | "slack";
|
|
11550
|
-
/** @description Naive datetime string (e.g., "2025-01-22 12:00:00") */
|
|
11551
|
-
sendAt?: string;
|
|
11552
|
-
/** @description IANA timezone for the reminder */
|
|
11553
|
-
timezone?: string;
|
|
11554
|
-
}[];
|
|
11555
|
-
/** @enum {string} */
|
|
11556
|
-
status?: "new" | "in_progress" | "complete";
|
|
11557
|
-
tags?: string[];
|
|
11558
|
-
/** @description IANA timezone (e.g., "America/New_York") */
|
|
11559
|
-
timezone?: string;
|
|
11560
|
-
title?: string;
|
|
11561
|
-
/** @description Array of todo items. Sending this field replaces all existing items. Omit to leave items unchanged. */
|
|
11562
|
-
todoItems?: {
|
|
11563
|
-
/**
|
|
11564
|
-
* @description Whether the item is completed
|
|
11565
|
-
* @default false
|
|
11566
|
-
*/
|
|
11567
|
-
completed?: boolean;
|
|
11568
|
-
/** @description Content of the todo item */
|
|
11569
|
-
content: string;
|
|
11570
|
-
/** @description Display order */
|
|
11571
|
-
displayOrder?: number;
|
|
11572
|
-
/** @description ID of existing item to update (omit for new items) */
|
|
11573
|
-
id?: string;
|
|
12547
|
+
/** @description The plain text content of the comment */
|
|
12548
|
+
comment?: string;
|
|
12549
|
+
/** @description The HTML-formatted content of the comment */
|
|
12550
|
+
commentHtml?: string;
|
|
12551
|
+
/** @description Users to tag in the comment */
|
|
12552
|
+
taggedUsers?: {
|
|
12553
|
+
/** @description The user ID to tag */
|
|
12554
|
+
id: string;
|
|
11574
12555
|
}[];
|
|
11575
12556
|
};
|
|
11576
12557
|
};
|
|
11577
12558
|
};
|
|
11578
12559
|
responses: {
|
|
11579
|
-
/** @description
|
|
11580
|
-
|
|
12560
|
+
/** @description Comment created */
|
|
12561
|
+
201: {
|
|
11581
12562
|
headers: {
|
|
11582
12563
|
[name: string]: unknown;
|
|
11583
12564
|
};
|
|
11584
12565
|
content: {
|
|
11585
12566
|
"application/json": {
|
|
11586
|
-
|
|
11587
|
-
} | {
|
|
11588
|
-
dealProgressed?: boolean;
|
|
11589
|
-
dealProgression?: {
|
|
11590
|
-
dealId?: string;
|
|
11591
|
-
dealName?: string;
|
|
11592
|
-
nextStage?: {
|
|
11593
|
-
id?: string;
|
|
11594
|
-
name?: string;
|
|
11595
|
-
};
|
|
11596
|
-
previousStage?: {
|
|
11597
|
-
id?: string;
|
|
11598
|
-
name?: string;
|
|
11599
|
-
};
|
|
11600
|
-
};
|
|
11601
|
-
success?: boolean;
|
|
11602
|
-
task?: components["schemas"]["Task"];
|
|
12567
|
+
comment?: components["schemas"]["TaskComment"];
|
|
11603
12568
|
};
|
|
11604
12569
|
};
|
|
11605
12570
|
};
|
|
11606
|
-
/** @description
|
|
12571
|
+
/** @description Invalid request (missing comment content) */
|
|
11607
12572
|
400: {
|
|
11608
12573
|
headers: {
|
|
11609
12574
|
[name: string]: unknown;
|
|
@@ -11612,7 +12577,81 @@ type paths = {
|
|
|
11612
12577
|
};
|
|
11613
12578
|
401: components["responses"]["401"];
|
|
11614
12579
|
403: components["responses"]["403"];
|
|
11615
|
-
/** @description Task not found
|
|
12580
|
+
/** @description Task not found */
|
|
12581
|
+
404: {
|
|
12582
|
+
headers: {
|
|
12583
|
+
[name: string]: unknown;
|
|
12584
|
+
};
|
|
12585
|
+
content?: never;
|
|
12586
|
+
};
|
|
12587
|
+
};
|
|
12588
|
+
};
|
|
12589
|
+
delete?: never;
|
|
12590
|
+
options?: never;
|
|
12591
|
+
head?: never;
|
|
12592
|
+
patch?: never;
|
|
12593
|
+
trace?: never;
|
|
12594
|
+
};
|
|
12595
|
+
"/tasks/{id}/comments/{commentId}": {
|
|
12596
|
+
parameters: {
|
|
12597
|
+
query?: never;
|
|
12598
|
+
header?: never;
|
|
12599
|
+
path?: never;
|
|
12600
|
+
cookie?: never;
|
|
12601
|
+
};
|
|
12602
|
+
get?: never;
|
|
12603
|
+
/**
|
|
12604
|
+
* Update a comment
|
|
12605
|
+
* @description Update an existing comment on a task. Only the comment author can update it.
|
|
12606
|
+
*/
|
|
12607
|
+
put: {
|
|
12608
|
+
parameters: {
|
|
12609
|
+
query?: never;
|
|
12610
|
+
header?: never;
|
|
12611
|
+
path: {
|
|
12612
|
+
/** @description The comment ID */
|
|
12613
|
+
commentId: string;
|
|
12614
|
+
/** @description The task ID */
|
|
12615
|
+
id: string;
|
|
12616
|
+
};
|
|
12617
|
+
cookie?: never;
|
|
12618
|
+
};
|
|
12619
|
+
requestBody: {
|
|
12620
|
+
content: {
|
|
12621
|
+
"application/json": {
|
|
12622
|
+
/** @description The plain text content of the comment */
|
|
12623
|
+
comment?: string;
|
|
12624
|
+
/** @description The HTML-formatted content of the comment */
|
|
12625
|
+
commentHtml?: string;
|
|
12626
|
+
/** @description Users to tag in the comment (replaces existing tags) */
|
|
12627
|
+
taggedUsers?: {
|
|
12628
|
+
/** @description The user ID to tag */
|
|
12629
|
+
id: string;
|
|
12630
|
+
}[];
|
|
12631
|
+
};
|
|
12632
|
+
};
|
|
12633
|
+
};
|
|
12634
|
+
responses: {
|
|
12635
|
+
/** @description The updated comment */
|
|
12636
|
+
200: {
|
|
12637
|
+
headers: {
|
|
12638
|
+
[name: string]: unknown;
|
|
12639
|
+
};
|
|
12640
|
+
content: {
|
|
12641
|
+
"application/json": {
|
|
12642
|
+
comment?: components["schemas"]["TaskComment"];
|
|
12643
|
+
};
|
|
12644
|
+
};
|
|
12645
|
+
};
|
|
12646
|
+
401: components["responses"]["401"];
|
|
12647
|
+
/** @description Not authorized to update this comment */
|
|
12648
|
+
403: {
|
|
12649
|
+
headers: {
|
|
12650
|
+
[name: string]: unknown;
|
|
12651
|
+
};
|
|
12652
|
+
content?: never;
|
|
12653
|
+
};
|
|
12654
|
+
/** @description Task or comment not found */
|
|
11616
12655
|
404: {
|
|
11617
12656
|
headers: {
|
|
11618
12657
|
[name: string]: unknown;
|
|
@@ -11623,21 +12662,24 @@ type paths = {
|
|
|
11623
12662
|
};
|
|
11624
12663
|
post?: never;
|
|
11625
12664
|
/**
|
|
11626
|
-
* Delete a
|
|
11627
|
-
* @description Delete
|
|
12665
|
+
* Delete a comment
|
|
12666
|
+
* @description Delete a comment from a task. Only the comment author can delete it.
|
|
11628
12667
|
*/
|
|
11629
12668
|
delete: {
|
|
11630
12669
|
parameters: {
|
|
11631
12670
|
query?: never;
|
|
11632
12671
|
header?: never;
|
|
11633
12672
|
path: {
|
|
12673
|
+
/** @description The comment ID */
|
|
12674
|
+
commentId: string;
|
|
12675
|
+
/** @description The task ID */
|
|
11634
12676
|
id: string;
|
|
11635
12677
|
};
|
|
11636
12678
|
cookie?: never;
|
|
11637
12679
|
};
|
|
11638
12680
|
requestBody?: never;
|
|
11639
12681
|
responses: {
|
|
11640
|
-
/** @description
|
|
12682
|
+
/** @description Comment deleted */
|
|
11641
12683
|
200: {
|
|
11642
12684
|
headers: {
|
|
11643
12685
|
[name: string]: unknown;
|
|
@@ -11649,8 +12691,14 @@ type paths = {
|
|
|
11649
12691
|
};
|
|
11650
12692
|
};
|
|
11651
12693
|
401: components["responses"]["401"];
|
|
11652
|
-
|
|
11653
|
-
|
|
12694
|
+
/** @description Not authorized to delete this comment */
|
|
12695
|
+
403: {
|
|
12696
|
+
headers: {
|
|
12697
|
+
[name: string]: unknown;
|
|
12698
|
+
};
|
|
12699
|
+
content?: never;
|
|
12700
|
+
};
|
|
12701
|
+
/** @description Task or comment not found */
|
|
11654
12702
|
404: {
|
|
11655
12703
|
headers: {
|
|
11656
12704
|
[name: string]: unknown;
|
|
@@ -14081,6 +15129,20 @@ type components = {
|
|
|
14081
15129
|
name?: string;
|
|
14082
15130
|
};
|
|
14083
15131
|
};
|
|
15132
|
+
Agent: {
|
|
15133
|
+
/** Format: date-time */
|
|
15134
|
+
createdAt?: string;
|
|
15135
|
+
email?: string;
|
|
15136
|
+
/** Format: uuid */
|
|
15137
|
+
id?: string;
|
|
15138
|
+
name?: string | null;
|
|
15139
|
+
/** Format: uuid */
|
|
15140
|
+
organizationId?: string;
|
|
15141
|
+
/** Format: date-time */
|
|
15142
|
+
updatedAt?: string;
|
|
15143
|
+
/** Format: uuid */
|
|
15144
|
+
userId?: string | null;
|
|
15145
|
+
};
|
|
14084
15146
|
AgentRun: {
|
|
14085
15147
|
/** @description The ID of the agent that was run. */
|
|
14086
15148
|
agentId: string;
|
|
@@ -14124,6 +15186,8 @@ type components = {
|
|
|
14124
15186
|
iconUrl?: string;
|
|
14125
15187
|
id: string;
|
|
14126
15188
|
name: string;
|
|
15189
|
+
/** @description The platform type (e.g., 'shopify', 'web'). */
|
|
15190
|
+
platform?: string;
|
|
14127
15191
|
slug?: string;
|
|
14128
15192
|
};
|
|
14129
15193
|
AppChargeWebhook: components["schemas"]["CustomerWebhook"] & components["schemas"]["TransactionWebhook"] & {
|
|
@@ -14941,6 +16005,32 @@ type components = {
|
|
|
14941
16005
|
/** Format: date-time */
|
|
14942
16006
|
updatedAt?: string;
|
|
14943
16007
|
};
|
|
16008
|
+
DocsGenerateJobResponse: {
|
|
16009
|
+
/** @description Unique key to poll for job status */
|
|
16010
|
+
jobKey?: string;
|
|
16011
|
+
/** @description URL to poll for job status */
|
|
16012
|
+
statusUrl?: string;
|
|
16013
|
+
};
|
|
16014
|
+
DocsGenerateStatusCompleted: {
|
|
16015
|
+
result?: {
|
|
16016
|
+
content?: string;
|
|
16017
|
+
seoDescription?: string;
|
|
16018
|
+
seoTitle?: string;
|
|
16019
|
+
summary?: string;
|
|
16020
|
+
title?: string;
|
|
16021
|
+
};
|
|
16022
|
+
/** @enum {string} */
|
|
16023
|
+
status?: "completed";
|
|
16024
|
+
};
|
|
16025
|
+
DocsGenerateStatusFailed: {
|
|
16026
|
+
error?: string;
|
|
16027
|
+
/** @enum {string} */
|
|
16028
|
+
status?: "failed";
|
|
16029
|
+
};
|
|
16030
|
+
DocsGenerateStatusPending: {
|
|
16031
|
+
/** @enum {string} */
|
|
16032
|
+
status?: "pending";
|
|
16033
|
+
};
|
|
14944
16034
|
/** @description A documentation group within a collection */
|
|
14945
16035
|
DocsGroup: {
|
|
14946
16036
|
/** Format: date-time */
|
|
@@ -15527,6 +16617,14 @@ type components = {
|
|
|
15527
16617
|
id?: string;
|
|
15528
16618
|
name?: string;
|
|
15529
16619
|
};
|
|
16620
|
+
MeetingPermission: {
|
|
16621
|
+
/** Format: date-time */
|
|
16622
|
+
createdAt?: string;
|
|
16623
|
+
grantedBy?: components["schemas"]["MeetingUser"];
|
|
16624
|
+
id?: string;
|
|
16625
|
+
user?: components["schemas"]["MeetingUser"];
|
|
16626
|
+
userId?: string;
|
|
16627
|
+
};
|
|
15530
16628
|
MeetingTaskSuggestion: {
|
|
15531
16629
|
/** Format: date-time */
|
|
15532
16630
|
createdAt?: string;
|
|
@@ -16348,6 +17446,8 @@ type components = {
|
|
|
16348
17446
|
* @description The due date for the task.
|
|
16349
17447
|
*/
|
|
16350
17448
|
dueDate?: string;
|
|
17449
|
+
/** @description Whether the task has any comments. */
|
|
17450
|
+
hasComments?: boolean;
|
|
16351
17451
|
/** @description The unique identifier for the task. */
|
|
16352
17452
|
id?: string;
|
|
16353
17453
|
/**
|
|
@@ -16372,6 +17472,38 @@ type components = {
|
|
|
16372
17472
|
*/
|
|
16373
17473
|
updatedAt?: string;
|
|
16374
17474
|
};
|
|
17475
|
+
TaskComment: {
|
|
17476
|
+
/** @description The plain text content of the comment. */
|
|
17477
|
+
comment?: string;
|
|
17478
|
+
/** @description The HTML-formatted content of the comment. */
|
|
17479
|
+
commentHtml?: string;
|
|
17480
|
+
/**
|
|
17481
|
+
* Format: date-time
|
|
17482
|
+
* @description The creation timestamp of the comment.
|
|
17483
|
+
*/
|
|
17484
|
+
createdAt?: string;
|
|
17485
|
+
/** @description The user who created this comment. */
|
|
17486
|
+
createdBy?: {
|
|
17487
|
+
email?: string;
|
|
17488
|
+
id?: string;
|
|
17489
|
+
name?: string;
|
|
17490
|
+
};
|
|
17491
|
+
/** @description The unique identifier for the comment. */
|
|
17492
|
+
id?: string;
|
|
17493
|
+
/** @description Users tagged in this comment. */
|
|
17494
|
+
taggedUsers?: {
|
|
17495
|
+
email?: string;
|
|
17496
|
+
id?: string;
|
|
17497
|
+
name?: string;
|
|
17498
|
+
}[];
|
|
17499
|
+
/** @description The task this comment belongs to. */
|
|
17500
|
+
taskId?: string;
|
|
17501
|
+
/**
|
|
17502
|
+
* Format: date-time
|
|
17503
|
+
* @description The last update timestamp of the comment.
|
|
17504
|
+
*/
|
|
17505
|
+
updatedAt?: string;
|
|
17506
|
+
};
|
|
16375
17507
|
TaskTodoItem: {
|
|
16376
17508
|
/** @description Whether the todo item is completed. */
|
|
16377
17509
|
completed?: boolean;
|
|
@@ -17630,6 +18762,7 @@ declare class AppsResource extends BaseResource {
|
|
|
17630
18762
|
iconUrl?: string | undefined;
|
|
17631
18763
|
id: string;
|
|
17632
18764
|
name: string;
|
|
18765
|
+
platform?: string | undefined;
|
|
17633
18766
|
slug?: string | undefined;
|
|
17634
18767
|
}[];
|
|
17635
18768
|
}>;
|
|
@@ -17645,6 +18778,7 @@ declare class AppsResource extends BaseResource {
|
|
|
17645
18778
|
iconUrl?: string | undefined;
|
|
17646
18779
|
id: string;
|
|
17647
18780
|
name: string;
|
|
18781
|
+
platform?: string | undefined;
|
|
17648
18782
|
slug?: string | undefined;
|
|
17649
18783
|
};
|
|
17650
18784
|
}>;
|
|
@@ -18094,7 +19228,9 @@ declare class AppsResource extends BaseResource {
|
|
|
18094
19228
|
}>;
|
|
18095
19229
|
listPlans(appId: string, params?: paths['/apps/{id}/plans']['get']['parameters']['query']): Promise<{
|
|
18096
19230
|
hasMore?: boolean | undefined;
|
|
18097
|
-
|
|
19231
|
+
hasNextPage?: boolean | undefined;
|
|
19232
|
+
hasPreviousPage?: boolean | undefined;
|
|
19233
|
+
nextCursor?: string | null | undefined;
|
|
18098
19234
|
plans?: {
|
|
18099
19235
|
activeTrialCount?: number | undefined;
|
|
18100
19236
|
amount?: number | undefined;
|
|
@@ -18146,6 +19282,7 @@ declare class AppsResource extends BaseResource {
|
|
|
18146
19282
|
updatedAt?: string | undefined;
|
|
18147
19283
|
visible?: boolean | undefined;
|
|
18148
19284
|
}[] | undefined;
|
|
19285
|
+
previousCursor?: string | null | undefined;
|
|
18149
19286
|
total?: number | undefined;
|
|
18150
19287
|
}>;
|
|
18151
19288
|
createPlan(appId: string, data: NonNullable<paths['/apps/{id}/plans']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
@@ -18634,6 +19771,7 @@ declare class CustomersResource extends BaseResource {
|
|
|
18634
19771
|
iconUrl?: string | undefined;
|
|
18635
19772
|
id: string;
|
|
18636
19773
|
name: string;
|
|
19774
|
+
platform?: string | undefined;
|
|
18637
19775
|
slug?: string | undefined;
|
|
18638
19776
|
} | undefined;
|
|
18639
19777
|
averageMonthlyRevenue?: number | undefined;
|
|
@@ -18813,6 +19951,7 @@ declare class CustomersResource extends BaseResource {
|
|
|
18813
19951
|
iconUrl?: string | undefined;
|
|
18814
19952
|
id: string;
|
|
18815
19953
|
name: string;
|
|
19954
|
+
platform?: string | undefined;
|
|
18816
19955
|
slug?: string | undefined;
|
|
18817
19956
|
} | undefined;
|
|
18818
19957
|
averageMonthlyRevenue?: number | undefined;
|
|
@@ -19039,6 +20178,7 @@ declare class CustomersResource extends BaseResource {
|
|
|
19039
20178
|
iconUrl?: string | undefined;
|
|
19040
20179
|
id: string;
|
|
19041
20180
|
name: string;
|
|
20181
|
+
platform?: string | undefined;
|
|
19042
20182
|
slug?: string | undefined;
|
|
19043
20183
|
} | undefined;
|
|
19044
20184
|
averageMonthlyRevenue?: number | undefined;
|
|
@@ -19218,6 +20358,7 @@ declare class CustomersResource extends BaseResource {
|
|
|
19218
20358
|
iconUrl?: string | undefined;
|
|
19219
20359
|
id: string;
|
|
19220
20360
|
name: string;
|
|
20361
|
+
platform?: string | undefined;
|
|
19221
20362
|
slug?: string | undefined;
|
|
19222
20363
|
} | undefined;
|
|
19223
20364
|
averageMonthlyRevenue?: number | undefined;
|
|
@@ -19397,6 +20538,7 @@ declare class CustomersResource extends BaseResource {
|
|
|
19397
20538
|
iconUrl?: string | undefined;
|
|
19398
20539
|
id: string;
|
|
19399
20540
|
name: string;
|
|
20541
|
+
platform?: string | undefined;
|
|
19400
20542
|
slug?: string | undefined;
|
|
19401
20543
|
} | undefined;
|
|
19402
20544
|
averageMonthlyRevenue?: number | undefined;
|
|
@@ -19576,6 +20718,7 @@ declare class CustomersResource extends BaseResource {
|
|
|
19576
20718
|
iconUrl?: string | undefined;
|
|
19577
20719
|
id: string;
|
|
19578
20720
|
name: string;
|
|
20721
|
+
platform?: string | undefined;
|
|
19579
20722
|
slug?: string | undefined;
|
|
19580
20723
|
} | undefined;
|
|
19581
20724
|
averageMonthlyRevenue?: number | undefined;
|
|
@@ -20874,13 +22017,50 @@ declare class DealsResource extends BaseResource {
|
|
|
20874
22017
|
name?: string | undefined;
|
|
20875
22018
|
} | undefined;
|
|
20876
22019
|
}[] | undefined;
|
|
20877
|
-
hasNextPage?: boolean | undefined;
|
|
20878
|
-
hasPreviousPage?: boolean | undefined;
|
|
20879
|
-
total?: number | undefined;
|
|
22020
|
+
hasNextPage?: boolean | undefined;
|
|
22021
|
+
hasPreviousPage?: boolean | undefined;
|
|
22022
|
+
total?: number | undefined;
|
|
22023
|
+
}>;
|
|
22024
|
+
}
|
|
22025
|
+
|
|
22026
|
+
declare class DocsResource extends BaseResource {
|
|
22027
|
+
getTree(params: paths['/docs/tree']['get']['parameters']['query']): Promise<{
|
|
22028
|
+
collections?: {
|
|
22029
|
+
createdAt?: string | undefined;
|
|
22030
|
+
description?: string | undefined;
|
|
22031
|
+
displayOrder?: number | undefined;
|
|
22032
|
+
groups?: {
|
|
22033
|
+
createdAt?: string | undefined;
|
|
22034
|
+
displayOrder?: number | undefined;
|
|
22035
|
+
handle?: string | undefined;
|
|
22036
|
+
id?: string | undefined;
|
|
22037
|
+
pages?: {
|
|
22038
|
+
children?: /*elided*/ any[] | undefined;
|
|
22039
|
+
depth?: number | undefined;
|
|
22040
|
+
displayOrder?: number | undefined;
|
|
22041
|
+
handle?: string | undefined;
|
|
22042
|
+
id?: string | undefined;
|
|
22043
|
+
path?: string | undefined;
|
|
22044
|
+
publishedAt?: string | undefined;
|
|
22045
|
+
title?: string | undefined;
|
|
22046
|
+
}[] | undefined;
|
|
22047
|
+
status?: "draft" | "published" | undefined;
|
|
22048
|
+
title?: string | undefined;
|
|
22049
|
+
updatedAt?: string | undefined;
|
|
22050
|
+
}[] | undefined;
|
|
22051
|
+
handles?: string[] | undefined;
|
|
22052
|
+
id?: string | undefined;
|
|
22053
|
+
status?: "draft" | "published" | undefined;
|
|
22054
|
+
title?: string | undefined;
|
|
22055
|
+
updatedAt?: string | undefined;
|
|
22056
|
+
}[] | undefined;
|
|
22057
|
+
defaultLocale?: string | undefined;
|
|
22058
|
+
handle?: string | undefined;
|
|
22059
|
+
id?: string | undefined;
|
|
22060
|
+
supportedLocales?: string[] | undefined;
|
|
22061
|
+
title?: string | undefined;
|
|
22062
|
+
visibility?: "public" | "internal" | undefined;
|
|
20880
22063
|
}>;
|
|
20881
|
-
}
|
|
20882
|
-
|
|
20883
|
-
declare class DocsResource extends BaseResource {
|
|
20884
22064
|
listCollections(params: paths['/docs/collections']['get']['parameters']['query']): Promise<{
|
|
20885
22065
|
collections?: {
|
|
20886
22066
|
createdAt?: string | undefined;
|
|
@@ -20951,6 +22131,10 @@ declare class DocsResource extends BaseResource {
|
|
|
20951
22131
|
title?: string | undefined;
|
|
20952
22132
|
updatedAt?: string | undefined;
|
|
20953
22133
|
}>;
|
|
22134
|
+
generatePage(data: NonNullable<paths['/docs/pages/generate']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
22135
|
+
jobKey?: string | undefined;
|
|
22136
|
+
statusUrl?: string | undefined;
|
|
22137
|
+
}>;
|
|
20954
22138
|
listPages(params?: paths['/docs/pages']['get']['parameters']['query']): Promise<{
|
|
20955
22139
|
pages?: {
|
|
20956
22140
|
children?: /*elided*/ any[] | undefined;
|
|
@@ -21011,6 +22195,18 @@ declare class DocsResource extends BaseResource {
|
|
|
21011
22195
|
visibility?: "public" | "internal" | undefined;
|
|
21012
22196
|
}[] | undefined;
|
|
21013
22197
|
}>;
|
|
22198
|
+
archivePage(pageId: string): Promise<{
|
|
22199
|
+
success?: boolean | undefined;
|
|
22200
|
+
}>;
|
|
22201
|
+
unarchivePage(pageId: string): Promise<{
|
|
22202
|
+
success?: boolean | undefined;
|
|
22203
|
+
}>;
|
|
22204
|
+
publishPage(pageId: string, data: NonNullable<paths['/docs/pages/{page_id}/publish']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
22205
|
+
success?: boolean | undefined;
|
|
22206
|
+
}>;
|
|
22207
|
+
unpublishPage(pageId: string): Promise<{
|
|
22208
|
+
success?: boolean | undefined;
|
|
22209
|
+
}>;
|
|
21014
22210
|
updateCollection(collectionId: string, data: NonNullable<paths['/docs/collections/{collection_id}']['put']['requestBody']>['content']['application/json']): Promise<{
|
|
21015
22211
|
createdAt?: string | undefined;
|
|
21016
22212
|
displayOrder?: number | undefined;
|
|
@@ -21101,6 +22297,21 @@ declare class DocsResource extends BaseResource {
|
|
|
21101
22297
|
deletePage(pageId: string): Promise<{
|
|
21102
22298
|
success?: boolean | undefined;
|
|
21103
22299
|
}>;
|
|
22300
|
+
getStatus(jobKey: string): Promise<{
|
|
22301
|
+
status?: "pending" | undefined;
|
|
22302
|
+
} | {
|
|
22303
|
+
result?: {
|
|
22304
|
+
content?: string | undefined;
|
|
22305
|
+
seoDescription?: string | undefined;
|
|
22306
|
+
seoTitle?: string | undefined;
|
|
22307
|
+
summary?: string | undefined;
|
|
22308
|
+
title?: string | undefined;
|
|
22309
|
+
} | undefined;
|
|
22310
|
+
status?: "completed" | undefined;
|
|
22311
|
+
} | {
|
|
22312
|
+
error?: string | undefined;
|
|
22313
|
+
status?: "failed" | undefined;
|
|
22314
|
+
}>;
|
|
21104
22315
|
getRepository(docId: string, params?: paths['/docs/repositories/{id}']['get']['parameters']['query']): Promise<{
|
|
21105
22316
|
repository?: {
|
|
21106
22317
|
collections?: {
|
|
@@ -21140,6 +22351,10 @@ declare class DocsResource extends BaseResource {
|
|
|
21140
22351
|
visibility?: "public" | "internal" | undefined;
|
|
21141
22352
|
} | undefined;
|
|
21142
22353
|
}>;
|
|
22354
|
+
regeneratePage(pageId: string, data: NonNullable<paths['/docs/pages/{page_id}/generate']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
22355
|
+
jobKey?: string | undefined;
|
|
22356
|
+
statusUrl?: string | undefined;
|
|
22357
|
+
}>;
|
|
21143
22358
|
}
|
|
21144
22359
|
|
|
21145
22360
|
declare class EmailUnsubscribeGroupsResource extends BaseResource {
|
|
@@ -21151,7 +22366,7 @@ declare class EmailUnsubscribeGroupsResource extends BaseResource {
|
|
|
21151
22366
|
name?: string | undefined;
|
|
21152
22367
|
}[];
|
|
21153
22368
|
}>;
|
|
21154
|
-
|
|
22369
|
+
deleteMember(groupId: string, memberId: string): Promise<{
|
|
21155
22370
|
success?: boolean | undefined;
|
|
21156
22371
|
}>;
|
|
21157
22372
|
listMembers(groupId: string): Promise<{
|
|
@@ -21164,6 +22379,9 @@ declare class EmailUnsubscribeGroupsResource extends BaseResource {
|
|
|
21164
22379
|
createMember(groupId: string, data: NonNullable<paths['/email/unsubscribe_groups/{id}/members']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
21165
22380
|
success?: boolean | undefined;
|
|
21166
22381
|
}>;
|
|
22382
|
+
deleteMembers(groupId: string, params: paths['/email/unsubscribe_groups/{id}/members']['delete']['parameters']['query']): Promise<{
|
|
22383
|
+
success?: boolean | undefined;
|
|
22384
|
+
}>;
|
|
21167
22385
|
}
|
|
21168
22386
|
|
|
21169
22387
|
declare class EntitiesResource extends BaseResource {
|
|
@@ -21196,6 +22414,7 @@ declare class EntitiesResource extends BaseResource {
|
|
|
21196
22414
|
iconUrl?: string | undefined;
|
|
21197
22415
|
id: string;
|
|
21198
22416
|
name: string;
|
|
22417
|
+
platform?: string | undefined;
|
|
21199
22418
|
slug?: string | undefined;
|
|
21200
22419
|
} | undefined;
|
|
21201
22420
|
averageMonthlyRevenue?: number | undefined;
|
|
@@ -21425,7 +22644,7 @@ declare class FlowExtensionsResource extends BaseResource {
|
|
|
21425
22644
|
version?: number | undefined;
|
|
21426
22645
|
}[] | undefined;
|
|
21427
22646
|
}>;
|
|
21428
|
-
|
|
22647
|
+
createTriggerByHandle(data: NonNullable<paths['/flow/extensions/triggers']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
21429
22648
|
trigger?: {
|
|
21430
22649
|
address?: string | undefined;
|
|
21431
22650
|
allVersions?: /*elided*/ any[] | undefined;
|
|
@@ -21833,6 +23052,7 @@ declare class ListsResource extends BaseResource {
|
|
|
21833
23052
|
iconUrl?: string | undefined;
|
|
21834
23053
|
id: string;
|
|
21835
23054
|
name: string;
|
|
23055
|
+
platform?: string | undefined;
|
|
21836
23056
|
slug?: string | undefined;
|
|
21837
23057
|
} | undefined;
|
|
21838
23058
|
averageMonthlyRevenue?: number | undefined;
|
|
@@ -22283,6 +23503,43 @@ declare class MeetingsResource extends BaseResource {
|
|
|
22283
23503
|
} | undefined;
|
|
22284
23504
|
updatedAt?: string | undefined;
|
|
22285
23505
|
}>;
|
|
23506
|
+
listPermissions(meetingId: string): Promise<{
|
|
23507
|
+
permissions?: {
|
|
23508
|
+
createdAt?: string | undefined;
|
|
23509
|
+
grantedBy?: {
|
|
23510
|
+
email?: string | undefined;
|
|
23511
|
+
id?: string | undefined;
|
|
23512
|
+
name?: string | undefined;
|
|
23513
|
+
} | undefined;
|
|
23514
|
+
id?: string | undefined;
|
|
23515
|
+
user?: {
|
|
23516
|
+
email?: string | undefined;
|
|
23517
|
+
id?: string | undefined;
|
|
23518
|
+
name?: string | undefined;
|
|
23519
|
+
} | undefined;
|
|
23520
|
+
userId?: string | undefined;
|
|
23521
|
+
}[] | undefined;
|
|
23522
|
+
}>;
|
|
23523
|
+
createPermission(meetingId: string, data: NonNullable<paths['/meetings/{id}/permissions']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
23524
|
+
permission?: {
|
|
23525
|
+
createdAt?: string | undefined;
|
|
23526
|
+
grantedBy?: {
|
|
23527
|
+
email?: string | undefined;
|
|
23528
|
+
id?: string | undefined;
|
|
23529
|
+
name?: string | undefined;
|
|
23530
|
+
} | undefined;
|
|
23531
|
+
id?: string | undefined;
|
|
23532
|
+
user?: {
|
|
23533
|
+
email?: string | undefined;
|
|
23534
|
+
id?: string | undefined;
|
|
23535
|
+
name?: string | undefined;
|
|
23536
|
+
} | undefined;
|
|
23537
|
+
userId?: string | undefined;
|
|
23538
|
+
} | undefined;
|
|
23539
|
+
}>;
|
|
23540
|
+
deletePermissions(meetingId: string, data: NonNullable<paths['/meetings/{id}/permissions']['delete']['requestBody']>['content']['application/json']): Promise<{
|
|
23541
|
+
success?: boolean | undefined;
|
|
23542
|
+
}>;
|
|
22286
23543
|
getRecordingUrl(meetingId: string): Promise<{
|
|
22287
23544
|
expiresIn?: number | undefined;
|
|
22288
23545
|
recordingUrl?: string | undefined;
|
|
@@ -22308,6 +23565,124 @@ declare class MeetingsResource extends BaseResource {
|
|
|
22308
23565
|
dismissTaskSuggestion(meetingId: string, suggestionId: string): Promise<{
|
|
22309
23566
|
success?: boolean | undefined;
|
|
22310
23567
|
}>;
|
|
23568
|
+
updateVisibility(meetingId: string, data: NonNullable<paths['/meetings/{id}/visibility']['put']['requestBody']>['content']['application/json']): Promise<{
|
|
23569
|
+
aiDealInsights?: {} | null | undefined;
|
|
23570
|
+
aiDecisions?: {
|
|
23571
|
+
context?: string | null | undefined;
|
|
23572
|
+
decision?: string | undefined;
|
|
23573
|
+
}[] | undefined;
|
|
23574
|
+
aiEnrichedAt?: string | null | undefined;
|
|
23575
|
+
aiEnrichmentStatus?: string | null | undefined;
|
|
23576
|
+
aiKeyPoints?: {
|
|
23577
|
+
point?: string | undefined;
|
|
23578
|
+
speaker?: string | null | undefined;
|
|
23579
|
+
timestampMs?: number | null | undefined;
|
|
23580
|
+
}[] | undefined;
|
|
23581
|
+
aiOpenQuestions?: {
|
|
23582
|
+
askedBy?: string | null | undefined;
|
|
23583
|
+
question?: string | undefined;
|
|
23584
|
+
}[] | undefined;
|
|
23585
|
+
aiSummary?: string | null | undefined;
|
|
23586
|
+
aiTopics?: {
|
|
23587
|
+
relevance?: number | undefined;
|
|
23588
|
+
topic?: string | undefined;
|
|
23589
|
+
}[] | undefined;
|
|
23590
|
+
attendees?: {
|
|
23591
|
+
color?: string | undefined;
|
|
23592
|
+
contact?: {
|
|
23593
|
+
email?: string | undefined;
|
|
23594
|
+
id?: string | undefined;
|
|
23595
|
+
name?: string | undefined;
|
|
23596
|
+
} | undefined;
|
|
23597
|
+
email?: string | undefined;
|
|
23598
|
+
engagementScore?: number | null | undefined;
|
|
23599
|
+
externalId?: string | undefined;
|
|
23600
|
+
id?: string | undefined;
|
|
23601
|
+
name?: string | undefined;
|
|
23602
|
+
sentiment?: number | null | undefined;
|
|
23603
|
+
talkTime?: number | undefined;
|
|
23604
|
+
user?: {
|
|
23605
|
+
email?: string | undefined;
|
|
23606
|
+
id?: string | undefined;
|
|
23607
|
+
name?: string | undefined;
|
|
23608
|
+
} | undefined;
|
|
23609
|
+
wordCount?: number | undefined;
|
|
23610
|
+
}[] | undefined;
|
|
23611
|
+
createdAt?: string | undefined;
|
|
23612
|
+
createdBy?: {
|
|
23613
|
+
email?: string | undefined;
|
|
23614
|
+
id?: string | undefined;
|
|
23615
|
+
name?: string | undefined;
|
|
23616
|
+
} | undefined;
|
|
23617
|
+
customer?: {
|
|
23618
|
+
email?: string | undefined;
|
|
23619
|
+
id?: string | undefined;
|
|
23620
|
+
name?: string | undefined;
|
|
23621
|
+
} | undefined;
|
|
23622
|
+
deal?: {
|
|
23623
|
+
id?: string | undefined;
|
|
23624
|
+
name?: string | undefined;
|
|
23625
|
+
} | undefined;
|
|
23626
|
+
duration?: number | undefined;
|
|
23627
|
+
endTime?: string | undefined;
|
|
23628
|
+
externalId?: string | undefined;
|
|
23629
|
+
id?: string | undefined;
|
|
23630
|
+
meetingUrl?: string | undefined;
|
|
23631
|
+
overallSentiment?: number | null | undefined;
|
|
23632
|
+
platform?: string | undefined;
|
|
23633
|
+
platformMeetingId?: string | undefined;
|
|
23634
|
+
recordingStatus?: string | undefined;
|
|
23635
|
+
recordingUrl?: string | undefined;
|
|
23636
|
+
sentimentTrend?: {
|
|
23637
|
+
sentiment?: number | undefined;
|
|
23638
|
+
timestampMs?: number | undefined;
|
|
23639
|
+
}[] | undefined;
|
|
23640
|
+
startTime?: string | undefined;
|
|
23641
|
+
summary?: string | undefined;
|
|
23642
|
+
taskSuggestions?: {
|
|
23643
|
+
createdAt?: string | undefined;
|
|
23644
|
+
createdTaskId?: string | null | undefined;
|
|
23645
|
+
description?: string | null | undefined;
|
|
23646
|
+
id?: string | undefined;
|
|
23647
|
+
priority?: string | undefined;
|
|
23648
|
+
status?: string | undefined;
|
|
23649
|
+
suggestedAssigneeId?: string | null | undefined;
|
|
23650
|
+
suggestedDueDate?: string | null | undefined;
|
|
23651
|
+
title?: string | undefined;
|
|
23652
|
+
triggerPhrase?: string | null | undefined;
|
|
23653
|
+
}[] | undefined;
|
|
23654
|
+
title?: string | undefined;
|
|
23655
|
+
transcript?: {
|
|
23656
|
+
createdAt?: string | undefined;
|
|
23657
|
+
externalId?: string | undefined;
|
|
23658
|
+
fullText?: string | undefined;
|
|
23659
|
+
id?: string | undefined;
|
|
23660
|
+
language?: string | undefined;
|
|
23661
|
+
status?: string | undefined;
|
|
23662
|
+
updatedAt?: string | undefined;
|
|
23663
|
+
utterances?: {
|
|
23664
|
+
attendee?: {
|
|
23665
|
+
email?: string | undefined;
|
|
23666
|
+
id?: string | undefined;
|
|
23667
|
+
name?: string | undefined;
|
|
23668
|
+
} | undefined;
|
|
23669
|
+
attendeeId?: string | undefined;
|
|
23670
|
+
confidence?: number | undefined;
|
|
23671
|
+
endTime?: number | undefined;
|
|
23672
|
+
id?: string | undefined;
|
|
23673
|
+
sequence?: number | undefined;
|
|
23674
|
+
startTime?: number | undefined;
|
|
23675
|
+
text?: string | undefined;
|
|
23676
|
+
words?: {
|
|
23677
|
+
confidence?: number | undefined;
|
|
23678
|
+
endTime?: number | undefined;
|
|
23679
|
+
startTime?: number | undefined;
|
|
23680
|
+
text?: string | undefined;
|
|
23681
|
+
}[] | undefined;
|
|
23682
|
+
}[] | undefined;
|
|
23683
|
+
} | undefined;
|
|
23684
|
+
updatedAt?: string | undefined;
|
|
23685
|
+
}>;
|
|
22311
23686
|
updateAttendee(meetingId: string, attendeeId: string, data: NonNullable<paths['/meetings/{id}/attendees/{attendeeId}']['put']['requestBody']>['content']['application/json']): Promise<{
|
|
22312
23687
|
attendee?: {
|
|
22313
23688
|
color?: string | undefined;
|
|
@@ -22331,7 +23706,7 @@ declare class MeetingsResource extends BaseResource {
|
|
|
22331
23706
|
wordCount?: number | undefined;
|
|
22332
23707
|
} | undefined;
|
|
22333
23708
|
}>;
|
|
22334
|
-
|
|
23709
|
+
getTranscription(meetingId: string): Promise<{
|
|
22335
23710
|
meetingId?: string | undefined;
|
|
22336
23711
|
recordingStatus?: string | undefined;
|
|
22337
23712
|
transcript?: {
|
|
@@ -22340,7 +23715,7 @@ declare class MeetingsResource extends BaseResource {
|
|
|
22340
23715
|
status?: string | undefined;
|
|
22341
23716
|
} | null | undefined;
|
|
22342
23717
|
}>;
|
|
22343
|
-
|
|
23718
|
+
transcribe(meetingId: string, data: NonNullable<paths['/meetings/{id}/transcribe']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
22344
23719
|
aiDealInsights?: {} | null | undefined;
|
|
22345
23720
|
aiDecisions?: {
|
|
22346
23721
|
context?: string | null | undefined;
|
|
@@ -23461,6 +24836,7 @@ declare class TasksResource extends BaseResource {
|
|
|
23461
24836
|
description?: string | undefined;
|
|
23462
24837
|
descriptionHtml?: string | undefined;
|
|
23463
24838
|
dueDate?: string | undefined;
|
|
24839
|
+
hasComments?: boolean | undefined;
|
|
23464
24840
|
id?: string | undefined;
|
|
23465
24841
|
priority?: "low" | "medium" | "high" | undefined;
|
|
23466
24842
|
status?: "new" | "in_progress" | "complete" | undefined;
|
|
@@ -23517,6 +24893,7 @@ declare class TasksResource extends BaseResource {
|
|
|
23517
24893
|
description?: string | undefined;
|
|
23518
24894
|
descriptionHtml?: string | undefined;
|
|
23519
24895
|
dueDate?: string | undefined;
|
|
24896
|
+
hasComments?: boolean | undefined;
|
|
23520
24897
|
id?: string | undefined;
|
|
23521
24898
|
priority?: "low" | "medium" | "high" | undefined;
|
|
23522
24899
|
status?: "new" | "in_progress" | "complete" | undefined;
|
|
@@ -23572,6 +24949,7 @@ declare class TasksResource extends BaseResource {
|
|
|
23572
24949
|
description?: string | undefined;
|
|
23573
24950
|
descriptionHtml?: string | undefined;
|
|
23574
24951
|
dueDate?: string | undefined;
|
|
24952
|
+
hasComments?: boolean | undefined;
|
|
23575
24953
|
id?: string | undefined;
|
|
23576
24954
|
priority?: "low" | "medium" | "high" | undefined;
|
|
23577
24955
|
status?: "new" | "in_progress" | "complete" | undefined;
|
|
@@ -23628,6 +25006,7 @@ declare class TasksResource extends BaseResource {
|
|
|
23628
25006
|
description?: string | undefined;
|
|
23629
25007
|
descriptionHtml?: string | undefined;
|
|
23630
25008
|
dueDate?: string | undefined;
|
|
25009
|
+
hasComments?: boolean | undefined;
|
|
23631
25010
|
id?: string | undefined;
|
|
23632
25011
|
priority?: "low" | "medium" | "high" | undefined;
|
|
23633
25012
|
status?: "new" | "in_progress" | "complete" | undefined;
|
|
@@ -23697,6 +25076,7 @@ declare class TasksResource extends BaseResource {
|
|
|
23697
25076
|
description?: string | undefined;
|
|
23698
25077
|
descriptionHtml?: string | undefined;
|
|
23699
25078
|
dueDate?: string | undefined;
|
|
25079
|
+
hasComments?: boolean | undefined;
|
|
23700
25080
|
id?: string | undefined;
|
|
23701
25081
|
priority?: "low" | "medium" | "high" | undefined;
|
|
23702
25082
|
status?: "new" | "in_progress" | "complete" | undefined;
|
|
@@ -23715,6 +25095,70 @@ declare class TasksResource extends BaseResource {
|
|
|
23715
25095
|
del(taskId: string): Promise<{
|
|
23716
25096
|
success?: boolean | undefined;
|
|
23717
25097
|
}>;
|
|
25098
|
+
updateComment(taskId: string, commentId: string, data: NonNullable<paths['/tasks/{id}/comments/{commentId}']['put']['requestBody']>['content']['application/json']): Promise<{
|
|
25099
|
+
comment?: {
|
|
25100
|
+
comment?: string | undefined;
|
|
25101
|
+
commentHtml?: string | undefined;
|
|
25102
|
+
createdAt?: string | undefined;
|
|
25103
|
+
createdBy?: {
|
|
25104
|
+
email?: string | undefined;
|
|
25105
|
+
id?: string | undefined;
|
|
25106
|
+
name?: string | undefined;
|
|
25107
|
+
} | undefined;
|
|
25108
|
+
id?: string | undefined;
|
|
25109
|
+
taggedUsers?: {
|
|
25110
|
+
email?: string | undefined;
|
|
25111
|
+
id?: string | undefined;
|
|
25112
|
+
name?: string | undefined;
|
|
25113
|
+
}[] | undefined;
|
|
25114
|
+
taskId?: string | undefined;
|
|
25115
|
+
updatedAt?: string | undefined;
|
|
25116
|
+
} | undefined;
|
|
25117
|
+
}>;
|
|
25118
|
+
deleteComment(taskId: string, commentId: string): Promise<{
|
|
25119
|
+
success?: boolean | undefined;
|
|
25120
|
+
}>;
|
|
25121
|
+
listComments(taskId: string): Promise<{
|
|
25122
|
+
comments?: {
|
|
25123
|
+
comment?: string | undefined;
|
|
25124
|
+
commentHtml?: string | undefined;
|
|
25125
|
+
createdAt?: string | undefined;
|
|
25126
|
+
createdBy?: {
|
|
25127
|
+
email?: string | undefined;
|
|
25128
|
+
id?: string | undefined;
|
|
25129
|
+
name?: string | undefined;
|
|
25130
|
+
} | undefined;
|
|
25131
|
+
id?: string | undefined;
|
|
25132
|
+
taggedUsers?: {
|
|
25133
|
+
email?: string | undefined;
|
|
25134
|
+
id?: string | undefined;
|
|
25135
|
+
name?: string | undefined;
|
|
25136
|
+
}[] | undefined;
|
|
25137
|
+
taskId?: string | undefined;
|
|
25138
|
+
updatedAt?: string | undefined;
|
|
25139
|
+
}[] | undefined;
|
|
25140
|
+
total?: number | undefined;
|
|
25141
|
+
}>;
|
|
25142
|
+
createComment(taskId: string, data: NonNullable<paths['/tasks/{id}/comments']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
25143
|
+
comment?: {
|
|
25144
|
+
comment?: string | undefined;
|
|
25145
|
+
commentHtml?: string | undefined;
|
|
25146
|
+
createdAt?: string | undefined;
|
|
25147
|
+
createdBy?: {
|
|
25148
|
+
email?: string | undefined;
|
|
25149
|
+
id?: string | undefined;
|
|
25150
|
+
name?: string | undefined;
|
|
25151
|
+
} | undefined;
|
|
25152
|
+
id?: string | undefined;
|
|
25153
|
+
taggedUsers?: {
|
|
25154
|
+
email?: string | undefined;
|
|
25155
|
+
id?: string | undefined;
|
|
25156
|
+
name?: string | undefined;
|
|
25157
|
+
}[] | undefined;
|
|
25158
|
+
taskId?: string | undefined;
|
|
25159
|
+
updatedAt?: string | undefined;
|
|
25160
|
+
} | undefined;
|
|
25161
|
+
}>;
|
|
23718
25162
|
getTodoItem(taskId: string, itemId: string): Promise<{
|
|
23719
25163
|
item?: {
|
|
23720
25164
|
completed?: boolean | undefined;
|
|
@@ -24648,21 +26092,39 @@ declare class WebhooksResource extends BaseResource {
|
|
|
24648
26092
|
}>;
|
|
24649
26093
|
}
|
|
24650
26094
|
|
|
24651
|
-
/**
|
|
24652
|
-
* Resource for CX support agents.
|
|
24653
|
-
* Note: /agents is not yet in the OpenAPI spec.
|
|
24654
|
-
*/
|
|
24655
26095
|
declare class AgentsResource extends BaseResource {
|
|
24656
|
-
list(): Promise<
|
|
24657
|
-
|
|
24658
|
-
|
|
24659
|
-
|
|
24660
|
-
|
|
24661
|
-
|
|
24662
|
-
|
|
24663
|
-
|
|
24664
|
-
|
|
24665
|
-
|
|
26096
|
+
list(params?: paths['/agents']['get']['parameters']['query']): Promise<{
|
|
26097
|
+
agents: {
|
|
26098
|
+
createdAt?: string | undefined;
|
|
26099
|
+
email?: string | undefined;
|
|
26100
|
+
id?: string | undefined;
|
|
26101
|
+
name?: string | null | undefined;
|
|
26102
|
+
organizationId?: string | undefined;
|
|
26103
|
+
updatedAt?: string | undefined;
|
|
26104
|
+
userId?: string | null | undefined;
|
|
26105
|
+
}[];
|
|
26106
|
+
}>;
|
|
26107
|
+
findOrCreate(data: NonNullable<paths['/agents']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
26108
|
+
agent?: {
|
|
26109
|
+
createdAt?: string | undefined;
|
|
26110
|
+
email?: string | undefined;
|
|
26111
|
+
id?: string | undefined;
|
|
26112
|
+
name?: string | null | undefined;
|
|
26113
|
+
organizationId?: string | undefined;
|
|
26114
|
+
updatedAt?: string | undefined;
|
|
26115
|
+
userId?: string | null | undefined;
|
|
26116
|
+
} | undefined;
|
|
26117
|
+
} | {
|
|
26118
|
+
agent?: {
|
|
26119
|
+
createdAt?: string | undefined;
|
|
26120
|
+
email?: string | undefined;
|
|
26121
|
+
id?: string | undefined;
|
|
26122
|
+
name?: string | null | undefined;
|
|
26123
|
+
organizationId?: string | undefined;
|
|
26124
|
+
updatedAt?: string | undefined;
|
|
26125
|
+
userId?: string | null | undefined;
|
|
26126
|
+
} | undefined;
|
|
26127
|
+
}>;
|
|
24666
26128
|
}
|
|
24667
26129
|
|
|
24668
26130
|
/**
|
|
@@ -24764,6 +26226,7 @@ type AffiliateReferral = components['schemas']['AffiliateReferral'];
|
|
|
24764
26226
|
type AffiliateRules = components['schemas']['AffiliateRules'];
|
|
24765
26227
|
type AffiliateRulesWebhook = components['schemas']['AffiliateRulesWebhook'];
|
|
24766
26228
|
type AffiliateWebhook = components['schemas']['AffiliateWebhook'];
|
|
26229
|
+
type Agent = components['schemas']['Agent'];
|
|
24767
26230
|
type AgentRun = components['schemas']['AgentRun'];
|
|
24768
26231
|
type App = components['schemas']['App'];
|
|
24769
26232
|
type AppChargeWebhook = components['schemas']['AppChargeWebhook'];
|
|
@@ -24810,6 +26273,10 @@ type DetailedAffiliate = components['schemas']['DetailedAffiliate'];
|
|
|
24810
26273
|
type DetailedFlow = components['schemas']['DetailedFlow'];
|
|
24811
26274
|
type DocsCollection = components['schemas']['DocsCollection'];
|
|
24812
26275
|
type DocsCollectionResponse = components['schemas']['DocsCollectionResponse'];
|
|
26276
|
+
type DocsGenerateJobResponse = components['schemas']['DocsGenerateJobResponse'];
|
|
26277
|
+
type DocsGenerateStatusCompleted = components['schemas']['DocsGenerateStatusCompleted'];
|
|
26278
|
+
type DocsGenerateStatusFailed = components['schemas']['DocsGenerateStatusFailed'];
|
|
26279
|
+
type DocsGenerateStatusPending = components['schemas']['DocsGenerateStatusPending'];
|
|
24813
26280
|
type DocsGroup = components['schemas']['DocsGroup'];
|
|
24814
26281
|
type DocsGroupResponse = components['schemas']['DocsGroupResponse'];
|
|
24815
26282
|
type DocsPage = components['schemas']['DocsPage'];
|
|
@@ -24838,6 +26305,7 @@ type MeetingAttendeeRef = components['schemas']['MeetingAttendeeRef'];
|
|
|
24838
26305
|
type MeetingContactRef = components['schemas']['MeetingContactRef'];
|
|
24839
26306
|
type MeetingCustomer = components['schemas']['MeetingCustomer'];
|
|
24840
26307
|
type MeetingDeal = components['schemas']['MeetingDeal'];
|
|
26308
|
+
type MeetingPermission = components['schemas']['MeetingPermission'];
|
|
24841
26309
|
type MeetingTaskSuggestion = components['schemas']['MeetingTaskSuggestion'];
|
|
24842
26310
|
type MeetingTranscript = components['schemas']['MeetingTranscript'];
|
|
24843
26311
|
type MeetingUser = components['schemas']['MeetingUser'];
|
|
@@ -24869,6 +26337,7 @@ type SyncedEmailDeal = components['schemas']['SyncedEmailDeal'];
|
|
|
24869
26337
|
type SyncedEmailMessage = components['schemas']['SyncedEmailMessage'];
|
|
24870
26338
|
type SyncedEmailUser = components['schemas']['SyncedEmailUser'];
|
|
24871
26339
|
type Task = components['schemas']['Task'];
|
|
26340
|
+
type TaskComment = components['schemas']['TaskComment'];
|
|
24872
26341
|
type TaskTodoItem = components['schemas']['TaskTodoItem'];
|
|
24873
26342
|
type ThreadEventType = components['schemas']['ThreadEventType'];
|
|
24874
26343
|
type ThreadMessageWebhook = components['schemas']['ThreadMessageWebhook'];
|
|
@@ -25020,4 +26489,4 @@ interface RateLimitOptions {
|
|
|
25020
26489
|
*/
|
|
25021
26490
|
declare function createRateLimitMiddleware(options?: RateLimitOptions): Middleware;
|
|
25022
26491
|
|
|
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 };
|
|
26492
|
+
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 MeetingPermission, 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 TaskComment, 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 };
|