Class: Stripe::V2::Billing::CollectionSettingService

Inherits:
StripeService
  • Object
show all
Defined in:
lib/stripe/services/v2/billing/collection_setting_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from StripeService

#request, #request_stream

Constructor Details

#initialize(requestor) ⇒ CollectionSettingService

Returns a new instance of CollectionSettingService.



10
11
12
13
 
# File 'lib/stripe/services/v2/billing/collection_setting_service.rb', line 10

def initialize(requestor)
  super
  @versions = Stripe::V2::Billing::CollectionSettings::VersionService.new(@requestor)
end

Instance Attribute Details

#versions ⇒ Object (readonly)

Returns the value of attribute versions.



8
9
10
 
# File 'lib/stripe/services/v2/billing/collection_setting_service.rb', line 8

def versions
  @versions
end

Instance Method Details

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

Create a CollectionSetting object.



16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/stripe/services/v2/billing/collection_setting_service.rb', line 16

def create(params = {}, opts = {})
  unless params.is_a?(Stripe::RequestParams)
    params = ::Stripe::V2::Billing::CollectionSettingCreateParams.coerce_params(params)
  end

  request(
    method: :post,
    path: "/v2/billing/collection_settings",
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

List all CollectionSetting objects.



31
32
33
34
35
36
37
38
39
 
# File 'lib/stripe/services/v2/billing/collection_setting_service.rb', line 31

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v2/billing/collection_settings",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(id, params = {}, opts = {}) ⇒ Object

Retrieve a CollectionSetting by ID.



42
43
44
45
46
47
48
49
50
 
# File 'lib/stripe/services/v2/billing/collection_setting_service.rb', line 42

def retrieve(id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v2/billing/collection_settings/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(id, params = {}, opts = {}) ⇒ Object

Update fields on an existing CollectionSetting.



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/stripe/services/v2/billing/collection_setting_service.rb', line 53

def update(id, params = {}, opts = {})
  unless params.is_a?(Stripe::RequestParams)
    params = ::Stripe::V2::Billing::CollectionSettingUpdateParams.coerce_params(params)
  end

  request(
    method: :post,
    path: format("/v2/billing/collection_settings/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end