Class: Moonbase::Models::FormCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/moonbase/models/form_create_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(name:, business_email_required: nil, pages_enabled: nil, redirect_url: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Moonbase::Models::FormCreateParams for more details.

Parameters:

  • name (String) —

    The name of the form, used as the title on its public page.

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

    If ‘true`, submissions require a business email address. Defaults to `false`.

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

    If ‘true`, enables a Moonbase Pages hosted page for this form, providing a stand

  • redirect_url (String) (defaults to: nil) —

    Optional URL the user is redirected to after a successful submission. Omit to le

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



# File 'lib/moonbase/models/form_create_params.rb', line 42

Instance Attribute Details

#business_email_required ⇒ Boolean?

If ‘true`, submissions require a business email address. Defaults to `false`.

Returns:

  • (Boolean, nil) 


20
 
# File 'lib/moonbase/models/form_create_params.rb', line 20

optional :business_email_required, Moonbase::Internal::Type::Boolean

#name ⇒ String

The name of the form, used as the title on its public page.

Returns:

  • (String) 


14
 
# File 'lib/moonbase/models/form_create_params.rb', line 14

required :name, String

#pages_enabled ⇒ Boolean?

If ‘true`, enables a Moonbase Pages hosted page for this form, providing a standalone public URL for sharing. Defaults to `false`.

Returns:

  • (Boolean, nil) 


27
 
# File 'lib/moonbase/models/form_create_params.rb', line 27

optional :pages_enabled, Moonbase::Internal::Type::Boolean

#redirect_url ⇒ String?

Optional URL the user is redirected to after a successful submission. Omit to leave submissions without a redirect. Stored as a Liquid template; rendered at submission time with form field values under ‘submission.<key>` (keyed by the field’s ‘key`) plus UTM params (`utm_source`, `utm_medium`, `utm_campaign`, `utm_term`, `utm_content`) automatically appended. Use the `uri_encode` filter for URL-safe values, e.g. `example.com/thanks?email=submission.email | uri_encode }`. The rendered URL must parse as a valid URL or the submission errors.

Returns:

  • (String, nil) 


40
 
# File 'lib/moonbase/models/form_create_params.rb', line 40

optional :redirect_url, String