Class: Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/trycourier/models/automations/invoke_invoke_ad_hoc_params.rb

Defined Under Namespace

Modules: 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(automation: , brand: nil, data: nil, profile: nil, recipient: nil, template: nil, request_options: {}) ⇒ Object

Parameters:



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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/trycourier/models/automations/invoke_invoke_ad_hoc_params.rb', line 50

class Automation < Trycourier::Internal::Type::BaseModel
  # @!attribute steps
  #
  #   @return [Array<Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep>]
  required :steps,
           -> { Trycourier::Internal::Type::ArrayOf[union: Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step] }

  # @!attribute cancelation_token
  #
  #   @return [String, nil]
  optional :cancelation_token, String, nil?: true

  # @!method initialize(steps:, cancelation_token: nil)
  #   @param steps [Array<Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep>]
  #   @param cancelation_token [String, nil]

  module Step
    extend Trycourier::Internal::Type::Union

    variant -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep }

    variant -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep }

    variant -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep }

    variant -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep }

    variant -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep }

    variant -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep }

    variant -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep }

    class AutomationDelayStep < Trycourier::Internal::Type::BaseModel
      # @!attribute action
      #
      #   @return [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep::Action]
      required :action,
               enum: -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep::Action }

      # @!attribute duration
      #
      #   @return [String, nil]
      optional :duration, String, nil?: true

      # @!attribute until_
      #
      #   @return [String, nil]
      optional :until_, String, api_name: :until, nil?: true

      # @!method initialize(action:, duration: nil, until_: nil)
      #   @param action [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep::Action]
      #   @param duration [String, nil]
      #   @param until_ [String, nil]

      # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep#action
      module Action
        extend Trycourier::Internal::Type::Enum

        DELAY = :delay

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class AutomationSendStep < Trycourier::Internal::Type::BaseModel
      # @!attribute action
      #
      #   @return [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep::Action]
      required :action,
               enum: -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep::Action }

      # @!attribute brand
      #
      #   @return [String, nil]
      optional :brand, String, nil?: true

      # @!attribute data
      #
      #   @return [Hash{Symbol=>Object}, nil]
      optional :data,
               Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown],
               nil?: true

      # @!attribute profile
      #
      #   @return [Hash{Symbol=>Object}, nil]
      optional :profile,
               Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown],
               nil?: true

      # @!attribute recipient
      #
      #   @return [String, nil]
      optional :recipient, String, nil?: true

      # @!attribute template
      #
      #   @return [String, nil]
      optional :template, String, nil?: true

      # @!method initialize(action:, brand: nil, data: nil, profile: nil, recipient: nil, template: nil)
      #   @param action [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep::Action]
      #   @param brand [String, nil]
      #   @param data [Hash{Symbol=>Object}, nil]
      #   @param profile [Hash{Symbol=>Object}, nil]
      #   @param recipient [String, nil]
      #   @param template [String, nil]

      # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep#action
      module Action
        extend Trycourier::Internal::Type::Enum

        SEND = :send

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class AutomationSendListStep < Trycourier::Internal::Type::BaseModel
      # @!attribute action
      #
      #   @return [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep::Action]
      required :action,
               enum: -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep::Action }

      # @!attribute list
      #
      #   @return [String]
      required :list, String

      # @!attribute brand
      #
      #   @return [String, nil]
      optional :brand, String, nil?: true

      # @!attribute data
      #
      #   @return [Hash{Symbol=>Object}, nil]
      optional :data,
               Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown],
               nil?: true

      # @!method initialize(action:, list:, brand: nil, data: nil)
      #   @param action [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep::Action]
      #   @param list [String]
      #   @param brand [String, nil]
      #   @param data [Hash{Symbol=>Object}, nil]

      # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep#action
      module Action
        extend Trycourier::Internal::Type::Enum

        SEND_LIST = :"send-list"

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class AutomationUpdateProfileStep < Trycourier::Internal::Type::BaseModel
      # @!attribute action
      #
      #   @return [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::Action]
      required :action,
               enum: -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::Action }

      # @!attribute profile
      #
      #   @return [Hash{Symbol=>Object}]
      required :profile, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown]

      # @!attribute merge
      #
      #   @return [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::Merge, nil]
      optional :merge,
               enum: -> {
                 Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::Merge
               },
               nil?: true

      # @!attribute recipient_id
      #
      #   @return [String, nil]
      optional :recipient_id, String, nil?: true

      # @!method initialize(action:, profile:, merge: nil, recipient_id: nil)
      #   @param action [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::Action]
      #   @param profile [Hash{Symbol=>Object}]
      #   @param merge [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::Merge, nil]
      #   @param recipient_id [String, nil]

      # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep#action
      module Action
        extend Trycourier::Internal::Type::Enum

        UPDATE_PROFILE = :"update-profile"

        # @!method self.values
        #   @return [Array<Symbol>]
      end

      # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep#merge
      module Merge
        extend Trycourier::Internal::Type::Enum

        NONE = :none
        OVERWRITE = :overwrite
        SOFT_MERGE = :"soft-merge"
        REPLACE = :replace

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class AutomationCancelStep < Trycourier::Internal::Type::BaseModel
      # @!attribute action
      #
      #   @return [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep::Action]
      required :action,
               enum: -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep::Action }

      # @!attribute cancelation_token
      #
      #   @return [String]
      required :cancelation_token, String

      # @!method initialize(action:, cancelation_token:)
      #   @param action [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep::Action]
      #   @param cancelation_token [String]

      # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep#action
      module Action
        extend Trycourier::Internal::Type::Enum

        CANCEL = :cancel

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class AutomationFetchDataStep < Trycourier::Internal::Type::BaseModel
      # @!attribute action
      #
      #   @return [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Action]
      required :action,
               enum: -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Action }

      # @!attribute webhook
      #
      #   @return [Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook]
      required :webhook,
               -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook }

      # @!attribute merge_strategy
      #
      #   @return [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::MergeStrategy, nil]
      optional :merge_strategy,
               enum: -> {
                 Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::MergeStrategy
               },
               nil?: true

      # @!method initialize(action:, webhook:, merge_strategy: nil)
      #   @param action [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Action]
      #   @param webhook [Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook]
      #   @param merge_strategy [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::MergeStrategy, nil]

      # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep#action
      module Action
        extend Trycourier::Internal::Type::Enum

        FETCH_DATA = :"fetch-data"

        # @!method self.values
        #   @return [Array<Symbol>]
      end

      # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep#webhook
      class Webhook < Trycourier::Internal::Type::BaseModel
        # @!attribute method_
        #
        #   @return [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook::Method]
        required :method_,
                 enum: -> {
                   Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook::Method
                 },
                 api_name: :method

        # @!attribute url
        #
        #   @return [String]
        required :url, String

        # @!attribute body
        #
        #   @return [String, nil]
        optional :body, String, nil?: true

        # @!attribute headers
        #
        #   @return [Hash{Symbol=>String}, nil]
        optional :headers, Trycourier::Internal::Type::HashOf[String], nil?: true

        # @!method initialize(method_:, url:, body: nil, headers: nil)
        #   @param method_ [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook::Method]
        #   @param url [String]
        #   @param body [String, nil]
        #   @param headers [Hash{Symbol=>String}, nil]

        # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook#method_
        module Method
          extend Trycourier::Internal::Type::Enum

          GET = :GET
          POST = :POST
          PUT = :PUT
          PATCH = :PATCH
          DELETE = :DELETE

          # @!method self.values
          #   @return [Array<Symbol>]
        end
      end

      # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep#merge_strategy
      module MergeStrategy
        extend Trycourier::Internal::Type::Enum

        REPLACE = :replace
        OVERWRITE = :overwrite
        SOFT_MERGE = :"soft-merge"

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class AutomationInvokeStep < Trycourier::Internal::Type::BaseModel
      # @!attribute action
      #
      #   @return [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep::Action]
      required :action,
               enum: -> { Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep::Action }

      # @!attribute template
      #
      #   @return [String]
      required :template, String

      # @!method initialize(action:, template:)
      #   @param action [Symbol, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep::Action]
      #   @param template [String]

      # @see Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep#action
      module Action
        extend Trycourier::Internal::Type::Enum

        INVOKE = :invoke

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    # @!method self.variants
    #   @return [Array(Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep)]
  end
end

Instance Attribute Details

#cancelation_token ⇒ String?

Returns:

  • (String, nil) 


60
 
# File 'lib/trycourier/models/automations/invoke_invoke_ad_hoc_params.rb', line 60

optional :cancelation_token, String, nil?: true

#steps ⇒ Array<Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep, Trycourier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep>

Returns:



54
55
 
# File 'lib/trycourier/models/automations/invoke_invoke_ad_hoc_params.rb', line 54

required :steps,
-> { Trycourier::Internal::Type::ArrayOf[union: Trycourier::Automations::InvokeInvokeAdHocParams::Automation::Step] }