workflow.ts 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. // @ts-ignore
  2. /* eslint-disable */
  3. import request from '@repo/api-client'
  4. /** Retrieve all workflows Retrieve all workflows from your instance. GET /workflows */
  5. export async function getWorkflows(
  6. // 叠加生成的Param类型 (非body参数swagger默认没有生成对象)
  7. params: API.getWorkflowsParams,
  8. options?: { [key: string]: any }
  9. ) {
  10. return request<API.workflowList>('/workflows', {
  11. method: 'GET',
  12. params: {
  13. // limit has a default value: 100
  14. limit: '100',
  15. ...params
  16. },
  17. ...(options || {})
  18. })
  19. }
  20. /** Create a workflow Create a workflow in your instance. POST /workflows */
  21. export async function postWorkflows(body: API.workflow, options?: { [key: string]: any }) {
  22. return request<API.workflow>('/workflows', {
  23. method: 'POST',
  24. headers: {
  25. 'Content-Type': 'application/json'
  26. },
  27. data: body,
  28. ...(options || {})
  29. })
  30. }
  31. /** Retrieve a workflow Retrieve a workflow. GET /workflows/${param0} */
  32. export async function getWorkflowsId(
  33. // 叠加生成的Param类型 (非body参数swagger默认没有生成对象)
  34. params: API.getWorkflowsIdParams,
  35. options?: { [key: string]: any }
  36. ) {
  37. const { id: param0, ...queryParams } = params
  38. return request<API.workflow>(`/workflows/${param0}`, {
  39. method: 'GET',
  40. params: {
  41. ...queryParams
  42. },
  43. ...(options || {})
  44. })
  45. }
  46. /** Update a workflow Update a workflow. If the workflow is published, the updated version will be automatically re-published. PUT /workflows/${param0} */
  47. export async function putWorkflowsId(
  48. // 叠加生成的Param类型 (非body参数swagger默认没有生成对象)
  49. params: API.putWorkflowsIdParams,
  50. body: API.workflow,
  51. options?: { [key: string]: any }
  52. ) {
  53. const { id: param0, ...queryParams } = params
  54. return request<API.workflow>(`/workflows/${param0}`, {
  55. method: 'PUT',
  56. headers: {
  57. 'Content-Type': 'application/json'
  58. },
  59. params: { ...queryParams },
  60. data: body,
  61. ...(options || {})
  62. })
  63. }
  64. /** Delete a workflow Delete a workflow. DELETE /workflows/${param0} */
  65. export async function deleteWorkflowsId(
  66. // 叠加生成的Param类型 (非body参数swagger默认没有生成对象)
  67. params: API.deleteWorkflowsIdParams,
  68. options?: { [key: string]: any }
  69. ) {
  70. const { id: param0, ...queryParams } = params
  71. return request<API.workflow>(`/workflows/${param0}`, {
  72. method: 'DELETE',
  73. params: { ...queryParams },
  74. ...(options || {})
  75. })
  76. }
  77. /** Retrieves a specific version of a workflow Retrieves a specific version of a workflow from workflow history. GET /workflows/${param0}/${param1} */
  78. export async function getWorkflowsIdVersionId(
  79. // 叠加生成的Param类型 (非body参数swagger默认没有生成对象)
  80. params: API.getWorkflowsIdVersionIdParams,
  81. options?: { [key: string]: any }
  82. ) {
  83. const { id: param0, versionId: param1, ...queryParams } = params
  84. return request<API.workflowVersion>(`/workflows/${param0}/${param1}`, {
  85. method: 'GET',
  86. params: { ...queryParams },
  87. ...(options || {})
  88. })
  89. }
  90. /** Publish a workflow Publish a workflow. In n8n v1, this action was termed activating a workflow. POST /workflows/${param0}/activate */
  91. export async function postWorkflowsIdActivate(
  92. // 叠加生成的Param类型 (非body参数swagger默认没有生成对象)
  93. params: API.postWorkflowsIdActivateParams,
  94. body: {
  95. /** The specific version ID to activate or publish. If not provided, the latest version is used. */
  96. versionId?: string
  97. /** Optional name for the workflow version during activation. */
  98. name?: string
  99. /** Optional description for the workflow version during activation. */
  100. description?: string
  101. },
  102. options?: { [key: string]: any }
  103. ) {
  104. const { id: param0, ...queryParams } = params
  105. return request<API.workflow>(`/workflows/${param0}/activate`, {
  106. method: 'POST',
  107. headers: {
  108. 'Content-Type': 'application/json'
  109. },
  110. params: { ...queryParams },
  111. data: body,
  112. ...(options || {})
  113. })
  114. }
  115. /** Deactivate a workflow Deactivate a workflow. POST /workflows/${param0}/deactivate */
  116. export async function postWorkflowsIdDeactivate(
  117. // 叠加生成的Param类型 (非body参数swagger默认没有生成对象)
  118. params: API.postWorkflowsIdDeactivateParams,
  119. options?: { [key: string]: any }
  120. ) {
  121. const { id: param0, ...queryParams } = params
  122. return request<API.workflow>(`/workflows/${param0}/deactivate`, {
  123. method: 'POST',
  124. params: { ...queryParams },
  125. ...(options || {})
  126. })
  127. }
  128. /** Get workflow tags Get workflow tags. GET /workflows/${param0}/tags */
  129. export async function getWorkflowsIdTags(
  130. // 叠加生成的Param类型 (非body参数swagger默认没有生成对象)
  131. params: API.getWorkflowsIdTagsParams,
  132. options?: { [key: string]: any }
  133. ) {
  134. const { id: param0, ...queryParams } = params
  135. return request<API.workflowTags>(`/workflows/${param0}/tags`, {
  136. method: 'GET',
  137. params: { ...queryParams },
  138. ...(options || {})
  139. })
  140. }
  141. /** Update tags of a workflow Update tags of a workflow. PUT /workflows/${param0}/tags */
  142. export async function putWorkflowsIdTags(
  143. // 叠加生成的Param类型 (非body参数swagger默认没有生成对象)
  144. params: API.putWorkflowsIdTagsParams,
  145. body: API.tagIds,
  146. options?: { [key: string]: any }
  147. ) {
  148. const { id: param0, ...queryParams } = params
  149. return request<API.workflowTags>(`/workflows/${param0}/tags`, {
  150. method: 'PUT',
  151. headers: {
  152. 'Content-Type': 'application/json'
  153. },
  154. params: { ...queryParams },
  155. data: body,
  156. ...(options || {})
  157. })
  158. }
  159. /** Transfer a workflow to another project Transfer a workflow to another project PUT /workflows/${param0}/transfer */
  160. export async function putWorkflowsIdTransfer(
  161. // 叠加生成的Param类型 (非body参数swagger默认没有生成对象)
  162. params: API.putWorkflowsIdTransferParams,
  163. body: {
  164. /** The ID of the project to transfer the workflow to. */
  165. destinationProjectId: string
  166. },
  167. options?: { [key: string]: any }
  168. ) {
  169. const { id: param0, ...queryParams } = params
  170. return request<any>(`/workflows/${param0}/transfer`, {
  171. method: 'PUT',
  172. headers: {
  173. 'Content-Type': 'application/json'
  174. },
  175. params: { ...queryParams },
  176. data: body,
  177. ...(options || {})
  178. })
  179. }