Class: Frame::Onboarding

Inherits:
APIResource show all
Defined in:
lib/frame/resources/onboarding.rb

Constant Summary collapse

OBJECT_NAME = 
"onboarding_session"

Instance Attribute Summary

Attributes inherited from FrameObject

#id, #original_values

Class Method Summary collapse

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 



15
16
17
 
# File 'lib/frame/resources/onboarding.rb', line 15

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

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



11
12
13
 
# File 'lib/frame/resources/onboarding.rb', line 11

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

.object_name ⇒ Object 



7
8
9
 
# File 'lib/frame/resources/onboarding.rb', line 7

def self.object_name
  OBJECT_NAME
end

.payout(session_id, params = {}, opts = {}) ⇒ Object 



27
28
29
 
# File 'lib/frame/resources/onboarding.rb', line 27

def self.payout(session_id, params = {}, opts = {})
  request_object(:post, "/v1/onboarding/sessions/#{CGI.escape(session_id)}/payout", params, opts)
end

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



19
20
21
 
# File 'lib/frame/resources/onboarding.rb', line 19

def self.retrieve(session_id, opts = {})
  request_object(:get, "/v1/onboarding/sessions/#{CGI.escape(session_id)}", {}, opts)
end

.update(session_id, params = {}, opts = {}) ⇒ Object 



23
24
25
 
# File 'lib/frame/resources/onboarding.rb', line 23

def self.update(session_id, params = {}, opts = {})
  request_object(:patch, "/v1/onboarding/sessions/#{CGI.escape(session_id)}", params, opts)
end