@sentry/api 0.397.0 → 0.399.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -0
- package/dist/index.d.ts +1 -0
- package/dist/query-enums.gen.d.ts +129 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -69,6 +69,20 @@ const { data, error } = await listOrganizations({
|
|
|
69
69
|
|
|
70
70
|
They can also reuse an existing instance's configuration: `listOrganizations({ client: sentry.client })`.
|
|
71
71
|
|
|
72
|
+
### Query parameter types
|
|
73
|
+
|
|
74
|
+
Each operation's `<Operation>Data` type describes its `path`, `query`, and `body`. Enum-valued query parameters also get a named type for one value, `<Operation>Query<Parameter>`. For array parameters, that is the element type:
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
import type {
|
|
78
|
+
ListOrganizationTraceItemAttributesQueryAttributeType,
|
|
79
|
+
ListOrganizationTraceItemAttributesQueryDataset,
|
|
80
|
+
} from "@sentry/api";
|
|
81
|
+
|
|
82
|
+
const dataset: ListOrganizationTraceItemAttributesQueryDataset = "spans";
|
|
83
|
+
const types: ListOrganizationTraceItemAttributesQueryAttributeType[] = ["string", "number"];
|
|
84
|
+
```
|
|
85
|
+
|
|
72
86
|
### Browser sessions
|
|
73
87
|
|
|
74
88
|
The browser helper configures session cookies and CSRF token injection:
|
package/dist/index.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ export type { DocumentedSentryApiError, NarrowedResult, SentryApiResultError, Se
|
|
|
5
5
|
export { parseSentryLinkHeader, unwrapResult, unwrapPaginatedResult, fetchPage, paginateAll, paginateUpTo } from './sentry-pagination.ts';
|
|
6
6
|
export type { UnwrappedResult, PaginatedResponse, PaginatedCollection, PaginateAllOptions, PaginateUpToOptions, PageFetcher, BudgetedPageFetcher } from './sentry-pagination.ts';
|
|
7
7
|
export * from './error-results.gen.ts';
|
|
8
|
+
export type * from './query-enums.gen.ts';
|
|
8
9
|
export * from './pagination.gen.ts';
|
|
9
10
|
export { createSentryClient } from './sentry-client.gen.ts';
|
|
10
11
|
export type { SentryClient } from './sentry-client.gen.ts';
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import type { DeleteOrganizationIssuesData, GetOrganizationIssueAutofixStateData, GetOrganizationIssueData, GetOrganizationIssueEventData, GetOrganizationIssueIntegrationData, GetOrganizationProfilingFlamegraphData, GetOrganizationReleaseData, GetOrganizationReplayCountData, GetOrganizationReplayData, GetOrganizationStatsSummaryData, GetOrganizationTraceData, GetOrganizationTraceMetaData, ListOrganizationDashboardsData, ListOrganizationEnvironmentsData, ListOrganizationEventsData, ListOrganizationEventsDroppedData, ListOrganizationEventsTimeseriesData, ListOrganizationFlagLogsData, ListOrganizationIssueTagValuesData, ListOrganizationIssueViewsData, ListOrganizationIssuesData, ListOrganizationProjectKeysData, ListOrganizationReplaysData, ListOrganizationReposData, ListOrganizationStatsV2Data, ListOrganizationTagsData, ListOrganizationTraceItemAttributesData, ListOrganizationTraceItemsStatsData, ListOrganizationTraceMetricsData, ListProjectCodeOwnersData, ListProjectEnvironmentsData, ListProjectIssuesData, ListProjectStatsData, ResolveOrganizationShortIdData, RetrieveOrganizationAiConversationData, UpdateOrganizationIssuesData } from './types.gen';
|
|
2
|
+
/** A value of the `sort` query parameter of `deleteOrganizationIssues`. */
|
|
3
|
+
export type DeleteOrganizationIssuesQuerySort = NonNullable<NonNullable<DeleteOrganizationIssuesData['query']>["sort"]>;
|
|
4
|
+
/** A value of the `llmFormat` query parameter of `getOrganizationIssueAutofixState`. */
|
|
5
|
+
export type GetOrganizationIssueAutofixStateQueryLlmFormat = NonNullable<NonNullable<GetOrganizationIssueAutofixStateData['query']>["llmFormat"]>;
|
|
6
|
+
/** A value of the `llmFormat` query parameter of `getOrganizationIssueEvent`. */
|
|
7
|
+
export type GetOrganizationIssueEventQueryLlmFormat = NonNullable<NonNullable<GetOrganizationIssueEventData['query']>["llmFormat"]>;
|
|
8
|
+
/** A value of the `action` query parameter of `getOrganizationIssueIntegration`. */
|
|
9
|
+
export type GetOrganizationIssueIntegrationQueryAction = NonNullable<NonNullable<GetOrganizationIssueIntegrationData['query']>["action"]>;
|
|
10
|
+
/** A value of the `collapse` query parameter of `getOrganizationIssue`. */
|
|
11
|
+
export type GetOrganizationIssueQueryCollapse = NonNullable<NonNullable<GetOrganizationIssueData['query']>["collapse"]>[number];
|
|
12
|
+
/** A value of the `expand` query parameter of `getOrganizationIssue`. */
|
|
13
|
+
export type GetOrganizationIssueQueryExpand = NonNullable<NonNullable<GetOrganizationIssueData['query']>["expand"]>[number];
|
|
14
|
+
/** A value of the `dataSource` query parameter of `getOrganizationProfilingFlamegraph`. */
|
|
15
|
+
export type GetOrganizationProfilingFlamegraphQueryDataSource = NonNullable<NonNullable<GetOrganizationProfilingFlamegraphData['query']>["dataSource"]>;
|
|
16
|
+
/** A value of the `expand` query parameter of `getOrganizationProfilingFlamegraph`. */
|
|
17
|
+
export type GetOrganizationProfilingFlamegraphQueryExpand = NonNullable<NonNullable<GetOrganizationProfilingFlamegraphData['query']>["expand"]>[number];
|
|
18
|
+
/** A value of the `healthStatsPeriod` query parameter of `getOrganizationRelease`. */
|
|
19
|
+
export type GetOrganizationReleaseQueryHealthStatsPeriod = NonNullable<NonNullable<GetOrganizationReleaseData['query']>["healthStatsPeriod"]>;
|
|
20
|
+
/** A value of the `sort` query parameter of `getOrganizationRelease`. */
|
|
21
|
+
export type GetOrganizationReleaseQuerySort = NonNullable<NonNullable<GetOrganizationReleaseData['query']>["sort"]>;
|
|
22
|
+
/** A value of the `status` query parameter of `getOrganizationRelease`. */
|
|
23
|
+
export type GetOrganizationReleaseQueryStatus = NonNullable<NonNullable<GetOrganizationReleaseData['query']>["status"]>;
|
|
24
|
+
/** A value of the `summaryStatsPeriod` query parameter of `getOrganizationRelease`. */
|
|
25
|
+
export type GetOrganizationReleaseQuerySummaryStatsPeriod = NonNullable<NonNullable<GetOrganizationReleaseData['query']>["summaryStatsPeriod"]>;
|
|
26
|
+
/** A value of the `data_source` query parameter of `getOrganizationReplayCount`. */
|
|
27
|
+
export type GetOrganizationReplayCountQueryDataSource = NonNullable<NonNullable<GetOrganizationReplayCountData['query']>["data_source"]>;
|
|
28
|
+
/** A value of the `field` query parameter of `getOrganizationReplay`. */
|
|
29
|
+
export type GetOrganizationReplayQueryField = NonNullable<NonNullable<GetOrganizationReplayData['query']>["field"]>[number];
|
|
30
|
+
/** A value of the `category` query parameter of `getOrganizationStatsSummary`. */
|
|
31
|
+
export type GetOrganizationStatsSummaryQueryCategory = NonNullable<NonNullable<GetOrganizationStatsSummaryData['query']>["category"]>;
|
|
32
|
+
/** A value of the `field` query parameter of `getOrganizationStatsSummary`. */
|
|
33
|
+
export type GetOrganizationStatsSummaryQueryField = NonNullable<NonNullable<GetOrganizationStatsSummaryData['query']>["field"]>;
|
|
34
|
+
/** A value of the `outcome` query parameter of `getOrganizationStatsSummary`. */
|
|
35
|
+
export type GetOrganizationStatsSummaryQueryOutcome = NonNullable<NonNullable<GetOrganizationStatsSummaryData['query']>["outcome"]>;
|
|
36
|
+
/** A value of the `include_uptime` query parameter of `getOrganizationTraceMeta`. */
|
|
37
|
+
export type GetOrganizationTraceMetaQueryIncludeUptime = NonNullable<NonNullable<GetOrganizationTraceMetaData['query']>["include_uptime"]>;
|
|
38
|
+
/** A value of the `include_uptime` query parameter of `getOrganizationTrace`. */
|
|
39
|
+
export type GetOrganizationTraceQueryIncludeUptime = NonNullable<NonNullable<GetOrganizationTraceData['query']>["include_uptime"]>;
|
|
40
|
+
/** A value of the `filter` query parameter of `listOrganizationDashboards`. */
|
|
41
|
+
export type ListOrganizationDashboardsQueryFilter = NonNullable<NonNullable<ListOrganizationDashboardsData['query']>["filter"]>[number];
|
|
42
|
+
/** A value of the `pin` query parameter of `listOrganizationDashboards`. */
|
|
43
|
+
export type ListOrganizationDashboardsQueryPin = NonNullable<NonNullable<ListOrganizationDashboardsData['query']>["pin"]>;
|
|
44
|
+
/** A value of the `visibility` query parameter of `listOrganizationEnvironments`. */
|
|
45
|
+
export type ListOrganizationEnvironmentsQueryVisibility = NonNullable<NonNullable<ListOrganizationEnvironmentsData['query']>["visibility"]>;
|
|
46
|
+
/** A value of the `dataset` query parameter of `listOrganizationEventsDropped`. */
|
|
47
|
+
export type ListOrganizationEventsDroppedQueryDataset = NonNullable<NonNullable<ListOrganizationEventsDroppedData['query']>["dataset"]>;
|
|
48
|
+
/** A value of the `outcome` query parameter of `listOrganizationEventsDropped`. */
|
|
49
|
+
export type ListOrganizationEventsDroppedQueryOutcome = NonNullable<NonNullable<ListOrganizationEventsDroppedData['query']>["outcome"]>;
|
|
50
|
+
/** A value of the `dataset` query parameter of `listOrganizationEvents`. */
|
|
51
|
+
export type ListOrganizationEventsQueryDataset = NonNullable<NonNullable<ListOrganizationEventsData['query']>["dataset"]>;
|
|
52
|
+
/** A value of the `dataset` query parameter of `listOrganizationEventsTimeseries`. */
|
|
53
|
+
export type ListOrganizationEventsTimeseriesQueryDataset = NonNullable<NonNullable<ListOrganizationEventsTimeseriesData['query']>["dataset"]>;
|
|
54
|
+
/** A value of the `disableAggregateExtrapolation` query parameter of `listOrganizationEventsTimeseries`. */
|
|
55
|
+
export type ListOrganizationEventsTimeseriesQueryDisableAggregateExtrapolation = NonNullable<NonNullable<ListOrganizationEventsTimeseriesData['query']>["disableAggregateExtrapolation"]>;
|
|
56
|
+
/** A value of the `excludeOther` query parameter of `listOrganizationEventsTimeseries`. */
|
|
57
|
+
export type ListOrganizationEventsTimeseriesQueryExcludeOther = NonNullable<NonNullable<ListOrganizationEventsTimeseriesData['query']>["excludeOther"]>;
|
|
58
|
+
/** A value of the `preventMetricAggregates` query parameter of `listOrganizationEventsTimeseries`. */
|
|
59
|
+
export type ListOrganizationEventsTimeseriesQueryPreventMetricAggregates = NonNullable<NonNullable<ListOrganizationEventsTimeseriesData['query']>["preventMetricAggregates"]>;
|
|
60
|
+
/** A value of the `provider` query parameter of `listOrganizationFlagLogs`. */
|
|
61
|
+
export type ListOrganizationFlagLogsQueryProvider = NonNullable<NonNullable<ListOrganizationFlagLogsData['query']>["provider"]>[number];
|
|
62
|
+
/** A value of the `collapse` query parameter of `listOrganizationIssues`. */
|
|
63
|
+
export type ListOrganizationIssuesQueryCollapse = NonNullable<NonNullable<ListOrganizationIssuesData['query']>["collapse"]>[number];
|
|
64
|
+
/** A value of the `expand` query parameter of `listOrganizationIssues`. */
|
|
65
|
+
export type ListOrganizationIssuesQueryExpand = NonNullable<NonNullable<ListOrganizationIssuesData['query']>["expand"]>[number];
|
|
66
|
+
/** A value of the `groupStatsPeriod` query parameter of `listOrganizationIssues`. */
|
|
67
|
+
export type ListOrganizationIssuesQueryGroupStatsPeriod = NonNullable<NonNullable<ListOrganizationIssuesData['query']>["groupStatsPeriod"]>;
|
|
68
|
+
/** A value of the `shortIdLookup` query parameter of `listOrganizationIssues`. */
|
|
69
|
+
export type ListOrganizationIssuesQueryShortIdLookup = NonNullable<NonNullable<ListOrganizationIssuesData['query']>["shortIdLookup"]>;
|
|
70
|
+
/** A value of the `sort` query parameter of `listOrganizationIssues`. */
|
|
71
|
+
export type ListOrganizationIssuesQuerySort = NonNullable<NonNullable<ListOrganizationIssuesData['query']>["sort"]>;
|
|
72
|
+
/** A value of the `sort` query parameter of `listOrganizationIssueTagValues`. */
|
|
73
|
+
export type ListOrganizationIssueTagValuesQuerySort = NonNullable<NonNullable<ListOrganizationIssueTagValuesData['query']>["sort"]>;
|
|
74
|
+
/** A value of the `createdBy` query parameter of `listOrganizationIssueViews`. */
|
|
75
|
+
export type ListOrganizationIssueViewsQueryCreatedBy = NonNullable<NonNullable<ListOrganizationIssueViewsData['query']>["createdBy"]>;
|
|
76
|
+
/** A value of the `sort` query parameter of `listOrganizationIssueViews`. */
|
|
77
|
+
export type ListOrganizationIssueViewsQuerySort = NonNullable<NonNullable<ListOrganizationIssueViewsData['query']>["sort"]>[number];
|
|
78
|
+
/** A value of the `status` query parameter of `listOrganizationProjectKeys`. */
|
|
79
|
+
export type ListOrganizationProjectKeysQueryStatus = NonNullable<NonNullable<ListOrganizationProjectKeysData['query']>["status"]>;
|
|
80
|
+
/** A value of the `field` query parameter of `listOrganizationReplays`. */
|
|
81
|
+
export type ListOrganizationReplaysQueryField = NonNullable<NonNullable<ListOrganizationReplaysData['query']>["field"]>[number];
|
|
82
|
+
/** A value of the `status` query parameter of `listOrganizationRepos`. */
|
|
83
|
+
export type ListOrganizationReposQueryStatus = NonNullable<NonNullable<ListOrganizationReposData['query']>["status"]>;
|
|
84
|
+
/** A value of the `category` query parameter of `listOrganizationStatsV2`. */
|
|
85
|
+
export type ListOrganizationStatsV2QueryCategory = NonNullable<NonNullable<ListOrganizationStatsV2Data['query']>["category"]>;
|
|
86
|
+
/** A value of the `field` query parameter of `listOrganizationStatsV2`. */
|
|
87
|
+
export type ListOrganizationStatsV2QueryField = NonNullable<NonNullable<ListOrganizationStatsV2Data['query']>["field"]>;
|
|
88
|
+
/** A value of the `groupBy` query parameter of `listOrganizationStatsV2`. */
|
|
89
|
+
export type ListOrganizationStatsV2QueryGroupBy = NonNullable<NonNullable<ListOrganizationStatsV2Data['query']>["groupBy"]>[number];
|
|
90
|
+
/** A value of the `outcome` query parameter of `listOrganizationStatsV2`. */
|
|
91
|
+
export type ListOrganizationStatsV2QueryOutcome = NonNullable<NonNullable<ListOrganizationStatsV2Data['query']>["outcome"]>;
|
|
92
|
+
/** A value of the `dataset` query parameter of `listOrganizationTags`. */
|
|
93
|
+
export type ListOrganizationTagsQueryDataset = NonNullable<NonNullable<ListOrganizationTagsData['query']>["dataset"]>;
|
|
94
|
+
/** A value of the `use_cache` query parameter of `listOrganizationTags`. */
|
|
95
|
+
export type ListOrganizationTagsQueryUseCache = NonNullable<NonNullable<ListOrganizationTagsData['query']>["use_cache"]>;
|
|
96
|
+
/** A value of the `useFlagsBackend` query parameter of `listOrganizationTags`. */
|
|
97
|
+
export type ListOrganizationTagsQueryUseFlagsBackend = NonNullable<NonNullable<ListOrganizationTagsData['query']>["useFlagsBackend"]>;
|
|
98
|
+
/** A value of the `attributeType` query parameter of `listOrganizationTraceItemAttributes`. */
|
|
99
|
+
export type ListOrganizationTraceItemAttributesQueryAttributeType = NonNullable<NonNullable<ListOrganizationTraceItemAttributesData['query']>["attributeType"]>[number];
|
|
100
|
+
/** A value of the `dataset` query parameter of `listOrganizationTraceItemAttributes`. */
|
|
101
|
+
export type ListOrganizationTraceItemAttributesQueryDataset = NonNullable<NonNullable<ListOrganizationTraceItemAttributesData['query']>["dataset"]>;
|
|
102
|
+
/** A value of the `expand` query parameter of `listOrganizationTraceItemAttributes`. */
|
|
103
|
+
export type ListOrganizationTraceItemAttributesQueryExpand = NonNullable<NonNullable<ListOrganizationTraceItemAttributesData['query']>["expand"]>[number];
|
|
104
|
+
/** A value of the `itemType` query parameter of `listOrganizationTraceItemAttributes`. */
|
|
105
|
+
export type ListOrganizationTraceItemAttributesQueryItemType = NonNullable<NonNullable<ListOrganizationTraceItemAttributesData['query']>["itemType"]>;
|
|
106
|
+
/** A value of the `itemType` query parameter of `listOrganizationTraceItemsStats`. */
|
|
107
|
+
export type ListOrganizationTraceItemsStatsQueryItemType = NonNullable<NonNullable<ListOrganizationTraceItemsStatsData['query']>["itemType"]>;
|
|
108
|
+
/** A value of the `statsType` query parameter of `listOrganizationTraceItemsStats`. */
|
|
109
|
+
export type ListOrganizationTraceItemsStatsQueryStatsType = NonNullable<NonNullable<ListOrganizationTraceItemsStatsData['query']>["statsType"]>[number];
|
|
110
|
+
/** A value of the `expand` query parameter of `listOrganizationTraceMetrics`. */
|
|
111
|
+
export type ListOrganizationTraceMetricsQueryExpand = NonNullable<NonNullable<ListOrganizationTraceMetricsData['query']>["expand"]>[number];
|
|
112
|
+
/** A value of the `sort` query parameter of `listOrganizationTraceMetrics`. */
|
|
113
|
+
export type ListOrganizationTraceMetricsQuerySort = NonNullable<NonNullable<ListOrganizationTraceMetricsData['query']>["sort"]>;
|
|
114
|
+
/** A value of the `expand` query parameter of `listProjectCodeOwners`. */
|
|
115
|
+
export type ListProjectCodeOwnersQueryExpand = NonNullable<NonNullable<ListProjectCodeOwnersData['query']>["expand"]>[number];
|
|
116
|
+
/** A value of the `visibility` query parameter of `listProjectEnvironments`. */
|
|
117
|
+
export type ListProjectEnvironmentsQueryVisibility = NonNullable<NonNullable<ListProjectEnvironmentsData['query']>["visibility"]>;
|
|
118
|
+
/** A value of the `sort` query parameter of `listProjectIssues`. */
|
|
119
|
+
export type ListProjectIssuesQuerySort = NonNullable<NonNullable<ListProjectIssuesData['query']>["sort"]>;
|
|
120
|
+
/** A value of the `resolution` query parameter of `listProjectStats`. */
|
|
121
|
+
export type ListProjectStatsQueryResolution = NonNullable<NonNullable<ListProjectStatsData['query']>["resolution"]>;
|
|
122
|
+
/** A value of the `stat` query parameter of `listProjectStats`. */
|
|
123
|
+
export type ListProjectStatsQueryStat = NonNullable<NonNullable<ListProjectStatsData['query']>["stat"]>;
|
|
124
|
+
/** A value of the `collapse` query parameter of `resolveOrganizationShortId`. */
|
|
125
|
+
export type ResolveOrganizationShortIdQueryCollapse = NonNullable<NonNullable<ResolveOrganizationShortIdData['query']>["collapse"]>[number];
|
|
126
|
+
/** A value of the `view` query parameter of `retrieveOrganizationAiConversation`. */
|
|
127
|
+
export type RetrieveOrganizationAiConversationQueryView = NonNullable<NonNullable<RetrieveOrganizationAiConversationData['query']>["view"]>;
|
|
128
|
+
/** A value of the `sort` query parameter of `updateOrganizationIssues`. */
|
|
129
|
+
export type UpdateOrganizationIssuesQuerySort = NonNullable<NonNullable<UpdateOrganizationIssuesData['query']>["sort"]>;
|