Class: Mailhub::Segment::Client

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



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

def initialize(client:)
  @client = client
end

Instance Method Details

#create_segment(request_options: {}, **params) ⇒ Mailhub::Types::SegmentModel

Examples:

client.segment.create_segment

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:



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

def create_segment(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/segments",
    body: Mailhub::Segment::Types::CreateSegmentRequest.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::SegmentModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

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

Examples:

client.segment.delete_segment(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) 


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

def delete_segment(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/segments/#{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

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

Examples:

client.segment.delete_segments

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:

  • (untyped)

Raises:

  • (error_class) 


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

def delete_segments(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/segments/delete",
    body: Mailhub::Segment::Types::DeleteSegmentsByCodeRequest.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
  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_segment(request_options: {}, **params) ⇒ Mailhub::Types::SegmentModel

Examples:

client.segment.get_segment(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:



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

def get_segment(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/segments/#{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::SegmentModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#get_segments(request_options: {}, **params) ⇒ Mailhub::Types::SegmentModelPagedResult

Examples:

client.segment.get_segments

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)
  • :sort_by (String, nil)
  • :sort_direction (String, nil)
  • :page_size (Integer, nil)
  • :page_index (Integer, nil)

Returns:



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

def get_segments(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  query_params = {}
  query_params["search"] = params[:search] if params.key?(:search)
  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/segments",
    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::SegmentModelPagedResult.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#preview_segment(request_options: {}, **params) ⇒ Mailhub::Types::PreviewSegmentModel

Examples:

client.segment.preview_segment

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:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/Mailhub/segment/client.rb', line 248

def preview_segment(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/segments/preview",
    body: Mailhub::Segment::Types::GetSegmentPreviewRequest.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::PreviewSegmentModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#preview_segments_union(request_options: {}, **params) ⇒ Mailhub::Types::PreviewSegmentModel

Examples:

client.segment.preview_segments_union

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:



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/Mailhub/segment/client.rb', line 283

def preview_segments_union(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/segments/preview/union",
    body: Mailhub::Segment::Types::GetSegmentsUnionPreviewByCodeRequest.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::PreviewSegmentModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#query_segment_contacts(request_options: {}, **params) ⇒ Mailhub::Types::ContactModelPagedResult

Examples:

client.segment.query_segment_contacts

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:



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/Mailhub/segment/client.rb', line 318

def query_segment_contacts(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/segments/preview/contacts",
    body: Mailhub::Segment::Types::GetSegmentContactsRequest.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::ContactModelPagedResult.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#sync_segment(request_options: {}, **params) ⇒ Mailhub::Types::SegmentModel

Examples:

client.segment.sync_segment(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:



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/Mailhub/segment/client.rb', line 354

def sync_segment(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/segments/#{URI.encode_uri_component(params[:code].to_s)}/sync",
    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::SegmentModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#update_segment(request_options: {}, **params) ⇒ Mailhub::Types::SegmentModel

Examples:

client.segment.update_segment(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:



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

def update_segment(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request_data = Mailhub::Segment::Types::UpdateSegmentRequest.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/segments/#{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::SegmentModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end