Class: GoCardlessPro::Resources::BillingRequestFlow

Inherits:
Object
  • Object
show all
Defined in:
lib/gocardless_pro/resources/billing_request_flow.rb

Overview

Billing Request Flows can be created to enable a payer to authorise a payment created for a scheme with strong payer authorisation (such as open banking single payments).

Defined Under Namespace

Classes: Links

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(object, response = nil) ⇒ BillingRequestFlow

Initialize a billing_request_flow resource instance

Parameters:

  • object (Hash) —

    an object returned from the API



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 22

def initialize(object, response = nil)
  @object = object

  @authorisation_url = object['authorisation_url']
  @auto_fulfil = object['auto_fulfil']
  @created_at = object['created_at']
  @customer_details_captured = object['customer_details_captured']
  @exit_uri = object['exit_uri']
  @expires_at = object['expires_at']
  @id = object['id']
  @language = object['language']
  @links = object['links']
  @lock_bank_account = object['lock_bank_account']
  @lock_currency = object['lock_currency']
  @lock_customer_details = object['lock_customer_details']
  @prefilled_bank_account = object['prefilled_bank_account']
  @prefilled_customer = object['prefilled_customer']
  @redirect_uri = object['redirect_uri']
  @session_token = object['session_token']
  @show_redirect_buttons = object['show_redirect_buttons']
  @show_success_redirect_button = object['show_success_redirect_button']
  @skip_success_screen = object['skip_success_screen']
  @response = response
end

Instance Attribute Details

#authorisation_url ⇒ Object (readonly)

Returns the value of attribute authorisation_url.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def authorisation_url
  @authorisation_url
end

#auto_fulfil ⇒ Object (readonly)

Returns the value of attribute auto_fulfil.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def auto_fulfil
  @auto_fulfil
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def created_at
  @created_at
end

#customer_details_captured ⇒ Object (readonly)

Returns the value of attribute customer_details_captured.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def customer_details_captured
  @customer_details_captured
end

#exit_uri ⇒ Object (readonly)

Returns the value of attribute exit_uri.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def exit_uri
  @exit_uri
end

#expires_at ⇒ Object (readonly)

Returns the value of attribute expires_at.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def id
  @id
end

#language ⇒ Object (readonly)

Returns the value of attribute language.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def language
  @language
end

#lock_bank_account ⇒ Object (readonly)

Returns the value of attribute lock_bank_account.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def 
  @lock_bank_account
end

#lock_currency ⇒ Object (readonly)

Returns the value of attribute lock_currency.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def lock_currency
  @lock_currency
end

#lock_customer_details ⇒ Object (readonly)

Returns the value of attribute lock_customer_details.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def lock_customer_details
  @lock_customer_details
end

#prefilled_bank_account ⇒ Object (readonly)

Returns the value of attribute prefilled_bank_account.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def 
  @prefilled_bank_account
end

#prefilled_customer ⇒ Object (readonly)

Returns the value of attribute prefilled_customer.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def prefilled_customer
  @prefilled_customer
end

#redirect_uri ⇒ Object (readonly)

Returns the value of attribute redirect_uri.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def redirect_uri
  @redirect_uri
end

#session_token ⇒ Object (readonly)

Returns the value of attribute session_token.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def session_token
  @session_token
end

#show_redirect_buttons ⇒ Object (readonly)

Returns the value of attribute show_redirect_buttons.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def show_redirect_buttons
  @show_redirect_buttons
end

#show_success_redirect_button ⇒ Object (readonly)

Returns the value of attribute show_success_redirect_button.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def show_success_redirect_button
  @show_success_redirect_button
end

#skip_success_screen ⇒ Object (readonly)

Returns the value of attribute skip_success_screen.



17
18
19
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 17

def skip_success_screen
  @skip_success_screen
end

Instance Method Details

#api_response ⇒ Object 



47
48
49
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 47

def api_response
  ApiResponse.new(@response)
end

#links ⇒ Object

Return the links that the resource has



52
53
54
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 52

def links
  @billing_request_flow_links ||= Links.new(@links)
end

#to_h ⇒ Object

Provides the billing_request_flow resource as a hash of all its readable attributes



57
58
59
 
# File 'lib/gocardless_pro/resources/billing_request_flow.rb', line 57

def to_h
  @object
end