Class: Stripe::Capability

Inherits:
APIResource show all
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/capability.rb

Overview

This is an object representing a capability for a Stripe account.

Related guide: [Account capabilities](docs.stripe.com/connect/account-capabilities)

Defined Under Namespace

Classes: FutureRequirements, Protections, Requirements

Constant Summary collapse

OBJECT_NAME = 
"capability"

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::Save

included, #save

Methods inherited from APIResource

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

#account ⇒ Object (readonly)

The account for which the capability enables functionality.



161
162
163
 
# File 'lib/stripe/resources/capability.rb', line 161

def 
  @account
end

#future_requirements ⇒ Object (readonly)

Attribute for field future_requirements



163
164
165
 
# File 'lib/stripe/resources/capability.rb', line 163

def future_requirements
  @future_requirements
end

#id ⇒ Object (readonly)

The identifier for the capability.



165
166
167
 
# File 'lib/stripe/resources/capability.rb', line 165

def id
  @id
end

#object ⇒ Object (readonly)

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



167
168
169
 
# File 'lib/stripe/resources/capability.rb', line 167

def object
  @object
end

#protections ⇒ Object (readonly)

Attribute for field protections



169
170
171
 
# File 'lib/stripe/resources/capability.rb', line 169

def protections
  @protections
end

#requested ⇒ Object (readonly)

Whether the capability has been requested.



171
172
173
 
# File 'lib/stripe/resources/capability.rb', line 171

def requested
  @requested
end

#requested_at ⇒ Object (readonly)

Time at which the capability was requested. Measured in seconds since the Unix epoch.



173
174
175
 
# File 'lib/stripe/resources/capability.rb', line 173

def requested_at
  @requested_at
end

#requirements ⇒ Object (readonly)

Attribute for field requirements



175
176
177
 
# File 'lib/stripe/resources/capability.rb', line 175

def requirements
  @requirements
end

#status ⇒ Object (readonly)

The status of the capability.



177
178
179
 
# File 'lib/stripe/resources/capability.rb', line 177

def status
  @status
end

Class Method Details

.field_remappings ⇒ Object 



210
211
212
 
# File 'lib/stripe/resources/capability.rb', line 210

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



202
203
204
205
206
207
208
 
# File 'lib/stripe/resources/capability.rb', line 202

def self.inner_class_types
  @inner_class_types = {
    future_requirements: FutureRequirements,
    protections: Protections,
    requirements: Requirements,
  }
end

.object_name ⇒ Object 



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

def self.object_name
  "capability"
end

.retrieve(_id, _opts = {}) ⇒ Object

Raises:

  • (NotImplementedError) 


188
189
190
191
192
193
 
# File 'lib/stripe/resources/capability.rb', line 188

def self.retrieve(_id, _opts = {})
  raise NotImplementedError,
        "Capabilities cannot be retrieve without an account ID. " \
        "Retrieve a capability using Account.retrieve_capability(" \
        "'account_id', 'capability_id')`"
end

.update(_id, _params = nil, _opts = nil) ⇒ Object

Raises:

  • (NotImplementedError) 


195
196
197
198
199
200
 
# File 'lib/stripe/resources/capability.rb', line 195

def self.update(_id, _params = nil, _opts = nil)
  raise NotImplementedError,
        "Capabilities cannot be updated without an account ID. Update a " \
        "capability using `Account.update_capability('account_id', " \
        "'capability_id', update_params)`"
end

Instance Method Details

#resource_url ⇒ Object 



179
180
181
182
183
184
185
186
 
# File 'lib/stripe/resources/capability.rb', line 179

def resource_url
  if !respond_to?(:account) || .nil?
    raise NotImplementedError,
          "Capabilities cannot be accessed without an account ID."
  end
  "#{Account.resource_url}/#{CGI.escape()}/capabilities" \
    "/#{CGI.escape(id)}"
end