adzerk_decision_sdk 1.0.0.pre.beta.6 → 1.0.0.pre.beta.10

data/docs/UserdbApi.md

@@ -2,18 +2,17 @@
 
 All URIs are relative to *https://e-23.adzerk.net*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**add_custom_properties**](UserdbApi.md#add_custom_properties) | **POST** /udb/{networkId}/custom | 
-[**add_interests**](UserdbApi.md#add_interests) | **GET** /udb/{networkId}/interest/i.gif | 
-[**add_retargeting_segment**](UserdbApi.md#add_retargeting_segment) | **GET** /udb/{networkId}/rt/{advertiserId}/{retargetingSegmentId}/i.gif | 
-[**forget**](UserdbApi.md#forget) | **DELETE** /udb/{networkId} | 
-[**gdpr_consent**](UserdbApi.md#gdpr_consent) | **POST** /udb/{networkId}/consent | 
-[**ip_override**](UserdbApi.md#ip_override) | **GET** /udb/{networkId}/ip/i.gif | 
-[**match_user**](UserdbApi.md#match_user) | **GET** /udb/{networkId}/sync/i.gif | 
-[**opt_out**](UserdbApi.md#opt_out) | **GET** /udb/{networkId}/optout/i.gif | 
-[**read**](UserdbApi.md#read) | **GET** /udb/{networkId}/read | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_custom_properties**](UserdbApi.md#add_custom_properties) | **POST** /udb/{networkId}/custom |  |
+| [**add_interests**](UserdbApi.md#add_interests) | **GET** /udb/{networkId}/interest/i.gif |  |
+| [**add_retargeting_segment**](UserdbApi.md#add_retargeting_segment) | **GET** /udb/{networkId}/rt/{advertiserId}/{retargetingSegmentId}/i.gif |  |
+| [**forget**](UserdbApi.md#forget) | **DELETE** /udb/{networkId} |  |
+| [**gdpr_consent**](UserdbApi.md#gdpr_consent) | **POST** /udb/{networkId}/consent |  |
+| [**ip_override**](UserdbApi.md#ip_override) | **GET** /udb/{networkId}/ip/i.gif |  |
+| [**match_user**](UserdbApi.md#match_user) | **GET** /udb/{networkId}/sync/i.gif |  |
+| [**opt_out**](UserdbApi.md#opt_out) | **GET** /udb/{networkId}/optout/i.gif |  |
+| [**read**](UserdbApi.md#read) | **GET** /udb/{networkId}/read |  |
 
 
 ## add_custom_properties
@@ -24,42 +23,60 @@ Method | HTTP request | Description
 
 Add Custom Properties to a User
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'adzerk_decision_sdk'
 # setup authorization
 AdzerkDecisionSdk.configure do |config|
   # Configure API key authorization: ApiKeyAuth
-  config.api_key['X-Adzerk-ApiKey'] = 'YOUR API KEY'
+  config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-Adzerk-ApiKey'] = 'Bearer'
+  # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
 end
 
 api_instance = AdzerkDecisionSdk::UserdbApi.new
 network_id = 56 # Integer | Your Network Id
 user_key = 'user_key_example' # String | The User's UserDB Key
 opts = {
-  body: nil # Object | 
+  body: Object # Object | 
 }
 
 begin
+  
   result = api_instance.add_custom_properties(network_id, user_key, opts)
   p result
 rescue AdzerkDecisionSdk::ApiError => e
-  puts "Exception when calling UserdbApi->add_custom_properties: #{e}"
+  puts "Error when calling UserdbApi->add_custom_properties: #{e}"
 end
 ```
 
-### Parameters
+#### Using the add_custom_properties_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> add_custom_properties_with_http_info(network_id, user_key, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.add_custom_properties_with_http_info(network_id, user_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Error when calling UserdbApi->add_custom_properties_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **network_id** | **Integer**| Your Network Id | 
- **user_key** | **String**| The User&#39;s UserDB Key | 
- **body** | **Object**|  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **Integer** | Your Network Id |  |
+| **user_key** | **String** | The User&#39;s UserDB Key |  |
+| **body** | **Object** |  | [optional] |
 
 ### Return type
 
@@ -83,10 +100,10 @@ Name | Type | Description  | Notes
 
 Add Interests to a User
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'adzerk_decision_sdk'
 
 api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -95,21 +112,39 @@ user_key = 'user_key_example' # String | The User's UserDB Key
 interest = 'interest_example' # String | Comma Seperated list of interests
 
 begin
+  
   result = api_instance.add_interests(network_id, user_key, interest)
   p result
 rescue AdzerkDecisionSdk::ApiError => e
-  puts "Exception when calling UserdbApi->add_interests: #{e}"
+  puts "Error when calling UserdbApi->add_interests: #{e}"
 end
 ```
 
-### Parameters
+#### Using the add_interests_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **network_id** | **Integer**| Your Network Id | 
- **user_key** | **String**| The User&#39;s UserDB Key | 
- **interest** | **String**| Comma Seperated list of interests | 
+> <Array(File, Integer, Hash)> add_interests_with_http_info(network_id, user_key, interest)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.add_interests_with_http_info(network_id, user_key, interest)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Error when calling UserdbApi->add_interests_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **Integer** | Your Network Id |  |
+| **user_key** | **String** | The User&#39;s UserDB Key |  |
+| **interest** | **String** | Comma Seperated list of interests |  |
 
 ### Return type
 
@@ -133,10 +168,10 @@ No authorization required
 
 Add User to a Retargeting Segment
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'adzerk_decision_sdk'
 
 api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -146,22 +181,40 @@ retargeting_segment_id = 56 # Integer | The Segment's ID
 user_key = 'user_key_example' # String | The User's UserDB Key
 
 begin
+  
   result = api_instance.add_retargeting_segment(network_id, advertiser_id, retargeting_segment_id, user_key)
   p result
 rescue AdzerkDecisionSdk::ApiError => e
-  puts "Exception when calling UserdbApi->add_retargeting_segment: #{e}"
+  puts "Error when calling UserdbApi->add_retargeting_segment: #{e}"
 end
 ```
 
-### Parameters
+#### Using the add_retargeting_segment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(File, Integer, Hash)> add_retargeting_segment_with_http_info(network_id, advertiser_id, retargeting_segment_id, user_key)
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **network_id** | **Integer**| Your Network Id | 
- **advertiser_id** | **Integer**| The Advertiser&#39;s ID | 
- **retargeting_segment_id** | **Integer**| The Segment&#39;s ID | 
- **user_key** | **String**| The User&#39;s UserDB Key | 
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.add_retargeting_segment_with_http_info(network_id, advertiser_id, retargeting_segment_id, user_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Error when calling UserdbApi->add_retargeting_segment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **Integer** | Your Network Id |  |
+| **advertiser_id** | **Integer** | The Advertiser&#39;s ID |  |
+| **retargeting_segment_id** | **Integer** | The Segment&#39;s ID |  |
+| **user_key** | **String** | The User&#39;s UserDB Key |  |
 
 ### Return type
 
@@ -185,17 +238,17 @@ No authorization required
 
 Forget User
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'adzerk_decision_sdk'
 # setup authorization
 AdzerkDecisionSdk.configure do |config|
   # Configure API key authorization: ApiKeyAuth
-  config.api_key['X-Adzerk-ApiKey'] = 'YOUR API KEY'
+  config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-Adzerk-ApiKey'] = 'Bearer'
+  # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
 end
 
 api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -203,19 +256,37 @@ network_id = 56 # Integer | Your Network Id
 user_key = 'user_key_example' # String | The User's UserDB Key
 
 begin
+  
   api_instance.forget(network_id, user_key)
 rescue AdzerkDecisionSdk::ApiError => e
-  puts "Exception when calling UserdbApi->forget: #{e}"
+  puts "Error when calling UserdbApi->forget: #{e}"
 end
 ```
 
-### Parameters
+#### Using the forget_with_http_info variant
 
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **network_id** | **Integer**| Your Network Id | 
- **user_key** | **String**| The User&#39;s UserDB Key | 
+> <Array(nil, Integer, Hash)> forget_with_http_info(network_id, user_key)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.forget_with_http_info(network_id, user_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Error when calling UserdbApi->forget_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **Integer** | Your Network Id |  |
+| **user_key** | **String** | The User&#39;s UserDB Key |  |
 
 ### Return type
 
@@ -239,17 +310,17 @@ nil (empty response body)
 
 GDPR Consent
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'adzerk_decision_sdk'
 # setup authorization
 AdzerkDecisionSdk.configure do |config|
   # Configure API key authorization: ApiKeyAuth
-  config.api_key['X-Adzerk-ApiKey'] = 'YOUR API KEY'
+  config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-Adzerk-ApiKey'] = 'Bearer'
+  # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
 end
 
 api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -259,20 +330,38 @@ opts = {
 }
 
 begin
+  
   result = api_instance.gdpr_consent(network_id, opts)
   p result
 rescue AdzerkDecisionSdk::ApiError => e
-  puts "Exception when calling UserdbApi->gdpr_consent: #{e}"
+  puts "Error when calling UserdbApi->gdpr_consent: #{e}"
 end
 ```
 
-### Parameters
+#### Using the gdpr_consent_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **network_id** | **Integer**| Your Network Id | 
- **consent_request** | [**ConsentRequest**](ConsentRequest.md)|  | [optional] 
+> <Array(File, Integer, Hash)> gdpr_consent_with_http_info(network_id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.gdpr_consent_with_http_info(network_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Error when calling UserdbApi->gdpr_consent_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **Integer** | Your Network Id |  |
+| **consent_request** | [**ConsentRequest**](ConsentRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -296,10 +385,10 @@ Name | Type | Description  | Notes
 
 IP Address Override
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'adzerk_decision_sdk'
 
 api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -308,21 +397,39 @@ user_key = 'user_key_example' # String | The User's UserDB Key
 ip = 'ip_example' # String | This is the IP to exclude
 
 begin
+  
   result = api_instance.ip_override(network_id, user_key, ip)
   p result
 rescue AdzerkDecisionSdk::ApiError => e
-  puts "Exception when calling UserdbApi->ip_override: #{e}"
+  puts "Error when calling UserdbApi->ip_override: #{e}"
 end
 ```
 
-### Parameters
+#### Using the ip_override_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **network_id** | **Integer**| Your Network Id | 
- **user_key** | **String**| The User&#39;s UserDB Key | 
- **ip** | **String**| This is the IP to exclude | 
+> <Array(File, Integer, Hash)> ip_override_with_http_info(network_id, user_key, ip)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.ip_override_with_http_info(network_id, user_key, ip)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Error when calling UserdbApi->ip_override_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **Integer** | Your Network Id |  |
+| **user_key** | **String** | The User&#39;s UserDB Key |  |
+| **ip** | **String** | This is the IP to exclude |  |
 
 ### Return type
 
@@ -346,10 +453,10 @@ No authorization required
 
 User Matching
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'adzerk_decision_sdk'
 
 api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -359,22 +466,40 @@ partner_id = 56 # Integer | The ID of the RTB provider in Adzerk. Contact Suppor
 user_id = 56 # Integer | This is the UserID the individual RTB provider has of the user. This is NOT the UserDB userkey.
 
 begin
+  
   result = api_instance.match_user(network_id, user_key, partner_id, user_id)
   p result
 rescue AdzerkDecisionSdk::ApiError => e
-  puts "Exception when calling UserdbApi->match_user: #{e}"
+  puts "Error when calling UserdbApi->match_user: #{e}"
 end
 ```
 
-### Parameters
+#### Using the match_user_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **network_id** | **Integer**| Your Network Id | 
- **user_key** | **String**| The User&#39;s UserDB Key | 
- **partner_id** | **Integer**| The ID of the RTB provider in Adzerk. Contact Support if you don&#39;t have the ID. | 
- **user_id** | **Integer**| This is the UserID the individual RTB provider has of the user. This is NOT the UserDB userkey. | 
+> <Array(File, Integer, Hash)> match_user_with_http_info(network_id, user_key, partner_id, user_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.match_user_with_http_info(network_id, user_key, partner_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Error when calling UserdbApi->match_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **Integer** | Your Network Id |  |
+| **user_key** | **String** | The User&#39;s UserDB Key |  |
+| **partner_id** | **Integer** | The ID of the RTB provider in Adzerk. Contact Support if you don&#39;t have the ID. |  |
+| **user_id** | **Integer** | This is the UserID the individual RTB provider has of the user. This is NOT the UserDB userkey. |  |
 
 ### Return type
 
@@ -398,10 +523,10 @@ No authorization required
 
 Opt-Out a User
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'adzerk_decision_sdk'
 
 api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -409,20 +534,38 @@ network_id = 56 # Integer | Your Network Id
 user_key = 'user_key_example' # String | The User's UserDB Key
 
 begin
+  
   result = api_instance.opt_out(network_id, user_key)
   p result
 rescue AdzerkDecisionSdk::ApiError => e
-  puts "Exception when calling UserdbApi->opt_out: #{e}"
+  puts "Error when calling UserdbApi->opt_out: #{e}"
 end
 ```
 
-### Parameters
+#### Using the opt_out_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> opt_out_with_http_info(network_id, user_key)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.opt_out_with_http_info(network_id, user_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Error when calling UserdbApi->opt_out_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **network_id** | **Integer**| Your Network Id | 
- **user_key** | **String**| The User&#39;s UserDB Key | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **Integer** | Your Network Id |  |
+| **user_key** | **String** | The User&#39;s UserDB Key |  |
 
 ### Return type
 
@@ -446,10 +589,10 @@ No authorization required
 
 Read a User's UserDB Record
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'adzerk_decision_sdk'
 
 api_instance = AdzerkDecisionSdk::UserdbApi.new
@@ -457,20 +600,38 @@ network_id = 56 # Integer | Your Network Id
 user_key = 'user_key_example' # String | The User's UserDB Key
 
 begin
+  
   result = api_instance.read(network_id, user_key)
   p result
 rescue AdzerkDecisionSdk::ApiError => e
-  puts "Exception when calling UserdbApi->read: #{e}"
+  puts "Error when calling UserdbApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(Object, Integer, Hash)> read_with_http_info(network_id, user_key)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.read_with_http_info(network_id, user_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Error when calling UserdbApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **network_id** | **Integer**| Your Network Id | 
- **user_key** | **String**| The User&#39;s UserDB Key | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **Integer** | Your Network Id |  |
+| **user_key** | **String** | The User&#39;s UserDB Key |  |
 
 ### Return type
 

data/lib/adzerk_decision_sdk/api/decision_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -53,15 +53,16 @@ module AdzerkDecisionSdk
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'decision_request']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'decision_request'])
 
       # return_type
-      return_type = opts[:return_type] || 'DecisionResponse' 
+      return_type = opts[:debug_return_type] || 'DecisionResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"DecisionApi.get_decisions",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,