@sentry/api 1.29.2 → 1.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -2491,11 +2491,6 @@ var updateProjectIssues = (options) => (options.client ?? client).put({
2491
2491
  ...options.headers
2492
2492
  }
2493
2493
  });
2494
- var listOrganizationIssueTagValues = (options) => (options.client ?? client).get({
2495
- security: [{ scheme: "bearer", type: "http" }],
2496
- url: "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/tags/{key}/values/",
2497
- ...options
2498
- });
2499
2494
  var listOrganizationReleaseCommitfiles = (options) => (options.client ?? client).get({
2500
2495
  security: [{ scheme: "bearer", type: "http" }],
2501
2496
  url: "/api/0/organizations/{organization_id_or_slug}/releases/{version}/commitfiles/",
@@ -2635,6 +2630,11 @@ var getOrganizationIssueTag = (options) => (options.client ?? client).get({
2635
2630
  url: "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/tags/{key}/",
2636
2631
  ...options
2637
2632
  });
2633
+ var listOrganizationIssueTagValues = (options) => (options.client ?? client).get({
2634
+ security: [{ scheme: "bearer", type: "http" }],
2635
+ url: "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/tags/{key}/values/",
2636
+ ...options
2637
+ });
2638
2638
 
2639
2639
  // src/sentry-pagination.ts
2640
2640
  function assertPositiveInteger(value, name) {
@@ -6741,13 +6741,6 @@ function createSentryClient(config = {}) {
6741
6741
  * If any IDs are out of scope this operation will succeed without any data mutation.
6742
6742
  */
6743
6743
  updateProjectIssues: (...args) => updateProjectIssues(...[{ ...args[0], client: client2 }]),
6744
- /**
6745
- * List a Tag's Values for an Issue
6746
- *
6747
- * Returns a list of values associated with this key for an issue.
6748
- * Returns at most 1000 values when paginated.
6749
- */
6750
- listOrganizationIssueTagValues: (...args) => listOrganizationIssueTagValues(...[{ ...args[0], client: client2 }]),
6751
6744
  /**
6752
6745
  * Retrieve files changed in a release's commits
6753
6746
  */
@@ -6781,8 +6774,8 @@ function createSentryClient(config = {}) {
6781
6774
  /**
6782
6775
  * Retrieve an Issue
6783
6776
  *
6784
- * Return details on an individual issue, including its basic stats, comment
6785
- * and user-report counts, and a summary of the latest event.
6777
+ * Return details on an individual issue, including its basic stats, comment count, and
6778
+ * user-report count.
6786
6779
  */
6787
6780
  getOrganizationIssue: (...args) => getOrganizationIssue(...[{ ...args[0], client: client2 }]),
6788
6781
  /**
@@ -6824,7 +6817,7 @@ function createSentryClient(config = {}) {
6824
6817
  /**
6825
6818
  * List an Issue's Events
6826
6819
  *
6827
- * Return a list of error events bound to an issue
6820
+ * Return a list of events bound to an issue.
6828
6821
  */
6829
6822
  listOrganizationIssueEvents: (...args) => listOrganizationIssueEvents(...[{ ...args[0], client: client2 }]),
6830
6823
  /**
@@ -6902,6 +6895,13 @@ function createSentryClient(config = {}) {
6902
6895
  * Return a list of values associated with this key for an issue. When paginated can return at most 1000 values.
6903
6896
  */
6904
6897
  getOrganizationIssueTag: (...args) => getOrganizationIssueTag(...[{ ...args[0], client: client2 }]),
6898
+ /**
6899
+ * List a Tag's Values for an Issue
6900
+ *
6901
+ * Returns a list of values associated with this key for an issue.
6902
+ * Returns at most 1000 values when paginated.
6903
+ */
6904
+ listOrganizationIssueTagValues: (...args) => listOrganizationIssueTagValues(...[{ ...args[0], client: client2 }]),
6905
6905
  fetchPage: {
6906
6906
  /** Fetch a single page of `getOrganizationReplay` with cursors from the Link header. */
6907
6907
  getOrganizationReplay: (options, cursor) => fetchPage_getOrganizationReplay({ ...options, client: client2 }, cursor),
@@ -1813,13 +1813,7 @@ var operations = [
1813
1813
  {
1814
1814
  "name": "query",
1815
1815
  "required": false,
1816
- "description": "An optional search query for filtering issues. A default query will apply if no view/query is set. For all results use this parameter with an empty string.",
1817
- "type": "string"
1818
- },
1819
- {
1820
- "name": "viewId",
1821
- "required": false,
1822
- "description": "The ID of the view to use. If no query is present, the view's query and filters will be applied.",
1816
+ "description": "An optional search query for filtering issues. A default query will apply if no query is set. For all results use this parameter with an empty string.",
1823
1817
  "type": "string"
1824
1818
  },
1825
1819
  {
@@ -1836,12 +1830,6 @@ var operations = [
1836
1830
  "trends",
1837
1831
  "user"
1838
1832
  ]
1839
- },
1840
- {
1841
- "name": "limit",
1842
- "required": false,
1843
- "description": "The maximum number of issues to affect. The maximum is 100.",
1844
- "type": "integer"
1845
1833
  }
1846
1834
  ],
1847
1835
  "deprecated": false,
@@ -1928,13 +1916,7 @@ var operations = [
1928
1916
  {
1929
1917
  "name": "query",
1930
1918
  "required": false,
1931
- "description": "An optional search query for filtering issues. A default query will apply if no view/query is set. For all results use this parameter with an empty string.",
1932
- "type": "string"
1933
- },
1934
- {
1935
- "name": "viewId",
1936
- "required": false,
1937
- "description": "The ID of the view to use. If no query is present, the view's query and filters will be applied.",
1919
+ "description": "An optional search query for filtering issues. A default query will apply if no query is set. For all results use this parameter with an empty string.",
1938
1920
  "type": "string"
1939
1921
  },
1940
1922
  {
@@ -1955,7 +1937,7 @@ var operations = [
1955
1937
  {
1956
1938
  "name": "limit",
1957
1939
  "required": false,
1958
- "description": "The maximum number of issues to affect. The maximum is 100.",
1940
+ "description": "The maximum number of issues to return. The maximum is 100.",
1959
1941
  "type": "integer"
1960
1942
  },
1961
1943
  {
@@ -2048,13 +2030,7 @@ var operations = [
2048
2030
  {
2049
2031
  "name": "query",
2050
2032
  "required": false,
2051
- "description": "An optional search query for filtering issues. A default query will apply if no view/query is set. For all results use this parameter with an empty string.",
2052
- "type": "string"
2053
- },
2054
- {
2055
- "name": "viewId",
2056
- "required": false,
2057
- "description": "The ID of the view to use. If no query is present, the view's query and filters will be applied.",
2033
+ "description": "An optional search query for filtering issues. A default query will apply if no query is set. For all results use this parameter with an empty string.",
2058
2034
  "type": "string"
2059
2035
  },
2060
2036
  {
@@ -2071,12 +2047,6 @@ var operations = [
2071
2047
  "trends",
2072
2048
  "user"
2073
2049
  ]
2074
- },
2075
- {
2076
- "name": "limit",
2077
- "required": false,
2078
- "description": "The maximum number of issues to affect. The maximum is 100.",
2079
- "type": "integer"
2080
2050
  }
2081
2051
  ],
2082
2052
  "deprecated": false,
@@ -2106,7 +2076,7 @@ var operations = [
2106
2076
  "method": "GET",
2107
2077
  "path": "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/",
2108
2078
  "summary": "Retrieve an Issue",
2109
- "description": "Return details on an individual issue, including its basic stats, comment\nand user-report counts, and a summary of the latest event.",
2079
+ "description": "Return details on an individual issue, including its basic stats, comment count, and\nuser-report count.",
2110
2080
  "tags": [
2111
2081
  "Events"
2112
2082
  ],
@@ -2222,7 +2192,7 @@ var operations = [
2222
2192
  "method": "GET",
2223
2193
  "path": "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/events/",
2224
2194
  "summary": "List an Issue's Events",
2225
- "description": "Return a list of error events bound to an issue",
2195
+ "description": "Return a list of events bound to an issue.",
2226
2196
  "tags": [
2227
2197
  "Events"
2228
2198
  ],
package/dist/sdk.gen.d.ts CHANGED
@@ -2154,13 +2154,6 @@ export declare const listProjectIssues: <ThrowOnError extends boolean = false>(o
2154
2154
  * If any IDs are out of scope this operation will succeed without any data mutation.
2155
2155
  */
2156
2156
  export declare const updateProjectIssues: <ThrowOnError extends boolean = false>(options: Options<UpdateProjectIssuesData, ThrowOnError>) => RequestResult<UpdateProjectIssuesResponses, UpdateProjectIssuesErrors, ThrowOnError>;
2157
- /**
2158
- * List a Tag's Values for an Issue
2159
- *
2160
- * Returns a list of values associated with this key for an issue.
2161
- * Returns at most 1000 values when paginated.
2162
- */
2163
- export declare const listOrganizationIssueTagValues: <ThrowOnError extends boolean = false>(options: Options<ListOrganizationIssueTagValuesData, ThrowOnError>) => RequestResult<ListOrganizationIssueTagValuesResponses, ListOrganizationIssueTagValuesErrors, ThrowOnError>;
2164
2157
  /**
2165
2158
  * Retrieve files changed in a release's commits
2166
2159
  */
@@ -2194,8 +2187,8 @@ export declare const deleteOrganizationIssue: <ThrowOnError extends boolean = fa
2194
2187
  /**
2195
2188
  * Retrieve an Issue
2196
2189
  *
2197
- * Return details on an individual issue, including its basic stats, comment
2198
- * and user-report counts, and a summary of the latest event.
2190
+ * Return details on an individual issue, including its basic stats, comment count, and
2191
+ * user-report count.
2199
2192
  */
2200
2193
  export declare const getOrganizationIssue: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationIssueData, ThrowOnError>) => RequestResult<GetOrganizationIssueResponses, GetOrganizationIssueErrors, ThrowOnError>;
2201
2194
  /**
@@ -2237,7 +2230,7 @@ export declare const startOrganizationIssueAutofix: <ThrowOnError extends boolea
2237
2230
  /**
2238
2231
  * List an Issue's Events
2239
2232
  *
2240
- * Return a list of error events bound to an issue
2233
+ * Return a list of events bound to an issue.
2241
2234
  */
2242
2235
  export declare const listOrganizationIssueEvents: <ThrowOnError extends boolean = false>(options: Options<ListOrganizationIssueEventsData, ThrowOnError>) => RequestResult<ListOrganizationIssueEventsResponses, ListOrganizationIssueEventsErrors, ThrowOnError>;
2243
2236
  /**
@@ -2315,3 +2308,10 @@ export declare const updateOrganizationIssueIntegration: <ThrowOnError extends b
2315
2308
  * Return a list of values associated with this key for an issue. When paginated can return at most 1000 values.
2316
2309
  */
2317
2310
  export declare const getOrganizationIssueTag: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationIssueTagData, ThrowOnError>) => RequestResult<GetOrganizationIssueTagResponses, GetOrganizationIssueTagErrors, ThrowOnError>;
2311
+ /**
2312
+ * List a Tag's Values for an Issue
2313
+ *
2314
+ * Returns a list of values associated with this key for an issue.
2315
+ * Returns at most 1000 values when paginated.
2316
+ */
2317
+ export declare const listOrganizationIssueTagValues: <ThrowOnError extends boolean = false>(options: Options<ListOrganizationIssueTagValuesData, ThrowOnError>) => RequestResult<ListOrganizationIssueTagValuesResponses, ListOrganizationIssueTagValuesErrors, ThrowOnError>;
@@ -2150,13 +2150,6 @@ export declare function createSentryClient(config?: Config): {
2150
2150
  * If any IDs are out of scope this operation will succeed without any data mutation.
2151
2151
  */
2152
2152
  readonly updateProjectIssues: <ThrowOnError extends boolean = false>(options: Omit<NonNullable<sdk.Options<types.UpdateProjectIssuesData, ThrowOnError, unknown>>, "client">) => import("./client").RequestResult<types.UpdateProjectIssuesResponses, types.UpdateProjectIssuesErrors, ThrowOnError>;
2153
- /**
2154
- * List a Tag's Values for an Issue
2155
- *
2156
- * Returns a list of values associated with this key for an issue.
2157
- * Returns at most 1000 values when paginated.
2158
- */
2159
- readonly listOrganizationIssueTagValues: <ThrowOnError extends boolean = false>(options: Omit<NonNullable<sdk.Options<types.ListOrganizationIssueTagValuesData, ThrowOnError, unknown>>, "client">) => import("./client").RequestResult<types.ListOrganizationIssueTagValuesResponses, types.ListOrganizationIssueTagValuesErrors, ThrowOnError>;
2160
2153
  /**
2161
2154
  * Retrieve files changed in a release's commits
2162
2155
  */
@@ -2190,8 +2183,8 @@ export declare function createSentryClient(config?: Config): {
2190
2183
  /**
2191
2184
  * Retrieve an Issue
2192
2185
  *
2193
- * Return details on an individual issue, including its basic stats, comment
2194
- * and user-report counts, and a summary of the latest event.
2186
+ * Return details on an individual issue, including its basic stats, comment count, and
2187
+ * user-report count.
2195
2188
  */
2196
2189
  readonly getOrganizationIssue: <ThrowOnError extends boolean = false>(options: Omit<NonNullable<sdk.Options<types.GetOrganizationIssueData, ThrowOnError, unknown>>, "client">) => import("./client").RequestResult<types.GetOrganizationIssueResponses, types.GetOrganizationIssueErrors, ThrowOnError>;
2197
2190
  /**
@@ -2233,7 +2226,7 @@ export declare function createSentryClient(config?: Config): {
2233
2226
  /**
2234
2227
  * List an Issue's Events
2235
2228
  *
2236
- * Return a list of error events bound to an issue
2229
+ * Return a list of events bound to an issue.
2237
2230
  */
2238
2231
  readonly listOrganizationIssueEvents: <ThrowOnError extends boolean = false>(options: Omit<NonNullable<sdk.Options<types.ListOrganizationIssueEventsData, ThrowOnError, unknown>>, "client">) => import("./client").RequestResult<types.ListOrganizationIssueEventsResponses, types.ListOrganizationIssueEventsErrors, ThrowOnError>;
2239
2232
  /**
@@ -2311,6 +2304,13 @@ export declare function createSentryClient(config?: Config): {
2311
2304
  * Return a list of values associated with this key for an issue. When paginated can return at most 1000 values.
2312
2305
  */
2313
2306
  readonly getOrganizationIssueTag: <ThrowOnError extends boolean = false>(options: Omit<NonNullable<sdk.Options<types.GetOrganizationIssueTagData, ThrowOnError, unknown>>, "client">) => import("./client").RequestResult<types.GetOrganizationIssueTagResponses, types.GetOrganizationIssueTagErrors, ThrowOnError>;
2307
+ /**
2308
+ * List a Tag's Values for an Issue
2309
+ *
2310
+ * Returns a list of values associated with this key for an issue.
2311
+ * Returns at most 1000 values when paginated.
2312
+ */
2313
+ readonly listOrganizationIssueTagValues: <ThrowOnError extends boolean = false>(options: Omit<NonNullable<sdk.Options<types.ListOrganizationIssueTagValuesData, ThrowOnError, unknown>>, "client">) => import("./client").RequestResult<types.ListOrganizationIssueTagValuesResponses, types.ListOrganizationIssueTagValuesErrors, ThrowOnError>;
2314
2314
  readonly fetchPage: {
2315
2315
  /** Fetch a single page of `getOrganizationReplay` with cursors from the Link header. */
2316
2316
  readonly getOrganizationReplay: (options: Omit<NonNullable<Parameters<typeof pagination.fetchPage_getOrganizationReplay>[0]>, "client">, cursor?: Parameters<typeof pagination.fetchPage_getOrganizationReplay>[1]) => Promise<import("./sentry-pagination").PaginatedResponse<{
@@ -3110,11 +3110,11 @@ export declare function createSentryClient(config?: Config): {
3110
3110
  } | null;
3111
3111
  date_added: string;
3112
3112
  };
3113
- owners: {
3113
+ owners: Array<{
3114
3114
  type: string;
3115
3115
  owner: string;
3116
3116
  date_added: string;
3117
- };
3117
+ }> | null;
3118
3118
  integrationIssues: Array<{
3119
3119
  [key: string]: unknown;
3120
3120
  }>;
@@ -5944,11 +5944,11 @@ export declare function createSentryClient(config?: Config): {
5944
5944
  } | null;
5945
5945
  date_added: string;
5946
5946
  };
5947
- owners: {
5947
+ owners: Array<{
5948
5948
  type: string;
5949
5949
  owner: string;
5950
5950
  date_added: string;
5951
- };
5951
+ }> | null;
5952
5952
  integrationIssues: Array<{
5953
5953
  [key: string]: unknown;
5954
5954
  }>;
@@ -8539,11 +8539,11 @@ export declare function createSentryClient(config?: Config): {
8539
8539
  } | null;
8540
8540
  date_added: string;
8541
8541
  };
8542
- owners: {
8542
+ owners: Array<{
8543
8543
  type: string;
8544
8544
  owner: string;
8545
8545
  date_added: string;
8546
- };
8546
+ }> | null;
8547
8547
  integrationIssues: Array<{
8548
8548
  [key: string]: unknown;
8549
8549
  }>;