Class: Dodopayments::Resources::Customers::CustomerPortal

Inherits:
Object
  • Object
show all
Defined in:
lib/dodopayments/resources/customers/customer_portal.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CustomerPortal

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CustomerPortal.

Parameters:



38
39
40
 
# File 'lib/dodopayments/resources/customers/customer_portal.rb', line 38

def initialize(client:)
  @client = client
end

Instance Method Details

#create(customer_id, return_url: nil, send_email: nil, request_options: {}) ⇒ Dodopayments::Models::CustomerPortalSession

Some parameter documentations has been truncated, see Models::Customers::CustomerPortalCreateParams for more details.

Parameters:

  • customer_id (String) —

    Customer Id

  • return_url (String) —

    Optional return URL for this session. Overrides the business-level default.

  • send_email (Boolean) —

    If true, will send link to user.

  • request_options (Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/dodopayments/resources/customers/customer_portal.rb', line 23

def create(customer_id, params = {})
  parsed, options = Dodopayments::Customers::CustomerPortalCreateParams.dump_request(params)
  query = Dodopayments::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :post,
    path: ["customers/%1$s/customer-portal/session", customer_id],
    query: query,
    model: Dodopayments::CustomerPortalSession,
    options: options
  )
end