1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
use crate::Client;
use crate::ClientResult;
pub struct Workflows {
pub client: Client,
}
impl Workflows {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Workflows { client }
}
/**
* This function performs a `GET` to the `/workflows.stepCompleted` endpoint.
*
* Indicate that an app's step in a workflow completed execution.
*
* FROM: <https://api.slack.com/methods/workflows.stepCompleted>
*
* **Parameters:**
*
* * `token: &str` -- Authentication token. Requires scope: `workflow.steps:execute`.
* * `workflow_step_execute_id: &str` -- Context identifier that maps to the correct workflow step execution.
* * `outputs: &str` -- Key-value object of outputs from your step. Keys of this object reflect the configured `key` properties of your [`outputs`](/reference/workflows/workflow_step#output) array from your `workflow_step` object.
*/
pub async fn step_completed(
&self,
workflow_step_execute_id: &str,
outputs: &str,
) -> ClientResult<crate::Response<crate::types::DndEndSchema>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !outputs.is_empty() {
query_args.push(("outputs".to_string(), outputs.to_string()));
}
if !workflow_step_execute_id.is_empty() {
query_args.push((
"workflow_step_execute_id".to_string(),
workflow_step_execute_id.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/workflows.stepCompleted?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* This function performs a `GET` to the `/workflows.stepFailed` endpoint.
*
* Indicate that an app's step in a workflow failed to execute.
*
* FROM: <https://api.slack.com/methods/workflows.stepFailed>
*
* **Parameters:**
*
* * `token: &str` -- Authentication token. Requires scope: `workflow.steps:execute`.
* * `workflow_step_execute_id: &str` -- Context identifier that maps to the correct workflow step execution.
* * `error: &str` -- A JSON-based object with a `message` property that should contain a human readable error message.
*/
pub async fn step_failed(
&self,
workflow_step_execute_id: &str,
error: &str,
) -> ClientResult<crate::Response<crate::types::DndEndSchema>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !error.is_empty() {
query_args.push(("error".to_string(), error.to_string()));
}
if !workflow_step_execute_id.is_empty() {
query_args.push((
"workflow_step_execute_id".to_string(),
workflow_step_execute_id.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/workflows.stepFailed?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* This function performs a `GET` to the `/workflows.updateStep` endpoint.
*
* Update the configuration for a workflow extension step.
*
* FROM: <https://api.slack.com/methods/workflows.updateStep>
*
* **Parameters:**
*
* * `token: &str` -- Authentication token. Requires scope: `workflow.steps:execute`.
* * `workflow_step_edit_id: &str` -- A context identifier provided with `view_submission` payloads used to call back to `workflows.updateStep`.
* * `inputs: &str` -- A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. **Please note**: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. [Read more about variables in workflow steps here](/workflows/steps#variables).
* * `outputs: &str` -- An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.
* * `step_name: &str` -- An optional field that can be used to override the step name that is shown in the Workflow Builder.
* * `step_image_url: &str` -- An optional field that can be used to override app image that is shown in the Workflow Builder.
*/
pub async fn update_step(
&self,
workflow_step_edit_id: &str,
inputs: &str,
outputs: &str,
step_name: &str,
step_image_url: &str,
) -> ClientResult<crate::Response<crate::types::DndEndSchema>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !inputs.is_empty() {
query_args.push(("inputs".to_string(), inputs.to_string()));
}
if !outputs.is_empty() {
query_args.push(("outputs".to_string(), outputs.to_string()));
}
if !step_image_url.is_empty() {
query_args.push(("step_image_url".to_string(), step_image_url.to_string()));
}
if !step_name.is_empty() {
query_args.push(("step_name".to_string(), step_name.to_string()));
}
if !workflow_step_edit_id.is_empty() {
query_args.push((
"workflow_step_edit_id".to_string(),
workflow_step_edit_id.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/workflows.updateStep?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
}