Class: Merge::Crm::WebhookReceiversClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/crm/webhook_receivers/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Crm::WebhookReceiversClient

Parameters:



16
17
18
 
# File 'lib/merge_ruby_client/crm/webhook_receivers/client.rb', line 16

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::RequestClient (readonly)

Returns:



12
13
14
 
# File 'lib/merge_ruby_client/crm/webhook_receivers/client.rb', line 12

def request_client
  @request_client
end

Instance Method Details

#create(event:, is_active:, key: nil, request_options: nil) ⇒ Merge::Crm::WebhookReceiver

Creates a ‘WebhookReceiver` object with the given values.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.crm.webhook_receivers.create(event: "event", is_active: true)

Parameters:

  • event (String)
  • is_active (Boolean)
  • key (String) (defaults to: nil)
  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/merge_ruby_client/crm/webhook_receivers/client.rb', line 70

def create(event:, is_active:, key: nil, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    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 || {}),
      event: event,
      is_active: is_active,
      key: key
    }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/webhook-receivers"
  end
  Merge::Crm::WebhookReceiver.from_json(json_object: response.body)
end

#list(request_options: nil) ⇒ Array<Merge::Crm::WebhookReceiver>

Returns a list of ‘WebhookReceiver` objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.crm.webhook_receivers.list

Parameters:

Returns:



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/merge_ruby_client/crm/webhook_receivers/client.rb', line 31

def list(request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    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)}/crm/v1/webhook-receivers"
  end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do |item|
    item = item.to_json
    Merge::Crm::WebhookReceiver.from_json(json_object: item)
  end
end