Class: Retab::WorkflowEdges

Inherits:
Object
  • Object
show all
Defined in:
lib/retab/workflow_edges.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WorkflowEdges

Returns a new instance of WorkflowEdges.



9
10
11
 
# File 'lib/retab/workflow_edges.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#create(workflow_id:, source_block:, target_block:, id: nil, source_handle: nil, target_handle: nil, request_options: {}) ⇒ Retab::WorkflowEdgeDoc

Create Edge

Parameters:

  • workflow_id (String) —

    Workflow to create the edge in.

  • id (String, nil) (defaults to: nil) —

    Edge ID. Omit to let the server generate one (recommended).

  • source_block (String) —

    Source block ID

  • target_block (String) —

    Target block ID

  • source_handle (String, nil) (defaults to: nil) —

    Output handle

  • target_handle (String, nil) (defaults to: nil) —

    Input handle

  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



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
 
# File 'lib/retab/workflow_edges.rb', line 80

def create(
  workflow_id:,
  source_block:,
  target_block:,
  id: nil,
  source_handle: nil,
  target_handle: nil,
  request_options: {}
)
  body = {
    "workflow_id" => workflow_id,
    "id" => id,
    "source_block" => source_block,
    "target_block" => target_block,
    "source_handle" => source_handle,
    "target_handle" => target_handle
  }.compact
  response = @client.request(
    method: :post,
    path: "/v1/workflows/edges",
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Retab::WorkflowEdgeDoc.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#create_version_restore(edge_version_id:, request_options: {}) ⇒ Retab::WorkflowEdgeDoc

Restore Edge Version

Parameters:

  • edge_version_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/retab/workflow_edges.rb', line 228

def create_version_restore(
  edge_version_id:,
  request_options: {}
)
  response = @client.request(
    method: :post,
    path: "/v1/workflows/edges/versions/#{Retab::Util.encode_path(edge_version_id)}/restore",
    auth: true,
    request_options: request_options
  )
  result = Retab::WorkflowEdgeDoc.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#delete(edge_id:, request_options: {}) ⇒ void

This method returns an undefined value.

Delete Edge

Parameters:

  • edge_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)



274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/retab/workflow_edges.rb', line 274

def delete(
  edge_id:,
  request_options: {}
)
  @client.request(
    method: :delete,
    path: "/v1/workflows/edges/#{Retab::Util.encode_path(edge_id)}",
    auth: true,
    request_options: request_options
  )
  nil
end

#get(edge_id:, request_options: {}) ⇒ Retab::WorkflowEdgeDoc

Get Edge

Parameters:

  • edge_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/retab/workflow_edges.rb', line 251

def get(
  edge_id:,
  request_options: {}
)
  response = @client.request(
    method: :get,
    path: "/v1/workflows/edges/#{Retab::Util.encode_path(edge_id)}",
    auth: true,
    request_options: request_options
  )
  result = Retab::WorkflowEdgeDoc.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#get_version(edge_version_id:, request_options: {}) ⇒ Retab::WorkflowEdgeVersion

Get Edge Version

Parameters:

  • edge_version_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/retab/workflow_edges.rb', line 205

def get_version(
  edge_version_id:,
  request_options: {}
)
  response = @client.request(
    method: :get,
    path: "/v1/workflows/edges/versions/#{Retab::Util.encode_path(edge_version_id)}",
    auth: true,
    request_options: request_options
  )
  result = Retab::WorkflowEdgeVersion.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#list(workflow_id:, source_block: nil, target_block: nil, before: nil, after: nil, limit: 100, request_options: {}) ⇒ Retab::PaginatedList<Retab::WorkflowEdgeDoc>

List Edges

Parameters:

  • workflow_id (String)
  • source_block (String, nil) (defaults to: nil) —

    Filter by source block ID

  • target_block (String, nil) (defaults to: nil) —

    Filter by target block ID

  • before (String, nil) (defaults to: nil) —

    Edge id cursor: return the page before this id (mutually exclusive with ‘after`).

  • after (String, nil) (defaults to: nil) —

    Edge id cursor: return the page after this id (mutually exclusive with ‘before`).

  • limit (Integer, nil) (defaults to: 100) —

    Maximum number of edges to return per page (1-200).

  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



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
 
# File 'lib/retab/workflow_edges.rb', line 22

def list(
  workflow_id:,
  source_block: nil,
  target_block: nil,
  before: nil,
  after: nil,
  limit: 100,
  request_options: {}
)
  params = {
    "workflow_id" => workflow_id,
    "source_block" => source_block,
    "target_block" => target_block,
    "before" => before,
    "after" => after,
    "limit" => limit
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/workflows/edges",
    auth: true,
    params: params,
    request_options: request_options
  )
  fetch_next = -> (cursor) {
    list(
      workflow_id: workflow_id,
      source_block: source_block,
      target_block: target_block,
      before: before,
      after: cursor,
      limit: limit,
      request_options: request_options
    )
  }
  Retab::PaginatedList.from_response(
    response,
    model: Retab::WorkflowEdgeDoc,
    filters: {
      workflow_id: workflow_id,
      source_block: source_block,
      target_block: target_block,
      before: before,
      limit: limit
    },
    fetch_next: fetch_next
  )
end

#list_diff(from_edge_version_id:, to_edge_version_id:, request_options: {}) ⇒ Retab::WorkflowEdgeVersionDiff

Diff Edge Versions

Parameters:

  • from_edge_version_id (String)
  • to_edge_version_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/retab/workflow_edges.rb', line 176

def list_diff(
  from_edge_version_id:,
  to_edge_version_id:,
  request_options: {}
)
  params = {
    "from_edge_version_id" => from_edge_version_id,
    "to_edge_version_id" => to_edge_version_id
  }
  response = @client.request(
    method: :get,
    path: "/v1/workflows/edges/versions/diff",
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Retab::WorkflowEdgeVersionDiff.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#list_versions(workflow_id:, edge_id: nil, workflow_version_id: nil, before: nil, after: nil, limit: 50, request_options: {}) ⇒ Retab::PaginatedList<Retab::WorkflowEdgeVersion>

List Edge Versions

Parameters:

  • workflow_id (String)
  • edge_id (String, nil) (defaults to: nil) —

    Filter by stable edge ID

  • workflow_version_id (String, nil) (defaults to: nil) —

    Filter by workflow version ID

  • before (String, nil) (defaults to: nil) —

    Edge version cursor before

  • after (String, nil) (defaults to: nil) —

    Edge version cursor after

  • limit (Integer, nil) (defaults to: 50) —

    Maximum number of edge versions to return

  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/retab/workflow_edges.rb', line 122

def list_versions(
  workflow_id:,
  edge_id: nil,
  workflow_version_id: nil,
  before: nil,
  after: nil,
  limit: 50,
  request_options: {}
)
  params = {
    "workflow_id" => workflow_id,
    "edge_id" => edge_id,
    "workflow_version_id" => workflow_version_id,
    "before" => before,
    "after" => after,
    "limit" => limit
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/workflows/edges/versions",
    auth: true,
    params: params,
    request_options: request_options
  )
  fetch_next = -> (cursor) {
    list_versions(
      workflow_id: workflow_id,
      edge_id: edge_id,
      workflow_version_id: workflow_version_id,
      before: before,
      after: cursor,
      limit: limit,
      request_options: request_options
    )
  }
  Retab::PaginatedList.from_response(
    response,
    model: Retab::WorkflowEdgeVersion,
    filters: {
      workflow_id: workflow_id,
      edge_id: edge_id,
      workflow_version_id: workflow_version_id,
      before: before,
      limit: limit
    },
    fetch_next: fetch_next
  )
end