adzerk_decision_sdk 1.0.0.pre.beta.2 → 1.0.0.pre.beta.7

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 (45) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/Gemfile.lock +8 -10
  4. data/README.md +44 -4
  5. data/adzerk_decision_sdk.gemspec +3 -4
  6. data/docs/ConsentRequest.md +10 -9
  7. data/docs/Content.md +16 -15
  8. data/docs/Decision.md +28 -25
  9. data/docs/DecisionApi.md +30 -13
  10. data/docs/DecisionRequest.md +44 -33
  11. data/docs/DecisionResponse.md +12 -11
  12. data/docs/Event.md +10 -9
  13. data/docs/MatchedPoint.md +20 -0
  14. data/docs/Placement.md +46 -37
  15. data/docs/PricingData.md +16 -15
  16. data/docs/RequestLocation.md +19 -0
  17. data/docs/User.md +8 -7
  18. data/docs/UserdbApi.md +252 -140
  19. data/lib/adzerk_decision_sdk.rb +1 -1
  20. data/lib/adzerk_decision_sdk/api/decision_api.rb +5 -4
  21. data/lib/adzerk_decision_sdk/api/userdb_api.rb +37 -95
  22. data/lib/adzerk_decision_sdk/api_client.rb +50 -46
  23. data/lib/adzerk_decision_sdk/api_error.rb +1 -1
  24. data/lib/adzerk_decision_sdk/client.rb +2 -2
  25. data/lib/adzerk_decision_sdk/configuration.rb +39 -10
  26. data/lib/adzerk_decision_sdk/decision_client.rb +12 -1
  27. data/lib/adzerk_decision_sdk/models/consent_request.rb +19 -7
  28. data/lib/adzerk_decision_sdk/models/content.rb +20 -8
  29. data/lib/adzerk_decision_sdk/models/decision.rb +31 -8
  30. data/lib/adzerk_decision_sdk/models/decision_request.rb +74 -12
  31. data/lib/adzerk_decision_sdk/models/decision_response.rb +19 -7
  32. data/lib/adzerk_decision_sdk/models/event.rb +19 -7
  33. data/lib/adzerk_decision_sdk/models/matched_point.rb +227 -0
  34. data/lib/adzerk_decision_sdk/models/placement.rb +91 -12
  35. data/lib/adzerk_decision_sdk/models/pricing_data.rb +19 -7
  36. data/lib/adzerk_decision_sdk/models/{decision_data.rb → request_location.rb} +17 -44
  37. data/lib/adzerk_decision_sdk/models/user.rb +19 -7
  38. data/lib/adzerk_decision_sdk/pixel_client.rb +8 -2
  39. data/lib/adzerk_decision_sdk/user_db_client.rb +16 -2
  40. data/lib/adzerk_decision_sdk/version.rb +2 -2
  41. data/spec/spec_helper.rb +91 -0
  42. metadata +15 -33
  43. data/docs/DecisionData.md +0 -25
  44. data/pkg/adzerk_decision_sdk-1.0.0.gem +0 -0
  45. data/pkg/adzerk_decision_sdk-1.0.0.pre.beta.1.gem +0 -0
@@ -2,20 +2,21 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **user** | [**User**](User.md) | | [optional]
8
- **decisions** | [**Object**](.md) | | [optional]
9
- **explain** | [**Object**](.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **user** | [**User**](User.md) | | [optional] |
8
+ | **decisions** | **Object** | | [optional] |
9
+ | **explain** | **Object** | | [optional] |
10
10
 
11
- ## Code Sample
11
+ ## Example
12
12
 
13
13
  ```ruby
14
- require 'AdzerkDecisionSdk'
14
+ require 'adzerk_decision_sdk'
15
15
 
16
- instance = AdzerkDecisionSdk::DecisionResponse.new(user: null,
17
- decisions: null,
18
- explain: null)
16
+ instance = AdzerkDecisionSdk::DecisionResponse.new(
17
+ user: null,
18
+ decisions: null,
19
+ explain: null
20
+ )
19
21
  ```
20
22
 
21
-
data/docs/Event.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | | [optional]
8
- **url** | **String** | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | | [optional] |
8
+ | **url** | **String** | | [optional] |
9
9
 
10
- ## Code Sample
10
+ ## Example
11
11
 
12
12
  ```ruby
13
- require 'AdzerkDecisionSdk'
13
+ require 'adzerk_decision_sdk'
14
14
 
15
- instance = AdzerkDecisionSdk::Event.new(id: null,
16
- url: null)
15
+ instance = AdzerkDecisionSdk::Event.new(
16
+ id: null,
17
+ url: null
18
+ )
17
19
  ```
18
20
 
19
-
@@ -0,0 +1,20 @@
1
+ # AdzerkDecisionSdk::MatchedPoint
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **lat** | **String** | | [optional] |
8
+ | **lon** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'adzerk_decision_sdk'
14
+
15
+ instance = AdzerkDecisionSdk::MatchedPoint.new(
16
+ lat: null,
17
+ lon: null
18
+ )
19
+ ```
20
+
data/docs/Placement.md CHANGED
@@ -2,46 +2,55 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **div_name** | **String** | A unique name for the placement defined by you | [optional]
8
- **network_id** | **Integer** | The numeric network id | [optional]
9
- **site_id** | **Integer** | The numeric site id | [optional]
10
- **ad_types** | **Array<Integer>** | One or more integer ad types. More info [here](https://dev.adzerk.com/docs/ad-sizes) | [optional]
11
- **zone_ids** | **Array<Integer>** | Zone IDs to use | [optional]
12
- **campaign_id** | **Integer** | A numeric campaign id; if specified, only consider ads in that campaign | [optional]
13
- **flight_id** | **Integer** | A numeric ad (flight-creative map) id; if specified, only serve that ad if possible | [optional]
14
- **ad_id** | **Integer** | A numeric ad (flight-creative map) id; if specified, only serve that ad if possible | [optional]
15
- **click_url** | **String** | The ad's click-through URL | [optional]
16
- **properties** | [**Object**](.md) | A map of key/value pairs used for [Custom Targeting](https://dev.adzerk.com/docs/custom-targeting) | [optional]
17
- **event_ids** | **Array<Integer>** | An array of numeric event types. Requests tracking URLs for custom events. See here for [Event Tracking IDs](https://dev.adzerk.com/v1.0/docs/custom-event-tracking) | [optional]
18
- **overrides** | [**Object**](.md) | An object that overrides values for an advertiser, campaign, flight or ad. Used especially for header bidding | [optional]
19
- **content_keys** | **Hash<String, Integer>** | A map of key/value pairs used with [ContentDB](https://dev.adzerk.com/docs/contentdb-1). The format is `\"contentKeys\": {\"schema\": \"contentKey\"}` | [optional]
20
- **count** | **Integer** | (BETA) The number of ads to return per placement. Integer between 1 and 20 | [optional]
21
- **proportionality** | **Boolean** | (BETA) If true, fills ads in a multi-winner placement in proportion to the flight's goals | [optional]
22
- **ecpm_partition** | **String** | (BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **div_name** | **String** | A unique name for the placement defined by you | [optional] |
8
+ | **network_id** | **Integer** | The numeric network id | [optional] |
9
+ | **site_id** | **Integer** | The numeric site id | [optional] |
10
+ | **ad_types** | **Array<Integer>** | One or more integer ad types. More info [here](https://dev.adzerk.com/docs/ad-sizes) | [optional] |
11
+ | **zone_ids** | **Array<Integer>** | Zone IDs to use | [optional] |
12
+ | **campaign_id** | **Integer** | A numeric campaign id; if specified, only consider ads in that campaign | [optional] |
13
+ | **flight_id** | **Integer** | A numeric ad (flight-creative map) id; if specified, only serve that ad if possible | [optional] |
14
+ | **ad_id** | **Integer** | A numeric ad (flight-creative map) id; if specified, only serve that ad if possible | [optional] |
15
+ | **click_url** | **String** | The ad's click-through URL | [optional] |
16
+ | **properties** | **Object** | A map of key/value pairs used for [Custom Targeting](https://dev.adzerk.com/docs/custom-targeting) | [optional] |
17
+ | **event_ids** | **Array<Integer>** | An array of numeric event types. Requests tracking URLs for custom events. See here for [Event Tracking IDs](https://dev.adzerk.com/v1.0/docs/custom-event-tracking) | [optional] |
18
+ | **overrides** | **Object** | An object that overrides values for an advertiser, campaign, flight or ad. Used especially for header bidding | [optional] |
19
+ | **content_keys** | **Hash<String, Integer>** | A map of key/value pairs used with [ContentDB](https://dev.adzerk.com/docs/contentdb-1). The format is `\"contentKeys\": {\"schema\": \"contentKey\"}` | [optional] |
20
+ | **count** | **Integer** | (BETA) The number of ads to return per placement. Integer between 1 and 20 | [optional] |
21
+ | **proportionality** | **Boolean** | (BETA) If true, fills ads in a multi-winner placement in proportion to the flight's goals | [optional] |
22
+ | **ecpm_partition** | **String** | (BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions | [optional] |
23
+ | **ecpm_partitions** | **Array<String>** | (BETA) The names of the eCPM Partitions that should be used to source eCPM data for auctions | [optional] |
24
+ | **event_multiplier** | **Integer** | | [optional] |
25
+ | **skip_selection** | **Boolean** | | [optional] |
26
+ | **ad_query** | **Object** | | [optional] |
23
27
 
24
- ## Code Sample
28
+ ## Example
25
29
 
26
30
  ```ruby
27
- require 'AdzerkDecisionSdk'
31
+ require 'adzerk_decision_sdk'
28
32
 
29
- instance = AdzerkDecisionSdk::Placement.new(div_name: null,
30
- network_id: null,
31
- site_id: null,
32
- ad_types: null,
33
- zone_ids: null,
34
- campaign_id: null,
35
- flight_id: null,
36
- ad_id: null,
37
- click_url: null,
38
- properties: null,
39
- event_ids: null,
40
- overrides: null,
41
- content_keys: null,
42
- count: null,
43
- proportionality: null,
44
- ecpm_partition: null)
33
+ instance = AdzerkDecisionSdk::Placement.new(
34
+ div_name: null,
35
+ network_id: null,
36
+ site_id: null,
37
+ ad_types: null,
38
+ zone_ids: null,
39
+ campaign_id: null,
40
+ flight_id: null,
41
+ ad_id: null,
42
+ click_url: null,
43
+ properties: null,
44
+ event_ids: null,
45
+ overrides: null,
46
+ content_keys: null,
47
+ count: null,
48
+ proportionality: null,
49
+ ecpm_partition: null,
50
+ ecpm_partitions: null,
51
+ event_multiplier: null,
52
+ skip_selection: null,
53
+ ad_query: null
54
+ )
45
55
  ```
46
56
 
47
-
data/docs/PricingData.md CHANGED
@@ -2,24 +2,25 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **price** | **Float** | | [optional]
8
- **clear_price** | **Float** | | [optional]
9
- **revenue** | **Float** | | [optional]
10
- **rate_type** | **Integer** | | [optional]
11
- **e_cpm** | **Float** | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **price** | **Float** | | [optional] |
8
+ | **clear_price** | **Float** | | [optional] |
9
+ | **revenue** | **Float** | | [optional] |
10
+ | **rate_type** | **Integer** | | [optional] |
11
+ | **e_cpm** | **Float** | | [optional] |
12
12
 
13
- ## Code Sample
13
+ ## Example
14
14
 
15
15
  ```ruby
16
- require 'AdzerkDecisionSdk'
16
+ require 'adzerk_decision_sdk'
17
17
 
18
- instance = AdzerkDecisionSdk::PricingData.new(price: null,
19
- clear_price: null,
20
- revenue: null,
21
- rate_type: null,
22
- e_cpm: null)
18
+ instance = AdzerkDecisionSdk::PricingData.new(
19
+ price: null,
20
+ clear_price: null,
21
+ revenue: null,
22
+ rate_type: null,
23
+ e_cpm: null
24
+ )
23
25
  ```
24
26
 
25
-
@@ -0,0 +1,19 @@
1
+ # AdzerkDecisionSdk::RequestLocation
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **latitude** | **String** | | [optional]
8
+ **longitude** | **String** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'AdzerkDecisionSdk'
14
+
15
+ instance = AdzerkDecisionSdk::RequestLocation.new(latitude: null,
16
+ longitude: null)
17
+ ```
18
+
19
+
data/docs/User.md CHANGED
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **key** | **String** | The UserKey used for UserDB Targeting | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **key** | **String** | The UserKey used for UserDB Targeting | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
- require 'AdzerkDecisionSdk'
12
+ require 'adzerk_decision_sdk'
13
13
 
14
- instance = AdzerkDecisionSdk::User.new(key: null)
14
+ instance = AdzerkDecisionSdk::User.new(
15
+ key: null
16
+ )
15
17
  ```
16
18
 
17
-
data/docs/UserdbApi.md CHANGED
@@ -2,19 +2,17 @@
2
2
 
3
3
  All URIs are relative to *https://e-23.adzerk.net*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**add_custom_properties**](UserdbApi.md#add_custom_properties) | **POST** /udb/{networkId}/custom |
8
- [**add_interests**](UserdbApi.md#add_interests) | **GET** /udb/{networkId}/interest/i.gif |
9
- [**add_retargeting_segment**](UserdbApi.md#add_retargeting_segment) | **GET** /udb/{networkId}/rt/{advertiserId}/{retargetingSegmentId}/i.gif |
10
- [**forget**](UserdbApi.md#forget) | **DELETE** /udb/{networkId} |
11
- [**gdpr_consent**](UserdbApi.md#gdpr_consent) | **POST** /udb/{networkId}/consent |
12
- [**ip_override**](UserdbApi.md#ip_override) | **GET** /udb/{networkId}/ip/i.gif |
13
- [**match_user**](UserdbApi.md#match_user) | **GET** /udb/{networkId}/sync/i.gif |
14
- [**opt_out**](UserdbApi.md#opt_out) | **GET** /udb/{networkId}/optout/i.gif |
15
- [**read**](UserdbApi.md#read) | **GET** /udb/{networkId}/read |
16
- [**set_user_cookie**](UserdbApi.md#set_user_cookie) | **GET** /udb/{networkId}/set/i.gif |
17
-
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**add_custom_properties**](UserdbApi.md#add_custom_properties) | **POST** /udb/{networkId}/custom | |
8
+ | [**add_interests**](UserdbApi.md#add_interests) | **GET** /udb/{networkId}/interest/i.gif | |
9
+ | [**add_retargeting_segment**](UserdbApi.md#add_retargeting_segment) | **GET** /udb/{networkId}/rt/{advertiserId}/{retargetingSegmentId}/i.gif | |
10
+ | [**forget**](UserdbApi.md#forget) | **DELETE** /udb/{networkId} | |
11
+ | [**gdpr_consent**](UserdbApi.md#gdpr_consent) | **POST** /udb/{networkId}/consent | |
12
+ | [**ip_override**](UserdbApi.md#ip_override) | **GET** /udb/{networkId}/ip/i.gif | |
13
+ | [**match_user**](UserdbApi.md#match_user) | **GET** /udb/{networkId}/sync/i.gif | |
14
+ | [**opt_out**](UserdbApi.md#opt_out) | **GET** /udb/{networkId}/optout/i.gif | |
15
+ | [**read**](UserdbApi.md#read) | **GET** /udb/{networkId}/read | |
18
16
 
19
17
 
20
18
  ## add_custom_properties
@@ -25,42 +23,60 @@ Method | HTTP request | Description
25
23
 
26
24
  Add Custom Properties to a User
27
25
 
28
- ### Example
26
+ ### Examples
29
27
 
30
28
  ```ruby
31
- # load the gem
29
+ require 'time'
32
30
  require 'adzerk_decision_sdk'
33
31
  # setup authorization
34
32
  AdzerkDecisionSdk.configure do |config|
35
33
  # Configure API key authorization: ApiKeyAuth
36
- config.api_key['X-Adzerk-ApiKey'] = 'YOUR API KEY'
34
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
37
35
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
- #config.api_key_prefix['X-Adzerk-ApiKey'] = 'Bearer'
36
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
39
37
  end
40
38
 
41
39
  api_instance = AdzerkDecisionSdk::UserdbApi.new
42
40
  network_id = 56 # Integer | Your Network Id
43
41
  user_key = 'user_key_example' # String | The User's UserDB Key
44
42
  opts = {
45
- body: nil # Object |
43
+ body: Object # Object |
46
44
  }
47
45
 
48
46
  begin
47
+
49
48
  result = api_instance.add_custom_properties(network_id, user_key, opts)
50
49
  p result
51
50
  rescue AdzerkDecisionSdk::ApiError => e
52
- puts "Exception when calling UserdbApi->add_custom_properties: #{e}"
51
+ puts "Error when calling UserdbApi->add_custom_properties: #{e}"
53
52
  end
54
53
  ```
55
54
 
56
- ### Parameters
55
+ #### Using the add_custom_properties_with_http_info variant
57
56
 
57
+ This returns an Array which contains the response data, status code and headers.
58
58
 
59
- Name | Type | Description | Notes
60
- ------------- | ------------- | ------------- | -------------
61
- **network_id** | **Integer**| Your Network Id |
62
- **user_key** | **String**| The User's UserDB Key |
63
- **body** | **Object**| | [optional]
59
+ > <Array(File, Integer, Hash)> add_custom_properties_with_http_info(network_id, user_key, opts)
60
+
61
+ ```ruby
62
+ begin
63
+
64
+ data, status_code, headers = api_instance.add_custom_properties_with_http_info(network_id, user_key, opts)
65
+ p status_code # => 2xx
66
+ p headers # => { ... }
67
+ p data # => File
68
+ rescue AdzerkDecisionSdk::ApiError => e
69
+ puts "Error when calling UserdbApi->add_custom_properties_with_http_info: #{e}"
70
+ end
71
+ ```
72
+
73
+ ### Parameters
74
+
75
+ | Name | Type | Description | Notes |
76
+ | ---- | ---- | ----------- | ----- |
77
+ | **network_id** | **Integer** | Your Network Id | |
78
+ | **user_key** | **String** | The User&#39;s UserDB Key | |
79
+ | **body** | **Object** | | [optional] |
64
80
 
65
81
  ### Return type
66
82
 
@@ -84,10 +100,10 @@ Name | Type | Description | Notes
84
100
 
85
101
  Add Interests to a User
86
102
 
87
- ### Example
103
+ ### Examples
88
104
 
89
105
  ```ruby
90
- # load the gem
106
+ require 'time'
91
107
  require 'adzerk_decision_sdk'
92
108
 
93
109
  api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -96,21 +112,39 @@ user_key = 'user_key_example' # String | The User's UserDB Key
96
112
  interest = 'interest_example' # String | Comma Seperated list of interests
97
113
 
98
114
  begin
115
+
99
116
  result = api_instance.add_interests(network_id, user_key, interest)
100
117
  p result
101
118
  rescue AdzerkDecisionSdk::ApiError => e
102
- puts "Exception when calling UserdbApi->add_interests: #{e}"
119
+ puts "Error when calling UserdbApi->add_interests: #{e}"
103
120
  end
104
121
  ```
105
122
 
106
- ### Parameters
123
+ #### Using the add_interests_with_http_info variant
107
124
 
125
+ This returns an Array which contains the response data, status code and headers.
108
126
 
109
- Name | Type | Description | Notes
110
- ------------- | ------------- | ------------- | -------------
111
- **network_id** | **Integer**| Your Network Id |
112
- **user_key** | **String**| The User&#39;s UserDB Key |
113
- **interest** | **String**| Comma Seperated list of interests |
127
+ > <Array(File, Integer, Hash)> add_interests_with_http_info(network_id, user_key, interest)
128
+
129
+ ```ruby
130
+ begin
131
+
132
+ data, status_code, headers = api_instance.add_interests_with_http_info(network_id, user_key, interest)
133
+ p status_code # => 2xx
134
+ p headers # => { ... }
135
+ p data # => File
136
+ rescue AdzerkDecisionSdk::ApiError => e
137
+ puts "Error when calling UserdbApi->add_interests_with_http_info: #{e}"
138
+ end
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+ | Name | Type | Description | Notes |
144
+ | ---- | ---- | ----------- | ----- |
145
+ | **network_id** | **Integer** | Your Network Id | |
146
+ | **user_key** | **String** | The User&#39;s UserDB Key | |
147
+ | **interest** | **String** | Comma Seperated list of interests | |
114
148
 
115
149
  ### Return type
116
150
 
@@ -134,10 +168,10 @@ No authorization required
134
168
 
135
169
  Add User to a Retargeting Segment
136
170
 
137
- ### Example
171
+ ### Examples
138
172
 
139
173
  ```ruby
140
- # load the gem
174
+ require 'time'
141
175
  require 'adzerk_decision_sdk'
142
176
 
143
177
  api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -147,22 +181,40 @@ retargeting_segment_id = 56 # Integer | The Segment's ID
147
181
  user_key = 'user_key_example' # String | The User's UserDB Key
148
182
 
149
183
  begin
184
+
150
185
  result = api_instance.add_retargeting_segment(network_id, advertiser_id, retargeting_segment_id, user_key)
151
186
  p result
152
187
  rescue AdzerkDecisionSdk::ApiError => e
153
- puts "Exception when calling UserdbApi->add_retargeting_segment: #{e}"
188
+ puts "Error when calling UserdbApi->add_retargeting_segment: #{e}"
154
189
  end
155
190
  ```
156
191
 
157
- ### Parameters
192
+ #### Using the add_retargeting_segment_with_http_info variant
158
193
 
194
+ This returns an Array which contains the response data, status code and headers.
159
195
 
160
- Name | Type | Description | Notes
161
- ------------- | ------------- | ------------- | -------------
162
- **network_id** | **Integer**| Your Network Id |
163
- **advertiser_id** | **Integer**| The Advertiser&#39;s ID |
164
- **retargeting_segment_id** | **Integer**| The Segment&#39;s ID |
165
- **user_key** | **String**| The User&#39;s UserDB Key |
196
+ > <Array(File, Integer, Hash)> add_retargeting_segment_with_http_info(network_id, advertiser_id, retargeting_segment_id, user_key)
197
+
198
+ ```ruby
199
+ begin
200
+
201
+ data, status_code, headers = api_instance.add_retargeting_segment_with_http_info(network_id, advertiser_id, retargeting_segment_id, user_key)
202
+ p status_code # => 2xx
203
+ p headers # => { ... }
204
+ p data # => File
205
+ rescue AdzerkDecisionSdk::ApiError => e
206
+ puts "Error when calling UserdbApi->add_retargeting_segment_with_http_info: #{e}"
207
+ end
208
+ ```
209
+
210
+ ### Parameters
211
+
212
+ | Name | Type | Description | Notes |
213
+ | ---- | ---- | ----------- | ----- |
214
+ | **network_id** | **Integer** | Your Network Id | |
215
+ | **advertiser_id** | **Integer** | The Advertiser&#39;s ID | |
216
+ | **retargeting_segment_id** | **Integer** | The Segment&#39;s ID | |
217
+ | **user_key** | **String** | The User&#39;s UserDB Key | |
166
218
 
167
219
  ### Return type
168
220
 
@@ -186,17 +238,17 @@ No authorization required
186
238
 
187
239
  Forget User
188
240
 
189
- ### Example
241
+ ### Examples
190
242
 
191
243
  ```ruby
192
- # load the gem
244
+ require 'time'
193
245
  require 'adzerk_decision_sdk'
194
246
  # setup authorization
195
247
  AdzerkDecisionSdk.configure do |config|
196
248
  # Configure API key authorization: ApiKeyAuth
197
- config.api_key['X-Adzerk-ApiKey'] = 'YOUR API KEY'
249
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
198
250
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
199
- #config.api_key_prefix['X-Adzerk-ApiKey'] = 'Bearer'
251
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
200
252
  end
201
253
 
202
254
  api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -204,19 +256,37 @@ network_id = 56 # Integer | Your Network Id
204
256
  user_key = 'user_key_example' # String | The User's UserDB Key
205
257
 
206
258
  begin
259
+
207
260
  api_instance.forget(network_id, user_key)
208
261
  rescue AdzerkDecisionSdk::ApiError => e
209
- puts "Exception when calling UserdbApi->forget: #{e}"
262
+ puts "Error when calling UserdbApi->forget: #{e}"
210
263
  end
211
264
  ```
212
265
 
213
- ### Parameters
266
+ #### Using the forget_with_http_info variant
267
+
268
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
269
+
270
+ > <Array(nil, Integer, Hash)> forget_with_http_info(network_id, user_key)
271
+
272
+ ```ruby
273
+ begin
274
+
275
+ data, status_code, headers = api_instance.forget_with_http_info(network_id, user_key)
276
+ p status_code # => 2xx
277
+ p headers # => { ... }
278
+ p data # => nil
279
+ rescue AdzerkDecisionSdk::ApiError => e
280
+ puts "Error when calling UserdbApi->forget_with_http_info: #{e}"
281
+ end
282
+ ```
214
283
 
284
+ ### Parameters
215
285
 
216
- Name | Type | Description | Notes
217
- ------------- | ------------- | ------------- | -------------
218
- **network_id** | **Integer**| Your Network Id |
219
- **user_key** | **String**| The User&#39;s UserDB Key |
286
+ | Name | Type | Description | Notes |
287
+ | ---- | ---- | ----------- | ----- |
288
+ | **network_id** | **Integer** | Your Network Id | |
289
+ | **user_key** | **String** | The User&#39;s UserDB Key | |
220
290
 
221
291
  ### Return type
222
292
 
@@ -240,17 +310,17 @@ nil (empty response body)
240
310
 
241
311
  GDPR Consent
242
312
 
243
- ### Example
313
+ ### Examples
244
314
 
245
315
  ```ruby
246
- # load the gem
316
+ require 'time'
247
317
  require 'adzerk_decision_sdk'
248
318
  # setup authorization
249
319
  AdzerkDecisionSdk.configure do |config|
250
320
  # Configure API key authorization: ApiKeyAuth
251
- config.api_key['X-Adzerk-ApiKey'] = 'YOUR API KEY'
321
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
252
322
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
253
- #config.api_key_prefix['X-Adzerk-ApiKey'] = 'Bearer'
323
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
254
324
  end
255
325
 
256
326
  api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -260,20 +330,38 @@ opts = {
260
330
  }
261
331
 
262
332
  begin
333
+
263
334
  result = api_instance.gdpr_consent(network_id, opts)
264
335
  p result
265
336
  rescue AdzerkDecisionSdk::ApiError => e
266
- puts "Exception when calling UserdbApi->gdpr_consent: #{e}"
337
+ puts "Error when calling UserdbApi->gdpr_consent: #{e}"
267
338
  end
268
339
  ```
269
340
 
270
- ### Parameters
341
+ #### Using the gdpr_consent_with_http_info variant
342
+
343
+ This returns an Array which contains the response data, status code and headers.
271
344
 
345
+ > <Array(File, Integer, Hash)> gdpr_consent_with_http_info(network_id, opts)
272
346
 
273
- Name | Type | Description | Notes
274
- ------------- | ------------- | ------------- | -------------
275
- **network_id** | **Integer**| Your Network Id |
276
- **consent_request** | [**ConsentRequest**](ConsentRequest.md)| | [optional]
347
+ ```ruby
348
+ begin
349
+
350
+ data, status_code, headers = api_instance.gdpr_consent_with_http_info(network_id, opts)
351
+ p status_code # => 2xx
352
+ p headers # => { ... }
353
+ p data # => File
354
+ rescue AdzerkDecisionSdk::ApiError => e
355
+ puts "Error when calling UserdbApi->gdpr_consent_with_http_info: #{e}"
356
+ end
357
+ ```
358
+
359
+ ### Parameters
360
+
361
+ | Name | Type | Description | Notes |
362
+ | ---- | ---- | ----------- | ----- |
363
+ | **network_id** | **Integer** | Your Network Id | |
364
+ | **consent_request** | [**ConsentRequest**](ConsentRequest.md) | | [optional] |
277
365
 
278
366
  ### Return type
279
367
 
@@ -297,10 +385,10 @@ Name | Type | Description | Notes
297
385
 
298
386
  IP Address Override
299
387
 
300
- ### Example
388
+ ### Examples
301
389
 
302
390
  ```ruby
303
- # load the gem
391
+ require 'time'
304
392
  require 'adzerk_decision_sdk'
305
393
 
306
394
  api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -309,21 +397,39 @@ user_key = 'user_key_example' # String | The User's UserDB Key
309
397
  ip = 'ip_example' # String | This is the IP to exclude
310
398
 
311
399
  begin
400
+
312
401
  result = api_instance.ip_override(network_id, user_key, ip)
313
402
  p result
314
403
  rescue AdzerkDecisionSdk::ApiError => e
315
- puts "Exception when calling UserdbApi->ip_override: #{e}"
404
+ puts "Error when calling UserdbApi->ip_override: #{e}"
316
405
  end
317
406
  ```
318
407
 
319
- ### Parameters
408
+ #### Using the ip_override_with_http_info variant
320
409
 
410
+ This returns an Array which contains the response data, status code and headers.
321
411
 
322
- Name | Type | Description | Notes
323
- ------------- | ------------- | ------------- | -------------
324
- **network_id** | **Integer**| Your Network Id |
325
- **user_key** | **String**| The User&#39;s UserDB Key |
326
- **ip** | **String**| This is the IP to exclude |
412
+ > <Array(File, Integer, Hash)> ip_override_with_http_info(network_id, user_key, ip)
413
+
414
+ ```ruby
415
+ begin
416
+
417
+ data, status_code, headers = api_instance.ip_override_with_http_info(network_id, user_key, ip)
418
+ p status_code # => 2xx
419
+ p headers # => { ... }
420
+ p data # => File
421
+ rescue AdzerkDecisionSdk::ApiError => e
422
+ puts "Error when calling UserdbApi->ip_override_with_http_info: #{e}"
423
+ end
424
+ ```
425
+
426
+ ### Parameters
427
+
428
+ | Name | Type | Description | Notes |
429
+ | ---- | ---- | ----------- | ----- |
430
+ | **network_id** | **Integer** | Your Network Id | |
431
+ | **user_key** | **String** | The User&#39;s UserDB Key | |
432
+ | **ip** | **String** | This is the IP to exclude | |
327
433
 
328
434
  ### Return type
329
435
 
@@ -347,10 +453,10 @@ No authorization required
347
453
 
348
454
  User Matching
349
455
 
350
- ### Example
456
+ ### Examples
351
457
 
352
458
  ```ruby
353
- # load the gem
459
+ require 'time'
354
460
  require 'adzerk_decision_sdk'
355
461
 
356
462
  api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -360,22 +466,40 @@ partner_id = 56 # Integer | The ID of the RTB provider in Adzerk. Contact Suppor
360
466
  user_id = 56 # Integer | This is the UserID the individual RTB provider has of the user. This is NOT the UserDB userkey.
361
467
 
362
468
  begin
469
+
363
470
  result = api_instance.match_user(network_id, user_key, partner_id, user_id)
364
471
  p result
365
472
  rescue AdzerkDecisionSdk::ApiError => e
366
- puts "Exception when calling UserdbApi->match_user: #{e}"
473
+ puts "Error when calling UserdbApi->match_user: #{e}"
367
474
  end
368
475
  ```
369
476
 
370
- ### Parameters
477
+ #### Using the match_user_with_http_info variant
478
+
479
+ This returns an Array which contains the response data, status code and headers.
480
+
481
+ > <Array(File, Integer, Hash)> match_user_with_http_info(network_id, user_key, partner_id, user_id)
371
482
 
483
+ ```ruby
484
+ begin
485
+
486
+ data, status_code, headers = api_instance.match_user_with_http_info(network_id, user_key, partner_id, user_id)
487
+ p status_code # => 2xx
488
+ p headers # => { ... }
489
+ p data # => File
490
+ rescue AdzerkDecisionSdk::ApiError => e
491
+ puts "Error when calling UserdbApi->match_user_with_http_info: #{e}"
492
+ end
493
+ ```
494
+
495
+ ### Parameters
372
496
 
373
- Name | Type | Description | Notes
374
- ------------- | ------------- | ------------- | -------------
375
- **network_id** | **Integer**| Your Network Id |
376
- **user_key** | **String**| The User&#39;s UserDB Key |
377
- **partner_id** | **Integer**| The ID of the RTB provider in Adzerk. Contact Support if you don&#39;t have the ID. |
378
- **user_id** | **Integer**| This is the UserID the individual RTB provider has of the user. This is NOT the UserDB userkey. |
497
+ | Name | Type | Description | Notes |
498
+ | ---- | ---- | ----------- | ----- |
499
+ | **network_id** | **Integer** | Your Network Id | |
500
+ | **user_key** | **String** | The User&#39;s UserDB Key | |
501
+ | **partner_id** | **Integer** | The ID of the RTB provider in Adzerk. Contact Support if you don&#39;t have the ID. | |
502
+ | **user_id** | **Integer** | This is the UserID the individual RTB provider has of the user. This is NOT the UserDB userkey. | |
379
503
 
380
504
  ### Return type
381
505
 
@@ -399,10 +523,10 @@ No authorization required
399
523
 
400
524
  Opt-Out a User
401
525
 
402
- ### Example
526
+ ### Examples
403
527
 
404
528
  ```ruby
405
- # load the gem
529
+ require 'time'
406
530
  require 'adzerk_decision_sdk'
407
531
 
408
532
  api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -410,20 +534,38 @@ network_id = 56 # Integer | Your Network Id
410
534
  user_key = 'user_key_example' # String | The User's UserDB Key
411
535
 
412
536
  begin
537
+
413
538
  result = api_instance.opt_out(network_id, user_key)
414
539
  p result
415
540
  rescue AdzerkDecisionSdk::ApiError => e
416
- puts "Exception when calling UserdbApi->opt_out: #{e}"
541
+ puts "Error when calling UserdbApi->opt_out: #{e}"
417
542
  end
418
543
  ```
419
544
 
420
- ### Parameters
545
+ #### Using the opt_out_with_http_info variant
546
+
547
+ This returns an Array which contains the response data, status code and headers.
548
+
549
+ > <Array(File, Integer, Hash)> opt_out_with_http_info(network_id, user_key)
550
+
551
+ ```ruby
552
+ begin
553
+
554
+ data, status_code, headers = api_instance.opt_out_with_http_info(network_id, user_key)
555
+ p status_code # => 2xx
556
+ p headers # => { ... }
557
+ p data # => File
558
+ rescue AdzerkDecisionSdk::ApiError => e
559
+ puts "Error when calling UserdbApi->opt_out_with_http_info: #{e}"
560
+ end
561
+ ```
421
562
 
563
+ ### Parameters
422
564
 
423
- Name | Type | Description | Notes
424
- ------------- | ------------- | ------------- | -------------
425
- **network_id** | **Integer**| Your Network Id |
426
- **user_key** | **String**| The User&#39;s UserDB Key |
565
+ | Name | Type | Description | Notes |
566
+ | ---- | ---- | ----------- | ----- |
567
+ | **network_id** | **Integer** | Your Network Id | |
568
+ | **user_key** | **String** | The User&#39;s UserDB Key | |
427
569
 
428
570
  ### Return type
429
571
 
@@ -447,10 +589,10 @@ No authorization required
447
589
 
448
590
  Read a User's UserDB Record
449
591
 
450
- ### Example
592
+ ### Examples
451
593
 
452
594
  ```ruby
453
- # load the gem
595
+ require 'time'
454
596
  require 'adzerk_decision_sdk'
455
597
 
456
598
  api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -458,72 +600,42 @@ network_id = 56 # Integer | Your Network Id
458
600
  user_key = 'user_key_example' # String | The User's UserDB Key
459
601
 
460
602
  begin
603
+
461
604
  result = api_instance.read(network_id, user_key)
462
605
  p result
463
606
  rescue AdzerkDecisionSdk::ApiError => e
464
- puts "Exception when calling UserdbApi->read: #{e}"
607
+ puts "Error when calling UserdbApi->read: #{e}"
465
608
  end
466
609
  ```
467
610
 
468
- ### Parameters
469
-
470
-
471
- Name | Type | Description | Notes
472
- ------------- | ------------- | ------------- | -------------
473
- **network_id** | **Integer**| Your Network Id |
474
- **user_key** | **String**| The User&#39;s UserDB Key |
475
-
476
- ### Return type
477
-
478
- **Object**
479
-
480
- ### Authorization
481
-
482
- No authorization required
483
-
484
- ### HTTP request headers
485
-
486
- - **Content-Type**: Not defined
487
- - **Accept**: application/json
488
-
489
-
490
- ## set_user_cookie
611
+ #### Using the read_with_http_info variant
491
612
 
492
- > File set_user_cookie(network_id, user_key)
613
+ This returns an Array which contains the response data, status code and headers.
493
614
 
494
-
495
-
496
- Set User Cookie
497
-
498
- ### Example
615
+ > <Array(Object, Integer, Hash)> read_with_http_info(network_id, user_key)
499
616
 
500
617
  ```ruby
501
- # load the gem
502
- require 'adzerk_decision_sdk'
503
-
504
- api_instance = AdzerkDecisionSdk::UserdbApi.new
505
- network_id = 56 # Integer | Your Network Id
506
- user_key = 'user_key_example' # String | UserDB Id for the user
507
-
508
618
  begin
509
- result = api_instance.set_user_cookie(network_id, user_key)
510
- p result
619
+
620
+ data, status_code, headers = api_instance.read_with_http_info(network_id, user_key)
621
+ p status_code # => 2xx
622
+ p headers # => { ... }
623
+ p data # => Object
511
624
  rescue AdzerkDecisionSdk::ApiError => e
512
- puts "Exception when calling UserdbApi->set_user_cookie: #{e}"
625
+ puts "Error when calling UserdbApi->read_with_http_info: #{e}"
513
626
  end
514
627
  ```
515
628
 
516
629
  ### Parameters
517
630
 
518
-
519
- Name | Type | Description | Notes
520
- ------------- | ------------- | ------------- | -------------
521
- **network_id** | **Integer**| Your Network Id |
522
- **user_key** | **String**| UserDB Id for the user |
631
+ | Name | Type | Description | Notes |
632
+ | ---- | ---- | ----------- | ----- |
633
+ | **network_id** | **Integer** | Your Network Id | |
634
+ | **user_key** | **String** | The User&#39;s UserDB Key | |
523
635
 
524
636
  ### Return type
525
637
 
526
- **File**
638
+ **Object**
527
639
 
528
640
  ### Authorization
529
641
 
@@ -532,5 +644,5 @@ No authorization required
532
644
  ### HTTP request headers
533
645
 
534
646
  - **Content-Type**: Not defined
535
- - **Accept**: image/gif
647
+ - **Accept**: application/json
536
648