Module: Crowdin::ApiResources::Webhooks

Defined in:
lib/crowdin-api/api_resources/webhooks.rb

Instance Method Summary collapse

Instance Method Details

#add_webhook(query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Body



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/crowdin-api/api_resources/webhooks.rb', line 24

def add_webhook(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/webhooks",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#delete_webhook(webhook_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • webhook_id (Integer) (defaults to: nil) —

    Webhook Identifier



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/crowdin-api/api_resources/webhooks.rb', line 54

def delete_webhook(webhook_id = nil, project_id = config.project_id)
  webhook_id || raise_parameter_is_required_error(:webhook_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}/webhooks/#{webhook_id}"
  )
  Web::SendRequest.new(request).perform
end

#edit_webhook(webhook_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • webhook_id (Integer) (defaults to: nil) —

    Webhook Identifier

  • query (Hash) (defaults to: {}) —

    Request Body



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/crowdin-api/api_resources/webhooks.rb', line 70

def edit_webhook(webhook_id = nil, query = {}, project_id = config.project_id)
  webhook_id || raise_parameter_is_required_error(:webhook_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/projects/#{project_id}/webhooks/#{webhook_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#get_webhook(webhook_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • webhook_id (Integer) (defaults to: nil) —

    Webhook Identifier



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/crowdin-api/api_resources/webhooks.rb', line 39

def get_webhook(webhook_id = nil, project_id = config.project_id)
  webhook_id || raise_parameter_is_required_error(:webhook_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/webhooks/#{webhook_id}"
  )
  Web::SendRequest.new(request).perform
end

#list_webhooks(query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/crowdin-api/api_resources/webhooks.rb', line 9

def list_webhooks(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/webhooks",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end