Class: Dodopayments::Models::Customers::CustomerPortalCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::Customers::CustomerPortalCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/customers/customer_portal_create_params.rb

Overview

See Also:

• Resources::Customers::CustomerPortal#create

Instance Attribute Summary

• #customer_id ⇒ String
• #return_url ⇒ String^?

  Optional return URL for this session.

• #send_email ⇒ Boolean^?

  If true, will send link to user.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(customer_id:, return_url: nil, send_email: nil, request_options: {}) ⇒ Object constructor

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

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(customer_id:, return_url: nil, send_email: nil, request_options: {}) ⇒ Object

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

Parameters:

• customer_id (String)
• return_url (String) (defaults to: nil) —

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

• send_email (Boolean) (defaults to: nil) —

  If true, will send link to user.

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

# File 'lib/dodopayments/models/customers/customer_portal_create_params.rb', line 29

Instance Attribute Details

#customer_id ⇒ String

Returns:

• (String)

# File 'lib/dodopayments/models/customers/customer_portal_create_params.rb', line 14

required :customer_id, String

#return_url ⇒ String^?

Optional return URL for this session. Overrides the business-level default. This URL will be shown as a “Return to business” back button in the portal.

Returns:

• (String, nil)

# File 'lib/dodopayments/models/customers/customer_portal_create_params.rb', line 21

optional :return_url, String

#send_email ⇒ Boolean^?

If true, will send link to user.

Returns:

• (Boolean, nil)

# File 'lib/dodopayments/models/customers/customer_portal_create_params.rb', line 27

optional :send_email, Dodopayments::Internal::Type::Boolean