Class: Stripe::DelegatedCheckout::RequestedSession

Inherits:
APIResource show all
Extended by:
APIOperations::Create
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/delegated_checkout/requested_session.rb

Overview

A requested session is a session that has been requested by a customer.

Defined Under Namespace

Classes: FulfillmentDetails

Constant Summary collapse

OBJECT_NAME = 
"delegated_checkout.requested_session"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



26
27
28
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 26

def currency
  @currency
end

#customer ⇒ Object (readonly)

The customer for this requested session.



28
29
30
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 28

def customer
  @customer
end

#fulfillment_details ⇒ Object (readonly)

Attribute for field fulfillment_details



30
31
32
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 30

def fulfillment_details
  @fulfillment_details
end

#id ⇒ Object (readonly)

Unique identifier for the object.



32
33
34
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 32

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



34
35
36
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 34

def livemode
  @livemode
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



36
37
38
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 36

def object
  @object
end

Class Method Details

.confirm(requested_session, params = {}, opts = {}) ⇒ Object

Confirms a requested session



49
50
51
52
53
54
55
56
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 49

def self.confirm(requested_session, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/delegated_checkout/requested_sessions/%<requested_session>s/confirm", { requested_session: CGI.escape(requested_session) }),
    params: params,
    opts: opts
  )
end

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

Creates a requested session



59
60
61
62
63
64
65
66
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 59

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/delegated_checkout/requested_sessions",
    params: params,
    opts: opts
  )
end

.expire(requested_session, params = {}, opts = {}) ⇒ Object

Expires a requested session



79
80
81
82
83
84
85
86
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 79

def self.expire(requested_session, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/delegated_checkout/requested_sessions/%<requested_session>s/expire", { requested_session: CGI.escape(requested_session) }),
    params: params,
    opts: opts
  )
end

.field_remappings ⇒ Object 



102
103
104
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 102

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



98
99
100
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 98

def self.inner_class_types
  @inner_class_types = { fulfillment_details: FulfillmentDetails }
end

.object_name ⇒ Object 



12
13
14
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 12

def self.object_name
  "delegated_checkout.requested_session"
end

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

Updates a requested session



89
90
91
92
93
94
95
96
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 89

def self.update(requested_session, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/delegated_checkout/requested_sessions/%<requested_session>s", { requested_session: CGI.escape(requested_session) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

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

Confirms a requested session



39
40
41
42
43
44
45
46
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 39

def confirm(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/delegated_checkout/requested_sessions/%<requested_session>s/confirm", { requested_session: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

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

Expires a requested session



69
70
71
72
73
74
75
76
 
# File 'lib/stripe/resources/delegated_checkout/requested_session.rb', line 69

def expire(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/delegated_checkout/requested_sessions/%<requested_session>s/expire", { requested_session: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end