Class: Stripe::APIResource

Inherits:
StripeObject show all
Includes:
Stripe::APIOperations::Request
Defined in:
lib/stripe/api_resource.rb

Direct Known Subclasses

Account, AccountLink, AccountNotice, AccountSession, AlipayAccount, ApplePayDomain, ApplicationFee, ApplicationFeeRefund, Stripe::Apps::Secret, BalanceTransaction, BankAccount, Billing::Alert, Billing::Meter, Billing::MeterEvent, Billing::MeterEventAdjustment, Billing::MeterEventSummary, BillingPortal::Configuration, BillingPortal::Session, Capability, Capital::FinancingOffer, Capital::FinancingTransaction, Card, CashBalance, Charge, Checkout::Session, Climate::Order, Climate::Product, Climate::Supplier, ConfirmationToken, CountrySpec, Coupon, CreditNote, Customer, CustomerBalanceTransaction, CustomerCashBalanceTransaction, CustomerSession, Dispute, Entitlements::ActiveEntitlement, Entitlements::Feature, EphemeralKey, Event, ExchangeRate, File, FileLink, FinancialConnections::Account, FinancialConnections::AccountInferredBalance, FinancialConnections::Institution, FinancialConnections::Session, FinancialConnections::Transaction, Forwarding::Request, FundingInstructions, GiftCards::Card, GiftCards::Transaction, Identity::VerificationReport, Identity::VerificationSession, Invoice, InvoiceItem, InvoicePayment, Issuing::Authorization, Issuing::Card, Issuing::Cardholder, Issuing::CreditUnderwritingRecord, Issuing::Dispute, Issuing::PersonalizationDesign, Issuing::PhysicalBundle, Issuing::Token, Issuing::Transaction, LineItem, LoginLink, Mandate, Margin, Order, PaymentIntent, PaymentLink, PaymentMethod, PaymentMethodConfiguration, PaymentMethodDomain, Payout, Person, Plan, Price, Product, ProductFeature, PromotionCode, Quote, QuotePhase, QuotePreviewInvoice, QuotePreviewSubscriptionSchedule, Radar::EarlyFraudWarning, Radar::ValueList, Radar::ValueListItem, Refund, Reporting::ReportRun, Reporting::ReportType, Reversal, Review, SetupAttempt, SetupIntent, ShippingRate, Sigma::ScheduledQueryRun, SingletonAPIResource, Source, Subscription, SubscriptionItem, SubscriptionSchedule, Tax::Association, Tax::Calculation, Tax::CalculationLineItem, Tax::Form, Tax::Registration, Tax::Transaction, Tax::TransactionLineItem, TaxCode, TaxId, TaxRate, Terminal::Configuration, Terminal::ConnectionToken, Terminal::Location, Terminal::Reader, TestHelpers::TestClock, Token, Topup, Transfer, Treasury::CreditReversal, Treasury::DebitReversal, Treasury::FinancialAccount, Treasury::FinancialAccountFeatures, Treasury::InboundTransfer, Treasury::OutboundPayment, Treasury::OutboundTransfer, Treasury::ReceivedCredit, Treasury::ReceivedDebit, Treasury::Transaction, Treasury::TransactionEntry, UsageRecord, WebhookEndpoint

Constant Summary collapse

OBJECT_NAME =

TODO: (major) Remove OBJECT_NAME and stop using const_get here This is a workaround to avoid breaking users who have defined their own APIResource subclasses with a custom OBJECT_NAME. We should never fallback on this case otherwise.

""

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Stripe::APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, 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

#save_with_parent ⇒ Object

A flag that can be set a behavior that will cause this resource to be encoded and sent up along with an update of its parent resource. This is usually not desirable because resources are updated individually on their own endpoints, but there are certain cases, replacing a customer’s source for example, where this is allowed.



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

def save_with_parent
  @save_with_parent
end

Class Method Details

.class_name ⇒ Object 



23
24
25
 
# File 'lib/stripe/api_resource.rb', line 23

def self.class_name
  name.split("::")[-1]
end

.custom_method(name, http_verb:, http_path: nil) ⇒ Object

Adds a custom method to a resource class. This is used to add support for non-CRUDL API requests, e.g. capturing charges. custom_method takes the following parameters:

  • name: the name of the custom method to create (as a symbol)

  • http_verb: the HTTP verb for the API request (:get, :post, or :delete)

  • http_path: the path to append to the resource’s URL. If not provided,

    the name is used as the path

For example, this call:

custom_method :capture, http_verb: post

adds a ‘capture` class method to the resource class that, when called, will send a POST request to `/v1/<object_name>/capture`.



74
75
76
 
# File 'lib/stripe/api_resource.rb', line 74

def self.custom_method(name, http_verb:, http_path: nil)
  Util.custom_method self, self, name, http_verb, http_path
end

.object_name ⇒ Object 



19
20
21
 
# File 'lib/stripe/api_resource.rb', line 19

def self.object_name
  const_get(:OBJECT_NAME)
end

.resource_url ⇒ Object 



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/stripe/api_resource.rb', line 27

def self.resource_url
  if self == APIResource
    raise NotImplementedError,
          "APIResource is an abstract class. You should perform actions " \
          "on its subclasses (Charge, Customer, etc.)"
  end
  # Namespaces are separated in object names with periods (.) and in URLs
  # with forward slashes (/), so replace the former with the latter.
  "/v1/#{object_name.downcase.tr('.', '/')}s"
end

.retrieve(id, opts = {}) ⇒ Object 



95
96
97
98
99
100
 
# File 'lib/stripe/api_resource.rb', line 95

def self.retrieve(id, opts = {})
  opts = Util.normalize_opts(opts)
  instance = new(id, opts)
  instance.refresh
  instance
end

.save_nested_resource(name) ⇒ Object

A metaprogramming call that specifies that a field of a resource can be its own type of API resource (say a nested card under an account for example), and if that resource is set, it should be transmitted to the API on a create or update. Doing so is not the default behavior because API resources should normally be persisted on their own RESTful endpoints.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/stripe/api_resource.rb', line 44

def self.save_nested_resource(name)
  define_method(:"#{name}=") do |value|
    super(value)

    # The parent setter will perform certain useful operations like
    # converting to an APIResource if appropriate. Refresh our argument
    # value to whatever it mutated to.
    value = send(name)

    # Note that the value may be subresource, but could also be a scalar
    # (like a tokenized card's ID for example), so we check the type before
    # setting #save_with_parent here.
    value.save_with_parent = true if value.is_a?(APIResource)

    value
  end
end

Instance Method Details

#refresh ⇒ Object 



89
90
91
92
93
 
# File 'lib/stripe/api_resource.rb', line 89

def refresh
  resp, opts = execute_resource_request(:get, resource_url,
                                        @retrieve_params)
  initialize_from(resp.data, opts, resp)
end

#request_stripe_object(method:, path:, params:, opts: {}) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/stripe/api_resource.rb', line 102

def request_stripe_object(method:, path:, params:, opts: {})
  resp, opts = execute_resource_request(method, path, params, opts)

  # If we're getting back this thing, update; otherwise, instantiate.
  if Util.object_name_matches_class?(resp.data[:object], self.class)
    initialize_from(resp.data, opts, resp)
  else
    Util.convert_to_stripe_object_with_params(resp.data, params, opts, resp)
  end
end

#resource_url ⇒ Object 



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/stripe/api_resource.rb', line 78

def resource_url
  unless (id = self["id"])
    raise InvalidRequestError.new(
      "Could not determine which URL to request: #{self.class} instance " \
      "has invalid ID: #{id.inspect}",
      "id"
    )
  end
  "#{self.class.resource_url}/#{CGI.escape(id)}"
end