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

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

Defined Under Namespace

Classes: ActivationURLPattern, ActivationURLRule, Step

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(argument: nil, directive: nil, operator: nil, variable: nil) ⇒ Object

Parameters:

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

    The value to compare against

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

    The directive for the URL pattern (‘allow’ or ‘block’)

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

    The comparison operator (‘contains’ or ‘equal_to’)

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

    The variable to evaluate (‘pathname’)



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/knockapi/models/users/guide_get_channel_response.rb', line 37

class Entry < Knockapi::Internal::Type::BaseModel
  # @!attribute id
  #   The unique identifier for the guide.
  #
  #   @return [String, nil]
  optional :id, String

  # @!attribute _typename
  #   The typename of the schema.
  #
  #   @return [String, nil]
  optional :_typename, String, api_name: :__typename

  # @!attribute activation_url_patterns
  #   A list of URL Patterns to evaluate user's current location to activate the
  #   guide, if matched
  #
  #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern>, nil]
  optional :activation_url_patterns,
           -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern] }

  # @!attribute activation_url_rules
  #   A list of URL rules to evaluate user's current location to activate the guide,
  #   if matched
  #
  #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule>, nil]
  optional :activation_url_rules,
           -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule] }

  # @!attribute active
  #   Whether the guide is active.
  #
  #   @return [Boolean, nil]
  optional :active, Knockapi::Internal::Type::Boolean

  # @!attribute bypass_global_group_limit
  #
  #   @return [Boolean, nil]
  optional :bypass_global_group_limit, Knockapi::Internal::Type::Boolean

  # @!attribute channel_id
  #
  #   @return [String, nil]
  optional :channel_id, String

  # @!attribute inserted_at
  #
  #   @return [Time, nil]
  optional :inserted_at, Time

  # @!attribute key
  #   The key of the guide.
  #
  #   @return [String, nil]
  optional :key, String

  # @!attribute semver
  #
  #   @return [String, nil]
  optional :semver, String

  # @!attribute steps
  #
  #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step>, nil]
  optional :steps,
           -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step] }

  # @!attribute type
  #   The type of the guide.
  #
  #   @return [String, nil]
  optional :type, String

  # @!attribute updated_at
  #
  #   @return [Time, nil]
  optional :updated_at, Time

  # @!method initialize(id: nil, _typename: nil, activation_url_patterns: nil, activation_url_rules: nil, active: nil, bypass_global_group_limit: nil, channel_id: nil, inserted_at: nil, key: nil, semver: nil, steps: nil, type: nil, updated_at: nil)
  #   Some parameter documentations has been truncated, see
  #   {Knockapi::Models::Users::GuideGetChannelResponse::Entry} for more details.
  #
  #   @param id [String] The unique identifier for the guide.
  #
  #   @param _typename [String] The typename of the schema.
  #
  #   @param activation_url_patterns [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern>] A list of URL Patterns to evaluate user's current location to activate the guide
  #
  #   @param activation_url_rules [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule>] A list of URL rules to evaluate user's current location to activate the guide, i
  #
  #   @param active [Boolean] Whether the guide is active.
  #
  #   @param bypass_global_group_limit [Boolean]
  #
  #   @param channel_id [String]
  #
  #   @param inserted_at [Time]
  #
  #   @param key [String] The key of the guide.
  #
  #   @param semver [String]
  #
  #   @param steps [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step>]
  #
  #   @param type [String] The type of the guide.
  #
  #   @param updated_at [Time]

  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

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

  class ActivationURLRule < Knockapi::Internal::Type::BaseModel
    # @!attribute argument
    #   The value to compare against
    #
    #   @return [String, nil]
    optional :argument, String

    # @!attribute directive
    #   The directive for the URL pattern ('allow' or 'block')
    #
    #   @return [String, nil]
    optional :directive, String

    # @!attribute operator
    #   The comparison operator ('contains' or 'equal_to')
    #
    #   @return [String, nil]
    optional :operator, String

    # @!attribute variable
    #   The variable to evaluate ('pathname')
    #
    #   @return [String, nil]
    optional :variable, String

    # @!method initialize(argument: nil, directive: nil, operator: nil, variable: nil)
    #   @param argument [String] The value to compare against
    #
    #   @param directive [String] The directive for the URL pattern ('allow' or 'block')
    #
    #   @param operator [String] The comparison operator ('contains' or 'equal_to')
    #
    #   @param variable [String] The variable to evaluate ('pathname')
  end

  class Step < Knockapi::Internal::Type::BaseModel
    # @!attribute content
    #
    #   @return [Hash{Symbol=>Object}, nil]
    optional :content, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]

    # @!attribute message
    #
    #   @return [Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message, nil]
    optional :message, -> { Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message }

    # @!attribute ref
    #
    #   @return [String, nil]
    optional :ref, String

    # @!attribute schema_key
    #
    #   @return [String, nil]
    optional :schema_key, String

    # @!attribute schema_semver
    #
    #   @return [String, nil]
    optional :schema_semver, String

    # @!attribute schema_variant_key
    #
    #   @return [String, nil]
    optional :schema_variant_key, String

    # @!method initialize(content: nil, message: nil, ref: nil, schema_key: nil, schema_semver: nil, schema_variant_key: nil)
    #   @param content [Hash{Symbol=>Object}]
    #   @param message [Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message]
    #   @param ref [String]
    #   @param schema_key [String]
    #   @param schema_semver [String]
    #   @param schema_variant_key [String]

    # @see Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step#message
    class Message < Knockapi::Internal::Type::BaseModel
      # @!attribute id
      #
      #   @return [String, nil]
      optional :id, String, nil?: true

      # @!attribute archived_at
      #
      #   @return [Time, nil]
      optional :archived_at, Time, nil?: true

      # @!attribute interacted_at
      #
      #   @return [Time, nil]
      optional :interacted_at, Time, nil?: true

      # @!attribute link_clicked_at
      #
      #   @return [Time, nil]
      optional :link_clicked_at, Time, nil?: true

      # @!attribute read_at
      #
      #   @return [Time, nil]
      optional :read_at, Time, nil?: true

      # @!attribute seen_at
      #
      #   @return [Time, nil]
      optional :seen_at, Time, nil?: true

      # @!method initialize(id: nil, archived_at: nil, interacted_at: nil, link_clicked_at: nil, read_at: nil, seen_at: nil)
      #   @param id [String, nil]
      #   @param archived_at [Time, nil]
      #   @param interacted_at [Time, nil]
      #   @param link_clicked_at [Time, nil]
      #   @param read_at [Time, nil]
      #   @param seen_at [Time, nil]
    end
  end
end

Instance Attribute Details

#_typename ⇒ String?

The typename of the schema.

Returns:

  • (String, nil) 


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

optional :_typename, String, api_name: :__typename

#activation_url_patterns ⇒ Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern>?

A list of URL Patterns to evaluate user’s current location to activate the guide, if matched

Returns:



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

optional :activation_url_patterns,
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern] }

#activation_url_rules ⇒ Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule>?

A list of URL rules to evaluate user’s current location to activate the guide, if matched

Returns:



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

optional :activation_url_rules,
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule] }

#active ⇒ Boolean?

Whether the guide is active.

Returns:

  • (Boolean, nil) 


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

optional :active, Knockapi::Internal::Type::Boolean

#bypass_global_group_limit ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

optional :bypass_global_group_limit, Knockapi::Internal::Type::Boolean

#channel_id ⇒ String?

Returns:

  • (String, nil) 


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

optional :channel_id, String

#id ⇒ String?

The unique identifier for the guide.

Returns:

  • (String, nil) 


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

optional :id, String

#inserted_at ⇒ Time?

Returns:

  • (Time, nil) 


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

optional :inserted_at, Time

#key ⇒ String?

The key of the guide.

Returns:

  • (String, nil) 


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

optional :key, String

#semver ⇒ String?

Returns:

  • (String, nil) 


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

optional :semver, String

#steps ⇒ Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step>?

Returns:



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

optional :steps,
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step] }

#type ⇒ String?

The type of the guide.

Returns:

  • (String, nil) 


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

optional :type, String

#updated_at ⇒ Time?

Returns:

  • (Time, nil) 


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

optional :updated_at, Time