Class: Gusto::WebhooksClient

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/webhooks/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Gusto::WebhooksClient

Parameters:



24
25
26
 
# File 'lib/fern_gusto/webhooks/client.rb', line 24

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Gusto::RequestClient (readonly)

Returns:



19
20
21
 
# File 'lib/fern_gusto/webhooks/client.rb', line 19

def request_client
  @request_client
end

Instance Method Details

#create(url:, subscription_types:, request_options: nil) ⇒ Object

api.webhooks.create(url: “partner-app.com/subscriber”, subscription_types: [COMPANY, EMPLOYEE])



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/fern_gusto/webhooks/client.rb', line 91

def create(url:, subscription_types:, 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
  unless request_options&.gusto_api_version.nil?
req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  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 || {}), url: url, subscription_types: subscription_types }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/webhook_subscriptions"
end
  Gusto::Webhooks::WebhookSubscription.from_json(json_object: response.body)
end

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

api.webhooks.delete(webhook_subscription_uuid: “webhook_subscription_uuid”)



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/fern_gusto/webhooks/client.rb', line 208

def delete(webhook_subscription_uuid:, 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
  unless request_options&.gusto_api_version.nil?
req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  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)}/v1/webhook_subscriptions/#{webhook_subscription_uuid}"
end
end

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

api.webhooks.get(webhook_subscription_uuid: “webhook_subscription_uuid”)



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/fern_gusto/webhooks/client.rb', line 129

def get(webhook_subscription_uuid:, 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
  unless request_options&.gusto_api_version.nil?
req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  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)}/v1/webhook_subscriptions/#{webhook_subscription_uuid}"
end
  Gusto::Webhooks::WebhookSubscription.from_json(json_object: response.body)
end

#get_verification_token(webhook_subscription_uuid:, request_options: nil) ⇒ Object

api.webhooks.get_verification_token(webhook_subscription_uuid: “webhook_subscription_uuid”)



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/fern_gusto/webhooks/client.rb', line 293

def get_verification_token(webhook_subscription_uuid:, 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
  unless request_options&.gusto_api_version.nil?
req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  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)}/v1/webhook_subscriptions/#{webhook_subscription_uuid}/request_verification_token"
end
end

#list(request_options: nil) ⇒ Object

api.webhooks.list



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
 
# File 'lib/fern_gusto/webhooks/client.rb', line 45

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
  unless request_options&.gusto_api_version.nil?
req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  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)}/v1/webhook_subscriptions"
end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do | item |
    item = item.to_json
    Gusto::Webhooks::WebhookSubscription.from_json(json_object: item)
  end
end

#update(webhook_subscription_uuid:, subscription_types:, request_options: nil) ⇒ Object

api.webhooks.update(webhook_subscription_uuid: “webhook_subscription_uuid”, subscription_types: [COMPANY, EMPLOYEE])



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/fern_gusto/webhooks/client.rb', line 170

def update(webhook_subscription_uuid:, subscription_types:, 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
  unless request_options&.gusto_api_version.nil?
req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  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 || {}), subscription_types: subscription_types }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/webhook_subscriptions/#{webhook_subscription_uuid}"
end
  Gusto::Webhooks::WebhookSubscription.from_json(json_object: response.body)
end

#verify(webhook_subscription_uuid:, verification_token:, request_options: nil) ⇒ Object

api.webhooks.verify(webhook_subscription_uuid: “webhook_subscription_uuid”, verification_token: “asefasedfe23e234easd”)



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/fern_gusto/webhooks/client.rb', line 254

def verify(webhook_subscription_uuid:, verification_token:, 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
  unless request_options&.gusto_api_version.nil?
req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  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 || {}), verification_token: verification_token }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/webhook_subscriptions/#{webhook_subscription_uuid}/verify"
end
  Gusto::Webhooks::WebhookSubscription.from_json(json_object: response.body)
end