Class: Frame::WebhookEndpoint

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Delete, APIOperations::Save
Defined in:
lib/frame/resources/webhook_endpoint.rb

Constant Summary collapse

OBJECT_NAME = 
"webhook_endpoint"

Instance Attribute Summary

Attributes inherited from FrameObject

#id, #original_values

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

#serialize_params

Methods inherited from APIResource

class_name, #refresh, resource_url, #resource_url

Methods included from APIOperations::Request

included

Methods inherited from FrameObject

#[], #[]=, construct_from, #each, #initialize, #initialize_from, #inspect, #keys, #serialize_params, #to_hash, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Frame::FrameObject

Class Method Details

.create(params = {}, opts = {}) ⇒ Object 



25
26
27
 
# File 'lib/frame/resources/webhook_endpoint.rb', line 25

def self.create(params = {}, opts = {})
  request_object(:post, "/v1/webhook_endpoints", params, opts)
end

.list(params = {}, opts = {}) ⇒ Object 



16
17
18
 
# File 'lib/frame/resources/webhook_endpoint.rb', line 16

def self.list(params = {}, opts = {})
  request_object(:get, "/v1/webhook_endpoints", params, opts)
end

.object_name ⇒ Object 



12
13
14
 
# File 'lib/frame/resources/webhook_endpoint.rb', line 12

def self.object_name
  OBJECT_NAME
end

.retrieve(id, opts = {}) ⇒ Object 



20
21
22
23
 
# File 'lib/frame/resources/webhook_endpoint.rb', line 20

def self.retrieve(id, opts = {})
  id = Util.normalize_id(id)
  request_object(:get, "/v1/webhook_endpoints/#{CGI.escape(id)}", {}, opts)
end

.rotate_secret(id, params = {}, opts = {}) ⇒ Object 



29
30
31
32
 
# File 'lib/frame/resources/webhook_endpoint.rb', line 29

def self.rotate_secret(id, params = {}, opts = {})
  id = Util.normalize_id(id)
  request_object(:post, "/v1/webhook_endpoints/#{CGI.escape(id)}/rotate_secret", params, opts)
end

Instance Method Details

#delete(params = {}, opts = {}) ⇒ Object 



47
48
49
 
# File 'lib/frame/resources/webhook_endpoint.rb', line 47

def delete(params = {}, opts = {})
  request_object(:delete, "/v1/webhook_endpoints/#{CGI.escape(self["id"])}", params, opts)
end

#rotate_secret(params = {}, opts = {}) ⇒ Object 



34
35
36
 
# File 'lib/frame/resources/webhook_endpoint.rb', line 34

def rotate_secret(params = {}, opts = {})
  request_object(:post, "/v1/webhook_endpoints/#{CGI.escape(self["id"])}/rotate_secret", params, opts)
end

#save(params = {}, opts = {}) ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/frame/resources/webhook_endpoint.rb', line 38

def save(params = {}, opts = {})
  values = serialize_params(self).merge(params)
  return self if values.empty?

  updated = request_object(:patch, "/v1/webhook_endpoints/#{CGI.escape(self["id"])}", values, opts)
  initialize_from(updated)
  self
end