Class: Stripe::Capital::FinancingOffer

Inherits:
APIResource show all
Extended by:
APIOperations::List
Defined in:
lib/stripe/resources/capital/financing_offer.rb

Overview

This is an object representing an offer of financing from Stripe Capital to a Connect subaccount.

Constant Summary collapse

OBJECT_NAME = 
"capital.financing_offer"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

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

list

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

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

Class Method Details

.list(filters = {}, opts = {}) ⇒ Object

Retrieves the financing offers available for Connected accounts that belong to your platform.



17
18
19
20
21
22
23
24
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 17

def self.list(filters = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/capital/financing_offers",
    params: filters,
    opts: opts
  )
end

.mark_delivered(financing_offer, params = {}, opts = {}) ⇒ Object

Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.



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

def self.mark_delivered(financing_offer, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



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

def self.object_name
  "capital.financing_offer"
end

Instance Method Details

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

Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.



28
29
30
31
32
33
34
35
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 28

def mark_delivered(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end