README.md

Link

(link)

Overview

Available Operations

• create_payment_link - Create a link
• get_payment_link - Retrieve a link
• list_payment_links - List all links
• patch_payment_link - Update a link
• remove_payment_link - Remove a link
• update_payment_link - Update a link

create_payment_link

Create a link

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.link.create_payment_link(connection_id="<id>", payment_link=::UnifiedRubySDK::Shared::PaymentLink.new(), fields_=[
  "<value>",
])

if ! res.payment_link.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
payment_link	T.nilable(::UnifiedRubySDK::Shared::PaymentLink)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreatePaymentLinkResponse)

get_payment_link

Retrieve a link

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.link.get_payment_link(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.payment_link.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Link
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetPaymentLinkResponse)

list_payment_links

List all links

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListPaymentLinksRequest.new(
  connection_id: "<id>",
)
    
res = s.link.list_payment_links(req)

if ! res.payment_links.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListPaymentLinksRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListPaymentLinksResponse)

patch_payment_link

Update a link

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.link.patch_payment_link(connection_id="<id>", id="<id>", payment_link=::UnifiedRubySDK::Shared::PaymentLink.new(), fields_=[
  "<value>",
])

if ! res.payment_link.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Link
payment_link	T.nilable(::UnifiedRubySDK::Shared::PaymentLink)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchPaymentLinkResponse)

remove_payment_link

Remove a link

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.link.remove_payment_link(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Link

Response

T.nilable(::UnifiedRubySDK::Operations::RemovePaymentLinkResponse)

update_payment_link

Update a link

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.link.update_payment_link(connection_id="<id>", id="<id>", payment_link=::UnifiedRubySDK::Shared::PaymentLink.new(), fields_=[
  "<value>",
])

if ! res.payment_link.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Link
payment_link	T.nilable(::UnifiedRubySDK::Shared::PaymentLink)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdatePaymentLinkResponse)