Class: OneSignal::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/onesignal/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.



19
20
21
 
# File 'lib/onesignal/api/default_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/onesignal/api/default_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#begin_live_activity(app_id, activity_id, begin_live_activity_request, opts = {}) ⇒ nil

Start Live Activity Starts a Live Activity

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys & IDs.

  • activity_id (String) —

    Live Activity record ID

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

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/onesignal/api/default_api.rb', line 29

def begin_live_activity(app_id, activity_id, begin_live_activity_request, opts = {})
  begin_live_activity_with_http_info(app_id, activity_id, begin_live_activity_request, opts)
  nil
end

#begin_live_activity_with_http_info(app_id, activity_id, begin_live_activity_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Start Live Activity Starts a Live Activity

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • activity_id (String) —

    Live Activity record ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/onesignal/api/default_api.rb', line 41

def begin_live_activity_with_http_info(app_id, activity_id, begin_live_activity_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.begin_live_activity ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.begin_live_activity"
  end
  # verify the required parameter 'activity_id' is set
  if @api_client.config.client_side_validation && activity_id.nil?
    fail ArgumentError, "Missing the required parameter 'activity_id' when calling DefaultApi.begin_live_activity"
  end
  # verify the required parameter 'begin_live_activity_request' is set
  if @api_client.config.client_side_validation && begin_live_activity_request.nil?
    fail ArgumentError, "Missing the required parameter 'begin_live_activity_request' when calling DefaultApi.begin_live_activity"
  end
  # resource path
  local_var_path = '/apps/{app_id}/live_activities/{activity_id}/token'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'activity_id' + '}', CGI.escape(activity_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'])
  # 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(begin_live_activity_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#cancel_notification(app_id, notification_id, opts = {}) ⇒ CancelNotificationSuccessResponse

Stop a scheduled or currently outgoing notification Used to stop a scheduled or currently outgoing notification

Parameters:

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

    the optional parameters

Returns:



108
109
110
111
 
# File 'lib/onesignal/api/default_api.rb', line 108

def cancel_notification(app_id, notification_id, opts = {})
  data, _status_code, _headers = cancel_notification_with_http_info(app_id, notification_id, opts)
  data
end

#cancel_notification_with_http_info(app_id, notification_id, opts = {}) ⇒ Array<(CancelNotificationSuccessResponse, Integer, Hash)>

Stop a scheduled or currently outgoing notification Used to stop a scheduled or currently outgoing notification

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/onesignal/api/default_api.rb', line 119

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

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

  # 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] || 'CancelNotificationSuccessResponse'

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

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

#create_app(app, opts = {}) ⇒ App

Create an app Creates a new OneSignal app

Parameters:

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

    the optional parameters

Returns:



177
178
179
180
 
# File 'lib/onesignal/api/default_api.rb', line 177

def create_app(app, opts = {})
  data, _status_code, _headers = create_app_with_http_info(app, opts)
  data
end

#create_app_with_http_info(app, opts = {}) ⇒ Array<(App, Integer, Hash)>

Create an app Creates a new OneSignal app

Parameters:

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

    the optional parameters

Returns:

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

    App data, response status code and response headers



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
 
# File 'lib/onesignal/api/default_api.rb', line 187

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

  # 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(app)

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

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

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

#create_notification(notification, opts = {}) ⇒ CreateNotificationSuccessResponse

Create notification Sends notifications to your users

Parameters:

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

    the optional parameters

Returns:



245
246
247
248
 
# File 'lib/onesignal/api/default_api.rb', line 245

def create_notification(notification, opts = {})
  data, _status_code, _headers = create_notification_with_http_info(notification, opts)
  data
end

#create_notification_with_http_info(notification, opts = {}) ⇒ Array<(CreateNotificationSuccessResponse, Integer, Hash)>

Create notification Sends notifications to your users

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/onesignal/api/default_api.rb', line 255

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

  # 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(notification)

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

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

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

#create_player(player, opts = {}) ⇒ CreatePlayerSuccessResponse

Add a device Register a new device to one of your OneSignal apps &#x1F6A7; Don’t use this This API endpoint is designed to be used from our open source Mobile and Web Push SDKs. It is not designed for developers to use it directly, unless instructed to do so by OneSignal support. If you use this method instead of our SDKs, many OneSignal features such as conversion tracking, timezone tracking, language detection, and rich-push won’t work out of the box. It will also make it harder to identify possible setup issues. This method is used to register a new device with OneSignal. If a device is already registered with the specified identifier, then this will update the existing device record instead of creating a new one. The returned player is a player / user ID. Use the returned ID to send push notifications to this specific user later, or to include this player when sending to a set of users. &#x1F6A7; iOS Must set test_type to 1 when building your iOS app as development. Omit this field in your production app builds.

Parameters:

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

    the optional parameters

Returns:



313
314
315
316
 
# File 'lib/onesignal/api/default_api.rb', line 313

def create_player(player, opts = {})
  data, _status_code, _headers = create_player_with_http_info(player, opts)
  data
end

#create_player_with_http_info(player, opts = {}) ⇒ Array<(CreatePlayerSuccessResponse, Integer, Hash)>

Add a device Register a new device to one of your OneSignal apps &amp;#x1F6A7; Don&#39;t use this This API endpoint is designed to be used from our open source Mobile and Web Push SDKs. It is not designed for developers to use it directly, unless instructed to do so by OneSignal support. If you use this method instead of our SDKs, many OneSignal features such as conversion tracking, timezone tracking, language detection, and rich-push won&#39;t work out of the box. It will also make it harder to identify possible setup issues. This method is used to register a new device with OneSignal. If a device is already registered with the specified identifier, then this will update the existing device record instead of creating a new one. The returned player is a player / user ID. Use the returned ID to send push notifications to this specific user later, or to include this player when sending to a set of users. &amp;#x1F6A7; iOS Must set test_type to 1 when building your iOS app as development. Omit this field in your production app builds.

Parameters:

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

    the optional parameters

Returns:

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

    CreatePlayerSuccessResponse data, response status code and response headers



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
 
# File 'lib/onesignal/api/default_api.rb', line 323

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

  # 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(player)

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

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

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

#create_segments(app_id, opts = {}) ⇒ CreateSegmentSuccessResponse

Create Segments Create segments visible and usable in the dashboard and API - Required: OneSignal Paid Plan The Create Segment method is used when you want your server to programmatically create a segment instead of using the OneSignal Dashboard UI. Just like creating Segments from the dashboard you can pass in filters with multiple "AND" or "OR" operator’s. &#x1F6A7; Does Not Update Segments This endpoint will only create segments, it does not edit or update currently created Segments. You will need to use the Delete Segments endpoint and re-create it with this endpoint to edit.

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

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

    the optional parameters

Options Hash (opts):

Returns:



382
383
384
385
 
# File 'lib/onesignal/api/default_api.rb', line 382

def create_segments(app_id, opts = {})
  data, _status_code, _headers = create_segments_with_http_info(app_id, opts)
  data
end

#create_segments_with_http_info(app_id, opts = {}) ⇒ Array<(CreateSegmentSuccessResponse, Integer, Hash)>

Create Segments Create segments visible and usable in the dashboard and API - Required: OneSignal Paid Plan The Create Segment method is used when you want your server to programmatically create a segment instead of using the OneSignal Dashboard UI. Just like creating Segments from the dashboard you can pass in filters with multiple &quot;AND&quot; or &quot;OR&quot; operator&#39;s. &amp;#x1F6A7; Does Not Update Segments This endpoint will only create segments, it does not edit or update currently created Segments. You will need to use the Delete Segments endpoint and re-create it with this endpoint to edit.

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

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

    the optional parameters

Options Hash (opts):

Returns:



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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/onesignal/api/default_api.rb', line 393

def create_segments_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_segments ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.create_segments"
  end
  # resource path
  local_var_path = '/apps/{app_id}/segments'.sub('{' + 'app_id' + '}', CGI.escape(app_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'])
  # 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[:'segment'])

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

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

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

#create_subscription(app_id, alias_label, alias_id, create_subscription_request_body, opts = {}) ⇒ InlineResponse201

Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • create_subscription_request_body (CreateSubscriptionRequestBody)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



453
454
455
456
 
# File 'lib/onesignal/api/default_api.rb', line 453

def create_subscription(app_id, alias_label, alias_id, create_subscription_request_body, opts = {})
  data, _status_code, _headers = create_subscription_with_http_info(app_id, alias_label, alias_id, create_subscription_request_body, opts)
  data
end

#create_subscription_with_http_info(app_id, alias_label, alias_id, create_subscription_request_body, opts = {}) ⇒ Array<(InlineResponse201, Integer, Hash)>

Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • create_subscription_request_body (CreateSubscriptionRequestBody)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    InlineResponse201 data, response status code and response headers



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
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
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/onesignal/api/default_api.rb', line 465

def create_subscription_with_http_info(app_id, alias_label, alias_id, create_subscription_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_subscription ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.create_subscription"
  end
  # verify the required parameter 'alias_label' is set
  if @api_client.config.client_side_validation && alias_label.nil?
    fail ArgumentError, "Missing the required parameter 'alias_label' when calling DefaultApi.create_subscription"
  end
  # verify the required parameter 'alias_id' is set
  if @api_client.config.client_side_validation && alias_id.nil?
    fail ArgumentError, "Missing the required parameter 'alias_id' when calling DefaultApi.create_subscription"
  end
  # verify the required parameter 'create_subscription_request_body' is set
  if @api_client.config.client_side_validation && create_subscription_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'create_subscription_request_body' when calling DefaultApi.create_subscription"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'alias_label' + '}', CGI.escape(alias_label.to_s)).sub('{' + 'alias_id' + '}', CGI.escape(alias_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'])
  # 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_subscription_request_body)

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

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

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

#create_user(app_id, user, opts = {}) ⇒ User

Creates a User, optionally Subscriptions owned by the User as well as Aliases. Aliases provided in the payload will be used to look up an existing User.

Parameters:

  • app_id (String)
  • user (User)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



535
536
537
538
 
# File 'lib/onesignal/api/default_api.rb', line 535

def create_user(app_id, user, opts = {})
  data, _status_code, _headers = create_user_with_http_info(app_id, user, opts)
  data
end

#create_user_with_http_info(app_id, user, opts = {}) ⇒ Array<(User, Integer, Hash)>

Creates a User, optionally Subscriptions owned by the User as well as Aliases. Aliases provided in the payload will be used to look up an existing User.

Parameters:

  • app_id (String)
  • user (User)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    User data, response status code and response headers



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/onesignal/api/default_api.rb', line 545

def create_user_with_http_info(app_id, user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_user ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.create_user"
  end
  # verify the required parameter 'user' is set
  if @api_client.config.client_side_validation && user.nil?
    fail ArgumentError, "Missing the required parameter 'user' when calling DefaultApi.create_user"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users'.sub('{' + 'app_id' + '}', CGI.escape(app_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'])
  # 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(user)

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

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

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

#delete_alias(app_id, alias_label, alias_id, alias_label_to_delete, opts = {}) ⇒ InlineResponse200

Deletes an alias by alias label

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • alias_label_to_delete (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



609
610
611
612
 
# File 'lib/onesignal/api/default_api.rb', line 609

def delete_alias(app_id, alias_label, alias_id, alias_label_to_delete, opts = {})
  data, _status_code, _headers = delete_alias_with_http_info(app_id, alias_label, alias_id, alias_label_to_delete, opts)
  data
end

#delete_alias_with_http_info(app_id, alias_label, alias_id, alias_label_to_delete, opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Deletes an alias by alias label

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • alias_label_to_delete (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    InlineResponse200 data, response status code and response headers



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/onesignal/api/default_api.rb', line 621

def delete_alias_with_http_info(app_id, alias_label, alias_id, alias_label_to_delete, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_alias ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.delete_alias"
  end
  # verify the required parameter 'alias_label' is set
  if @api_client.config.client_side_validation && alias_label.nil?
    fail ArgumentError, "Missing the required parameter 'alias_label' when calling DefaultApi.delete_alias"
  end
  # verify the required parameter 'alias_id' is set
  if @api_client.config.client_side_validation && alias_id.nil?
    fail ArgumentError, "Missing the required parameter 'alias_id' when calling DefaultApi.delete_alias"
  end
  # verify the required parameter 'alias_label_to_delete' is set
  if @api_client.config.client_side_validation && alias_label_to_delete.nil?
    fail ArgumentError, "Missing the required parameter 'alias_label_to_delete' when calling DefaultApi.delete_alias"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'alias_label' + '}', CGI.escape(alias_label.to_s)).sub('{' + 'alias_id' + '}', CGI.escape(alias_id.to_s)).sub('{' + 'alias_label_to_delete' + '}', CGI.escape(alias_label_to_delete.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] || 'InlineResponse200'

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

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

#delete_player(app_id, player_id, opts = {}) ⇒ DeletePlayerSuccessResponse

Delete a user record Delete player - Required: Used to delete a single, specific Player ID record from a specific OneSignal app.

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • player_id (String) —

    The OneSignal player_id

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

    the optional parameters

Returns:



687
688
689
690
 
# File 'lib/onesignal/api/default_api.rb', line 687

def delete_player(app_id, player_id, opts = {})
  data, _status_code, _headers = delete_player_with_http_info(app_id, player_id, opts)
  data
end

#delete_player_with_http_info(app_id, player_id, opts = {}) ⇒ Array<(DeletePlayerSuccessResponse, Integer, Hash)>

Delete a user record Delete player - Required: Used to delete a single, specific Player ID record from a specific OneSignal app.

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • player_id (String) —

    The OneSignal player_id

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

    the optional parameters

Returns:

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

    DeletePlayerSuccessResponse data, response status code and response headers



698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/onesignal/api/default_api.rb', line 698

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

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

  # 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] || 'DeletePlayerSuccessResponse'

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

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

#delete_segments(app_id, segment_id, opts = {}) ⇒ DeleteSegmentSuccessResponse

Delete Segments Delete segments (not user devices) - Required: OneSignal Paid Plan You can delete a segment under your app by calling this API. You must provide an API key in the Authorization header that has admin access on the app. The segment_id can be found in the URL of the segment when viewing it in the dashboard.

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • segment_id (String) —

    The segment_id can be found in the URL of the segment when viewing it in the dashboard.

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

    the optional parameters

Returns:



757
758
759
760
 
# File 'lib/onesignal/api/default_api.rb', line 757

def delete_segments(app_id, segment_id, opts = {})
  data, _status_code, _headers = delete_segments_with_http_info(app_id, segment_id, opts)
  data
end

#delete_segments_with_http_info(app_id, segment_id, opts = {}) ⇒ Array<(DeleteSegmentSuccessResponse, Integer, Hash)>

Delete Segments Delete segments (not user devices) - Required: OneSignal Paid Plan You can delete a segment under your app by calling this API. You must provide an API key in the Authorization header that has admin access on the app. The segment_id can be found in the URL of the segment when viewing it in the dashboard.

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • segment_id (String) —

    The segment_id can be found in the URL of the segment when viewing it in the dashboard.

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

    the optional parameters

Returns:



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/onesignal/api/default_api.rb', line 768

def delete_segments_with_http_info(app_id, segment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_segments ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.delete_segments"
  end
  # verify the required parameter 'segment_id' is set
  if @api_client.config.client_side_validation && segment_id.nil?
    fail ArgumentError, "Missing the required parameter 'segment_id' when calling DefaultApi.delete_segments"
  end
  # resource path
  local_var_path = '/apps/{app_id}/segments/{segment_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'segment_id' + '}', CGI.escape(segment_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'])

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

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

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

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

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

#delete_subscription(app_id, subscription_id, opts = {}) ⇒ nil

Deletes the Subscription.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


825
826
827
828
 
# File 'lib/onesignal/api/default_api.rb', line 825

def delete_subscription(app_id, subscription_id, opts = {})
  delete_subscription_with_http_info(app_id, subscription_id, opts)
  nil
end

#delete_subscription_with_http_info(app_id, subscription_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes the Subscription.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/onesignal/api/default_api.rb', line 835

def delete_subscription_with_http_info(app_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_subscription ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.delete_subscription"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DefaultApi.delete_subscription"
  end
  # resource path
  local_var_path = '/apps/{app_id}/subscriptions/{subscription_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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'])

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

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

#delete_user(app_id, alias_label, alias_id, opts = {}) ⇒ nil

Removes the User identified by (:alias_label, :alias_id), and all Subscriptions and Aliases

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


893
894
895
896
 
# File 'lib/onesignal/api/default_api.rb', line 893

def delete_user(app_id, alias_label, alias_id, opts = {})
  delete_user_with_http_info(app_id, alias_label, alias_id, opts)
  nil
end

#delete_user_with_http_info(app_id, alias_label, alias_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Removes the User identified by (:alias_label, :alias_id), and all Subscriptions and Aliases

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/onesignal/api/default_api.rb', line 904

def delete_user_with_http_info(app_id, alias_label, alias_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_user ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.delete_user"
  end
  # verify the required parameter 'alias_label' is set
  if @api_client.config.client_side_validation && alias_label.nil?
    fail ArgumentError, "Missing the required parameter 'alias_label' when calling DefaultApi.delete_user"
  end
  # verify the required parameter 'alias_id' is set
  if @api_client.config.client_side_validation && alias_id.nil?
    fail ArgumentError, "Missing the required parameter 'alias_id' when calling DefaultApi.delete_user"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/by/{alias_label}/{alias_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'alias_label' + '}', CGI.escape(alias_label.to_s)).sub('{' + 'alias_id' + '}', CGI.escape(alias_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'])

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

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

#end_live_activity(app_id, activity_id, subscription_id, opts = {}) ⇒ nil

Stop Live Activity Stops a Live Activity

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • activity_id (String) —

    Live Activity record ID

  • subscription_id (String) —

    Subscription ID

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

    the optional parameters

Returns:

  • (nil) 


967
968
969
970
 
# File 'lib/onesignal/api/default_api.rb', line 967

def end_live_activity(app_id, activity_id, subscription_id, opts = {})
  end_live_activity_with_http_info(app_id, activity_id, subscription_id, opts)
  nil
end

#end_live_activity_with_http_info(app_id, activity_id, subscription_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Stop Live Activity Stops a Live Activity

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • activity_id (String) —

    Live Activity record ID

  • subscription_id (String) —

    Subscription ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/onesignal/api/default_api.rb', line 979

def end_live_activity_with_http_info(app_id, activity_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.end_live_activity ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.end_live_activity"
  end
  # verify the required parameter 'activity_id' is set
  if @api_client.config.client_side_validation && activity_id.nil?
    fail ArgumentError, "Missing the required parameter 'activity_id' when calling DefaultApi.end_live_activity"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DefaultApi.end_live_activity"
  end
  # resource path
  local_var_path = '/apps/{app_id}/live_activities/{activity_id}/token/{subscription_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'activity_id' + '}', CGI.escape(activity_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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'])

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

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

#export_events(notification_id, app_id, opts = {}) ⇒ ExportEventsSuccessResponse

Export CSV of Events Generate a compressed CSV report of all of the events data for a notification. This will return a URL immediately upon success but it may take several minutes for the CSV to become available at that URL depending on the volume of data. Only one export can be in-progress per OneSignal account at any given time.

Parameters:

  • notification_id (String) —

    The ID of the notification to export events from.

  • app_id (String) —

    The ID of the app that the notification belongs to.

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

    the optional parameters

Returns:



1041
1042
1043
1044
 
# File 'lib/onesignal/api/default_api.rb', line 1041

def export_events(notification_id, app_id, opts = {})
  data, _status_code, _headers = export_events_with_http_info(notification_id, app_id, opts)
  data
end

#export_events_with_http_info(notification_id, app_id, opts = {}) ⇒ Array<(ExportEventsSuccessResponse, Integer, Hash)>

Export CSV of Events Generate a compressed CSV report of all of the events data for a notification. This will return a URL immediately upon success but it may take several minutes for the CSV to become available at that URL depending on the volume of data. Only one export can be in-progress per OneSignal account at any given time.

Parameters:

  • notification_id (String) —

    The ID of the notification to export events from.

  • app_id (String) —

    The ID of the app that the notification belongs to.

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

    the optional parameters

Returns:

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

    ExportEventsSuccessResponse data, response status code and response headers



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
 
# File 'lib/onesignal/api/default_api.rb', line 1052

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

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

  # 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] || 'ExportEventsSuccessResponse'

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

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

#export_players(app_id, opts = {}) ⇒ ExportPlayersSuccessResponse

Export CSV of Players Generate a compressed CSV export of all of your current user data This method can be used to generate a compressed CSV export of all of your current user data. It is a much faster alternative than retrieving this data using the /players API endpoint. The file will be compressed using GZip. The file may take several minutes to generate depending on the number of users in your app. The URL generated will be available for 3 days and includes random v4 uuid as part of the resource name to be unguessable. &#x1F6A7; 403 Error Responses You can test if it is complete by making a GET request to the csv_file_url value. This file may take time to generate depending on how many device records are being pulled. If the file is not ready, a 403 error will be returned. Otherwise the file itself will be returned. &#x1F6A7; Requires Authentication Key Requires your OneSignal App’s REST API Key, available in Keys & IDs. &#x1F6A7; Concurrent Exports Only one concurrent export is allowed per OneSignal account. Please ensure you have successfully downloaded the .csv.gz file before exporting another app. CSV File Format: - Default Columns: | Field | Details | | — | — | | id | OneSignal Player Id | | identifier | Push Token | | session_count | Number of times they visited the app or site | language | Device language code | | timezone | Number of seconds away from UTC. Example: -28800 | | game_version | Version of your mobile app gathered from Android Studio versionCode in your App/build.gradle and iOS uses kCFBundleVersionKey in Xcode. | | device_os | Device Operating System Version. Example: 80 = Chrome 80, 9 = Android 9 | | device_type | Device Operating System Type | | device_model | Device Hardware String Code. Example: Mobile Web Subscribers will have ‘Linux armv` | | ad_id | Based on the Google Advertising Id for Android, identifierForVendor for iOS. OptedOut means user turned off Advertising tracking on the device. | | tags | Current OneSignal Data Tags on the device. | | last_active | Date and time the user last opened the mobile app or visited the site. | | playtime | Total amount of time in seconds the user had the mobile app open. | | amount_spent | Mobile only - amount spent in USD on In-App Purchases. | | created_at | Date and time the device record was created in OneSignal. Mobile - first time they opened the app with OneSignal SDK. Web - first time the user subscribed to the site. | | invalid_identifier | t = unsubscribed, f = subscibed | | badge_count | Current number of badges on the device | - Extra Columns: | Field | Details | | — | — | | external_user_id | Your User Id set on the device | | notification_types | Notification types | | location | Location points (Latitude and Longitude) set on the device. | | country | Country code | | rooted | Android device rooted or not | | ip | IP Address of the device if being tracked. See Handling Personal Data. | | web_auth | Web Only authorization key. | | web_p256 | Web Only p256 key. |

Parameters:

  • app_id (String) —

    The app ID that you want to export devices from

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

    the optional parameters

Options Hash (opts):

Returns:



1111
1112
1113
1114
 
# File 'lib/onesignal/api/default_api.rb', line 1111

def export_players(app_id, opts = {})
  data, _status_code, _headers = export_players_with_http_info(app_id, opts)
  data
end

#export_players_with_http_info(app_id, opts = {}) ⇒ Array<(ExportPlayersSuccessResponse, Integer, Hash)>

Export CSV of Players Generate a compressed CSV export of all of your current user data This method can be used to generate a compressed CSV export of all of your current user data. It is a much faster alternative than retrieving this data using the /players API endpoint. The file will be compressed using GZip. The file may take several minutes to generate depending on the number of users in your app. The URL generated will be available for 3 days and includes random v4 uuid as part of the resource name to be unguessable. &amp;#x1F6A7; 403 Error Responses You can test if it is complete by making a GET request to the csv_file_url value. This file may take time to generate depending on how many device records are being pulled. If the file is not ready, a 403 error will be returned. Otherwise the file itself will be returned. &amp;#x1F6A7; Requires Authentication Key Requires your OneSignal App&#39;s REST API Key, available in Keys &amp; IDs. &amp;#x1F6A7; Concurrent Exports Only one concurrent export is allowed per OneSignal account. Please ensure you have successfully downloaded the .csv.gz file before exporting another app. CSV File Format: - Default Columns: | Field | Details | | — | — | | id | OneSignal Player Id | | identifier | Push Token | | session_count | Number of times they visited the app or site | language | Device language code | | timezone | Number of seconds away from UTC. Example: -28800 | | game_version | Version of your mobile app gathered from Android Studio versionCode in your App/build.gradle and iOS uses kCFBundleVersionKey in Xcode. | | device_os | Device Operating System Version. Example: 80 &#x3D; Chrome 80, 9 &#x3D; Android 9 | | device_type | Device Operating System Type | | device_model | Device Hardware String Code. Example: Mobile Web Subscribers will have &#x60;Linux armv&#x60; | | ad_id | Based on the Google Advertising Id for Android, identifierForVendor for iOS. OptedOut means user turned off Advertising tracking on the device. | | tags | Current OneSignal Data Tags on the device. | | last_active | Date and time the user last opened the mobile app or visited the site. | | playtime | Total amount of time in seconds the user had the mobile app open. | | amount_spent | Mobile only - amount spent in USD on In-App Purchases. | | created_at | Date and time the device record was created in OneSignal. Mobile - first time they opened the app with OneSignal SDK. Web - first time the user subscribed to the site. | | invalid_identifier | t &#x3D; unsubscribed, f &#x3D; subscibed | | badge_count | Current number of badges on the device | - Extra Columns: | Field | Details | | — | — | | external_user_id | Your User Id set on the device | | notification_types | Notification types | | location | Location points (Latitude and Longitude) set on the device. | | country | Country code | | rooted | Android device rooted or not | | ip | IP Address of the device if being tracked. See Handling Personal Data. | | web_auth | Web Only authorization key. | | web_p256 | Web Only p256 key. |

Parameters:

  • app_id (String) —

    The app ID that you want to export devices from

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

    the optional parameters

Options Hash (opts):

Returns:



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/onesignal/api/default_api.rb', line 1122

def export_players_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.export_players ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.export_players"
  end
  # resource path
  local_var_path = '/players/csv_export?app_id={app_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_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'])
  # 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[:'export_players_request_body'])

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

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

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

#fetch_aliases(app_id, subscription_id, opts = {}) ⇒ UserIdentityResponse

Lists all Aliases for the User identified by :subscription_id.

Parameters:

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

    the optional parameters

Returns:



1180
1181
1182
1183
 
# File 'lib/onesignal/api/default_api.rb', line 1180

def fetch_aliases(app_id, subscription_id, opts = {})
  data, _status_code, _headers = fetch_aliases_with_http_info(app_id, subscription_id, opts)
  data
end

#fetch_aliases_with_http_info(app_id, subscription_id, opts = {}) ⇒ Array<(UserIdentityResponse, Integer, Hash)>

Lists all Aliases for the User identified by :subscription_id.

Parameters:

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

    the optional parameters

Returns:

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

    UserIdentityResponse data, response status code and response headers



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'lib/onesignal/api/default_api.rb', line 1190

def fetch_aliases_with_http_info(app_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.fetch_aliases ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.fetch_aliases"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DefaultApi.fetch_aliases"
  end
  # resource path
  local_var_path = '/apps/{app_id}/subscriptions/{subscription_id}/user/identity'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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'])

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

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

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

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

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

#fetch_user(app_id, alias_label, alias_id, opts = {}) ⇒ User

Returns the User’s properties, Aliases, and Subscriptions.

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1248
1249
1250
1251
 
# File 'lib/onesignal/api/default_api.rb', line 1248

def fetch_user(app_id, alias_label, alias_id, opts = {})
  data, _status_code, _headers = fetch_user_with_http_info(app_id, alias_label, alias_id, opts)
  data
end

#fetch_user_identity(app_id, alias_label, alias_id, opts = {}) ⇒ InlineResponse200

Lists all Aliases for the User identified by (:alias_label, :alias_id).

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1321
1322
1323
1324
 
# File 'lib/onesignal/api/default_api.rb', line 1321

def fetch_user_identity(app_id, alias_label, alias_id, opts = {})
  data, _status_code, _headers = fetch_user_identity_with_http_info(app_id, alias_label, alias_id, opts)
  data
end

#fetch_user_identity_with_http_info(app_id, alias_label, alias_id, opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Lists all Aliases for the User identified by (:alias_label, :alias_id).

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    InlineResponse200 data, response status code and response headers



1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/onesignal/api/default_api.rb', line 1332

def fetch_user_identity_with_http_info(app_id, alias_label, alias_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.fetch_user_identity ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.fetch_user_identity"
  end
  # verify the required parameter 'alias_label' is set
  if @api_client.config.client_side_validation && alias_label.nil?
    fail ArgumentError, "Missing the required parameter 'alias_label' when calling DefaultApi.fetch_user_identity"
  end
  # verify the required parameter 'alias_id' is set
  if @api_client.config.client_side_validation && alias_id.nil?
    fail ArgumentError, "Missing the required parameter 'alias_id' when calling DefaultApi.fetch_user_identity"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/by/{alias_label}/{alias_id}/identity'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'alias_label' + '}', CGI.escape(alias_label.to_s)).sub('{' + 'alias_id' + '}', CGI.escape(alias_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'])

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

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

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

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

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

#fetch_user_with_http_info(app_id, alias_label, alias_id, opts = {}) ⇒ Array<(User, Integer, Hash)>

Returns the User’s properties, Aliases, and Subscriptions.

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    User data, response status code and response headers



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'lib/onesignal/api/default_api.rb', line 1259

def fetch_user_with_http_info(app_id, alias_label, alias_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.fetch_user ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.fetch_user"
  end
  # verify the required parameter 'alias_label' is set
  if @api_client.config.client_side_validation && alias_label.nil?
    fail ArgumentError, "Missing the required parameter 'alias_label' when calling DefaultApi.fetch_user"
  end
  # verify the required parameter 'alias_id' is set
  if @api_client.config.client_side_validation && alias_id.nil?
    fail ArgumentError, "Missing the required parameter 'alias_id' when calling DefaultApi.fetch_user"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/by/{alias_label}/{alias_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'alias_label' + '}', CGI.escape(alias_label.to_s)).sub('{' + 'alias_id' + '}', CGI.escape(alias_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'])

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

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

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

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

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

#get_app(app_id, opts = {}) ⇒ App

View an app View the details of a single OneSignal app

Parameters:

  • app_id (String) —

    An app id

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

    the optional parameters

Returns:



1393
1394
1395
1396
 
# File 'lib/onesignal/api/default_api.rb', line 1393

def get_app(app_id, opts = {})
  data, _status_code, _headers = get_app_with_http_info(app_id, opts)
  data
end

#get_app_with_http_info(app_id, opts = {}) ⇒ Array<(App, Integer, Hash)>

View an app View the details of a single OneSignal app

Parameters:

  • app_id (String) —

    An app id

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

    the optional parameters

Returns:

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

    App data, response status code and response headers



1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
 
# File 'lib/onesignal/api/default_api.rb', line 1403

def get_app_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_app ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.get_app"
  end
  # resource path
  local_var_path = '/apps/{app_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_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'])

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

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

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

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

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

#get_apps(opts = {}) ⇒ Array<App>

View apps View the details of all of your current OneSignal apps

Parameters:

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

    the optional parameters

Returns:



1455
1456
1457
1458
 
# File 'lib/onesignal/api/default_api.rb', line 1455

def get_apps(opts = {})
  data, _status_code, _headers = get_apps_with_http_info(opts)
  data
end

#get_apps_with_http_info(opts = {}) ⇒ Array<(Array<App>, Integer, Hash)>

View apps View the details of all of your current OneSignal apps

Parameters:

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

    the optional parameters

Returns:

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

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



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
 
# File 'lib/onesignal/api/default_api.rb', line 1464

def get_apps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_apps ...'
  end
  # resource path
  local_var_path = '/apps'

  # 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] || 'Array<App>'

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

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

#get_eligible_iams(app_id, subscription_id, opts = {}) ⇒ InlineResponse2003

Manifest of In-App Messages the Subscription is eligible to display by the SDK.

Parameters:

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

    the optional parameters

Returns:



1513
1514
1515
1516
 
# File 'lib/onesignal/api/default_api.rb', line 1513

def get_eligible_iams(app_id, subscription_id, opts = {})
  data, _status_code, _headers = get_eligible_iams_with_http_info(app_id, subscription_id, opts)
  data
end

#get_eligible_iams_with_http_info(app_id, subscription_id, opts = {}) ⇒ Array<(InlineResponse2003, Integer, Hash)>

Manifest of In-App Messages the Subscription is eligible to display by the SDK.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse2003 data, response status code and response headers



1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
 
# File 'lib/onesignal/api/default_api.rb', line 1523

def get_eligible_iams_with_http_info(app_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_eligible_iams ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.get_eligible_iams"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DefaultApi.get_eligible_iams"
  end
  # resource path
  local_var_path = '/apps/{app_id}/subscriptions/{subscription_id}/iams'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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'])

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

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

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

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

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

#get_notification(app_id, notification_id, opts = {}) ⇒ NotificationWithMeta

View notification View the details of a single notification and outcomes associated with it

Parameters:

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

    the optional parameters

Returns:



1581
1582
1583
1584
 
# File 'lib/onesignal/api/default_api.rb', line 1581

def get_notification(app_id, notification_id, opts = {})
  data, _status_code, _headers = get_notification_with_http_info(app_id, notification_id, opts)
  data
end

#get_notification_history(notification_id, get_notification_request_body, opts = {}) ⇒ NotificationHistorySuccessResponse

Notification History -> View the devices sent a message - OneSignal Paid Plan Required This method will return all devices that were sent the given notification_id of an Email or Push Notification if used within 7 days of the date sent. After 7 days of the sending date, the message history data will be unavailable. After a successful response is received, the destination url may be polled until the file becomes available. Most exports are done in ~1-3 minutes, so setting a poll interval of 10 seconds should be adequate. For use cases that are not meant to be consumed by a script, an email will be sent to the supplied email address. &#x1F6A7; Requirements A OneSignal Paid Plan. Turn on Send History via OneSignal API in Settings -> Analytics. Cannot get data before this was turned on. Must be called within 7 days after sending the message. Messages targeting under 1000 recipients will not have "sent" events recorded, but will show "clicked" events. Requires your OneSignal App’s REST API Key, available in Keys & IDs.

Parameters:

  • notification_id (String) —

    The &quot;id&quot; of the message found in the Notification object

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

    the optional parameters

Returns:



1651
1652
1653
1654
 
# File 'lib/onesignal/api/default_api.rb', line 1651

def get_notification_history(notification_id, get_notification_request_body, opts = {})
  data, _status_code, _headers = get_notification_history_with_http_info(notification_id, get_notification_request_body, opts)
  data
end

#get_notification_history_with_http_info(notification_id, get_notification_request_body, opts = {}) ⇒ Array<(NotificationHistorySuccessResponse, Integer, Hash)>

Notification History -&gt; View the devices sent a message - OneSignal Paid Plan Required This method will return all devices that were sent the given notification_id of an Email or Push Notification if used within 7 days of the date sent. After 7 days of the sending date, the message history data will be unavailable. After a successful response is received, the destination url may be polled until the file becomes available. Most exports are done in ~1-3 minutes, so setting a poll interval of 10 seconds should be adequate. For use cases that are not meant to be consumed by a script, an email will be sent to the supplied email address. &amp;#x1F6A7; Requirements A OneSignal Paid Plan. Turn on Send History via OneSignal API in Settings -&gt; Analytics. Cannot get data before this was turned on. Must be called within 7 days after sending the message. Messages targeting under 1000 recipients will not have &quot;sent&quot; events recorded, but will show &quot;clicked&quot; events. Requires your OneSignal App&#39;s REST API Key, available in Keys &amp; IDs.

Parameters:

  • notification_id (String) —

    The &quot;id&quot; of the message found in the Notification object

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

    the optional parameters

Returns:



1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
 
# File 'lib/onesignal/api/default_api.rb', line 1662

def get_notification_history_with_http_info(notification_id, get_notification_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_notification_history ...'
  end
  # verify the required parameter 'notification_id' is set
  if @api_client.config.client_side_validation && notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_id' when calling DefaultApi.get_notification_history"
  end
  # verify the required parameter 'get_notification_request_body' is set
  if @api_client.config.client_side_validation && get_notification_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'get_notification_request_body' when calling DefaultApi.get_notification_history"
  end
  # resource path
  local_var_path = '/notifications/{notification_id}/history'.sub('{' + 'notification_id' + '}', CGI.escape(notification_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'])
  # 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(get_notification_request_body)

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

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

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

#get_notification_with_http_info(app_id, notification_id, opts = {}) ⇒ Array<(NotificationWithMeta, Integer, Hash)>

View notification View the details of a single notification and outcomes associated with it

Parameters:

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

    the optional parameters

Returns:

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

    NotificationWithMeta data, response status code and response headers



1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
 
# File 'lib/onesignal/api/default_api.rb', line 1592

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

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

  # 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] || 'NotificationWithMeta'

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

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

#get_notifications(app_id, opts = {}) ⇒ NotificationSlice

View notifications View the details of multiple notifications

Parameters:

  • app_id (String) —

    The app ID that you want to view notifications from

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    How many notifications to return. Max is 50. Default is 50.

  • :offset (Integer) —

    Page offset. Default is 0. Results are sorted by queued_at in descending order. queued_at is a representation of the time that the notification was queued at.

  • :kind (Integer) —

    Kind of notifications returned: * unset - All notification types (default) * &#x60;0&#x60; - Dashboard only * &#x60;1&#x60; - API only * &#x60;3&#x60; - Automated only

Returns:



1727
1728
1729
1730
 
# File 'lib/onesignal/api/default_api.rb', line 1727

def get_notifications(app_id, opts = {})
  data, _status_code, _headers = get_notifications_with_http_info(app_id, opts)
  data
end

#get_notifications_with_http_info(app_id, opts = {}) ⇒ Array<(NotificationSlice, Integer, Hash)>

View notifications View the details of multiple notifications

Parameters:

  • app_id (String) —

    The app ID that you want to view notifications from

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    How many notifications to return. Max is 50. Default is 50.

  • :offset (Integer) —

    Page offset. Default is 0. Results are sorted by queued_at in descending order. queued_at is a representation of the time that the notification was queued at.

  • :kind (Integer) —

    Kind of notifications returned: * unset - All notification types (default) * &#x60;0&#x60; - Dashboard only * &#x60;1&#x60; - API only * &#x60;3&#x60; - Automated only

Returns:

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

    NotificationSlice data, response status code and response headers



1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
 
# File 'lib/onesignal/api/default_api.rb', line 1740

def get_notifications_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_notifications ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.get_notifications"
  end
  allowable_values = [0, 1, 3]
  if @api_client.config.client_side_validation && opts[:'kind'] && !allowable_values.include?(opts[:'kind'])
    fail ArgumentError, "invalid value for \"kind\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/notifications'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'app_id'] = app_id
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'kind'] = opts[:'kind'] if !opts[:'kind'].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] || 'NotificationSlice'

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

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

#get_outcomes(app_id, outcome_names, opts = {}) ⇒ OutcomesData

View Outcomes View the details of all the outcomes associated with your app &#x1F6A7; Requires Authentication Key Requires your OneSignal App’s REST API Key, available in Keys & IDs. &#x1F6A7; Outcome Data Limitations Outcomes are only accessible for around 30 days before deleted from our servers. You will need to export this data every month if you want to keep it.

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • outcome_names (String) —

    Required Comma-separated list of names and the value (sum/count) for the returned outcome data. Note: Clicks only support count aggregation. For out-of-the-box OneSignal outcomes such as click and session duration, please use the &quot;os&quot; prefix with two underscores. For other outcomes, please use the name specified by the user. Example:os__session_duration.count,os__click.count,CustomOutcomeName.sum

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

    the optional parameters

Options Hash (opts):

  • :outcome_names2 (String) —

    Optional If outcome names contain any commas, then please specify only one value at a time. Example: outcome_names[]&#x3D;os__click.count&amp;outcome_names&#x3D;Sales, Purchase.count where &quot;Sales, Purchase&quot; is the custom outcomes with a comma in the name.

  • :outcome_time_range (String) —

    Optional Time range for the returned data. The values can be 1h (for the last 1 hour data), 1d (for the last 1 day data), or 1mo (for the last 1 month data). Default is 1h if the parameter is omitted.

  • :outcome_platforms (String) —

    Optional Platform id. Refer device&#39;s platform ids for values. Example: outcome_platform&#x3D;0 for iOS outcome_platform&#x3D;7,8 for Safari and Firefox Default is data from all platforms if the parameter is omitted.

  • :outcome_attribution (String) —

    Optional Attribution type for the outcomes. The values can be direct or influenced or unattributed. Example: outcome_attribution&#x3D;direct Default is total (returns direct+influenced+unattributed) if the parameter is omitted.

Returns:



1806
1807
1808
1809
 
# File 'lib/onesignal/api/default_api.rb', line 1806

def get_outcomes(app_id, outcome_names, opts = {})
  data, _status_code, _headers = get_outcomes_with_http_info(app_id, outcome_names, opts)
  data
end

#get_outcomes_with_http_info(app_id, outcome_names, opts = {}) ⇒ Array<(OutcomesData, Integer, Hash)>

View Outcomes View the details of all the outcomes associated with your app &amp;#x1F6A7; Requires Authentication Key Requires your OneSignal App&#39;s REST API Key, available in Keys &amp; IDs. &amp;#x1F6A7; Outcome Data Limitations Outcomes are only accessible for around 30 days before deleted from our servers. You will need to export this data every month if you want to keep it.

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • outcome_names (String) —

    Required Comma-separated list of names and the value (sum/count) for the returned outcome data. Note: Clicks only support count aggregation. For out-of-the-box OneSignal outcomes such as click and session duration, please use the &quot;os&quot; prefix with two underscores. For other outcomes, please use the name specified by the user. Example:os__session_duration.count,os__click.count,CustomOutcomeName.sum

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

    the optional parameters

Options Hash (opts):

  • :outcome_names2 (String) —

    Optional If outcome names contain any commas, then please specify only one value at a time. Example: outcome_names[]&#x3D;os__click.count&amp;outcome_names&#x3D;Sales, Purchase.count where &quot;Sales, Purchase&quot; is the custom outcomes with a comma in the name.

  • :outcome_time_range (String) —

    Optional Time range for the returned data. The values can be 1h (for the last 1 hour data), 1d (for the last 1 day data), or 1mo (for the last 1 month data). Default is 1h if the parameter is omitted.

  • :outcome_platforms (String) —

    Optional Platform id. Refer device&#39;s platform ids for values. Example: outcome_platform&#x3D;0 for iOS outcome_platform&#x3D;7,8 for Safari and Firefox Default is data from all platforms if the parameter is omitted.

  • :outcome_attribution (String) —

    Optional Attribution type for the outcomes. The values can be direct or influenced or unattributed. Example: outcome_attribution&#x3D;direct Default is total (returns direct+influenced+unattributed) if the parameter is omitted.

Returns:

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

    OutcomesData data, response status code and response headers



1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
 
# File 'lib/onesignal/api/default_api.rb', line 1821

def get_outcomes_with_http_info(app_id, outcome_names, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_outcomes ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.get_outcomes"
  end
  # verify the required parameter 'outcome_names' is set
  if @api_client.config.client_side_validation && outcome_names.nil?
    fail ArgumentError, "Missing the required parameter 'outcome_names' when calling DefaultApi.get_outcomes"
  end
  # resource path
  local_var_path = '/apps/{app_id}/outcomes'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'outcome_names'] = outcome_names
  query_params[:'outcome_names[]'] = opts[:'outcome_names2'] if !opts[:'outcome_names2'].nil?
  query_params[:'outcome_time_range'] = opts[:'outcome_time_range'] if !opts[:'outcome_time_range'].nil?
  query_params[:'outcome_platforms'] = opts[:'outcome_platforms'] if !opts[:'outcome_platforms'].nil?
  query_params[:'outcome_attribution'] = opts[:'outcome_attribution'] if !opts[:'outcome_attribution'].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] || 'OutcomesData'

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

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

#get_player(app_id, player_id, opts = {}) ⇒ Player

View device View the details of an existing device in one of your OneSignal apps

Parameters:

  • app_id (String) —

    Your app_id for this device

  • player_id (String) —

    Player&#39;s OneSignal ID

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

    the optional parameters

Options Hash (opts):

  • :email_auth_hash (String) —

    Email - Only required if you have enabled Identity Verification and device_type is email (11).

Returns:



1885
1886
1887
1888
 
# File 'lib/onesignal/api/default_api.rb', line 1885

def get_player(app_id, player_id, opts = {})
  data, _status_code, _headers = get_player_with_http_info(app_id, player_id, opts)
  data
end

#get_player_with_http_info(app_id, player_id, opts = {}) ⇒ Array<(Player, Integer, Hash)>

View device View the details of an existing device in one of your OneSignal apps

Parameters:

  • app_id (String) —

    Your app_id for this device

  • player_id (String) —

    Player&#39;s OneSignal ID

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

    the optional parameters

Options Hash (opts):

  • :email_auth_hash (String) —

    Email - Only required if you have enabled Identity Verification and device_type is email (11).

Returns:

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

    Player data, response status code and response headers



1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
 
# File 'lib/onesignal/api/default_api.rb', line 1897

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'app_id'] = app_id
  query_params[:'email_auth_hash'] = opts[:'email_auth_hash'] if !opts[:'email_auth_hash'].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] || 'Player'

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

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

#get_players(app_id, opts = {}) ⇒ PlayerSlice

View devices View the details of multiple devices in one of your OneSignal apps Unavailable for Apps Over 80,000 Users For performance reasons, this method is not available for larger apps. Larger apps should use the CSV export API endpoint, which is much more performant.

Parameters:

  • app_id (String) —

    The app ID that you want to view players from

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    How many devices to return. Max is 300. Default is 300

  • :offset (Integer) —

    Result offset. Default is 0. Results are sorted by id;

Returns:



1958
1959
1960
1961
 
# File 'lib/onesignal/api/default_api.rb', line 1958

def get_players(app_id, opts = {})
  data, _status_code, _headers = get_players_with_http_info(app_id, opts)
  data
end

#get_players_with_http_info(app_id, opts = {}) ⇒ Array<(PlayerSlice, Integer, Hash)>

View devices View the details of multiple devices in one of your OneSignal apps Unavailable for Apps Over 80,000 Users For performance reasons, this method is not available for larger apps. Larger apps should use the CSV export API endpoint, which is much more performant.

Parameters:

  • app_id (String) —

    The app ID that you want to view players from

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    How many devices to return. Max is 300. Default is 300

  • :offset (Integer) —

    Result offset. Default is 0. Results are sorted by id;

Returns:

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

    PlayerSlice data, response status code and response headers



1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
 
# File 'lib/onesignal/api/default_api.rb', line 1970

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'app_id'] = app_id
  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] || 'PlayerSlice'

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

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

#identify_user_by_alias(app_id, alias_label, alias_id, user_identity_request_body, opts = {}) ⇒ InlineResponse200

Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • user_identity_request_body (UserIdentityRequestBody)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2028
2029
2030
2031
 
# File 'lib/onesignal/api/default_api.rb', line 2028

def identify_user_by_alias(app_id, alias_label, alias_id, user_identity_request_body, opts = {})
  data, _status_code, _headers = identify_user_by_alias_with_http_info(app_id, alias_label, alias_id, user_identity_request_body, opts)
  data
end

#identify_user_by_alias_with_http_info(app_id, alias_label, alias_id, user_identity_request_body, opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • user_identity_request_body (UserIdentityRequestBody)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    InlineResponse200 data, response status code and response headers



2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
 
# File 'lib/onesignal/api/default_api.rb', line 2040

def identify_user_by_alias_with_http_info(app_id, alias_label, alias_id, user_identity_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.identify_user_by_alias ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.identify_user_by_alias"
  end
  # verify the required parameter 'alias_label' is set
  if @api_client.config.client_side_validation && alias_label.nil?
    fail ArgumentError, "Missing the required parameter 'alias_label' when calling DefaultApi.identify_user_by_alias"
  end
  # verify the required parameter 'alias_id' is set
  if @api_client.config.client_side_validation && alias_id.nil?
    fail ArgumentError, "Missing the required parameter 'alias_id' when calling DefaultApi.identify_user_by_alias"
  end
  # verify the required parameter 'user_identity_request_body' is set
  if @api_client.config.client_side_validation && user_identity_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'user_identity_request_body' when calling DefaultApi.identify_user_by_alias"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/by/{alias_label}/{alias_id}/identity'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'alias_label' + '}', CGI.escape(alias_label.to_s)).sub('{' + 'alias_id' + '}', CGI.escape(alias_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'])
  # 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(user_identity_request_body)

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

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

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

#identify_user_by_subscription_id(app_id, subscription_id, user_identity_request_body, opts = {}) ⇒ UserIdentityResponse

Upserts one or more Aliases for the User identified by :subscription_id.

Parameters:

  • app_id (String)
  • subscription_id (String)
  • user_identity_request_body (UserIdentityRequestBody)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2111
2112
2113
2114
 
# File 'lib/onesignal/api/default_api.rb', line 2111

def identify_user_by_subscription_id(app_id, subscription_id, user_identity_request_body, opts = {})
  data, _status_code, _headers = identify_user_by_subscription_id_with_http_info(app_id, subscription_id, user_identity_request_body, opts)
  data
end

#identify_user_by_subscription_id_with_http_info(app_id, subscription_id, user_identity_request_body, opts = {}) ⇒ Array<(UserIdentityResponse, Integer, Hash)>

Upserts one or more Aliases for the User identified by :subscription_id.

Parameters:

  • app_id (String)
  • subscription_id (String)
  • user_identity_request_body (UserIdentityRequestBody)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    UserIdentityResponse data, response status code and response headers



2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
 
# File 'lib/onesignal/api/default_api.rb', line 2122

def identify_user_by_subscription_id_with_http_info(app_id, subscription_id, user_identity_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.identify_user_by_subscription_id ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.identify_user_by_subscription_id"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DefaultApi.identify_user_by_subscription_id"
  end
  # verify the required parameter 'user_identity_request_body' is set
  if @api_client.config.client_side_validation && user_identity_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'user_identity_request_body' when calling DefaultApi.identify_user_by_subscription_id"
  end
  # resource path
  local_var_path = '/apps/{app_id}/subscriptions/{subscription_id}/user/identity'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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'])
  # 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(user_identity_request_body)

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

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

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

#transfer_subscription(app_id, subscription_id, transfer_subscription_request_body, opts = {}) ⇒ UserIdentityResponse

Transfers this Subscription to the User identified by the identity in the payload.

Parameters:

  • app_id (String)
  • subscription_id (String)
  • transfer_subscription_request_body (TransferSubscriptionRequestBody)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2189
2190
2191
2192
 
# File 'lib/onesignal/api/default_api.rb', line 2189

def transfer_subscription(app_id, subscription_id, transfer_subscription_request_body, opts = {})
  data, _status_code, _headers = transfer_subscription_with_http_info(app_id, subscription_id, transfer_subscription_request_body, opts)
  data
end

#transfer_subscription_with_http_info(app_id, subscription_id, transfer_subscription_request_body, opts = {}) ⇒ Array<(UserIdentityResponse, Integer, Hash)>

Transfers this Subscription to the User identified by the identity in the payload.

Parameters:

  • app_id (String)
  • subscription_id (String)
  • transfer_subscription_request_body (TransferSubscriptionRequestBody)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    UserIdentityResponse data, response status code and response headers



2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
 
# File 'lib/onesignal/api/default_api.rb', line 2200

def transfer_subscription_with_http_info(app_id, subscription_id, transfer_subscription_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.transfer_subscription ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.transfer_subscription"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DefaultApi.transfer_subscription"
  end
  # verify the required parameter 'transfer_subscription_request_body' is set
  if @api_client.config.client_side_validation && transfer_subscription_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_subscription_request_body' when calling DefaultApi.transfer_subscription"
  end
  # resource path
  local_var_path = '/apps/{app_id}/subscriptions/{subscription_id}/owner'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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'])
  # 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(transfer_subscription_request_body)

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

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

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

#update_app(app_id, app, opts = {}) ⇒ App

Update an app Updates the name or configuration settings of an existing OneSignal app

Parameters:

  • app_id (String) —

    An app id

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

    the optional parameters

Returns:



2267
2268
2269
2270
 
# File 'lib/onesignal/api/default_api.rb', line 2267

def update_app(app_id, app, opts = {})
  data, _status_code, _headers = update_app_with_http_info(app_id, app, opts)
  data
end

#update_app_with_http_info(app_id, app, opts = {}) ⇒ Array<(App, Integer, Hash)>

Update an app Updates the name or configuration settings of an existing OneSignal app

Parameters:

  • app_id (String) —

    An app id

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

    the optional parameters

Returns:

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

    App data, response status code and response headers



2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
 
# File 'lib/onesignal/api/default_api.rb', line 2278

def update_app_with_http_info(app_id, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_app ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.update_app"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling DefaultApi.update_app"
  end
  # resource path
  local_var_path = '/apps/{app_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_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'])
  # 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(app)

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

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

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

#update_live_activity(app_id, activity_id, update_live_activity_request, opts = {}) ⇒ UpdateLiveActivitySuccessResponse

Update a Live Activity via Push Updates a specified live activity.

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • activity_id (String) —

    Live Activity record ID

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

    the optional parameters

Returns:



2342
2343
2344
2345
 
# File 'lib/onesignal/api/default_api.rb', line 2342

def update_live_activity(app_id, activity_id, update_live_activity_request, opts = {})
  data, _status_code, _headers = update_live_activity_with_http_info(app_id, activity_id, update_live_activity_request, opts)
  data
end

#update_live_activity_with_http_info(app_id, activity_id, update_live_activity_request, opts = {}) ⇒ Array<(UpdateLiveActivitySuccessResponse, Integer, Hash)>

Update a Live Activity via Push Updates a specified live activity.

Parameters:

  • app_id (String) —

    The OneSignal App ID for your app. Available in Keys &amp; IDs.

  • activity_id (String) —

    Live Activity record ID

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

    the optional parameters

Returns:



2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
 
# File 'lib/onesignal/api/default_api.rb', line 2354

def update_live_activity_with_http_info(app_id, activity_id, update_live_activity_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_live_activity ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.update_live_activity"
  end
  # verify the required parameter 'activity_id' is set
  if @api_client.config.client_side_validation && activity_id.nil?
    fail ArgumentError, "Missing the required parameter 'activity_id' when calling DefaultApi.update_live_activity"
  end
  # verify the required parameter 'update_live_activity_request' is set
  if @api_client.config.client_side_validation && update_live_activity_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_live_activity_request' when calling DefaultApi.update_live_activity"
  end
  # resource path
  local_var_path = '/apps/{app_id}/live_activities/{activity_id}/notifications'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'activity_id' + '}', CGI.escape(activity_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'])
  # 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(update_live_activity_request)

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

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

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

#update_player(player_id, player, opts = {}) ⇒ UpdatePlayerSuccessResponse

Edit device Update an existing device in one of your OneSignal apps

Parameters:

  • player_id (String) —

    Player&#39;s OneSignal ID

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

    the optional parameters

Returns:



2421
2422
2423
2424
 
# File 'lib/onesignal/api/default_api.rb', line 2421

def update_player(player_id, player, opts = {})
  data, _status_code, _headers = update_player_with_http_info(player_id, player, opts)
  data
end

#update_player_tags(app_id, external_user_id, opts = {}) ⇒ UpdatePlayerTagsSuccessResponse

Edit tags with external user id Update an existing device’s tags in one of your OneSignal apps using the External User ID. Warning - Android SDK Data Synchronization Tags added through the Android SDK tagging methods may not update if using the API to change or update the same tag. For example, if you use SDK method sendTag("key", "value1") then update the tag value to "value2" with this API endpoint. You will not be able to set the value back to "value1" through the SDK, you will need to change it to something different through the SDK to be reset. Recommendations if using this Endpoint on Android Mobile Apps: 1 - Do not use the same tag keys for SDK and API updates 2 - If you want to use the same key for both SDK and API updates, call the SDK getTags method first to update the device’s tags. This is only applicable on the Android Mobile App SDKs. &#128216; Deleting Tags To delete a tag, include its key and set its value to blank. Omitting a key/value will not delete it. For example, if I wanted to delete two existing tags rank and category while simultaneously adding a new tag class, the tags JSON would look like the following: "tags": { "rank": "", "category": "", "class": "my_new_value" }

Parameters:

  • app_id (String) —

    The OneSignal App ID the user record is found under.

  • external_user_id (String) —

    The External User ID mapped to teh device record in OneSignal. Must be actively set on the device to be updated.

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

    the optional parameters

Options Hash (opts):

Returns:



2496
2497
2498
2499
 
# File 'lib/onesignal/api/default_api.rb', line 2496

def update_player_tags(app_id, external_user_id, opts = {})
  data, _status_code, _headers = update_player_tags_with_http_info(app_id, external_user_id, opts)
  data
end

#update_player_tags_with_http_info(app_id, external_user_id, opts = {}) ⇒ Array<(UpdatePlayerTagsSuccessResponse, Integer, Hash)>

Edit tags with external user id Update an existing device&#39;s tags in one of your OneSignal apps using the External User ID. Warning - Android SDK Data Synchronization Tags added through the Android SDK tagging methods may not update if using the API to change or update the same tag. For example, if you use SDK method sendTag(&quot;key&quot;, &quot;value1&quot;) then update the tag value to &quot;value2&quot; with this API endpoint. You will not be able to set the value back to &quot;value1&quot; through the SDK, you will need to change it to something different through the SDK to be reset. Recommendations if using this Endpoint on Android Mobile Apps: 1 - Do not use the same tag keys for SDK and API updates 2 - If you want to use the same key for both SDK and API updates, call the SDK getTags method first to update the device&#39;s tags. This is only applicable on the Android Mobile App SDKs. &amp;#128216; Deleting Tags To delete a tag, include its key and set its value to blank. Omitting a key/value will not delete it. For example, if I wanted to delete two existing tags rank and category while simultaneously adding a new tag class, the tags JSON would look like the following: &quot;tags&quot;: { &quot;rank&quot;: &quot;&quot;, &quot;category&quot;: &quot;&quot;, &quot;class&quot;: &quot;my_new_value&quot; }

Parameters:

  • app_id (String) —

    The OneSignal App ID the user record is found under.

  • external_user_id (String) —

    The External User ID mapped to teh device record in OneSignal. Must be actively set on the device to be updated.

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

    the optional parameters

Options Hash (opts):

Returns:



2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
 
# File 'lib/onesignal/api/default_api.rb', line 2508

def update_player_tags_with_http_info(app_id, external_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_player_tags ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.update_player_tags"
  end
  # verify the required parameter 'external_user_id' is set
  if @api_client.config.client_side_validation && external_user_id.nil?
    fail ArgumentError, "Missing the required parameter 'external_user_id' when calling DefaultApi.update_player_tags"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/{external_user_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'external_user_id' + '}', CGI.escape(external_user_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'])
  # 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_player_tags_request_body'])

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

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

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

#update_player_with_http_info(player_id, player, opts = {}) ⇒ Array<(UpdatePlayerSuccessResponse, Integer, Hash)>

Edit device Update an existing device in one of your OneSignal apps

Parameters:

  • player_id (String) —

    Player&#39;s OneSignal ID

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

    the optional parameters

Returns:

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

    UpdatePlayerSuccessResponse data, response status code and response headers



2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
 
# File 'lib/onesignal/api/default_api.rb', line 2432

def update_player_with_http_info(player_id, player, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_player ...'
  end
  # verify the required parameter 'player_id' is set
  if @api_client.config.client_side_validation && player_id.nil?
    fail ArgumentError, "Missing the required parameter 'player_id' when calling DefaultApi.update_player"
  end
  # verify the required parameter 'player' is set
  if @api_client.config.client_side_validation && player.nil?
    fail ArgumentError, "Missing the required parameter 'player' when calling DefaultApi.update_player"
  end
  # resource path
  local_var_path = '/players/{player_id}'.sub('{' + 'player_id' + '}', CGI.escape(player_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'])
  # 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(player)

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

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

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

#update_subscription(app_id, subscription_id, update_subscription_request_body, opts = {}) ⇒ nil

Updates an existing Subscription’s properties.

Parameters:

  • app_id (String)
  • subscription_id (String)
  • update_subscription_request_body (UpdateSubscriptionRequestBody)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2571
2572
2573
2574
 
# File 'lib/onesignal/api/default_api.rb', line 2571

def update_subscription(app_id, subscription_id, update_subscription_request_body, opts = {})
  update_subscription_with_http_info(app_id, subscription_id, update_subscription_request_body, opts)
  nil
end

#update_subscription_with_http_info(app_id, subscription_id, update_subscription_request_body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Updates an existing Subscription’s properties.

Parameters:

  • app_id (String)
  • subscription_id (String)
  • update_subscription_request_body (UpdateSubscriptionRequestBody)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
 
# File 'lib/onesignal/api/default_api.rb', line 2582

def update_subscription_with_http_info(app_id, subscription_id, update_subscription_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_subscription ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.update_subscription"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DefaultApi.update_subscription"
  end
  # verify the required parameter 'update_subscription_request_body' is set
  if @api_client.config.client_side_validation && update_subscription_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'update_subscription_request_body' when calling DefaultApi.update_subscription"
  end
  # resource path
  local_var_path = '/apps/{app_id}/subscriptions/{subscription_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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'])
  # 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(update_subscription_request_body)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#update_user(app_id, alias_label, alias_id, update_user_request, opts = {}) ⇒ InlineResponse202

Updates an existing User’s properties.

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • update_user_request (UpdateUserRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2650
2651
2652
2653
 
# File 'lib/onesignal/api/default_api.rb', line 2650

def update_user(app_id, alias_label, alias_id, update_user_request, opts = {})
  data, _status_code, _headers = update_user_with_http_info(app_id, alias_label, alias_id, update_user_request, opts)
  data
end

#update_user_with_http_info(app_id, alias_label, alias_id, update_user_request, opts = {}) ⇒ Array<(InlineResponse202, Integer, Hash)>

Updates an existing User’s properties.

Parameters:

  • app_id (String)
  • alias_label (String)
  • alias_id (String)
  • update_user_request (UpdateUserRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    InlineResponse202 data, response status code and response headers



2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
 
# File 'lib/onesignal/api/default_api.rb', line 2662

def update_user_with_http_info(app_id, alias_label, alias_id, update_user_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_user ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.update_user"
  end
  # verify the required parameter 'alias_label' is set
  if @api_client.config.client_side_validation && alias_label.nil?
    fail ArgumentError, "Missing the required parameter 'alias_label' when calling DefaultApi.update_user"
  end
  # verify the required parameter 'alias_id' is set
  if @api_client.config.client_side_validation && alias_id.nil?
    fail ArgumentError, "Missing the required parameter 'alias_id' when calling DefaultApi.update_user"
  end
  # verify the required parameter 'update_user_request' is set
  if @api_client.config.client_side_validation && update_user_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_user_request' when calling DefaultApi.update_user"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/by/{alias_label}/{alias_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'alias_label' + '}', CGI.escape(alias_label.to_s)).sub('{' + 'alias_id' + '}', CGI.escape(alias_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'])
  # 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(update_user_request)

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

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

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