mparticle 1.0.0

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 (80) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +73 -0
  3. data/docs/ApiResponse.md +8 -0
  4. data/docs/ApiResponseErrors.md +9 -0
  5. data/docs/AppEvent.md +18 -0
  6. data/docs/ApplicationInformation.md +11 -0
  7. data/docs/ApplicationStateTransitionEvent.md +20 -0
  8. data/docs/AttributionInfo.md +10 -0
  9. data/docs/Batch.md +18 -0
  10. data/docs/BreadcrumbEvent.md +17 -0
  11. data/docs/CommerceEvent.md +22 -0
  12. data/docs/CrashReportEvent.md +26 -0
  13. data/docs/DeviceCurrentState.md +23 -0
  14. data/docs/DeviceInformation.md +41 -0
  15. data/docs/EventBase.md +9 -0
  16. data/docs/EventData.md +15 -0
  17. data/docs/EventsApi.md +124 -0
  18. data/docs/FirstRunEvent.md +15 -0
  19. data/docs/GeoLocation.md +10 -0
  20. data/docs/MediaInfo.md +15 -0
  21. data/docs/NetworkPerformanceEvent.md +22 -0
  22. data/docs/OptOutEvent.md +16 -0
  23. data/docs/Product.md +19 -0
  24. data/docs/ProductAction.md +19 -0
  25. data/docs/ProductImpression.md +9 -0
  26. data/docs/ProfileEvent.md +18 -0
  27. data/docs/Promotion.md +11 -0
  28. data/docs/PromotionAction.md +9 -0
  29. data/docs/PushMessageEvent.md +22 -0
  30. data/docs/PushRegistrationEvent.md +17 -0
  31. data/docs/ScreenViewEvent.md +17 -0
  32. data/docs/SessionEndEvent.md +16 -0
  33. data/docs/SessionStartEvent.md +15 -0
  34. data/docs/ShoppingCart.md +8 -0
  35. data/docs/SourceInformation.md +11 -0
  36. data/docs/UserIdentities.md +17 -0
  37. data/example/main.rb +32 -0
  38. data/lib/.DS_Store +0 -0
  39. data/lib/mparticle/.DS_Store +0 -0
  40. data/lib/mparticle/api/events_api.rb +129 -0
  41. data/lib/mparticle/api_client.rb +398 -0
  42. data/lib/mparticle/api_error.rb +26 -0
  43. data/lib/mparticle/configuration.rb +160 -0
  44. data/lib/mparticle/models/api_response.rb +178 -0
  45. data/lib/mparticle/models/api_response_errors.rb +185 -0
  46. data/lib/mparticle/models/app_event.rb +311 -0
  47. data/lib/mparticle/models/application_information.rb +203 -0
  48. data/lib/mparticle/models/application_state_transition_event.rb +352 -0
  49. data/lib/mparticle/models/attribution_info.rb +209 -0
  50. data/lib/mparticle/models/batch.rb +348 -0
  51. data/lib/mparticle/models/breadcrumb_event.rb +269 -0
  52. data/lib/mparticle/models/commerce_event.rb +306 -0
  53. data/lib/mparticle/models/crash_report_event.rb +362 -0
  54. data/lib/mparticle/models/device_current_state.rb +356 -0
  55. data/lib/mparticle/models/device_information.rb +506 -0
  56. data/lib/mparticle/models/event_base.rb +228 -0
  57. data/lib/mparticle/models/event_data.rb +241 -0
  58. data/lib/mparticle/models/first_run_event.rb +241 -0
  59. data/lib/mparticle/models/geo_location.rb +204 -0
  60. data/lib/mparticle/models/media_info.rb +296 -0
  61. data/lib/mparticle/models/network_performance_event.rb +334 -0
  62. data/lib/mparticle/models/opt_out_event.rb +255 -0
  63. data/lib/mparticle/models/product.rb +297 -0
  64. data/lib/mparticle/models/product_action.rb +330 -0
  65. data/lib/mparticle/models/product_impression.rb +197 -0
  66. data/lib/mparticle/models/profile_event.rb +316 -0
  67. data/lib/mparticle/models/promotion.rb +223 -0
  68. data/lib/mparticle/models/promotion_action.rb +230 -0
  69. data/lib/mparticle/models/push_message_event.rb +369 -0
  70. data/lib/mparticle/models/push_registration_event.rb +269 -0
  71. data/lib/mparticle/models/screen_view_event.rb +264 -0
  72. data/lib/mparticle/models/session_end_event.rb +255 -0
  73. data/lib/mparticle/models/session_start_event.rb +241 -0
  74. data/lib/mparticle/models/shopping_cart.rb +183 -0
  75. data/lib/mparticle/models/source_information.rb +246 -0
  76. data/lib/mparticle/models/user_identities.rb +257 -0
  77. data/lib/mparticle/version.rb +3 -0
  78. data/lib/mparticle.rb +61 -0
  79. data/mparticle.gemspec +19 -0
  80. metadata +163 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ca3e0ee524d0b95fd3534b5a03d809ff605171eb
4
+ data.tar.gz: 8de4e9d9ee00daeabe689b29a6d755554b5cbda6
5
+ SHA512:
6
+ metadata.gz: f6081300e374d42ba3c0f74e1214d75f0757b037bb366581dbd435912760f0e1ed92848a67b07da8952a689552563e4972b827d50a84c8db263d82bb0c4c34d4
7
+ data.tar.gz: 02ac2a7897727924bcd57af06124f4d6050e4fbfab90d4a9a906a8af6eee43b4c6b86e21655fa621f4f9db7ed629093033226a68c6ff86b69a3541ff188f2c87
data/README.md ADDED
@@ -0,0 +1,73 @@
1
+ <img src="http://static.mparticle.com/sdk/logo.svg" width="280">
2
+
3
+ ## Ruby SDK
4
+
5
+ This is the mParticle Ruby client SDK - use it to send your data to the [mParticle platform](https://www.mparticle.com/) and off to 100+ app services.
6
+
7
+ ## Requirements
8
+
9
+ Ruby 1.9 or later
10
+
11
+ ### Installation
12
+
13
+ ```sh
14
+ gem install mparticle
15
+ ```
16
+
17
+ Or add it to your Gemfile:
18
+
19
+ ```ruby
20
+ gem 'mparticle'
21
+ ```
22
+
23
+ Import the package:
24
+
25
+ ```ruby
26
+ require 'mparticle'
27
+ ```
28
+
29
+ ### Usage
30
+
31
+ ```ruby
32
+ # load the gem
33
+ require 'mparticle'
34
+
35
+ # set credentials
36
+ config = MParticle::Configuration.new
37
+ config.api_key = 'REPLACE WITH API KEY'
38
+ config.api_secret = 'REPLACE WITH API SECRET'
39
+
40
+ api_instance = MParticle::EventsApi.new(config)
41
+
42
+ batch = MParticle::Batch.new
43
+ batch.environment = 'development'
44
+
45
+ app_event = MParticle::AppEvent.new
46
+ app_event.event_name = 'Test event'
47
+ app_event.custom_event_type = 'navigation'
48
+
49
+ batch.events = [MParticle::SessionStartEvent.new, app_event, MParticle::SessionEndEvent.new]
50
+
51
+ begin
52
+
53
+ # send events
54
+ thread = api_instance.upload_events(batch) { |data, status_code, headers|
55
+ if status_code == 202
56
+ puts "Upload complete"
57
+ end
58
+ }
59
+
60
+ # wait for the thread, if needed to prevent the process from terminating
61
+ thread.join
62
+
63
+ # you can also omit the callback and synchronously wait until the network request completes.
64
+ data, status_code, headers = api_instance.upload_events(batch)
65
+
66
+ rescue MParticle::ApiError => e
67
+ puts "Exception when calling mParticle: #{e}"
68
+ end
69
+ ```
70
+
71
+ ### License
72
+
73
+ [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
data/docs/ApiResponse.md ADDED
@@ -0,0 +1,8 @@
1
+ # MParticle::ApiResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **errors** | [**Array&lt;ApiResponseErrors&gt;**](ApiResponseErrors.md) | | [optional]
7
+
8
+
data/docs/ApiResponseErrors.md ADDED
@@ -0,0 +1,9 @@
1
+ # MParticle::ApiResponseErrors
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | | [optional]
7
+ **message** | **String** | | [optional]
8
+
9
+
data/docs/AppEvent.md ADDED
@@ -0,0 +1,18 @@
1
+ # MParticle::AppEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **timestamp_unixtime_ms** | **Integer** | | [optional]
7
+ **event_id** | **Integer** | | [optional]
8
+ **source_message_id** | **String** | | [optional]
9
+ **session_id** | **Integer** | | [optional]
10
+ **session_uuid** | **String** | | [optional]
11
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
12
+ **location** | [**GeoLocation**](GeoLocation.md) | | [optional]
13
+ **device_current_state** | [**DeviceCurrentState**](DeviceCurrentState.md) | | [optional]
14
+ **custom_event_type** | **String** | |
15
+ **event_name** | **String** | |
16
+ **media_info** | [**MediaInfo**](MediaInfo.md) | | [optional]
17
+
18
+
data/docs/ApplicationInformation.md ADDED
@@ -0,0 +1,11 @@
1
+ # MParticle::ApplicationInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **application_name** | **String** | | [optional]
7
+ **application_version** | **String** | | [optional]
8
+ **install_referrer** | **String** | | [optional]
9
+ **package** | **String** | | [optional]
10
+
11
+
data/docs/ApplicationStateTransitionEvent.md ADDED
@@ -0,0 +1,20 @@
1
+ # MParticle::ApplicationStateTransitionEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **timestamp_unixtime_ms** | **Integer** | | [optional]
7
+ **event_id** | **Integer** | | [optional]
8
+ **source_message_id** | **String** | | [optional]
9
+ **session_id** | **Integer** | | [optional]
10
+ **session_uuid** | **String** | | [optional]
11
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
12
+ **location** | [**GeoLocation**](GeoLocation.md) | | [optional]
13
+ **device_current_state** | [**DeviceCurrentState**](DeviceCurrentState.md) | | [optional]
14
+ **successfully_closed** | **BOOLEAN** | | [optional]
15
+ **is_first_run** | **BOOLEAN** | | [optional]
16
+ **is_upgrade** | **BOOLEAN** | | [optional]
17
+ **push_notification_payload** | **String** | | [optional]
18
+ **application_transition_type** | **String** | |
19
+
20
+
data/docs/AttributionInfo.md ADDED
@@ -0,0 +1,10 @@
1
+ # MParticle::AttributionInfo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **service_provider** | **String** | |
7
+ **publisher** | **String** | |
8
+ **campaign** | **String** | |
9
+
10
+
data/docs/Batch.md ADDED
@@ -0,0 +1,18 @@
1
+ # mParticle::Batch
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **events** | [**Array&lt;EventBase&gt;**](EventBase.md) | | [optional]
7
+ **source_request_id** | **String** | | [optional]
8
+ **environment** | **String** | |
9
+ **ip** | **String** | | [optional]
10
+ **schema_version** | **Integer** | | [optional]
11
+ **device_info** | [**DeviceInformation**](DeviceInformation.md) | | [optional]
12
+ **application_info** | [**ApplicationInformation**](ApplicationInformation.md) | | [optional]
13
+ **user_attributes** | **Object** | | [optional]
14
+ **deleted_user_attributes** | **Array&lt;String&gt;** | | [optional]
15
+ **user_identities** | [**UserIdentities**](UserIdentities.md) | | [optional]
16
+ **api_key** | **String** | | [optional]
17
+
18
+
data/docs/BreadcrumbEvent.md ADDED
@@ -0,0 +1,17 @@
1
+ # MParticle::BreadcrumbEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **timestamp_unixtime_ms** | **Integer** | | [optional]
7
+ **event_id** | **Integer** | | [optional]
8
+ **source_message_id** | **String** | | [optional]
9
+ **session_id** | **Integer** | | [optional]
10
+ **session_uuid** | **String** | | [optional]
11
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
12
+ **location** | [**GeoLocation**](GeoLocation.md) | | [optional]
13
+ **device_current_state** | [**DeviceCurrentState**](DeviceCurrentState.md) | | [optional]
14
+ **session_number** | **Integer** | |
15
+ **label** | **String** | |
16
+
17
+
data/docs/CommerceEvent.md ADDED
@@ -0,0 +1,22 @@
1
+ # MParticle::CommerceEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **timestamp_unixtime_ms** | **Integer** | | [optional]
7
+ **event_id** | **Integer** | | [optional]
8
+ **source_message_id** | **String** | | [optional]
9
+ **session_id** | **Integer** | | [optional]
10
+ **session_uuid** | **String** | | [optional]
11
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
12
+ **location** | [**GeoLocation**](GeoLocation.md) | | [optional]
13
+ **device_current_state** | [**DeviceCurrentState**](DeviceCurrentState.md) | | [optional]
14
+ **product_action** | [**ProductAction**](ProductAction.md) | | [optional]
15
+ **promotion_action** | [**PromotionAction**](PromotionAction.md) | | [optional]
16
+ **product_impressions** | [**Array&lt;ProductImpression&gt;**](ProductImpression.md) | | [optional]
17
+ **shopping_cart** | [**ShoppingCart**](ShoppingCart.md) | | [optional]
18
+ **currency_code** | **String** | | [optional]
19
+ **screen_name** | **String** | | [optional]
20
+ **is_non_interactive** | **BOOLEAN** | | [optional]
21
+
22
+
data/docs/CrashReportEvent.md ADDED
@@ -0,0 +1,26 @@
1
+ # MParticle::CrashReportEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **timestamp_unixtime_ms** | **Integer** | | [optional]
7
+ **event_id** | **Integer** | | [optional]
8
+ **source_message_id** | **String** | | [optional]
9
+ **session_id** | **Integer** | | [optional]
10
+ **session_uuid** | **String** | | [optional]
11
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
12
+ **location** | [**GeoLocation**](GeoLocation.md) | | [optional]
13
+ **device_current_state** | [**DeviceCurrentState**](DeviceCurrentState.md) | | [optional]
14
+ **breadcrumbs** | [**Array&lt;BreadcrumbEvent&gt;**](BreadcrumbEvent.md) | | [optional]
15
+ **class_name** | **String** | |
16
+ **severity** | **String** | | [optional]
17
+ **message** | **String** | |
18
+ **stack_trace** | **String** | |
19
+ **exception_handled** | **BOOLEAN** | |
20
+ **topmost_context** | **String** | | [optional]
21
+ **pl_crash_report_file_base64** | **String** | | [optional]
22
+ **ios_image_base_address** | **Integer** | | [optional]
23
+ **ios_image_size** | **Integer** | | [optional]
24
+ **session_number** | **Integer** | | [optional]
25
+
26
+
data/docs/DeviceCurrentState.md ADDED
@@ -0,0 +1,23 @@
1
+ # MParticle::DeviceCurrentState
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **time_since_start_ms** | **Integer** | | [optional]
7
+ **battery_level** | **Float** | | [optional]
8
+ **data_connection_type** | **String** | | [optional]
9
+ **data_connection_type_detail** | **String** | | [optional]
10
+ **gps_state** | **BOOLEAN** | | [optional]
11
+ **total_system_memory_usage_bytes** | **Integer** | | [optional]
12
+ **disk_space_free_bytes** | **Integer** | | [optional]
13
+ **cpu** | **String** | | [optional]
14
+ **system_memory_available_bytes** | **Float** | | [optional]
15
+ **system_memory_low** | **BOOLEAN** | | [optional]
16
+ **system_memory_threshold_bytes** | **Float** | | [optional]
17
+ **application_memory_available_bytes** | **Float** | | [optional]
18
+ **application_memory_max_bytes** | **Float** | | [optional]
19
+ **application_memory_total_bytes** | **Float** | | [optional]
20
+ **device_orientation** | **String** | | [optional]
21
+ **status_bar_orientation** | **String** | | [optional]
22
+
23
+
data/docs/DeviceInformation.md ADDED
@@ -0,0 +1,41 @@
1
+ # MParticle::DeviceInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **brand** | **String** | | [optional]
7
+ **product** | **String** | | [optional]
8
+ **device** | **String** | | [optional]
9
+ **android_uuid** | **String** | | [optional]
10
+ **device_manufacturer** | **String** | | [optional]
11
+ **platform** | **String** | | [optional]
12
+ **os_version** | **String** | | [optional]
13
+ **device_model** | **String** | | [optional]
14
+ **screen_height** | **Integer** | | [optional]
15
+ **screen_width** | **Integer** | | [optional]
16
+ **screen_dpi** | **Integer** | | [optional]
17
+ **device_country** | **String** | | [optional]
18
+ **locale_language** | **String** | | [optional]
19
+ **locale_country** | **String** | | [optional]
20
+ **network_country** | **String** | | [optional]
21
+ **network_carrier** | **String** | | [optional]
22
+ **network_code** | **String** | | [optional]
23
+ **network_mobile_country_code** | **String** | | [optional]
24
+ **timezone_offset** | **Integer** | | [optional]
25
+ **build_identifier** | **String** | | [optional]
26
+ **http_header_user_agent** | **String** | | [optional]
27
+ **ios_advertising_id** | **String** | | [optional]
28
+ **push_token** | **String** | | [optional]
29
+ **cpu_architecture** | **String** | | [optional]
30
+ **is_tablet** | **BOOLEAN** | | [optional]
31
+ **push_notification_sound_enabled** | **BOOLEAN** | | [optional]
32
+ **push_notification_vibrate_enabled** | **BOOLEAN** | | [optional]
33
+ **radio_access_technology** | **String** | | [optional]
34
+ **supports_telephony** | **BOOLEAN** | | [optional]
35
+ **has_nfc** | **BOOLEAN** | | [optional]
36
+ **bluetooth_enabled** | **BOOLEAN** | | [optional]
37
+ **bluetooth_version** | **String** | | [optional]
38
+ **ios_idfv** | **String** | | [optional]
39
+ **android_advertising_id** | **String** | | [optional]
40
+
41
+
data/docs/EventBase.md ADDED
@@ -0,0 +1,9 @@
1
+ # MParticle::EventBase
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**EventData**](EventData.md) | |
7
+ **event_type** | **String** | |
8
+
9
+
data/docs/EventData.md ADDED
@@ -0,0 +1,15 @@
1
+ # MParticle::EventData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **timestamp_unixtime_ms** | **Integer** | | [optional]
7
+ **event_id** | **Integer** | | [optional]
8
+ **source_message_id** | **String** | | [optional]
9
+ **session_id** | **Integer** | | [optional]
10
+ **session_uuid** | **String** | | [optional]
11
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
12
+ **location** | [**GeoLocation**](GeoLocation.md) | | [optional]
13
+ **device_current_state** | [**DeviceCurrentState**](DeviceCurrentState.md) | | [optional]
14
+
15
+
data/docs/EventsApi.md ADDED
@@ -0,0 +1,124 @@
1
+ # MParticle::EventsApi
2
+
3
+ All URIs are relative to *https://s2s.mparticle.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**bulk_upload_events**](EventsApi.md#bulk_upload_events) | **POST** /bulkevents | Send events to mParticle
8
+ [**upload_events**](EventsApi.md#upload_events) | **POST** /events | Send events to mParticle
9
+
10
+
11
+ # **bulk_upload_events**
12
+ > bulk_upload_events(body)
13
+
14
+ Send events to mParticle
15
+
16
+
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'mparticle'
22
+ MParticle.configure do |config|
23
+ # set credentials
24
+ config.api_key = 'REPLACE WITH API KEY'
25
+ config.api_secret = 'REPLACE WITH API SECRET'
26
+ end
27
+
28
+ api_instance = MParticle::EventsApi.new
29
+
30
+ batch = MParticle::Batch.new
31
+ batch.environment = 'development'
32
+
33
+ app_event = MParticle::AppEvent.new
34
+ app_event.event_name = 'Test event'
35
+ app_event.custom_event_type = 'navigation'
36
+
37
+ batch.events = [MParticle::SessionStartEvent.new, app_event, MParticle::SessionEndEvent.new]
38
+
39
+ begin
40
+ # send events
41
+ api_instance.bulk_upload_events(batch)
42
+ rescue MParticle::ApiError => e
43
+ puts "Exception when calling mParticle: #{e}"
44
+ end
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+ Name | Type | Description | Notes
50
+ ------------- | ------------- | ------------- | -------------
51
+ **body** | [**Array&lt;Batch&gt;**](Batch.md)| Up to 100 Batch objects |
52
+
53
+ ### Return type
54
+
55
+ nil (empty response body)
56
+
57
+ ### Authorization
58
+
59
+ [basic](../README.md#basic)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: application/json
64
+ - **Accept**: text/html, application/json
65
+
66
+
67
+
68
+ # **upload_events**
69
+ > upload_events(body)
70
+
71
+ Send events to mParticle
72
+
73
+
74
+
75
+ ### Example
76
+ ```ruby
77
+ # load the gem
78
+ require 'mparticle'
79
+ MParticle.configure do |config|
80
+ # set credentials
81
+ config.api_key = 'REPLACE WITH API KEY'
82
+ config.api_secret = 'REPLACE WITH API SECRET'
83
+ end
84
+
85
+ api_instance = MParticle::EventsApi.new
86
+
87
+ batch = MParticle::Batch.new
88
+ batch.environment = 'development'
89
+
90
+ app_event = MParticle::AppEvent.new
91
+ app_event.event_name = 'Test event'
92
+ app_event.custom_event_type = 'navigation'
93
+
94
+ batch.events = [MParticle::SessionStartEvent.new, app_event, MParticle::SessionEndEvent.new]
95
+
96
+ begin
97
+ # send events
98
+ api_instance.upload_events(batch)
99
+ rescue MParticle::ApiError => e
100
+ puts "Exception when calling mParticle: #{e}"
101
+ end
102
+ ```
103
+
104
+ ### Parameters
105
+
106
+ Name | Type | Description | Notes
107
+ ------------- | ------------- | ------------- | -------------
108
+ **body** | [**Batch**](Batch.md)| Batch of event data |
109
+
110
+ ### Return type
111
+
112
+ nil (empty response body)
113
+
114
+ ### Authorization
115
+
116
+ [basic](../README.md#basic)
117
+
118
+ ### HTTP request headers
119
+
120
+ - **Content-Type**: application/json
121
+ - **Accept**: text/html, application/json
122
+
123
+
124
+
data/docs/FirstRunEvent.md ADDED
@@ -0,0 +1,15 @@
1
+ # MParticle::FirstRunEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **timestamp_unixtime_ms** | **Integer** | | [optional]
7
+ **event_id** | **Integer** | | [optional]
8
+ **source_message_id** | **String** | | [optional]
9
+ **session_id** | **Integer** | | [optional]
10
+ **session_uuid** | **String** | | [optional]
11
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
12
+ **location** | [**GeoLocation**](GeoLocation.md) | | [optional]
13
+ **device_current_state** | [**DeviceCurrentState**](DeviceCurrentState.md) | | [optional]
14
+
15
+
data/docs/GeoLocation.md ADDED
@@ -0,0 +1,10 @@
1
+ # MParticle::GeoLocation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **latitude** | **Float** | |
7
+ **longitude** | **Float** | |
8
+ **accuracy** | **Float** | | [optional]
9
+
10
+
data/docs/MediaInfo.md ADDED
@@ -0,0 +1,15 @@
1
+ # MParticle::MediaInfo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action** | **String** | | [optional]
7
+ **channel** | **String** | | [optional]
8
+ **metadata** | **String** | | [optional]
9
+ **timed_metadata** | **String** | | [optional]
10
+ **playback_position** | **Float** | | [optional]
11
+ **format** | **String** | | [optional]
12
+ **quality** | **String** | | [optional]
13
+ **playback_rate** | **Float** | | [optional]
14
+
15
+
data/docs/NetworkPerformanceEvent.md ADDED
@@ -0,0 +1,22 @@
1
+ # MParticle::NetworkPerformanceEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **timestamp_unixtime_ms** | **Integer** | | [optional]
7
+ **event_id** | **Integer** | | [optional]
8
+ **source_message_id** | **String** | | [optional]
9
+ **session_id** | **Integer** | | [optional]
10
+ **session_uuid** | **String** | | [optional]
11
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
12
+ **location** | [**GeoLocation**](GeoLocation.md) | | [optional]
13
+ **device_current_state** | [**DeviceCurrentState**](DeviceCurrentState.md) | | [optional]
14
+ **http_verb** | **String** | |
15
+ **url** | **String** | |
16
+ **time_elapsed** | **Integer** | |
17
+ **bytes_in** | **Integer** | |
18
+ **bytes_out** | **Integer** | |
19
+ **response_code** | **Integer** | |
20
+ **data** | **String** | | [optional]
21
+
22
+
data/docs/OptOutEvent.md ADDED
@@ -0,0 +1,16 @@
1
+ # MParticle::OptOutEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **timestamp_unixtime_ms** | **Integer** | | [optional]
7
+ **event_id** | **Integer** | | [optional]
8
+ **source_message_id** | **String** | | [optional]
9
+ **session_id** | **Integer** | | [optional]
10
+ **session_uuid** | **String** | | [optional]
11
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
12
+ **location** | [**GeoLocation**](GeoLocation.md) | | [optional]
13
+ **device_current_state** | [**DeviceCurrentState**](DeviceCurrentState.md) | | [optional]
14
+ **is_opted_out** | **BOOLEAN** | |
15
+
16
+
data/docs/Product.md ADDED
@@ -0,0 +1,19 @@
1
+ # MParticle::Product
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | |
7
+ **name** | **String** | |
8
+ **brand** | **String** | | [optional]
9
+ **category** | **String** | | [optional]
10
+ **variant** | **String** | | [optional]
11
+ **position** | **Integer** | | [optional]
12
+ **price** | **Float** | |
13
+ **quantity** | **Float** | | [optional]
14
+ **coupon_code** | **String** | | [optional]
15
+ **added_to_cart_time_ms** | **Integer** | | [optional]
16
+ **total_product_amount** | **Float** | |
17
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
18
+
19
+
data/docs/ProductAction.md ADDED
@@ -0,0 +1,19 @@
1
+ # MParticle::ProductAction
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action** | **String** | |
7
+ **checkout_step** | **Integer** | | [optional]
8
+ **checkout_options** | **String** | | [optional]
9
+ **product_action_list** | **String** | | [optional]
10
+ **product_list_source** | **String** | | [optional]
11
+ **transaction_id** | **String** | |
12
+ **affiliation** | **String** | | [optional]
13
+ **total_amount** | **Float** | |
14
+ **tax_amount** | **Float** | | [optional]
15
+ **shipping_amount** | **Float** | | [optional]
16
+ **coupon_code** | **String** | | [optional]
17
+ **products** | [**Array&lt;Product&gt;**](Product.md) | |
18
+
19
+
data/docs/ProductImpression.md ADDED
@@ -0,0 +1,9 @@
1
+ # MParticle::ProductImpression
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **product_impression_list** | **String** | |
7
+ **products** | [**Array&lt;Product&gt;**](Product.md) | |
8
+
9
+
data/docs/ProfileEvent.md ADDED
@@ -0,0 +1,18 @@
1
+ # MParticle::ProfileEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **timestamp_unixtime_ms** | **Integer** | | [optional]
7
+ **event_id** | **Integer** | | [optional]
8
+ **source_message_id** | **String** | | [optional]
9
+ **session_id** | **Integer** | | [optional]
10
+ **session_uuid** | **String** | | [optional]
11
+ **custom_attributes** | **Hash&lt;String, String&gt;** | | [optional]
12
+ **location** | [**GeoLocation**](GeoLocation.md) | | [optional]
13
+ **device_current_state** | [**DeviceCurrentState**](DeviceCurrentState.md) | | [optional]
14
+ **profile_name** | **String** | |
15
+ **previous_profile_name** | **String** | |
16
+ **profile_event_type** | **String** | |
17
+
18
+
data/docs/Promotion.md ADDED
@@ -0,0 +1,11 @@
1
+ # MParticle::Promotion
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | |
7
+ **name** | **String** | |
8
+ **creative** | **String** | |
9
+ **position** | **String** | |
10
+
11
+
data/docs/PromotionAction.md ADDED
@@ -0,0 +1,9 @@
1
+ # MParticle::PromotionAction
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action** | **String** | |
7
+ **promotions** | [**Array&lt;Promotion&gt;**](Promotion.md) | |
8
+
9
+