Class: ElasticEmail::SegmentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ElasticEmail/api/segments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SegmentsApi

Returns a new instance of SegmentsApi.



19
20
21
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#segments_by_name_delete(name, opts = {}) ⇒ nil

Delete Segment Delete an existing segment. Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your segment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 27

def segments_by_name_delete(name, opts = {})
  segments_by_name_delete_with_http_info(name, opts)
  nil
end

#segments_by_name_delete_with_http_info(name, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Segment Delete an existing segment. Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your segment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 37

def segments_by_name_delete_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SegmentsApi.segments_by_name_delete ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SegmentsApi.segments_by_name_delete"
  end
  # resource path
  local_var_path = '/segments/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apikey']

  new_options = opts.merge(
    :operation => :"SegmentsApi.segments_by_name_delete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SegmentsApi#segments_by_name_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#segments_by_name_get(name, opts = {}) ⇒ Segment

Load Segment Returns details for the specified segment. Required Access Level: ViewContacts

Parameters:

  • name (String) —

    Name of the segment you want to load. Will load all contacts if the &#39;All Contacts&#39; name has been provided

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 88

def segments_by_name_get(name, opts = {})
  data, _status_code, _headers = segments_by_name_get_with_http_info(name, opts)
  data
end

#segments_by_name_get_with_http_info(name, opts = {}) ⇒ Array<(Segment, Integer, Hash)>

Load Segment Returns details for the specified segment. Required Access Level: ViewContacts

Parameters:

  • name (String) —

    Name of the segment you want to load. Will load all contacts if the &#39;All Contacts&#39; name has been provided

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Segment, Integer, Hash)>) —

    Segment data, response status code and response headers



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
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 98

def segments_by_name_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SegmentsApi.segments_by_name_get ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SegmentsApi.segments_by_name_get"
  end
  # resource path
  local_var_path = '/segments/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Segment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apikey']

  new_options = opts.merge(
    :operation => :"SegmentsApi.segments_by_name_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SegmentsApi#segments_by_name_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#segments_by_name_put(name, segment_payload, opts = {}) ⇒ Segment

Update Segment Rename or change RULE for your segment. Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your segment.

  • segment_payload (SegmentPayload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 152

def segments_by_name_put(name, segment_payload, opts = {})
  data, _status_code, _headers = segments_by_name_put_with_http_info(name, segment_payload, opts)
  data
end

#segments_by_name_put_with_http_info(name, segment_payload, opts = {}) ⇒ Array<(Segment, Integer, Hash)>

Update Segment Rename or change RULE for your segment. Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your segment.

  • segment_payload (SegmentPayload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Segment, Integer, Hash)>) —

    Segment data, response status code and response headers



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
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 163

def segments_by_name_put_with_http_info(name, segment_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SegmentsApi.segments_by_name_put ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SegmentsApi.segments_by_name_put"
  end
  # verify the required parameter 'segment_payload' is set
  if @api_client.config.client_side_validation && segment_payload.nil?
    fail ArgumentError, "Missing the required parameter 'segment_payload' when calling SegmentsApi.segments_by_name_put"
  end
  # resource path
  local_var_path = '/segments/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(segment_payload)

  # return_type
  return_type = opts[:debug_return_type] || 'Segment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apikey']

  new_options = opts.merge(
    :operation => :"SegmentsApi.segments_by_name_put",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SegmentsApi#segments_by_name_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#segments_get(opts = {}) ⇒ Array<Segment>

Load Segments Returns a list of all your available Segments. Required Access Level: ViewContacts

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:



226
227
228
229
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 226

def segments_get(opts = {})
  data, _status_code, _headers = segments_get_with_http_info(opts)
  data
end

#segments_get_with_http_info(opts = {}) ⇒ Array<(Array<Segment>, Integer, Hash)>

Load Segments Returns a list of all your available Segments. Required Access Level: ViewContacts

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:

  • (Array<(Array<Segment>, Integer, Hash)>) —

    Array<Segment> data, response status code and response headers



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
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 237

def segments_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SegmentsApi.segments_get ...'
  end
  # resource path
  local_var_path = '/segments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Segment>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apikey']

  new_options = opts.merge(
    :operation => :"SegmentsApi.segments_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SegmentsApi#segments_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#segments_post(segment_payload, opts = {}) ⇒ Segment

Add Segment Add a new segment, based on specified RULE. Required Access Level: ModifyContacts

Parameters:

  • segment_payload (SegmentPayload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



288
289
290
291
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 288

def segments_post(segment_payload, opts = {})
  data, _status_code, _headers = segments_post_with_http_info(segment_payload, opts)
  data
end

#segments_post_with_http_info(segment_payload, opts = {}) ⇒ Array<(Segment, Integer, Hash)>

Add Segment Add a new segment, based on specified RULE. Required Access Level: ModifyContacts

Parameters:

  • segment_payload (SegmentPayload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Segment, Integer, Hash)>) —

    Segment data, response status code and response headers



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
 
# File 'lib/ElasticEmail/api/segments_api.rb', line 298

def segments_post_with_http_info(segment_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SegmentsApi.segments_post ...'
  end
  # verify the required parameter 'segment_payload' is set
  if @api_client.config.client_side_validation && segment_payload.nil?
    fail ArgumentError, "Missing the required parameter 'segment_payload' when calling SegmentsApi.segments_post"
  end
  # resource path
  local_var_path = '/segments'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(segment_payload)

  # return_type
  return_type = opts[:debug_return_type] || 'Segment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apikey']

  new_options = opts.merge(
    :operation => :"SegmentsApi.segments_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SegmentsApi#segments_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end