Class: EasyPost::Services::ScanForm

Inherits:
Service
  • Object
show all
Defined in:
lib/easypost/services/scan_form.rb

Constant Summary collapse

MODEL_CLASS =
EasyPost::Models::ScanForm

Instance Method Summary collapse

Methods inherited from Service

#initialize

Constructor Details

This class inherits a constructor from EasyPost::Services::Service

Instance Method Details

#all(params = {}) ⇒ Object

Retrieve a list of ScanForms



17
18
19
# File 'lib/easypost/services/scan_form.rb', line 17

def all(params = {})
  @client.make_request(:get, 'scan_forms', MODEL_CLASS, params)
end

#create(params = {}) ⇒ Object

Create a ScanForm.



7
8
9
# File 'lib/easypost/services/scan_form.rb', line 7

def create(params = {})
  @client.make_request(:post, 'scan_forms', MODEL_CLASS, params)
end

#get_next_page(collection, page_size = nil) ⇒ Object

Get the next page of ScanForms.



22
23
24
# File 'lib/easypost/services/scan_form.rb', line 22

def get_next_page(collection, page_size = nil)
  get_next_page_helper(collection, collection.scan_forms, 'scan_forms', MODEL_CLASS, page_size)
end

#retrieve(id) ⇒ Object

Retrieve a ScanForm.



12
13
14
# File 'lib/easypost/services/scan_form.rb', line 12

def retrieve(id)
  @client.make_request(:get, "scan_forms/#{id}", MODEL_CLASS)
end