vendor/sendinblue/api-v3-sdk/lib/Configuration.php line 116

Open in your IDE?
  1. <?php
  2. /**
  3.  * Configuration
  4.  * PHP version 5
  5.  *
  6.  * @category Class
  7.  * @package  SendinBlue\Client
  8.  * @author   Swagger Codegen team
  9.  * @link     https://github.com/swagger-api/swagger-codegen
  10.  */
  12. /**
  13.  * SendinBlue API
  14.  *
  15.  * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
  16.  *
  17.  * OpenAPI spec version: 3.0.0
  18.  * Contact: contact@sendinblue.com
  19.  * Generated by: https://github.com/swagger-api/swagger-codegen.git
  20.  * Swagger Codegen version: 2.4.12
  21.  */
  23. /**
  24.  * NOTE: This class is auto generated by the swagger code generator program.
  25.  * https://github.com/swagger-api/swagger-codegen
  26.  * Do not edit the class manually.
  27.  */
  29. namespace SendinBlue\Client;
  31. /**
  32.  * Configuration Class Doc Comment
  33.  * PHP version 5
  34.  *
  35.  * @category Class
  36.  * @package  SendinBlue\Client
  37.  * @author   Swagger Codegen team
  38.  * @link     https://github.com/swagger-api/swagger-codegen
  39.  */
  41. $GLOBALS['version'] = '7.4.3';
  43. class Configuration
  44. {
  45.     private static $defaultConfiguration;
  47.     /**
  48.      * Associate array to store API key(s)
  49.      *
  50.      * @var string[]
  51.      */
  52.     protected $apiKeys = [];
  54.     /**
  55.      * Associate array to store API prefix (e.g. Bearer)
  56.      *
  57.      * @var string[]
  58.      */
  59.     protected $apiKeyPrefixes = [];
  61.     /**
  62.      * Access token for OAuth
  63.      *
  64.      * @var string
  65.      */
  66.     protected $accessToken = '';
  68.     /**
  69.      * Username for HTTP basic authentication
  70.      *
  71.      * @var string
  72.      */
  73.     protected $username = '';
  75.     /**
  76.      * Password for HTTP basic authentication
  77.      *
  78.      * @var string
  79.      */
  80.     protected $password = '';
  82.     /**
  83.      * The host
  84.      *
  85.      * @var string
  86.      */
  87.     protected $host = 'https://api.sendinblue.com/v3';
  89.     /**
  90.      * Debug switch (default set to false)
  91.      *
  92.      * @var bool
  93.      */
  94.     protected $debug = false;
  96.     /**
  97.      * Debug file location (log to STDOUT by default)
  98.      *
  99.      * @var string
  100.      */
  101.     protected $debugFile = 'php://output';
  103.     /**
  104.      * Debug file location (log to STDOUT by default)
  105.      *
  106.      * @var string
  107.      */
  108.     protected $tempFolderPath;
  110.     /**
  111.      * Constructor
  112.      */
  113.     public function __construct()
  114.     {
  115.         $this->tempFolderPath = sys_get_temp_dir();
  116.         $this->userAgent = 'sendinblue_clientAPI/v' . $GLOBALS['version'] . '/php'; 
  117.     }
  119.     /**
  120.      * Sets API key
  121.      *
  122.      * @param string $apiKeyIdentifier API key identifier (authentication scheme)
  123.      * @param string $key              API key or token
  124.      *
  125.      * @return $this
  126.      */
  127.     public function setApiKey($apiKeyIdentifier, $key)
  128.     {
  129.         $this->apiKeys[$apiKeyIdentifier] = $key;
  130.         return $this;
  131.     }
  133.     /**
  134.      * Gets API key
  135.      *
  136.      * @param string $apiKeyIdentifier API key identifier (authentication scheme)
  137.      *
  138.      * @return string API key or token
  139.      */
  140.     public function getApiKey($apiKeyIdentifier)
  141.     {
  142.         return isset($this->apiKeys[$apiKeyIdentifier]) ? $this->apiKeys[$apiKeyIdentifier] : null;
  143.     }
  145.     /**
  146.      * Sets the prefix for API key (e.g. Bearer)
  147.      *
  148.      * @param string $apiKeyIdentifier API key identifier (authentication scheme)
  149.      * @param string $prefix           API key prefix, e.g. Bearer
  150.      *
  151.      * @return $this
  152.      */
  153.     public function setApiKeyPrefix($apiKeyIdentifier, $prefix)
  154.     {
  155.         $this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix;
  156.         return $this;
  157.     }
  159.     /**
  160.      * Gets API key prefix
  161.      *
  162.      * @param string $apiKeyIdentifier API key identifier (authentication scheme)
  163.      *
  164.      * @return string
  165.      */
  166.     public function getApiKeyPrefix($apiKeyIdentifier)
  167.     {
  168.         return isset($this->apiKeyPrefixes[$apiKeyIdentifier]) ? $this->apiKeyPrefixes[$apiKeyIdentifier] : null;
  169.     }
  171.     /**
  172.      * Sets the access token for OAuth
  173.      *
  174.      * @param string $accessToken Token for OAuth
  175.      *
  176.      * @return $this
  177.      */
  178.     public function setAccessToken($accessToken)
  179.     {
  180.         $this->accessToken = $accessToken;
  181.         return $this;
  182.     }
  184.     /**
  185.      * Gets the access token for OAuth
  186.      *
  187.      * @return string Access token for OAuth
  188.      */
  189.     public function getAccessToken()
  190.     {
  191.         return $this->accessToken;
  192.     }
  194.     /**
  195.      * Sets the username for HTTP basic authentication
  196.      *
  197.      * @param string $username Username for HTTP basic authentication
  198.      *
  199.      * @return $this
  200.      */
  201.     public function setUsername($username)
  202.     {
  203.         $this->username = $username;
  204.         return $this;
  205.     }
  207.     /**
  208.      * Gets the username for HTTP basic authentication
  209.      *
  210.      * @return string Username for HTTP basic authentication
  211.      */
  212.     public function getUsername()
  213.     {
  214.         return $this->username;
  215.     }
  217.     /**
  218.      * Sets the password for HTTP basic authentication
  219.      *
  220.      * @param string $password Password for HTTP basic authentication
  221.      *
  222.      * @return $this
  223.      */
  224.     public function setPassword($password)
  225.     {
  226.         $this->password = $password;
  227.         return $this;
  228.     }
  230.     /**
  231.      * Gets the password for HTTP basic authentication
  232.      *
  233.      * @return string Password for HTTP basic authentication
  234.      */
  235.     public function getPassword()
  236.     {
  237.         return $this->password;
  238.     }
  240.     /**
  241.      * Sets the host
  242.      *
  243.      * @param string $host Host
  244.      *
  245.      * @return $this
  246.      */
  247.     public function setHost($host)
  248.     {
  249.         $this->host = $host;
  250.         return $this;
  251.     }
  253.     /**
  254.      * Gets the host
  255.      *
  256.      * @return string Host
  257.      */
  258.     public function getHost()
  259.     {
  260.         return $this->host;
  261.     }
  263.     /**
  264.      * Sets the user agent of the api client
  265.      *
  266.      * @param string $userAgent the user agent of the api client
  267.      *
  268.      * @throws \InvalidArgumentException
  269.      * @return $this
  270.      */
  271.     public function setUserAgent($userAgent)
  272.     {
  273.         if (!is_string($userAgent)) {
  274.             throw new \InvalidArgumentException('User-agent must be a string.');
  275.         }
  277.         if(strpos($userAgent, 'sendinblue_') !== false) {
  278.             $this->userAgent = $userAgent;
  279.         }
  281.         return $this;
  282.     }
  284.     /**
  285.      * Gets the user agent of the api client
  286.      *
  287.      * @return string user agent
  288.      */
  289.     public function getUserAgent()
  290.     {
  291.         return $this->userAgent;
  292.     }
  294.     /**
  295.      * Sets debug flag
  296.      *
  297.      * @param bool $debug Debug flag
  298.      *
  299.      * @return $this
  300.      */
  301.     public function setDebug($debug)
  302.     {
  303.         $this->debug = $debug;
  304.         return $this;
  305.     }
  307.     /**
  308.      * Gets the debug flag
  309.      *
  310.      * @return bool
  311.      */
  312.     public function getDebug()
  313.     {
  314.         return $this->debug;
  315.     }
  317.     /**
  318.      * Sets the debug file
  319.      *
  320.      * @param string $debugFile Debug file
  321.      *
  322.      * @return $this
  323.      */
  324.     public function setDebugFile($debugFile)
  325.     {
  326.         $this->debugFile = $debugFile;
  327.         return $this;
  328.     }
  330.     /**
  331.      * Gets the debug file
  332.      *
  333.      * @return string
  334.      */
  335.     public function getDebugFile()
  336.     {
  337.         return $this->debugFile;
  338.     }
  340.     /**
  341.      * Sets the temp folder path
  342.      *
  343.      * @param string $tempFolderPath Temp folder path
  344.      *
  345.      * @return $this
  346.      */
  347.     public function setTempFolderPath($tempFolderPath)
  348.     {
  349.         $this->tempFolderPath = $tempFolderPath;
  350.         return $this;
  351.     }
  353.     /**
  354.      * Gets the temp folder path
  355.      *
  356.      * @return string Temp folder path
  357.      */
  358.     public function getTempFolderPath()
  359.     {
  360.         return $this->tempFolderPath;
  361.     }
  363.     /**
  364.      * Gets the default configuration instance
  365.      *
  366.      * @return Configuration
  367.      */
  368.     public static function getDefaultConfiguration()
  369.     {
  370.         if (self::$defaultConfiguration === null) {
  371.             self::$defaultConfiguration = new Configuration();
  372.         }
  373.         return self::$defaultConfiguration;
  374.     }
  376.     /**
  377.      * Sets the detault configuration instance
  378.      *
  379.      * @param Configuration $config An instance of the Configuration Object
  380.      *
  381.      * @return void
  382.      */
  383.     public static function setDefaultConfiguration(Configuration $config)
  384.     {
  385.         self::$defaultConfiguration = $config;
  386.     }
  388.     /**
  389.      * Gets the essential information for debugging
  390.      *
  391.      * @return string The report for debugging
  392.      */
  393.     public static function toDebugReport()
  394.     {
  395.         $report  = 'PHP SDK (SendinBlue\Client) Debug Report:' . PHP_EOL;
  396.         $report .= '    OS: ' . php_uname() . PHP_EOL;
  397.         $report .= '    PHP Version: ' . PHP_VERSION . PHP_EOL;
  398.         $report .= '    OpenAPI Spec Version: 3.0.0' . PHP_EOL;
  399.         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
  401.         return $report;
  402.     }
  404.     /**
  405.      * Get API key (with prefix if set)
  406.      *
  407.      * @param  string $apiKeyIdentifier name of apikey
  408.      *
  409.      * @return string API key with the prefix
  410.      */
  411.     public function getApiKeyWithPrefix($apiKeyIdentifier)
  412.     {
  413.         $prefix = $this->getApiKeyPrefix($apiKeyIdentifier);
  414.         $apiKey = $this->getApiKey($apiKeyIdentifier);
  416.         if ($apiKey === null) {
  417.             return null;
  418.         }
  420.         if ($prefix === null) {
  421.             $keyWithPrefix = $apiKey;
  422.         } else {
  423.             $keyWithPrefix = $prefix . ' ' . $apiKey;
  424.         }
  426.         return $keyWithPrefix;
  427.     }
  428. }