braze_api_client 0.1.0 → 0.1.1

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 (65) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/braze_api_client.gemspec +1 -1
  4. data/docs/RestApi.md +26 -26
  5. data/docs/UsersAliasNewResponse.md +20 -0
  6. data/docs/{IdentifierOneOf.md → UsersDeleteResponse.md} +4 -4
  7. data/docs/UsersExternalIdsRemoveResponse.md +22 -0
  8. data/docs/UsersExternalIdsRenameResponse.md +22 -0
  9. data/docs/UsersExternalIdsRenameResponseExternalIds.md +20 -0
  10. data/docs/UsersIdentifyResponse.md +20 -0
  11. data/lib/braze_api_client/api/rest_api.rb +25 -25
  12. data/lib/braze_api_client/api_client.rb +2 -2
  13. data/lib/braze_api_client/api_error.rb +1 -1
  14. data/lib/braze_api_client/configuration.rb +1 -1
  15. data/lib/braze_api_client/models/general_error.rb +1 -1
  16. data/lib/braze_api_client/models/{attributes_array.rb → users_alias_new_response.rb} +20 -18
  17. data/lib/braze_api_client/models/{events_array.rb → users_delete_response.rb} +11 -13
  18. data/lib/braze_api_client/models/{users_track_request.rb → users_external_ids_remove_response.rb} +32 -37
  19. data/lib/braze_api_client/models/{attributes_push_tokens.rb → users_external_ids_rename_response.rb} +27 -33
  20. data/lib/braze_api_client/models/{attributes_facebook.rb → users_external_ids_rename_response_external_ids.rb} +17 -28
  21. data/lib/braze_api_client/models/{attributes_current_location.rb → users_identify_response.rb} +17 -17
  22. data/lib/braze_api_client/models/users_track_response.rb +1 -1
  23. data/lib/braze_api_client/version.rb +2 -2
  24. data/lib/braze_api_client.rb +7 -14
  25. data/spec/api/rest_api_spec.rb +7 -7
  26. data/spec/api_client_spec.rb +1 -1
  27. data/spec/configuration_spec.rb +1 -1
  28. data/spec/models/general_error_spec.rb +1 -1
  29. data/spec/models/{attributes_current_location_spec.rb → users_alias_new_response_spec.rb} +9 -9
  30. data/spec/models/{identifier_one_of2_spec.rb → users_delete_response_spec.rb} +8 -8
  31. data/spec/models/{attributes_facebook_spec.rb → users_external_ids_remove_response_spec.rb} +10 -10
  32. data/spec/models/users_external_ids_rename_response_external_ids_spec.rb +40 -0
  33. data/spec/models/{attributes_push_tokens_spec.rb → users_external_ids_rename_response_spec.rb} +10 -10
  34. data/spec/models/users_identify_response_spec.rb +40 -0
  35. data/spec/models/users_track_response_spec.rb +1 -1
  36. data/spec/spec_helper.rb +1 -1
  37. metadata +26 -54
  38. data/docs/Attributes.md +0 -58
  39. data/docs/AttributesArray.md +0 -18
  40. data/docs/AttributesCurrentLocation.md +0 -20
  41. data/docs/AttributesFacebook.md +0 -22
  42. data/docs/AttributesPushTokens.md +0 -22
  43. data/docs/AttributesTwitter.md +0 -26
  44. data/docs/Event.md +0 -26
  45. data/docs/EventsArray.md +0 -18
  46. data/docs/Identifier.md +0 -51
  47. data/docs/IdentifierOneOf1.md +0 -18
  48. data/docs/IdentifierOneOf2.md +0 -18
  49. data/docs/UsersTrackRequest.md +0 -18
  50. data/lib/braze_api_client/models/attributes.rb +0 -458
  51. data/lib/braze_api_client/models/attributes_twitter.rb +0 -254
  52. data/lib/braze_api_client/models/event.rb +0 -264
  53. data/lib/braze_api_client/models/identifier.rb +0 -106
  54. data/lib/braze_api_client/models/identifier_one_of.rb +0 -223
  55. data/lib/braze_api_client/models/identifier_one_of1.rb +0 -223
  56. data/lib/braze_api_client/models/identifier_one_of2.rb +0 -223
  57. data/spec/models/attributes_array_spec.rb +0 -34
  58. data/spec/models/attributes_spec.rb +0 -166
  59. data/spec/models/attributes_twitter_spec.rb +0 -58
  60. data/spec/models/event_spec.rb +0 -58
  61. data/spec/models/events_array_spec.rb +0 -34
  62. data/spec/models/identifier_one_of1_spec.rb +0 -34
  63. data/spec/models/identifier_one_of_spec.rb +0 -34
  64. data/spec/models/identifier_spec.rb +0 -31
  65. data/spec/models/users_track_request_spec.rb +0 -34
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5f798e36c422e6bf7b20f8a03b3eb14a62f7a33c2169220b716f1f28d4c04155
4
- data.tar.gz: 65ef0db1d80017692361d0f54d7347da78b91fc6e378edf1030767682ad15053
3
+ metadata.gz: e8bd7a3f8ab3a07ce8a525845cfa37013876d763bb7bb98743a251ffd58f67de
4
+ data.tar.gz: ab16b38f9d0f5c3742f5b2f4b22dfc4c4044abc99acb8946d14d75420ea9fa82
5
5
  SHA512:
6
- metadata.gz: e32681c682c8f6702c7b99dc0d7703b9280abfbecf1a3016d3a8a7563ccf377d93ed28bdc0f574324d4a32d3d0d411ee9c3d0ea19ec695131341ed184dcb6d0d
7
- data.tar.gz: a1faaf88c9a086f4897fb3d1f3b4999f4a3f467e7fef2253a48c3e88a578947d457bfbfe715da0eab5f457efc09461f5627f40ad53ebb6a74d5645b25381d84c
6
+ metadata.gz: '069bd0032be5a76f93b87d1db25e55d6263344bfb3cc19f15c714795dbb811d0247ea56ef86b1c965bc7e58dd8aff51c05e1e7a56f474a30bff3f4200fb93dd4'
7
+ data.tar.gz: 4d764b76ed9281d54764bf031169c0c1040cb139db4d909644dd79bf2b340881fae2b0701281cd2a69d87a2e2d3765b045e80da64f45f9bd75e61a1ab2de0558
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Braze API Ruby Client ![Tests](https://img.shields.io/github/workflow/status/braze-inc/braze-api-client-ruby/rspec) [![Gem Version](https://img.shields.io/gem/v/braze_client.svg)](https://rubygems.org/gems/braze_client)
1
+ # Braze API Ruby Client [![Ruby](https://github.com/braze-inc/braze-api-client-ruby/actions/workflows/rspec.yaml/badge.svg)](https://github.com/braze-inc/braze-api-client-ruby/actions/workflows/rspec.yaml) [![Gem Version](https://img.shields.io/gem/v/braze_api_client.svg)](https://rubygems.org/gems/braze_api_client)
2
2
 
3
3
  Track users, send messages, export data, and more
4
4
 
@@ -186,6 +186,6 @@ end
186
186
 
187
187
  This library is automatically generated. To make changes, please see [braze-api-client-codegen](https://github.com/braze-inc/braze-api-client-codegen)
188
188
 
189
- - API version: 0.1.0
190
- - Package version: 0.1.0
189
+ - API version: 0.1.1
190
+ - Package version: 0.1.1
191
191
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
@@ -5,7 +5,7 @@
5
5
 
6
6
  #Track users, send messages, export data, and more
7
7
 
8
- The version of the OpenAPI document: 0.1.0
8
+ The version of the OpenAPI document: 0.1.1
9
9
 
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 5.2.1
data/docs/RestApi.md CHANGED
@@ -14,7 +14,7 @@ All URIs are relative to *https://rest.iad-01.braze.com*
14
14
 
15
15
  ## delete_users
16
16
 
17
- > Object delete_users(body)
17
+ > <UsersDeleteResponse> delete_users(body)
18
18
 
19
19
 
20
20
 
@@ -47,7 +47,7 @@ end
47
47
 
48
48
  This returns an Array which contains the response data, status code and headers.
49
49
 
50
- > <Array(Object, Integer, Hash)> delete_users_with_http_info(body)
50
+ > <Array(<UsersDeleteResponse>, Integer, Hash)> delete_users_with_http_info(body)
51
51
 
52
52
  ```ruby
53
53
  begin
@@ -55,7 +55,7 @@ begin
55
55
  data, status_code, headers = api_instance.delete_users_with_http_info(body)
56
56
  p status_code # => 2xx
57
57
  p headers # => { ... }
58
- p data # => Object
58
+ p data # => <UsersDeleteResponse>
59
59
  rescue BrazeClient::ApiError => e
60
60
  puts "Error when calling RestApi->delete_users_with_http_info: #{e}"
61
61
  end
@@ -69,7 +69,7 @@ end
69
69
 
70
70
  ### Return type
71
71
 
72
- **Object**
72
+ [**UsersDeleteResponse**](UsersDeleteResponse.md)
73
73
 
74
74
  ### Authorization
75
75
 
@@ -83,7 +83,7 @@ end
83
83
 
84
84
  ## identify_users
85
85
 
86
- > Object identify_users(body)
86
+ > <UsersIdentifyResponse> identify_users(body)
87
87
 
88
88
 
89
89
 
@@ -116,7 +116,7 @@ end
116
116
 
117
117
  This returns an Array which contains the response data, status code and headers.
118
118
 
119
- > <Array(Object, Integer, Hash)> identify_users_with_http_info(body)
119
+ > <Array(<UsersIdentifyResponse>, Integer, Hash)> identify_users_with_http_info(body)
120
120
 
121
121
  ```ruby
122
122
  begin
@@ -124,7 +124,7 @@ begin
124
124
  data, status_code, headers = api_instance.identify_users_with_http_info(body)
125
125
  p status_code # => 2xx
126
126
  p headers # => { ... }
127
- p data # => Object
127
+ p data # => <UsersIdentifyResponse>
128
128
  rescue BrazeClient::ApiError => e
129
129
  puts "Error when calling RestApi->identify_users_with_http_info: #{e}"
130
130
  end
@@ -138,7 +138,7 @@ end
138
138
 
139
139
  ### Return type
140
140
 
141
- **Object**
141
+ [**UsersIdentifyResponse**](UsersIdentifyResponse.md)
142
142
 
143
143
  ### Authorization
144
144
 
@@ -152,7 +152,7 @@ end
152
152
 
153
153
  ## new_user_aliases
154
154
 
155
- > Object new_user_aliases(body)
155
+ > <UsersAliasNewResponse> new_user_aliases(body)
156
156
 
157
157
 
158
158
 
@@ -185,7 +185,7 @@ end
185
185
 
186
186
  This returns an Array which contains the response data, status code and headers.
187
187
 
188
- > <Array(Object, Integer, Hash)> new_user_aliases_with_http_info(body)
188
+ > <Array(<UsersAliasNewResponse>, Integer, Hash)> new_user_aliases_with_http_info(body)
189
189
 
190
190
  ```ruby
191
191
  begin
@@ -193,7 +193,7 @@ begin
193
193
  data, status_code, headers = api_instance.new_user_aliases_with_http_info(body)
194
194
  p status_code # => 2xx
195
195
  p headers # => { ... }
196
- p data # => Object
196
+ p data # => <UsersAliasNewResponse>
197
197
  rescue BrazeClient::ApiError => e
198
198
  puts "Error when calling RestApi->new_user_aliases_with_http_info: #{e}"
199
199
  end
@@ -207,7 +207,7 @@ end
207
207
 
208
208
  ### Return type
209
209
 
210
- **Object**
210
+ [**UsersAliasNewResponse**](UsersAliasNewResponse.md)
211
211
 
212
212
  ### Authorization
213
213
 
@@ -221,7 +221,7 @@ end
221
221
 
222
222
  ## remove_external_ids
223
223
 
224
- > Object remove_external_ids(body)
224
+ > <UsersExternalIdsRemoveResponse> remove_external_ids(body)
225
225
 
226
226
 
227
227
 
@@ -254,7 +254,7 @@ end
254
254
 
255
255
  This returns an Array which contains the response data, status code and headers.
256
256
 
257
- > <Array(Object, Integer, Hash)> remove_external_ids_with_http_info(body)
257
+ > <Array(<UsersExternalIdsRemoveResponse>, Integer, Hash)> remove_external_ids_with_http_info(body)
258
258
 
259
259
  ```ruby
260
260
  begin
@@ -262,7 +262,7 @@ begin
262
262
  data, status_code, headers = api_instance.remove_external_ids_with_http_info(body)
263
263
  p status_code # => 2xx
264
264
  p headers # => { ... }
265
- p data # => Object
265
+ p data # => <UsersExternalIdsRemoveResponse>
266
266
  rescue BrazeClient::ApiError => e
267
267
  puts "Error when calling RestApi->remove_external_ids_with_http_info: #{e}"
268
268
  end
@@ -276,7 +276,7 @@ end
276
276
 
277
277
  ### Return type
278
278
 
279
- **Object**
279
+ [**UsersExternalIdsRemoveResponse**](UsersExternalIdsRemoveResponse.md)
280
280
 
281
281
  ### Authorization
282
282
 
@@ -290,7 +290,7 @@ end
290
290
 
291
291
  ## rename_external_ids
292
292
 
293
- > Object rename_external_ids(body)
293
+ > <UsersExternalIdsRenameResponse> rename_external_ids(body)
294
294
 
295
295
 
296
296
 
@@ -323,7 +323,7 @@ end
323
323
 
324
324
  This returns an Array which contains the response data, status code and headers.
325
325
 
326
- > <Array(Object, Integer, Hash)> rename_external_ids_with_http_info(body)
326
+ > <Array(<UsersExternalIdsRenameResponse>, Integer, Hash)> rename_external_ids_with_http_info(body)
327
327
 
328
328
  ```ruby
329
329
  begin
@@ -331,7 +331,7 @@ begin
331
331
  data, status_code, headers = api_instance.rename_external_ids_with_http_info(body)
332
332
  p status_code # => 2xx
333
333
  p headers # => { ... }
334
- p data # => Object
334
+ p data # => <UsersExternalIdsRenameResponse>
335
335
  rescue BrazeClient::ApiError => e
336
336
  puts "Error when calling RestApi->rename_external_ids_with_http_info: #{e}"
337
337
  end
@@ -345,7 +345,7 @@ end
345
345
 
346
346
  ### Return type
347
347
 
348
- **Object**
348
+ [**UsersExternalIdsRenameResponse**](UsersExternalIdsRenameResponse.md)
349
349
 
350
350
  ### Authorization
351
351
 
@@ -359,7 +359,7 @@ end
359
359
 
360
360
  ## track_users
361
361
 
362
- > <UsersTrackResponse> track_users(users_track_request)
362
+ > <UsersTrackResponse> track_users(body)
363
363
 
364
364
 
365
365
 
@@ -377,11 +377,11 @@ BrazeClient.configure do |config|
377
377
  end
378
378
 
379
379
  api_instance = BrazeClient::RestApi.new
380
- users_track_request = BrazeClient::UsersTrackRequest.new({attributes: [BrazeClient::Event.new({name: 'name_example', time: Time.now})]}) # UsersTrackRequest |
380
+ body = Object # Object |
381
381
 
382
382
  begin
383
383
 
384
- result = api_instance.track_users(users_track_request)
384
+ result = api_instance.track_users(body)
385
385
  p result
386
386
  rescue BrazeClient::ApiError => e
387
387
  puts "Error when calling RestApi->track_users: #{e}"
@@ -392,12 +392,12 @@ end
392
392
 
393
393
  This returns an Array which contains the response data, status code and headers.
394
394
 
395
- > <Array(<UsersTrackResponse>, Integer, Hash)> track_users_with_http_info(users_track_request)
395
+ > <Array(<UsersTrackResponse>, Integer, Hash)> track_users_with_http_info(body)
396
396
 
397
397
  ```ruby
398
398
  begin
399
399
 
400
- data, status_code, headers = api_instance.track_users_with_http_info(users_track_request)
400
+ data, status_code, headers = api_instance.track_users_with_http_info(body)
401
401
  p status_code # => 2xx
402
402
  p headers # => { ... }
403
403
  p data # => <UsersTrackResponse>
@@ -410,7 +410,7 @@ end
410
410
 
411
411
  | Name | Type | Description | Notes |
412
412
  | ---- | ---- | ----------- | ----- |
413
- | **users_track_request** | [**UsersTrackRequest**](UsersTrackRequest.md) | | |
413
+ | **body** | **Object** | | |
414
414
 
415
415
  ### Return type
416
416
 
@@ -0,0 +1,20 @@
1
+ # BrazeClient::UsersAliasNewResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **aliases_processed** | **Integer** | | [optional] |
8
+ | **message** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'braze_api_client'
14
+
15
+ instance = BrazeClient::UsersAliasNewResponse.new(
16
+ aliases_processed: null,
17
+ message: null
18
+ )
19
+ ```
20
+
@@ -1,18 +1,18 @@
1
- # BrazeClient::IdentifierOneOf
1
+ # BrazeClient::UsersDeleteResponse
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **external_id** | **String** | | |
7
+ | **deleted** | **Integer** | | [optional] |
8
8
 
9
9
  ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'braze_api_client'
13
13
 
14
- instance = BrazeClient::IdentifierOneOf.new(
15
- external_id: null
14
+ instance = BrazeClient::UsersDeleteResponse.new(
15
+ deleted: null
16
16
  )
17
17
  ```
18
18
 
@@ -0,0 +1,22 @@
1
+ # BrazeClient::UsersExternalIdsRemoveResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | | [optional] |
8
+ | **removal_errors** | **Array&lt;Object&gt;** | | [optional] |
9
+ | **removed_ids** | **Array&lt;String&gt;** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'braze_api_client'
15
+
16
+ instance = BrazeClient::UsersExternalIdsRemoveResponse.new(
17
+ message: null,
18
+ removal_errors: null,
19
+ removed_ids: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # BrazeClient::UsersExternalIdsRenameResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | | [optional] |
8
+ | **rename_errors** | **Array&lt;Object&gt;** | | [optional] |
9
+ | **external_ids** | [**Array&lt;UsersExternalIdsRenameResponseExternalIds&gt;**](UsersExternalIdsRenameResponseExternalIds.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'braze_api_client'
15
+
16
+ instance = BrazeClient::UsersExternalIdsRenameResponse.new(
17
+ message: null,
18
+ rename_errors: null,
19
+ external_ids: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # BrazeClient::UsersExternalIdsRenameResponseExternalIds
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **current_external_id** | **String** | | [optional] |
8
+ | **new_external_id** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'braze_api_client'
14
+
15
+ instance = BrazeClient::UsersExternalIdsRenameResponseExternalIds.new(
16
+ current_external_id: null,
17
+ new_external_id: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # BrazeClient::UsersIdentifyResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | | [optional] |
8
+ | **aliases_processed** | **Integer** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'braze_api_client'
14
+
15
+ instance = BrazeClient::UsersIdentifyResponse.new(
16
+ message: null,
17
+ aliases_processed: null
18
+ )
19
+ ```
20
+
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Track users, send messages, export data, and more
5
5
 
6
- The version of the OpenAPI document: 0.1.0
6
+ The version of the OpenAPI document: 0.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.1
@@ -22,7 +22,7 @@ module BrazeClient
22
22
  # Delete any user profile by specifying a known user identifier
23
23
  # @param body [Object]
24
24
  # @param [Hash] opts the optional parameters
25
- # @return [Object]
25
+ # @return [UsersDeleteResponse]
26
26
  def delete_users(body, opts = {})
27
27
  data, _status_code, _headers = delete_users_with_http_info(body, opts)
28
28
  data
@@ -31,7 +31,7 @@ module BrazeClient
31
31
  # Delete any user profile by specifying a known user identifier
32
32
  # @param body [Object]
33
33
  # @param [Hash] opts the optional parameters
34
- # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
34
+ # @return [Array<(UsersDeleteResponse, Integer, Hash)>] UsersDeleteResponse data, response status code and response headers
35
35
  def delete_users_with_http_info(body, opts = {})
36
36
  if @api_client.config.debugging
37
37
  @api_client.config.logger.debug 'Calling API: RestApi.delete_users ...'
@@ -60,7 +60,7 @@ module BrazeClient
60
60
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
61
61
 
62
62
  # return_type
63
- return_type = opts[:debug_return_type] || 'Object'
63
+ return_type = opts[:debug_return_type] || 'UsersDeleteResponse'
64
64
 
65
65
  # auth_names
66
66
  auth_names = opts[:debug_auth_names] || ['bearerAuth']
@@ -85,7 +85,7 @@ module BrazeClient
85
85
  # Identify an unidentified (alias-only) user
86
86
  # @param body [Object]
87
87
  # @param [Hash] opts the optional parameters
88
- # @return [Object]
88
+ # @return [UsersIdentifyResponse]
89
89
  def identify_users(body, opts = {})
90
90
  data, _status_code, _headers = identify_users_with_http_info(body, opts)
91
91
  data
@@ -94,7 +94,7 @@ module BrazeClient
94
94
  # Identify an unidentified (alias-only) user
95
95
  # @param body [Object]
96
96
  # @param [Hash] opts the optional parameters
97
- # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
97
+ # @return [Array<(UsersIdentifyResponse, Integer, Hash)>] UsersIdentifyResponse data, response status code and response headers
98
98
  def identify_users_with_http_info(body, opts = {})
99
99
  if @api_client.config.debugging
100
100
  @api_client.config.logger.debug 'Calling API: RestApi.identify_users ...'
@@ -123,7 +123,7 @@ module BrazeClient
123
123
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
124
124
 
125
125
  # return_type
126
- return_type = opts[:debug_return_type] || 'Object'
126
+ return_type = opts[:debug_return_type] || 'UsersIdentifyResponse'
127
127
 
128
128
  # auth_names
129
129
  auth_names = opts[:debug_auth_names] || ['bearerAuth']
@@ -148,7 +148,7 @@ module BrazeClient
148
148
  # Add new user aliases for existing identified users or create new unidentified users
149
149
  # @param body [Object]
150
150
  # @param [Hash] opts the optional parameters
151
- # @return [Object]
151
+ # @return [UsersAliasNewResponse]
152
152
  def new_user_aliases(body, opts = {})
153
153
  data, _status_code, _headers = new_user_aliases_with_http_info(body, opts)
154
154
  data
@@ -157,7 +157,7 @@ module BrazeClient
157
157
  # Add new user aliases for existing identified users or create new unidentified users
158
158
  # @param body [Object]
159
159
  # @param [Hash] opts the optional parameters
160
- # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
160
+ # @return [Array<(UsersAliasNewResponse, Integer, Hash)>] UsersAliasNewResponse data, response status code and response headers
161
161
  def new_user_aliases_with_http_info(body, opts = {})
162
162
  if @api_client.config.debugging
163
163
  @api_client.config.logger.debug 'Calling API: RestApi.new_user_aliases ...'
@@ -186,7 +186,7 @@ module BrazeClient
186
186
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
187
187
 
188
188
  # return_type
189
- return_type = opts[:debug_return_type] || 'Object'
189
+ return_type = opts[:debug_return_type] || 'UsersAliasNewResponse'
190
190
 
191
191
  # auth_names
192
192
  auth_names = opts[:debug_auth_names] || ['bearerAuth']
@@ -211,7 +211,7 @@ module BrazeClient
211
211
  # Remove your users' old deprecated external IDs. This endpoint completely removes the deprecated ID and cannot be undone.
212
212
  # @param body [Object]
213
213
  # @param [Hash] opts the optional parameters
214
- # @return [Object]
214
+ # @return [UsersExternalIdsRemoveResponse]
215
215
  def remove_external_ids(body, opts = {})
216
216
  data, _status_code, _headers = remove_external_ids_with_http_info(body, opts)
217
217
  data
@@ -220,7 +220,7 @@ module BrazeClient
220
220
  # Remove your users&#39; old deprecated external IDs. This endpoint completely removes the deprecated ID and cannot be undone.
221
221
  # @param body [Object]
222
222
  # @param [Hash] opts the optional parameters
223
- # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
223
+ # @return [Array<(UsersExternalIdsRemoveResponse, Integer, Hash)>] UsersExternalIdsRemoveResponse data, response status code and response headers
224
224
  def remove_external_ids_with_http_info(body, opts = {})
225
225
  if @api_client.config.debugging
226
226
  @api_client.config.logger.debug 'Calling API: RestApi.remove_external_ids ...'
@@ -249,7 +249,7 @@ module BrazeClient
249
249
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
250
250
 
251
251
  # return_type
252
- return_type = opts[:debug_return_type] || 'Object'
252
+ return_type = opts[:debug_return_type] || 'UsersExternalIdsRemoveResponse'
253
253
 
254
254
  # auth_names
255
255
  auth_names = opts[:debug_auth_names] || ['bearerAuth']
@@ -274,7 +274,7 @@ module BrazeClient
274
274
  # Set a new (primary) external_id for the user and deprecate their existing external_id
275
275
  # @param body [Object]
276
276
  # @param [Hash] opts the optional parameters
277
- # @return [Object]
277
+ # @return [UsersExternalIdsRenameResponse]
278
278
  def rename_external_ids(body, opts = {})
279
279
  data, _status_code, _headers = rename_external_ids_with_http_info(body, opts)
280
280
  data
@@ -283,7 +283,7 @@ module BrazeClient
283
283
  # Set a new (primary) external_id for the user and deprecate their existing external_id
284
284
  # @param body [Object]
285
285
  # @param [Hash] opts the optional parameters
286
- # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
286
+ # @return [Array<(UsersExternalIdsRenameResponse, Integer, Hash)>] UsersExternalIdsRenameResponse data, response status code and response headers
287
287
  def rename_external_ids_with_http_info(body, opts = {})
288
288
  if @api_client.config.debugging
289
289
  @api_client.config.logger.debug 'Calling API: RestApi.rename_external_ids ...'
@@ -312,7 +312,7 @@ module BrazeClient
312
312
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
313
313
 
314
314
  # return_type
315
- return_type = opts[:debug_return_type] || 'Object'
315
+ return_type = opts[:debug_return_type] || 'UsersExternalIdsRenameResponse'
316
316
 
317
317
  # auth_names
318
318
  auth_names = opts[:debug_auth_names] || ['bearerAuth']
@@ -335,25 +335,25 @@ module BrazeClient
335
335
  end
336
336
 
337
337
  # Record custom events, purchases, and update user profile attributes
338
- # @param users_track_request [UsersTrackRequest]
338
+ # @param body [Object]
339
339
  # @param [Hash] opts the optional parameters
340
340
  # @return [UsersTrackResponse]
341
- def track_users(users_track_request, opts = {})
342
- data, _status_code, _headers = track_users_with_http_info(users_track_request, opts)
341
+ def track_users(body, opts = {})
342
+ data, _status_code, _headers = track_users_with_http_info(body, opts)
343
343
  data
344
344
  end
345
345
 
346
346
  # Record custom events, purchases, and update user profile attributes
347
- # @param users_track_request [UsersTrackRequest]
347
+ # @param body [Object]
348
348
  # @param [Hash] opts the optional parameters
349
349
  # @return [Array<(UsersTrackResponse, Integer, Hash)>] UsersTrackResponse data, response status code and response headers
350
- def track_users_with_http_info(users_track_request, opts = {})
350
+ def track_users_with_http_info(body, opts = {})
351
351
  if @api_client.config.debugging
352
352
  @api_client.config.logger.debug 'Calling API: RestApi.track_users ...'
353
353
  end
354
- # verify the required parameter 'users_track_request' is set
355
- if @api_client.config.client_side_validation && users_track_request.nil?
356
- fail ArgumentError, "Missing the required parameter 'users_track_request' when calling RestApi.track_users"
354
+ # verify the required parameter 'body' is set
355
+ if @api_client.config.client_side_validation && body.nil?
356
+ fail ArgumentError, "Missing the required parameter 'body' when calling RestApi.track_users"
357
357
  end
358
358
  # resource path
359
359
  local_var_path = '/users/track'
@@ -372,7 +372,7 @@ module BrazeClient
372
372
  form_params = opts[:form_params] || {}
373
373
 
374
374
  # http body (model)
375
- post_body = opts[:debug_body] || @api_client.object_to_http_body(users_track_request)
375
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
376
376
 
377
377
  # return_type
378
378
  return_type = opts[:debug_return_type] || 'UsersTrackResponse'
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Track users, send messages, export data, and more
5
5
 
6
- The version of the OpenAPI document: 0.1.0
6
+ The version of the OpenAPI document: 0.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.1
@@ -31,7 +31,7 @@ module BrazeClient
31
31
  # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
32
32
  def initialize(config = Configuration.default)
33
33
  @config = config
34
- @user_agent = "braze_client ruby v0.1.0"
34
+ @user_agent = "braze_client ruby v0.1.1"
35
35
  @default_headers = {
36
36
  'Content-Type' => 'application/json',
37
37
  'User-Agent' => @user_agent
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Track users, send messages, export data, and more
5
5
 
6
- The version of the OpenAPI document: 0.1.0
6
+ The version of the OpenAPI document: 0.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Track users, send messages, export data, and more
5
5
 
6
- The version of the OpenAPI document: 0.1.0
6
+ The version of the OpenAPI document: 0.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Track users, send messages, export data, and more
5
5
 
6
- The version of the OpenAPI document: 0.1.0
6
+ The version of the OpenAPI document: 0.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.1