Class: Stripe::Capability::FutureRequirements

Inherits:
StripeObject
  • Object
show all
Defined in:
lib/stripe/resources/capability.rb

Defined Under Namespace

Classes: Alternative, Error

Constant Summary

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

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

#alternatives ⇒ Object (readonly)

Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same ‘original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields.



49
50
51
 
# File 'lib/stripe/resources/capability.rb', line 49

def alternatives
  @alternatives
end

#current_deadline ⇒ Object (readonly)

Date on which ‘future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability’s enablement state prior to transitioning.



51
52
53
 
# File 'lib/stripe/resources/capability.rb', line 51

def current_deadline
  @current_deadline
end

#currently_due ⇒ Object (readonly)

Fields that need to be resolved to keep the capability enabled. If not resolved by ‘future_requirements`, these fields will transition to the main `requirements` hash.



53
54
55
 
# File 'lib/stripe/resources/capability.rb', line 53

def currently_due
  @currently_due
end

#disabled_reason ⇒ Object (readonly)

This is typed as an enum for consistency with ‘requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.



55
56
57
 
# File 'lib/stripe/resources/capability.rb', line 55

def disabled_reason
  @disabled_reason
end

#errors ⇒ Object (readonly)

Details about validation and verification failures for ‘due` requirements that must be resolved.



57
58
59
 
# File 'lib/stripe/resources/capability.rb', line 57

def errors
  @errors
end

#eventually_due ⇒ Object (readonly)

Fields you must collect when all thresholds are reached. As they become required, they appear in ‘currently_due` as well.



59
60
61
 
# File 'lib/stripe/resources/capability.rb', line 59

def eventually_due
  @eventually_due
end

#past_due ⇒ Object (readonly)

Fields that haven’t been resolved by ‘requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`.



61
62
63
 
# File 'lib/stripe/resources/capability.rb', line 61

def past_due
  @past_due
end

#pending_verification ⇒ Object (readonly)

Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to ‘eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.



63
64
65
 
# File 'lib/stripe/resources/capability.rb', line 63

def pending_verification
  @pending_verification
end

Class Method Details

.field_remappings ⇒ Object 



69
70
71
 
# File 'lib/stripe/resources/capability.rb', line 69

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



65
66
67
 
# File 'lib/stripe/resources/capability.rb', line 65

def self.inner_class_types
  @inner_class_types = { alternatives: Alternative, errors: Error }
end