Class: Zernio::CommentAutomationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zernio-sdk/api/comment_automations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CommentAutomationsApi

Returns a new instance of CommentAutomationsApi.



19
20
21
 
# File 'lib/zernio-sdk/api/comment_automations_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/zernio-sdk/api/comment_automations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_comment_automation(create_comment_automation_request, opts = {}) ⇒ CreateCommentAutomation200Response

Create comment-to-DM automation Create a keyword-triggered DM automation on an Instagram or Facebook account. When someone comments a matching keyword (or, with trigger: story_reply, replies to your Instagram story with one), they automatically receive a DM. Triggers (trigger): * comment (default): fires on keyword comments on a post or reel. * story_reply: fires when someone replies to your Instagram story with a keyword, and answers them with a DM. Set platformPostId to a story media id to scope to one story, or omit it to match replies to any story. Targeting (comment trigger): * Per-post: set platformPostId to scope to one specific post (only one active per-post automation is allowed per post). * Account-wide ("any post"): omit platformPostId (and postId). The automation evaluates every comment on every post on the account. You can stack unlimited account-wide automations, each with its own keyword set, and they all run independently. Per-post automations take priority on their post. Links in the DM's buttons can be click-tracked (linkTracking, on by default) and clickers optionally tagged (clickTag) for segmentation. Stats returned include delivered, read, and link clicks.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 27

def create_comment_automation(create_comment_automation_request, opts = {})
  data, _status_code, _headers = create_comment_automation_with_http_info(create_comment_automation_request, opts)
  data
end

#create_comment_automation_with_http_info(create_comment_automation_request, opts = {}) ⇒ Array<(CreateCommentAutomation200Response, Integer, Hash)>

Create comment-to-DM automation Create a keyword-triggered DM automation on an Instagram or Facebook account. When someone comments a matching keyword (or, with `trigger: story_reply`, replies to your Instagram story with one), they automatically receive a DM. Triggers (`trigger`): * `comment` (default): fires on keyword comments on a post or reel. * `story_reply`: fires when someone replies to your Instagram story with a keyword, and answers them with a DM. Set `platformPostId` to a story media id to scope to one story, or omit it to match replies to any story. Targeting (comment trigger): * Per-post: set `platformPostId` to scope to one specific post (only one active per-post automation is allowed per post). * Account-wide (&quot;any post&quot;): omit `platformPostId` (and `postId`). The automation evaluates every comment on every post on the account. You can stack unlimited account-wide automations, each with its own keyword set, and they all run independently. Per-post automations take priority on their post. Links in the DM's buttons can be click-tracked (`linkTracking`, on by default) and clickers optionally tagged (`clickTag`) for segmentation. Stats returned include delivered, read, and link clicks.

Parameters:

Returns:



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
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 37

def create_comment_automation_with_http_info(create_comment_automation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentAutomationsApi.create_comment_automation ...'
  end
  # verify the required parameter 'create_comment_automation_request' is set
  if @api_client.config.client_side_validation && create_comment_automation_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_comment_automation_request' when calling CommentAutomationsApi.create_comment_automation"
  end
  # resource path
  local_var_path = '/v1/comment-automations'

  # 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']) unless header_params['Accept']
  # 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(create_comment_automation_request)

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

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

  new_options = opts.merge(
    :operation => :"CommentAutomationsApi.create_comment_automation",
    :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: CommentAutomationsApi#create_comment_automation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_comment_automation(automation_id, opts = {}) ⇒ nil

Delete automation Permanently delete an automation and all its trigger logs.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 95

def delete_comment_automation(automation_id, opts = {})
  delete_comment_automation_with_http_info(automation_id, opts)
  nil
end

#delete_comment_automation_with_http_info(automation_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete automation Permanently delete an automation and all its trigger logs.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 105

def delete_comment_automation_with_http_info(automation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentAutomationsApi.delete_comment_automation ...'
  end
  # verify the required parameter 'automation_id' is set
  if @api_client.config.client_side_validation && automation_id.nil?
    fail ArgumentError, "Missing the required parameter 'automation_id' when calling CommentAutomationsApi.delete_comment_automation"
  end
  # resource path
  local_var_path = '/v1/comment-automations/{automationId}'.sub('{' + 'automationId' + '}', CGI.escape(automation_id.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']) unless header_params['Accept']

  # 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] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"CommentAutomationsApi.delete_comment_automation",
    :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: CommentAutomationsApi#delete_comment_automation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_comment_automation(automation_id, opts = {}) ⇒ GetCommentAutomation200Response

Get automation details Returns an automation with its configuration, stats, and recent trigger logs.

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 158

def get_comment_automation(automation_id, opts = {})
  data, _status_code, _headers = get_comment_automation_with_http_info(automation_id, opts)
  data
end

#get_comment_automation_with_http_info(automation_id, opts = {}) ⇒ Array<(GetCommentAutomation200Response, Integer, Hash)>

Get automation details Returns an automation with its configuration, stats, and recent trigger logs.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 168

def get_comment_automation_with_http_info(automation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentAutomationsApi.get_comment_automation ...'
  end
  # verify the required parameter 'automation_id' is set
  if @api_client.config.client_side_validation && automation_id.nil?
    fail ArgumentError, "Missing the required parameter 'automation_id' when calling CommentAutomationsApi.get_comment_automation"
  end
  # resource path
  local_var_path = '/v1/comment-automations/{automationId}'.sub('{' + 'automationId' + '}', CGI.escape(automation_id.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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"CommentAutomationsApi.get_comment_automation",
    :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: CommentAutomationsApi#get_comment_automation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_comment_automation_logs(automation_id, opts = {}) ⇒ ListCommentAutomationLogs200Response

List automation logs Paginated list of every comment that triggered this automation, with send status and commenter info.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by result status

  • :limit (Integer) — default: default to 50
  • :skip (Integer) — default: default to 0

Returns:



224
225
226
227
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 224

def list_comment_automation_logs(automation_id, opts = {})
  data, _status_code, _headers = list_comment_automation_logs_with_http_info(automation_id, opts)
  data
end

#list_comment_automation_logs_with_http_info(automation_id, opts = {}) ⇒ Array<(ListCommentAutomationLogs200Response, Integer, Hash)>

List automation logs Paginated list of every comment that triggered this automation, with send status and commenter info.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by result status

  • :limit (Integer) — default: default to 50
  • :skip (Integer) — default: default to 0

Returns:



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
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 237

def list_comment_automation_logs_with_http_info(automation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentAutomationsApi.list_comment_automation_logs ...'
  end
  # verify the required parameter 'automation_id' is set
  if @api_client.config.client_side_validation && automation_id.nil?
    fail ArgumentError, "Missing the required parameter 'automation_id' when calling CommentAutomationsApi.list_comment_automation_logs"
  end
  allowable_values = ["sent", "failed", "skipped"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/comment-automations/{automationId}/logs'.sub('{' + 'automationId' + '}', CGI.escape(automation_id.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CommentAutomationsApi.list_comment_automation_logs",
    :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: CommentAutomationsApi#list_comment_automation_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_comment_automations(opts = {}) ⇒ ListCommentAutomations200Response

List comment-to-DM automations List all comment-to-DM automations for a profile. Returns automations with their stats.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    Filter by profile. Omit to list across all profiles

Returns:



297
298
299
300
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 297

def list_comment_automations(opts = {})
  data, _status_code, _headers = list_comment_automations_with_http_info(opts)
  data
end

#list_comment_automations_with_http_info(opts = {}) ⇒ Array<(ListCommentAutomations200Response, Integer, Hash)>

List comment-to-DM automations List all comment-to-DM automations for a profile. Returns automations with their stats.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    Filter by profile. Omit to list across all profiles

Returns:



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
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 307

def list_comment_automations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentAutomationsApi.list_comment_automations ...'
  end
  # resource path
  local_var_path = '/v1/comment-automations'

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CommentAutomationsApi.list_comment_automations",
    :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: CommentAutomationsApi#list_comment_automations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_comment_automation(automation_id, opts = {}) ⇒ UpdateCommentAutomation200Response

Update automation settings Update an automation's keywords, DM message, inline buttons, comment reply, or active status. Pass buttons: [] to clear all buttons. When buttons is non-empty, dmMessage (the new one if you're changing it, otherwise the stored one) must be 640 characters or less.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



358
359
360
361
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 358

def update_comment_automation(automation_id, opts = {})
  data, _status_code, _headers = update_comment_automation_with_http_info(automation_id, opts)
  data
end

#update_comment_automation_with_http_info(automation_id, opts = {}) ⇒ Array<(UpdateCommentAutomation200Response, Integer, Hash)>

Update automation settings Update an automation's keywords, DM message, inline buttons, comment reply, or active status. Pass `buttons: []` to clear all buttons. When `buttons` is non-empty, `dmMessage` (the new one if you're changing it, otherwise the stored one) must be 640 characters or less.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
 
# File 'lib/zernio-sdk/api/comment_automations_api.rb', line 369

def update_comment_automation_with_http_info(automation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentAutomationsApi.update_comment_automation ...'
  end
  # verify the required parameter 'automation_id' is set
  if @api_client.config.client_side_validation && automation_id.nil?
    fail ArgumentError, "Missing the required parameter 'automation_id' when calling CommentAutomationsApi.update_comment_automation"
  end
  # resource path
  local_var_path = '/v1/comment-automations/{automationId}'.sub('{' + 'automationId' + '}', CGI.escape(automation_id.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']) unless header_params['Accept']
  # 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(opts[:'update_comment_automation_request'])

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

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

  new_options = opts.merge(
    :operation => :"CommentAutomationsApi.update_comment_automation",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommentAutomationsApi#update_comment_automation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end