Class: Merge::Crm::AsyncWebhookReceiversClient

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

Parameters:



101
102
103
 
# File 'lib/merge_ruby_client/crm/webhook_receivers/client.rb', line 101

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



97
98
99
 
# File 'lib/merge_ruby_client/crm/webhook_receivers/client.rb', line 97

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:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/merge_ruby_client/crm/webhook_receivers/client.rb', line 157

def create(event:, is_active:, key: nil, request_options: nil)
  Async do
    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
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:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/merge_ruby_client/crm/webhook_receivers/client.rb', line 116

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