Class: Paid::AgentsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/paid_ruby/agents/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Paid::AgentsClient

Parameters:



24
25
26
 
# File 'lib/paid_ruby/agents/client.rb', line 24

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Paid::RequestClient (readonly)

Returns:



19
20
21
 
# File 'lib/paid_ruby/agents/client.rb', line 19

def request_client
  @request_client
end

Instance Method Details

#create(name:, description:, agent_code: nil, external_id: nil, active: nil, request_options: nil) ⇒ Object

)



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/paid_ruby/agents/client.rb', line 77

def create(name:, description:, agent_code: nil, external_id: nil, active: nil, request_options: nil)
  response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), name: name, description: description, agentCode: agent_code, externalId: external_id, active: active }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/agents"
end
  Paid::Agent.from_json(json_object: response.body)
end

#delete(agent_id:, request_options: nil) ⇒ Object

api.agents.delete(agent_id: “agentId”)



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/paid_ruby/agents/client.rb', line 167

def delete(agent_id:, request_options: nil)
  response = @request_client.conn.delete do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/agents/#{agent_id}"
end
end

#delete_by_external_id(external_id:, request_options: nil) ⇒ Object

api.agents.delete_by_external_id(external_id: “externalId”)



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/paid_ruby/agents/client.rb', line 258

def delete_by_external_id(external_id:, request_options: nil)
  response = @request_client.conn.delete do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/agents/external/#{external_id}"
end
end

#get(agent_id:, request_options: nil) ⇒ Object

api.agents.get(agent_id: “agentId”)



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/paid_ruby/agents/client.rb', line 104

def get(agent_id:, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/agents/#{agent_id}"
end
  Paid::Agent.from_json(json_object: response.body)
end

#get_by_external_id(external_id:, request_options: nil) ⇒ Object

api.agents.get_by_external_id(external_id: “externalId”)



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/paid_ruby/agents/client.rb', line 195

def get_by_external_id(external_id:, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/agents/external/#{external_id}"
end
  Paid::Agent.from_json(json_object: response.body)
end

#list(request_options: nil) ⇒ Object

api.agents.list



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/paid_ruby/agents/client.rb', line 36

def list(request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/agents"
end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do | item |
    item = item.to_json
    Paid::Agent.from_json(json_object: item)
  end
end

#update(agent_id:, request:, request_options: nil) ⇒ Object

api.agents.update(agent_id: “agentId”, request: { name: “Acme Agent (Updated)”, agent_attributes: [{ name: “Emails sent signal”, active: true, pricing: { event_name: “emails_sent”, taxable: true, charge_type: USAGE, pricing_model: PER_UNIT, billing_frequency: MONTHLY, price_points: { “USD”: { tiers: [{ min_quantity: 0, max_quantity: 10, unit_price: 100 }, { min_quantity: 11, max_quantity: 100, unit_price: 90 }, { min_quantity: 101, unit_price: 80 }] } } } }] })



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/paid_ruby/agents/client.rb', line 140

def update(agent_id:, request:, request_options: nil)
  response = @request_client.conn.put do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/agents/#{agent_id}"
end
  Paid::Agent.from_json(json_object: response.body)
end

#update_by_external_id(external_id:, request:, request_options: nil) ⇒ Object

api.agents.update_by_external_id(external_id: “externalId”, request: { name: “Acme Agent (Updated)”, agent_attributes: [{ name: “Emails sent signal”, active: true, pricing: { event_name: “emails_sent”, taxable: true, charge_type: USAGE, pricing_model: PER_UNIT, billing_frequency: MONTHLY, price_points: { “USD”: { unit_price: 150 } } } }] })



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/paid_ruby/agents/client.rb', line 231

def update_by_external_id(external_id:, request:, request_options: nil)
  response = @request_client.conn.put do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/agents/external/#{external_id}"
end
  Paid::Agent.from_json(json_object: response.body)
end