@rustrak/client 0.14.12 → 0.14.14

package/dist/index.d.cts

@@ -182,6 +182,7 @@ declare const providerTypeSchema: z.ZodEnum<{
     webhook: "webhook";
     email: "email";
     slack: "slack";
+    custom_webhook: "custom_webhook";
 }>;
 declare const alertTypeSchema: z.ZodEnum<{
     new_issue: "new_issue";
@@ -201,6 +202,7 @@ declare const alertIntegrationSchema: z.ZodObject<{
         webhook: "webhook";
         email: "email";
         slack: "slack";
+        custom_webhook: "custom_webhook";
     }>;
     credentials: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     is_enabled: z.ZodBoolean;
@@ -217,6 +219,7 @@ declare const createAlertIntegrationSchema: z.ZodObject<{
         webhook: "webhook";
         email: "email";
         slack: "slack";
+        custom_webhook: "custom_webhook";
     }>;
     credentials: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     is_enabled: z.ZodOptional<z.ZodBoolean>;
@@ -302,6 +305,12 @@ declare const alertHistorySchema: z.ZodObject<{
 declare const testChannelResponseSchema: z.ZodObject<{
     success: z.ZodBoolean;
     message: z.ZodString;
+    response_body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+declare const previewTemplateResponseSchema: z.ZodObject<{
+    ok: z.ZodBoolean;
+    rendered: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 declare const testIntegrationBodySchema: z.ZodObject<{
     routing_override: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -320,6 +329,7 @@ type CreateAlertRule = z.infer<typeof createAlertRuleSchema>;
 type UpdateAlertRule = z.infer<typeof updateAlertRuleSchema>;
 type AlertHistory = z.infer<typeof alertHistorySchema>;
 type TestChannelResponse = z.infer<typeof testChannelResponseSchema>;
+type PreviewTemplateResponse = z.infer<typeof previewTemplateResponseSchema>;
 type TestIntegrationBody = z.infer<typeof testIntegrationBodySchema>;
 interface ListAlertHistoryOptions {
     limit?: number;
@@ -1159,6 +1169,7 @@ declare class AlertIntegrationsResource extends BaseResource {
     update(id: number, input: UpdateAlertIntegration): Promise<Result<AlertIntegration, RustrakError>>;
     delete(id: number): Promise<Result<void, RustrakError>>;
     test(id: number, routingOverride?: RoutingOverride): Promise<Result<TestChannelResponse, RustrakError>>;
+    previewTemplate(template: string): Promise<Result<PreviewTemplateResponse, RustrakError>>;
 }
 
 declare class AlertRulesResource extends BaseResource {
@@ -1333,4 +1344,4 @@ declare class RustrakClient {
     constructor(config: ClientConfig);
 }
 
-export { type AcceptInvitation, type ActivityEntry, type AgentBreakdownOptions, type AgentDurationPoint, type AgentModelRow, type AgentSummary, type AgentTimeseriesOptions, type AgentTimeseriesPoint, type AgentToolRow, type AgentTraceSummary, type AgentTracesOptions, type AlertHistory, type AlertIntegration, type AlertRule, type AlertRuleChannelInput, type AlertStatus, type AlertType, type ApiError, type AssembleInput, type AssembleResponse, type AuthResponse, type AuthToken, type AuthTokenCreated, type BulkDeleteIssues, type BulkUpdateIssues, type ChunkUploadCapability, type CleanupCounts, type CleanupOptions, type ClientConfig, type CreateAlertIntegration, type CreateAlertRule, type CreateAuthToken, type CreateComment, type CreateInvitation, type CreateProject, type CreateUserReport, Err, type Event, type EventDetail, type EventTimeseries, type EventTimeseriesPoint, FIELD_ERROR_CODES, type FieldError, type FieldErrorCode, type GenAiBreakdownRow, type GlobalRole, type Invitation, type InvitationInfo, type Issue, type IssueAggregates, type IssueFilter, type IssueHash, type IssuePriority, type IssueSort, type IssueStats, type IssueStatsWindow, type IssueStatus, type IssueTagValue, type ListAlertHistoryOptions, type ListEventsOptions, type ListIssuesOptions, type ListLogsOptions, type ListProjectsOptions, type ListSourceMapsResponse, type ListSpansOptions, type ListTransactionsOptions, type Log, type LoginRequest, type LoginResult, type MetricDelta, NETWORK_ERROR_MESSAGE, type OffsetPaginatedResponse, Ok, type PaginatedResponse, type Project, type ProjectListStats, type ProjectMember, type ProjectRole, type ProjectStatsSummary, type ProjectStorage, type ProviderType, type RegisterRequest, type ReleaseHealthRow, type ReleaseHealthStatsOptions, type Result, type RoutingOverride, RustrakClient, type RustrakError, type RustrakErrorKind, SERVER_ERROR_MESSAGE, type ServerVersion, type SessionSummary, type SessionTimeseries, type SessionTimeseriesPoint, type SortOrder, type SourceMapFile, type SourceMapGcResult, type SourceMapStorage, type Span, type SpanDetail, type StorageSummary, TIMEOUT_ERROR_MESSAGE, type TagSummary, type TagValueCount, type TeamMember, type TestChannelResponse, type TestIntegrationBody, type Transaction, type TransactionDetail, type TransactionStats, type UpdateAlertIntegration, type UpdateAlertRule, type UpdateIssueState, type UpdateProject, type UpdateUserRole, type UpsertProjectMember, type User, type UserReport, isRetryable, mapResult, unwrap, unwrapOr };
+export { type AcceptInvitation, type ActivityEntry, type AgentBreakdownOptions, type AgentDurationPoint, type AgentModelRow, type AgentSummary, type AgentTimeseriesOptions, type AgentTimeseriesPoint, type AgentToolRow, type AgentTraceSummary, type AgentTracesOptions, type AlertHistory, type AlertIntegration, type AlertRule, type AlertRuleChannelInput, type AlertStatus, type AlertType, type ApiError, type AssembleInput, type AssembleResponse, type AuthResponse, type AuthToken, type AuthTokenCreated, type BulkDeleteIssues, type BulkUpdateIssues, type ChunkUploadCapability, type CleanupCounts, type CleanupOptions, type ClientConfig, type CreateAlertIntegration, type CreateAlertRule, type CreateAuthToken, type CreateComment, type CreateInvitation, type CreateProject, type CreateUserReport, Err, type Event, type EventDetail, type EventTimeseries, type EventTimeseriesPoint, FIELD_ERROR_CODES, type FieldError, type FieldErrorCode, type GenAiBreakdownRow, type GlobalRole, type Invitation, type InvitationInfo, type Issue, type IssueAggregates, type IssueFilter, type IssueHash, type IssuePriority, type IssueSort, type IssueStats, type IssueStatsWindow, type IssueStatus, type IssueTagValue, type ListAlertHistoryOptions, type ListEventsOptions, type ListIssuesOptions, type ListLogsOptions, type ListProjectsOptions, type ListSourceMapsResponse, type ListSpansOptions, type ListTransactionsOptions, type Log, type LoginRequest, type LoginResult, type MetricDelta, NETWORK_ERROR_MESSAGE, type OffsetPaginatedResponse, Ok, type PaginatedResponse, type PreviewTemplateResponse, type Project, type ProjectListStats, type ProjectMember, type ProjectRole, type ProjectStatsSummary, type ProjectStorage, type ProviderType, type RegisterRequest, type ReleaseHealthRow, type ReleaseHealthStatsOptions, type Result, type RoutingOverride, RustrakClient, type RustrakError, type RustrakErrorKind, SERVER_ERROR_MESSAGE, type ServerVersion, type SessionSummary, type SessionTimeseries, type SessionTimeseriesPoint, type SortOrder, type SourceMapFile, type SourceMapGcResult, type SourceMapStorage, type Span, type SpanDetail, type StorageSummary, TIMEOUT_ERROR_MESSAGE, type TagSummary, type TagValueCount, type TeamMember, type TestChannelResponse, type TestIntegrationBody, type Transaction, type TransactionDetail, type TransactionStats, type UpdateAlertIntegration, type UpdateAlertRule, type UpdateIssueState, type UpdateProject, type UpdateUserRole, type UpsertProjectMember, type User, type UserReport, isRetryable, mapResult, unwrap, unwrapOr };

package/dist/index.d.ts

@@ -182,6 +182,7 @@ declare const providerTypeSchema: z.ZodEnum<{
     webhook: "webhook";
     email: "email";
     slack: "slack";
+    custom_webhook: "custom_webhook";
 }>;
 declare const alertTypeSchema: z.ZodEnum<{
     new_issue: "new_issue";
@@ -201,6 +202,7 @@ declare const alertIntegrationSchema: z.ZodObject<{
         webhook: "webhook";
         email: "email";
         slack: "slack";
+        custom_webhook: "custom_webhook";
     }>;
     credentials: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     is_enabled: z.ZodBoolean;
@@ -217,6 +219,7 @@ declare const createAlertIntegrationSchema: z.ZodObject<{
         webhook: "webhook";
         email: "email";
         slack: "slack";
+        custom_webhook: "custom_webhook";
     }>;
     credentials: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     is_enabled: z.ZodOptional<z.ZodBoolean>;
@@ -302,6 +305,12 @@ declare const alertHistorySchema: z.ZodObject<{
 declare const testChannelResponseSchema: z.ZodObject<{
     success: z.ZodBoolean;
     message: z.ZodString;
+    response_body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+declare const previewTemplateResponseSchema: z.ZodObject<{
+    ok: z.ZodBoolean;
+    rendered: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 declare const testIntegrationBodySchema: z.ZodObject<{
     routing_override: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -320,6 +329,7 @@ type CreateAlertRule = z.infer<typeof createAlertRuleSchema>;
 type UpdateAlertRule = z.infer<typeof updateAlertRuleSchema>;
 type AlertHistory = z.infer<typeof alertHistorySchema>;
 type TestChannelResponse = z.infer<typeof testChannelResponseSchema>;
+type PreviewTemplateResponse = z.infer<typeof previewTemplateResponseSchema>;
 type TestIntegrationBody = z.infer<typeof testIntegrationBodySchema>;
 interface ListAlertHistoryOptions {
     limit?: number;
@@ -1159,6 +1169,7 @@ declare class AlertIntegrationsResource extends BaseResource {
     update(id: number, input: UpdateAlertIntegration): Promise<Result<AlertIntegration, RustrakError>>;
     delete(id: number): Promise<Result<void, RustrakError>>;
     test(id: number, routingOverride?: RoutingOverride): Promise<Result<TestChannelResponse, RustrakError>>;
+    previewTemplate(template: string): Promise<Result<PreviewTemplateResponse, RustrakError>>;
 }
 
 declare class AlertRulesResource extends BaseResource {
@@ -1333,4 +1344,4 @@ declare class RustrakClient {
     constructor(config: ClientConfig);
 }
 
-export { type AcceptInvitation, type ActivityEntry, type AgentBreakdownOptions, type AgentDurationPoint, type AgentModelRow, type AgentSummary, type AgentTimeseriesOptions, type AgentTimeseriesPoint, type AgentToolRow, type AgentTraceSummary, type AgentTracesOptions, type AlertHistory, type AlertIntegration, type AlertRule, type AlertRuleChannelInput, type AlertStatus, type AlertType, type ApiError, type AssembleInput, type AssembleResponse, type AuthResponse, type AuthToken, type AuthTokenCreated, type BulkDeleteIssues, type BulkUpdateIssues, type ChunkUploadCapability, type CleanupCounts, type CleanupOptions, type ClientConfig, type CreateAlertIntegration, type CreateAlertRule, type CreateAuthToken, type CreateComment, type CreateInvitation, type CreateProject, type CreateUserReport, Err, type Event, type EventDetail, type EventTimeseries, type EventTimeseriesPoint, FIELD_ERROR_CODES, type FieldError, type FieldErrorCode, type GenAiBreakdownRow, type GlobalRole, type Invitation, type InvitationInfo, type Issue, type IssueAggregates, type IssueFilter, type IssueHash, type IssuePriority, type IssueSort, type IssueStats, type IssueStatsWindow, type IssueStatus, type IssueTagValue, type ListAlertHistoryOptions, type ListEventsOptions, type ListIssuesOptions, type ListLogsOptions, type ListProjectsOptions, type ListSourceMapsResponse, type ListSpansOptions, type ListTransactionsOptions, type Log, type LoginRequest, type LoginResult, type MetricDelta, NETWORK_ERROR_MESSAGE, type OffsetPaginatedResponse, Ok, type PaginatedResponse, type Project, type ProjectListStats, type ProjectMember, type ProjectRole, type ProjectStatsSummary, type ProjectStorage, type ProviderType, type RegisterRequest, type ReleaseHealthRow, type ReleaseHealthStatsOptions, type Result, type RoutingOverride, RustrakClient, type RustrakError, type RustrakErrorKind, SERVER_ERROR_MESSAGE, type ServerVersion, type SessionSummary, type SessionTimeseries, type SessionTimeseriesPoint, type SortOrder, type SourceMapFile, type SourceMapGcResult, type SourceMapStorage, type Span, type SpanDetail, type StorageSummary, TIMEOUT_ERROR_MESSAGE, type TagSummary, type TagValueCount, type TeamMember, type TestChannelResponse, type TestIntegrationBody, type Transaction, type TransactionDetail, type TransactionStats, type UpdateAlertIntegration, type UpdateAlertRule, type UpdateIssueState, type UpdateProject, type UpdateUserRole, type UpsertProjectMember, type User, type UserReport, isRetryable, mapResult, unwrap, unwrapOr };
+export { type AcceptInvitation, type ActivityEntry, type AgentBreakdownOptions, type AgentDurationPoint, type AgentModelRow, type AgentSummary, type AgentTimeseriesOptions, type AgentTimeseriesPoint, type AgentToolRow, type AgentTraceSummary, type AgentTracesOptions, type AlertHistory, type AlertIntegration, type AlertRule, type AlertRuleChannelInput, type AlertStatus, type AlertType, type ApiError, type AssembleInput, type AssembleResponse, type AuthResponse, type AuthToken, type AuthTokenCreated, type BulkDeleteIssues, type BulkUpdateIssues, type ChunkUploadCapability, type CleanupCounts, type CleanupOptions, type ClientConfig, type CreateAlertIntegration, type CreateAlertRule, type CreateAuthToken, type CreateComment, type CreateInvitation, type CreateProject, type CreateUserReport, Err, type Event, type EventDetail, type EventTimeseries, type EventTimeseriesPoint, FIELD_ERROR_CODES, type FieldError, type FieldErrorCode, type GenAiBreakdownRow, type GlobalRole, type Invitation, type InvitationInfo, type Issue, type IssueAggregates, type IssueFilter, type IssueHash, type IssuePriority, type IssueSort, type IssueStats, type IssueStatsWindow, type IssueStatus, type IssueTagValue, type ListAlertHistoryOptions, type ListEventsOptions, type ListIssuesOptions, type ListLogsOptions, type ListProjectsOptions, type ListSourceMapsResponse, type ListSpansOptions, type ListTransactionsOptions, type Log, type LoginRequest, type LoginResult, type MetricDelta, NETWORK_ERROR_MESSAGE, type OffsetPaginatedResponse, Ok, type PaginatedResponse, type PreviewTemplateResponse, type Project, type ProjectListStats, type ProjectMember, type ProjectRole, type ProjectStatsSummary, type ProjectStorage, type ProviderType, type RegisterRequest, type ReleaseHealthRow, type ReleaseHealthStatsOptions, type Result, type RoutingOverride, RustrakClient, type RustrakError, type RustrakErrorKind, SERVER_ERROR_MESSAGE, type ServerVersion, type SessionSummary, type SessionTimeseries, type SessionTimeseriesPoint, type SortOrder, type SourceMapFile, type SourceMapGcResult, type SourceMapStorage, type Span, type SpanDetail, type StorageSummary, TIMEOUT_ERROR_MESSAGE, type TagSummary, type TagValueCount, type TeamMember, type TestChannelResponse, type TestIntegrationBody, type Transaction, type TransactionDetail, type TransactionStats, type UpdateAlertIntegration, type UpdateAlertRule, type UpdateIssueState, type UpdateProject, type UpdateUserRole, type UpsertProjectMember, type User, type UserReport, isRetryable, mapResult, unwrap, unwrapOr };

package/dist/index.js

@@ -87,7 +87,12 @@ var agentToolRowSchema = z.object({
   avg_ms: z.number(),
   p95_ms: z.number()
 });
-var providerTypeSchema = z.enum(["webhook", "email", "slack"]);
+var providerTypeSchema = z.enum([
+  "webhook",
+  "email",
+  "slack",
+  "custom_webhook"
+]);
 var alertTypeSchema = z.enum(["new_issue", "regression", "unmute"]);
 var alertStatusSchema = z.enum([
   "pending",
@@ -172,7 +177,20 @@ var alertHistorySchema = z.object({
 });
 var testChannelResponseSchema = z.object({
   success: z.boolean(),
-  message: z.string()
+  message: z.string(),
+  /**
+   * What the endpoint answered, when it answered anything.
+   *
+   * Delivery is judged by the HTTP status and the body is not interpreted, so
+   * the body is handed back instead: a group bot that refuses a message still
+   * answers 200 and explains itself here.
+   */
+  response_body: z.string().nullish()
+});
+var previewTemplateResponseSchema = z.object({
+  ok: z.boolean(),
+  rendered: z.string().nullish(),
+  error: z.string().nullish()
 });
 var testIntegrationBodySchema = z.object({
   routing_override: z.record(z.string(), z.unknown()).optional()
@@ -1263,6 +1281,22 @@ var AlertIntegrationsResource = class extends BaseResource {
       testChannelResponseSchema
     );
   }
+  /**
+   * Render a Custom Webhook template against a sample payload.
+   *
+   * Answers with the body that would be sent, or with why it would not
+   * render. It goes to the server because the server owns the template
+   * engine: a preview computed anywhere else would eventually disagree with
+   * what a delivery actually sends.
+   */
+  async previewTemplate(template) {
+    return this.request(
+      () => this.http.post("api/integrations/preview-template", {
+        json: { template }
+      }),
+      previewTemplateResponseSchema
+    );
+  }
 };
 var AlertRulesResource = class extends BaseResource {
   /**