Class: Stripe::LoginLink

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/login_link.rb

Overview

Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard. A Login Link differs from an [Account Link](stripe.com/docs/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](stripe.com/docs/connect/integrate-express-dashboard#create-login-link)

Constant Summary collapse

OBJECT_NAME =
"login_link"

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

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, 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

#createdObject (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



14
15
16
# File 'lib/stripe/resources/login_link.rb', line 14

def created
  @created
end

#objectObject (readonly)

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



16
17
18
# File 'lib/stripe/resources/login_link.rb', line 16

def object
  @object
end

#urlObject (readonly)

The URL for the login link.



18
19
20
# File 'lib/stripe/resources/login_link.rb', line 18

def url
  @url
end

Class Method Details

.field_remappingsObject



31
32
33
# File 'lib/stripe/resources/login_link.rb', line 31

def self.field_remappings
  @field_remappings = {}
end

.inner_class_typesObject



27
28
29
# File 'lib/stripe/resources/login_link.rb', line 27

def self.inner_class_types
  @inner_class_types = {}
end

.object_nameObject



9
10
11
# File 'lib/stripe/resources/login_link.rb', line 9

def self.object_name
  "login_link"
end

.retrieve(_id, _opts = nil) ⇒ Object

Raises:

  • (NotImplementedError)


20
21
22
23
24
25
# File 'lib/stripe/resources/login_link.rb', line 20

def self.retrieve(_id, _opts = nil)
  raise NotImplementedError,
        "Login links do not have IDs and cannot be retrieved. They can " \
        "only be created using `Account.create_login_link('account_id', " \
        "create_params)`"
end