pgbeam 0.3.0 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +67 -0
- package/dist/index.d.cts +1012 -130
- package/dist/index.d.mts +1012 -130
- package/dist/index.mjs +67 -0
- package/dist/operations.cjs +67 -0
- package/dist/operations.d.cts +886 -154
- package/dist/operations.d.mts +886 -154
- package/dist/operations.mjs +67 -0
- package/package.json +1 -1
package/dist/operations.d.mts
CHANGED
|
@@ -486,8 +486,8 @@ type AgentCredentialSecrets = {
|
|
|
486
486
|
*/
|
|
487
487
|
connection_string: string;
|
|
488
488
|
/**
|
|
489
|
-
* @description Hosted MCP endpoint
|
|
490
|
-
* @example https://
|
|
489
|
+
* @description Hosted agent-database MCP endpoint for this project, served by the edge proxy on the same per-project host the agent connects to over the wire. Paste into an MCP client (Claude Code, Cursor, …) with the mcp_token as a bearer token.
|
|
490
|
+
* @example https://abc.proxy.pgbeam.app/mcp
|
|
491
491
|
* @type string
|
|
492
492
|
*/
|
|
493
493
|
mcp_url: string;
|
|
@@ -725,6 +725,48 @@ type RevokeAgentCredentialRequestConfig = {
|
|
|
725
725
|
url: `/v1/projects/${string}/agents/${string}`;
|
|
726
726
|
};
|
|
727
727
|
|
|
728
|
+
/**
|
|
729
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
730
|
+
* Do not edit manually.
|
|
731
|
+
*/
|
|
732
|
+
|
|
733
|
+
/**
|
|
734
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
735
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
736
|
+
* @type string
|
|
737
|
+
*/
|
|
738
|
+
type RotateAgentCredentialPathProjectId = string;
|
|
739
|
+
/**
|
|
740
|
+
* @description Unique agent credential identifier (prefixed, e.g. agt_xxx).
|
|
741
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
742
|
+
* @type string
|
|
743
|
+
*/
|
|
744
|
+
type RotateAgentCredentialPathAgentId = string;
|
|
745
|
+
/**
|
|
746
|
+
* @description One-time secrets returned only at creation. The connection string and MCP token are not retrievable again.
|
|
747
|
+
* @type object
|
|
748
|
+
*/
|
|
749
|
+
type RotateAgentCredentialStatus200 = AgentCredentialSecrets;
|
|
750
|
+
/**
|
|
751
|
+
* @type object
|
|
752
|
+
*/
|
|
753
|
+
type RotateAgentCredentialRequestConfig = {
|
|
754
|
+
data?: never;
|
|
755
|
+
/**
|
|
756
|
+
* @type object
|
|
757
|
+
*/
|
|
758
|
+
pathParams: {
|
|
759
|
+
project_id: RotateAgentCredentialPathProjectId;
|
|
760
|
+
agent_id: RotateAgentCredentialPathAgentId;
|
|
761
|
+
};
|
|
762
|
+
queryParams?: never;
|
|
763
|
+
headerParams?: never;
|
|
764
|
+
/**
|
|
765
|
+
* @type string
|
|
766
|
+
*/
|
|
767
|
+
url: `/v1/projects/${string}/agents/${string}/rotate`;
|
|
768
|
+
};
|
|
769
|
+
|
|
728
770
|
/**
|
|
729
771
|
* Generated by Kubb (https://kubb.dev/).
|
|
730
772
|
* Do not edit manually.
|
|
@@ -1871,35 +1913,10 @@ type DatabaseBranch = {
|
|
|
1871
1913
|
*/
|
|
1872
1914
|
session_id?: string;
|
|
1873
1915
|
/**
|
|
1874
|
-
* @description
|
|
1916
|
+
* @description Generated name for the branch.
|
|
1875
1917
|
* @type string
|
|
1876
1918
|
*/
|
|
1877
1919
|
branch_name: string;
|
|
1878
|
-
/**
|
|
1879
|
-
* @description Branch host.
|
|
1880
|
-
* @type string | undefined
|
|
1881
|
-
*/
|
|
1882
|
-
host?: string;
|
|
1883
|
-
/**
|
|
1884
|
-
* @description Branch port.
|
|
1885
|
-
* @type integer | undefined
|
|
1886
|
-
*/
|
|
1887
|
-
port?: number;
|
|
1888
|
-
/**
|
|
1889
|
-
* @description Branch database name.
|
|
1890
|
-
* @type string | undefined
|
|
1891
|
-
*/
|
|
1892
|
-
name?: string;
|
|
1893
|
-
/**
|
|
1894
|
-
* @description Branch username.
|
|
1895
|
-
* @type string | undefined
|
|
1896
|
-
*/
|
|
1897
|
-
username?: string;
|
|
1898
|
-
/**
|
|
1899
|
-
* @description Branch provider (e.g. internal, neon).
|
|
1900
|
-
* @type string
|
|
1901
|
-
*/
|
|
1902
|
-
provider: string;
|
|
1903
1920
|
/**
|
|
1904
1921
|
* @description Provisioning state of the branch.
|
|
1905
1922
|
* @type string
|
|
@@ -3812,6 +3829,11 @@ type OnboardingProgress = {
|
|
|
3812
3829
|
* @type boolean
|
|
3813
3830
|
*/
|
|
3814
3831
|
first_query_run: boolean;
|
|
3832
|
+
/**
|
|
3833
|
+
* @description Whether an agent credential has been issued.
|
|
3834
|
+
* @type boolean
|
|
3835
|
+
*/
|
|
3836
|
+
agent_credential_created: boolean;
|
|
3815
3837
|
/**
|
|
3816
3838
|
* @description Whether the user has dismissed the onboarding checklist.
|
|
3817
3839
|
* @type boolean
|
|
@@ -3885,6 +3907,7 @@ declare const updateOnboardingRequestStepEnum: {
|
|
|
3885
3907
|
readonly connection_tested: "connection_tested";
|
|
3886
3908
|
readonly connection_string_copied: "connection_string_copied";
|
|
3887
3909
|
readonly first_query_run: "first_query_run";
|
|
3910
|
+
readonly agent_credential_created: "agent_credential_created";
|
|
3888
3911
|
};
|
|
3889
3912
|
type UpdateOnboardingRequestStepEnumKey = (typeof updateOnboardingRequestStepEnum)[keyof typeof updateOnboardingRequestStepEnum];
|
|
3890
3913
|
/**
|
|
@@ -5528,41 +5551,90 @@ type DeleteReplicaRequestConfig = {
|
|
|
5528
5551
|
* Generated by Kubb (https://kubb.dev/).
|
|
5529
5552
|
* Do not edit manually.
|
|
5530
5553
|
*/
|
|
5554
|
+
declare const supportCaseStatus: {
|
|
5555
|
+
readonly open: "open";
|
|
5556
|
+
readonly closed: "closed";
|
|
5557
|
+
};
|
|
5558
|
+
type SupportCaseStatusKey = (typeof supportCaseStatus)[keyof typeof supportCaseStatus];
|
|
5559
|
+
|
|
5531
5560
|
/**
|
|
5532
|
-
|
|
5561
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5562
|
+
* Do not edit manually.
|
|
5563
|
+
*/
|
|
5564
|
+
|
|
5565
|
+
/**
|
|
5566
|
+
* @description A support case filed by an organization member.
|
|
5533
5567
|
* @type object
|
|
5534
5568
|
*/
|
|
5535
|
-
type
|
|
5569
|
+
type SupportCase = {
|
|
5536
5570
|
/**
|
|
5537
|
-
* @description
|
|
5571
|
+
* @description Unique support case identifier (prefixed).
|
|
5572
|
+
* @example sc_01h455vb4pex5vsknk084sn02q
|
|
5538
5573
|
* @type string
|
|
5539
5574
|
*/
|
|
5540
|
-
|
|
5575
|
+
id: string;
|
|
5541
5576
|
/**
|
|
5542
|
-
* @description
|
|
5577
|
+
* @description Human-readable sequential case number.
|
|
5543
5578
|
* @type integer
|
|
5544
5579
|
*/
|
|
5545
|
-
|
|
5580
|
+
readonly case_number: number;
|
|
5546
5581
|
/**
|
|
5547
|
-
* @description
|
|
5548
|
-
* @type
|
|
5582
|
+
* @description Organization that owns this case.
|
|
5583
|
+
* @type string
|
|
5549
5584
|
*/
|
|
5550
|
-
|
|
5585
|
+
org_id: string;
|
|
5551
5586
|
/**
|
|
5552
|
-
* @description
|
|
5553
|
-
* @type
|
|
5587
|
+
* @description User who created the case.
|
|
5588
|
+
* @type string
|
|
5554
5589
|
*/
|
|
5555
|
-
|
|
5590
|
+
user_id: string;
|
|
5556
5591
|
/**
|
|
5557
|
-
* @description
|
|
5558
|
-
* @type
|
|
5592
|
+
* @description Brief summary of the issue.
|
|
5593
|
+
* @type string
|
|
5559
5594
|
*/
|
|
5560
|
-
|
|
5595
|
+
title: string;
|
|
5561
5596
|
/**
|
|
5562
|
-
* @description
|
|
5597
|
+
* @description Severity level: 1=Critical, 2=High, 3=Normal, 4=Low.
|
|
5598
|
+
* @minLength 1
|
|
5599
|
+
* @maxLength 4
|
|
5563
5600
|
* @type integer
|
|
5564
5601
|
*/
|
|
5565
|
-
|
|
5602
|
+
severity: number;
|
|
5603
|
+
/**
|
|
5604
|
+
* @description Current status of the support case.
|
|
5605
|
+
* @type string
|
|
5606
|
+
*/
|
|
5607
|
+
status: SupportCaseStatusKey;
|
|
5608
|
+
/**
|
|
5609
|
+
* @description Slack channel where the case thread lives.
|
|
5610
|
+
* @type string | undefined
|
|
5611
|
+
*/
|
|
5612
|
+
slack_channel_id?: string;
|
|
5613
|
+
/**
|
|
5614
|
+
* @description Slack thread timestamp for the case.
|
|
5615
|
+
* @type string | undefined
|
|
5616
|
+
*/
|
|
5617
|
+
slack_thread_ts?: string;
|
|
5618
|
+
/**
|
|
5619
|
+
* @description When the case was created.
|
|
5620
|
+
* @type string
|
|
5621
|
+
*/
|
|
5622
|
+
created_at: string;
|
|
5623
|
+
/**
|
|
5624
|
+
* @description When the case was last updated.
|
|
5625
|
+
* @type string
|
|
5626
|
+
*/
|
|
5627
|
+
updated_at: string;
|
|
5628
|
+
/**
|
|
5629
|
+
* @description When the case was closed, if applicable.
|
|
5630
|
+
* @type string
|
|
5631
|
+
*/
|
|
5632
|
+
closed_at?: string | null;
|
|
5633
|
+
/**
|
|
5634
|
+
* @description Number of messages in the case.
|
|
5635
|
+
* @type integer | undefined
|
|
5636
|
+
*/
|
|
5637
|
+
readonly message_count?: number;
|
|
5566
5638
|
};
|
|
5567
5639
|
|
|
5568
5640
|
/**
|
|
@@ -5571,15 +5643,20 @@ type DailyUsage = {
|
|
|
5571
5643
|
*/
|
|
5572
5644
|
|
|
5573
5645
|
/**
|
|
5574
|
-
* @description
|
|
5646
|
+
* @description Paginated list of support cases.
|
|
5575
5647
|
* @type object
|
|
5576
5648
|
*/
|
|
5577
|
-
type
|
|
5649
|
+
type ListSupportCasesResponse = {
|
|
5578
5650
|
/**
|
|
5579
|
-
* @description
|
|
5651
|
+
* @description Support cases for the current page.
|
|
5580
5652
|
* @type array
|
|
5581
5653
|
*/
|
|
5582
|
-
|
|
5654
|
+
cases: SupportCase[];
|
|
5655
|
+
/**
|
|
5656
|
+
* @description Total number of cases matching the filter.
|
|
5657
|
+
* @type integer
|
|
5658
|
+
*/
|
|
5659
|
+
total: number;
|
|
5583
5660
|
};
|
|
5584
5661
|
|
|
5585
5662
|
/**
|
|
@@ -5593,47 +5670,62 @@ type UsageResponse = {
|
|
|
5593
5670
|
* @example org_abc123
|
|
5594
5671
|
* @type string
|
|
5595
5672
|
*/
|
|
5596
|
-
type
|
|
5673
|
+
type ListSupportCasesPathOrgId = string;
|
|
5597
5674
|
/**
|
|
5598
|
-
* @description
|
|
5599
|
-
* @
|
|
5600
|
-
* @type string
|
|
5675
|
+
* @description Filter by case status.
|
|
5676
|
+
* @type string | undefined
|
|
5601
5677
|
*/
|
|
5602
|
-
type
|
|
5678
|
+
type ListSupportCasesQueryStatus = SupportCaseStatusKey | undefined;
|
|
5603
5679
|
/**
|
|
5604
|
-
* @description
|
|
5605
|
-
* @
|
|
5606
|
-
* @type string
|
|
5680
|
+
* @description Search cases by title.
|
|
5681
|
+
* @type string | undefined
|
|
5607
5682
|
*/
|
|
5608
|
-
type
|
|
5683
|
+
type ListSupportCasesQuerySearch = string | undefined;
|
|
5609
5684
|
/**
|
|
5610
|
-
* @description
|
|
5685
|
+
* @description Number of results per page (1-100, default 20).
|
|
5686
|
+
* @minLength 1
|
|
5687
|
+
* @maxLength 100
|
|
5688
|
+
* @default 20
|
|
5689
|
+
* @type integer | undefined
|
|
5690
|
+
*/
|
|
5691
|
+
type ListSupportCasesQueryPageSize = number | undefined;
|
|
5692
|
+
/**
|
|
5693
|
+
* @description Page number (1-based, default 1).
|
|
5694
|
+
* @minLength 1
|
|
5695
|
+
* @default 1
|
|
5696
|
+
* @type integer | undefined
|
|
5697
|
+
*/
|
|
5698
|
+
type ListSupportCasesQueryPage = number | undefined;
|
|
5699
|
+
/**
|
|
5700
|
+
* @description Paginated list of support cases.
|
|
5611
5701
|
* @type object
|
|
5612
5702
|
*/
|
|
5613
|
-
type
|
|
5703
|
+
type ListSupportCasesStatus200 = ListSupportCasesResponse;
|
|
5614
5704
|
/**
|
|
5615
5705
|
* @type object
|
|
5616
5706
|
*/
|
|
5617
|
-
type
|
|
5707
|
+
type ListSupportCasesRequestConfig = {
|
|
5618
5708
|
data?: never;
|
|
5619
5709
|
/**
|
|
5620
5710
|
* @type object
|
|
5621
5711
|
*/
|
|
5622
5712
|
pathParams: {
|
|
5623
|
-
org_id:
|
|
5713
|
+
org_id: ListSupportCasesPathOrgId;
|
|
5624
5714
|
};
|
|
5625
5715
|
/**
|
|
5626
5716
|
* @type object | undefined
|
|
5627
5717
|
*/
|
|
5628
5718
|
queryParams?: {
|
|
5629
|
-
|
|
5630
|
-
|
|
5719
|
+
status?: ListSupportCasesQueryStatus;
|
|
5720
|
+
search?: ListSupportCasesQuerySearch;
|
|
5721
|
+
page_size?: ListSupportCasesQueryPageSize;
|
|
5722
|
+
page?: ListSupportCasesQueryPage;
|
|
5631
5723
|
};
|
|
5632
5724
|
headerParams?: never;
|
|
5633
5725
|
/**
|
|
5634
5726
|
* @type string
|
|
5635
5727
|
*/
|
|
5636
|
-
url: `/v1/organizations/${string}/
|
|
5728
|
+
url: `/v1/organizations/${string}/support/cases`;
|
|
5637
5729
|
};
|
|
5638
5730
|
|
|
5639
5731
|
/**
|
|
@@ -5641,62 +5733,37 @@ type GetOrganizationUsageRequestConfig = {
|
|
|
5641
5733
|
* Do not edit manually.
|
|
5642
5734
|
*/
|
|
5643
5735
|
/**
|
|
5644
|
-
* @description
|
|
5736
|
+
* @description Request body for creating a support case.
|
|
5645
5737
|
* @type object
|
|
5646
5738
|
*/
|
|
5647
|
-
type
|
|
5739
|
+
type CreateSupportCaseRequest = {
|
|
5648
5740
|
/**
|
|
5649
|
-
* @description
|
|
5741
|
+
* @description Organization ID.
|
|
5650
5742
|
* @type string
|
|
5651
5743
|
*/
|
|
5652
|
-
|
|
5744
|
+
org_id: string;
|
|
5653
5745
|
/**
|
|
5654
|
-
* @description
|
|
5746
|
+
* @description Brief summary of the issue.
|
|
5747
|
+
* @minLength 1
|
|
5748
|
+
* @maxLength 500
|
|
5655
5749
|
* @type string
|
|
5656
5750
|
*/
|
|
5657
|
-
|
|
5658
|
-
/**
|
|
5659
|
-
* @description Total queries served on the day.
|
|
5660
|
-
* @type integer
|
|
5661
|
-
*/
|
|
5662
|
-
queries_total: number;
|
|
5663
|
-
/**
|
|
5664
|
-
* @description Total cache hits on the day.
|
|
5665
|
-
* @type integer
|
|
5666
|
-
*/
|
|
5667
|
-
cache_hits: number;
|
|
5668
|
-
/**
|
|
5669
|
-
* @description Total cache misses on the day.
|
|
5670
|
-
* @type integer
|
|
5671
|
-
*/
|
|
5672
|
-
cache_misses: number;
|
|
5673
|
-
/**
|
|
5674
|
-
* @description Total proxy connection time consumed on the day.
|
|
5675
|
-
* @type integer
|
|
5676
|
-
*/
|
|
5677
|
-
connection_seconds: number;
|
|
5751
|
+
title: string;
|
|
5678
5752
|
/**
|
|
5679
|
-
* @description
|
|
5680
|
-
* @
|
|
5753
|
+
* @description Severity level: 1=Critical, 2=High, 3=Normal, 4=Low.
|
|
5754
|
+
* @minLength 1
|
|
5755
|
+
* @maxLength 4
|
|
5756
|
+
* @default 4
|
|
5757
|
+
* @type integer | undefined
|
|
5681
5758
|
*/
|
|
5682
|
-
|
|
5683
|
-
};
|
|
5684
|
-
|
|
5685
|
-
/**
|
|
5686
|
-
* Generated by Kubb (https://kubb.dev/).
|
|
5687
|
-
* Do not edit manually.
|
|
5688
|
-
*/
|
|
5689
|
-
|
|
5690
|
-
/**
|
|
5691
|
-
* @description Response envelope for project usage queries.
|
|
5692
|
-
* @type object
|
|
5693
|
-
*/
|
|
5694
|
-
type ProjectUsageResponse = {
|
|
5759
|
+
severity?: number;
|
|
5695
5760
|
/**
|
|
5696
|
-
* @description
|
|
5697
|
-
* @
|
|
5761
|
+
* @description Initial message body.
|
|
5762
|
+
* @minLength 1
|
|
5763
|
+
* @maxLength 50000
|
|
5764
|
+
* @type string
|
|
5698
5765
|
*/
|
|
5699
|
-
|
|
5766
|
+
body: string;
|
|
5700
5767
|
};
|
|
5701
5768
|
|
|
5702
5769
|
/**
|
|
@@ -5705,96 +5772,630 @@ type ProjectUsageResponse = {
|
|
|
5705
5772
|
*/
|
|
5706
5773
|
|
|
5707
5774
|
/**
|
|
5708
|
-
* @description Unique
|
|
5775
|
+
* @description Unique organization identifier.
|
|
5709
5776
|
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5777
|
+
* @example org_abc123
|
|
5710
5778
|
* @type string
|
|
5711
5779
|
*/
|
|
5712
|
-
type
|
|
5713
|
-
/**
|
|
5714
|
-
* @description Start date (inclusive, YYYY-MM-DD).
|
|
5715
|
-
* @example 2024-01-01
|
|
5716
|
-
* @type string
|
|
5717
|
-
*/
|
|
5718
|
-
type GetProjectUsageQueryStartDate = string;
|
|
5780
|
+
type CreateSupportCasePathOrgId = string;
|
|
5719
5781
|
/**
|
|
5720
|
-
* @description
|
|
5721
|
-
* @
|
|
5722
|
-
* @type string
|
|
5782
|
+
* @description A support case filed by an organization member.
|
|
5783
|
+
* @type object
|
|
5723
5784
|
*/
|
|
5724
|
-
type
|
|
5785
|
+
type CreateSupportCaseStatus201 = SupportCase;
|
|
5725
5786
|
/**
|
|
5726
|
-
* @description
|
|
5787
|
+
* @description Request body for creating a support case.
|
|
5727
5788
|
* @type object
|
|
5728
5789
|
*/
|
|
5729
|
-
type
|
|
5790
|
+
type CreateSupportCaseData = CreateSupportCaseRequest;
|
|
5730
5791
|
/**
|
|
5731
5792
|
* @type object
|
|
5732
5793
|
*/
|
|
5733
|
-
type
|
|
5734
|
-
data?:
|
|
5794
|
+
type CreateSupportCaseRequestConfig = {
|
|
5795
|
+
data?: CreateSupportCaseData;
|
|
5735
5796
|
/**
|
|
5736
5797
|
* @type object
|
|
5737
5798
|
*/
|
|
5738
5799
|
pathParams: {
|
|
5739
|
-
|
|
5740
|
-
};
|
|
5741
|
-
/**
|
|
5742
|
-
* @type object | undefined
|
|
5743
|
-
*/
|
|
5744
|
-
queryParams?: {
|
|
5745
|
-
start_date: GetProjectUsageQueryStartDate;
|
|
5746
|
-
end_date: GetProjectUsageQueryEndDate;
|
|
5800
|
+
org_id: CreateSupportCasePathOrgId;
|
|
5747
5801
|
};
|
|
5802
|
+
queryParams?: never;
|
|
5748
5803
|
headerParams?: never;
|
|
5749
5804
|
/**
|
|
5750
5805
|
* @type string
|
|
5751
5806
|
*/
|
|
5752
|
-
url: `/v1/
|
|
5807
|
+
url: `/v1/organizations/${string}/support/cases`;
|
|
5753
5808
|
};
|
|
5754
5809
|
|
|
5755
5810
|
/**
|
|
5756
5811
|
* Generated by Kubb (https://kubb.dev/).
|
|
5757
5812
|
* Do not edit manually.
|
|
5758
5813
|
*/
|
|
5759
|
-
declare const
|
|
5760
|
-
readonly
|
|
5761
|
-
readonly
|
|
5762
|
-
readonly datadog: "datadog";
|
|
5763
|
-
readonly elastic: "elastic";
|
|
5814
|
+
declare const supportMessageSource: {
|
|
5815
|
+
readonly user: "user";
|
|
5816
|
+
readonly slack: "slack";
|
|
5764
5817
|
};
|
|
5765
|
-
type
|
|
5818
|
+
type SupportMessageSourceKey = (typeof supportMessageSource)[keyof typeof supportMessageSource];
|
|
5819
|
+
|
|
5766
5820
|
/**
|
|
5767
|
-
|
|
5821
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5822
|
+
* Do not edit manually.
|
|
5823
|
+
*/
|
|
5824
|
+
|
|
5825
|
+
/**
|
|
5826
|
+
* @description A message within a support case thread.
|
|
5768
5827
|
* @type object
|
|
5769
5828
|
*/
|
|
5770
|
-
type
|
|
5829
|
+
type SupportMessage = {
|
|
5771
5830
|
/**
|
|
5772
|
-
* @description Unique
|
|
5773
|
-
* @example
|
|
5831
|
+
* @description Unique message identifier (prefixed).
|
|
5832
|
+
* @example sm_01h455vb4pex5vsknk084sn02q
|
|
5774
5833
|
* @type string
|
|
5775
5834
|
*/
|
|
5776
5835
|
id: string;
|
|
5777
5836
|
/**
|
|
5778
|
-
* @description
|
|
5837
|
+
* @description Parent support case ID.
|
|
5779
5838
|
* @type string
|
|
5780
5839
|
*/
|
|
5781
|
-
|
|
5840
|
+
case_id: string;
|
|
5782
5841
|
/**
|
|
5783
|
-
* @description
|
|
5784
|
-
* @example https://example.com/hooks/pgbeam
|
|
5842
|
+
* @description Origin of the message.
|
|
5785
5843
|
* @type string
|
|
5786
5844
|
*/
|
|
5787
|
-
|
|
5845
|
+
source: SupportMessageSourceKey;
|
|
5788
5846
|
/**
|
|
5789
|
-
* @description
|
|
5847
|
+
* @description Display name of the message author.
|
|
5790
5848
|
* @type string
|
|
5791
5849
|
*/
|
|
5792
|
-
|
|
5850
|
+
author_name: string;
|
|
5793
5851
|
/**
|
|
5794
|
-
* @description
|
|
5795
|
-
* @type
|
|
5852
|
+
* @description URL to the author\'s avatar.
|
|
5853
|
+
* @type string
|
|
5796
5854
|
*/
|
|
5797
|
-
|
|
5855
|
+
author_image?: string | null;
|
|
5856
|
+
/**
|
|
5857
|
+
* @description Message content.
|
|
5858
|
+
* @type string
|
|
5859
|
+
*/
|
|
5860
|
+
body: string;
|
|
5861
|
+
/**
|
|
5862
|
+
* @description Slack user ID (for Slack-sourced messages).
|
|
5863
|
+
* @type string
|
|
5864
|
+
*/
|
|
5865
|
+
slack_user_id?: string | null;
|
|
5866
|
+
/**
|
|
5867
|
+
* @description When the message was created.
|
|
5868
|
+
* @type string
|
|
5869
|
+
*/
|
|
5870
|
+
created_at: string;
|
|
5871
|
+
};
|
|
5872
|
+
|
|
5873
|
+
/**
|
|
5874
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5875
|
+
* Do not edit manually.
|
|
5876
|
+
*/
|
|
5877
|
+
|
|
5878
|
+
/**
|
|
5879
|
+
* @description Support case with its message thread.
|
|
5880
|
+
* @type object
|
|
5881
|
+
*/
|
|
5882
|
+
type GetSupportCaseResponse = {
|
|
5883
|
+
/**
|
|
5884
|
+
* @description A support case filed by an organization member.
|
|
5885
|
+
* @type object
|
|
5886
|
+
*/
|
|
5887
|
+
case: SupportCase;
|
|
5888
|
+
/**
|
|
5889
|
+
* @description Messages in the support case thread.
|
|
5890
|
+
* @type array
|
|
5891
|
+
*/
|
|
5892
|
+
messages: SupportMessage[];
|
|
5893
|
+
};
|
|
5894
|
+
|
|
5895
|
+
/**
|
|
5896
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5897
|
+
* Do not edit manually.
|
|
5898
|
+
*/
|
|
5899
|
+
|
|
5900
|
+
/**
|
|
5901
|
+
* @description Unique organization identifier.
|
|
5902
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5903
|
+
* @example org_abc123
|
|
5904
|
+
* @type string
|
|
5905
|
+
*/
|
|
5906
|
+
type GetSupportCasePathOrgId = string;
|
|
5907
|
+
/**
|
|
5908
|
+
* @description Unique support case identifier (prefixed, e.g. sc_xxx).
|
|
5909
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5910
|
+
* @type string
|
|
5911
|
+
*/
|
|
5912
|
+
type GetSupportCasePathCaseId = string;
|
|
5913
|
+
/**
|
|
5914
|
+
* @description Support case with its message thread.
|
|
5915
|
+
* @type object
|
|
5916
|
+
*/
|
|
5917
|
+
type GetSupportCaseStatus200 = GetSupportCaseResponse;
|
|
5918
|
+
/**
|
|
5919
|
+
* @type object
|
|
5920
|
+
*/
|
|
5921
|
+
type GetSupportCaseRequestConfig = {
|
|
5922
|
+
data?: never;
|
|
5923
|
+
/**
|
|
5924
|
+
* @type object
|
|
5925
|
+
*/
|
|
5926
|
+
pathParams: {
|
|
5927
|
+
org_id: GetSupportCasePathOrgId;
|
|
5928
|
+
case_id: GetSupportCasePathCaseId;
|
|
5929
|
+
};
|
|
5930
|
+
queryParams?: never;
|
|
5931
|
+
headerParams?: never;
|
|
5932
|
+
/**
|
|
5933
|
+
* @type string
|
|
5934
|
+
*/
|
|
5935
|
+
url: `/v1/organizations/${string}/support/cases/${string}`;
|
|
5936
|
+
};
|
|
5937
|
+
|
|
5938
|
+
/**
|
|
5939
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5940
|
+
* Do not edit manually.
|
|
5941
|
+
*/
|
|
5942
|
+
|
|
5943
|
+
/**
|
|
5944
|
+
* @description Request body for updating a support case status.
|
|
5945
|
+
* @type object
|
|
5946
|
+
*/
|
|
5947
|
+
type UpdateSupportCaseRequest = {
|
|
5948
|
+
/**
|
|
5949
|
+
* @description Current status of the support case.
|
|
5950
|
+
* @type string | undefined
|
|
5951
|
+
*/
|
|
5952
|
+
status?: SupportCaseStatusKey;
|
|
5953
|
+
};
|
|
5954
|
+
|
|
5955
|
+
/**
|
|
5956
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5957
|
+
* Do not edit manually.
|
|
5958
|
+
*/
|
|
5959
|
+
|
|
5960
|
+
/**
|
|
5961
|
+
* @description Unique organization identifier.
|
|
5962
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5963
|
+
* @example org_abc123
|
|
5964
|
+
* @type string
|
|
5965
|
+
*/
|
|
5966
|
+
type UpdateSupportCasePathOrgId = string;
|
|
5967
|
+
/**
|
|
5968
|
+
* @description Unique support case identifier (prefixed, e.g. sc_xxx).
|
|
5969
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5970
|
+
* @type string
|
|
5971
|
+
*/
|
|
5972
|
+
type UpdateSupportCasePathCaseId = string;
|
|
5973
|
+
/**
|
|
5974
|
+
* @description A support case filed by an organization member.
|
|
5975
|
+
* @type object
|
|
5976
|
+
*/
|
|
5977
|
+
type UpdateSupportCaseStatus200 = SupportCase;
|
|
5978
|
+
/**
|
|
5979
|
+
* @description Request body for updating a support case status.
|
|
5980
|
+
* @type object
|
|
5981
|
+
*/
|
|
5982
|
+
type UpdateSupportCaseData = UpdateSupportCaseRequest;
|
|
5983
|
+
/**
|
|
5984
|
+
* @type object
|
|
5985
|
+
*/
|
|
5986
|
+
type UpdateSupportCaseRequestConfig = {
|
|
5987
|
+
data?: UpdateSupportCaseData;
|
|
5988
|
+
/**
|
|
5989
|
+
* @type object
|
|
5990
|
+
*/
|
|
5991
|
+
pathParams: {
|
|
5992
|
+
org_id: UpdateSupportCasePathOrgId;
|
|
5993
|
+
case_id: UpdateSupportCasePathCaseId;
|
|
5994
|
+
};
|
|
5995
|
+
queryParams?: never;
|
|
5996
|
+
headerParams?: never;
|
|
5997
|
+
/**
|
|
5998
|
+
* @type string
|
|
5999
|
+
*/
|
|
6000
|
+
url: `/v1/organizations/${string}/support/cases/${string}`;
|
|
6001
|
+
};
|
|
6002
|
+
|
|
6003
|
+
/**
|
|
6004
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6005
|
+
* Do not edit manually.
|
|
6006
|
+
*/
|
|
6007
|
+
/**
|
|
6008
|
+
* @description Request body for adding a message to a support case.
|
|
6009
|
+
* @type object
|
|
6010
|
+
*/
|
|
6011
|
+
type CreateSupportMessageRequest = {
|
|
6012
|
+
/**
|
|
6013
|
+
* @description Message content.
|
|
6014
|
+
* @minLength 1
|
|
6015
|
+
* @maxLength 50000
|
|
6016
|
+
* @type string
|
|
6017
|
+
*/
|
|
6018
|
+
body: string;
|
|
6019
|
+
};
|
|
6020
|
+
|
|
6021
|
+
/**
|
|
6022
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6023
|
+
* Do not edit manually.
|
|
6024
|
+
*/
|
|
6025
|
+
|
|
6026
|
+
/**
|
|
6027
|
+
* @description Unique organization identifier.
|
|
6028
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
6029
|
+
* @example org_abc123
|
|
6030
|
+
* @type string
|
|
6031
|
+
*/
|
|
6032
|
+
type CreateSupportMessagePathOrgId = string;
|
|
6033
|
+
/**
|
|
6034
|
+
* @description Unique support case identifier (prefixed, e.g. sc_xxx).
|
|
6035
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
6036
|
+
* @type string
|
|
6037
|
+
*/
|
|
6038
|
+
type CreateSupportMessagePathCaseId = string;
|
|
6039
|
+
/**
|
|
6040
|
+
* @description A message within a support case thread.
|
|
6041
|
+
* @type object
|
|
6042
|
+
*/
|
|
6043
|
+
type CreateSupportMessageStatus201 = SupportMessage;
|
|
6044
|
+
/**
|
|
6045
|
+
* @description Request body for adding a message to a support case.
|
|
6046
|
+
* @type object
|
|
6047
|
+
*/
|
|
6048
|
+
type CreateSupportMessageData = CreateSupportMessageRequest;
|
|
6049
|
+
/**
|
|
6050
|
+
* @type object
|
|
6051
|
+
*/
|
|
6052
|
+
type CreateSupportMessageRequestConfig = {
|
|
6053
|
+
data?: CreateSupportMessageData;
|
|
6054
|
+
/**
|
|
6055
|
+
* @type object
|
|
6056
|
+
*/
|
|
6057
|
+
pathParams: {
|
|
6058
|
+
org_id: CreateSupportMessagePathOrgId;
|
|
6059
|
+
case_id: CreateSupportMessagePathCaseId;
|
|
6060
|
+
};
|
|
6061
|
+
queryParams?: never;
|
|
6062
|
+
headerParams?: never;
|
|
6063
|
+
/**
|
|
6064
|
+
* @type string
|
|
6065
|
+
*/
|
|
6066
|
+
url: `/v1/organizations/${string}/support/cases/${string}/messages`;
|
|
6067
|
+
};
|
|
6068
|
+
|
|
6069
|
+
/**
|
|
6070
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6071
|
+
* Do not edit manually.
|
|
6072
|
+
*/
|
|
6073
|
+
/**
|
|
6074
|
+
* @description Slack event forwarded from the dashboard webhook handler.
|
|
6075
|
+
* @type object
|
|
6076
|
+
*/
|
|
6077
|
+
type SlackEventPayload = {
|
|
6078
|
+
/**
|
|
6079
|
+
* @description Slack channel ID where the message was posted.
|
|
6080
|
+
* @type string
|
|
6081
|
+
*/
|
|
6082
|
+
channel_id: string;
|
|
6083
|
+
/**
|
|
6084
|
+
* @description Slack thread timestamp identifying the support case thread.
|
|
6085
|
+
* @type string
|
|
6086
|
+
*/
|
|
6087
|
+
thread_ts: string;
|
|
6088
|
+
/**
|
|
6089
|
+
* @description Slack user ID of the message author.
|
|
6090
|
+
* @type string
|
|
6091
|
+
*/
|
|
6092
|
+
user_id: string;
|
|
6093
|
+
/**
|
|
6094
|
+
* @description Message text from Slack.
|
|
6095
|
+
* @type string
|
|
6096
|
+
*/
|
|
6097
|
+
text: string;
|
|
6098
|
+
};
|
|
6099
|
+
|
|
6100
|
+
/**
|
|
6101
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6102
|
+
* Do not edit manually.
|
|
6103
|
+
*/
|
|
6104
|
+
|
|
6105
|
+
/**
|
|
6106
|
+
* @type any
|
|
6107
|
+
*/
|
|
6108
|
+
type HandleSlackSupportEventStatus200 = any;
|
|
6109
|
+
/**
|
|
6110
|
+
* @description Slack event forwarded from the dashboard webhook handler.
|
|
6111
|
+
* @type object
|
|
6112
|
+
*/
|
|
6113
|
+
type HandleSlackSupportEventData = SlackEventPayload;
|
|
6114
|
+
/**
|
|
6115
|
+
* @type object
|
|
6116
|
+
*/
|
|
6117
|
+
type HandleSlackSupportEventRequestConfig = {
|
|
6118
|
+
data?: HandleSlackSupportEventData;
|
|
6119
|
+
pathParams?: never;
|
|
6120
|
+
queryParams?: never;
|
|
6121
|
+
headerParams?: never;
|
|
6122
|
+
/**
|
|
6123
|
+
* @type string
|
|
6124
|
+
*/
|
|
6125
|
+
url: "/v1/internal/support/slack-event";
|
|
6126
|
+
};
|
|
6127
|
+
|
|
6128
|
+
/**
|
|
6129
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6130
|
+
* Do not edit manually.
|
|
6131
|
+
*/
|
|
6132
|
+
/**
|
|
6133
|
+
* @description Daily usage totals aggregated across all projects in an organization.
|
|
6134
|
+
* @type object
|
|
6135
|
+
*/
|
|
6136
|
+
type DailyUsage = {
|
|
6137
|
+
/**
|
|
6138
|
+
* @description Usage date in UTC.
|
|
6139
|
+
* @type string
|
|
6140
|
+
*/
|
|
6141
|
+
day: string;
|
|
6142
|
+
/**
|
|
6143
|
+
* @description Total queries served on the day.
|
|
6144
|
+
* @type integer
|
|
6145
|
+
*/
|
|
6146
|
+
queries_total: number;
|
|
6147
|
+
/**
|
|
6148
|
+
* @description Total cache hits on the day.
|
|
6149
|
+
* @type integer
|
|
6150
|
+
*/
|
|
6151
|
+
cache_hits: number;
|
|
6152
|
+
/**
|
|
6153
|
+
* @description Total cache misses on the day.
|
|
6154
|
+
* @type integer
|
|
6155
|
+
*/
|
|
6156
|
+
cache_misses: number;
|
|
6157
|
+
/**
|
|
6158
|
+
* @description Total proxy connection time consumed on the day.
|
|
6159
|
+
* @type integer
|
|
6160
|
+
*/
|
|
6161
|
+
connection_seconds: number;
|
|
6162
|
+
/**
|
|
6163
|
+
* @description Total bytes transferred to clients.
|
|
6164
|
+
* @type integer
|
|
6165
|
+
*/
|
|
6166
|
+
bytes_transferred: number;
|
|
6167
|
+
};
|
|
6168
|
+
|
|
6169
|
+
/**
|
|
6170
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6171
|
+
* Do not edit manually.
|
|
6172
|
+
*/
|
|
6173
|
+
|
|
6174
|
+
/**
|
|
6175
|
+
* @description Response envelope for organization usage queries.
|
|
6176
|
+
* @type object
|
|
6177
|
+
*/
|
|
6178
|
+
type UsageResponse = {
|
|
6179
|
+
/**
|
|
6180
|
+
* @description Daily usage entries aggregated across the organization.
|
|
6181
|
+
* @type array
|
|
6182
|
+
*/
|
|
6183
|
+
usage: DailyUsage[];
|
|
6184
|
+
};
|
|
6185
|
+
|
|
6186
|
+
/**
|
|
6187
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6188
|
+
* Do not edit manually.
|
|
6189
|
+
*/
|
|
6190
|
+
|
|
6191
|
+
/**
|
|
6192
|
+
* @description Unique organization identifier.
|
|
6193
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
6194
|
+
* @example org_abc123
|
|
6195
|
+
* @type string
|
|
6196
|
+
*/
|
|
6197
|
+
type GetOrganizationUsagePathOrgId = string;
|
|
6198
|
+
/**
|
|
6199
|
+
* @description Start date (inclusive, YYYY-MM-DD).
|
|
6200
|
+
* @example 2024-01-01
|
|
6201
|
+
* @type string
|
|
6202
|
+
*/
|
|
6203
|
+
type GetOrganizationUsageQueryStartDate = string;
|
|
6204
|
+
/**
|
|
6205
|
+
* @description End date (inclusive, YYYY-MM-DD).
|
|
6206
|
+
* @example 2024-01-31
|
|
6207
|
+
* @type string
|
|
6208
|
+
*/
|
|
6209
|
+
type GetOrganizationUsageQueryEndDate = string;
|
|
6210
|
+
/**
|
|
6211
|
+
* @description Response envelope for organization usage queries.
|
|
6212
|
+
* @type object
|
|
6213
|
+
*/
|
|
6214
|
+
type GetOrganizationUsageStatus200 = UsageResponse;
|
|
6215
|
+
/**
|
|
6216
|
+
* @type object
|
|
6217
|
+
*/
|
|
6218
|
+
type GetOrganizationUsageRequestConfig = {
|
|
6219
|
+
data?: never;
|
|
6220
|
+
/**
|
|
6221
|
+
* @type object
|
|
6222
|
+
*/
|
|
6223
|
+
pathParams: {
|
|
6224
|
+
org_id: GetOrganizationUsagePathOrgId;
|
|
6225
|
+
};
|
|
6226
|
+
/**
|
|
6227
|
+
* @type object | undefined
|
|
6228
|
+
*/
|
|
6229
|
+
queryParams?: {
|
|
6230
|
+
start_date: GetOrganizationUsageQueryStartDate;
|
|
6231
|
+
end_date: GetOrganizationUsageQueryEndDate;
|
|
6232
|
+
};
|
|
6233
|
+
headerParams?: never;
|
|
6234
|
+
/**
|
|
6235
|
+
* @type string
|
|
6236
|
+
*/
|
|
6237
|
+
url: `/v1/organizations/${string}/usage`;
|
|
6238
|
+
};
|
|
6239
|
+
|
|
6240
|
+
/**
|
|
6241
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6242
|
+
* Do not edit manually.
|
|
6243
|
+
*/
|
|
6244
|
+
/**
|
|
6245
|
+
* @description Daily usage totals for a single project and region.
|
|
6246
|
+
* @type object
|
|
6247
|
+
*/
|
|
6248
|
+
type ProjectDailyUsage = {
|
|
6249
|
+
/**
|
|
6250
|
+
* @description Usage date in UTC.
|
|
6251
|
+
* @type string
|
|
6252
|
+
*/
|
|
6253
|
+
day: string;
|
|
6254
|
+
/**
|
|
6255
|
+
* @description Region where the traffic was served.
|
|
6256
|
+
* @type string
|
|
6257
|
+
*/
|
|
6258
|
+
region: string;
|
|
6259
|
+
/**
|
|
6260
|
+
* @description Total queries served on the day.
|
|
6261
|
+
* @type integer
|
|
6262
|
+
*/
|
|
6263
|
+
queries_total: number;
|
|
6264
|
+
/**
|
|
6265
|
+
* @description Total cache hits on the day.
|
|
6266
|
+
* @type integer
|
|
6267
|
+
*/
|
|
6268
|
+
cache_hits: number;
|
|
6269
|
+
/**
|
|
6270
|
+
* @description Total cache misses on the day.
|
|
6271
|
+
* @type integer
|
|
6272
|
+
*/
|
|
6273
|
+
cache_misses: number;
|
|
6274
|
+
/**
|
|
6275
|
+
* @description Total proxy connection time consumed on the day.
|
|
6276
|
+
* @type integer
|
|
6277
|
+
*/
|
|
6278
|
+
connection_seconds: number;
|
|
6279
|
+
/**
|
|
6280
|
+
* @description Total bytes transferred to clients.
|
|
6281
|
+
* @type integer
|
|
6282
|
+
*/
|
|
6283
|
+
bytes_transferred: number;
|
|
6284
|
+
};
|
|
6285
|
+
|
|
6286
|
+
/**
|
|
6287
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6288
|
+
* Do not edit manually.
|
|
6289
|
+
*/
|
|
6290
|
+
|
|
6291
|
+
/**
|
|
6292
|
+
* @description Response envelope for project usage queries.
|
|
6293
|
+
* @type object
|
|
6294
|
+
*/
|
|
6295
|
+
type ProjectUsageResponse = {
|
|
6296
|
+
/**
|
|
6297
|
+
* @description Daily usage entries grouped by region for the project.
|
|
6298
|
+
* @type array
|
|
6299
|
+
*/
|
|
6300
|
+
usage: ProjectDailyUsage[];
|
|
6301
|
+
};
|
|
6302
|
+
|
|
6303
|
+
/**
|
|
6304
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6305
|
+
* Do not edit manually.
|
|
6306
|
+
*/
|
|
6307
|
+
|
|
6308
|
+
/**
|
|
6309
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
6310
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
6311
|
+
* @type string
|
|
6312
|
+
*/
|
|
6313
|
+
type GetProjectUsagePathProjectId = string;
|
|
6314
|
+
/**
|
|
6315
|
+
* @description Start date (inclusive, YYYY-MM-DD).
|
|
6316
|
+
* @example 2024-01-01
|
|
6317
|
+
* @type string
|
|
6318
|
+
*/
|
|
6319
|
+
type GetProjectUsageQueryStartDate = string;
|
|
6320
|
+
/**
|
|
6321
|
+
* @description End date (inclusive, YYYY-MM-DD).
|
|
6322
|
+
* @example 2024-01-31
|
|
6323
|
+
* @type string
|
|
6324
|
+
*/
|
|
6325
|
+
type GetProjectUsageQueryEndDate = string;
|
|
6326
|
+
/**
|
|
6327
|
+
* @description Response envelope for project usage queries.
|
|
6328
|
+
* @type object
|
|
6329
|
+
*/
|
|
6330
|
+
type GetProjectUsageStatus200 = ProjectUsageResponse;
|
|
6331
|
+
/**
|
|
6332
|
+
* @type object
|
|
6333
|
+
*/
|
|
6334
|
+
type GetProjectUsageRequestConfig = {
|
|
6335
|
+
data?: never;
|
|
6336
|
+
/**
|
|
6337
|
+
* @type object
|
|
6338
|
+
*/
|
|
6339
|
+
pathParams: {
|
|
6340
|
+
project_id: GetProjectUsagePathProjectId;
|
|
6341
|
+
};
|
|
6342
|
+
/**
|
|
6343
|
+
* @type object | undefined
|
|
6344
|
+
*/
|
|
6345
|
+
queryParams?: {
|
|
6346
|
+
start_date: GetProjectUsageQueryStartDate;
|
|
6347
|
+
end_date: GetProjectUsageQueryEndDate;
|
|
6348
|
+
};
|
|
6349
|
+
headerParams?: never;
|
|
6350
|
+
/**
|
|
6351
|
+
* @type string
|
|
6352
|
+
*/
|
|
6353
|
+
url: `/v1/projects/${string}/usage`;
|
|
6354
|
+
};
|
|
6355
|
+
|
|
6356
|
+
/**
|
|
6357
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
6358
|
+
* Do not edit manually.
|
|
6359
|
+
*/
|
|
6360
|
+
declare const webhookEndpointFormatEnum: {
|
|
6361
|
+
readonly json: "json";
|
|
6362
|
+
readonly splunk_hec: "splunk_hec";
|
|
6363
|
+
readonly datadog: "datadog";
|
|
6364
|
+
readonly elastic: "elastic";
|
|
6365
|
+
};
|
|
6366
|
+
type WebhookEndpointFormatEnumKey = (typeof webhookEndpointFormatEnum)[keyof typeof webhookEndpointFormatEnum];
|
|
6367
|
+
/**
|
|
6368
|
+
* @description A delivery target for project audit/event notifications.
|
|
6369
|
+
* @type object
|
|
6370
|
+
*/
|
|
6371
|
+
type WebhookEndpoint = {
|
|
6372
|
+
/**
|
|
6373
|
+
* @description Unique webhook endpoint identifier (prefixed).
|
|
6374
|
+
* @example whk_01h455vb4pex5vsknk084sn02q
|
|
6375
|
+
* @type string
|
|
6376
|
+
*/
|
|
6377
|
+
id: string;
|
|
6378
|
+
/**
|
|
6379
|
+
* @description Owning project ID.
|
|
6380
|
+
* @type string
|
|
6381
|
+
*/
|
|
6382
|
+
project_id: string;
|
|
6383
|
+
/**
|
|
6384
|
+
* @description HTTPS endpoint that receives event deliveries.
|
|
6385
|
+
* @example https://example.com/hooks/pgbeam
|
|
6386
|
+
* @type string
|
|
6387
|
+
*/
|
|
6388
|
+
url: string;
|
|
6389
|
+
/**
|
|
6390
|
+
* @description Payload format for delivered events.
|
|
6391
|
+
* @type string
|
|
6392
|
+
*/
|
|
6393
|
+
format: WebhookEndpointFormatEnumKey;
|
|
6394
|
+
/**
|
|
6395
|
+
* @description Event types to deliver. Empty means all events.
|
|
6396
|
+
* @type array | undefined
|
|
6397
|
+
*/
|
|
6398
|
+
event_types?: string[];
|
|
5798
6399
|
/**
|
|
5799
6400
|
* @description Whether deliveries are active for this endpoint.
|
|
5800
6401
|
* @type boolean
|
|
@@ -6229,6 +6830,10 @@ declare const operationsByTag: {
|
|
|
6229
6830
|
readonly method: "DELETE";
|
|
6230
6831
|
readonly path: "/v1/projects/{project_id}/agents/{agent_id}";
|
|
6231
6832
|
};
|
|
6833
|
+
readonly rotateAgentCredential: {
|
|
6834
|
+
readonly method: "POST";
|
|
6835
|
+
readonly path: "/v1/projects/{project_id}/agents/{agent_id}/rotate";
|
|
6836
|
+
};
|
|
6232
6837
|
readonly listAuditLogs: {
|
|
6233
6838
|
readonly method: "GET";
|
|
6234
6839
|
readonly path: "/v1/projects/{project_id}/audit-logs";
|
|
@@ -6424,6 +7029,34 @@ declare const operationsByTag: {
|
|
|
6424
7029
|
readonly path: "/v1/projects/{project_id}/policies/{policy_id}";
|
|
6425
7030
|
};
|
|
6426
7031
|
};
|
|
7032
|
+
readonly support: {
|
|
7033
|
+
readonly listSupportCases: {
|
|
7034
|
+
readonly method: "GET";
|
|
7035
|
+
readonly path: "/v1/organizations/{org_id}/support/cases";
|
|
7036
|
+
};
|
|
7037
|
+
readonly createSupportCase: {
|
|
7038
|
+
readonly method: "POST";
|
|
7039
|
+
readonly path: "/v1/organizations/{org_id}/support/cases";
|
|
7040
|
+
};
|
|
7041
|
+
readonly getSupportCase: {
|
|
7042
|
+
readonly method: "GET";
|
|
7043
|
+
readonly path: "/v1/organizations/{org_id}/support/cases/{case_id}";
|
|
7044
|
+
};
|
|
7045
|
+
readonly updateSupportCase: {
|
|
7046
|
+
readonly method: "PATCH";
|
|
7047
|
+
readonly path: "/v1/organizations/{org_id}/support/cases/{case_id}";
|
|
7048
|
+
};
|
|
7049
|
+
readonly createSupportMessage: {
|
|
7050
|
+
readonly method: "POST";
|
|
7051
|
+
readonly path: "/v1/organizations/{org_id}/support/cases/{case_id}/messages";
|
|
7052
|
+
};
|
|
7053
|
+
};
|
|
7054
|
+
readonly internal: {
|
|
7055
|
+
readonly handleSlackSupportEvent: {
|
|
7056
|
+
readonly method: "POST";
|
|
7057
|
+
readonly path: "/v1/internal/support/slack-event";
|
|
7058
|
+
};
|
|
7059
|
+
};
|
|
6427
7060
|
readonly webhooks: {
|
|
6428
7061
|
readonly listWebhookEndpoints: {
|
|
6429
7062
|
readonly method: "GET";
|
|
@@ -6482,6 +7115,11 @@ declare const operationsByPath: {
|
|
|
6482
7115
|
readonly path: "/v1/projects/{project_id}/agents/{agent_id}";
|
|
6483
7116
|
readonly operationId: "revokeAgentCredential";
|
|
6484
7117
|
};
|
|
7118
|
+
readonly "POST /v1/projects/{project_id}/agents/{agent_id}/rotate": {
|
|
7119
|
+
readonly method: "POST";
|
|
7120
|
+
readonly path: "/v1/projects/{project_id}/agents/{agent_id}/rotate";
|
|
7121
|
+
readonly operationId: "rotateAgentCredential";
|
|
7122
|
+
};
|
|
6485
7123
|
readonly "GET /v1/projects/{project_id}/anomalies": {
|
|
6486
7124
|
readonly method: "GET";
|
|
6487
7125
|
readonly path: "/v1/projects/{project_id}/anomalies";
|
|
@@ -6702,6 +7340,36 @@ declare const operationsByPath: {
|
|
|
6702
7340
|
readonly path: "/v1/databases/{database_id}/replicas/{replica_id}";
|
|
6703
7341
|
readonly operationId: "deleteReplica";
|
|
6704
7342
|
};
|
|
7343
|
+
readonly "GET /v1/organizations/{org_id}/support/cases": {
|
|
7344
|
+
readonly method: "GET";
|
|
7345
|
+
readonly path: "/v1/organizations/{org_id}/support/cases";
|
|
7346
|
+
readonly operationId: "listSupportCases";
|
|
7347
|
+
};
|
|
7348
|
+
readonly "POST /v1/organizations/{org_id}/support/cases": {
|
|
7349
|
+
readonly method: "POST";
|
|
7350
|
+
readonly path: "/v1/organizations/{org_id}/support/cases";
|
|
7351
|
+
readonly operationId: "createSupportCase";
|
|
7352
|
+
};
|
|
7353
|
+
readonly "GET /v1/organizations/{org_id}/support/cases/{case_id}": {
|
|
7354
|
+
readonly method: "GET";
|
|
7355
|
+
readonly path: "/v1/organizations/{org_id}/support/cases/{case_id}";
|
|
7356
|
+
readonly operationId: "getSupportCase";
|
|
7357
|
+
};
|
|
7358
|
+
readonly "PATCH /v1/organizations/{org_id}/support/cases/{case_id}": {
|
|
7359
|
+
readonly method: "PATCH";
|
|
7360
|
+
readonly path: "/v1/organizations/{org_id}/support/cases/{case_id}";
|
|
7361
|
+
readonly operationId: "updateSupportCase";
|
|
7362
|
+
};
|
|
7363
|
+
readonly "POST /v1/organizations/{org_id}/support/cases/{case_id}/messages": {
|
|
7364
|
+
readonly method: "POST";
|
|
7365
|
+
readonly path: "/v1/organizations/{org_id}/support/cases/{case_id}/messages";
|
|
7366
|
+
readonly operationId: "createSupportMessage";
|
|
7367
|
+
};
|
|
7368
|
+
readonly "POST /v1/internal/support/slack-event": {
|
|
7369
|
+
readonly method: "POST";
|
|
7370
|
+
readonly path: "/v1/internal/support/slack-event";
|
|
7371
|
+
readonly operationId: "handleSlackSupportEvent";
|
|
7372
|
+
};
|
|
6705
7373
|
readonly "GET /v1/organizations/{org_id}/usage": {
|
|
6706
7374
|
readonly method: "GET";
|
|
6707
7375
|
readonly path: "/v1/organizations/{org_id}/usage";
|
|
@@ -6761,6 +7429,9 @@ type UpdateAgentCredentialStatusParams = {
|
|
|
6761
7429
|
type RevokeAgentCredentialParams = {
|
|
6762
7430
|
pathParams: NonNullable<RevokeAgentCredentialRequestConfig["pathParams"]>;
|
|
6763
7431
|
};
|
|
7432
|
+
type RotateAgentCredentialParams = {
|
|
7433
|
+
pathParams: NonNullable<RotateAgentCredentialRequestConfig["pathParams"]>;
|
|
7434
|
+
};
|
|
6764
7435
|
type ListAnomalyAlertsParams = {
|
|
6765
7436
|
pathParams: NonNullable<ListAnomalyAlertsRequestConfig["pathParams"]>;
|
|
6766
7437
|
queryParams?: NonNullable<ListAnomalyAlertsRequestConfig["queryParams"]>;
|
|
@@ -6909,6 +7580,28 @@ type CreateReplicaParams = {
|
|
|
6909
7580
|
type DeleteReplicaParams = {
|
|
6910
7581
|
pathParams: NonNullable<DeleteReplicaRequestConfig["pathParams"]>;
|
|
6911
7582
|
};
|
|
7583
|
+
type ListSupportCasesParams = {
|
|
7584
|
+
pathParams: NonNullable<ListSupportCasesRequestConfig["pathParams"]>;
|
|
7585
|
+
queryParams?: NonNullable<ListSupportCasesRequestConfig["queryParams"]>;
|
|
7586
|
+
};
|
|
7587
|
+
type CreateSupportCaseParams = {
|
|
7588
|
+
pathParams: NonNullable<CreateSupportCaseRequestConfig["pathParams"]>;
|
|
7589
|
+
body: NonNullable<CreateSupportCaseRequestConfig["data"]>;
|
|
7590
|
+
};
|
|
7591
|
+
type GetSupportCaseParams = {
|
|
7592
|
+
pathParams: NonNullable<GetSupportCaseRequestConfig["pathParams"]>;
|
|
7593
|
+
};
|
|
7594
|
+
type UpdateSupportCaseParams = {
|
|
7595
|
+
pathParams: NonNullable<UpdateSupportCaseRequestConfig["pathParams"]>;
|
|
7596
|
+
body: NonNullable<UpdateSupportCaseRequestConfig["data"]>;
|
|
7597
|
+
};
|
|
7598
|
+
type CreateSupportMessageParams = {
|
|
7599
|
+
pathParams: NonNullable<CreateSupportMessageRequestConfig["pathParams"]>;
|
|
7600
|
+
body: NonNullable<CreateSupportMessageRequestConfig["data"]>;
|
|
7601
|
+
};
|
|
7602
|
+
type HandleSlackSupportEventParams = {
|
|
7603
|
+
body: NonNullable<HandleSlackSupportEventRequestConfig["data"]>;
|
|
7604
|
+
};
|
|
6912
7605
|
type GetOrganizationUsageParams = {
|
|
6913
7606
|
pathParams: NonNullable<GetOrganizationUsageRequestConfig["pathParams"]>;
|
|
6914
7607
|
queryParams: NonNullable<GetOrganizationUsageRequestConfig["queryParams"]>;
|
|
@@ -6950,6 +7643,7 @@ interface ApiOperations {
|
|
|
6950
7643
|
getAgentCredential(params: GetAgentCredentialParams): Promise<GetAgentCredentialStatus200>;
|
|
6951
7644
|
updateAgentCredentialStatus(params: UpdateAgentCredentialStatusParams): Promise<UpdateAgentCredentialStatusStatus200>;
|
|
6952
7645
|
revokeAgentCredential(params: RevokeAgentCredentialParams): Promise<void>;
|
|
7646
|
+
rotateAgentCredential(params: RotateAgentCredentialParams): Promise<RotateAgentCredentialStatus200>;
|
|
6953
7647
|
listAuditLogs(params: ListAuditLogsParams): Promise<ListAuditLogsStatus200>;
|
|
6954
7648
|
};
|
|
6955
7649
|
anomalies: {
|
|
@@ -7013,6 +7707,16 @@ interface ApiOperations {
|
|
|
7013
7707
|
updatePolicyProfile(params: UpdatePolicyProfileParams): Promise<UpdatePolicyProfileStatus200>;
|
|
7014
7708
|
deletePolicyProfile(params: DeletePolicyProfileParams): Promise<void>;
|
|
7015
7709
|
};
|
|
7710
|
+
support: {
|
|
7711
|
+
listSupportCases(params: ListSupportCasesParams): Promise<ListSupportCasesStatus200>;
|
|
7712
|
+
createSupportCase(params: CreateSupportCaseParams): Promise<CreateSupportCaseStatus201>;
|
|
7713
|
+
getSupportCase(params: GetSupportCaseParams): Promise<GetSupportCaseStatus200>;
|
|
7714
|
+
updateSupportCase(params: UpdateSupportCaseParams): Promise<UpdateSupportCaseStatus200>;
|
|
7715
|
+
createSupportMessage(params: CreateSupportMessageParams): Promise<CreateSupportMessageStatus201>;
|
|
7716
|
+
};
|
|
7717
|
+
internal: {
|
|
7718
|
+
handleSlackSupportEvent(params: HandleSlackSupportEventParams): Promise<HandleSlackSupportEventStatus200>;
|
|
7719
|
+
};
|
|
7016
7720
|
webhooks: {
|
|
7017
7721
|
listWebhookEndpoints(params: ListWebhookEndpointsParams): Promise<ListWebhookEndpointsStatus200>;
|
|
7018
7722
|
createWebhookEndpoint(params: CreateWebhookEndpointParams): Promise<CreateWebhookEndpointStatus201>;
|
|
@@ -7047,6 +7751,10 @@ interface RequestMap {
|
|
|
7047
7751
|
params: RevokeAgentCredentialParams;
|
|
7048
7752
|
response: void;
|
|
7049
7753
|
};
|
|
7754
|
+
"POST /v1/projects/{project_id}/agents/{agent_id}/rotate": {
|
|
7755
|
+
params: RotateAgentCredentialParams;
|
|
7756
|
+
response: RotateAgentCredentialStatus200;
|
|
7757
|
+
};
|
|
7050
7758
|
"GET /v1/projects/{project_id}/anomalies": {
|
|
7051
7759
|
params: ListAnomalyAlertsParams;
|
|
7052
7760
|
response: ListAnomalyAlertsStatus200;
|
|
@@ -7223,6 +7931,30 @@ interface RequestMap {
|
|
|
7223
7931
|
params: DeleteReplicaParams;
|
|
7224
7932
|
response: void;
|
|
7225
7933
|
};
|
|
7934
|
+
"GET /v1/organizations/{org_id}/support/cases": {
|
|
7935
|
+
params: ListSupportCasesParams;
|
|
7936
|
+
response: ListSupportCasesStatus200;
|
|
7937
|
+
};
|
|
7938
|
+
"POST /v1/organizations/{org_id}/support/cases": {
|
|
7939
|
+
params: CreateSupportCaseParams;
|
|
7940
|
+
response: CreateSupportCaseStatus201;
|
|
7941
|
+
};
|
|
7942
|
+
"GET /v1/organizations/{org_id}/support/cases/{case_id}": {
|
|
7943
|
+
params: GetSupportCaseParams;
|
|
7944
|
+
response: GetSupportCaseStatus200;
|
|
7945
|
+
};
|
|
7946
|
+
"PATCH /v1/organizations/{org_id}/support/cases/{case_id}": {
|
|
7947
|
+
params: UpdateSupportCaseParams;
|
|
7948
|
+
response: UpdateSupportCaseStatus200;
|
|
7949
|
+
};
|
|
7950
|
+
"POST /v1/organizations/{org_id}/support/cases/{case_id}/messages": {
|
|
7951
|
+
params: CreateSupportMessageParams;
|
|
7952
|
+
response: CreateSupportMessageStatus201;
|
|
7953
|
+
};
|
|
7954
|
+
"POST /v1/internal/support/slack-event": {
|
|
7955
|
+
params: HandleSlackSupportEventParams;
|
|
7956
|
+
response: HandleSlackSupportEventStatus200;
|
|
7957
|
+
};
|
|
7226
7958
|
"GET /v1/organizations/{org_id}/usage": {
|
|
7227
7959
|
params: GetOrganizationUsageParams;
|
|
7228
7960
|
response: GetOrganizationUsageStatus200;
|