-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Adding Workflow Trigger WebAPI Methods #1349
Open
lorenzoaiello
wants to merge
2
commits into
master
Choose a base branch
from
feat/workflow-triggers
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+445
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,154 @@ | ||
package slack | ||
|
||
import ( | ||
"context" | ||
"errors" | ||
"fmt" | ||
) | ||
|
||
type ( | ||
WorkflowsTriggersPermissionsAddInput struct { | ||
TriggerId string `json:"trigger_id"` | ||
ChannelIds []string `json:"channel_ids,omitempty"` | ||
OrgIds []string `json:"org_ids,omitempty"` | ||
TeamIds []string `json:"team_ids,omitempty"` | ||
UserIds []string `json:"user_ids,omitempty"` | ||
} | ||
|
||
WorkflowsTriggersPermissionsAddOutput struct { | ||
PermissionType string `json:"permission_type"` | ||
ChannelIds []string `json:"channel_ids,omitempty"` | ||
OrgIds []string `json:"org_ids,omitempty"` | ||
TeamIds []string `json:"team_ids,omitempty"` | ||
UserIds []string `json:"user_ids,omitempty"` | ||
} | ||
|
||
WorkflowsTriggersPermissionsListInput struct { | ||
TriggerId string `json:"trigger_id"` | ||
} | ||
|
||
WorkflowsTriggersPermissionsListOutput struct { | ||
PermissionType string `json:"permission_type"` | ||
ChannelIds []string `json:"channel_ids,omitempty"` | ||
OrgIds []string `json:"org_ids,omitempty"` | ||
TeamIds []string `json:"team_ids,omitempty"` | ||
UserIds []string `json:"user_ids,omitempty"` | ||
} | ||
|
||
WorkflowsTriggersPermissionsRemoveInput struct { | ||
TriggerId string `json:"trigger_id"` | ||
ChannelIds []string `json:"channel_ids,omitempty"` | ||
OrgIds []string `json:"org_ids,omitempty"` | ||
TeamIds []string `json:"team_ids,omitempty"` | ||
UserIds []string `json:"user_ids,omitempty"` | ||
} | ||
|
||
WorkflowsTriggersPermissionsRemoveOutput struct { | ||
PermissionType string `json:"permission_type"` | ||
ChannelIds []string `json:"channel_ids,omitempty"` | ||
OrgIds []string `json:"org_ids,omitempty"` | ||
TeamIds []string `json:"team_ids,omitempty"` | ||
UserIds []string `json:"user_ids,omitempty"` | ||
} | ||
|
||
WorkflowsTriggersPermissionsSetInput struct { | ||
PermissionType string `json:"permission_type"` | ||
TriggerId string `json:"trigger_id"` | ||
ChannelIds []string `json:"channel_ids,omitempty"` | ||
OrgIds []string `json:"org_ids,omitempty"` | ||
TeamIds []string `json:"team_ids,omitempty"` | ||
UserIds []string `json:"user_ids,omitempty"` | ||
} | ||
|
||
WorkflowsTriggersPermissionsSetOutput struct { | ||
PermissionType string `json:"permission_type"` | ||
ChannelIds []string `json:"channel_ids,omitempty"` | ||
OrgIds []string `json:"org_ids,omitempty"` | ||
TeamIds []string `json:"team_ids,omitempty"` | ||
UserIds []string `json:"user_ids,omitempty"` | ||
} | ||
) | ||
|
||
// WorkflowsTriggersPermissionsAdd allows users to run a trigger that has its permission type set to named_entities. | ||
// | ||
// Slack API Docs:https://api.dev.slack.com/methods/workflows.triggers.permissions.add | ||
func (api *Client) WorkflowsTriggersPermissionsAdd(ctx context.Context, input *WorkflowsTriggersPermissionsAddInput) (*WorkflowsTriggersPermissionsAddOutput, error) { | ||
response := struct { | ||
*ResponsePointer | ||
*WorkflowsTriggersPermissionsAddOutput | ||
}{} | ||
|
||
err := api.postJSON(ctx, "workflows.triggers.permissions.add", input, &response) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
if response.Error != nil { | ||
return nil, errors.New(fmt.Sprintf("error: %s", *response.Error)) | ||
} | ||
|
||
return response.WorkflowsTriggersPermissionsAddOutput, nil | ||
} | ||
|
||
// WorkflowsTriggersPermissionsList returns the permission type of a trigger and if applicable, includes the entities that have been granted access. | ||
// | ||
// Slack API Docs:https://api.dev.slack.com/methods/workflows.triggers.permissions.list | ||
func (api *Client) WorkflowsTriggersPermissionsList(ctx context.Context, input *WorkflowsTriggersPermissionsListInput) (*WorkflowsTriggersPermissionsListOutput, error) { | ||
response := struct { | ||
*ResponsePointer | ||
*WorkflowsTriggersPermissionsListOutput | ||
}{} | ||
|
||
err := api.postJSON(ctx, "workflows.triggers.permissions.list", input, &response) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
if response.Error != nil { | ||
return nil, errors.New(fmt.Sprintf("error: %s", *response.Error)) | ||
} | ||
|
||
return response.WorkflowsTriggersPermissionsListOutput, nil | ||
} | ||
|
||
// WorkflowsTriggersPermissionsRemove revoke an entity's access to a trigger that has its permission type set to named_entities. | ||
// | ||
// Slack API Docs:https://api.dev.slack.com/methods/workflows.triggers.permissions.remove | ||
func (api *Client) WorkflowsTriggersPermissionsRemove(ctx context.Context, input *WorkflowsTriggersPermissionsRemoveInput) (*WorkflowsTriggersPermissionsRemoveOutput, error) { | ||
response := struct { | ||
*ResponsePointer | ||
*WorkflowsTriggersPermissionsRemoveOutput | ||
}{} | ||
|
||
err := api.postJSON(ctx, "workflows.triggers.permissions.remove", input, &response) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
if response.Error != nil { | ||
return nil, errors.New(fmt.Sprintf("error: %s", *response.Error)) | ||
} | ||
|
||
return response.WorkflowsTriggersPermissionsRemoveOutput, nil | ||
} | ||
|
||
// WorkflowsTriggersPermissionsSet sets the permission type for who can run a trigger. | ||
// | ||
// Slack API Docs:https://api.dev.slack.com/methods/workflows.triggers.permissions.set | ||
func (api *Client) WorkflowsTriggersPermissionsSet(ctx context.Context, input *WorkflowsTriggersPermissionsSetInput) (*WorkflowsTriggersPermissionsSetOutput, error) { | ||
response := struct { | ||
*ResponsePointer | ||
*WorkflowsTriggersPermissionsSetOutput | ||
}{} | ||
|
||
err := api.postJSON(ctx, "workflows.triggers.permissions.set", input, &response) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
if response.Error != nil { | ||
return nil, errors.New(fmt.Sprintf("error: %s", *response.Error)) | ||
} | ||
|
||
return response.WorkflowsTriggersPermissionsSetOutput, nil | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we have this PR without this?
I'd love to keep
SlackResponse
for introducing this feature.I think I understand the rationale for having these as
omitempty
but if we introduce this change, I'd rather do it in its own PR and change theSlackResponse
instead of a new struct.What's your take @lorenzoaiello ?