@sentry/api 0.421.0 → 0.423.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 CHANGED
@@ -90,6 +90,7 @@ A few operations send a query parameter by default to skip expensive work most c
90
90
  | Operation | Default | Effect |
91
91
  | --- | --- | --- |
92
92
  | `getOrganizationIssueEvent` | `collapse: ["adjacentEvents"]` | Skips the next/previous event lookups; `nextEventID` and `previousEventID` are `null` |
93
+ | `getProjectEvent` | `collapse: ["adjacentEvents"]` | Skips the next/previous event lookups; `nextEventID` and `previousEventID` are `null` |
93
94
 
94
95
  The default applies only when the parameter is omitted or `undefined`. Any value you pass replaces it, and an empty list sends nothing:
95
96
 
package/dist/index.js CHANGED
@@ -1890,7 +1890,8 @@ var listProjectEvents = (options) => (options.client ?? client).get({
1890
1890
  var getProjectEvent = (options) => (options.client ?? client).get({
1891
1891
  security: [{ scheme: "bearer", type: "http" }],
1892
1892
  url: "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/events/{event_id}/",
1893
- ...options
1893
+ ...options,
1894
+ query: { ...options?.query, collapse: options?.query?.["collapse"] ?? ["adjacentEvents"] }
1894
1895
  });
1895
1896
  var listProjectEventAttachments = (options) => (options.client ?? client).get({
1896
1897
  security: [{ scheme: "bearer", type: "http" }],
@@ -6636,6 +6636,15 @@ Update a custom inbound filter's name, active state, or conditions.`,
6636
6636
  required: false,
6637
6637
  description: "The name of environments to filter by.",
6638
6638
  type: "array"
6639
+ },
6640
+ {
6641
+ name: "collapse",
6642
+ required: false,
6643
+ description: "Parts of the response to skip computing. Specify `adjacentEvents` to skip looking up the neighboring events in the issue; `nextEventID` and `previousEventID` are then always `null`. Unknown values are ignored.",
6644
+ type: "array",
6645
+ enum: [
6646
+ "adjacentEvents"
6647
+ ]
6639
6648
  }
6640
6649
  ],
6641
6650
  deprecated: false,
@@ -1,4 +1,4 @@
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';
1
+ import type { DeleteOrganizationIssuesData, GetOrganizationIssueAutofixStateData, GetOrganizationIssueData, GetOrganizationIssueEventData, GetOrganizationIssueIntegrationData, GetOrganizationProfilingFlamegraphData, GetOrganizationReleaseData, GetOrganizationReplayCountData, GetOrganizationReplayData, GetOrganizationStatsSummaryData, GetOrganizationTraceData, GetOrganizationTraceMetaData, GetProjectEventData, 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
2
  /** A value of the `sort` query parameter of `deleteOrganizationIssues`. */
3
3
  export type DeleteOrganizationIssuesQuerySort = NonNullable<NonNullable<DeleteOrganizationIssuesData['query']>["sort"]>;
4
4
  /** A value of the `llmFormat` query parameter of `getOrganizationIssueAutofixState`. */
@@ -39,6 +39,8 @@ export type GetOrganizationStatsSummaryQueryOutcome = NonNullable<NonNullable<Ge
39
39
  export type GetOrganizationTraceMetaQueryIncludeUptime = NonNullable<NonNullable<GetOrganizationTraceMetaData['query']>["include_uptime"]>;
40
40
  /** A value of the `include_uptime` query parameter of `getOrganizationTrace`. */
41
41
  export type GetOrganizationTraceQueryIncludeUptime = NonNullable<NonNullable<GetOrganizationTraceData['query']>["include_uptime"]>;
42
+ /** A value of the `collapse` query parameter of `getProjectEvent`. */
43
+ export type GetProjectEventQueryCollapse = NonNullable<NonNullable<GetProjectEventData['query']>["collapse"]>[number];
42
44
  /** A value of the `filter` query parameter of `listOrganizationDashboards`. */
43
45
  export type ListOrganizationDashboardsQueryFilter = NonNullable<NonNullable<ListOrganizationDashboardsData['query']>["filter"]>[number];
44
46
  /** A value of the `pin` query parameter of `listOrganizationDashboards`. */
package/dist/sdk.gen.d.ts CHANGED
@@ -1440,6 +1440,8 @@ export declare const listProjectEvents: <ThrowOnError extends boolean = false>(o
1440
1440
  * Retrieve an Event for a Project
1441
1441
  *
1442
1442
  * Return details on an individual event.
1443
+ *
1444
+ * By default, the SDK sends `collapse: ["adjacentEvents"]`, which skips looking up the neighboring events (`nextEventID` and `previousEventID` are `null`). Passing the parameter replaces the default; `collapse: []` sends none.
1443
1445
  */
1444
1446
  export declare const getProjectEvent: <ThrowOnError extends boolean = false>(options: Options<GetProjectEventData, ThrowOnError>) => import("./client").RequestResult<GetProjectEventResponses, GetProjectEventErrors, ThrowOnError, "fields">;
1445
1447
  /**
@@ -1436,6 +1436,8 @@ export declare function createSentryClient(config?: Config): {
1436
1436
  * Retrieve an Event for a Project
1437
1437
  *
1438
1438
  * Return details on an individual event.
1439
+ *
1440
+ * By default, the SDK sends `collapse: ["adjacentEvents"]`, which skips looking up the neighboring events (`nextEventID` and `previousEventID` are `null`). Passing the parameter replaces the default; `collapse: []` sends none.
1439
1441
  */
1440
1442
  readonly getProjectEvent: <ThrowOnError extends boolean = false>(options: Omit<NonNullable<sdk.Options<types.GetProjectEventData, ThrowOnError>>, "client">) => import("./client").RequestResult<types.GetProjectEventResponses, types.GetProjectEventErrors, ThrowOnError, "fields">;
1441
1443
  /**
@@ -32543,6 +32543,10 @@ export type GetProjectEventData = {
32543
32543
  * The name of environments to filter by.
32544
32544
  */
32545
32545
  environment?: Array<string>;
32546
+ /**
32547
+ * Parts of the response to skip computing. Specify `adjacentEvents` to skip looking up the neighboring events in the issue; `nextEventID` and `previousEventID` are then always `null`. Unknown values are ignored.
32548
+ */
32549
+ collapse?: Array<'adjacentEvents'>;
32546
32550
  };
32547
32551
  url: '/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/events/{event_id}/';
32548
32552
  };
@@ -15816,6 +15816,7 @@ export declare const vGetProjectEventData: v.ObjectSchema<{
15816
15816
  }, undefined>;
15817
15817
  readonly query: v.OptionalSchema<v.ObjectSchema<{
15818
15818
  readonly environment: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
15819
+ readonly collapse: v.OptionalSchema<v.ArraySchema<v.PicklistSchema<["adjacentEvents"], undefined>, undefined>, undefined>;
15819
15820
  }, undefined>, undefined>;
15820
15821
  }, undefined>;
15821
15822
  export declare const vGetProjectEventResponse: v.ObjectSchema<{
package/dist/valibot.js CHANGED
@@ -19597,7 +19597,8 @@ var vGetProjectEventData = v.object({
19597
19597
  event_id: v.pipe(v.string(), v.regex(/^[0-9a-f]{32}$/))
19598
19598
  }),
19599
19599
  query: v.optional(v.object({
19600
- environment: v.optional(v.array(v.string()))
19600
+ environment: v.optional(v.array(v.string())),
19601
+ collapse: v.optional(v.array(v.picklist(["adjacentEvents"])))
19601
19602
  }))
19602
19603
  });
19603
19604
  var vGetProjectEventResponse = v.object({
package/dist/zod.gen.d.ts CHANGED
@@ -77354,10 +77354,13 @@ export declare const zGetProjectEventData: z.ZodObject<{
77354
77354
  }>;
77355
77355
  query: z.ZodOptional<z.ZodObject<{
77356
77356
  environment: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
77357
+ collapse: z.ZodOptional<z.ZodArray<z.ZodEnum<["adjacentEvents"]>, "many">>;
77357
77358
  }, "strip", z.ZodTypeAny, {
77358
77359
  environment?: string[] | undefined;
77360
+ collapse?: "adjacentEvents"[] | undefined;
77359
77361
  }, {
77360
77362
  environment?: string[] | undefined;
77363
+ collapse?: "adjacentEvents"[] | undefined;
77361
77364
  }>>;
77362
77365
  }, "strip", z.ZodTypeAny, {
77363
77366
  path: {
@@ -77367,6 +77370,7 @@ export declare const zGetProjectEventData: z.ZodObject<{
77367
77370
  };
77368
77371
  query?: {
77369
77372
  environment?: string[] | undefined;
77373
+ collapse?: "adjacentEvents"[] | undefined;
77370
77374
  } | undefined;
77371
77375
  body?: undefined;
77372
77376
  }, {
@@ -77377,6 +77381,7 @@ export declare const zGetProjectEventData: z.ZodObject<{
77377
77381
  };
77378
77382
  query?: {
77379
77383
  environment?: string[] | undefined;
77384
+ collapse?: "adjacentEvents"[] | undefined;
77380
77385
  } | undefined;
77381
77386
  body?: undefined;
77382
77387
  }>;
package/dist/zod.js CHANGED
@@ -28683,7 +28683,8 @@ var zGetProjectEventData = z.object({
28683
28683
  event_id: z.string().regex(/^[0-9a-f]{32}$/)
28684
28684
  }),
28685
28685
  query: z.object({
28686
- environment: z.array(z.string()).optional()
28686
+ environment: z.array(z.string()).optional(),
28687
+ collapse: z.array(z.enum(["adjacentEvents"])).optional()
28687
28688
  }).optional()
28688
28689
  });
28689
28690
  var zGetProjectEventResponse = z.object({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sentry/api",
3
- "version": "0.421.0",
3
+ "version": "0.423.0",
4
4
  "description": "Official auto-generated TypeScript client for the Sentry public REST API",
5
5
  "keywords": [
6
6
  "sentry",