lark/api_apaas_application_flow_execute.go at master · chyroc/lark · GitHub

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
// Code generated by lark_sdk_gen. DO NOT EDIT.
/**
 * Copyright 2022 chyroc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package lark

import (
	"context"
)

// ExecuteAPaaSApplicationFlow 执行相应流程
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-flow/execute
// new doc: https://open.feishu.cn/document/apaas-v1/flow/application-flow/execute
func (r *APaaSService) ExecuteAPaaSApplicationFlow(ctx context.Context, request *ExecuteAPaaSApplicationFlowReq, options ...MethodOptionFunc) (*ExecuteAPaaSApplicationFlowResp, *Response, error) {
	if r.cli.mock.mockAPaaSExecuteAPaaSApplicationFlow != nil {
		r.cli.Log(ctx, LogLevelDebug, "[lark] APaaS#ExecuteAPaaSApplicationFlow mock enable")
		return r.cli.mock.mockAPaaSExecuteAPaaSApplicationFlow(ctx, request, options...)
	}

	req := &RawRequestReq{
		Scope:                 "APaaS",
		API:                   "ExecuteAPaaSApplicationFlow",
		Method:                "POST",
		URL:                   r.cli.openBaseURL + "/open-apis/apaas/v1/applications/:namespace/flows/:flow_id/execute",
		Body:                  request,
		MethodOption:          newMethodOption(options),
		NeedTenantAccessToken: true,
	}
	resp := new(executeAPaaSApplicationFlowResp)

	response, err := r.cli.RawRequest(ctx, req, resp)
	return resp.Data, response, err
}

// MockAPaaSExecuteAPaaSApplicationFlow mock APaaSExecuteAPaaSApplicationFlow method
func (r *Mock) MockAPaaSExecuteAPaaSApplicationFlow(f func(ctx context.Context, request *ExecuteAPaaSApplicationFlowReq, options ...MethodOptionFunc) (*ExecuteAPaaSApplicationFlowResp, *Response, error)) {
	r.mockAPaaSExecuteAPaaSApplicationFlow = f
}

// UnMockAPaaSExecuteAPaaSApplicationFlow un-mock APaaSExecuteAPaaSApplicationFlow method
func (r *Mock) UnMockAPaaSExecuteAPaaSApplicationFlow() {
	r.mockAPaaSExecuteAPaaSApplicationFlow = nil
}

// ExecuteAPaaSApplicationFlowReq ...
type ExecuteAPaaSApplicationFlowReq struct {
	Namespace     string   `path:"namespace" json:"-"`       // 应用命名空间(低代码平台->我的应用->应用管理->可查看到)示例值: "package_7344545d87__c"
	FlowID        string   `path:"flow_id" json:"-"`         // 流程API名称（低代码平台->我的应用->开发->流程->展开为表格->可查看到）示例值: "deleteObject_99c656599f"
	IsAsync       *bool    `json:"is_async,omitempty"`       // 是否异步执行(不传默认false)示例值: true
	IdempotentKey *string  `json:"idempotent_key,omitempty"` // 幂等键（建议本地生成uuid传入, 重复的话请求会报错）示例值: "iuhg23897489797"
	LoopMasks     []string `json:"loop_masks,omitempty"`     // 循环标志信息(当前版本可不传)示例值: ["\"] 长度范围: `0` ～ `20`
	Params        *string  `json:"params,omitempty"`         // 流程入参（json 字符串, 无入参不传）示例值: "`{\"variable_rgrtgqworiginal\": {\"_id\": 5454545}}`"
	Operator      string   `json:"operator,omitempty"`       // 操作人（_id和email至少填一个, 低代码平台用户的 id和email, 需要从低代码平台获取, json字符串）示例值: "`{\"_id\": 1111, \"email\": \"apaas@bytedance.com\"}`"
}

// ExecuteAPaaSApplicationFlowResp ...
type ExecuteAPaaSApplicationFlowResp struct {
	Status      string `json:"status,omitempty"`       // 状态
	OutParams   string `json:"out_params,omitempty"`   // 输出参数
	ExecutionID string `json:"execution_id,omitempty"` // 执行id
	ErrorMsg    string `json:"error_msg,omitempty"`    // 错误信息
	Code        string `json:"code,omitempty"`         // code
}

// executeAPaaSApplicationFlowResp ...
type executeAPaaSApplicationFlowResp struct {
	Code  int64                            `json:"code,omitempty"` // 错误码, 非 0 表示失败
	Msg   string                           `json:"msg,omitempty"`  // 错误描述
	Data  *ExecuteAPaaSApplicationFlowResp `json:"data,omitempty"`
	Error *ErrorDetail                     `json:"error,omitempty"`
}