Module: RubyLokaliseApi::Rest::Webhooks

Included in:
Client
Defined in:
lib/ruby_lokalise_api/rest/webhooks.rb

Instance Method Summary collapse

Instance Method Details

#create_webhook(project_id, params) ⇒ RubyLokaliseApi::Resources::Webhook

Creates webhook for the given project

Parameters:

  • project_id (String)
  • params (Hash)

Returns:

See Also:



32
33
34
 
# File 'lib/ruby_lokalise_api/rest/webhooks.rb', line 32

def create_webhook(project_id, params)
  c_r RubyLokaliseApi::Resources::Webhook, :create, project_id, params
end

#destroy_webhook(project_id, webhook_id) ⇒ Hash

Deletes webhook for the given project

Parameters:

  • project_id (String)
  • webhook_id (String, Integer)

Returns:

  • (Hash)

See Also:



53
54
55
 
# File 'lib/ruby_lokalise_api/rest/webhooks.rb', line 53

def destroy_webhook(project_id, webhook_id)
  c_r RubyLokaliseApi::Resources::Webhook, :destroy, [project_id, webhook_id]
end

#regenerate_webhook_secret(project_id, webhook_id) ⇒ Hash

Regenerates secret for the given webhook

Parameters:

  • project_id (String)
  • webhook_id (String, Integer)

Returns:

  • (Hash)

See Also:



63
64
65
66
 
# File 'lib/ruby_lokalise_api/rest/webhooks.rb', line 63

def regenerate_webhook_secret(project_id, webhook_id)
  c_r RubyLokaliseApi::Resources::Webhook, :regenerate_secret,
      [project_id, webhook_id, 'secret', 'regenerate']
end

#update_webhook(project_id, webhook_id, params = {}) ⇒ RubyLokaliseApi::Resources::Webhook

Updates webhook for the given project

Parameters:

  • project_id (String)
  • webhook_id (String, Integer)
  • params (Hash) (defaults to: {})

Returns:

See Also:



43
44
45
 
# File 'lib/ruby_lokalise_api/rest/webhooks.rb', line 43

def update_webhook(project_id, webhook_id, params = {})
  c_r RubyLokaliseApi::Resources::Webhook, :update, [project_id, webhook_id], params
end

#webhook(project_id, webhook_id) ⇒ RubyLokaliseApi::Resources::Webhook

Returns a single webhook for the given project

Parameters:

  • project_id (String)
  • webhook_id (String, Integer)

Returns:

See Also:



22
23
24
 
# File 'lib/ruby_lokalise_api/rest/webhooks.rb', line 22

def webhook(project_id, webhook_id)
  c_r RubyLokaliseApi::Resources::Webhook, :find, [project_id, webhook_id]
end

#webhooks(project_id, params = {}) ⇒ RubyLokaliseApi::Collection::Webhook<RubyLokaliseApi::Resources::Webhook>

Returns all webhooks for the given project

Parameters:

  • project_id (String)
  • params (Hash) (defaults to: {})

Returns:

See Also:



12
13
14
 
# File 'lib/ruby_lokalise_api/rest/webhooks.rb', line 12

def webhooks(project_id, params = {})
  c_r RubyLokaliseApi::Collections::Webhook, :all, project_id, params
end