@onesignal/node-onesignal 1.0.0-beta8 → 2.0.0-beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (184) hide show
  1. package/.github/workflows/Zapier.yml +34 -0
  2. package/CHANGELOG.md +15 -0
  3. package/DefaultApi.md +988 -3
  4. package/README.md +152 -24
  5. package/apis/DefaultApi.ts +1339 -98
  6. package/dist/apis/DefaultApi.d.ts +39 -0
  7. package/dist/apis/DefaultApi.js +1490 -408
  8. package/dist/apis/DefaultApi.js.map +1 -1
  9. package/dist/models/BasicNotification.d.ts +4 -0
  10. package/dist/models/BasicNotification.js +12 -0
  11. package/dist/models/BasicNotification.js.map +1 -1
  12. package/dist/models/CreateNotificationSuccessResponse.d.ts +2 -2
  13. package/dist/models/CreateSubscriptionRequestBody.d.ts +19 -0
  14. package/dist/models/CreateSubscriptionRequestBody.js +28 -0
  15. package/dist/models/CreateSubscriptionRequestBody.js.map +1 -0
  16. package/dist/models/CreateUserConflictResponse.d.ts +18 -0
  17. package/dist/models/CreateUserConflictResponse.js +22 -0
  18. package/dist/models/CreateUserConflictResponse.js.map +1 -0
  19. package/dist/models/CreateUserConflictResponseErrorsInner.d.ts +20 -0
  20. package/dist/models/CreateUserConflictResponseErrorsInner.js +34 -0
  21. package/dist/models/CreateUserConflictResponseErrorsInner.js.map +1 -0
  22. package/dist/models/CreateUserConflictResponseErrorsItemsMeta.d.ts +17 -0
  23. package/dist/models/CreateUserConflictResponseErrorsItemsMeta.js +22 -0
  24. package/dist/models/CreateUserConflictResponseErrorsItemsMeta.js.map +1 -0
  25. package/dist/models/IdentifyUserConflictResponse.d.ts +18 -0
  26. package/dist/models/IdentifyUserConflictResponse.js +22 -0
  27. package/dist/models/IdentifyUserConflictResponse.js.map +1 -0
  28. package/dist/models/IdentifyUserConflictResponseErrorsInner.d.ts +18 -0
  29. package/dist/models/IdentifyUserConflictResponseErrorsInner.js +28 -0
  30. package/dist/models/IdentifyUserConflictResponseErrorsInner.js.map +1 -0
  31. package/dist/models/InlineResponse200.d.ts +19 -0
  32. package/dist/models/InlineResponse200.js +22 -0
  33. package/dist/models/InlineResponse200.js.map +1 -0
  34. package/dist/models/InlineResponse2003.d.ts +17 -0
  35. package/dist/models/InlineResponse2003.js +22 -0
  36. package/dist/models/InlineResponse2003.js.map +1 -0
  37. package/dist/models/InlineResponse201.d.ts +18 -0
  38. package/dist/models/InlineResponse201.js +22 -0
  39. package/dist/models/InlineResponse201.js.map +1 -0
  40. package/dist/models/InlineResponse202.d.ts +18 -0
  41. package/dist/models/InlineResponse202.js +22 -0
  42. package/dist/models/InlineResponse202.js.map +1 -0
  43. package/dist/models/Notification.d.ts +4 -0
  44. package/dist/models/Notification.js +12 -0
  45. package/dist/models/Notification.js.map +1 -1
  46. package/dist/models/NotificationTarget.d.ts +4 -0
  47. package/dist/models/NotificationTarget.js +12 -0
  48. package/dist/models/NotificationTarget.js.map +1 -1
  49. package/dist/models/NotificationWithMeta.d.ts +4 -0
  50. package/dist/models/NotificationWithMeta.js +12 -0
  51. package/dist/models/NotificationWithMeta.js.map +1 -1
  52. package/dist/models/ObjectSerializer.d.ts +21 -0
  53. package/dist/models/ObjectSerializer.js +69 -0
  54. package/dist/models/ObjectSerializer.js.map +1 -1
  55. package/dist/models/Player.d.ts +1 -1
  56. package/dist/models/Player.js +1 -1
  57. package/dist/models/Player.js.map +1 -1
  58. package/dist/models/PlayerNotificationTarget.d.ts +4 -0
  59. package/dist/models/PlayerNotificationTarget.js +12 -0
  60. package/dist/models/PlayerNotificationTarget.js.map +1 -1
  61. package/dist/models/PlayerNotificationTargetIncludeAliases.d.ts +17 -0
  62. package/dist/models/PlayerNotificationTargetIncludeAliases.js +22 -0
  63. package/dist/models/PlayerNotificationTargetIncludeAliases.js.map +1 -0
  64. package/dist/models/PropertiesDeltas.d.ts +20 -0
  65. package/dist/models/PropertiesDeltas.js +34 -0
  66. package/dist/models/PropertiesDeltas.js.map +1 -0
  67. package/dist/models/PropertiesObject.d.ts +30 -0
  68. package/dist/models/PropertiesObject.js +82 -0
  69. package/dist/models/PropertiesObject.js.map +1 -0
  70. package/dist/models/Purchase.d.ts +2 -1
  71. package/dist/models/Purchase.js +7 -1
  72. package/dist/models/Purchase.js.map +1 -1
  73. package/dist/models/SubscriptionObject.d.ts +34 -0
  74. package/dist/models/SubscriptionObject.js +118 -0
  75. package/dist/models/SubscriptionObject.js.map +1 -0
  76. package/dist/models/TransferSubscriptionRequestBody.d.ts +19 -0
  77. package/dist/models/TransferSubscriptionRequestBody.js +22 -0
  78. package/dist/models/TransferSubscriptionRequestBody.js.map +1 -0
  79. package/dist/models/UpdateSubscriptionRequestBody.d.ts +18 -0
  80. package/dist/models/UpdateSubscriptionRequestBody.js +22 -0
  81. package/dist/models/UpdateSubscriptionRequestBody.js.map +1 -0
  82. package/dist/models/UpdateUserRequest.d.ts +21 -0
  83. package/dist/models/UpdateUserRequest.js +34 -0
  84. package/dist/models/UpdateUserRequest.js.map +1 -0
  85. package/dist/models/User.d.ts +25 -0
  86. package/dist/models/User.js +40 -0
  87. package/dist/models/User.js.map +1 -0
  88. package/dist/models/UserIdentityRequestBody.d.ts +19 -0
  89. package/dist/models/UserIdentityRequestBody.js +22 -0
  90. package/dist/models/UserIdentityRequestBody.js.map +1 -0
  91. package/dist/models/UserIdentityResponse.d.ts +19 -0
  92. package/dist/models/UserIdentityResponse.js +22 -0
  93. package/dist/models/UserIdentityResponse.js.map +1 -0
  94. package/dist/models/UserSubscriptionOptions.d.ts +17 -0
  95. package/dist/models/UserSubscriptionOptions.js +22 -0
  96. package/dist/models/UserSubscriptionOptions.js.map +1 -0
  97. package/dist/models/all.d.ts +21 -0
  98. package/dist/models/all.js +21 -0
  99. package/dist/models/all.js.map +1 -1
  100. package/dist/types/ObjectParamAPI.d.ts +95 -0
  101. package/dist/types/ObjectParamAPI.js +42 -0
  102. package/dist/types/ObjectParamAPI.js.map +1 -1
  103. package/dist/types/ObservableAPI.d.ts +25 -0
  104. package/dist/types/ObservableAPI.js +383 -47
  105. package/dist/types/ObservableAPI.js.map +1 -1
  106. package/dist/types/PromiseAPI.d.ts +25 -0
  107. package/dist/types/PromiseAPI.js +56 -0
  108. package/dist/types/PromiseAPI.js.map +1 -1
  109. package/models/App.ts +1 -1
  110. package/models/BadRequestError.ts +1 -1
  111. package/models/BasicNotification.ts +17 -1
  112. package/models/BasicNotificationAllOf.ts +1 -1
  113. package/models/BasicNotificationAllOfAndroidBackgroundLayout.ts +1 -1
  114. package/models/BeginLiveActivityRequest.ts +1 -1
  115. package/models/Button.ts +1 -1
  116. package/models/CancelNotificationSuccessResponse.ts +1 -1
  117. package/models/CreateNotificationSuccessResponse.ts +3 -3
  118. package/models/CreatePlayerSuccessResponse.ts +1 -1
  119. package/models/CreateSegmentConflictResponse.ts +1 -1
  120. package/models/CreateSegmentSuccessResponse.ts +1 -1
  121. package/models/CreateSubscriptionRequestBody.ts +39 -0
  122. package/models/CreateUserConflictResponse.ts +32 -0
  123. package/models/CreateUserConflictResponseErrorsInner.ts +46 -0
  124. package/models/CreateUserConflictResponseErrorsItemsMeta.ts +31 -0
  125. package/models/DeletePlayerNotFoundResponse.ts +1 -1
  126. package/models/DeletePlayerSuccessResponse.ts +1 -1
  127. package/models/DeleteSegmentNotFoundResponse.ts +1 -1
  128. package/models/DeleteSegmentSuccessResponse.ts +1 -1
  129. package/models/DeliveryData.ts +1 -1
  130. package/models/ExportPlayersRequestBody.ts +1 -1
  131. package/models/ExportPlayersSuccessResponse.ts +1 -1
  132. package/models/Filter.ts +1 -1
  133. package/models/FilterExpressions.ts +1 -1
  134. package/models/GetNotificationRequestBody.ts +1 -1
  135. package/models/IdentifyUserConflictResponse.ts +32 -0
  136. package/models/IdentifyUserConflictResponseErrorsInner.ts +38 -0
  137. package/models/InlineResponse200.ts +31 -0
  138. package/models/InlineResponse2003.ts +31 -0
  139. package/models/InlineResponse201.ts +32 -0
  140. package/models/InlineResponse202.ts +32 -0
  141. package/models/InvalidIdentifierError.ts +1 -1
  142. package/models/Notification.ts +17 -1
  143. package/models/Notification200Errors.ts +1 -1
  144. package/models/NotificationAllOf.ts +1 -1
  145. package/models/NotificationHistorySuccessResponse.ts +1 -1
  146. package/models/NotificationSlice.ts +1 -1
  147. package/models/NotificationTarget.ts +19 -1
  148. package/models/NotificationWithMeta.ts +17 -1
  149. package/models/NotificationWithMetaAllOf.ts +1 -1
  150. package/models/ObjectSerializer.ts +74 -5
  151. package/models/Operator.ts +1 -1
  152. package/models/OutcomeData.ts +1 -1
  153. package/models/OutcomesData.ts +1 -1
  154. package/models/PlatformDeliveryData.ts +1 -1
  155. package/models/PlatformDeliveryDataEmailAllOf.ts +1 -1
  156. package/models/PlatformDeliveryDataSmsAllOf.ts +1 -1
  157. package/models/Player.ts +3 -3
  158. package/models/PlayerNotificationTarget.ts +19 -1
  159. package/models/PlayerNotificationTargetIncludeAliases.ts +31 -0
  160. package/models/PlayerSlice.ts +1 -1
  161. package/models/PropertiesDeltas.ts +46 -0
  162. package/models/PropertiesObject.ts +102 -0
  163. package/models/Purchase.ts +10 -3
  164. package/models/Segment.ts +1 -1
  165. package/models/SegmentNotificationTarget.ts +1 -1
  166. package/models/StringMap.ts +1 -1
  167. package/models/SubscriptionObject.ts +146 -0
  168. package/models/TransferSubscriptionRequestBody.ts +31 -0
  169. package/models/UpdateLiveActivityRequest.ts +1 -1
  170. package/models/UpdateLiveActivitySuccessResponse.ts +1 -1
  171. package/models/UpdatePlayerSuccessResponse.ts +1 -1
  172. package/models/UpdatePlayerTagsRequestBody.ts +1 -1
  173. package/models/UpdatePlayerTagsSuccessResponse.ts +1 -1
  174. package/models/UpdateSubscriptionRequestBody.ts +32 -0
  175. package/models/UpdateUserRequest.ts +47 -0
  176. package/models/User.ts +55 -0
  177. package/models/UserIdentityRequestBody.ts +31 -0
  178. package/models/UserIdentityResponse.ts +31 -0
  179. package/models/UserSubscriptionOptions.ts +31 -0
  180. package/models/all.ts +21 -0
  181. package/package.json +2 -2
  182. package/types/ObjectParamAPI.ts +427 -0
  183. package/types/ObservableAPI.ts +371 -0
  184. package/types/PromiseAPI.ts +175 -0
package/DefaultApi.md CHANGED
@@ -10,22 +10,36 @@ Method | HTTP request | Description
10
10
  [**createNotification**](DefaultApi.md#createNotification) | **POST** /notifications | Create notification
11
11
  [**createPlayer**](DefaultApi.md#createPlayer) | **POST** /players | Add a device
12
12
  [**createSegments**](DefaultApi.md#createSegments) | **POST** /apps/{app_id}/segments | Create Segments
13
+ [**createSubscription**](DefaultApi.md#createSubscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions |
14
+ [**createUser**](DefaultApi.md#createUser) | **POST** /apps/{app_id}/users |
15
+ [**deleteAlias**](DefaultApi.md#deleteAlias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} |
13
16
  [**deletePlayer**](DefaultApi.md#deletePlayer) | **DELETE** /players/{player_id} | Delete a user record
14
17
  [**deleteSegments**](DefaultApi.md#deleteSegments) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segments
18
+ [**deleteSubscription**](DefaultApi.md#deleteSubscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} |
19
+ [**deleteUser**](DefaultApi.md#deleteUser) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
15
20
  [**endLiveActivity**](DefaultApi.md#endLiveActivity) | **DELETE** /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id} | Stop Live Activity
16
21
  [**exportPlayers**](DefaultApi.md#exportPlayers) | **POST** /players/csv_export?app_id={app_id} | CSV export
22
+ [**fetchAliases**](DefaultApi.md#fetchAliases) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
23
+ [**fetchUser**](DefaultApi.md#fetchUser) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
24
+ [**fetchUserIdentity**](DefaultApi.md#fetchUserIdentity) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
17
25
  [**getApp**](DefaultApi.md#getApp) | **GET** /apps/{app_id} | View an app
18
26
  [**getApps**](DefaultApi.md#getApps) | **GET** /apps | View apps
27
+ [**getEligibleIams**](DefaultApi.md#getEligibleIams) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/iams |
19
28
  [**getNotification**](DefaultApi.md#getNotification) | **GET** /notifications/{notification_id} | View notification
20
29
  [**getNotificationHistory**](DefaultApi.md#getNotificationHistory) | **POST** /notifications/{notification_id}/history | Notification History
21
30
  [**getNotifications**](DefaultApi.md#getNotifications) | **GET** /notifications | View notifications
22
31
  [**getOutcomes**](DefaultApi.md#getOutcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes
23
32
  [**getPlayer**](DefaultApi.md#getPlayer) | **GET** /players/{player_id} | View device
24
33
  [**getPlayers**](DefaultApi.md#getPlayers) | **GET** /players | View devices
34
+ [**identifyUserByAlias**](DefaultApi.md#identifyUserByAlias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
35
+ [**identifyUserBySubscriptionId**](DefaultApi.md#identifyUserBySubscriptionId) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
36
+ [**transferSubscription**](DefaultApi.md#transferSubscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner |
25
37
  [**updateApp**](DefaultApi.md#updateApp) | **PUT** /apps/{app_id} | Update an app
26
38
  [**updateLiveActivity**](DefaultApi.md#updateLiveActivity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push
27
39
  [**updatePlayer**](DefaultApi.md#updatePlayer) | **PUT** /players/{player_id} | Edit device
28
40
  [**updatePlayerTags**](DefaultApi.md#updatePlayerTags) | **PUT** /apps/{app_id}/users/{external_user_id} | Edit tags with external user id
41
+ [**updateSubscription**](DefaultApi.md#updateSubscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} |
42
+ [**updateUser**](DefaultApi.md#updateUser) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
29
43
 
30
44
 
31
45
  # **beginLiveActivity**
@@ -322,7 +336,7 @@ let body:.DefaultApiCreatePlayerRequest = {
322
336
  last_active: 1,
323
337
  notification_types: 1,
324
338
  test_type: 1,
325
- _long: 3.14,
339
+ long: 3.14,
326
340
  lat: 3.14,
327
341
  country: "country_example",
328
342
  },
@@ -428,6 +442,259 @@ Name | Type | Description | Notes
428
442
 
429
443
  [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
430
444
 
445
+ # **createSubscription**
446
+ > InlineResponse201 createSubscription(createSubscriptionRequestBody)
447
+
448
+ Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.
449
+
450
+ ### Example
451
+
452
+
453
+ ```typescript
454
+ import { } from '';
455
+ import * as fs from 'fs';
456
+
457
+ const configuration = .createConfiguration();
458
+ const apiInstance = new .DefaultApi(configuration);
459
+
460
+ let body:.DefaultApiCreateSubscriptionRequest = {
461
+ // string
462
+ appId: "app_id_example",
463
+ // string
464
+ aliasLabel: "alias_label_example",
465
+ // string
466
+ aliasId: "alias_id_example",
467
+ // CreateSubscriptionRequestBody
468
+ createSubscriptionRequestBody: {
469
+ subscription: {
470
+ id: "id_example",
471
+ type: "iOSPush",
472
+ token: "token_example",
473
+ enabled: true,
474
+ notification_types: 3.14,
475
+ session_time: 3.14,
476
+ session_count: 3.14,
477
+ sdk: "sdk_example",
478
+ device_model: "device_model_example",
479
+ device_os: "device_os_example",
480
+ rooted: true,
481
+ test_type: 3.14,
482
+ app_version: "app_version_example",
483
+ net_type: 3.14,
484
+ carrier: "carrier_example",
485
+ web_auth: "web_auth_example",
486
+ web_p256: "web_p256_example",
487
+ },
488
+ retain_previous_owner: true,
489
+ },
490
+ };
491
+
492
+ apiInstance.createSubscription(body).then((data:any) => {
493
+ console.log('API called successfully. Returned data: ' + data);
494
+ }).catch((error:any) => console.error(error));
495
+ ```
496
+
497
+
498
+ ### Parameters
499
+
500
+ Name | Type | Description | Notes
501
+ ------------- | ------------- | ------------- | -------------
502
+ **createSubscriptionRequestBody** | **CreateSubscriptionRequestBody**| |
503
+ **appId** | [**string**] | | defaults to undefined
504
+ **aliasLabel** | [**string**] | | defaults to undefined
505
+ **aliasId** | [**string**] | | defaults to undefined
506
+
507
+
508
+ ### Return type
509
+
510
+ **InlineResponse201**
511
+
512
+ ### Authorization
513
+
514
+ [app_key](README.md#app_key)
515
+
516
+ ### HTTP request headers
517
+
518
+ - **Content-Type**: application/json
519
+ - **Accept**: application/json
520
+
521
+
522
+ ### HTTP response details
523
+ | Status code | Description | Response headers |
524
+ |-------------|-------------|------------------|
525
+ **201** | CREATED | - |
526
+ **202** | ACCEPTED | - |
527
+
528
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
529
+
530
+ # **createUser**
531
+ > User createUser(user)
532
+
533
+ 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.
534
+
535
+ ### Example
536
+
537
+
538
+ ```typescript
539
+ import { } from '';
540
+ import * as fs from 'fs';
541
+
542
+ const configuration = .createConfiguration();
543
+ const apiInstance = new .DefaultApi(configuration);
544
+
545
+ let body:.DefaultApiCreateUserRequest = {
546
+ // string
547
+ appId: "app_id_example",
548
+ // User
549
+ user: {
550
+ properties: {
551
+ tags: {},
552
+ language: "language_example",
553
+ timezone_id: "timezone_id_example",
554
+ lat: 3.14,
555
+ long: 3.14,
556
+ country: "country_example",
557
+ first_active: 3.14,
558
+ last_active: 3.14,
559
+ amount_spent: 3.14,
560
+ purchases: [
561
+ {
562
+ sku: "sku_example",
563
+ amount: "amount_example",
564
+ iso: "iso_example",
565
+ count: 3.14,
566
+ },
567
+ ],
568
+ ip: "ip_example",
569
+ },
570
+ identity: {},
571
+ subscriptions: [
572
+ {
573
+ id: "id_example",
574
+ type: "iOSPush",
575
+ token: "token_example",
576
+ enabled: true,
577
+ notification_types: 3.14,
578
+ session_time: 3.14,
579
+ session_count: 3.14,
580
+ sdk: "sdk_example",
581
+ device_model: "device_model_example",
582
+ device_os: "device_os_example",
583
+ rooted: true,
584
+ test_type: 3.14,
585
+ app_version: "app_version_example",
586
+ net_type: 3.14,
587
+ carrier: "carrier_example",
588
+ web_auth: "web_auth_example",
589
+ web_p256: "web_p256_example",
590
+ },
591
+ ],
592
+ subscription_options: {
593
+ retain_previous_owner: true,
594
+ },
595
+ },
596
+ };
597
+
598
+ apiInstance.createUser(body).then((data:any) => {
599
+ console.log('API called successfully. Returned data: ' + data);
600
+ }).catch((error:any) => console.error(error));
601
+ ```
602
+
603
+
604
+ ### Parameters
605
+
606
+ Name | Type | Description | Notes
607
+ ------------- | ------------- | ------------- | -------------
608
+ **user** | **User**| |
609
+ **appId** | [**string**] | | defaults to undefined
610
+
611
+
612
+ ### Return type
613
+
614
+ **User**
615
+
616
+ ### Authorization
617
+
618
+ [app_key](README.md#app_key)
619
+
620
+ ### HTTP request headers
621
+
622
+ - **Content-Type**: application/json
623
+ - **Accept**: application/json
624
+
625
+
626
+ ### HTTP response details
627
+ | Status code | Description | Response headers |
628
+ |-------------|-------------|------------------|
629
+ **201** | CREATED | - |
630
+ **202** | ACCEPTED | - |
631
+ **409** | Multiple User Identity Conflict | - |
632
+
633
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
634
+
635
+ # **deleteAlias**
636
+ > InlineResponse200 deleteAlias()
637
+
638
+ Deletes an alias by alias label
639
+
640
+ ### Example
641
+
642
+
643
+ ```typescript
644
+ import { } from '';
645
+ import * as fs from 'fs';
646
+
647
+ const configuration = .createConfiguration();
648
+ const apiInstance = new .DefaultApi(configuration);
649
+
650
+ let body:.DefaultApiDeleteAliasRequest = {
651
+ // string
652
+ appId: "app_id_example",
653
+ // string
654
+ aliasLabel: "alias_label_example",
655
+ // string
656
+ aliasId: "alias_id_example",
657
+ // string
658
+ aliasLabelToDelete: "alias_label_to_delete_example",
659
+ };
660
+
661
+ apiInstance.deleteAlias(body).then((data:any) => {
662
+ console.log('API called successfully. Returned data: ' + data);
663
+ }).catch((error:any) => console.error(error));
664
+ ```
665
+
666
+
667
+ ### Parameters
668
+
669
+ Name | Type | Description | Notes
670
+ ------------- | ------------- | ------------- | -------------
671
+ **appId** | [**string**] | | defaults to undefined
672
+ **aliasLabel** | [**string**] | | defaults to undefined
673
+ **aliasId** | [**string**] | | defaults to undefined
674
+ **aliasLabelToDelete** | [**string**] | | defaults to undefined
675
+
676
+
677
+ ### Return type
678
+
679
+ **InlineResponse200**
680
+
681
+ ### Authorization
682
+
683
+ [app_key](README.md#app_key)
684
+
685
+ ### HTTP request headers
686
+
687
+ - **Content-Type**: Not defined
688
+ - **Accept**: application/json
689
+
690
+
691
+ ### HTTP response details
692
+ | Status code | Description | Response headers |
693
+ |-------------|-------------|------------------|
694
+ **200** | OK | - |
695
+
696
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
697
+
431
698
  # **deletePlayer**
432
699
  > DeletePlayerSuccessResponse deletePlayer()
433
700
 
@@ -546,6 +813,123 @@ Name | Type | Description | Notes
546
813
 
547
814
  [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
548
815
 
816
+ # **deleteSubscription**
817
+ > void deleteSubscription()
818
+
819
+ Deletes the Subscription.
820
+
821
+ ### Example
822
+
823
+
824
+ ```typescript
825
+ import { } from '';
826
+ import * as fs from 'fs';
827
+
828
+ const configuration = .createConfiguration();
829
+ const apiInstance = new .DefaultApi(configuration);
830
+
831
+ let body:.DefaultApiDeleteSubscriptionRequest = {
832
+ // string
833
+ appId: "app_id_example",
834
+ // string
835
+ subscriptionId: "subscription_id_example",
836
+ };
837
+
838
+ apiInstance.deleteSubscription(body).then((data:any) => {
839
+ console.log('API called successfully. Returned data: ' + data);
840
+ }).catch((error:any) => console.error(error));
841
+ ```
842
+
843
+
844
+ ### Parameters
845
+
846
+ Name | Type | Description | Notes
847
+ ------------- | ------------- | ------------- | -------------
848
+ **appId** | [**string**] | | defaults to undefined
849
+ **subscriptionId** | [**string**] | | defaults to undefined
850
+
851
+
852
+ ### Return type
853
+
854
+ **void**
855
+
856
+ ### Authorization
857
+
858
+ [app_key](README.md#app_key)
859
+
860
+ ### HTTP request headers
861
+
862
+ - **Content-Type**: Not defined
863
+ - **Accept**: Not defined
864
+
865
+
866
+ ### HTTP response details
867
+ | Status code | Description | Response headers |
868
+ |-------------|-------------|------------------|
869
+ **202** | ACCEPTED | - |
870
+
871
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
872
+
873
+ # **deleteUser**
874
+ > void deleteUser()
875
+
876
+ Removes the User identified by (:alias_label, :alias_id), and all Subscriptions and Aliases
877
+
878
+ ### Example
879
+
880
+
881
+ ```typescript
882
+ import { } from '';
883
+ import * as fs from 'fs';
884
+
885
+ const configuration = .createConfiguration();
886
+ const apiInstance = new .DefaultApi(configuration);
887
+
888
+ let body:.DefaultApiDeleteUserRequest = {
889
+ // string
890
+ appId: "app_id_example",
891
+ // string
892
+ aliasLabel: "alias_label_example",
893
+ // string
894
+ aliasId: "alias_id_example",
895
+ };
896
+
897
+ apiInstance.deleteUser(body).then((data:any) => {
898
+ console.log('API called successfully. Returned data: ' + data);
899
+ }).catch((error:any) => console.error(error));
900
+ ```
901
+
902
+
903
+ ### Parameters
904
+
905
+ Name | Type | Description | Notes
906
+ ------------- | ------------- | ------------- | -------------
907
+ **appId** | [**string**] | | defaults to undefined
908
+ **aliasLabel** | [**string**] | | defaults to undefined
909
+ **aliasId** | [**string**] | | defaults to undefined
910
+
911
+
912
+ ### Return type
913
+
914
+ **void**
915
+
916
+ ### Authorization
917
+
918
+ No authorization required
919
+
920
+ ### HTTP request headers
921
+
922
+ - **Content-Type**: Not defined
923
+ - **Accept**: Not defined
924
+
925
+
926
+ ### HTTP response details
927
+ | Status code | Description | Response headers |
928
+ |-------------|-------------|------------------|
929
+ **200** | OK | - |
930
+
931
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
932
+
549
933
  # **endLiveActivity**
550
934
  > void endLiveActivity()
551
935
 
@@ -671,6 +1055,183 @@ Name | Type | Description | Notes
671
1055
 
672
1056
  [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
673
1057
 
1058
+ # **fetchAliases**
1059
+ > UserIdentityResponse fetchAliases()
1060
+
1061
+ Lists all Aliases for the User identified by :subscription_id.
1062
+
1063
+ ### Example
1064
+
1065
+
1066
+ ```typescript
1067
+ import { } from '';
1068
+ import * as fs from 'fs';
1069
+
1070
+ const configuration = .createConfiguration();
1071
+ const apiInstance = new .DefaultApi(configuration);
1072
+
1073
+ let body:.DefaultApiFetchAliasesRequest = {
1074
+ // string
1075
+ appId: "app_id_example",
1076
+ // string
1077
+ subscriptionId: "subscription_id_example",
1078
+ };
1079
+
1080
+ apiInstance.fetchAliases(body).then((data:any) => {
1081
+ console.log('API called successfully. Returned data: ' + data);
1082
+ }).catch((error:any) => console.error(error));
1083
+ ```
1084
+
1085
+
1086
+ ### Parameters
1087
+
1088
+ Name | Type | Description | Notes
1089
+ ------------- | ------------- | ------------- | -------------
1090
+ **appId** | [**string**] | | defaults to undefined
1091
+ **subscriptionId** | [**string**] | | defaults to undefined
1092
+
1093
+
1094
+ ### Return type
1095
+
1096
+ **UserIdentityResponse**
1097
+
1098
+ ### Authorization
1099
+
1100
+ [app_key](README.md#app_key)
1101
+
1102
+ ### HTTP request headers
1103
+
1104
+ - **Content-Type**: Not defined
1105
+ - **Accept**: application/json
1106
+
1107
+
1108
+ ### HTTP response details
1109
+ | Status code | Description | Response headers |
1110
+ |-------------|-------------|------------------|
1111
+ **200** | OK | - |
1112
+
1113
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1114
+
1115
+ # **fetchUser**
1116
+ > User fetchUser()
1117
+
1118
+ Returns the User’s properties, Aliases, and Subscriptions.
1119
+
1120
+ ### Example
1121
+
1122
+
1123
+ ```typescript
1124
+ import { } from '';
1125
+ import * as fs from 'fs';
1126
+
1127
+ const configuration = .createConfiguration();
1128
+ const apiInstance = new .DefaultApi(configuration);
1129
+
1130
+ let body:.DefaultApiFetchUserRequest = {
1131
+ // string
1132
+ appId: "app_id_example",
1133
+ // string
1134
+ aliasLabel: "alias_label_example",
1135
+ // string
1136
+ aliasId: "alias_id_example",
1137
+ };
1138
+
1139
+ apiInstance.fetchUser(body).then((data:any) => {
1140
+ console.log('API called successfully. Returned data: ' + data);
1141
+ }).catch((error:any) => console.error(error));
1142
+ ```
1143
+
1144
+
1145
+ ### Parameters
1146
+
1147
+ Name | Type | Description | Notes
1148
+ ------------- | ------------- | ------------- | -------------
1149
+ **appId** | [**string**] | | defaults to undefined
1150
+ **aliasLabel** | [**string**] | | defaults to undefined
1151
+ **aliasId** | [**string**] | | defaults to undefined
1152
+
1153
+
1154
+ ### Return type
1155
+
1156
+ **User**
1157
+
1158
+ ### Authorization
1159
+
1160
+ [app_key](README.md#app_key)
1161
+
1162
+ ### HTTP request headers
1163
+
1164
+ - **Content-Type**: Not defined
1165
+ - **Accept**: application/json
1166
+
1167
+
1168
+ ### HTTP response details
1169
+ | Status code | Description | Response headers |
1170
+ |-------------|-------------|------------------|
1171
+ **200** | OK | - |
1172
+
1173
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1174
+
1175
+ # **fetchUserIdentity**
1176
+ > InlineResponse200 fetchUserIdentity()
1177
+
1178
+ Lists all Aliases for the User identified by (:alias_label, :alias_id).
1179
+
1180
+ ### Example
1181
+
1182
+
1183
+ ```typescript
1184
+ import { } from '';
1185
+ import * as fs from 'fs';
1186
+
1187
+ const configuration = .createConfiguration();
1188
+ const apiInstance = new .DefaultApi(configuration);
1189
+
1190
+ let body:.DefaultApiFetchUserIdentityRequest = {
1191
+ // string
1192
+ appId: "app_id_example",
1193
+ // string
1194
+ aliasLabel: "alias_label_example",
1195
+ // string
1196
+ aliasId: "alias_id_example",
1197
+ };
1198
+
1199
+ apiInstance.fetchUserIdentity(body).then((data:any) => {
1200
+ console.log('API called successfully. Returned data: ' + data);
1201
+ }).catch((error:any) => console.error(error));
1202
+ ```
1203
+
1204
+
1205
+ ### Parameters
1206
+
1207
+ Name | Type | Description | Notes
1208
+ ------------- | ------------- | ------------- | -------------
1209
+ **appId** | [**string**] | | defaults to undefined
1210
+ **aliasLabel** | [**string**] | | defaults to undefined
1211
+ **aliasId** | [**string**] | | defaults to undefined
1212
+
1213
+
1214
+ ### Return type
1215
+
1216
+ **InlineResponse200**
1217
+
1218
+ ### Authorization
1219
+
1220
+ [app_key](README.md#app_key)
1221
+
1222
+ ### HTTP request headers
1223
+
1224
+ - **Content-Type**: Not defined
1225
+ - **Accept**: application/json
1226
+
1227
+
1228
+ ### HTTP response details
1229
+ | Status code | Description | Response headers |
1230
+ |-------------|-------------|------------------|
1231
+ **200** | OK | - |
1232
+
1233
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1234
+
674
1235
  # **getApp**
675
1236
  > App getApp()
676
1237
 
@@ -775,6 +1336,63 @@ This endpoint does not need any parameter.
775
1336
 
776
1337
  [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
777
1338
 
1339
+ # **getEligibleIams**
1340
+ > InlineResponse2003 getEligibleIams()
1341
+
1342
+ Manifest of In-App Messages the Subscription is eligible to display by the SDK.
1343
+
1344
+ ### Example
1345
+
1346
+
1347
+ ```typescript
1348
+ import { } from '';
1349
+ import * as fs from 'fs';
1350
+
1351
+ const configuration = .createConfiguration();
1352
+ const apiInstance = new .DefaultApi(configuration);
1353
+
1354
+ let body:.DefaultApiGetEligibleIamsRequest = {
1355
+ // string
1356
+ appId: "app_id_example",
1357
+ // string
1358
+ subscriptionId: "subscription_id_example",
1359
+ };
1360
+
1361
+ apiInstance.getEligibleIams(body).then((data:any) => {
1362
+ console.log('API called successfully. Returned data: ' + data);
1363
+ }).catch((error:any) => console.error(error));
1364
+ ```
1365
+
1366
+
1367
+ ### Parameters
1368
+
1369
+ Name | Type | Description | Notes
1370
+ ------------- | ------------- | ------------- | -------------
1371
+ **appId** | [**string**] | | defaults to undefined
1372
+ **subscriptionId** | [**string**] | | defaults to undefined
1373
+
1374
+
1375
+ ### Return type
1376
+
1377
+ **InlineResponse2003**
1378
+
1379
+ ### Authorization
1380
+
1381
+ [app_key](README.md#app_key)
1382
+
1383
+ ### HTTP request headers
1384
+
1385
+ - **Content-Type**: Not defined
1386
+ - **Accept**: application/json
1387
+
1388
+
1389
+ ### HTTP response details
1390
+ | Status code | Description | Response headers |
1391
+ |-------------|-------------|------------------|
1392
+ **200** | OK | - |
1393
+
1394
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1395
+
778
1396
  # **getNotification**
779
1397
  > NotificationWithMeta getNotification()
780
1398
 
@@ -1151,6 +1769,197 @@ Name | Type | Description | Notes
1151
1769
 
1152
1770
  [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1153
1771
 
1772
+ # **identifyUserByAlias**
1773
+ > InlineResponse200 identifyUserByAlias(userIdentityRequestBody)
1774
+
1775
+ Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).
1776
+
1777
+ ### Example
1778
+
1779
+
1780
+ ```typescript
1781
+ import { } from '';
1782
+ import * as fs from 'fs';
1783
+
1784
+ const configuration = .createConfiguration();
1785
+ const apiInstance = new .DefaultApi(configuration);
1786
+
1787
+ let body:.DefaultApiIdentifyUserByAliasRequest = {
1788
+ // string
1789
+ appId: "app_id_example",
1790
+ // string
1791
+ aliasLabel: "alias_label_example",
1792
+ // string
1793
+ aliasId: "alias_id_example",
1794
+ // UserIdentityRequestBody
1795
+ userIdentityRequestBody: {
1796
+ identity: {},
1797
+ },
1798
+ };
1799
+
1800
+ apiInstance.identifyUserByAlias(body).then((data:any) => {
1801
+ console.log('API called successfully. Returned data: ' + data);
1802
+ }).catch((error:any) => console.error(error));
1803
+ ```
1804
+
1805
+
1806
+ ### Parameters
1807
+
1808
+ Name | Type | Description | Notes
1809
+ ------------- | ------------- | ------------- | -------------
1810
+ **userIdentityRequestBody** | **UserIdentityRequestBody**| |
1811
+ **appId** | [**string**] | | defaults to undefined
1812
+ **aliasLabel** | [**string**] | | defaults to undefined
1813
+ **aliasId** | [**string**] | | defaults to undefined
1814
+
1815
+
1816
+ ### Return type
1817
+
1818
+ **InlineResponse200**
1819
+
1820
+ ### Authorization
1821
+
1822
+ [app_key](README.md#app_key)
1823
+
1824
+ ### HTTP request headers
1825
+
1826
+ - **Content-Type**: application/json
1827
+ - **Accept**: application/json
1828
+
1829
+
1830
+ ### HTTP response details
1831
+ | Status code | Description | Response headers |
1832
+ |-------------|-------------|------------------|
1833
+ **200** | OK | - |
1834
+ **409** | Conflict | - |
1835
+
1836
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1837
+
1838
+ # **identifyUserBySubscriptionId**
1839
+ > UserIdentityResponse identifyUserBySubscriptionId(userIdentityRequestBody)
1840
+
1841
+ Upserts one or more Aliases for the User identified by :subscription_id.
1842
+
1843
+ ### Example
1844
+
1845
+
1846
+ ```typescript
1847
+ import { } from '';
1848
+ import * as fs from 'fs';
1849
+
1850
+ const configuration = .createConfiguration();
1851
+ const apiInstance = new .DefaultApi(configuration);
1852
+
1853
+ let body:.DefaultApiIdentifyUserBySubscriptionIdRequest = {
1854
+ // string
1855
+ appId: "app_id_example",
1856
+ // string
1857
+ subscriptionId: "subscription_id_example",
1858
+ // UserIdentityRequestBody
1859
+ userIdentityRequestBody: {
1860
+ identity: {},
1861
+ },
1862
+ };
1863
+
1864
+ apiInstance.identifyUserBySubscriptionId(body).then((data:any) => {
1865
+ console.log('API called successfully. Returned data: ' + data);
1866
+ }).catch((error:any) => console.error(error));
1867
+ ```
1868
+
1869
+
1870
+ ### Parameters
1871
+
1872
+ Name | Type | Description | Notes
1873
+ ------------- | ------------- | ------------- | -------------
1874
+ **userIdentityRequestBody** | **UserIdentityRequestBody**| |
1875
+ **appId** | [**string**] | | defaults to undefined
1876
+ **subscriptionId** | [**string**] | | defaults to undefined
1877
+
1878
+
1879
+ ### Return type
1880
+
1881
+ **UserIdentityResponse**
1882
+
1883
+ ### Authorization
1884
+
1885
+ [app_key](README.md#app_key)
1886
+
1887
+ ### HTTP request headers
1888
+
1889
+ - **Content-Type**: application/json
1890
+ - **Accept**: application/json
1891
+
1892
+
1893
+ ### HTTP response details
1894
+ | Status code | Description | Response headers |
1895
+ |-------------|-------------|------------------|
1896
+ **200** | OK | - |
1897
+ **409** | Conflict | - |
1898
+
1899
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1900
+
1901
+ # **transferSubscription**
1902
+ > UserIdentityResponse transferSubscription(transferSubscriptionRequestBody)
1903
+
1904
+ Transfers this Subscription to the User identified by the identity in the payload.
1905
+
1906
+ ### Example
1907
+
1908
+
1909
+ ```typescript
1910
+ import { } from '';
1911
+ import * as fs from 'fs';
1912
+
1913
+ const configuration = .createConfiguration();
1914
+ const apiInstance = new .DefaultApi(configuration);
1915
+
1916
+ let body:.DefaultApiTransferSubscriptionRequest = {
1917
+ // string
1918
+ appId: "app_id_example",
1919
+ // string
1920
+ subscriptionId: "subscription_id_example",
1921
+ // TransferSubscriptionRequestBody
1922
+ transferSubscriptionRequestBody: {
1923
+ identity: {},
1924
+ },
1925
+ };
1926
+
1927
+ apiInstance.transferSubscription(body).then((data:any) => {
1928
+ console.log('API called successfully. Returned data: ' + data);
1929
+ }).catch((error:any) => console.error(error));
1930
+ ```
1931
+
1932
+
1933
+ ### Parameters
1934
+
1935
+ Name | Type | Description | Notes
1936
+ ------------- | ------------- | ------------- | -------------
1937
+ **transferSubscriptionRequestBody** | **TransferSubscriptionRequestBody**| |
1938
+ **appId** | [**string**] | | defaults to undefined
1939
+ **subscriptionId** | [**string**] | | defaults to undefined
1940
+
1941
+
1942
+ ### Return type
1943
+
1944
+ **UserIdentityResponse**
1945
+
1946
+ ### Authorization
1947
+
1948
+ [app_key](README.md#app_key)
1949
+
1950
+ ### HTTP request headers
1951
+
1952
+ - **Content-Type**: application/json
1953
+ - **Accept**: application/json
1954
+
1955
+
1956
+ ### HTTP response details
1957
+ | Status code | Description | Response headers |
1958
+ |-------------|-------------|------------------|
1959
+ **200** | OK | - |
1960
+
1961
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1962
+
1154
1963
  # **updateApp**
1155
1964
  > App updateApp(app)
1156
1965
 
@@ -1339,7 +2148,7 @@ let body:.DefaultApiUpdatePlayerRequest = {
1339
2148
  last_active: 1,
1340
2149
  notification_types: 1,
1341
2150
  test_type: 1,
1342
- _long: 3.14,
2151
+ long: 3.14,
1343
2152
  lat: 3.14,
1344
2153
  country: "country_example",
1345
2154
  },
@@ -1440,7 +2249,183 @@ Name | Type | Description | Notes
1440
2249
  | Status code | Description | Response headers |
1441
2250
  |-------------|-------------|------------------|
1442
2251
  **200** | OK | - |
1443
- **400** | Bad Request | - |
2252
+
2253
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
2254
+
2255
+ # **updateSubscription**
2256
+ > void updateSubscription(updateSubscriptionRequestBody)
2257
+
2258
+ Updates an existing Subscription’s properties.
2259
+
2260
+ ### Example
2261
+
2262
+
2263
+ ```typescript
2264
+ import { } from '';
2265
+ import * as fs from 'fs';
2266
+
2267
+ const configuration = .createConfiguration();
2268
+ const apiInstance = new .DefaultApi(configuration);
2269
+
2270
+ let body:.DefaultApiUpdateSubscriptionRequest = {
2271
+ // string
2272
+ appId: "app_id_example",
2273
+ // string
2274
+ subscriptionId: "subscription_id_example",
2275
+ // UpdateSubscriptionRequestBody
2276
+ updateSubscriptionRequestBody: {
2277
+ subscription: {
2278
+ id: "id_example",
2279
+ type: "iOSPush",
2280
+ token: "token_example",
2281
+ enabled: true,
2282
+ notification_types: 3.14,
2283
+ session_time: 3.14,
2284
+ session_count: 3.14,
2285
+ sdk: "sdk_example",
2286
+ device_model: "device_model_example",
2287
+ device_os: "device_os_example",
2288
+ rooted: true,
2289
+ test_type: 3.14,
2290
+ app_version: "app_version_example",
2291
+ net_type: 3.14,
2292
+ carrier: "carrier_example",
2293
+ web_auth: "web_auth_example",
2294
+ web_p256: "web_p256_example",
2295
+ },
2296
+ },
2297
+ };
2298
+
2299
+ apiInstance.updateSubscription(body).then((data:any) => {
2300
+ console.log('API called successfully. Returned data: ' + data);
2301
+ }).catch((error:any) => console.error(error));
2302
+ ```
2303
+
2304
+
2305
+ ### Parameters
2306
+
2307
+ Name | Type | Description | Notes
2308
+ ------------- | ------------- | ------------- | -------------
2309
+ **updateSubscriptionRequestBody** | **UpdateSubscriptionRequestBody**| |
2310
+ **appId** | [**string**] | | defaults to undefined
2311
+ **subscriptionId** | [**string**] | | defaults to undefined
2312
+
2313
+
2314
+ ### Return type
2315
+
2316
+ **void**
2317
+
2318
+ ### Authorization
2319
+
2320
+ [app_key](README.md#app_key)
2321
+
2322
+ ### HTTP request headers
2323
+
2324
+ - **Content-Type**: application/json
2325
+ - **Accept**: Not defined
2326
+
2327
+
2328
+ ### HTTP response details
2329
+ | Status code | Description | Response headers |
2330
+ |-------------|-------------|------------------|
2331
+ **202** | ACCEPTED | - |
2332
+
2333
+ [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
2334
+
2335
+ # **updateUser**
2336
+ > InlineResponse202 updateUser(updateUserRequest)
2337
+
2338
+ Updates an existing User’s properties.
2339
+
2340
+ ### Example
2341
+
2342
+
2343
+ ```typescript
2344
+ import { } from '';
2345
+ import * as fs from 'fs';
2346
+
2347
+ const configuration = .createConfiguration();
2348
+ const apiInstance = new .DefaultApi(configuration);
2349
+
2350
+ let body:.DefaultApiUpdateUserRequest = {
2351
+ // string
2352
+ appId: "app_id_example",
2353
+ // string
2354
+ aliasLabel: "alias_label_example",
2355
+ // string
2356
+ aliasId: "alias_id_example",
2357
+ // UpdateUserRequest
2358
+ updateUserRequest: {
2359
+ properties: {
2360
+ tags: {},
2361
+ language: "language_example",
2362
+ timezone_id: "timezone_id_example",
2363
+ lat: 3.14,
2364
+ long: 3.14,
2365
+ country: "country_example",
2366
+ first_active: 3.14,
2367
+ last_active: 3.14,
2368
+ amount_spent: 3.14,
2369
+ purchases: [
2370
+ {
2371
+ sku: "sku_example",
2372
+ amount: "amount_example",
2373
+ iso: "iso_example",
2374
+ count: 3.14,
2375
+ },
2376
+ ],
2377
+ ip: "ip_example",
2378
+ },
2379
+ refresh_device_metadata: false,
2380
+ deltas: {
2381
+ session_time: 3.14,
2382
+ session_count: 3.14,
2383
+ purchases: [
2384
+ {
2385
+ sku: "sku_example",
2386
+ amount: "amount_example",
2387
+ iso: "iso_example",
2388
+ count: 3.14,
2389
+ },
2390
+ ],
2391
+ },
2392
+ },
2393
+ };
2394
+
2395
+ apiInstance.updateUser(body).then((data:any) => {
2396
+ console.log('API called successfully. Returned data: ' + data);
2397
+ }).catch((error:any) => console.error(error));
2398
+ ```
2399
+
2400
+
2401
+ ### Parameters
2402
+
2403
+ Name | Type | Description | Notes
2404
+ ------------- | ------------- | ------------- | -------------
2405
+ **updateUserRequest** | **UpdateUserRequest**| |
2406
+ **appId** | [**string**] | | defaults to undefined
2407
+ **aliasLabel** | [**string**] | | defaults to undefined
2408
+ **aliasId** | [**string**] | | defaults to undefined
2409
+
2410
+
2411
+ ### Return type
2412
+
2413
+ **InlineResponse202**
2414
+
2415
+ ### Authorization
2416
+
2417
+ [app_key](README.md#app_key)
2418
+
2419
+ ### HTTP request headers
2420
+
2421
+ - **Content-Type**: application/json
2422
+ - **Accept**: application/json
2423
+
2424
+
2425
+ ### HTTP response details
2426
+ | Status code | Description | Response headers |
2427
+ |-------------|-------------|------------------|
2428
+ **202** | ACCEPTED | - |
1444
2429
 
1445
2430
  [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1446
2431