Class: HubSpotSDK::Models::Scheduler::ExternalMeetingsLinkSettings

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• HubSpotSDK::Models::Scheduler::ExternalMeetingsLinkSettings

Defined in:

lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb

Defined Under Namespace

Modules: StartTimeIncrementMinutes

Instance Attribute Summary

• #availability ⇒ Hash{Symbol=>HubSpotSDK::Models::Scheduler::ExternalClosedRange}

  An array containing the closed range availability for a meeting link.

• #custom_availability_end_date ⇒ Integer^?

  The end date for a meeting link’s custom availability window, represented as Unix time in milliseconds.

• #custom_availability_start_date ⇒ Integer^?

  The start date for a meeting link’s custom availability window, represented as Unix time in milliseconds.

• #display_info ⇒ HubSpotSDK::Models::Scheduler::ExternalLinkDisplayInfo^?
• #durations ⇒ Array<Integer>
• #form_fields ⇒ Array<HubSpotSDK::Models::Scheduler::ExternalLinkFormField>
• #guest_settings ⇒ HubSpotSDK::Models::Scheduler::ExternalGuestSettings^?
• #language ⇒ String^?

  The language setting used for the meeting link.

• #legal_consent_enabled ⇒ Boolean

  Whether the legal consent checkbox is displayed during meeting booking.

• #legal_consent_options ⇒ HubSpotSDK::Models::Scheduler::ExternalLegalConsentOptions^?
• #locale ⇒ String^?

  The locale setting used for formatting dates and times in the meeting link.

• #location ⇒ String^?

  The physical or virtual location where the meeting will take place.

• #meeting_buffer_time ⇒ Integer

  The minimum buffer time in milliseconds between consecutive meetings.

• #owner_prioritized ⇒ Boolean

  Indicates whether the meeting owner is prioritized during booking.

• #redirect_url ⇒ String^?

  The URL to redirect to after a meeting is booked.

• #start_time_increment_minutes ⇒ Symbol, HubSpotSDK::Models::Scheduler::ExternalMeetingsLinkSettings::StartTimeIncrementMinutes

  The increment for available start times of meetings, spelt out as a word (e.g. 15 minute increment corresponds to ‘FIFTEEN`).

• #weeks_to_advertise ⇒ Integer

  Legacy property that indicates the number of weeks in advance that availability is advertised.

• #welcome_screen_info ⇒ HubSpotSDK::Models::Scheduler::ExternalMeetingsWelcomeScreenInfo^?

Instance Method Summary

• #initialize(availability:, durations:, form_fields:, legal_consent_enabled:, meeting_buffer_time:, owner_prioritized:, start_time_increment_minutes:, weeks_to_advertise:, custom_availability_end_date: nil, custom_availability_start_date: nil, display_info: nil, guest_settings: nil, language: nil, legal_consent_options: nil, locale: nil, location: nil, redirect_url: nil, welcome_screen_info: nil) ⇒ Object constructor

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

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(availability:, durations:, form_fields:, legal_consent_enabled:, meeting_buffer_time:, owner_prioritized:, start_time_increment_minutes:, weeks_to_advertise:, custom_availability_end_date: nil, custom_availability_start_date: nil, display_info: nil, guest_settings: nil, language: nil, legal_consent_options: nil, locale: nil, location: nil, redirect_url: nil, welcome_screen_info: nil) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::Scheduler::ExternalMeetingsLinkSettings for more details.

Parameters:

• availability (Hash{Symbol=>HubSpotSDK::Models::Scheduler::ExternalClosedRange}) —

  An array containing the closed range availability for a meeting link. Closed ran

• durations (Array<Integer>)
• form_fields (Array<HubSpotSDK::Models::Scheduler::ExternalLinkFormField>)
• legal_consent_enabled (Boolean) —

  Whether the legal consent checkbox is displayed during meeting booking.

• meeting_buffer_time (Integer) —

  The minimum buffer time in milliseconds between consecutive meetings.

• owner_prioritized (Boolean) —

  Indicates whether the meeting owner is prioritized during booking. Only applies

• start_time_increment_minutes (Symbol, HubSpotSDK::Models::Scheduler::ExternalMeetingsLinkSettings::StartTimeIncrementMinutes) —

  The increment for available start times of meetings, spelt out as a word (e.g. 1

• weeks_to_advertise (Integer) —

  Legacy property that indicates the number of weeks in advance that availability

• custom_availability_end_date (Integer) (defaults to: nil) —

  The end date for a meeting link’s custom availability window, represented as Uni

• custom_availability_start_date (Integer) (defaults to: nil) —

  The start date for a meeting link’s custom availability window, represented as U

• display_info (HubSpotSDK::Models::Scheduler::ExternalLinkDisplayInfo) (defaults to: nil)
• guest_settings (HubSpotSDK::Models::Scheduler::ExternalGuestSettings) (defaults to: nil)
• language (String) (defaults to: nil) —

  The language setting used for the meeting link.

• legal_consent_options (HubSpotSDK::Models::Scheduler::ExternalLegalConsentOptions) (defaults to: nil)
• locale (String) (defaults to: nil) —

  The locale setting used for formatting dates and times in the meeting link.

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

  The physical or virtual location where the meeting will take place.

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

  The URL to redirect to after a meeting is booked.

• welcome_screen_info (HubSpotSDK::Models::Scheduler::ExternalMeetingsWelcomeScreenInfo) (defaults to: nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 130

Instance Attribute Details

#availability ⇒ Hash{Symbol=>HubSpotSDK::Models::Scheduler::ExternalClosedRange}

An array containing the closed range availability for a meeting link. Closed range times are provided as minute offsets from midnight (e.g., 540 corresponds to 9am).

Returns:

• (Hash{Symbol=>HubSpotSDK::Models::Scheduler::ExternalClosedRange})

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 13

required :availability,
-> { HubSpotSDK::Internal::Type::HashOf[HubSpotSDK::Scheduler::ExternalClosedRange] }

#custom_availability_end_date ⇒ Integer^?

The end date for a meeting link’s custom availability window, represented as Unix time in milliseconds.

Returns:

• (Integer, nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 69

optional :custom_availability_end_date, Integer, api_name: :customAvailabilityEndDate

#custom_availability_start_date ⇒ Integer^?

The start date for a meeting link’s custom availability window, represented as Unix time in milliseconds.

Returns:

• (Integer, nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 76

optional :custom_availability_start_date, Integer, api_name: :customAvailabilityStartDate

#display_info ⇒ HubSpotSDK::Models::Scheduler::ExternalLinkDisplayInfo^?

Returns:

• (HubSpotSDK::Models::Scheduler::ExternalLinkDisplayInfo, nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 81

optional :display_info, -> { HubSpotSDK::Scheduler::ExternalLinkDisplayInfo }, api_name: :displayInfo

#durations ⇒ Array<Integer>

Returns:

• (Array<Integer>)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 19

required :durations, HubSpotSDK::Internal::Type::ArrayOf[Integer]

#form_fields ⇒ Array<HubSpotSDK::Models::Scheduler::ExternalLinkFormField>

Returns:

• (Array<HubSpotSDK::Models::Scheduler::ExternalLinkFormField>)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 24

required :form_fields,
-> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::Scheduler::ExternalLinkFormField] },
api_name: :formFields

#guest_settings ⇒ HubSpotSDK::Models::Scheduler::ExternalGuestSettings^?

Returns:

• (HubSpotSDK::Models::Scheduler::ExternalGuestSettings, nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 86

optional :guest_settings,
-> {
  HubSpotSDK::Scheduler::ExternalGuestSettings
},
api_name: :guestSettings

#language ⇒ String^?

The language setting used for the meeting link.

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 96

optional :language, String

#legal_consent_enabled ⇒ Boolean

Whether the legal consent checkbox is displayed during meeting booking.

Returns:

• (Boolean)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 32

required :legal_consent_enabled, HubSpotSDK::Internal::Type::Boolean, api_name: :legalConsentEnabled

#legal_consent_options ⇒ HubSpotSDK::Models::Scheduler::ExternalLegalConsentOptions^?

Returns:

• (HubSpotSDK::Models::Scheduler::ExternalLegalConsentOptions, nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 101

optional :legal_consent_options,
-> { HubSpotSDK::Scheduler::ExternalLegalConsentOptions },
api_name: :legalConsentOptions

#locale ⇒ String^?

The locale setting used for formatting dates and times in the meeting link.

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 109

optional :locale, String

#location ⇒ String^?

The physical or virtual location where the meeting will take place.

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 115

optional :location, String

#meeting_buffer_time ⇒ Integer

The minimum buffer time in milliseconds between consecutive meetings.

Returns:

• (Integer)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 38

required :meeting_buffer_time, Integer, api_name: :meetingBufferTime

#owner_prioritized ⇒ Boolean

Indicates whether the meeting owner is prioritized during booking. Only applies to link types of ROUND_ROBIN.

Returns:

• (Boolean)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 45

required :owner_prioritized, HubSpotSDK::Internal::Type::Boolean, api_name: :ownerPrioritized

#redirect_url ⇒ String^?

The URL to redirect to after a meeting is booked.

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 121

optional :redirect_url, String, api_name: :redirectUrl

#start_time_increment_minutes ⇒ Symbol, HubSpotSDK::Models::Scheduler::ExternalMeetingsLinkSettings::StartTimeIncrementMinutes

The increment for available start times of meetings, spelt out as a word (e.g. 15 minute increment corresponds to ‘FIFTEEN`). `MEETING_DURATION` is also a valid value.

Returns:

• (Symbol, HubSpotSDK::Models::Scheduler::ExternalMeetingsLinkSettings::StartTimeIncrementMinutes)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 53

required :start_time_increment_minutes,
enum: -> { HubSpotSDK::Scheduler::ExternalMeetingsLinkSettings::StartTimeIncrementMinutes },
api_name: :startTimeIncrementMinutes

#weeks_to_advertise ⇒ Integer

Legacy property that indicates the number of weeks in advance that availability is advertised. May be outdated or superseded by other properties.

Returns:

• (Integer)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 62

required :weeks_to_advertise, Integer, api_name: :weeksToAdvertise

#welcome_screen_info ⇒ HubSpotSDK::Models::Scheduler::ExternalMeetingsWelcomeScreenInfo^?

Returns:

• (HubSpotSDK::Models::Scheduler::ExternalMeetingsWelcomeScreenInfo, nil)

# File 'lib/hubspot_sdk/models/scheduler/external_meetings_link_settings.rb', line 126

optional :welcome_screen_info,
-> { HubSpotSDK::Scheduler::ExternalMeetingsWelcomeScreenInfo },
api_name: :welcomeScreenInfo