Class: Gusto::AsyncWebhooksClient

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::AsyncWebhooksClient

Parameters:



322
323
324
 
# File 'lib/fern_gusto/webhooks/client.rb', line 322

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Gusto::AsyncRequestClient (readonly)

Returns:



317
318
319
 
# File 'lib/fern_gusto/webhooks/client.rb', line 317

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])



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/fern_gusto/webhooks/client.rb', line 391

def create(url:, subscription_types:, request_options: nil)
  Async do
    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
end

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

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



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/fern_gusto/webhooks/client.rb', line 514

def delete(webhook_subscription_uuid:, request_options: nil)
  Async do
    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
end

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

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



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/fern_gusto/webhooks/client.rb', line 431

def get(webhook_subscription_uuid:, request_options: nil)
  Async do
    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
end

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

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



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/fern_gusto/webhooks/client.rb', line 603

def get_verification_token(webhook_subscription_uuid:, request_options: nil)
  Async do
    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
end

#list(request_options: nil) ⇒ Object

api.webhooks.list



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/fern_gusto/webhooks/client.rb', line 343

def list(request_options: nil)
  Async do
    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
end

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

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



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/fern_gusto/webhooks/client.rb', line 474

def update(webhook_subscription_uuid:, subscription_types:, request_options: nil)
  Async do
    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
end

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

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



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/fern_gusto/webhooks/client.rb', line 562

def verify(webhook_subscription_uuid:, verification_token:, request_options: nil)
  Async do
    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
end