Class: Berrycrawl::Webhooks::Client

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



9
10
11
 
# File 'lib/Berrycrawl/webhooks/client.rb', line 9

def initialize(client:)
  @client = client
end

Instance Method Details

#create(request_options: {}, **params) ⇒ Berrycrawl::Types::WebhookResponse

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/Berrycrawl/webhooks/client.rb', line 52

def create(request_options: {}, **params)
  params = Berrycrawl::Internal::Types::Utils.normalize_keys(params)
  request = Berrycrawl::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "webhooks",
    body: Berrycrawl::Webhooks::Types::CreateWebhookDto.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Berrycrawl::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Berrycrawl::Types::WebhookResponse.load(response.body)
  else
    error_class = Berrycrawl::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#delete(request_options: {}, **params) ⇒ Berrycrawl::Types::MessageResponse

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :id (String)

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/Berrycrawl/webhooks/client.rb', line 117

def delete(request_options: {}, **params)
  params = Berrycrawl::Internal::Types::Utils.normalize_keys(params)
  request = Berrycrawl::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "DELETE",
    path: "webhooks/#{URI.encode_uri_component(params[:id].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Berrycrawl::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Berrycrawl::Types::MessageResponse.load(response.body)
  else
    error_class = Berrycrawl::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#get(request_options: {}, **params) ⇒ Berrycrawl::Types::WebhookResponse

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :id (String)

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/Berrycrawl/webhooks/client.rb', line 85

def get(request_options: {}, **params)
  params = Berrycrawl::Internal::Types::Utils.normalize_keys(params)
  request = Berrycrawl::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "webhooks/#{URI.encode_uri_component(params[:id].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Berrycrawl::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Berrycrawl::Types::WebhookResponse.load(response.body)
  else
    error_class = Berrycrawl::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#list(request_options: {}, **_params) ⇒ Berrycrawl::Types::ListWebhooksResponse

Parameters:

  • request_options (Hash) (defaults to: {})
  • _params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/Berrycrawl/webhooks/client.rb', line 22

def list(request_options: {}, **_params)
  request = Berrycrawl::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "webhooks",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Berrycrawl::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Berrycrawl::Types::ListWebhooksResponse.load(response.body)
  else
    error_class = Berrycrawl::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#test(request_options: {}, **params) ⇒ Berrycrawl::Types::TestWebhookResponse

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :id (String)

Returns:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/Berrycrawl/webhooks/client.rb', line 186

def test(request_options: {}, **params)
  params = Berrycrawl::Internal::Types::Utils.normalize_keys(params)
  request_data = Berrycrawl::Webhooks::Types::TestWebhookDto.new(params).to_h
  non_body_param_names = %w[id]
  body = request_data.except(*non_body_param_names)

  request = Berrycrawl::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "webhooks/#{URI.encode_uri_component(params[:id].to_s)}/test",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Berrycrawl::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Berrycrawl::Types::TestWebhookResponse.load(response.body)
  else
    error_class = Berrycrawl::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#update(request_options: {}, **params) ⇒ Berrycrawl::Types::WebhookResponse

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :id (String)

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/Berrycrawl/webhooks/client.rb', line 149

def update(request_options: {}, **params)
  params = Berrycrawl::Internal::Types::Utils.normalize_keys(params)
  request_data = Berrycrawl::Webhooks::Types::UpdateWebhookDto.new(params).to_h
  non_body_param_names = %w[id]
  body = request_data.except(*non_body_param_names)

  request = Berrycrawl::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PATCH",
    path: "webhooks/#{URI.encode_uri_component(params[:id].to_s)}",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Berrycrawl::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Berrycrawl::Types::WebhookResponse.load(response.body)
  else
    error_class = Berrycrawl::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end