Skip to content

workflows.md

Latest commit

 

History

History
86 lines (67 loc) · 4.99 KB

workflows.md

File metadata and controls

86 lines (67 loc) · 4.99 KB
Raw

Workflows — operations

Accessor: client.workflows · Source: src/resources/workflows.ts · 3 operations · Request and error types: namespace Workflows

Type sources: every type an operation names, with the file that declares it and the schema value exported beside it. Import every name from slack-web-api; the Source path is where to read the shape, never what to import. ApiError, the runtime error family and the file vocabulary are excluded — see sdk-map.md.

workflowsStepCompleted

  • Signature: workflowsStepCompleted(request: Workflows.WorkflowsStepCompletedRequest, options?: RequestOptions): ApiPromise<Defaultsuccesstemplate, Workflows.WorkflowsStepCompletedError>
  • Wire: GET /workflows.stepCompleted
  • Auth: slackAuth
  • Request body: none — no Content-Type header is sent
  • Returns: Defaultsuccesstemplate
  • Error: SlackWebApiError with kind: "api", an instance of Workflows.WorkflowsStepCompletedError — typed arms, narrowed on err.payload.kind
  • Error arms: "defaulterrortemplate1" [default — any status no arm above covers] Defaulterrortemplate1 · "undeclared" [a default-matched body that did not fit Defaulterrortemplate1] rawBody: ArrayBuffer

Fields — Workflows.WorkflowsStepCompletedRequest (4):

Field Channel Wire Type Req
workflowStepExecuteId query workflow_step_execute_id string yes
outputs query — string no
token header — string yes
contentType header Content-Type ContentType yes
Type Schema value Source
ContentType contentTypeSchema src/models/content-type.ts
Defaultsuccesstemplate defaultsuccesstemplateSchema src/models/defaultsuccesstemplate.ts
Defaulterrortemplate1 defaulterrortemplate1Schema src/models/defaulterrortemplate1.ts

workflowsStepFailed

  • Signature: workflowsStepFailed(request: Workflows.WorkflowsStepFailedRequest, options?: RequestOptions): ApiPromise<Defaultsuccesstemplate, Workflows.WorkflowsStepFailedError>
  • Wire: GET /workflows.stepFailed
  • Auth: slackAuth
  • Request body: none — no Content-Type header is sent
  • Returns: Defaultsuccesstemplate
  • Error: SlackWebApiError with kind: "api", an instance of Workflows.WorkflowsStepFailedError — typed arms, narrowed on err.payload.kind
  • Error arms: "defaulterrortemplate1" [default — any status no arm above covers] Defaulterrortemplate1 · "undeclared" [a default-matched body that did not fit Defaulterrortemplate1] rawBody: ArrayBuffer

Fields — Workflows.WorkflowsStepFailedRequest (4):

Field Channel Wire Type Req
workflowStepExecuteId query workflow_step_execute_id string yes
error query — string yes
token header — string yes
contentType header Content-Type ContentType yes
Type Schema value Source
ContentType contentTypeSchema src/models/content-type.ts
Defaultsuccesstemplate defaultsuccesstemplateSchema src/models/defaultsuccesstemplate.ts
Defaulterrortemplate1 defaulterrortemplate1Schema src/models/defaulterrortemplate1.ts

workflowsUpdateStep

  • Signature: workflowsUpdateStep(request: Workflows.WorkflowsUpdateStepRequest, options?: RequestOptions): ApiPromise<Defaultsuccesstemplate, Workflows.WorkflowsUpdateStepError>
  • Wire: GET /workflows.updateStep
  • Auth: slackAuth
  • Request body: none — no Content-Type header is sent
  • Returns: Defaultsuccesstemplate
  • Error: SlackWebApiError with kind: "api", an instance of Workflows.WorkflowsUpdateStepError — typed arms, narrowed on err.payload.kind
  • Error arms: "defaulterrortemplate1" [default — any status no arm above covers] Defaulterrortemplate1 · "undeclared" [a default-matched body that did not fit Defaulterrortemplate1] rawBody: ArrayBuffer

Fields — Workflows.WorkflowsUpdateStepRequest (7):

Field Channel Wire Type Req
workflowStepEditId query workflow_step_edit_id string yes
inputs query — string no
outputs query — string no
stepName query step_name string no
stepImageUrl query step_image_url string no
token header — string yes
contentType header Content-Type ContentType yes
Type Schema value Source
ContentType contentTypeSchema src/models/content-type.ts
Defaultsuccesstemplate defaultsuccesstemplateSchema src/models/defaultsuccesstemplate.ts
Defaulterrortemplate1 defaulterrortemplate1Schema src/models/defaulterrortemplate1.ts