Class: Zavudev::Resources::Senders::Agent::Flows

Inherits:
Object
  • Object
show all
Defined in:
lib/zavudev/resources/senders/agent/flows.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Flows

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Flows.

Parameters:



184
185
186
 
# File 'lib/zavudev/resources/senders/agent/flows.rb', line 184

def initialize(client:)
  @client = client
end

Instance Method Details

#create(sender_id, name:, steps:, trigger:, description: nil, enabled: nil, priority: nil, request_options: {}) ⇒ Zavudev::Models::Senders::Agent::FlowCreateResponse

Create a new flow for an agent.

Parameters:

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/zavudev/resources/senders/agent/flows.rb', line 24

def create(sender_id, params)
  parsed, options = Zavudev::Senders::Agent::FlowCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/senders/%1$s/agent/flows", sender_id],
    body: parsed,
    model: Zavudev::Models::Senders::Agent::FlowCreateResponse,
    options: options
  )
end

#delete(flow_id, sender_id:, request_options: {}) ⇒ nil

Delete a flow. Cannot delete flows with active sessions.

Parameters:

Returns:

  • (nil)

See Also:



137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/zavudev/resources/senders/agent/flows.rb', line 137

def delete(flow_id, params)
  parsed, options = Zavudev::Senders::Agent::FlowDeleteParams.dump_request(params)
  sender_id =
    parsed.delete(:sender_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["v1/senders/%1$s/agent/flows/%2$s", sender_id, flow_id],
    model: NilClass,
    options: options
  )
end

#duplicate(flow_id, sender_id:, new_name:, request_options: {}) ⇒ Zavudev::Models::Senders::Agent::FlowDuplicateResponse

Create a copy of an existing flow with a new name.

Parameters:

  • flow_id (String) —

    Path param

  • sender_id (String) —

    Path param

  • new_name (String) —

    Body param

  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/zavudev/resources/senders/agent/flows.rb', line 166

def duplicate(flow_id, params)
  parsed, options = Zavudev::Senders::Agent::FlowDuplicateParams.dump_request(params)
  sender_id =
    parsed.delete(:sender_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["v1/senders/%1$s/agent/flows/%2$s/duplicate", sender_id, flow_id],
    body: parsed,
    model: Zavudev::Models::Senders::Agent::FlowDuplicateResponse,
    options: options
  )
end

#list(sender_id, cursor: nil, enabled: nil, limit: nil, request_options: {}) ⇒ Zavudev::Internal::Cursor<Zavudev::Models::Senders::Agent::AgentFlow>

List flows for an agent.

Parameters:

  • sender_id (String)
  • cursor (String)
  • enabled (Boolean)
  • limit (Integer)
  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/zavudev/resources/senders/agent/flows.rb', line 113

def list(sender_id, params = {})
  parsed, options = Zavudev::Senders::Agent::FlowListParams.dump_request(params)
  query = Zavudev::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["v1/senders/%1$s/agent/flows", sender_id],
    query: query,
    page: Zavudev::Internal::Cursor,
    model: Zavudev::Senders::Agent::AgentFlow,
    options: options
  )
end

#retrieve(flow_id, sender_id:, request_options: {}) ⇒ Zavudev::Models::Senders::Agent::FlowRetrieveResponse

Get a specific flow.

Parameters:

Returns:

See Also:



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/zavudev/resources/senders/agent/flows.rb', line 46

def retrieve(flow_id, params)
  parsed, options = Zavudev::Senders::Agent::FlowRetrieveParams.dump_request(params)
  sender_id =
    parsed.delete(:sender_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["v1/senders/%1$s/agent/flows/%2$s", sender_id, flow_id],
    model: Zavudev::Models::Senders::Agent::FlowRetrieveResponse,
    options: options
  )
end

#update(flow_id, sender_id:, description: nil, enabled: nil, name: nil, priority: nil, steps: nil, trigger: nil, request_options: {}) ⇒ Zavudev::Models::Senders::Agent::FlowUpdateResponse

Update a flow.

Parameters:

Returns:

See Also:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/zavudev/resources/senders/agent/flows.rb', line 85

def update(flow_id, params)
  parsed, options = Zavudev::Senders::Agent::FlowUpdateParams.dump_request(params)
  sender_id =
    parsed.delete(:sender_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :patch,
    path: ["v1/senders/%1$s/agent/flows/%2$s", sender_id, flow_id],
    body: parsed,
    model: Zavudev::Models::Senders::Agent::FlowUpdateResponse,
    options: options
  )
end