Class: EasyPost::Webhook

Inherits:
Resource show all
Defined in:
lib/easypost/webhook.rb

Instance Attribute Summary

Attributes inherited from EasyPostObject

#api_key, #name, #parent, #unsaved_values

Instance Method Summary collapse

Methods inherited from Resource

all, class_name, create, #refresh, retrieve, #save, url, #url

Methods inherited from EasyPostObject

#[], #[]=, #as_json, construct_from, #deconstruct_keys, #each, #id, #id=, #initialize, #inspect, #keys, #refresh_from, #to_hash, #to_json, #to_s, #values

Constructor Details

This class inherits a constructor from EasyPost::EasyPostObject

Instance Method Details

#deleteObject



16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'lib/easypost/webhook.rb', line 16

def delete
  # NOTE: This method is redefined here since the "url" method conflicts
  # with the objects field
  unless self.id
    raise EasyPost::Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{self.id.inspect}")
  end
  instance_url = "#{self.class.url}/#{CGI.escape(id)}"

  response = EasyPost.make_request(:delete, instance_url, @api_key)
  refresh_from(response, api_key)

  return self
end

#update(params = {}) ⇒ Object



2
3
4
5
6
7
8
9
10
11
12
13
14
# File 'lib/easypost/webhook.rb', line 2

def update(params={})
  # NOTE: This method is redefined here since the "url" method conflicts
  # with the objects field
  unless self.id
    raise EasyPost::Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{self.id.inspect}")
  end
  instance_url = "#{self.class.url}/#{CGI.escape(id)}"

  response = EasyPost.make_request(:put, instance_url, @api_key, params)
  self.refresh_from(response, api_key, true)

  return self
end