Class: Asana::Resources::WebhooksBase
- Defined in:
- lib/asana/resources/gen/webhooks_base.rb
Direct Known Subclasses
Class Method Summary collapse
-
.create_webhook(client, options: {}, **data) ⇒ Object
options - [Hash] the request I/O options > opt_fields - [list] Defines fields to return.
-
.delete_webhook(client, webhook_gid: required("webhook_gid"), options: {}) ⇒ Object
Delete a webhook.
-
.get_webhook(client, webhook_gid: required("webhook_gid"), options: {}) ⇒ Object
Get a webhook.
-
.get_webhooks(client, workspace: nil, resource: nil, options: {}) ⇒ Object
workspace - [str] (required) The workspace to query for webhooks in.
- .inherited(base) ⇒ Object
-
.update_webhook(client, webhook_gid: required("webhook_gid"), options: {}, **data) ⇒ Object
Update a webhook.
Methods inherited from Resource
#initialize, #method_missing, #refresh, #respond_to_missing?, #to_h, #to_s
Methods included from ResponseHelper
Constructor Details
This class inherits a constructor from Asana::Resources::Resource
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Asana::Resources::Resource
Class Method Details
.create_webhook(client, options: {}, **data) ⇒ Object
options - [Hash] the request I/O options > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
22 23 24 25 |
# File 'lib/asana/resources/gen/webhooks_base.rb', line 22 def create_webhook(client, options: {}, **data) path = "/webhooks" Webhook.new(parse(client.post(path, body: data, options: )).first, client: client) end |
.delete_webhook(client, webhook_gid: required("webhook_gid"), options: {}) ⇒ Object
Delete a webhook
33 34 35 36 37 |
# File 'lib/asana/resources/gen/webhooks_base.rb', line 33 def delete_webhook(client, webhook_gid: required("webhook_gid"), options: {}) path = "/webhooks/{webhook_gid}" path["{webhook_gid}"] = webhook_gid parse(client.delete(path, options: )).first end |
.get_webhook(client, webhook_gid: required("webhook_gid"), options: {}) ⇒ Object
Get a webhook
45 46 47 48 49 |
# File 'lib/asana/resources/gen/webhooks_base.rb', line 45 def get_webhook(client, webhook_gid: required("webhook_gid"), options: {}) path = "/webhooks/{webhook_gid}" path["{webhook_gid}"] = webhook_gid Webhook.new(parse(client.get(path, options: )).first, client: client) end |
.get_webhooks(client, workspace: nil, resource: nil, options: {}) ⇒ Object
workspace - [str] (required) The workspace to query for webhooks in.
61 62 63 64 65 |
# File 'lib/asana/resources/gen/webhooks_base.rb', line 61 def get_webhooks(client, workspace: nil, resource: nil, options: {}) path = "/webhooks" params = { workspace: workspace, resource: resource }.reject { |_,v| v.nil? || Array(v).empty? } Collection.new(parse(client.get(path, params: params, options: )), type: Webhook, client: client) end |
.inherited(base) ⇒ Object
10 11 12 |
# File 'lib/asana/resources/gen/webhooks_base.rb', line 10 def self.inherited(base) Registry.register(base) end |
.update_webhook(client, webhook_gid: required("webhook_gid"), options: {}, **data) ⇒ Object
Update a webhook
74 75 76 77 78 |
# File 'lib/asana/resources/gen/webhooks_base.rb', line 74 def update_webhook(client, webhook_gid: required("webhook_gid"), options: {}, **data) path = "/webhooks/{webhook_gid}" path["{webhook_gid}"] = webhook_gid Webhook.new(parse(client.put(path, body: data, options: )).first, client: client) end |