@hatchet-dev/typescript-sdk 1.10.4-alpha.0 → 1.10.5

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.
@@ -1,4 +1,4 @@
1
- import { AcceptInviteRequest, APIErrors, APIMeta, BulkCreateEventRequest, BulkCreateEventResponse, CancelEventRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreateCronWorkflowTriggerRequest, CreateEventRequest, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, CronWorkflows, CronWorkflowsList, CronWorkflowsOrderByField, Event, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, ListAPIMetaIntegration, ListAPITokensResponse, ListSlackWebhooks, ListSNSIntegrations, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, RateLimitList, RateLimitOrderByDirection, RateLimitOrderByField, RejectInviteRequest, ReplayEventRequest, ReplayWorkflowRunsRequest, ReplayWorkflowRunsResponse, RerunStepRunRequest, ScheduledRunStatus, ScheduledWorkflows, ScheduledWorkflowsList, ScheduledWorkflowsOrderByField, ScheduleWorkflowRunRequest, SNSIntegration, StepRun, StepRunArchiveList, StepRunEventList, TaskStats, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantQueueMetrics, TenantResourcePolicy, TenantStepRunQueueMetrics, TriggerWorkflowRunRequest, UpdateCronWorkflowTriggerRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantMemberRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, V1CancelledTasks, V1CancelTaskRequest, V1CELDebugRequest, V1CELDebugResponse, V1CreateFilterRequest, V1CreateWebhookRequest, V1DagChildren, V1EventList, V1Filter, V1FilterList, V1LogLineList, V1ReplayedTasks, V1ReplayTaskRequest, V1TaskEventList, V1TaskPointMetrics, V1TaskRunMetrics, V1TaskStatus, V1TaskSummary, V1TaskSummaryList, V1TaskTimingList, V1TriggerWorkflowRunRequest, V1UpdateFilterRequest, V1UpdateWebhookRequest, V1Webhook, V1WebhookList, V1WebhookSourceName, V1WorkflowRunDetails, V1WorkflowRunDisplayNameList, V1WorkflowRunExternalIdList, WebhookWorkerCreated, WebhookWorkerCreateRequest, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, Workflow, WorkflowID, WorkflowKindList, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunOrderByDirection, WorkflowRunOrderByField, WorkflowRunsCancelRequest, WorkflowRunShape, WorkflowRunsMetrics, WorkflowRunStatus, WorkflowRunStatusList, WorkflowUpdateRequest, WorkflowVersion, WorkflowWorkersCount } from './data-contracts';
1
+ import { APIErrors, APIMeta, AcceptInviteRequest, BulkCreateEventRequest, CancelEventRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreateCronWorkflowTriggerRequest, CreateEventRequest, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, CronWorkflows, CronWorkflowsList, CronWorkflowsOrderByField, Event, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, Events, ListAPIMetaIntegration, ListAPITokensResponse, ListSNSIntegrations, ListSlackWebhooks, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, RateLimitList, RateLimitOrderByDirection, RateLimitOrderByField, RejectInviteRequest, ReplayEventRequest, ReplayWorkflowRunsRequest, ReplayWorkflowRunsResponse, RerunStepRunRequest, SNSIntegration, ScheduleWorkflowRunRequest, ScheduledRunStatus, ScheduledWorkflows, ScheduledWorkflowsBulkDeleteRequest, ScheduledWorkflowsBulkDeleteResponse, ScheduledWorkflowsBulkUpdateRequest, ScheduledWorkflowsBulkUpdateResponse, ScheduledWorkflowsList, ScheduledWorkflowsOrderByField, StepRun, StepRunArchiveList, StepRunEventList, TaskStats, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantQueueMetrics, TenantResourcePolicy, TenantStepRunQueueMetrics, TriggerWorkflowRunRequest, UpdateCronWorkflowTriggerRequest, UpdateScheduledWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantMemberRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, V1CELDebugRequest, V1CELDebugResponse, V1CancelTaskRequest, V1CancelledTasks, V1CreateFilterRequest, V1CreateWebhookRequest, V1DagChildren, V1Event, V1EventList, V1Filter, V1FilterList, V1LogLineList, V1ReplayTaskRequest, V1ReplayedTasks, V1TaskEventList, V1TaskPointMetrics, V1TaskRunMetrics, V1TaskStatus, V1TaskSummary, V1TaskSummaryList, V1TaskTimingList, V1TriggerWorkflowRunRequest, V1UpdateFilterRequest, V1UpdateWebhookRequest, V1Webhook, V1WebhookList, V1WebhookSourceName, V1WorkflowRunDetails, V1WorkflowRunDisplayNameList, V1WorkflowRunExternalIdList, WebhookWorkerCreateRequest, WebhookWorkerCreated, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, Workflow, WorkflowID, WorkflowKindList, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunOrderByDirection, WorkflowRunOrderByField, WorkflowRunShape, WorkflowRunStatus, WorkflowRunStatusList, WorkflowRunsCancelRequest, WorkflowRunsMetrics, WorkflowUpdateRequest, WorkflowVersion, WorkflowWorkersCount } from './data-contracts';
2
2
  import { HttpClient, RequestParams } from './http-client';
3
3
  export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
4
4
  /**
@@ -375,6 +375,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
375
375
  /** The scopes to filter by */
376
376
  scopes?: string[];
377
377
  }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1EventList, any, {}>>;
378
+ /**
379
+ * @description Get an event by its id
380
+ *
381
+ * @tags Event
382
+ * @name V1EventGet
383
+ * @summary Get events
384
+ * @request GET:/api/v1/stable/tenants/{tenant}/events/{v1-event}
385
+ * @secure
386
+ */
387
+ v1EventGet: (tenant: string, v1Event: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1Event, any, {}>>;
378
388
  /**
379
389
  * @description Lists all event keys for a tenant.
380
390
  *
@@ -1025,7 +1035,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
1025
1035
  * @request POST:/api/v1/tenants/{tenant}/events/bulk
1026
1036
  * @secure
1027
1037
  */
1028
- eventCreateBulk: (tenant: string, data: BulkCreateEventRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<BulkCreateEventResponse, any, {}>>;
1038
+ eventCreateBulk: (tenant: string, data: BulkCreateEventRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<Events, any, {}>>;
1029
1039
  /**
1030
1040
  * @description Replays a list of events.
1031
1041
  *
@@ -1125,6 +1135,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
1125
1135
  * @secure
1126
1136
  */
1127
1137
  eventDataGet: (event: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<EventData, any, {}>>;
1138
+ /**
1139
+ * @description Get the data for an event.
1140
+ *
1141
+ * @tags Event
1142
+ * @name EventDataGetWithTenant
1143
+ * @summary Get event data
1144
+ * @request GET:/api/v1/tenants/{tenant}/events/{event-with-tenant}/data
1145
+ * @secure
1146
+ */
1147
+ eventDataGetWithTenant: (eventWithTenant: string, tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<EventData, any, {}>>;
1128
1148
  /**
1129
1149
  * @description Lists all event keys for a tenant.
1130
1150
  *
@@ -1243,6 +1263,36 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
1243
1263
  * @secure
1244
1264
  */
1245
1265
  workflowScheduledDelete: (tenant: string, scheduledWorkflowRun: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any, {}>>;
1266
+ /**
1267
+ * @description Update (reschedule) a scheduled workflow run for a tenant
1268
+ *
1269
+ * @tags Workflow
1270
+ * @name WorkflowScheduledUpdate
1271
+ * @summary Update scheduled workflow run
1272
+ * @request PATCH:/api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run}
1273
+ * @secure
1274
+ */
1275
+ workflowScheduledUpdate: (tenant: string, scheduledWorkflowRun: string, data: UpdateScheduledWorkflowRunRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<ScheduledWorkflows, any, {}>>;
1276
+ /**
1277
+ * @description Bulk delete scheduled workflow runs for a tenant
1278
+ *
1279
+ * @tags Workflow
1280
+ * @name WorkflowScheduledBulkDelete
1281
+ * @summary Bulk delete scheduled workflow runs
1282
+ * @request POST:/api/v1/tenants/{tenant}/workflows/scheduled/bulk-delete
1283
+ * @secure
1284
+ */
1285
+ workflowScheduledBulkDelete: (tenant: string, data: ScheduledWorkflowsBulkDeleteRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<ScheduledWorkflowsBulkDeleteResponse, any, {}>>;
1286
+ /**
1287
+ * @description Bulk update (reschedule) scheduled workflow runs for a tenant
1288
+ *
1289
+ * @tags Workflow
1290
+ * @name WorkflowScheduledBulkUpdate
1291
+ * @summary Bulk update scheduled workflow runs
1292
+ * @request POST:/api/v1/tenants/{tenant}/workflows/scheduled/bulk-update
1293
+ * @secure
1294
+ */
1295
+ workflowScheduledBulkUpdate: (tenant: string, data: ScheduledWorkflowsBulkUpdateRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<ScheduledWorkflowsBulkUpdateResponse, any, {}>>;
1246
1296
  /**
1247
1297
  * @description Create a new cron job workflow trigger for a tenant
1248
1298
  *
@@ -186,6 +186,16 @@ class Api extends http_client_1.HttpClient {
186
186
  * @secure
187
187
  */
188
188
  this.v1EventList = (tenant, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/events`, method: 'GET', query: query, secure: true, format: 'json' }, params));
189
+ /**
190
+ * @description Get an event by its id
191
+ *
192
+ * @tags Event
193
+ * @name V1EventGet
194
+ * @summary Get events
195
+ * @request GET:/api/v1/stable/tenants/{tenant}/events/{v1-event}
196
+ * @secure
197
+ */
198
+ this.v1EventGet = (tenant, v1Event, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/events/${v1Event}`, method: 'GET', secure: true, format: 'json' }, params));
189
199
  /**
190
200
  * @description Lists all event keys for a tenant.
191
201
  *
@@ -849,6 +859,16 @@ class Api extends http_client_1.HttpClient {
849
859
  * @secure
850
860
  */
851
861
  this.eventDataGet = (event, params = {}) => this.request(Object.assign({ path: `/api/v1/events/${event}/data`, method: 'GET', secure: true, format: 'json' }, params));
862
+ /**
863
+ * @description Get the data for an event.
864
+ *
865
+ * @tags Event
866
+ * @name EventDataGetWithTenant
867
+ * @summary Get event data
868
+ * @request GET:/api/v1/tenants/{tenant}/events/{event-with-tenant}/data
869
+ * @secure
870
+ */
871
+ this.eventDataGetWithTenant = (eventWithTenant, tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/events/${eventWithTenant}/data`, method: 'GET', secure: true, format: 'json' }, params));
852
872
  /**
853
873
  * @description Lists all event keys for a tenant.
854
874
  *
@@ -909,6 +929,36 @@ class Api extends http_client_1.HttpClient {
909
929
  * @secure
910
930
  */
911
931
  this.workflowScheduledDelete = (tenant, scheduledWorkflowRun, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/workflows/scheduled/${scheduledWorkflowRun}`, method: 'DELETE', secure: true }, params));
932
+ /**
933
+ * @description Update (reschedule) a scheduled workflow run for a tenant
934
+ *
935
+ * @tags Workflow
936
+ * @name WorkflowScheduledUpdate
937
+ * @summary Update scheduled workflow run
938
+ * @request PATCH:/api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run}
939
+ * @secure
940
+ */
941
+ this.workflowScheduledUpdate = (tenant, scheduledWorkflowRun, data, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/workflows/scheduled/${scheduledWorkflowRun}`, method: 'PATCH', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
942
+ /**
943
+ * @description Bulk delete scheduled workflow runs for a tenant
944
+ *
945
+ * @tags Workflow
946
+ * @name WorkflowScheduledBulkDelete
947
+ * @summary Bulk delete scheduled workflow runs
948
+ * @request POST:/api/v1/tenants/{tenant}/workflows/scheduled/bulk-delete
949
+ * @secure
950
+ */
951
+ this.workflowScheduledBulkDelete = (tenant, data, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/workflows/scheduled/bulk-delete`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
952
+ /**
953
+ * @description Bulk update (reschedule) scheduled workflow runs for a tenant
954
+ *
955
+ * @tags Workflow
956
+ * @name WorkflowScheduledBulkUpdate
957
+ * @summary Bulk update scheduled workflow runs
958
+ * @request POST:/api/v1/tenants/{tenant}/workflows/scheduled/bulk-update
959
+ * @secure
960
+ */
961
+ this.workflowScheduledBulkUpdate = (tenant, data, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/workflows/scheduled/bulk-update`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
912
962
  /**
913
963
  * @description Create a new cron job workflow trigger for a tenant
914
964
  *