adzerk_decision_sdk 1.0.0.pre.beta.1

data/docs/Response.md

@@ -0,0 +1,21 @@
+# AdzerkDecisionSdk::Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**User**](User.md) |  | [optional] 
+**decisions** | [**Object**](.md) |  | [optional] 
+**explain** | [**Object**](.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::Response.new(user: null,
+                                 decisions: null,
+                                 explain: null)
+```
+
+

data/docs/User.md

@@ -0,0 +1,17 @@
+# AdzerkDecisionSdk::User
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | The UserKey used for UserDB Targeting | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::User.new(key: null)
+```
+
+

data/docs/UserdbApi.md

@@ -0,0 +1,536 @@
+# AdzerkDecisionSdk::UserdbApi
+
+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 | 
+[**set_user_cookie**](UserdbApi.md#set_user_cookie) | **GET** /udb/{networkId}/set/i.gif | 
+
+
+
+## add_custom_properties
+
+> File add_custom_properties(network_id, user_key, opts)
+
+
+
+Add Custom Properties to a User
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+# setup authorization
+AdzerkDecisionSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-Adzerk-ApiKey'] = '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'
+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 | 
+}
+
+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}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **Integer**| Your Network Id | 
+ **user_key** | **String**| The User's UserDB Key | 
+ **body** | **Object**|  | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: image/gif
+
+
+## add_interests
+
+> File add_interests(network_id, user_key, interest)
+
+
+
+Add Interests to a User
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+
+api_instance = AdzerkDecisionSdk::UserdbApi.new
+network_id = 56 # Integer | Your Network Id
+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}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **Integer**| Your Network Id | 
+ **user_key** | **String**| The User's UserDB Key | 
+ **interest** | **String**| Comma Seperated list of interests | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: image/gif
+
+
+## add_retargeting_segment
+
+> File add_retargeting_segment(network_id, advertiser_id, retargeting_segment_id, user_key)
+
+
+
+Add User to a Retargeting Segment
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+
+api_instance = AdzerkDecisionSdk::UserdbApi.new
+network_id = 56 # Integer | Your Network Id
+advertiser_id = 56 # Integer | The Advertiser's ID
+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}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **Integer**| Your Network Id | 
+ **advertiser_id** | **Integer**| The Advertiser's ID | 
+ **retargeting_segment_id** | **Integer**| The Segment's ID | 
+ **user_key** | **String**| The User's UserDB Key | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: image/gif
+
+
+## forget
+
+> forget(network_id, user_key)
+
+
+
+Forget User
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+# setup authorization
+AdzerkDecisionSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-Adzerk-ApiKey'] = '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'
+end
+
+api_instance = AdzerkDecisionSdk::UserdbApi.new
+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}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **Integer**| Your Network Id | 
+ **user_key** | **String**| The User's UserDB Key | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## gdpr_consent
+
+> File gdpr_consent(network_id, opts)
+
+
+
+GDPR Consent
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+# setup authorization
+AdzerkDecisionSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-Adzerk-ApiKey'] = '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'
+end
+
+api_instance = AdzerkDecisionSdk::UserdbApi.new
+network_id = 56 # Integer | Your Network Id
+opts = {
+  consent_request: AdzerkDecisionSdk::ConsentRequest.new # ConsentRequest | 
+}
+
+begin
+  result = api_instance.gdpr_consent(network_id, opts)
+  p result
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Exception when calling UserdbApi->gdpr_consent: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **Integer**| Your Network Id | 
+ **consent_request** | [**ConsentRequest**](ConsentRequest.md)|  | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: image/gif
+
+
+## ip_override
+
+> File ip_override(network_id, user_key, ip)
+
+
+
+IP Address Override
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+
+api_instance = AdzerkDecisionSdk::UserdbApi.new
+network_id = 56 # Integer | Your Network Id
+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}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **Integer**| Your Network Id | 
+ **user_key** | **String**| The User's UserDB Key | 
+ **ip** | **String**| This is the IP to exclude | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: image/gif
+
+
+## match_user
+
+> File match_user(network_id, user_key, partner_id, user_id)
+
+
+
+User Matching
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+
+api_instance = AdzerkDecisionSdk::UserdbApi.new
+network_id = 56 # Integer | Your Network Id
+user_key = 'user_key_example' # String | The User's UserDB Key
+partner_id = 56 # Integer | The ID of the RTB provider in Adzerk. Contact Support if you don't have the ID.
+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}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **Integer**| Your Network Id | 
+ **user_key** | **String**| The User's UserDB Key | 
+ **partner_id** | **Integer**| The ID of the RTB provider in Adzerk. Contact Support if you don'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
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: image/gif
+
+
+## opt_out
+
+> File opt_out(network_id, user_key)
+
+
+
+Opt-Out a User
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+
+api_instance = AdzerkDecisionSdk::UserdbApi.new
+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}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **Integer**| Your Network Id | 
+ **user_key** | **String**| The User's UserDB Key | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: image/gif
+
+
+## read
+
+> Object read(network_id, user_key)
+
+
+
+Read a User's UserDB Record
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+
+api_instance = AdzerkDecisionSdk::UserdbApi.new
+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}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **Integer**| Your Network Id | 
+ **user_key** | **String**| The User's UserDB Key | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## set_user_cookie
+
+> File set_user_cookie(network_id, user_key)
+
+
+
+Set User Cookie
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+
+api_instance = AdzerkDecisionSdk::UserdbApi.new
+network_id = 56 # Integer | Your Network Id
+user_key = 'user_key_example' # String | UserDB Id for the user
+
+begin
+  result = api_instance.set_user_cookie(network_id, user_key)
+  p result
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Exception when calling UserdbApi->set_user_cookie: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **Integer**| Your Network Id | 
+ **user_key** | **String**| UserDB Id for the user | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: image/gif
+

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/adzerk_decision_sdk/api/decision_api.rb

@@ -0,0 +1,80 @@
+=begin
+#Adzerk Decision API
+
+#Adzerk Decision API
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module AdzerkDecisionSdk
+  class DecisionApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Request Decision(s)
+    # @param [Hash] opts the optional parameters
+    # @option opts [DecisionRequest] :decision_request 
+    # @return [DecisionResponse]
+    def get_decisions(opts = {})
+      data, _status_code, _headers = get_decisions_with_http_info(opts)
+      data
+    end
+
+    # Request Decision(s)
+    # @param [Hash] opts the optional parameters
+    # @option opts [DecisionRequest] :decision_request 
+    # @return [Array<(DecisionResponse, Integer, Hash)>] DecisionResponse data, response status code and response headers
+    def get_decisions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DecisionApi.get_decisions ...'
+      end
+      # resource path
+      local_var_path = '/api/v2'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'decision_request']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'DecisionResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DecisionApi#get_decisions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end