Class: Stripe::PaymentLinkService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/payment_link_service.rb

Defined Under Namespace

Classes: CreateParams, ListParams, RetrieveParams, UpdateParams

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from StripeService

#request, #request_stream

Constructor Details

#initialize(requestor) ⇒ PaymentLinkService

Returns a new instance of PaymentLinkService.



8
9
10
11
 
# File 'lib/stripe/services/payment_link_service.rb', line 8

def initialize(requestor)
  super(requestor)
  @line_items = Stripe::PaymentLinkLineItemService.new(@requestor)
end

Instance Attribute Details

#line_items ⇒ Object (readonly)

Returns the value of attribute line_items.



6
7
8
 
# File 'lib/stripe/services/payment_link_service.rb', line 6

def line_items
  @line_items
end

Instance Method Details

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

Creates a payment link.



1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File 'lib/stripe/services/payment_link_service.rb', line 1357

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/payment_links",
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Returns a list of your payment links.



1368
1369
1370
1371
1372
1373
1374
1375
1376
 
# File 'lib/stripe/services/payment_link_service.rb', line 1368

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

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

Retrieve a payment link.



1379
1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'lib/stripe/services/payment_link_service.rb', line 1379

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

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

Updates a payment link.



1390
1391
1392
1393
1394
1395
1396
1397
1398
 
# File 'lib/stripe/services/payment_link_service.rb', line 1390

def update(payment_link, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/payment_links/%<payment_link>s", { payment_link: CGI.escape(payment_link) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end