Class: Mailhub::Campaign::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/Mailhub/campaign/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



9
10
11
 
# File 'lib/Mailhub/campaign/client.rb', line 9

def initialize(client:)
  @client = client
end

Instance Method Details

#add_campaign_media(request_options: {}, **params) ⇒ Mailhub::Types::CampaignMediaModel

Examples:

client.campaign.add_campaign_media(code: "code")

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/Mailhub/campaign/client.rb', line 492

def add_campaign_media(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request_data = Mailhub::Campaign::Types::AddCampaignMediaByCodeRequest.new(params).to_h
  non_body_param_names = %w[code]
  body = request_data.except(*non_body_param_names)

  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/media",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignMediaModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#cancel_campaign(request_options: {}, **params) ⇒ Mailhub::Types::CampaignModel

Examples:

client.campaign.cancel_campaign(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/Mailhub/campaign/client.rb', line 674

def cancel_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PUT",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/cancel",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#catch_up_campaign(request_options: {}, **params) ⇒ Mailhub::Types::CampaignModel

Examples:

client.campaign.catch_up_campaign(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/Mailhub/campaign/client.rb', line 709

def catch_up_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PUT",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/catch-up",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#create_campaign(request_options: {}, **params) ⇒ Mailhub::Types::CampaignModel

Examples:

client.campaign.create_campaign

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/Mailhub/campaign/client.rb', line 74

def create_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v1/campaigns",
    body: Mailhub::Campaign::Types::CreateCampaignByCodeRequest.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#delete_campaign(request_options: {}, **params) ⇒ untyped

Examples:

client.campaign.delete_campaign(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:

  • (untyped)

Raises:

  • (error_class) 


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/Mailhub/campaign/client.rb', line 185

def delete_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "DELETE",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#get_campaign(request_options: {}, **params) ⇒ Mailhub::Types::CampaignModel

Examples:

client.campaign.get_campaign(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/Mailhub/campaign/client.rb', line 110

def get_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#get_campaign_activity(request_options: {}, **params) ⇒ Array[Mailhub::Types::CampaignActivityPointModel]

Examples:

client.campaign.get_campaign_activity(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:

Raises:

  • (error_class) 


393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/Mailhub/campaign/client.rb', line 393

def get_campaign_activity(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/activity",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#get_campaign_analytics(request_options: {}, **params) ⇒ Mailhub::Types::CampaignAnalyticsModel

Examples:

client.campaign.get_campaign_analytics(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/Mailhub/campaign/client.rb', line 358

def get_campaign_analytics(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/analytics",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignAnalyticsModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#get_campaign_link_stats(request_options: {}, **params) ⇒ Array[Mailhub::Types::CampaignLinkStatModel]

Examples:

client.campaign.get_campaign_link_stats(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:

Raises:

  • (error_class) 


426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/Mailhub/campaign/client.rb', line 426

def get_campaign_link_stats(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/link-stats",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#get_campaign_media(request_options: {}, **params) ⇒ Array[Mailhub::Types::CampaignMediaModel]

Examples:

client.campaign.get_campaign_media(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:

Raises:

  • (error_class) 


459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/Mailhub/campaign/client.rb', line 459

def get_campaign_media(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/media",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#get_campaigns(request_options: {}, **params) ⇒ Mailhub::Types::CampaignModelPagedResult

Examples:

client.campaign.get_campaigns

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :search (String, nil)
  • :status (Mailhub::Types::CampaignStatus, nil)
  • :sort_by (String, nil)
  • :sort_direction (String, nil)
  • :page_size (Integer, nil)
  • :page_index (Integer, nil)

Returns:



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/Mailhub/campaign/client.rb', line 31

def get_campaigns(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  query_params = {}
  query_params["search"] = params[:search] if params.key?(:search)
  query_params["status"] = params[:status] if params.key?(:status)
  query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
  query_params["sortDirection"] = params[:sort_direction] if params.key?(:sort_direction)
  query_params["pageSize"] = params[:page_size] if params.key?(:page_size)
  query_params["pageIndex"] = params[:page_index] if params.key?(:page_index)

  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/campaigns",
    query: query_params,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignModelPagedResult.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#get_running_campaign_stats(request_options: {}, **_params) ⇒ Array[Mailhub::Types::RunningCampaignStatsModel]

Examples:

client.campaign.get_running_campaign_stats

Parameters:

  • request_options (Hash) (defaults to: {})
  • _params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:

Raises:

  • (error_class) 


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/Mailhub/campaign/client.rb', line 326

def get_running_campaign_stats(request_options: {}, **_params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/campaigns/stats/running",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#pause_campaign(request_options: {}, **params) ⇒ Mailhub::Types::CampaignModel

Examples:

client.campaign.pause_campaign(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/Mailhub/campaign/client.rb', line 639

def pause_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PUT",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/pause",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#preview_campaign(request_options: {}, **params) ⇒ String

Examples:

client.campaign.preview_campaign(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:

  • (String)

Raises:

  • (error_class) 


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/Mailhub/campaign/client.rb', line 218

def preview_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/preview",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#remove_campaign_media(request_options: {}, **params) ⇒ untyped

Examples:

client.campaign.remove_campaign_media(
  code: "code",
  media_code: "mediaCode"
)

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)
  • :media_code (String)

Returns:

  • (untyped)

Raises:

  • (error_class) 


536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/Mailhub/campaign/client.rb', line 536

def remove_campaign_media(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "DELETE",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/media/#{URI.encode_uri_component(params[:media_code].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#render_campaign_preview(request_options: {}, **params) ⇒ String

Examples:

client.campaign.render_campaign_preview(code: "code")

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:

  • (String)

Raises:

  • (error_class) 


251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/Mailhub/campaign/client.rb', line 251

def render_campaign_preview(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request_data = Mailhub::Campaign::Types::GetCampaignRenderedPreviewByCodeRequest.new(params).to_h
  non_body_param_names = %w[code]
  body = request_data.except(*non_body_param_names)

  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/preview",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#schedule_campaign(request_options: {}, **params) ⇒ Mailhub::Types::CampaignModel

Examples:

client.campaign.schedule_campaign(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/Mailhub/campaign/client.rb', line 569

def schedule_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PUT",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/schedule",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#send_campaign(request_options: {}, **params) ⇒ Mailhub::Types::CampaignModel

Examples:

client.campaign.send_campaign(code: "code")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/Mailhub/campaign/client.rb', line 604

def send_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PUT",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/send",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#test_campaign(request_options: {}, **params) ⇒ Boolean

Examples:

client.campaign.test_campaign(code: "code")

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:

  • (Boolean)

Raises:

  • (error_class) 


289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/Mailhub/campaign/client.rb', line 289

def test_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request_data = Mailhub::Campaign::Types::TestCampaignByCodeRequest.new(params).to_h
  non_body_param_names = %w[code]
  body = request_data.except(*non_body_param_names)

  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}/test",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#update_campaign(request_options: {}, **params) ⇒ Mailhub::Types::CampaignModel

Examples:

client.campaign.update_campaign(code: "code")

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :code (String)

Returns:



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
 
# File 'lib/Mailhub/campaign/client.rb', line 145

def update_campaign(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request_data = Mailhub::Campaign::Types::UpdateCampaignByCodeRequest.new(params).to_h
  non_body_param_names = %w[code]
  body = request_data.except(*non_body_param_names)

  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PUT",
    path: "v1/campaigns/#{URI.encode_uri_component(params[:code].to_s)}",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::CampaignModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end