Class: Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/users/guide_get_channel_response.rb,
sig/knockapi/models/users/guide_get_channel_response.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

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(id: nil, _typename: nil, activation_url_patterns: nil, activation_url_rules: nil, active: nil, bypass_global_group_limit: nil, channel_id: nil, dashboard_url: nil, inserted_at: nil, key: nil, semver: nil, steps: nil, type: nil, updated_at: nil) ⇒ Object

Some parameter documentations has been truncated, see Knockapi::Models::Users::GuideGetChannelResponse::Entry for more details.

Parameters:

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

    The unique identifier for the guide.

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

    The typename of the schema.

  • activation_url_patterns (Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern>) (defaults to: nil) —

    A list of URL Patterns to evaluate user's current location to activate the guide

  • activation_url_rules (Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule>) (defaults to: nil) —

    A list of URL rules to evaluate user's current location to activate the guide, i

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

    Whether the guide is active.

  • bypass_global_group_limit (Boolean) (defaults to: nil)
  • channel_id (String) (defaults to: nil)
  • dashboard_url (String) (defaults to: nil) —

    URL to this guide in the Knock dashboard

  • inserted_at (Time) (defaults to: nil)
  • key (String) (defaults to: nil) —

    The key of the guide.

  • semver (String) (defaults to: nil)
  • steps (Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step>) (defaults to: nil)
  • type (String) (defaults to: nil) —

    The type of the guide.

  • updated_at (Time) (defaults to: nil) 


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/knockapi/models/users/guide_get_channel_response.rb', line 162

class ActivationURLPattern < Knockapi::Internal::Type::BaseModel
  # @!attribute directive
  #   The directive for the URL pattern ('allow' or 'block')
  #
  #   @return [String, nil]
  optional :directive, String

  # @!attribute pathname
  #   The pathname pattern to match (supports wildcards like /\*)
  #
  #   @return [String, nil]
  optional :pathname, String

  # @!attribute search
  #   The search query params to match
  #
  #   @return [String, nil]
  optional :search, String

  # @!method initialize(directive: nil, pathname: nil, search: nil)
  #   @param directive [String] The directive for the URL pattern ('allow' or 'block')
  #
  #   @param pathname [String] The pathname pattern to match (supports wildcards like /\*)
  #
  #   @param search [String] The search query params to match
end

Instance Attribute Details

#directive ⇒ String?

The directive for the URL pattern ('allow' or 'block')

Parameters:

  • (String)

Returns:

  • (String, nil) 


167
 
# File 'lib/knockapi/models/users/guide_get_channel_response.rb', line 167

optional :directive, String

#pathname ⇒ String?

The pathname pattern to match (supports wildcards like /*)

Parameters:

  • (String)

Returns:

  • (String, nil) 


173
 
# File 'lib/knockapi/models/users/guide_get_channel_response.rb', line 173

optional :pathname, String

#search ⇒ String?

The search query params to match

Parameters:

  • (String)

Returns:

  • (String, nil) 


179
 
# File 'lib/knockapi/models/users/guide_get_channel_response.rb', line 179

optional :search, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


172
 
# File 'sig/knockapi/models/users/guide_get_channel_response.rbs', line 172

def to_hash: -> {