From ebdee0e6330c05b7f3abf7d7f5729359c3fe8e4c Mon Sep 17 00:00:00 2001 From: Brooke Bryan Date: Wed, 3 Jan 2024 09:01:59 +0000 Subject: [PATCH] Updated Auto Generated Code --- src/Definitions/FortifiApiDefinition.php | 2 +- src/Payloads/FlowLogMetricPayload.php | 767 ++++------------------- swagger.yaml | 73 +-- 3 files changed, 137 insertions(+), 705 deletions(-) diff --git a/src/Definitions/FortifiApiDefinition.php b/src/Definitions/FortifiApiDefinition.php index cd13884..f8d0fa4 100644 --- a/src/Definitions/FortifiApiDefinition.php +++ b/src/Definitions/FortifiApiDefinition.php @@ -11,7 +11,7 @@ class FortifiApiDefinition extends ApiDefinition public function __construct() { $this->setTitle('Fortifi API'); - $this->setVersion('3.142.0'); + $this->setVersion('3.142.1'); $this->setDescription(<<_actionTimestamp = (int)$data["actionTimestamp"]; } - if(isset($data["companyFid"])) - { - $this->_companyFid = (string)$data["companyFid"]; - } - if(isset($data["sessionId"])) - { - $this->_sessionId = (string)$data["sessionId"]; - } if(isset($data["action"])) { $this->_action = (string)$data["action"]; } - if(isset($data["language"])) - { - $this->_language = (string)$data["language"]; - } - if(isset($data["languageSpecific"])) - { - $this->_languageSpecific = (string)$data["languageSpecific"]; - } - if(isset($data["os"])) - { - $this->_os = (string)$data["os"]; - } - if(isset($data["osVersion"])) - { - $this->_osVersion = (string)$data["osVersion"]; - } - if(isset($data["osBlended"])) - { - $this->_osBlended = (string)$data["osBlended"]; - } - if(isset($data["platform"])) - { - $this->_platform = (string)$data["platform"]; - } - if(isset($data["device"])) - { - $this->_device = (string)$data["device"]; - } - if(isset($data["client"])) - { - $this->_client = (string)$data["client"]; - } - if(isset($data["clientVersion"])) - { - $this->_clientVersion = (string)$data["clientVersion"]; - } - if(isset($data["clientBlended"])) - { - $this->_clientBlended = (string)$data["clientBlended"]; - } - if(isset($data["ip"])) - { - $this->_ip = (string)$data["ip"]; - } - if(isset($data["city"])) + if(isset($data["sessionId"])) { - $this->_city = (string)$data["city"]; + $this->_sessionId = (string)$data["sessionId"]; } - if(isset($data["country"])) + if(isset($data["customerFid"])) { - $this->_country = (string)$data["country"]; + $this->_customerFid = (string)$data["customerFid"]; } - if(isset($data["state"])) + if(isset($data["purchaseFid"])) { - $this->_state = (string)$data["state"]; + $this->_purchaseFid = (string)$data["purchaseFid"]; } - if(isset($data["postal"])) + if(isset($data["amount"])) { - $this->_postal = (string)$data["postal"]; + $this->_amount = (string)$data["amount"]; } - if(isset($data["timezone"])) + if(isset($data["userAgent"])) { - $this->_timezone = (string)$data["timezone"]; + $this->_userAgent = (string)$data["userAgent"]; } - if(isset($data["continent"])) + if(isset($data["encoding"])) { - $this->_continent = (string)$data["continent"]; + $this->_encoding = (string)$data["encoding"]; } - if(isset($data["affiliateFid"])) + if(isset($data["language"])) { - $this->_affiliateFid = (string)$data["affiliateFid"]; + $this->_language = (string)$data["language"]; } - if(isset($data["foundationFid"])) + if(isset($data["clientIp"])) { - $this->_foundationFid = (string)$data["foundationFid"]; + $this->_clientIp = (string)$data["clientIp"]; } - if(isset($data["affiliateType"])) + if(isset($data["brandFid"])) { - $this->_affiliateType = (string)$data["affiliateType"]; + $this->_brandFid = (string)$data["brandFid"]; } if(isset($data["campaignHash"])) { $this->_campaignHash = (string)$data["campaignHash"]; } - if(isset($data["campaignFid"])) - { - $this->_campaignFid = (string)$data["campaignFid"]; - } if(isset($data["sid1"])) { $this->_sid1 = (string)$data["sid1"]; @@ -172,30 +121,6 @@ public function hydrate($data) { $this->_sid3 = (string)$data["sid3"]; } - if(isset($data["customerFid"])) - { - $this->_customerFid = (string)$data["customerFid"]; - } - if(isset($data["productFid"])) - { - $this->_productFid = (string)$data["productFid"]; - } - if(isset($data["priceFid"])) - { - $this->_priceFid = (string)$data["priceFid"]; - } - if(isset($data["purchaseFid"])) - { - $this->_purchaseFid = (string)$data["purchaseFid"]; - } - if(isset($data["currency"])) - { - $this->_currency = (string)$data["currency"]; - } - if(isset($data["amount"])) - { - $this->_amount = (string)$data["amount"]; - } return $this; } @@ -203,41 +128,21 @@ public function hydrate($data) public function jsonSerialize() { return [ - "actionTimestamp" => $this->_actionTimestamp, - "companyFid" => $this->_companyFid, - "sessionId" => $this->_sessionId, - "action" => $this->_action, - "language" => $this->_language, - "languageSpecific" => $this->_languageSpecific, - "os" => $this->_os, - "osVersion" => $this->_osVersion, - "osBlended" => $this->_osBlended, - "platform" => $this->_platform, - "device" => $this->_device, - "client" => $this->_client, - "clientVersion" => $this->_clientVersion, - "clientBlended" => $this->_clientBlended, - "ip" => $this->_ip, - "city" => $this->_city, - "country" => $this->_country, - "state" => $this->_state, - "postal" => $this->_postal, - "timezone" => $this->_timezone, - "continent" => $this->_continent, - "affiliateFid" => $this->_affiliateFid, - "foundationFid" => $this->_foundationFid, - "affiliateType" => $this->_affiliateType, - "campaignHash" => $this->_campaignHash, - "campaignFid" => $this->_campaignFid, - "sid1" => $this->_sid1, - "sid2" => $this->_sid2, - "sid3" => $this->_sid3, - "customerFid" => $this->_customerFid, - "productFid" => $this->_productFid, - "priceFid" => $this->_priceFid, - "purchaseFid" => $this->_purchaseFid, - "currency" => $this->_currency, - "amount" => $this->_amount, + "actionTimestamp" => $this->_actionTimestamp, + "action" => $this->_action, + "sessionId" => $this->_sessionId, + "customerFid" => $this->_customerFid, + "purchaseFid" => $this->_purchaseFid, + "amount" => $this->_amount, + "userAgent" => $this->_userAgent, + "encoding" => $this->_encoding, + "language" => $this->_language, + "clientIp" => $this->_clientIp, + "brandFid" => $this->_brandFid, + "campaignHash" => $this->_campaignHash, + "sid1" => $this->_sid1, + "sid2" => $this->_sid2, + "sid3" => $this->_sid3, ]; } @@ -262,52 +167,6 @@ public function getActionTimestamp($default = null) return $this->_actionTimestamp ?: $default; } - /** - * @param string $value - * - * @return $this - */ - public function setCompanyFid(?string $value) - { - $this->_companyFid = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getCompanyFid($default = null, $trim = true) - { - $value = $this->_companyFid ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setSessionId(?string $value) - { - $this->_sessionId = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getSessionId($default = null, $trim = true) - { - $value = $this->_sessionId ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - /** * @param string $value * @@ -336,124 +195,9 @@ public function getAction($default = null, $trim = true) * * @return $this */ - public function setLanguage(?string $value) - { - $this->_language = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getLanguage($default = null, $trim = true) - { - $value = $this->_language ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setLanguageSpecific(?string $value) - { - $this->_languageSpecific = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getLanguageSpecific($default = null, $trim = true) - { - $value = $this->_languageSpecific ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setOs(?string $value) - { - $this->_os = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getOs($default = null, $trim = true) - { - $value = $this->_os ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setOsVersion(?string $value) - { - $this->_osVersion = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getOsVersion($default = null, $trim = true) - { - $value = $this->_osVersion ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setOsBlended(?string $value) - { - $this->_osBlended = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getOsBlended($default = null, $trim = true) - { - $value = $this->_osBlended ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setPlatform(?string $value) + public function setSessionId(?string $value) { - $this->_platform = $value; + $this->_sessionId = $value; return $this; } @@ -463,9 +207,9 @@ public function setPlatform(?string $value) * * @return string */ - public function getPlatform($default = null, $trim = true) + public function getSessionId($default = null, $trim = true) { - $value = $this->_platform ?: $default; + $value = $this->_sessionId ?: $default; return $trim ? Strings::ntrim($value) : $value; } @@ -474,44 +218,23 @@ public function getPlatform($default = null, $trim = true) * * @return $this */ - public function setDevice(?string $value) + public function setCustomerFid(?string $value) { - $this->_device = $value; + $this->_customerFid = $value; return $this; } /** - * @param mixed $default - * @param bool $trim Trim Value + * Customer FID linked to this action * - * @return string - */ - public function getDevice($default = null, $trim = true) - { - $value = $this->_device ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setClient(?string $value) - { - $this->_client = $value; - return $this; - } - - /** * @param mixed $default * @param bool $trim Trim Value * * @return string */ - public function getClient($default = null, $trim = true) + public function getCustomerFid($default = null, $trim = true) { - $value = $this->_client ?: $default; + $value = $this->_customerFid ?: $default; return $trim ? Strings::ntrim($value) : $value; } @@ -520,9 +243,9 @@ public function getClient($default = null, $trim = true) * * @return $this */ - public function setClientVersion(?string $value) + public function setPurchaseFid(?string $value) { - $this->_clientVersion = $value; + $this->_purchaseFid = $value; return $this; } @@ -532,9 +255,9 @@ public function setClientVersion(?string $value) * * @return string */ - public function getClientVersion($default = null, $trim = true) + public function getPurchaseFid($default = null, $trim = true) { - $value = $this->_clientVersion ?: $default; + $value = $this->_purchaseFid ?: $default; return $trim ? Strings::ntrim($value) : $value; } @@ -543,9 +266,9 @@ public function getClientVersion($default = null, $trim = true) * * @return $this */ - public function setClientBlended(?string $value) + public function setAmount(?string $value) { - $this->_clientBlended = $value; + $this->_amount = $value; return $this; } @@ -555,9 +278,9 @@ public function setClientBlended(?string $value) * * @return string */ - public function getClientBlended($default = null, $trim = true) + public function getAmount($default = null, $trim = true) { - $value = $this->_clientBlended ?: $default; + $value = $this->_amount ?: $default; return $trim ? Strings::ntrim($value) : $value; } @@ -566,44 +289,23 @@ public function getClientBlended($default = null, $trim = true) * * @return $this */ - public function setIp(?string $value) + public function setUserAgent(?string $value) { - $this->_ip = $value; + $this->_userAgent = $value; return $this; } /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getIp($default = null, $trim = true) - { - $value = $this->_ip ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value + * User Agent of the visitors browser 'HTTP_USER_AGENT' * - * @return $this - */ - public function setCity(?string $value) - { - $this->_city = $value; - return $this; - } - - /** * @param mixed $default * @param bool $trim Trim Value * * @return string */ - public function getCity($default = null, $trim = true) + public function getUserAgent($default = null, $trim = true) { - $value = $this->_city ?: $default; + $value = $this->_userAgent ?: $default; return $trim ? Strings::ntrim($value) : $value; } @@ -612,44 +314,23 @@ public function getCity($default = null, $trim = true) * * @return $this */ - public function setCountry(?string $value) + public function setEncoding(?string $value) { - $this->_country = $value; + $this->_encoding = $value; return $this; } /** - * @param mixed $default - * @param bool $trim Trim Value + * Encoding from the visitors browser 'HTTP_ACCEPT_ENCODING' * - * @return string - */ - public function getCountry($default = null, $trim = true) - { - $value = $this->_country ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setState(?string $value) - { - $this->_state = $value; - return $this; - } - - /** * @param mixed $default * @param bool $trim Trim Value * * @return string */ - public function getState($default = null, $trim = true) + public function getEncoding($default = null, $trim = true) { - $value = $this->_state ?: $default; + $value = $this->_encoding ?: $default; return $trim ? Strings::ntrim($value) : $value; } @@ -658,44 +339,23 @@ public function getState($default = null, $trim = true) * * @return $this */ - public function setPostal(?string $value) + public function setLanguage(?string $value) { - $this->_postal = $value; + $this->_language = $value; return $this; } /** - * @param mixed $default - * @param bool $trim Trim Value + * Language from visitors browser 'HTTP_ACCEPT_LANGUAGE' * - * @return string - */ - public function getPostal($default = null, $trim = true) - { - $value = $this->_postal ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setTimezone(?string $value) - { - $this->_timezone = $value; - return $this; - } - - /** * @param mixed $default * @param bool $trim Trim Value * * @return string */ - public function getTimezone($default = null, $trim = true) + public function getLanguage($default = null, $trim = true) { - $value = $this->_timezone ?: $default; + $value = $this->_language ?: $default; return $trim ? Strings::ntrim($value) : $value; } @@ -704,44 +364,23 @@ public function getTimezone($default = null, $trim = true) * * @return $this */ - public function setContinent(?string $value) + public function setClientIp(?string $value) { - $this->_continent = $value; + $this->_clientIp = $value; return $this; } /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getContinent($default = null, $trim = true) - { - $value = $this->_continent ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value + * IP Address of the visitor * - * @return $this - */ - public function setAffiliateFid(?string $value) - { - $this->_affiliateFid = $value; - return $this; - } - - /** * @param mixed $default * @param bool $trim Trim Value * * @return string */ - public function getAffiliateFid($default = null, $trim = true) + public function getClientIp($default = null, $trim = true) { - $value = $this->_affiliateFid ?: $default; + $value = $this->_clientIp ?: $default; return $trim ? Strings::ntrim($value) : $value; } @@ -750,44 +389,23 @@ public function getAffiliateFid($default = null, $trim = true) * * @return $this */ - public function setFoundationFid(?string $value) + public function setBrandFid(?string $value) { - $this->_foundationFid = $value; + $this->_brandFid = $value; return $this; } /** - * @param mixed $default - * @param bool $trim Trim Value + * FID of a valid Brand * - * @return string - */ - public function getFoundationFid($default = null, $trim = true) - { - $value = $this->_foundationFid ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setAffiliateType(?string $value) - { - $this->_affiliateType = $value; - return $this; - } - - /** * @param mixed $default * @param bool $trim Trim Value * * @return string */ - public function getAffiliateType($default = null, $trim = true) + public function getBrandFid($default = null, $trim = true) { - $value = $this->_affiliateType ?: $default; + $value = $this->_brandFid ?: $default; return $trim ? Strings::ntrim($value) : $value; } @@ -816,29 +434,6 @@ public function getCampaignHash($default = null, $trim = true) return $trim ? Strings::ntrim($value) : $value; } - /** - * @param string $value - * - * @return $this - */ - public function setCampaignFid(?string $value) - { - $this->_campaignFid = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getCampaignFid($default = null, $trim = true) - { - $value = $this->_campaignFid ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - /** * @param string $value * @@ -851,6 +446,8 @@ public function setSid1(?string $value) } /** + * Advertiser sub tracking ID 1 + * * @param mixed $default * @param bool $trim Trim Value * @@ -874,6 +471,8 @@ public function setSid2(?string $value) } /** + * Advertiser sub tracking ID 2 + * * @param mixed $default * @param bool $trim Trim Value * @@ -897,6 +496,8 @@ public function setSid3(?string $value) } /** + * Advertiser sub tracking ID 3 + * * @param mixed $default * @param bool $trim Trim Value * @@ -907,142 +508,4 @@ public function getSid3($default = null, $trim = true) $value = $this->_sid3 ?: $default; return $trim ? Strings::ntrim($value) : $value; } - - /** - * @param string $value - * - * @return $this - */ - public function setCustomerFid(?string $value) - { - $this->_customerFid = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getCustomerFid($default = null, $trim = true) - { - $value = $this->_customerFid ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setProductFid(?string $value) - { - $this->_productFid = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getProductFid($default = null, $trim = true) - { - $value = $this->_productFid ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setPriceFid(?string $value) - { - $this->_priceFid = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getPriceFid($default = null, $trim = true) - { - $value = $this->_priceFid ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setPurchaseFid(?string $value) - { - $this->_purchaseFid = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getPurchaseFid($default = null, $trim = true) - { - $value = $this->_purchaseFid ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setCurrency(?string $value) - { - $this->_currency = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getCurrency($default = null, $trim = true) - { - $value = $this->_currency ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } - - /** - * @param string $value - * - * @return $this - */ - public function setAmount(?string $value) - { - $this->_amount = $value; - return $this; - } - - /** - * @param mixed $default - * @param bool $trim Trim Value - * - * @return string - */ - public function getAmount($default = null, $trim = true) - { - $value = $this->_amount ?: $default; - return $trim ? Strings::ntrim($value) : $value; - } } diff --git a/swagger.yaml b/swagger.yaml index c0b9e75..cc90262 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1,7 +1,7 @@ swagger: '2.0' info: title: Fortifi API - version: '3.142.0' + version: '3.142.1' termsOfService: 'https://fortifi.io/legal/terms/api' description: > The second version of the Fortifi API is an exciting step forward towards @@ -9984,77 +9984,46 @@ definitions: actionTimestamp: type: number format: int64 - companyFid: - type: string - sessionId: - type: string action: type: string - language: - type: string - languageSpecific: - type: string - os: - type: string - osVersion: - type: string - osBlended: - type: string - platform: - type: string - device: - type: string - client: - type: string - clientVersion: - type: string - clientBlended: - type: string - ip: - type: string - city: + sessionId: type: string - country: + customerFid: type: string - state: + description: Customer FID linked to this action + purchaseFid: type: string - postal: + amount: type: string - timezone: + userAgent: + description: User Agent of the visitors browser 'HTTP_USER_AGENT' type: string - continent: + encoding: + description: Encoding from the visitors browser 'HTTP_ACCEPT_ENCODING' type: string - affiliateFid: + language: + description: Language from visitors browser 'HTTP_ACCEPT_LANGUAGE' type: string - foundationFid: + clientIp: + description: IP Address of the visitor type: string - affiliateType: + brandFid: + description: FID of a valid Brand type: string campaignHash: - description: Advertiser Campaign to track this action to (if not already locked) - type: string - campaignFid: + description: | + Advertiser Campaign to track this action to (if not already locked) type: string sid1: type: string + description: Advertiser sub tracking ID 1 sid2: type: string + description: Advertiser sub tracking ID 2 sid3: type: string - customerFid: - type: string - productFid: - type: string - priceFid: - type: string - purchaseFid: - type: string - currency: - type: string - amount: - type: string + description: Advertiser sub tracking ID 3 required: - - companyFid - sessionId - action