newsletter field working
This commit is contained in:
isUnknown
parent
2f836dde20
commit
63c98bfd30
1302 changed files with 308003 additions and 7 deletions
|
|
@ -23,7 +23,8 @@
|
|||
},
|
||||
"require": {
|
||||
"php": "~8.1.0 || ~8.2.0 || ~8.3.0",
|
||||
"getkirby/cms": "^4.0"
|
||||
"getkirby/cms": "^4.0",
|
||||
"getbrevo/brevo-php": "2.0.2"
|
||||
},
|
||||
"config": {
|
||||
"allow-plugins": {
|
||||
|
|
|
|||
594
composer.lock
generated
594
composer.lock
generated
|
|
@ -4,7 +4,7 @@
|
|||
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
|
||||
"This file is @generated automatically"
|
||||
],
|
||||
"content-hash": "749a661738bcd5b9428c88a1da847bc7",
|
||||
"content-hash": "e25e9c7b9b9173ae3dbcc7eb0d4fa982",
|
||||
"packages": [
|
||||
{
|
||||
"name": "christian-riesen/base32",
|
||||
|
|
@ -270,6 +270,69 @@
|
|||
],
|
||||
"time": "2023-11-03T12:00:00+00:00"
|
||||
},
|
||||
{
|
||||
"name": "getbrevo/brevo-php",
|
||||
"version": "v2.0.2",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/getbrevo/brevo-php.git",
|
||||
"reference": "d090995afd88ff9d6f1284d7f9adaff0c6a58949"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/getbrevo/brevo-php/zipball/d090995afd88ff9d6f1284d7f9adaff0c6a58949",
|
||||
"reference": "d090995afd88ff9d6f1284d7f9adaff0c6a58949",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"ext-curl": "*",
|
||||
"ext-json": "*",
|
||||
"ext-mbstring": "*",
|
||||
"guzzlehttp/guzzle": "^7.4.0",
|
||||
"php": ">=5.6"
|
||||
},
|
||||
"require-dev": {
|
||||
"friendsofphp/php-cs-fixer": "~1.12",
|
||||
"phpunit/phpunit": "^4.8",
|
||||
"squizlabs/php_codesniffer": "~2.6"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "1.x.x-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Brevo\\Client\\": "lib/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Brevo Developers",
|
||||
"email": "contact@brevo.com",
|
||||
"homepage": "https://www.brevo.com/"
|
||||
}
|
||||
],
|
||||
"description": "Official Brevo provided RESTFul API V3 php library",
|
||||
"homepage": "https://github.com/getbrevo/brevo-php",
|
||||
"keywords": [
|
||||
"api",
|
||||
"brevo",
|
||||
"php",
|
||||
"sdk",
|
||||
"swagger"
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/getbrevo/brevo-php/issues",
|
||||
"source": "https://github.com/getbrevo/brevo-php/tree/v2.0.2"
|
||||
},
|
||||
"time": "2024-08-12T07:30:54+00:00"
|
||||
},
|
||||
{
|
||||
"name": "getkirby/cms",
|
||||
"version": "4.3.0",
|
||||
|
|
@ -420,6 +483,331 @@
|
|||
],
|
||||
"time": "2020-12-28T12:54:39+00:00"
|
||||
},
|
||||
{
|
||||
"name": "guzzlehttp/guzzle",
|
||||
"version": "7.9.2",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/guzzle/guzzle.git",
|
||||
"reference": "d281ed313b989f213357e3be1a179f02196ac99b"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/guzzle/guzzle/zipball/d281ed313b989f213357e3be1a179f02196ac99b",
|
||||
"reference": "d281ed313b989f213357e3be1a179f02196ac99b",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"ext-json": "*",
|
||||
"guzzlehttp/promises": "^1.5.3 || ^2.0.3",
|
||||
"guzzlehttp/psr7": "^2.7.0",
|
||||
"php": "^7.2.5 || ^8.0",
|
||||
"psr/http-client": "^1.0",
|
||||
"symfony/deprecation-contracts": "^2.2 || ^3.0"
|
||||
},
|
||||
"provide": {
|
||||
"psr/http-client-implementation": "1.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"bamarni/composer-bin-plugin": "^1.8.2",
|
||||
"ext-curl": "*",
|
||||
"guzzle/client-integration-tests": "3.0.2",
|
||||
"php-http/message-factory": "^1.1",
|
||||
"phpunit/phpunit": "^8.5.39 || ^9.6.20",
|
||||
"psr/log": "^1.1 || ^2.0 || ^3.0"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-curl": "Required for CURL handler support",
|
||||
"ext-intl": "Required for Internationalized Domain Name (IDN) support",
|
||||
"psr/log": "Required for using the Log middleware"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"bamarni-bin": {
|
||||
"bin-links": true,
|
||||
"forward-command": false
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"files": [
|
||||
"src/functions_include.php"
|
||||
],
|
||||
"psr-4": {
|
||||
"GuzzleHttp\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Graham Campbell",
|
||||
"email": "hello@gjcampbell.co.uk",
|
||||
"homepage": "https://github.com/GrahamCampbell"
|
||||
},
|
||||
{
|
||||
"name": "Michael Dowling",
|
||||
"email": "mtdowling@gmail.com",
|
||||
"homepage": "https://github.com/mtdowling"
|
||||
},
|
||||
{
|
||||
"name": "Jeremy Lindblom",
|
||||
"email": "jeremeamia@gmail.com",
|
||||
"homepage": "https://github.com/jeremeamia"
|
||||
},
|
||||
{
|
||||
"name": "George Mponos",
|
||||
"email": "gmponos@gmail.com",
|
||||
"homepage": "https://github.com/gmponos"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Nyholm",
|
||||
"email": "tobias.nyholm@gmail.com",
|
||||
"homepage": "https://github.com/Nyholm"
|
||||
},
|
||||
{
|
||||
"name": "Márk Sági-Kazár",
|
||||
"email": "mark.sagikazar@gmail.com",
|
||||
"homepage": "https://github.com/sagikazarmark"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Schultze",
|
||||
"email": "webmaster@tubo-world.de",
|
||||
"homepage": "https://github.com/Tobion"
|
||||
}
|
||||
],
|
||||
"description": "Guzzle is a PHP HTTP client library",
|
||||
"keywords": [
|
||||
"client",
|
||||
"curl",
|
||||
"framework",
|
||||
"http",
|
||||
"http client",
|
||||
"psr-18",
|
||||
"psr-7",
|
||||
"rest",
|
||||
"web service"
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/guzzle/guzzle/issues",
|
||||
"source": "https://github.com/guzzle/guzzle/tree/7.9.2"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://github.com/GrahamCampbell",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/Nyholm",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/guzzlehttp/guzzle",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2024-07-24T11:22:20+00:00"
|
||||
},
|
||||
{
|
||||
"name": "guzzlehttp/promises",
|
||||
"version": "2.0.3",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/guzzle/promises.git",
|
||||
"reference": "6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/guzzle/promises/zipball/6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8",
|
||||
"reference": "6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.2.5 || ^8.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"bamarni/composer-bin-plugin": "^1.8.2",
|
||||
"phpunit/phpunit": "^8.5.39 || ^9.6.20"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"bamarni-bin": {
|
||||
"bin-links": true,
|
||||
"forward-command": false
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"GuzzleHttp\\Promise\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Graham Campbell",
|
||||
"email": "hello@gjcampbell.co.uk",
|
||||
"homepage": "https://github.com/GrahamCampbell"
|
||||
},
|
||||
{
|
||||
"name": "Michael Dowling",
|
||||
"email": "mtdowling@gmail.com",
|
||||
"homepage": "https://github.com/mtdowling"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Nyholm",
|
||||
"email": "tobias.nyholm@gmail.com",
|
||||
"homepage": "https://github.com/Nyholm"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Schultze",
|
||||
"email": "webmaster@tubo-world.de",
|
||||
"homepage": "https://github.com/Tobion"
|
||||
}
|
||||
],
|
||||
"description": "Guzzle promises library",
|
||||
"keywords": [
|
||||
"promise"
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/guzzle/promises/issues",
|
||||
"source": "https://github.com/guzzle/promises/tree/2.0.3"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://github.com/GrahamCampbell",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/Nyholm",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/guzzlehttp/promises",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2024-07-18T10:29:17+00:00"
|
||||
},
|
||||
{
|
||||
"name": "guzzlehttp/psr7",
|
||||
"version": "2.7.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/guzzle/psr7.git",
|
||||
"reference": "a70f5c95fb43bc83f07c9c948baa0dc1829bf201"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/guzzle/psr7/zipball/a70f5c95fb43bc83f07c9c948baa0dc1829bf201",
|
||||
"reference": "a70f5c95fb43bc83f07c9c948baa0dc1829bf201",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.2.5 || ^8.0",
|
||||
"psr/http-factory": "^1.0",
|
||||
"psr/http-message": "^1.1 || ^2.0",
|
||||
"ralouphie/getallheaders": "^3.0"
|
||||
},
|
||||
"provide": {
|
||||
"psr/http-factory-implementation": "1.0",
|
||||
"psr/http-message-implementation": "1.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"bamarni/composer-bin-plugin": "^1.8.2",
|
||||
"http-interop/http-factory-tests": "0.9.0",
|
||||
"phpunit/phpunit": "^8.5.39 || ^9.6.20"
|
||||
},
|
||||
"suggest": {
|
||||
"laminas/laminas-httphandlerrunner": "Emit PSR-7 responses"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"bamarni-bin": {
|
||||
"bin-links": true,
|
||||
"forward-command": false
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"GuzzleHttp\\Psr7\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Graham Campbell",
|
||||
"email": "hello@gjcampbell.co.uk",
|
||||
"homepage": "https://github.com/GrahamCampbell"
|
||||
},
|
||||
{
|
||||
"name": "Michael Dowling",
|
||||
"email": "mtdowling@gmail.com",
|
||||
"homepage": "https://github.com/mtdowling"
|
||||
},
|
||||
{
|
||||
"name": "George Mponos",
|
||||
"email": "gmponos@gmail.com",
|
||||
"homepage": "https://github.com/gmponos"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Nyholm",
|
||||
"email": "tobias.nyholm@gmail.com",
|
||||
"homepage": "https://github.com/Nyholm"
|
||||
},
|
||||
{
|
||||
"name": "Márk Sági-Kazár",
|
||||
"email": "mark.sagikazar@gmail.com",
|
||||
"homepage": "https://github.com/sagikazarmark"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Schultze",
|
||||
"email": "webmaster@tubo-world.de",
|
||||
"homepage": "https://github.com/Tobion"
|
||||
},
|
||||
{
|
||||
"name": "Márk Sági-Kazár",
|
||||
"email": "mark.sagikazar@gmail.com",
|
||||
"homepage": "https://sagikazarmark.hu"
|
||||
}
|
||||
],
|
||||
"description": "PSR-7 message implementation that also provides common utility methods",
|
||||
"keywords": [
|
||||
"http",
|
||||
"message",
|
||||
"psr-7",
|
||||
"request",
|
||||
"response",
|
||||
"stream",
|
||||
"uri",
|
||||
"url"
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/guzzle/psr7/issues",
|
||||
"source": "https://github.com/guzzle/psr7/tree/2.7.0"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://github.com/GrahamCampbell",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/Nyholm",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/guzzlehttp/psr7",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2024-07-18T11:15:46+00:00"
|
||||
},
|
||||
{
|
||||
"name": "laminas/laminas-escaper",
|
||||
"version": "2.13.0",
|
||||
|
|
@ -678,6 +1066,166 @@
|
|||
],
|
||||
"time": "2023-11-25T22:23:28+00:00"
|
||||
},
|
||||
{
|
||||
"name": "psr/http-client",
|
||||
"version": "1.0.3",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/php-fig/http-client.git",
|
||||
"reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/php-fig/http-client/zipball/bb5906edc1c324c9a05aa0873d40117941e5fa90",
|
||||
"reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.0 || ^8.0",
|
||||
"psr/http-message": "^1.0 || ^2.0"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "1.0.x-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Psr\\Http\\Client\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "PHP-FIG",
|
||||
"homepage": "https://www.php-fig.org/"
|
||||
}
|
||||
],
|
||||
"description": "Common interface for HTTP clients",
|
||||
"homepage": "https://github.com/php-fig/http-client",
|
||||
"keywords": [
|
||||
"http",
|
||||
"http-client",
|
||||
"psr",
|
||||
"psr-18"
|
||||
],
|
||||
"support": {
|
||||
"source": "https://github.com/php-fig/http-client"
|
||||
},
|
||||
"time": "2023-09-23T14:17:50+00:00"
|
||||
},
|
||||
{
|
||||
"name": "psr/http-factory",
|
||||
"version": "1.1.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/php-fig/http-factory.git",
|
||||
"reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/php-fig/http-factory/zipball/2b4765fddfe3b508ac62f829e852b1501d3f6e8a",
|
||||
"reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=7.1",
|
||||
"psr/http-message": "^1.0 || ^2.0"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "1.0.x-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Psr\\Http\\Message\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "PHP-FIG",
|
||||
"homepage": "https://www.php-fig.org/"
|
||||
}
|
||||
],
|
||||
"description": "PSR-17: Common interfaces for PSR-7 HTTP message factories",
|
||||
"keywords": [
|
||||
"factory",
|
||||
"http",
|
||||
"message",
|
||||
"psr",
|
||||
"psr-17",
|
||||
"psr-7",
|
||||
"request",
|
||||
"response"
|
||||
],
|
||||
"support": {
|
||||
"source": "https://github.com/php-fig/http-factory"
|
||||
},
|
||||
"time": "2024-04-15T12:06:14+00:00"
|
||||
},
|
||||
{
|
||||
"name": "psr/http-message",
|
||||
"version": "2.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/php-fig/http-message.git",
|
||||
"reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/php-fig/http-message/zipball/402d35bcb92c70c026d1a6a9883f06b2ead23d71",
|
||||
"reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.2 || ^8.0"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "2.0.x-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Psr\\Http\\Message\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "PHP-FIG",
|
||||
"homepage": "https://www.php-fig.org/"
|
||||
}
|
||||
],
|
||||
"description": "Common interface for HTTP messages",
|
||||
"homepage": "https://github.com/php-fig/http-message",
|
||||
"keywords": [
|
||||
"http",
|
||||
"http-message",
|
||||
"psr",
|
||||
"psr-7",
|
||||
"request",
|
||||
"response"
|
||||
],
|
||||
"support": {
|
||||
"source": "https://github.com/php-fig/http-message/tree/2.0"
|
||||
},
|
||||
"time": "2023-04-04T09:54:51+00:00"
|
||||
},
|
||||
{
|
||||
"name": "psr/log",
|
||||
"version": "3.0.0",
|
||||
|
|
@ -728,6 +1276,50 @@
|
|||
},
|
||||
"time": "2021-07-14T16:46:02+00:00"
|
||||
},
|
||||
{
|
||||
"name": "ralouphie/getallheaders",
|
||||
"version": "3.0.3",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/ralouphie/getallheaders.git",
|
||||
"reference": "120b605dfeb996808c31b6477290a714d356e822"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/ralouphie/getallheaders/zipball/120b605dfeb996808c31b6477290a714d356e822",
|
||||
"reference": "120b605dfeb996808c31b6477290a714d356e822",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.6"
|
||||
},
|
||||
"require-dev": {
|
||||
"php-coveralls/php-coveralls": "^2.1",
|
||||
"phpunit/phpunit": "^5 || ^6.5"
|
||||
},
|
||||
"type": "library",
|
||||
"autoload": {
|
||||
"files": [
|
||||
"src/getallheaders.php"
|
||||
]
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Ralph Khattar",
|
||||
"email": "ralph.khattar@gmail.com"
|
||||
}
|
||||
],
|
||||
"description": "A polyfill for getallheaders.",
|
||||
"support": {
|
||||
"issues": "https://github.com/ralouphie/getallheaders/issues",
|
||||
"source": "https://github.com/ralouphie/getallheaders/tree/develop"
|
||||
},
|
||||
"time": "2019-03-08T08:55:37+00:00"
|
||||
},
|
||||
{
|
||||
"name": "symfony/deprecation-contracts",
|
||||
"version": "v3.5.0",
|
||||
|
|
|
|||
|
|
@ -37,6 +37,7 @@ return [
|
|||
require_once(__DIR__ . '/routes/month-dates.php'),
|
||||
require_once(__DIR__ . '/routes/update-mapado-event.php'),
|
||||
require_once(__DIR__ . '/routes/mapado-fetch.php'),
|
||||
require_once(__DIR__ . '/routes/brevo-create-contact.php'),
|
||||
],
|
||||
'hooks' => [
|
||||
'page.update:after' => require_once(__DIR__ . '/hooks/update-mapado-event.php')
|
||||
|
|
|
|||
45
site/config/routes/brevo-create-contact.php
Normal file
45
site/config/routes/brevo-create-contact.php
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
|
||||
<?php
|
||||
|
||||
require_once(__DIR__ . '/../../../vendor/autoload.php');
|
||||
|
||||
return [
|
||||
'pattern' => '/brevo-create-contact.json',
|
||||
'method' => 'POST',
|
||||
'action' => function () {
|
||||
$jsonRequest = file_get_contents("php://input");
|
||||
$request = json_decode($jsonRequest, true);
|
||||
|
||||
$email = $request['email'];
|
||||
|
||||
$apiKey = site()->brevoApiKey()->value();
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', $apiKey);
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', $apiKey);
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ContactsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
$createContact = new \Brevo\Client\Model\CreateContact([
|
||||
'email' => $email,
|
||||
'updateEnabled' => true,
|
||||
]);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createContact($createContact);
|
||||
return json_encode($email . ' correctement ajouté à Brevo.');
|
||||
} catch (Exception $e) {
|
||||
return json_encode('Exception when calling ContactsApi->createContact: ' . $e->getMessage());
|
||||
}
|
||||
}
|
||||
];
|
||||
|
|
@ -1,10 +1,44 @@
|
|||
<section class="newsletter">
|
||||
<h2>Newsletter</h2>
|
||||
<div class="grid">
|
||||
<div
|
||||
x-data="{
|
||||
btnMsg: 's\'inscrire',
|
||||
submit(event) {
|
||||
event.preventDefault()
|
||||
|
||||
const email = this.$refs.emailInput.value;
|
||||
const emailRegex = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/;
|
||||
|
||||
if (emailRegex.test(email)) {
|
||||
const options = {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({
|
||||
email
|
||||
})
|
||||
}
|
||||
|
||||
fetch('/brevo-create-contact.json', options)
|
||||
.then(res => res.json())
|
||||
.then(json => {
|
||||
console.log(json)
|
||||
this.$refs.emailInput.value = 'Vous êtes inscrit !'
|
||||
this.$refs.emailSubmit.setAttribute('disabled', 'true')
|
||||
})
|
||||
} else {
|
||||
this.btnMsg = 'email invalide'
|
||||
this.$refs.emailInput.value = ''
|
||||
setTimeout(() => {
|
||||
this.btnMsg = 'réessayer'
|
||||
}, 2000)
|
||||
}
|
||||
}
|
||||
}"
|
||||
class="grid"
|
||||
>
|
||||
<p class="grid__item" style="--span: 6;">Inscrivez-vous à notre newsletter pour être tenue informé·e·s de nos dernières actualités !</p>
|
||||
<form class="grid__item" action="" style="--span: 6;">
|
||||
<input placeholder="e-mail" type="email" name="email" autocomplete="email" id="email">
|
||||
<button type="submit">s'inscrire</button>
|
||||
<input placeholder="e-mail" type="email" name="email" autocomplete="email" id="email" x-ref="emailInput">
|
||||
<button type="submit" @click="submit" x-text="btnMsg" x-ref="emailSubmit"></button>
|
||||
</form>
|
||||
</div>
|
||||
</section>
|
||||
489
vendor/composer/autoload_classmap.php
vendored
489
vendor/composer/autoload_classmap.php
vendored
|
|
@ -8,6 +8,392 @@ $baseDir = dirname($vendorDir);
|
|||
return array(
|
||||
'Base32\\Base32' => $vendorDir . '/christian-riesen/base32/src/Base32.php',
|
||||
'Base32\\Base32Hex' => $vendorDir . '/christian-riesen/base32/src/Base32Hex.php',
|
||||
'Brevo\\Client\\ApiException' => $vendorDir . '/getbrevo/brevo-php/lib/ApiException.php',
|
||||
'Brevo\\Client\\Api\\AccountApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/AccountApi.php',
|
||||
'Brevo\\Client\\Api\\AttributesApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/AttributesApi.php',
|
||||
'Brevo\\Client\\Api\\CRMApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/CRMApi.php',
|
||||
'Brevo\\Client\\Api\\CompaniesApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/CompaniesApi.php',
|
||||
'Brevo\\Client\\Api\\ContactsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/ContactsApi.php',
|
||||
'Brevo\\Client\\Api\\ConversationsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/ConversationsApi.php',
|
||||
'Brevo\\Client\\Api\\CouponsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/CouponsApi.php',
|
||||
'Brevo\\Client\\Api\\DealsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/DealsApi.php',
|
||||
'Brevo\\Client\\Api\\DomainsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/DomainsApi.php',
|
||||
'Brevo\\Client\\Api\\EcommerceApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/EcommerceApi.php',
|
||||
'Brevo\\Client\\Api\\EmailCampaignsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/EmailCampaignsApi.php',
|
||||
'Brevo\\Client\\Api\\EventsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/EventsApi.php',
|
||||
'Brevo\\Client\\Api\\ExternalFeedsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/ExternalFeedsApi.php',
|
||||
'Brevo\\Client\\Api\\FilesApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/FilesApi.php',
|
||||
'Brevo\\Client\\Api\\FoldersApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/FoldersApi.php',
|
||||
'Brevo\\Client\\Api\\InboundParsingApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/InboundParsingApi.php',
|
||||
'Brevo\\Client\\Api\\ListsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/ListsApi.php',
|
||||
'Brevo\\Client\\Api\\MasterAccountApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/MasterAccountApi.php',
|
||||
'Brevo\\Client\\Api\\NotesApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/NotesApi.php',
|
||||
'Brevo\\Client\\Api\\ProcessApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/ProcessApi.php',
|
||||
'Brevo\\Client\\Api\\ResellerApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/ResellerApi.php',
|
||||
'Brevo\\Client\\Api\\SMSCampaignsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/SMSCampaignsApi.php',
|
||||
'Brevo\\Client\\Api\\SendersApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/SendersApi.php',
|
||||
'Brevo\\Client\\Api\\TasksApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/TasksApi.php',
|
||||
'Brevo\\Client\\Api\\TransactionalEmailsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/TransactionalEmailsApi.php',
|
||||
'Brevo\\Client\\Api\\TransactionalSMSApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/TransactionalSMSApi.php',
|
||||
'Brevo\\Client\\Api\\TransactionalWhatsAppApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/TransactionalWhatsAppApi.php',
|
||||
'Brevo\\Client\\Api\\UserApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/UserApi.php',
|
||||
'Brevo\\Client\\Api\\WebhooksApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/WebhooksApi.php',
|
||||
'Brevo\\Client\\Api\\WhatsAppCampaignsApi' => $vendorDir . '/getbrevo/brevo-php/lib/Api/WhatsAppCampaignsApi.php',
|
||||
'Brevo\\Client\\Configuration' => $vendorDir . '/getbrevo/brevo-php/lib/Configuration.php',
|
||||
'Brevo\\Client\\HeaderSelector' => $vendorDir . '/getbrevo/brevo-php/lib/HeaderSelector.php',
|
||||
'Brevo\\Client\\Model\\AbTestCampaignResult' => $vendorDir . '/getbrevo/brevo-php/lib/Model/AbTestCampaignResult.php',
|
||||
'Brevo\\Client\\Model\\AbTestCampaignResultClickedLinks' => $vendorDir . '/getbrevo/brevo-php/lib/Model/AbTestCampaignResultClickedLinks.php',
|
||||
'Brevo\\Client\\Model\\AbTestCampaignResultStatistics' => $vendorDir . '/getbrevo/brevo-php/lib/Model/AbTestCampaignResultStatistics.php',
|
||||
'Brevo\\Client\\Model\\AbTestVersionClicks' => $vendorDir . '/getbrevo/brevo-php/lib/Model/AbTestVersionClicks.php',
|
||||
'Brevo\\Client\\Model\\AbTestVersionClicksInner' => $vendorDir . '/getbrevo/brevo-php/lib/Model/AbTestVersionClicksInner.php',
|
||||
'Brevo\\Client\\Model\\AbTestVersionStats' => $vendorDir . '/getbrevo/brevo-php/lib/Model/AbTestVersionStats.php',
|
||||
'Brevo\\Client\\Model\\AddChildDomain' => $vendorDir . '/getbrevo/brevo-php/lib/Model/AddChildDomain.php',
|
||||
'Brevo\\Client\\Model\\AddContactToList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/AddContactToList.php',
|
||||
'Brevo\\Client\\Model\\AddCredits' => $vendorDir . '/getbrevo/brevo-php/lib/Model/AddCredits.php',
|
||||
'Brevo\\Client\\Model\\AuthenticateDomainModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/AuthenticateDomainModel.php',
|
||||
'Brevo\\Client\\Model\\BlockDomain' => $vendorDir . '/getbrevo/brevo-php/lib/Model/BlockDomain.php',
|
||||
'Brevo\\Client\\Model\\Body' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body.php',
|
||||
'Brevo\\Client\\Model\\Body1' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body1.php',
|
||||
'Brevo\\Client\\Model\\Body10' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body10.php',
|
||||
'Brevo\\Client\\Model\\Body11' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body11.php',
|
||||
'Brevo\\Client\\Model\\Body12' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body12.php',
|
||||
'Brevo\\Client\\Model\\Body13' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body13.php',
|
||||
'Brevo\\Client\\Model\\Body14' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body14.php',
|
||||
'Brevo\\Client\\Model\\Body2' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body2.php',
|
||||
'Brevo\\Client\\Model\\Body3' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body3.php',
|
||||
'Brevo\\Client\\Model\\Body4' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body4.php',
|
||||
'Brevo\\Client\\Model\\Body5' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body5.php',
|
||||
'Brevo\\Client\\Model\\Body6' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body6.php',
|
||||
'Brevo\\Client\\Model\\Body7' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body7.php',
|
||||
'Brevo\\Client\\Model\\Body8' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body8.php',
|
||||
'Brevo\\Client\\Model\\Body9' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Body9.php',
|
||||
'Brevo\\Client\\Model\\BodyVariablesItems' => $vendorDir . '/getbrevo/brevo-php/lib/Model/BodyVariablesItems.php',
|
||||
'Brevo\\Client\\Model\\CompaniesList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CompaniesList.php',
|
||||
'Brevo\\Client\\Model\\Company' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Company.php',
|
||||
'Brevo\\Client\\Model\\CompanyAttributes' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CompanyAttributes.php',
|
||||
'Brevo\\Client\\Model\\CompanyAttributesInner' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CompanyAttributesInner.php',
|
||||
'Brevo\\Client\\Model\\ComponentItems' => $vendorDir . '/getbrevo/brevo-php/lib/Model/ComponentItems.php',
|
||||
'Brevo\\Client\\Model\\Contact' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Contact.php',
|
||||
'Brevo\\Client\\Model\\ConversationsMessage' => $vendorDir . '/getbrevo/brevo-php/lib/Model/ConversationsMessage.php',
|
||||
'Brevo\\Client\\Model\\ConversationsMessageFile' => $vendorDir . '/getbrevo/brevo-php/lib/Model/ConversationsMessageFile.php',
|
||||
'Brevo\\Client\\Model\\ConversationsMessageFileImageInfo' => $vendorDir . '/getbrevo/brevo-php/lib/Model/ConversationsMessageFileImageInfo.php',
|
||||
'Brevo\\Client\\Model\\CreateApiKeyRequest' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateApiKeyRequest.php',
|
||||
'Brevo\\Client\\Model\\CreateApiKeyResponse' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateApiKeyResponse.php',
|
||||
'Brevo\\Client\\Model\\CreateAttribute' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateAttribute.php',
|
||||
'Brevo\\Client\\Model\\CreateAttributeEnumeration' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateAttributeEnumeration.php',
|
||||
'Brevo\\Client\\Model\\CreateCategoryModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateCategoryModel.php',
|
||||
'Brevo\\Client\\Model\\CreateChild' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateChild.php',
|
||||
'Brevo\\Client\\Model\\CreateContact' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateContact.php',
|
||||
'Brevo\\Client\\Model\\CreateCouponCollection' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateCouponCollection.php',
|
||||
'Brevo\\Client\\Model\\CreateCoupons' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateCoupons.php',
|
||||
'Brevo\\Client\\Model\\CreateDoiContact' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateDoiContact.php',
|
||||
'Brevo\\Client\\Model\\CreateDomain' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateDomain.php',
|
||||
'Brevo\\Client\\Model\\CreateDomainModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateDomainModel.php',
|
||||
'Brevo\\Client\\Model\\CreateDomainModelDnsRecords' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateDomainModelDnsRecords.php',
|
||||
'Brevo\\Client\\Model\\CreateDomainModelDnsRecordsDkimRecord' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateDomainModelDnsRecordsDkimRecord.php',
|
||||
'Brevo\\Client\\Model\\CreateEmailCampaign' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateEmailCampaign.php',
|
||||
'Brevo\\Client\\Model\\CreateEmailCampaignRecipients' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateEmailCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\CreateEmailCampaignSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateEmailCampaignSender.php',
|
||||
'Brevo\\Client\\Model\\CreateExternalFeed' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateExternalFeed.php',
|
||||
'Brevo\\Client\\Model\\CreateList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateList.php',
|
||||
'Brevo\\Client\\Model\\CreateModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateModel.php',
|
||||
'Brevo\\Client\\Model\\CreateProductModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateProductModel.php',
|
||||
'Brevo\\Client\\Model\\CreateReseller' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateReseller.php',
|
||||
'Brevo\\Client\\Model\\CreateSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateSender.php',
|
||||
'Brevo\\Client\\Model\\CreateSenderIps' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateSenderIps.php',
|
||||
'Brevo\\Client\\Model\\CreateSenderModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateSenderModel.php',
|
||||
'Brevo\\Client\\Model\\CreateSmsCampaign' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateSmsCampaign.php',
|
||||
'Brevo\\Client\\Model\\CreateSmsCampaignRecipients' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateSmsCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\CreateSmtpEmail' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateSmtpEmail.php',
|
||||
'Brevo\\Client\\Model\\CreateSmtpTemplate' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateSmtpTemplate.php',
|
||||
'Brevo\\Client\\Model\\CreateSmtpTemplateSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateSmtpTemplateSender.php',
|
||||
'Brevo\\Client\\Model\\CreateSubAccount' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateSubAccount.php',
|
||||
'Brevo\\Client\\Model\\CreateSubAccountResponse' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateSubAccountResponse.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateBatchCategory' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateUpdateBatchCategory.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateBatchCategoryModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateUpdateBatchCategoryModel.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateBatchProducts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateUpdateBatchProducts.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateBatchProductsModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateUpdateBatchProductsModel.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateCategories' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateUpdateCategories.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateCategory' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateUpdateCategory.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateContactModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateUpdateContactModel.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateFolder' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateUpdateFolder.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateProduct' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateUpdateProduct.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateProducts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateUpdateProducts.php',
|
||||
'Brevo\\Client\\Model\\CreateWebhook' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateWebhook.php',
|
||||
'Brevo\\Client\\Model\\CreateWhatsAppCampaign' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateWhatsAppCampaign.php',
|
||||
'Brevo\\Client\\Model\\CreateWhatsAppCampaignRecipients' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateWhatsAppCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\CreateWhatsAppTemplate' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreateWhatsAppTemplate.php',
|
||||
'Brevo\\Client\\Model\\CreatedBatchId' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreatedBatchId.php',
|
||||
'Brevo\\Client\\Model\\CreatedProcessId' => $vendorDir . '/getbrevo/brevo-php/lib/Model/CreatedProcessId.php',
|
||||
'Brevo\\Client\\Model\\Deal' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Deal.php',
|
||||
'Brevo\\Client\\Model\\DealAttributes' => $vendorDir . '/getbrevo/brevo-php/lib/Model/DealAttributes.php',
|
||||
'Brevo\\Client\\Model\\DealAttributesInner' => $vendorDir . '/getbrevo/brevo-php/lib/Model/DealAttributesInner.php',
|
||||
'Brevo\\Client\\Model\\DealsList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/DealsList.php',
|
||||
'Brevo\\Client\\Model\\DeleteHardbounces' => $vendorDir . '/getbrevo/brevo-php/lib/Model/DeleteHardbounces.php',
|
||||
'Brevo\\Client\\Model\\EmailExportRecipients' => $vendorDir . '/getbrevo/brevo-php/lib/Model/EmailExportRecipients.php',
|
||||
'Brevo\\Client\\Model\\ErrorModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/ErrorModel.php',
|
||||
'Brevo\\Client\\Model\\Event' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Event.php',
|
||||
'Brevo\\Client\\Model\\EventIdentifiers' => $vendorDir . '/getbrevo/brevo-php/lib/Model/EventIdentifiers.php',
|
||||
'Brevo\\Client\\Model\\ExportWebhooksHistory' => $vendorDir . '/getbrevo/brevo-php/lib/Model/ExportWebhooksHistory.php',
|
||||
'Brevo\\Client\\Model\\FileData' => $vendorDir . '/getbrevo/brevo-php/lib/Model/FileData.php',
|
||||
'Brevo\\Client\\Model\\FileDownloadableLink' => $vendorDir . '/getbrevo/brevo-php/lib/Model/FileDownloadableLink.php',
|
||||
'Brevo\\Client\\Model\\FileList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/FileList.php',
|
||||
'Brevo\\Client\\Model\\GetAccount' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAccount.php',
|
||||
'Brevo\\Client\\Model\\GetAccountActivity' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAccountActivity.php',
|
||||
'Brevo\\Client\\Model\\GetAccountActivityLogs' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAccountActivityLogs.php',
|
||||
'Brevo\\Client\\Model\\GetAccountMarketingAutomation' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAccountMarketingAutomation.php',
|
||||
'Brevo\\Client\\Model\\GetAccountPlan' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAccountPlan.php',
|
||||
'Brevo\\Client\\Model\\GetAccountRelay' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAccountRelay.php',
|
||||
'Brevo\\Client\\Model\\GetAccountRelayData' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAccountRelayData.php',
|
||||
'Brevo\\Client\\Model\\GetAggregatedReport' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAggregatedReport.php',
|
||||
'Brevo\\Client\\Model\\GetAllExternalFeeds' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAllExternalFeeds.php',
|
||||
'Brevo\\Client\\Model\\GetAllExternalFeedsFeeds' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAllExternalFeedsFeeds.php',
|
||||
'Brevo\\Client\\Model\\GetAttributes' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAttributes.php',
|
||||
'Brevo\\Client\\Model\\GetAttributesAttributes' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAttributesAttributes.php',
|
||||
'Brevo\\Client\\Model\\GetAttributesEnumeration' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetAttributesEnumeration.php',
|
||||
'Brevo\\Client\\Model\\GetBlockedDomains' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetBlockedDomains.php',
|
||||
'Brevo\\Client\\Model\\GetCampaignOverview' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetCampaignOverview.php',
|
||||
'Brevo\\Client\\Model\\GetCampaignRecipients' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\GetCampaignStats' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetCampaignStats.php',
|
||||
'Brevo\\Client\\Model\\GetCategories' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetCategories.php',
|
||||
'Brevo\\Client\\Model\\GetCategoryDetails' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetCategoryDetails.php',
|
||||
'Brevo\\Client\\Model\\GetChildAccountCreationStatus' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetChildAccountCreationStatus.php',
|
||||
'Brevo\\Client\\Model\\GetChildDomain' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetChildDomain.php',
|
||||
'Brevo\\Client\\Model\\GetChildDomains' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetChildDomains.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfo' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetChildInfo.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfoApiKeys' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetChildInfoApiKeys.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfoApiKeysV2' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetChildInfoApiKeysV2.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfoApiKeysV3' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetChildInfoApiKeysV3.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfoCredits' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetChildInfoCredits.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfoStatistics' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetChildInfoStatistics.php',
|
||||
'Brevo\\Client\\Model\\GetChildrenList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetChildrenList.php',
|
||||
'Brevo\\Client\\Model\\GetClient' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetClient.php',
|
||||
'Brevo\\Client\\Model\\GetContactCampaignStats' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetContactCampaignStats.php',
|
||||
'Brevo\\Client\\Model\\GetContactCampaignStatsClicked' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetContactCampaignStatsClicked.php',
|
||||
'Brevo\\Client\\Model\\GetContactCampaignStatsOpened' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetContactCampaignStatsOpened.php',
|
||||
'Brevo\\Client\\Model\\GetContactCampaignStatsTransacAttributes' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetContactCampaignStatsTransacAttributes.php',
|
||||
'Brevo\\Client\\Model\\GetContactCampaignStatsUnsubscriptions' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetContactCampaignStatsUnsubscriptions.php',
|
||||
'Brevo\\Client\\Model\\GetContactDetails' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetContactDetails.php',
|
||||
'Brevo\\Client\\Model\\GetContacts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetContacts.php',
|
||||
'Brevo\\Client\\Model\\GetCorporateInvitedUsersList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetCorporateInvitedUsersList.php',
|
||||
'Brevo\\Client\\Model\\GetCorporateInvitedUsersListFeatureAccess' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetCorporateInvitedUsersListFeatureAccess.php',
|
||||
'Brevo\\Client\\Model\\GetCorporateInvitedUsersListGroups' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetCorporateInvitedUsersListGroups.php',
|
||||
'Brevo\\Client\\Model\\GetCorporateInvitedUsersListUsers' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetCorporateInvitedUsersListUsers.php',
|
||||
'Brevo\\Client\\Model\\GetCouponCollection' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetCouponCollection.php',
|
||||
'Brevo\\Client\\Model\\GetDeviceBrowserStats' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetDeviceBrowserStats.php',
|
||||
'Brevo\\Client\\Model\\GetDomainConfigurationModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetDomainConfigurationModel.php',
|
||||
'Brevo\\Client\\Model\\GetDomainsList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetDomainsList.php',
|
||||
'Brevo\\Client\\Model\\GetDomainsListDomains' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetDomainsListDomains.php',
|
||||
'Brevo\\Client\\Model\\GetEmailCampaign' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetEmailCampaign.php',
|
||||
'Brevo\\Client\\Model\\GetEmailCampaigns' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetEmailCampaigns.php',
|
||||
'Brevo\\Client\\Model\\GetEmailEventReport' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetEmailEventReport.php',
|
||||
'Brevo\\Client\\Model\\GetEmailEventReportEvents' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetEmailEventReportEvents.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedCampaignOverview' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedCampaignOverview.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedCampaignOverviewSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedCampaignOverviewSender.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedCampaignStats' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedCampaignStats.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedCampaignStatsGlobalStats' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedCampaignStatsGlobalStats.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedClient' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedClient.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedClientAddress' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedClientAddress.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetails' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetails.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatistics' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatistics.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsClicked' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsClicked.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsDelivered' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsDelivered.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsLinks' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsLinks.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsMessagesSent' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsMessagesSent.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsOpened' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsOpened.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsUnsubscriptions' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsUnsubscriptions.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedList.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedListCampaignStats' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExtendedListCampaignStats.php',
|
||||
'Brevo\\Client\\Model\\GetExternalFeedByUUID' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExternalFeedByUUID.php',
|
||||
'Brevo\\Client\\Model\\GetExternalFeedByUUIDHeaders' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetExternalFeedByUUIDHeaders.php',
|
||||
'Brevo\\Client\\Model\\GetFolder' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetFolder.php',
|
||||
'Brevo\\Client\\Model\\GetFolderLists' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetFolderLists.php',
|
||||
'Brevo\\Client\\Model\\GetFolders' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetFolders.php',
|
||||
'Brevo\\Client\\Model\\GetInboundEmailEvents' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetInboundEmailEvents.php',
|
||||
'Brevo\\Client\\Model\\GetInboundEmailEventsByUuid' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetInboundEmailEventsByUuid.php',
|
||||
'Brevo\\Client\\Model\\GetInboundEmailEventsByUuidAttachments' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetInboundEmailEventsByUuidAttachments.php',
|
||||
'Brevo\\Client\\Model\\GetInboundEmailEventsByUuidLogs' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetInboundEmailEventsByUuidLogs.php',
|
||||
'Brevo\\Client\\Model\\GetInboundEmailEventsEvents' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetInboundEmailEventsEvents.php',
|
||||
'Brevo\\Client\\Model\\GetInvitedUsersList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetInvitedUsersList.php',
|
||||
'Brevo\\Client\\Model\\GetInvitedUsersListFeatureAccess' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetInvitedUsersListFeatureAccess.php',
|
||||
'Brevo\\Client\\Model\\GetInvitedUsersListUsers' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetInvitedUsersListUsers.php',
|
||||
'Brevo\\Client\\Model\\GetIp' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetIp.php',
|
||||
'Brevo\\Client\\Model\\GetIpFromSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetIpFromSender.php',
|
||||
'Brevo\\Client\\Model\\GetIps' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetIps.php',
|
||||
'Brevo\\Client\\Model\\GetIpsFromSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetIpsFromSender.php',
|
||||
'Brevo\\Client\\Model\\GetList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetList.php',
|
||||
'Brevo\\Client\\Model\\GetLists' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetLists.php',
|
||||
'Brevo\\Client\\Model\\GetOrders' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetOrders.php',
|
||||
'Brevo\\Client\\Model\\GetProcess' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetProcess.php',
|
||||
'Brevo\\Client\\Model\\GetProcesses' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetProcesses.php',
|
||||
'Brevo\\Client\\Model\\GetProductDetails' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetProductDetails.php',
|
||||
'Brevo\\Client\\Model\\GetProducts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetProducts.php',
|
||||
'Brevo\\Client\\Model\\GetReports' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetReports.php',
|
||||
'Brevo\\Client\\Model\\GetReportsReports' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetReportsReports.php',
|
||||
'Brevo\\Client\\Model\\GetScheduledEmailByBatchId' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetScheduledEmailByBatchId.php',
|
||||
'Brevo\\Client\\Model\\GetScheduledEmailByBatchIdBatches' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetScheduledEmailByBatchIdBatches.php',
|
||||
'Brevo\\Client\\Model\\GetScheduledEmailByMessageId' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetScheduledEmailByMessageId.php',
|
||||
'Brevo\\Client\\Model\\GetSegments' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSegments.php',
|
||||
'Brevo\\Client\\Model\\GetSegmentsSegments' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSegmentsSegments.php',
|
||||
'Brevo\\Client\\Model\\GetSendersList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSendersList.php',
|
||||
'Brevo\\Client\\Model\\GetSendersListIps' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSendersListIps.php',
|
||||
'Brevo\\Client\\Model\\GetSendersListSenders' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSendersListSenders.php',
|
||||
'Brevo\\Client\\Model\\GetSharedTemplateUrl' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSharedTemplateUrl.php',
|
||||
'Brevo\\Client\\Model\\GetSmsCampaign' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSmsCampaign.php',
|
||||
'Brevo\\Client\\Model\\GetSmsCampaignOverview' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSmsCampaignOverview.php',
|
||||
'Brevo\\Client\\Model\\GetSmsCampaignRecipients' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSmsCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\GetSmsCampaignStats' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSmsCampaignStats.php',
|
||||
'Brevo\\Client\\Model\\GetSmsCampaigns' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSmsCampaigns.php',
|
||||
'Brevo\\Client\\Model\\GetSmsEventReport' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSmsEventReport.php',
|
||||
'Brevo\\Client\\Model\\GetSmsEventReportEvents' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSmsEventReportEvents.php',
|
||||
'Brevo\\Client\\Model\\GetSmtpTemplateOverview' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSmtpTemplateOverview.php',
|
||||
'Brevo\\Client\\Model\\GetSmtpTemplateOverviewSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSmtpTemplateOverviewSender.php',
|
||||
'Brevo\\Client\\Model\\GetSmtpTemplates' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSmtpTemplates.php',
|
||||
'Brevo\\Client\\Model\\GetSsoToken' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetSsoToken.php',
|
||||
'Brevo\\Client\\Model\\GetStatsByBrowser' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetStatsByBrowser.php',
|
||||
'Brevo\\Client\\Model\\GetStatsByDevice' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetStatsByDevice.php',
|
||||
'Brevo\\Client\\Model\\GetStatsByDomain' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetStatsByDomain.php',
|
||||
'Brevo\\Client\\Model\\GetTransacAggregatedSmsReport' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetTransacAggregatedSmsReport.php',
|
||||
'Brevo\\Client\\Model\\GetTransacBlockedContacts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetTransacBlockedContacts.php',
|
||||
'Brevo\\Client\\Model\\GetTransacBlockedContactsContacts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetTransacBlockedContactsContacts.php',
|
||||
'Brevo\\Client\\Model\\GetTransacBlockedContactsReason' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetTransacBlockedContactsReason.php',
|
||||
'Brevo\\Client\\Model\\GetTransacEmailContent' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetTransacEmailContent.php',
|
||||
'Brevo\\Client\\Model\\GetTransacEmailContentEvents' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetTransacEmailContentEvents.php',
|
||||
'Brevo\\Client\\Model\\GetTransacEmailsList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetTransacEmailsList.php',
|
||||
'Brevo\\Client\\Model\\GetTransacEmailsListTransactionalEmails' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetTransacEmailsListTransactionalEmails.php',
|
||||
'Brevo\\Client\\Model\\GetTransacSmsReport' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetTransacSmsReport.php',
|
||||
'Brevo\\Client\\Model\\GetTransacSmsReportReports' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetTransacSmsReportReports.php',
|
||||
'Brevo\\Client\\Model\\GetUserPermission' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetUserPermission.php',
|
||||
'Brevo\\Client\\Model\\GetUserPermissionPrivileges' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetUserPermissionPrivileges.php',
|
||||
'Brevo\\Client\\Model\\GetWATemplates' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWATemplates.php',
|
||||
'Brevo\\Client\\Model\\GetWATemplatesTemplates' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWATemplatesTemplates.php',
|
||||
'Brevo\\Client\\Model\\GetWebhook' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWebhook.php',
|
||||
'Brevo\\Client\\Model\\GetWebhookAuth' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWebhookAuth.php',
|
||||
'Brevo\\Client\\Model\\GetWebhookHeaders' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWebhookHeaders.php',
|
||||
'Brevo\\Client\\Model\\GetWebhooks' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWebhooks.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsAppConfig' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWhatsAppConfig.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsappCampaignOverview' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWhatsappCampaignOverview.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsappCampaigns' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWhatsappCampaigns.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsappCampaignsCampaigns' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWhatsappCampaignsCampaigns.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsappEventReport' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWhatsappEventReport.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsappEventReportEvents' => $vendorDir . '/getbrevo/brevo-php/lib/Model/GetWhatsappEventReportEvents.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse200' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InlineResponse200.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2001' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InlineResponse2001.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2002' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InlineResponse2002.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse201' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InlineResponse201.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2011' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InlineResponse2011.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2012' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InlineResponse2012.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2013' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InlineResponse2013.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2014' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InlineResponse2014.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2015' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InlineResponse2015.php',
|
||||
'Brevo\\Client\\Model\\InviteAdminUser' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InviteAdminUser.php',
|
||||
'Brevo\\Client\\Model\\InviteAdminUserPrivileges' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InviteAdminUserPrivileges.php',
|
||||
'Brevo\\Client\\Model\\Inviteuser' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Inviteuser.php',
|
||||
'Brevo\\Client\\Model\\InviteuserPrivileges' => $vendorDir . '/getbrevo/brevo-php/lib/Model/InviteuserPrivileges.php',
|
||||
'Brevo\\Client\\Model\\ManageIp' => $vendorDir . '/getbrevo/brevo-php/lib/Model/ManageIp.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponse' => $vendorDir . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponse.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponseBillingInfo' => $vendorDir . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponseBillingInfo.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponseBillingInfoAddress' => $vendorDir . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponseBillingInfoAddress.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponseBillingInfoName' => $vendorDir . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponseBillingInfoName.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponsePlanInfo' => $vendorDir . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponsePlanInfo.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponsePlanInfoFeatures' => $vendorDir . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponsePlanInfoFeatures.php',
|
||||
'Brevo\\Client\\Model\\ModelInterface' => $vendorDir . '/getbrevo/brevo-php/lib/Model/ModelInterface.php',
|
||||
'Brevo\\Client\\Model\\Note' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Note.php',
|
||||
'Brevo\\Client\\Model\\NoteData' => $vendorDir . '/getbrevo/brevo-php/lib/Model/NoteData.php',
|
||||
'Brevo\\Client\\Model\\NoteId' => $vendorDir . '/getbrevo/brevo-php/lib/Model/NoteId.php',
|
||||
'Brevo\\Client\\Model\\NoteList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/NoteList.php',
|
||||
'Brevo\\Client\\Model\\Order' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Order.php',
|
||||
'Brevo\\Client\\Model\\OrderBatch' => $vendorDir . '/getbrevo/brevo-php/lib/Model/OrderBatch.php',
|
||||
'Brevo\\Client\\Model\\OrderBilling' => $vendorDir . '/getbrevo/brevo-php/lib/Model/OrderBilling.php',
|
||||
'Brevo\\Client\\Model\\OrderProducts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/OrderProducts.php',
|
||||
'Brevo\\Client\\Model\\Otp' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Otp.php',
|
||||
'Brevo\\Client\\Model\\Pipeline' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Pipeline.php',
|
||||
'Brevo\\Client\\Model\\PipelineStage' => $vendorDir . '/getbrevo/brevo-php/lib/Model/PipelineStage.php',
|
||||
'Brevo\\Client\\Model\\Pipelines' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Pipelines.php',
|
||||
'Brevo\\Client\\Model\\PostContactInfo' => $vendorDir . '/getbrevo/brevo-php/lib/Model/PostContactInfo.php',
|
||||
'Brevo\\Client\\Model\\PostContactInfoContacts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/PostContactInfoContacts.php',
|
||||
'Brevo\\Client\\Model\\PostSendFailed' => $vendorDir . '/getbrevo/brevo-php/lib/Model/PostSendFailed.php',
|
||||
'Brevo\\Client\\Model\\PostSendSmsTestFailed' => $vendorDir . '/getbrevo/brevo-php/lib/Model/PostSendSmsTestFailed.php',
|
||||
'Brevo\\Client\\Model\\PutRevokeUserPermission' => $vendorDir . '/getbrevo/brevo-php/lib/Model/PutRevokeUserPermission.php',
|
||||
'Brevo\\Client\\Model\\Putresendcancelinvitation' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Putresendcancelinvitation.php',
|
||||
'Brevo\\Client\\Model\\RemainingCreditModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RemainingCreditModel.php',
|
||||
'Brevo\\Client\\Model\\RemainingCreditModelChild' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RemainingCreditModelChild.php',
|
||||
'Brevo\\Client\\Model\\RemainingCreditModelReseller' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RemainingCreditModelReseller.php',
|
||||
'Brevo\\Client\\Model\\RemoveContactFromList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RemoveContactFromList.php',
|
||||
'Brevo\\Client\\Model\\RemoveCredits' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RemoveCredits.php',
|
||||
'Brevo\\Client\\Model\\RequestContactExport' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RequestContactExport.php',
|
||||
'Brevo\\Client\\Model\\RequestContactExportCustomContactFilter' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RequestContactExportCustomContactFilter.php',
|
||||
'Brevo\\Client\\Model\\RequestContactImport' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RequestContactImport.php',
|
||||
'Brevo\\Client\\Model\\RequestContactImportJsonBody' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RequestContactImportJsonBody.php',
|
||||
'Brevo\\Client\\Model\\RequestContactImportNewList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RequestContactImportNewList.php',
|
||||
'Brevo\\Client\\Model\\RequestSmsRecipientExport' => $vendorDir . '/getbrevo/brevo-php/lib/Model/RequestSmsRecipientExport.php',
|
||||
'Brevo\\Client\\Model\\ScheduleSmtpEmail' => $vendorDir . '/getbrevo/brevo-php/lib/Model/ScheduleSmtpEmail.php',
|
||||
'Brevo\\Client\\Model\\SendReport' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendReport.php',
|
||||
'Brevo\\Client\\Model\\SendReportEmail' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendReportEmail.php',
|
||||
'Brevo\\Client\\Model\\SendSms' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSms.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmail' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSmtpEmail.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailAttachment' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailAttachment.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailBcc' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailBcc.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailCc' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailCc.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailMessageVersions' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailMessageVersions.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailReplyTo' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailReplyTo.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailReplyTo1' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailReplyTo1.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailSender.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailTo' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailTo.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailTo1' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailTo1.php',
|
||||
'Brevo\\Client\\Model\\SendTestEmail' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendTestEmail.php',
|
||||
'Brevo\\Client\\Model\\SendTestSms' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendTestSms.php',
|
||||
'Brevo\\Client\\Model\\SendTransacSms' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendTransacSms.php',
|
||||
'Brevo\\Client\\Model\\SendWhatsappMessage' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SendWhatsappMessage.php',
|
||||
'Brevo\\Client\\Model\\SsoTokenRequest' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SsoTokenRequest.php',
|
||||
'Brevo\\Client\\Model\\SubAccountAppsToggleRequest' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountAppsToggleRequest.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponse' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponse.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfo' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfo.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoCredits' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoCredits.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoCreditsEmails' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoCreditsEmails.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoFeatures' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeatures.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoFeaturesInbox' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeaturesInbox.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoFeaturesLandingPage' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoFeaturesUsers' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeaturesUsers.php',
|
||||
'Brevo\\Client\\Model\\SubAccountUpdatePlanRequest' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountUpdatePlanRequest.php',
|
||||
'Brevo\\Client\\Model\\SubAccountUpdatePlanRequestCredits' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountUpdatePlanRequestCredits.php',
|
||||
'Brevo\\Client\\Model\\SubAccountUpdatePlanRequestFeatures' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountUpdatePlanRequestFeatures.php',
|
||||
'Brevo\\Client\\Model\\SubAccountsResponse' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountsResponse.php',
|
||||
'Brevo\\Client\\Model\\SubAccountsResponseSubAccounts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/SubAccountsResponseSubAccounts.php',
|
||||
'Brevo\\Client\\Model\\Task' => $vendorDir . '/getbrevo/brevo-php/lib/Model/Task.php',
|
||||
'Brevo\\Client\\Model\\TaskList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/TaskList.php',
|
||||
'Brevo\\Client\\Model\\TaskReminder' => $vendorDir . '/getbrevo/brevo-php/lib/Model/TaskReminder.php',
|
||||
'Brevo\\Client\\Model\\TaskTypes' => $vendorDir . '/getbrevo/brevo-php/lib/Model/TaskTypes.php',
|
||||
'Brevo\\Client\\Model\\UpdateAttribute' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateAttribute.php',
|
||||
'Brevo\\Client\\Model\\UpdateAttributeEnumeration' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateAttributeEnumeration.php',
|
||||
'Brevo\\Client\\Model\\UpdateBatchContacts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateBatchContacts.php',
|
||||
'Brevo\\Client\\Model\\UpdateBatchContactsContacts' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateBatchContactsContacts.php',
|
||||
'Brevo\\Client\\Model\\UpdateBatchContactsModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateBatchContactsModel.php',
|
||||
'Brevo\\Client\\Model\\UpdateCampaignStatus' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateCampaignStatus.php',
|
||||
'Brevo\\Client\\Model\\UpdateChild' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateChild.php',
|
||||
'Brevo\\Client\\Model\\UpdateChildAccountStatus' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateChildAccountStatus.php',
|
||||
'Brevo\\Client\\Model\\UpdateChildDomain' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateChildDomain.php',
|
||||
'Brevo\\Client\\Model\\UpdateContact' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateContact.php',
|
||||
'Brevo\\Client\\Model\\UpdateCouponCollection' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateCouponCollection.php',
|
||||
'Brevo\\Client\\Model\\UpdateEmailCampaign' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateEmailCampaign.php',
|
||||
'Brevo\\Client\\Model\\UpdateEmailCampaignRecipients' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateEmailCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\UpdateEmailCampaignSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateEmailCampaignSender.php',
|
||||
'Brevo\\Client\\Model\\UpdateExternalFeed' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateExternalFeed.php',
|
||||
'Brevo\\Client\\Model\\UpdateList' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateList.php',
|
||||
'Brevo\\Client\\Model\\UpdateSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateSender.php',
|
||||
'Brevo\\Client\\Model\\UpdateSmsCampaign' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateSmsCampaign.php',
|
||||
'Brevo\\Client\\Model\\UpdateSmtpTemplate' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateSmtpTemplate.php',
|
||||
'Brevo\\Client\\Model\\UpdateSmtpTemplateSender' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateSmtpTemplateSender.php',
|
||||
'Brevo\\Client\\Model\\UpdateWebhook' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateWebhook.php',
|
||||
'Brevo\\Client\\Model\\UpdateWhatsAppCampaign' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UpdateWhatsAppCampaign.php',
|
||||
'Brevo\\Client\\Model\\UploadImageModel' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UploadImageModel.php',
|
||||
'Brevo\\Client\\Model\\UploadImageToGallery' => $vendorDir . '/getbrevo/brevo-php/lib/Model/UploadImageToGallery.php',
|
||||
'Brevo\\Client\\Model\\VariablesItems' => $vendorDir . '/getbrevo/brevo-php/lib/Model/VariablesItems.php',
|
||||
'Brevo\\Client\\Model\\WhatsappCampStats' => $vendorDir . '/getbrevo/brevo-php/lib/Model/WhatsappCampStats.php',
|
||||
'Brevo\\Client\\Model\\WhatsappCampTemplate' => $vendorDir . '/getbrevo/brevo-php/lib/Model/WhatsappCampTemplate.php',
|
||||
'Brevo\\Client\\ObjectSerializer' => $vendorDir . '/getbrevo/brevo-php/lib/ObjectSerializer.php',
|
||||
'Composer\\InstalledVersions' => $vendorDir . '/composer/InstalledVersions.php',
|
||||
'Composer\\Semver\\Comparator' => $vendorDir . '/composer/semver/src/Comparator.php',
|
||||
'Composer\\Semver\\CompilingMatcher' => $vendorDir . '/composer/semver/src/CompilingMatcher.php',
|
||||
|
|
@ -21,6 +407,92 @@ return array(
|
|||
'Composer\\Semver\\Intervals' => $vendorDir . '/composer/semver/src/Intervals.php',
|
||||
'Composer\\Semver\\Semver' => $vendorDir . '/composer/semver/src/Semver.php',
|
||||
'Composer\\Semver\\VersionParser' => $vendorDir . '/composer/semver/src/VersionParser.php',
|
||||
'GuzzleHttp\\BodySummarizer' => $vendorDir . '/guzzlehttp/guzzle/src/BodySummarizer.php',
|
||||
'GuzzleHttp\\BodySummarizerInterface' => $vendorDir . '/guzzlehttp/guzzle/src/BodySummarizerInterface.php',
|
||||
'GuzzleHttp\\Client' => $vendorDir . '/guzzlehttp/guzzle/src/Client.php',
|
||||
'GuzzleHttp\\ClientInterface' => $vendorDir . '/guzzlehttp/guzzle/src/ClientInterface.php',
|
||||
'GuzzleHttp\\ClientTrait' => $vendorDir . '/guzzlehttp/guzzle/src/ClientTrait.php',
|
||||
'GuzzleHttp\\Cookie\\CookieJar' => $vendorDir . '/guzzlehttp/guzzle/src/Cookie/CookieJar.php',
|
||||
'GuzzleHttp\\Cookie\\CookieJarInterface' => $vendorDir . '/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php',
|
||||
'GuzzleHttp\\Cookie\\FileCookieJar' => $vendorDir . '/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php',
|
||||
'GuzzleHttp\\Cookie\\SessionCookieJar' => $vendorDir . '/guzzlehttp/guzzle/src/Cookie/SessionCookieJar.php',
|
||||
'GuzzleHttp\\Cookie\\SetCookie' => $vendorDir . '/guzzlehttp/guzzle/src/Cookie/SetCookie.php',
|
||||
'GuzzleHttp\\Exception\\BadResponseException' => $vendorDir . '/guzzlehttp/guzzle/src/Exception/BadResponseException.php',
|
||||
'GuzzleHttp\\Exception\\ClientException' => $vendorDir . '/guzzlehttp/guzzle/src/Exception/ClientException.php',
|
||||
'GuzzleHttp\\Exception\\ConnectException' => $vendorDir . '/guzzlehttp/guzzle/src/Exception/ConnectException.php',
|
||||
'GuzzleHttp\\Exception\\GuzzleException' => $vendorDir . '/guzzlehttp/guzzle/src/Exception/GuzzleException.php',
|
||||
'GuzzleHttp\\Exception\\InvalidArgumentException' => $vendorDir . '/guzzlehttp/guzzle/src/Exception/InvalidArgumentException.php',
|
||||
'GuzzleHttp\\Exception\\RequestException' => $vendorDir . '/guzzlehttp/guzzle/src/Exception/RequestException.php',
|
||||
'GuzzleHttp\\Exception\\ServerException' => $vendorDir . '/guzzlehttp/guzzle/src/Exception/ServerException.php',
|
||||
'GuzzleHttp\\Exception\\TooManyRedirectsException' => $vendorDir . '/guzzlehttp/guzzle/src/Exception/TooManyRedirectsException.php',
|
||||
'GuzzleHttp\\Exception\\TransferException' => $vendorDir . '/guzzlehttp/guzzle/src/Exception/TransferException.php',
|
||||
'GuzzleHttp\\HandlerStack' => $vendorDir . '/guzzlehttp/guzzle/src/HandlerStack.php',
|
||||
'GuzzleHttp\\Handler\\CurlFactory' => $vendorDir . '/guzzlehttp/guzzle/src/Handler/CurlFactory.php',
|
||||
'GuzzleHttp\\Handler\\CurlFactoryInterface' => $vendorDir . '/guzzlehttp/guzzle/src/Handler/CurlFactoryInterface.php',
|
||||
'GuzzleHttp\\Handler\\CurlHandler' => $vendorDir . '/guzzlehttp/guzzle/src/Handler/CurlHandler.php',
|
||||
'GuzzleHttp\\Handler\\CurlMultiHandler' => $vendorDir . '/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php',
|
||||
'GuzzleHttp\\Handler\\EasyHandle' => $vendorDir . '/guzzlehttp/guzzle/src/Handler/EasyHandle.php',
|
||||
'GuzzleHttp\\Handler\\HeaderProcessor' => $vendorDir . '/guzzlehttp/guzzle/src/Handler/HeaderProcessor.php',
|
||||
'GuzzleHttp\\Handler\\MockHandler' => $vendorDir . '/guzzlehttp/guzzle/src/Handler/MockHandler.php',
|
||||
'GuzzleHttp\\Handler\\Proxy' => $vendorDir . '/guzzlehttp/guzzle/src/Handler/Proxy.php',
|
||||
'GuzzleHttp\\Handler\\StreamHandler' => $vendorDir . '/guzzlehttp/guzzle/src/Handler/StreamHandler.php',
|
||||
'GuzzleHttp\\MessageFormatter' => $vendorDir . '/guzzlehttp/guzzle/src/MessageFormatter.php',
|
||||
'GuzzleHttp\\MessageFormatterInterface' => $vendorDir . '/guzzlehttp/guzzle/src/MessageFormatterInterface.php',
|
||||
'GuzzleHttp\\Middleware' => $vendorDir . '/guzzlehttp/guzzle/src/Middleware.php',
|
||||
'GuzzleHttp\\Pool' => $vendorDir . '/guzzlehttp/guzzle/src/Pool.php',
|
||||
'GuzzleHttp\\PrepareBodyMiddleware' => $vendorDir . '/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php',
|
||||
'GuzzleHttp\\Promise\\AggregateException' => $vendorDir . '/guzzlehttp/promises/src/AggregateException.php',
|
||||
'GuzzleHttp\\Promise\\CancellationException' => $vendorDir . '/guzzlehttp/promises/src/CancellationException.php',
|
||||
'GuzzleHttp\\Promise\\Coroutine' => $vendorDir . '/guzzlehttp/promises/src/Coroutine.php',
|
||||
'GuzzleHttp\\Promise\\Create' => $vendorDir . '/guzzlehttp/promises/src/Create.php',
|
||||
'GuzzleHttp\\Promise\\Each' => $vendorDir . '/guzzlehttp/promises/src/Each.php',
|
||||
'GuzzleHttp\\Promise\\EachPromise' => $vendorDir . '/guzzlehttp/promises/src/EachPromise.php',
|
||||
'GuzzleHttp\\Promise\\FulfilledPromise' => $vendorDir . '/guzzlehttp/promises/src/FulfilledPromise.php',
|
||||
'GuzzleHttp\\Promise\\Is' => $vendorDir . '/guzzlehttp/promises/src/Is.php',
|
||||
'GuzzleHttp\\Promise\\Promise' => $vendorDir . '/guzzlehttp/promises/src/Promise.php',
|
||||
'GuzzleHttp\\Promise\\PromiseInterface' => $vendorDir . '/guzzlehttp/promises/src/PromiseInterface.php',
|
||||
'GuzzleHttp\\Promise\\PromisorInterface' => $vendorDir . '/guzzlehttp/promises/src/PromisorInterface.php',
|
||||
'GuzzleHttp\\Promise\\RejectedPromise' => $vendorDir . '/guzzlehttp/promises/src/RejectedPromise.php',
|
||||
'GuzzleHttp\\Promise\\RejectionException' => $vendorDir . '/guzzlehttp/promises/src/RejectionException.php',
|
||||
'GuzzleHttp\\Promise\\TaskQueue' => $vendorDir . '/guzzlehttp/promises/src/TaskQueue.php',
|
||||
'GuzzleHttp\\Promise\\TaskQueueInterface' => $vendorDir . '/guzzlehttp/promises/src/TaskQueueInterface.php',
|
||||
'GuzzleHttp\\Promise\\Utils' => $vendorDir . '/guzzlehttp/promises/src/Utils.php',
|
||||
'GuzzleHttp\\Psr7\\AppendStream' => $vendorDir . '/guzzlehttp/psr7/src/AppendStream.php',
|
||||
'GuzzleHttp\\Psr7\\BufferStream' => $vendorDir . '/guzzlehttp/psr7/src/BufferStream.php',
|
||||
'GuzzleHttp\\Psr7\\CachingStream' => $vendorDir . '/guzzlehttp/psr7/src/CachingStream.php',
|
||||
'GuzzleHttp\\Psr7\\DroppingStream' => $vendorDir . '/guzzlehttp/psr7/src/DroppingStream.php',
|
||||
'GuzzleHttp\\Psr7\\Exception\\MalformedUriException' => $vendorDir . '/guzzlehttp/psr7/src/Exception/MalformedUriException.php',
|
||||
'GuzzleHttp\\Psr7\\FnStream' => $vendorDir . '/guzzlehttp/psr7/src/FnStream.php',
|
||||
'GuzzleHttp\\Psr7\\Header' => $vendorDir . '/guzzlehttp/psr7/src/Header.php',
|
||||
'GuzzleHttp\\Psr7\\HttpFactory' => $vendorDir . '/guzzlehttp/psr7/src/HttpFactory.php',
|
||||
'GuzzleHttp\\Psr7\\InflateStream' => $vendorDir . '/guzzlehttp/psr7/src/InflateStream.php',
|
||||
'GuzzleHttp\\Psr7\\LazyOpenStream' => $vendorDir . '/guzzlehttp/psr7/src/LazyOpenStream.php',
|
||||
'GuzzleHttp\\Psr7\\LimitStream' => $vendorDir . '/guzzlehttp/psr7/src/LimitStream.php',
|
||||
'GuzzleHttp\\Psr7\\Message' => $vendorDir . '/guzzlehttp/psr7/src/Message.php',
|
||||
'GuzzleHttp\\Psr7\\MessageTrait' => $vendorDir . '/guzzlehttp/psr7/src/MessageTrait.php',
|
||||
'GuzzleHttp\\Psr7\\MimeType' => $vendorDir . '/guzzlehttp/psr7/src/MimeType.php',
|
||||
'GuzzleHttp\\Psr7\\MultipartStream' => $vendorDir . '/guzzlehttp/psr7/src/MultipartStream.php',
|
||||
'GuzzleHttp\\Psr7\\NoSeekStream' => $vendorDir . '/guzzlehttp/psr7/src/NoSeekStream.php',
|
||||
'GuzzleHttp\\Psr7\\PumpStream' => $vendorDir . '/guzzlehttp/psr7/src/PumpStream.php',
|
||||
'GuzzleHttp\\Psr7\\Query' => $vendorDir . '/guzzlehttp/psr7/src/Query.php',
|
||||
'GuzzleHttp\\Psr7\\Request' => $vendorDir . '/guzzlehttp/psr7/src/Request.php',
|
||||
'GuzzleHttp\\Psr7\\Response' => $vendorDir . '/guzzlehttp/psr7/src/Response.php',
|
||||
'GuzzleHttp\\Psr7\\Rfc7230' => $vendorDir . '/guzzlehttp/psr7/src/Rfc7230.php',
|
||||
'GuzzleHttp\\Psr7\\ServerRequest' => $vendorDir . '/guzzlehttp/psr7/src/ServerRequest.php',
|
||||
'GuzzleHttp\\Psr7\\Stream' => $vendorDir . '/guzzlehttp/psr7/src/Stream.php',
|
||||
'GuzzleHttp\\Psr7\\StreamDecoratorTrait' => $vendorDir . '/guzzlehttp/psr7/src/StreamDecoratorTrait.php',
|
||||
'GuzzleHttp\\Psr7\\StreamWrapper' => $vendorDir . '/guzzlehttp/psr7/src/StreamWrapper.php',
|
||||
'GuzzleHttp\\Psr7\\UploadedFile' => $vendorDir . '/guzzlehttp/psr7/src/UploadedFile.php',
|
||||
'GuzzleHttp\\Psr7\\Uri' => $vendorDir . '/guzzlehttp/psr7/src/Uri.php',
|
||||
'GuzzleHttp\\Psr7\\UriComparator' => $vendorDir . '/guzzlehttp/psr7/src/UriComparator.php',
|
||||
'GuzzleHttp\\Psr7\\UriNormalizer' => $vendorDir . '/guzzlehttp/psr7/src/UriNormalizer.php',
|
||||
'GuzzleHttp\\Psr7\\UriResolver' => $vendorDir . '/guzzlehttp/psr7/src/UriResolver.php',
|
||||
'GuzzleHttp\\Psr7\\Utils' => $vendorDir . '/guzzlehttp/psr7/src/Utils.php',
|
||||
'GuzzleHttp\\RedirectMiddleware' => $vendorDir . '/guzzlehttp/guzzle/src/RedirectMiddleware.php',
|
||||
'GuzzleHttp\\RequestOptions' => $vendorDir . '/guzzlehttp/guzzle/src/RequestOptions.php',
|
||||
'GuzzleHttp\\RetryMiddleware' => $vendorDir . '/guzzlehttp/guzzle/src/RetryMiddleware.php',
|
||||
'GuzzleHttp\\TransferStats' => $vendorDir . '/guzzlehttp/guzzle/src/TransferStats.php',
|
||||
'GuzzleHttp\\Utils' => $vendorDir . '/guzzlehttp/guzzle/src/Utils.php',
|
||||
'Kirby\\Api\\Api' => $baseDir . '/kirby/src/Api/Api.php',
|
||||
'Kirby\\Api\\Collection' => $baseDir . '/kirby/src/Api/Collection.php',
|
||||
'Kirby\\Api\\Model' => $baseDir . '/kirby/src/Api/Model.php',
|
||||
|
|
@ -361,6 +833,23 @@ return array(
|
|||
'PHPMailer\\PHPMailer\\SMTP' => $vendorDir . '/phpmailer/phpmailer/src/SMTP.php',
|
||||
'Parsedown' => $baseDir . '/kirby/dependencies/parsedown/Parsedown.php',
|
||||
'ParsedownExtra' => $baseDir . '/kirby/dependencies/parsedown-extra/ParsedownExtra.php',
|
||||
'Psr\\Http\\Client\\ClientExceptionInterface' => $vendorDir . '/psr/http-client/src/ClientExceptionInterface.php',
|
||||
'Psr\\Http\\Client\\ClientInterface' => $vendorDir . '/psr/http-client/src/ClientInterface.php',
|
||||
'Psr\\Http\\Client\\NetworkExceptionInterface' => $vendorDir . '/psr/http-client/src/NetworkExceptionInterface.php',
|
||||
'Psr\\Http\\Client\\RequestExceptionInterface' => $vendorDir . '/psr/http-client/src/RequestExceptionInterface.php',
|
||||
'Psr\\Http\\Message\\MessageInterface' => $vendorDir . '/psr/http-message/src/MessageInterface.php',
|
||||
'Psr\\Http\\Message\\RequestFactoryInterface' => $vendorDir . '/psr/http-factory/src/RequestFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\RequestInterface' => $vendorDir . '/psr/http-message/src/RequestInterface.php',
|
||||
'Psr\\Http\\Message\\ResponseFactoryInterface' => $vendorDir . '/psr/http-factory/src/ResponseFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\ResponseInterface' => $vendorDir . '/psr/http-message/src/ResponseInterface.php',
|
||||
'Psr\\Http\\Message\\ServerRequestFactoryInterface' => $vendorDir . '/psr/http-factory/src/ServerRequestFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\ServerRequestInterface' => $vendorDir . '/psr/http-message/src/ServerRequestInterface.php',
|
||||
'Psr\\Http\\Message\\StreamFactoryInterface' => $vendorDir . '/psr/http-factory/src/StreamFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\StreamInterface' => $vendorDir . '/psr/http-message/src/StreamInterface.php',
|
||||
'Psr\\Http\\Message\\UploadedFileFactoryInterface' => $vendorDir . '/psr/http-factory/src/UploadedFileFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\UploadedFileInterface' => $vendorDir . '/psr/http-message/src/UploadedFileInterface.php',
|
||||
'Psr\\Http\\Message\\UriFactoryInterface' => $vendorDir . '/psr/http-factory/src/UriFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\UriInterface' => $vendorDir . '/psr/http-message/src/UriInterface.php',
|
||||
'Psr\\Log\\AbstractLogger' => $vendorDir . '/psr/log/src/AbstractLogger.php',
|
||||
'Psr\\Log\\InvalidArgumentException' => $vendorDir . '/psr/log/src/InvalidArgumentException.php',
|
||||
'Psr\\Log\\LogLevel' => $vendorDir . '/psr/log/src/LogLevel.php',
|
||||
|
|
|
|||
2
vendor/composer/autoload_files.php
vendored
2
vendor/composer/autoload_files.php
vendored
|
|
@ -7,8 +7,10 @@ $baseDir = dirname($vendorDir);
|
|||
|
||||
return array(
|
||||
'6e3fae29631ef280660b3cdad06f25a8' => $vendorDir . '/symfony/deprecation-contracts/function.php',
|
||||
'7b11c4dc42b3b3023073cb14e519683c' => $vendorDir . '/ralouphie/getallheaders/src/getallheaders.php',
|
||||
'320cde22f66dd4f5d3fd621d3e88b98f' => $vendorDir . '/symfony/polyfill-ctype/bootstrap.php',
|
||||
'e69f7f6ee287b969198c3c9d6777bd38' => $vendorDir . '/symfony/polyfill-intl-normalizer/bootstrap.php',
|
||||
'37a3dc5111fe8f707ab4c132ef1dbc62' => $vendorDir . '/guzzlehttp/guzzle/src/functions_include.php',
|
||||
'f598d06aa772fa33d905e87be6398fb1' => $vendorDir . '/symfony/polyfill-intl-idn/bootstrap.php',
|
||||
'0e6d7bf4a5811bfa5cf40c5ccd6fae6a' => $vendorDir . '/symfony/polyfill-mbstring/bootstrap.php',
|
||||
'f864ae44e8154e5ff6f4eec32f46d37f' => $baseDir . '/kirby/config/setup.php',
|
||||
|
|
|
|||
6
vendor/composer/autoload_psr4.php
vendored
6
vendor/composer/autoload_psr4.php
vendored
|
|
@ -13,10 +13,16 @@ return array(
|
|||
'Symfony\\Polyfill\\Ctype\\' => array($vendorDir . '/symfony/polyfill-ctype'),
|
||||
'Symfony\\Component\\Yaml\\' => array($vendorDir . '/symfony/yaml'),
|
||||
'Psr\\Log\\' => array($vendorDir . '/psr/log/src'),
|
||||
'Psr\\Http\\Message\\' => array($vendorDir . '/psr/http-factory/src', $vendorDir . '/psr/http-message/src'),
|
||||
'Psr\\Http\\Client\\' => array($vendorDir . '/psr/http-client/src'),
|
||||
'PHPMailer\\PHPMailer\\' => array($vendorDir . '/phpmailer/phpmailer/src'),
|
||||
'League\\ColorExtractor\\' => array($vendorDir . '/league/color-extractor/src'),
|
||||
'Laminas\\Escaper\\' => array($vendorDir . '/laminas/laminas-escaper/src'),
|
||||
'Kirby\\' => array($baseDir . '/kirby/src', $vendorDir . '/getkirby/composer-installer/src'),
|
||||
'GuzzleHttp\\Psr7\\' => array($vendorDir . '/guzzlehttp/psr7/src'),
|
||||
'GuzzleHttp\\Promise\\' => array($vendorDir . '/guzzlehttp/promises/src'),
|
||||
'GuzzleHttp\\' => array($vendorDir . '/guzzlehttp/guzzle/src'),
|
||||
'Composer\\Semver\\' => array($vendorDir . '/composer/semver/src'),
|
||||
'Brevo\\Client\\' => array($vendorDir . '/getbrevo/brevo-php/lib'),
|
||||
'Base32\\' => array($vendorDir . '/christian-riesen/base32/src'),
|
||||
);
|
||||
|
|
|
|||
525
vendor/composer/autoload_static.php
vendored
525
vendor/composer/autoload_static.php
vendored
|
|
@ -8,8 +8,10 @@ class ComposerStaticInit749a661738bcd5b9428c88a1da847bc7
|
|||
{
|
||||
public static $files = array (
|
||||
'6e3fae29631ef280660b3cdad06f25a8' => __DIR__ . '/..' . '/symfony/deprecation-contracts/function.php',
|
||||
'7b11c4dc42b3b3023073cb14e519683c' => __DIR__ . '/..' . '/ralouphie/getallheaders/src/getallheaders.php',
|
||||
'320cde22f66dd4f5d3fd621d3e88b98f' => __DIR__ . '/..' . '/symfony/polyfill-ctype/bootstrap.php',
|
||||
'e69f7f6ee287b969198c3c9d6777bd38' => __DIR__ . '/..' . '/symfony/polyfill-intl-normalizer/bootstrap.php',
|
||||
'37a3dc5111fe8f707ab4c132ef1dbc62' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/functions_include.php',
|
||||
'f598d06aa772fa33d905e87be6398fb1' => __DIR__ . '/..' . '/symfony/polyfill-intl-idn/bootstrap.php',
|
||||
'0e6d7bf4a5811bfa5cf40c5ccd6fae6a' => __DIR__ . '/..' . '/symfony/polyfill-mbstring/bootstrap.php',
|
||||
'f864ae44e8154e5ff6f4eec32f46d37f' => __DIR__ . '/../..' . '/kirby/config/setup.php',
|
||||
|
|
@ -32,6 +34,8 @@ class ComposerStaticInit749a661738bcd5b9428c88a1da847bc7
|
|||
'P' =>
|
||||
array (
|
||||
'Psr\\Log\\' => 8,
|
||||
'Psr\\Http\\Message\\' => 17,
|
||||
'Psr\\Http\\Client\\' => 16,
|
||||
'PHPMailer\\PHPMailer\\' => 20,
|
||||
),
|
||||
'L' =>
|
||||
|
|
@ -43,12 +47,19 @@ class ComposerStaticInit749a661738bcd5b9428c88a1da847bc7
|
|||
array (
|
||||
'Kirby\\' => 6,
|
||||
),
|
||||
'G' =>
|
||||
array (
|
||||
'GuzzleHttp\\Psr7\\' => 16,
|
||||
'GuzzleHttp\\Promise\\' => 19,
|
||||
'GuzzleHttp\\' => 11,
|
||||
),
|
||||
'C' =>
|
||||
array (
|
||||
'Composer\\Semver\\' => 16,
|
||||
),
|
||||
'B' =>
|
||||
array (
|
||||
'Brevo\\Client\\' => 13,
|
||||
'Base32\\' => 7,
|
||||
),
|
||||
);
|
||||
|
|
@ -82,6 +93,15 @@ class ComposerStaticInit749a661738bcd5b9428c88a1da847bc7
|
|||
array (
|
||||
0 => __DIR__ . '/..' . '/psr/log/src',
|
||||
),
|
||||
'Psr\\Http\\Message\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/..' . '/psr/http-factory/src',
|
||||
1 => __DIR__ . '/..' . '/psr/http-message/src',
|
||||
),
|
||||
'Psr\\Http\\Client\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/..' . '/psr/http-client/src',
|
||||
),
|
||||
'PHPMailer\\PHPMailer\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/..' . '/phpmailer/phpmailer/src',
|
||||
|
|
@ -99,10 +119,26 @@ class ComposerStaticInit749a661738bcd5b9428c88a1da847bc7
|
|||
0 => __DIR__ . '/../..' . '/kirby/src',
|
||||
1 => __DIR__ . '/..' . '/getkirby/composer-installer/src',
|
||||
),
|
||||
'GuzzleHttp\\Psr7\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/..' . '/guzzlehttp/psr7/src',
|
||||
),
|
||||
'GuzzleHttp\\Promise\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/..' . '/guzzlehttp/promises/src',
|
||||
),
|
||||
'GuzzleHttp\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/..' . '/guzzlehttp/guzzle/src',
|
||||
),
|
||||
'Composer\\Semver\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/..' . '/composer/semver/src',
|
||||
),
|
||||
'Brevo\\Client\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/..' . '/getbrevo/brevo-php/lib',
|
||||
),
|
||||
'Base32\\' =>
|
||||
array (
|
||||
0 => __DIR__ . '/..' . '/christian-riesen/base32/src',
|
||||
|
|
@ -129,6 +165,392 @@ class ComposerStaticInit749a661738bcd5b9428c88a1da847bc7
|
|||
public static $classMap = array (
|
||||
'Base32\\Base32' => __DIR__ . '/..' . '/christian-riesen/base32/src/Base32.php',
|
||||
'Base32\\Base32Hex' => __DIR__ . '/..' . '/christian-riesen/base32/src/Base32Hex.php',
|
||||
'Brevo\\Client\\ApiException' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/ApiException.php',
|
||||
'Brevo\\Client\\Api\\AccountApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/AccountApi.php',
|
||||
'Brevo\\Client\\Api\\AttributesApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/AttributesApi.php',
|
||||
'Brevo\\Client\\Api\\CRMApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/CRMApi.php',
|
||||
'Brevo\\Client\\Api\\CompaniesApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/CompaniesApi.php',
|
||||
'Brevo\\Client\\Api\\ContactsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/ContactsApi.php',
|
||||
'Brevo\\Client\\Api\\ConversationsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/ConversationsApi.php',
|
||||
'Brevo\\Client\\Api\\CouponsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/CouponsApi.php',
|
||||
'Brevo\\Client\\Api\\DealsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/DealsApi.php',
|
||||
'Brevo\\Client\\Api\\DomainsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/DomainsApi.php',
|
||||
'Brevo\\Client\\Api\\EcommerceApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/EcommerceApi.php',
|
||||
'Brevo\\Client\\Api\\EmailCampaignsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/EmailCampaignsApi.php',
|
||||
'Brevo\\Client\\Api\\EventsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/EventsApi.php',
|
||||
'Brevo\\Client\\Api\\ExternalFeedsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/ExternalFeedsApi.php',
|
||||
'Brevo\\Client\\Api\\FilesApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/FilesApi.php',
|
||||
'Brevo\\Client\\Api\\FoldersApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/FoldersApi.php',
|
||||
'Brevo\\Client\\Api\\InboundParsingApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/InboundParsingApi.php',
|
||||
'Brevo\\Client\\Api\\ListsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/ListsApi.php',
|
||||
'Brevo\\Client\\Api\\MasterAccountApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/MasterAccountApi.php',
|
||||
'Brevo\\Client\\Api\\NotesApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/NotesApi.php',
|
||||
'Brevo\\Client\\Api\\ProcessApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/ProcessApi.php',
|
||||
'Brevo\\Client\\Api\\ResellerApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/ResellerApi.php',
|
||||
'Brevo\\Client\\Api\\SMSCampaignsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/SMSCampaignsApi.php',
|
||||
'Brevo\\Client\\Api\\SendersApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/SendersApi.php',
|
||||
'Brevo\\Client\\Api\\TasksApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/TasksApi.php',
|
||||
'Brevo\\Client\\Api\\TransactionalEmailsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/TransactionalEmailsApi.php',
|
||||
'Brevo\\Client\\Api\\TransactionalSMSApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/TransactionalSMSApi.php',
|
||||
'Brevo\\Client\\Api\\TransactionalWhatsAppApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/TransactionalWhatsAppApi.php',
|
||||
'Brevo\\Client\\Api\\UserApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/UserApi.php',
|
||||
'Brevo\\Client\\Api\\WebhooksApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/WebhooksApi.php',
|
||||
'Brevo\\Client\\Api\\WhatsAppCampaignsApi' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Api/WhatsAppCampaignsApi.php',
|
||||
'Brevo\\Client\\Configuration' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Configuration.php',
|
||||
'Brevo\\Client\\HeaderSelector' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/HeaderSelector.php',
|
||||
'Brevo\\Client\\Model\\AbTestCampaignResult' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/AbTestCampaignResult.php',
|
||||
'Brevo\\Client\\Model\\AbTestCampaignResultClickedLinks' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/AbTestCampaignResultClickedLinks.php',
|
||||
'Brevo\\Client\\Model\\AbTestCampaignResultStatistics' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/AbTestCampaignResultStatistics.php',
|
||||
'Brevo\\Client\\Model\\AbTestVersionClicks' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/AbTestVersionClicks.php',
|
||||
'Brevo\\Client\\Model\\AbTestVersionClicksInner' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/AbTestVersionClicksInner.php',
|
||||
'Brevo\\Client\\Model\\AbTestVersionStats' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/AbTestVersionStats.php',
|
||||
'Brevo\\Client\\Model\\AddChildDomain' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/AddChildDomain.php',
|
||||
'Brevo\\Client\\Model\\AddContactToList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/AddContactToList.php',
|
||||
'Brevo\\Client\\Model\\AddCredits' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/AddCredits.php',
|
||||
'Brevo\\Client\\Model\\AuthenticateDomainModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/AuthenticateDomainModel.php',
|
||||
'Brevo\\Client\\Model\\BlockDomain' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/BlockDomain.php',
|
||||
'Brevo\\Client\\Model\\Body' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body.php',
|
||||
'Brevo\\Client\\Model\\Body1' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body1.php',
|
||||
'Brevo\\Client\\Model\\Body10' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body10.php',
|
||||
'Brevo\\Client\\Model\\Body11' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body11.php',
|
||||
'Brevo\\Client\\Model\\Body12' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body12.php',
|
||||
'Brevo\\Client\\Model\\Body13' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body13.php',
|
||||
'Brevo\\Client\\Model\\Body14' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body14.php',
|
||||
'Brevo\\Client\\Model\\Body2' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body2.php',
|
||||
'Brevo\\Client\\Model\\Body3' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body3.php',
|
||||
'Brevo\\Client\\Model\\Body4' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body4.php',
|
||||
'Brevo\\Client\\Model\\Body5' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body5.php',
|
||||
'Brevo\\Client\\Model\\Body6' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body6.php',
|
||||
'Brevo\\Client\\Model\\Body7' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body7.php',
|
||||
'Brevo\\Client\\Model\\Body8' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body8.php',
|
||||
'Brevo\\Client\\Model\\Body9' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Body9.php',
|
||||
'Brevo\\Client\\Model\\BodyVariablesItems' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/BodyVariablesItems.php',
|
||||
'Brevo\\Client\\Model\\CompaniesList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CompaniesList.php',
|
||||
'Brevo\\Client\\Model\\Company' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Company.php',
|
||||
'Brevo\\Client\\Model\\CompanyAttributes' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CompanyAttributes.php',
|
||||
'Brevo\\Client\\Model\\CompanyAttributesInner' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CompanyAttributesInner.php',
|
||||
'Brevo\\Client\\Model\\ComponentItems' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/ComponentItems.php',
|
||||
'Brevo\\Client\\Model\\Contact' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Contact.php',
|
||||
'Brevo\\Client\\Model\\ConversationsMessage' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/ConversationsMessage.php',
|
||||
'Brevo\\Client\\Model\\ConversationsMessageFile' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/ConversationsMessageFile.php',
|
||||
'Brevo\\Client\\Model\\ConversationsMessageFileImageInfo' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/ConversationsMessageFileImageInfo.php',
|
||||
'Brevo\\Client\\Model\\CreateApiKeyRequest' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateApiKeyRequest.php',
|
||||
'Brevo\\Client\\Model\\CreateApiKeyResponse' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateApiKeyResponse.php',
|
||||
'Brevo\\Client\\Model\\CreateAttribute' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateAttribute.php',
|
||||
'Brevo\\Client\\Model\\CreateAttributeEnumeration' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateAttributeEnumeration.php',
|
||||
'Brevo\\Client\\Model\\CreateCategoryModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateCategoryModel.php',
|
||||
'Brevo\\Client\\Model\\CreateChild' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateChild.php',
|
||||
'Brevo\\Client\\Model\\CreateContact' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateContact.php',
|
||||
'Brevo\\Client\\Model\\CreateCouponCollection' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateCouponCollection.php',
|
||||
'Brevo\\Client\\Model\\CreateCoupons' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateCoupons.php',
|
||||
'Brevo\\Client\\Model\\CreateDoiContact' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateDoiContact.php',
|
||||
'Brevo\\Client\\Model\\CreateDomain' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateDomain.php',
|
||||
'Brevo\\Client\\Model\\CreateDomainModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateDomainModel.php',
|
||||
'Brevo\\Client\\Model\\CreateDomainModelDnsRecords' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateDomainModelDnsRecords.php',
|
||||
'Brevo\\Client\\Model\\CreateDomainModelDnsRecordsDkimRecord' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateDomainModelDnsRecordsDkimRecord.php',
|
||||
'Brevo\\Client\\Model\\CreateEmailCampaign' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateEmailCampaign.php',
|
||||
'Brevo\\Client\\Model\\CreateEmailCampaignRecipients' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateEmailCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\CreateEmailCampaignSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateEmailCampaignSender.php',
|
||||
'Brevo\\Client\\Model\\CreateExternalFeed' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateExternalFeed.php',
|
||||
'Brevo\\Client\\Model\\CreateList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateList.php',
|
||||
'Brevo\\Client\\Model\\CreateModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateModel.php',
|
||||
'Brevo\\Client\\Model\\CreateProductModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateProductModel.php',
|
||||
'Brevo\\Client\\Model\\CreateReseller' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateReseller.php',
|
||||
'Brevo\\Client\\Model\\CreateSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateSender.php',
|
||||
'Brevo\\Client\\Model\\CreateSenderIps' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateSenderIps.php',
|
||||
'Brevo\\Client\\Model\\CreateSenderModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateSenderModel.php',
|
||||
'Brevo\\Client\\Model\\CreateSmsCampaign' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateSmsCampaign.php',
|
||||
'Brevo\\Client\\Model\\CreateSmsCampaignRecipients' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateSmsCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\CreateSmtpEmail' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateSmtpEmail.php',
|
||||
'Brevo\\Client\\Model\\CreateSmtpTemplate' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateSmtpTemplate.php',
|
||||
'Brevo\\Client\\Model\\CreateSmtpTemplateSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateSmtpTemplateSender.php',
|
||||
'Brevo\\Client\\Model\\CreateSubAccount' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateSubAccount.php',
|
||||
'Brevo\\Client\\Model\\CreateSubAccountResponse' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateSubAccountResponse.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateBatchCategory' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateUpdateBatchCategory.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateBatchCategoryModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateUpdateBatchCategoryModel.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateBatchProducts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateUpdateBatchProducts.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateBatchProductsModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateUpdateBatchProductsModel.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateCategories' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateUpdateCategories.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateCategory' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateUpdateCategory.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateContactModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateUpdateContactModel.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateFolder' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateUpdateFolder.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateProduct' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateUpdateProduct.php',
|
||||
'Brevo\\Client\\Model\\CreateUpdateProducts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateUpdateProducts.php',
|
||||
'Brevo\\Client\\Model\\CreateWebhook' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateWebhook.php',
|
||||
'Brevo\\Client\\Model\\CreateWhatsAppCampaign' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateWhatsAppCampaign.php',
|
||||
'Brevo\\Client\\Model\\CreateWhatsAppCampaignRecipients' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateWhatsAppCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\CreateWhatsAppTemplate' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreateWhatsAppTemplate.php',
|
||||
'Brevo\\Client\\Model\\CreatedBatchId' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreatedBatchId.php',
|
||||
'Brevo\\Client\\Model\\CreatedProcessId' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/CreatedProcessId.php',
|
||||
'Brevo\\Client\\Model\\Deal' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Deal.php',
|
||||
'Brevo\\Client\\Model\\DealAttributes' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/DealAttributes.php',
|
||||
'Brevo\\Client\\Model\\DealAttributesInner' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/DealAttributesInner.php',
|
||||
'Brevo\\Client\\Model\\DealsList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/DealsList.php',
|
||||
'Brevo\\Client\\Model\\DeleteHardbounces' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/DeleteHardbounces.php',
|
||||
'Brevo\\Client\\Model\\EmailExportRecipients' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/EmailExportRecipients.php',
|
||||
'Brevo\\Client\\Model\\ErrorModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/ErrorModel.php',
|
||||
'Brevo\\Client\\Model\\Event' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Event.php',
|
||||
'Brevo\\Client\\Model\\EventIdentifiers' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/EventIdentifiers.php',
|
||||
'Brevo\\Client\\Model\\ExportWebhooksHistory' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/ExportWebhooksHistory.php',
|
||||
'Brevo\\Client\\Model\\FileData' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/FileData.php',
|
||||
'Brevo\\Client\\Model\\FileDownloadableLink' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/FileDownloadableLink.php',
|
||||
'Brevo\\Client\\Model\\FileList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/FileList.php',
|
||||
'Brevo\\Client\\Model\\GetAccount' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAccount.php',
|
||||
'Brevo\\Client\\Model\\GetAccountActivity' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAccountActivity.php',
|
||||
'Brevo\\Client\\Model\\GetAccountActivityLogs' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAccountActivityLogs.php',
|
||||
'Brevo\\Client\\Model\\GetAccountMarketingAutomation' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAccountMarketingAutomation.php',
|
||||
'Brevo\\Client\\Model\\GetAccountPlan' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAccountPlan.php',
|
||||
'Brevo\\Client\\Model\\GetAccountRelay' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAccountRelay.php',
|
||||
'Brevo\\Client\\Model\\GetAccountRelayData' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAccountRelayData.php',
|
||||
'Brevo\\Client\\Model\\GetAggregatedReport' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAggregatedReport.php',
|
||||
'Brevo\\Client\\Model\\GetAllExternalFeeds' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAllExternalFeeds.php',
|
||||
'Brevo\\Client\\Model\\GetAllExternalFeedsFeeds' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAllExternalFeedsFeeds.php',
|
||||
'Brevo\\Client\\Model\\GetAttributes' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAttributes.php',
|
||||
'Brevo\\Client\\Model\\GetAttributesAttributes' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAttributesAttributes.php',
|
||||
'Brevo\\Client\\Model\\GetAttributesEnumeration' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetAttributesEnumeration.php',
|
||||
'Brevo\\Client\\Model\\GetBlockedDomains' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetBlockedDomains.php',
|
||||
'Brevo\\Client\\Model\\GetCampaignOverview' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetCampaignOverview.php',
|
||||
'Brevo\\Client\\Model\\GetCampaignRecipients' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\GetCampaignStats' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetCampaignStats.php',
|
||||
'Brevo\\Client\\Model\\GetCategories' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetCategories.php',
|
||||
'Brevo\\Client\\Model\\GetCategoryDetails' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetCategoryDetails.php',
|
||||
'Brevo\\Client\\Model\\GetChildAccountCreationStatus' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetChildAccountCreationStatus.php',
|
||||
'Brevo\\Client\\Model\\GetChildDomain' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetChildDomain.php',
|
||||
'Brevo\\Client\\Model\\GetChildDomains' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetChildDomains.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfo' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetChildInfo.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfoApiKeys' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetChildInfoApiKeys.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfoApiKeysV2' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetChildInfoApiKeysV2.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfoApiKeysV3' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetChildInfoApiKeysV3.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfoCredits' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetChildInfoCredits.php',
|
||||
'Brevo\\Client\\Model\\GetChildInfoStatistics' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetChildInfoStatistics.php',
|
||||
'Brevo\\Client\\Model\\GetChildrenList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetChildrenList.php',
|
||||
'Brevo\\Client\\Model\\GetClient' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetClient.php',
|
||||
'Brevo\\Client\\Model\\GetContactCampaignStats' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetContactCampaignStats.php',
|
||||
'Brevo\\Client\\Model\\GetContactCampaignStatsClicked' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetContactCampaignStatsClicked.php',
|
||||
'Brevo\\Client\\Model\\GetContactCampaignStatsOpened' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetContactCampaignStatsOpened.php',
|
||||
'Brevo\\Client\\Model\\GetContactCampaignStatsTransacAttributes' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetContactCampaignStatsTransacAttributes.php',
|
||||
'Brevo\\Client\\Model\\GetContactCampaignStatsUnsubscriptions' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetContactCampaignStatsUnsubscriptions.php',
|
||||
'Brevo\\Client\\Model\\GetContactDetails' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetContactDetails.php',
|
||||
'Brevo\\Client\\Model\\GetContacts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetContacts.php',
|
||||
'Brevo\\Client\\Model\\GetCorporateInvitedUsersList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetCorporateInvitedUsersList.php',
|
||||
'Brevo\\Client\\Model\\GetCorporateInvitedUsersListFeatureAccess' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetCorporateInvitedUsersListFeatureAccess.php',
|
||||
'Brevo\\Client\\Model\\GetCorporateInvitedUsersListGroups' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetCorporateInvitedUsersListGroups.php',
|
||||
'Brevo\\Client\\Model\\GetCorporateInvitedUsersListUsers' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetCorporateInvitedUsersListUsers.php',
|
||||
'Brevo\\Client\\Model\\GetCouponCollection' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetCouponCollection.php',
|
||||
'Brevo\\Client\\Model\\GetDeviceBrowserStats' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetDeviceBrowserStats.php',
|
||||
'Brevo\\Client\\Model\\GetDomainConfigurationModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetDomainConfigurationModel.php',
|
||||
'Brevo\\Client\\Model\\GetDomainsList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetDomainsList.php',
|
||||
'Brevo\\Client\\Model\\GetDomainsListDomains' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetDomainsListDomains.php',
|
||||
'Brevo\\Client\\Model\\GetEmailCampaign' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetEmailCampaign.php',
|
||||
'Brevo\\Client\\Model\\GetEmailCampaigns' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetEmailCampaigns.php',
|
||||
'Brevo\\Client\\Model\\GetEmailEventReport' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetEmailEventReport.php',
|
||||
'Brevo\\Client\\Model\\GetEmailEventReportEvents' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetEmailEventReportEvents.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedCampaignOverview' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedCampaignOverview.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedCampaignOverviewSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedCampaignOverviewSender.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedCampaignStats' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedCampaignStats.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedCampaignStatsGlobalStats' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedCampaignStatsGlobalStats.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedClient' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedClient.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedClientAddress' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedClientAddress.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetails' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetails.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatistics' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatistics.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsClicked' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsClicked.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsDelivered' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsDelivered.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsLinks' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsLinks.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsMessagesSent' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsMessagesSent.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsOpened' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsOpened.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsUnsubscriptions' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsUnsubscriptions.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedList.php',
|
||||
'Brevo\\Client\\Model\\GetExtendedListCampaignStats' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExtendedListCampaignStats.php',
|
||||
'Brevo\\Client\\Model\\GetExternalFeedByUUID' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExternalFeedByUUID.php',
|
||||
'Brevo\\Client\\Model\\GetExternalFeedByUUIDHeaders' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetExternalFeedByUUIDHeaders.php',
|
||||
'Brevo\\Client\\Model\\GetFolder' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetFolder.php',
|
||||
'Brevo\\Client\\Model\\GetFolderLists' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetFolderLists.php',
|
||||
'Brevo\\Client\\Model\\GetFolders' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetFolders.php',
|
||||
'Brevo\\Client\\Model\\GetInboundEmailEvents' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetInboundEmailEvents.php',
|
||||
'Brevo\\Client\\Model\\GetInboundEmailEventsByUuid' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetInboundEmailEventsByUuid.php',
|
||||
'Brevo\\Client\\Model\\GetInboundEmailEventsByUuidAttachments' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetInboundEmailEventsByUuidAttachments.php',
|
||||
'Brevo\\Client\\Model\\GetInboundEmailEventsByUuidLogs' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetInboundEmailEventsByUuidLogs.php',
|
||||
'Brevo\\Client\\Model\\GetInboundEmailEventsEvents' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetInboundEmailEventsEvents.php',
|
||||
'Brevo\\Client\\Model\\GetInvitedUsersList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetInvitedUsersList.php',
|
||||
'Brevo\\Client\\Model\\GetInvitedUsersListFeatureAccess' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetInvitedUsersListFeatureAccess.php',
|
||||
'Brevo\\Client\\Model\\GetInvitedUsersListUsers' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetInvitedUsersListUsers.php',
|
||||
'Brevo\\Client\\Model\\GetIp' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetIp.php',
|
||||
'Brevo\\Client\\Model\\GetIpFromSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetIpFromSender.php',
|
||||
'Brevo\\Client\\Model\\GetIps' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetIps.php',
|
||||
'Brevo\\Client\\Model\\GetIpsFromSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetIpsFromSender.php',
|
||||
'Brevo\\Client\\Model\\GetList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetList.php',
|
||||
'Brevo\\Client\\Model\\GetLists' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetLists.php',
|
||||
'Brevo\\Client\\Model\\GetOrders' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetOrders.php',
|
||||
'Brevo\\Client\\Model\\GetProcess' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetProcess.php',
|
||||
'Brevo\\Client\\Model\\GetProcesses' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetProcesses.php',
|
||||
'Brevo\\Client\\Model\\GetProductDetails' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetProductDetails.php',
|
||||
'Brevo\\Client\\Model\\GetProducts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetProducts.php',
|
||||
'Brevo\\Client\\Model\\GetReports' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetReports.php',
|
||||
'Brevo\\Client\\Model\\GetReportsReports' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetReportsReports.php',
|
||||
'Brevo\\Client\\Model\\GetScheduledEmailByBatchId' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetScheduledEmailByBatchId.php',
|
||||
'Brevo\\Client\\Model\\GetScheduledEmailByBatchIdBatches' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetScheduledEmailByBatchIdBatches.php',
|
||||
'Brevo\\Client\\Model\\GetScheduledEmailByMessageId' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetScheduledEmailByMessageId.php',
|
||||
'Brevo\\Client\\Model\\GetSegments' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSegments.php',
|
||||
'Brevo\\Client\\Model\\GetSegmentsSegments' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSegmentsSegments.php',
|
||||
'Brevo\\Client\\Model\\GetSendersList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSendersList.php',
|
||||
'Brevo\\Client\\Model\\GetSendersListIps' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSendersListIps.php',
|
||||
'Brevo\\Client\\Model\\GetSendersListSenders' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSendersListSenders.php',
|
||||
'Brevo\\Client\\Model\\GetSharedTemplateUrl' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSharedTemplateUrl.php',
|
||||
'Brevo\\Client\\Model\\GetSmsCampaign' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSmsCampaign.php',
|
||||
'Brevo\\Client\\Model\\GetSmsCampaignOverview' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSmsCampaignOverview.php',
|
||||
'Brevo\\Client\\Model\\GetSmsCampaignRecipients' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSmsCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\GetSmsCampaignStats' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSmsCampaignStats.php',
|
||||
'Brevo\\Client\\Model\\GetSmsCampaigns' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSmsCampaigns.php',
|
||||
'Brevo\\Client\\Model\\GetSmsEventReport' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSmsEventReport.php',
|
||||
'Brevo\\Client\\Model\\GetSmsEventReportEvents' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSmsEventReportEvents.php',
|
||||
'Brevo\\Client\\Model\\GetSmtpTemplateOverview' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSmtpTemplateOverview.php',
|
||||
'Brevo\\Client\\Model\\GetSmtpTemplateOverviewSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSmtpTemplateOverviewSender.php',
|
||||
'Brevo\\Client\\Model\\GetSmtpTemplates' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSmtpTemplates.php',
|
||||
'Brevo\\Client\\Model\\GetSsoToken' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetSsoToken.php',
|
||||
'Brevo\\Client\\Model\\GetStatsByBrowser' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetStatsByBrowser.php',
|
||||
'Brevo\\Client\\Model\\GetStatsByDevice' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetStatsByDevice.php',
|
||||
'Brevo\\Client\\Model\\GetStatsByDomain' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetStatsByDomain.php',
|
||||
'Brevo\\Client\\Model\\GetTransacAggregatedSmsReport' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetTransacAggregatedSmsReport.php',
|
||||
'Brevo\\Client\\Model\\GetTransacBlockedContacts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetTransacBlockedContacts.php',
|
||||
'Brevo\\Client\\Model\\GetTransacBlockedContactsContacts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetTransacBlockedContactsContacts.php',
|
||||
'Brevo\\Client\\Model\\GetTransacBlockedContactsReason' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetTransacBlockedContactsReason.php',
|
||||
'Brevo\\Client\\Model\\GetTransacEmailContent' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetTransacEmailContent.php',
|
||||
'Brevo\\Client\\Model\\GetTransacEmailContentEvents' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetTransacEmailContentEvents.php',
|
||||
'Brevo\\Client\\Model\\GetTransacEmailsList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetTransacEmailsList.php',
|
||||
'Brevo\\Client\\Model\\GetTransacEmailsListTransactionalEmails' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetTransacEmailsListTransactionalEmails.php',
|
||||
'Brevo\\Client\\Model\\GetTransacSmsReport' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetTransacSmsReport.php',
|
||||
'Brevo\\Client\\Model\\GetTransacSmsReportReports' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetTransacSmsReportReports.php',
|
||||
'Brevo\\Client\\Model\\GetUserPermission' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetUserPermission.php',
|
||||
'Brevo\\Client\\Model\\GetUserPermissionPrivileges' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetUserPermissionPrivileges.php',
|
||||
'Brevo\\Client\\Model\\GetWATemplates' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWATemplates.php',
|
||||
'Brevo\\Client\\Model\\GetWATemplatesTemplates' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWATemplatesTemplates.php',
|
||||
'Brevo\\Client\\Model\\GetWebhook' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWebhook.php',
|
||||
'Brevo\\Client\\Model\\GetWebhookAuth' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWebhookAuth.php',
|
||||
'Brevo\\Client\\Model\\GetWebhookHeaders' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWebhookHeaders.php',
|
||||
'Brevo\\Client\\Model\\GetWebhooks' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWebhooks.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsAppConfig' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWhatsAppConfig.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsappCampaignOverview' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWhatsappCampaignOverview.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsappCampaigns' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWhatsappCampaigns.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsappCampaignsCampaigns' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWhatsappCampaignsCampaigns.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsappEventReport' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWhatsappEventReport.php',
|
||||
'Brevo\\Client\\Model\\GetWhatsappEventReportEvents' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/GetWhatsappEventReportEvents.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse200' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InlineResponse200.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2001' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InlineResponse2001.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2002' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InlineResponse2002.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse201' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InlineResponse201.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2011' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InlineResponse2011.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2012' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InlineResponse2012.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2013' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InlineResponse2013.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2014' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InlineResponse2014.php',
|
||||
'Brevo\\Client\\Model\\InlineResponse2015' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InlineResponse2015.php',
|
||||
'Brevo\\Client\\Model\\InviteAdminUser' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InviteAdminUser.php',
|
||||
'Brevo\\Client\\Model\\InviteAdminUserPrivileges' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InviteAdminUserPrivileges.php',
|
||||
'Brevo\\Client\\Model\\Inviteuser' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Inviteuser.php',
|
||||
'Brevo\\Client\\Model\\InviteuserPrivileges' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/InviteuserPrivileges.php',
|
||||
'Brevo\\Client\\Model\\ManageIp' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/ManageIp.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponse' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponse.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponseBillingInfo' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponseBillingInfo.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponseBillingInfoAddress' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponseBillingInfoAddress.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponseBillingInfoName' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponseBillingInfoName.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponsePlanInfo' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponsePlanInfo.php',
|
||||
'Brevo\\Client\\Model\\MasterDetailsResponsePlanInfoFeatures' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/MasterDetailsResponsePlanInfoFeatures.php',
|
||||
'Brevo\\Client\\Model\\ModelInterface' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/ModelInterface.php',
|
||||
'Brevo\\Client\\Model\\Note' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Note.php',
|
||||
'Brevo\\Client\\Model\\NoteData' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/NoteData.php',
|
||||
'Brevo\\Client\\Model\\NoteId' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/NoteId.php',
|
||||
'Brevo\\Client\\Model\\NoteList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/NoteList.php',
|
||||
'Brevo\\Client\\Model\\Order' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Order.php',
|
||||
'Brevo\\Client\\Model\\OrderBatch' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/OrderBatch.php',
|
||||
'Brevo\\Client\\Model\\OrderBilling' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/OrderBilling.php',
|
||||
'Brevo\\Client\\Model\\OrderProducts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/OrderProducts.php',
|
||||
'Brevo\\Client\\Model\\Otp' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Otp.php',
|
||||
'Brevo\\Client\\Model\\Pipeline' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Pipeline.php',
|
||||
'Brevo\\Client\\Model\\PipelineStage' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/PipelineStage.php',
|
||||
'Brevo\\Client\\Model\\Pipelines' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Pipelines.php',
|
||||
'Brevo\\Client\\Model\\PostContactInfo' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/PostContactInfo.php',
|
||||
'Brevo\\Client\\Model\\PostContactInfoContacts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/PostContactInfoContacts.php',
|
||||
'Brevo\\Client\\Model\\PostSendFailed' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/PostSendFailed.php',
|
||||
'Brevo\\Client\\Model\\PostSendSmsTestFailed' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/PostSendSmsTestFailed.php',
|
||||
'Brevo\\Client\\Model\\PutRevokeUserPermission' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/PutRevokeUserPermission.php',
|
||||
'Brevo\\Client\\Model\\Putresendcancelinvitation' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Putresendcancelinvitation.php',
|
||||
'Brevo\\Client\\Model\\RemainingCreditModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RemainingCreditModel.php',
|
||||
'Brevo\\Client\\Model\\RemainingCreditModelChild' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RemainingCreditModelChild.php',
|
||||
'Brevo\\Client\\Model\\RemainingCreditModelReseller' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RemainingCreditModelReseller.php',
|
||||
'Brevo\\Client\\Model\\RemoveContactFromList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RemoveContactFromList.php',
|
||||
'Brevo\\Client\\Model\\RemoveCredits' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RemoveCredits.php',
|
||||
'Brevo\\Client\\Model\\RequestContactExport' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RequestContactExport.php',
|
||||
'Brevo\\Client\\Model\\RequestContactExportCustomContactFilter' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RequestContactExportCustomContactFilter.php',
|
||||
'Brevo\\Client\\Model\\RequestContactImport' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RequestContactImport.php',
|
||||
'Brevo\\Client\\Model\\RequestContactImportJsonBody' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RequestContactImportJsonBody.php',
|
||||
'Brevo\\Client\\Model\\RequestContactImportNewList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RequestContactImportNewList.php',
|
||||
'Brevo\\Client\\Model\\RequestSmsRecipientExport' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/RequestSmsRecipientExport.php',
|
||||
'Brevo\\Client\\Model\\ScheduleSmtpEmail' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/ScheduleSmtpEmail.php',
|
||||
'Brevo\\Client\\Model\\SendReport' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendReport.php',
|
||||
'Brevo\\Client\\Model\\SendReportEmail' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendReportEmail.php',
|
||||
'Brevo\\Client\\Model\\SendSms' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSms.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmail' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSmtpEmail.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailAttachment' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailAttachment.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailBcc' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailBcc.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailCc' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailCc.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailMessageVersions' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailMessageVersions.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailReplyTo' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailReplyTo.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailReplyTo1' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailReplyTo1.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailSender.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailTo' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailTo.php',
|
||||
'Brevo\\Client\\Model\\SendSmtpEmailTo1' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendSmtpEmailTo1.php',
|
||||
'Brevo\\Client\\Model\\SendTestEmail' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendTestEmail.php',
|
||||
'Brevo\\Client\\Model\\SendTestSms' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendTestSms.php',
|
||||
'Brevo\\Client\\Model\\SendTransacSms' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendTransacSms.php',
|
||||
'Brevo\\Client\\Model\\SendWhatsappMessage' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SendWhatsappMessage.php',
|
||||
'Brevo\\Client\\Model\\SsoTokenRequest' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SsoTokenRequest.php',
|
||||
'Brevo\\Client\\Model\\SubAccountAppsToggleRequest' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountAppsToggleRequest.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponse' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponse.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfo' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfo.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoCredits' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoCredits.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoCreditsEmails' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoCreditsEmails.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoFeatures' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeatures.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoFeaturesInbox' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeaturesInbox.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoFeaturesLandingPage' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.php',
|
||||
'Brevo\\Client\\Model\\SubAccountDetailsResponsePlanInfoFeaturesUsers' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeaturesUsers.php',
|
||||
'Brevo\\Client\\Model\\SubAccountUpdatePlanRequest' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountUpdatePlanRequest.php',
|
||||
'Brevo\\Client\\Model\\SubAccountUpdatePlanRequestCredits' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountUpdatePlanRequestCredits.php',
|
||||
'Brevo\\Client\\Model\\SubAccountUpdatePlanRequestFeatures' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountUpdatePlanRequestFeatures.php',
|
||||
'Brevo\\Client\\Model\\SubAccountsResponse' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountsResponse.php',
|
||||
'Brevo\\Client\\Model\\SubAccountsResponseSubAccounts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/SubAccountsResponseSubAccounts.php',
|
||||
'Brevo\\Client\\Model\\Task' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/Task.php',
|
||||
'Brevo\\Client\\Model\\TaskList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/TaskList.php',
|
||||
'Brevo\\Client\\Model\\TaskReminder' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/TaskReminder.php',
|
||||
'Brevo\\Client\\Model\\TaskTypes' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/TaskTypes.php',
|
||||
'Brevo\\Client\\Model\\UpdateAttribute' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateAttribute.php',
|
||||
'Brevo\\Client\\Model\\UpdateAttributeEnumeration' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateAttributeEnumeration.php',
|
||||
'Brevo\\Client\\Model\\UpdateBatchContacts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateBatchContacts.php',
|
||||
'Brevo\\Client\\Model\\UpdateBatchContactsContacts' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateBatchContactsContacts.php',
|
||||
'Brevo\\Client\\Model\\UpdateBatchContactsModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateBatchContactsModel.php',
|
||||
'Brevo\\Client\\Model\\UpdateCampaignStatus' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateCampaignStatus.php',
|
||||
'Brevo\\Client\\Model\\UpdateChild' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateChild.php',
|
||||
'Brevo\\Client\\Model\\UpdateChildAccountStatus' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateChildAccountStatus.php',
|
||||
'Brevo\\Client\\Model\\UpdateChildDomain' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateChildDomain.php',
|
||||
'Brevo\\Client\\Model\\UpdateContact' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateContact.php',
|
||||
'Brevo\\Client\\Model\\UpdateCouponCollection' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateCouponCollection.php',
|
||||
'Brevo\\Client\\Model\\UpdateEmailCampaign' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateEmailCampaign.php',
|
||||
'Brevo\\Client\\Model\\UpdateEmailCampaignRecipients' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateEmailCampaignRecipients.php',
|
||||
'Brevo\\Client\\Model\\UpdateEmailCampaignSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateEmailCampaignSender.php',
|
||||
'Brevo\\Client\\Model\\UpdateExternalFeed' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateExternalFeed.php',
|
||||
'Brevo\\Client\\Model\\UpdateList' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateList.php',
|
||||
'Brevo\\Client\\Model\\UpdateSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateSender.php',
|
||||
'Brevo\\Client\\Model\\UpdateSmsCampaign' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateSmsCampaign.php',
|
||||
'Brevo\\Client\\Model\\UpdateSmtpTemplate' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateSmtpTemplate.php',
|
||||
'Brevo\\Client\\Model\\UpdateSmtpTemplateSender' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateSmtpTemplateSender.php',
|
||||
'Brevo\\Client\\Model\\UpdateWebhook' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateWebhook.php',
|
||||
'Brevo\\Client\\Model\\UpdateWhatsAppCampaign' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UpdateWhatsAppCampaign.php',
|
||||
'Brevo\\Client\\Model\\UploadImageModel' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UploadImageModel.php',
|
||||
'Brevo\\Client\\Model\\UploadImageToGallery' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/UploadImageToGallery.php',
|
||||
'Brevo\\Client\\Model\\VariablesItems' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/VariablesItems.php',
|
||||
'Brevo\\Client\\Model\\WhatsappCampStats' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/WhatsappCampStats.php',
|
||||
'Brevo\\Client\\Model\\WhatsappCampTemplate' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/Model/WhatsappCampTemplate.php',
|
||||
'Brevo\\Client\\ObjectSerializer' => __DIR__ . '/..' . '/getbrevo/brevo-php/lib/ObjectSerializer.php',
|
||||
'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php',
|
||||
'Composer\\Semver\\Comparator' => __DIR__ . '/..' . '/composer/semver/src/Comparator.php',
|
||||
'Composer\\Semver\\CompilingMatcher' => __DIR__ . '/..' . '/composer/semver/src/CompilingMatcher.php',
|
||||
|
|
@ -142,6 +564,92 @@ class ComposerStaticInit749a661738bcd5b9428c88a1da847bc7
|
|||
'Composer\\Semver\\Intervals' => __DIR__ . '/..' . '/composer/semver/src/Intervals.php',
|
||||
'Composer\\Semver\\Semver' => __DIR__ . '/..' . '/composer/semver/src/Semver.php',
|
||||
'Composer\\Semver\\VersionParser' => __DIR__ . '/..' . '/composer/semver/src/VersionParser.php',
|
||||
'GuzzleHttp\\BodySummarizer' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/BodySummarizer.php',
|
||||
'GuzzleHttp\\BodySummarizerInterface' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/BodySummarizerInterface.php',
|
||||
'GuzzleHttp\\Client' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Client.php',
|
||||
'GuzzleHttp\\ClientInterface' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/ClientInterface.php',
|
||||
'GuzzleHttp\\ClientTrait' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/ClientTrait.php',
|
||||
'GuzzleHttp\\Cookie\\CookieJar' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Cookie/CookieJar.php',
|
||||
'GuzzleHttp\\Cookie\\CookieJarInterface' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php',
|
||||
'GuzzleHttp\\Cookie\\FileCookieJar' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php',
|
||||
'GuzzleHttp\\Cookie\\SessionCookieJar' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Cookie/SessionCookieJar.php',
|
||||
'GuzzleHttp\\Cookie\\SetCookie' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Cookie/SetCookie.php',
|
||||
'GuzzleHttp\\Exception\\BadResponseException' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Exception/BadResponseException.php',
|
||||
'GuzzleHttp\\Exception\\ClientException' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Exception/ClientException.php',
|
||||
'GuzzleHttp\\Exception\\ConnectException' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Exception/ConnectException.php',
|
||||
'GuzzleHttp\\Exception\\GuzzleException' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Exception/GuzzleException.php',
|
||||
'GuzzleHttp\\Exception\\InvalidArgumentException' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Exception/InvalidArgumentException.php',
|
||||
'GuzzleHttp\\Exception\\RequestException' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Exception/RequestException.php',
|
||||
'GuzzleHttp\\Exception\\ServerException' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Exception/ServerException.php',
|
||||
'GuzzleHttp\\Exception\\TooManyRedirectsException' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Exception/TooManyRedirectsException.php',
|
||||
'GuzzleHttp\\Exception\\TransferException' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Exception/TransferException.php',
|
||||
'GuzzleHttp\\HandlerStack' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/HandlerStack.php',
|
||||
'GuzzleHttp\\Handler\\CurlFactory' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Handler/CurlFactory.php',
|
||||
'GuzzleHttp\\Handler\\CurlFactoryInterface' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Handler/CurlFactoryInterface.php',
|
||||
'GuzzleHttp\\Handler\\CurlHandler' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Handler/CurlHandler.php',
|
||||
'GuzzleHttp\\Handler\\CurlMultiHandler' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php',
|
||||
'GuzzleHttp\\Handler\\EasyHandle' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Handler/EasyHandle.php',
|
||||
'GuzzleHttp\\Handler\\HeaderProcessor' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Handler/HeaderProcessor.php',
|
||||
'GuzzleHttp\\Handler\\MockHandler' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Handler/MockHandler.php',
|
||||
'GuzzleHttp\\Handler\\Proxy' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Handler/Proxy.php',
|
||||
'GuzzleHttp\\Handler\\StreamHandler' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Handler/StreamHandler.php',
|
||||
'GuzzleHttp\\MessageFormatter' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/MessageFormatter.php',
|
||||
'GuzzleHttp\\MessageFormatterInterface' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/MessageFormatterInterface.php',
|
||||
'GuzzleHttp\\Middleware' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Middleware.php',
|
||||
'GuzzleHttp\\Pool' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Pool.php',
|
||||
'GuzzleHttp\\PrepareBodyMiddleware' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php',
|
||||
'GuzzleHttp\\Promise\\AggregateException' => __DIR__ . '/..' . '/guzzlehttp/promises/src/AggregateException.php',
|
||||
'GuzzleHttp\\Promise\\CancellationException' => __DIR__ . '/..' . '/guzzlehttp/promises/src/CancellationException.php',
|
||||
'GuzzleHttp\\Promise\\Coroutine' => __DIR__ . '/..' . '/guzzlehttp/promises/src/Coroutine.php',
|
||||
'GuzzleHttp\\Promise\\Create' => __DIR__ . '/..' . '/guzzlehttp/promises/src/Create.php',
|
||||
'GuzzleHttp\\Promise\\Each' => __DIR__ . '/..' . '/guzzlehttp/promises/src/Each.php',
|
||||
'GuzzleHttp\\Promise\\EachPromise' => __DIR__ . '/..' . '/guzzlehttp/promises/src/EachPromise.php',
|
||||
'GuzzleHttp\\Promise\\FulfilledPromise' => __DIR__ . '/..' . '/guzzlehttp/promises/src/FulfilledPromise.php',
|
||||
'GuzzleHttp\\Promise\\Is' => __DIR__ . '/..' . '/guzzlehttp/promises/src/Is.php',
|
||||
'GuzzleHttp\\Promise\\Promise' => __DIR__ . '/..' . '/guzzlehttp/promises/src/Promise.php',
|
||||
'GuzzleHttp\\Promise\\PromiseInterface' => __DIR__ . '/..' . '/guzzlehttp/promises/src/PromiseInterface.php',
|
||||
'GuzzleHttp\\Promise\\PromisorInterface' => __DIR__ . '/..' . '/guzzlehttp/promises/src/PromisorInterface.php',
|
||||
'GuzzleHttp\\Promise\\RejectedPromise' => __DIR__ . '/..' . '/guzzlehttp/promises/src/RejectedPromise.php',
|
||||
'GuzzleHttp\\Promise\\RejectionException' => __DIR__ . '/..' . '/guzzlehttp/promises/src/RejectionException.php',
|
||||
'GuzzleHttp\\Promise\\TaskQueue' => __DIR__ . '/..' . '/guzzlehttp/promises/src/TaskQueue.php',
|
||||
'GuzzleHttp\\Promise\\TaskQueueInterface' => __DIR__ . '/..' . '/guzzlehttp/promises/src/TaskQueueInterface.php',
|
||||
'GuzzleHttp\\Promise\\Utils' => __DIR__ . '/..' . '/guzzlehttp/promises/src/Utils.php',
|
||||
'GuzzleHttp\\Psr7\\AppendStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/AppendStream.php',
|
||||
'GuzzleHttp\\Psr7\\BufferStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/BufferStream.php',
|
||||
'GuzzleHttp\\Psr7\\CachingStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/CachingStream.php',
|
||||
'GuzzleHttp\\Psr7\\DroppingStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/DroppingStream.php',
|
||||
'GuzzleHttp\\Psr7\\Exception\\MalformedUriException' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/Exception/MalformedUriException.php',
|
||||
'GuzzleHttp\\Psr7\\FnStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/FnStream.php',
|
||||
'GuzzleHttp\\Psr7\\Header' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/Header.php',
|
||||
'GuzzleHttp\\Psr7\\HttpFactory' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/HttpFactory.php',
|
||||
'GuzzleHttp\\Psr7\\InflateStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/InflateStream.php',
|
||||
'GuzzleHttp\\Psr7\\LazyOpenStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/LazyOpenStream.php',
|
||||
'GuzzleHttp\\Psr7\\LimitStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/LimitStream.php',
|
||||
'GuzzleHttp\\Psr7\\Message' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/Message.php',
|
||||
'GuzzleHttp\\Psr7\\MessageTrait' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/MessageTrait.php',
|
||||
'GuzzleHttp\\Psr7\\MimeType' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/MimeType.php',
|
||||
'GuzzleHttp\\Psr7\\MultipartStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/MultipartStream.php',
|
||||
'GuzzleHttp\\Psr7\\NoSeekStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/NoSeekStream.php',
|
||||
'GuzzleHttp\\Psr7\\PumpStream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/PumpStream.php',
|
||||
'GuzzleHttp\\Psr7\\Query' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/Query.php',
|
||||
'GuzzleHttp\\Psr7\\Request' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/Request.php',
|
||||
'GuzzleHttp\\Psr7\\Response' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/Response.php',
|
||||
'GuzzleHttp\\Psr7\\Rfc7230' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/Rfc7230.php',
|
||||
'GuzzleHttp\\Psr7\\ServerRequest' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/ServerRequest.php',
|
||||
'GuzzleHttp\\Psr7\\Stream' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/Stream.php',
|
||||
'GuzzleHttp\\Psr7\\StreamDecoratorTrait' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/StreamDecoratorTrait.php',
|
||||
'GuzzleHttp\\Psr7\\StreamWrapper' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/StreamWrapper.php',
|
||||
'GuzzleHttp\\Psr7\\UploadedFile' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/UploadedFile.php',
|
||||
'GuzzleHttp\\Psr7\\Uri' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/Uri.php',
|
||||
'GuzzleHttp\\Psr7\\UriComparator' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/UriComparator.php',
|
||||
'GuzzleHttp\\Psr7\\UriNormalizer' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/UriNormalizer.php',
|
||||
'GuzzleHttp\\Psr7\\UriResolver' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/UriResolver.php',
|
||||
'GuzzleHttp\\Psr7\\Utils' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/Utils.php',
|
||||
'GuzzleHttp\\RedirectMiddleware' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/RedirectMiddleware.php',
|
||||
'GuzzleHttp\\RequestOptions' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/RequestOptions.php',
|
||||
'GuzzleHttp\\RetryMiddleware' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/RetryMiddleware.php',
|
||||
'GuzzleHttp\\TransferStats' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/TransferStats.php',
|
||||
'GuzzleHttp\\Utils' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/Utils.php',
|
||||
'Kirby\\Api\\Api' => __DIR__ . '/../..' . '/kirby/src/Api/Api.php',
|
||||
'Kirby\\Api\\Collection' => __DIR__ . '/../..' . '/kirby/src/Api/Collection.php',
|
||||
'Kirby\\Api\\Model' => __DIR__ . '/../..' . '/kirby/src/Api/Model.php',
|
||||
|
|
@ -482,6 +990,23 @@ class ComposerStaticInit749a661738bcd5b9428c88a1da847bc7
|
|||
'PHPMailer\\PHPMailer\\SMTP' => __DIR__ . '/..' . '/phpmailer/phpmailer/src/SMTP.php',
|
||||
'Parsedown' => __DIR__ . '/../..' . '/kirby/dependencies/parsedown/Parsedown.php',
|
||||
'ParsedownExtra' => __DIR__ . '/../..' . '/kirby/dependencies/parsedown-extra/ParsedownExtra.php',
|
||||
'Psr\\Http\\Client\\ClientExceptionInterface' => __DIR__ . '/..' . '/psr/http-client/src/ClientExceptionInterface.php',
|
||||
'Psr\\Http\\Client\\ClientInterface' => __DIR__ . '/..' . '/psr/http-client/src/ClientInterface.php',
|
||||
'Psr\\Http\\Client\\NetworkExceptionInterface' => __DIR__ . '/..' . '/psr/http-client/src/NetworkExceptionInterface.php',
|
||||
'Psr\\Http\\Client\\RequestExceptionInterface' => __DIR__ . '/..' . '/psr/http-client/src/RequestExceptionInterface.php',
|
||||
'Psr\\Http\\Message\\MessageInterface' => __DIR__ . '/..' . '/psr/http-message/src/MessageInterface.php',
|
||||
'Psr\\Http\\Message\\RequestFactoryInterface' => __DIR__ . '/..' . '/psr/http-factory/src/RequestFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\RequestInterface' => __DIR__ . '/..' . '/psr/http-message/src/RequestInterface.php',
|
||||
'Psr\\Http\\Message\\ResponseFactoryInterface' => __DIR__ . '/..' . '/psr/http-factory/src/ResponseFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\ResponseInterface' => __DIR__ . '/..' . '/psr/http-message/src/ResponseInterface.php',
|
||||
'Psr\\Http\\Message\\ServerRequestFactoryInterface' => __DIR__ . '/..' . '/psr/http-factory/src/ServerRequestFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\ServerRequestInterface' => __DIR__ . '/..' . '/psr/http-message/src/ServerRequestInterface.php',
|
||||
'Psr\\Http\\Message\\StreamFactoryInterface' => __DIR__ . '/..' . '/psr/http-factory/src/StreamFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\StreamInterface' => __DIR__ . '/..' . '/psr/http-message/src/StreamInterface.php',
|
||||
'Psr\\Http\\Message\\UploadedFileFactoryInterface' => __DIR__ . '/..' . '/psr/http-factory/src/UploadedFileFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\UploadedFileInterface' => __DIR__ . '/..' . '/psr/http-message/src/UploadedFileInterface.php',
|
||||
'Psr\\Http\\Message\\UriFactoryInterface' => __DIR__ . '/..' . '/psr/http-factory/src/UriFactoryInterface.php',
|
||||
'Psr\\Http\\Message\\UriInterface' => __DIR__ . '/..' . '/psr/http-message/src/UriInterface.php',
|
||||
'Psr\\Log\\AbstractLogger' => __DIR__ . '/..' . '/psr/log/src/AbstractLogger.php',
|
||||
'Psr\\Log\\InvalidArgumentException' => __DIR__ . '/..' . '/psr/log/src/InvalidArgumentException.php',
|
||||
'Psr\\Log\\LogLevel' => __DIR__ . '/..' . '/psr/log/src/LogLevel.php',
|
||||
|
|
|
|||
616
vendor/composer/installed.json
vendored
616
vendor/composer/installed.json
vendored
|
|
@ -276,6 +276,72 @@
|
|||
],
|
||||
"install-path": "../filp/whoops"
|
||||
},
|
||||
{
|
||||
"name": "getbrevo/brevo-php",
|
||||
"version": "v2.0.2",
|
||||
"version_normalized": "2.0.2.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/getbrevo/brevo-php.git",
|
||||
"reference": "d090995afd88ff9d6f1284d7f9adaff0c6a58949"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/getbrevo/brevo-php/zipball/d090995afd88ff9d6f1284d7f9adaff0c6a58949",
|
||||
"reference": "d090995afd88ff9d6f1284d7f9adaff0c6a58949",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"ext-curl": "*",
|
||||
"ext-json": "*",
|
||||
"ext-mbstring": "*",
|
||||
"guzzlehttp/guzzle": "^7.4.0",
|
||||
"php": ">=5.6"
|
||||
},
|
||||
"require-dev": {
|
||||
"friendsofphp/php-cs-fixer": "~1.12",
|
||||
"phpunit/phpunit": "^4.8",
|
||||
"squizlabs/php_codesniffer": "~2.6"
|
||||
},
|
||||
"time": "2024-08-12T07:30:54+00:00",
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "1.x.x-dev"
|
||||
}
|
||||
},
|
||||
"installation-source": "dist",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Brevo\\Client\\": "lib/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Brevo Developers",
|
||||
"email": "contact@brevo.com",
|
||||
"homepage": "https://www.brevo.com/"
|
||||
}
|
||||
],
|
||||
"description": "Official Brevo provided RESTFul API V3 php library",
|
||||
"homepage": "https://github.com/getbrevo/brevo-php",
|
||||
"keywords": [
|
||||
"api",
|
||||
"brevo",
|
||||
"php",
|
||||
"sdk",
|
||||
"swagger"
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/getbrevo/brevo-php/issues",
|
||||
"source": "https://github.com/getbrevo/brevo-php/tree/v2.0.2"
|
||||
},
|
||||
"install-path": "../getbrevo/brevo-php"
|
||||
},
|
||||
{
|
||||
"name": "getkirby/cms",
|
||||
"version": "4.3.0",
|
||||
|
|
@ -432,6 +498,340 @@
|
|||
],
|
||||
"install-path": "../getkirby/composer-installer"
|
||||
},
|
||||
{
|
||||
"name": "guzzlehttp/guzzle",
|
||||
"version": "7.9.2",
|
||||
"version_normalized": "7.9.2.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/guzzle/guzzle.git",
|
||||
"reference": "d281ed313b989f213357e3be1a179f02196ac99b"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/guzzle/guzzle/zipball/d281ed313b989f213357e3be1a179f02196ac99b",
|
||||
"reference": "d281ed313b989f213357e3be1a179f02196ac99b",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"ext-json": "*",
|
||||
"guzzlehttp/promises": "^1.5.3 || ^2.0.3",
|
||||
"guzzlehttp/psr7": "^2.7.0",
|
||||
"php": "^7.2.5 || ^8.0",
|
||||
"psr/http-client": "^1.0",
|
||||
"symfony/deprecation-contracts": "^2.2 || ^3.0"
|
||||
},
|
||||
"provide": {
|
||||
"psr/http-client-implementation": "1.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"bamarni/composer-bin-plugin": "^1.8.2",
|
||||
"ext-curl": "*",
|
||||
"guzzle/client-integration-tests": "3.0.2",
|
||||
"php-http/message-factory": "^1.1",
|
||||
"phpunit/phpunit": "^8.5.39 || ^9.6.20",
|
||||
"psr/log": "^1.1 || ^2.0 || ^3.0"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-curl": "Required for CURL handler support",
|
||||
"ext-intl": "Required for Internationalized Domain Name (IDN) support",
|
||||
"psr/log": "Required for using the Log middleware"
|
||||
},
|
||||
"time": "2024-07-24T11:22:20+00:00",
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"bamarni-bin": {
|
||||
"bin-links": true,
|
||||
"forward-command": false
|
||||
}
|
||||
},
|
||||
"installation-source": "dist",
|
||||
"autoload": {
|
||||
"files": [
|
||||
"src/functions_include.php"
|
||||
],
|
||||
"psr-4": {
|
||||
"GuzzleHttp\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Graham Campbell",
|
||||
"email": "hello@gjcampbell.co.uk",
|
||||
"homepage": "https://github.com/GrahamCampbell"
|
||||
},
|
||||
{
|
||||
"name": "Michael Dowling",
|
||||
"email": "mtdowling@gmail.com",
|
||||
"homepage": "https://github.com/mtdowling"
|
||||
},
|
||||
{
|
||||
"name": "Jeremy Lindblom",
|
||||
"email": "jeremeamia@gmail.com",
|
||||
"homepage": "https://github.com/jeremeamia"
|
||||
},
|
||||
{
|
||||
"name": "George Mponos",
|
||||
"email": "gmponos@gmail.com",
|
||||
"homepage": "https://github.com/gmponos"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Nyholm",
|
||||
"email": "tobias.nyholm@gmail.com",
|
||||
"homepage": "https://github.com/Nyholm"
|
||||
},
|
||||
{
|
||||
"name": "Márk Sági-Kazár",
|
||||
"email": "mark.sagikazar@gmail.com",
|
||||
"homepage": "https://github.com/sagikazarmark"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Schultze",
|
||||
"email": "webmaster@tubo-world.de",
|
||||
"homepage": "https://github.com/Tobion"
|
||||
}
|
||||
],
|
||||
"description": "Guzzle is a PHP HTTP client library",
|
||||
"keywords": [
|
||||
"client",
|
||||
"curl",
|
||||
"framework",
|
||||
"http",
|
||||
"http client",
|
||||
"psr-18",
|
||||
"psr-7",
|
||||
"rest",
|
||||
"web service"
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/guzzle/guzzle/issues",
|
||||
"source": "https://github.com/guzzle/guzzle/tree/7.9.2"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://github.com/GrahamCampbell",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/Nyholm",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/guzzlehttp/guzzle",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"install-path": "../guzzlehttp/guzzle"
|
||||
},
|
||||
{
|
||||
"name": "guzzlehttp/promises",
|
||||
"version": "2.0.3",
|
||||
"version_normalized": "2.0.3.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/guzzle/promises.git",
|
||||
"reference": "6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/guzzle/promises/zipball/6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8",
|
||||
"reference": "6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.2.5 || ^8.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"bamarni/composer-bin-plugin": "^1.8.2",
|
||||
"phpunit/phpunit": "^8.5.39 || ^9.6.20"
|
||||
},
|
||||
"time": "2024-07-18T10:29:17+00:00",
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"bamarni-bin": {
|
||||
"bin-links": true,
|
||||
"forward-command": false
|
||||
}
|
||||
},
|
||||
"installation-source": "dist",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"GuzzleHttp\\Promise\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Graham Campbell",
|
||||
"email": "hello@gjcampbell.co.uk",
|
||||
"homepage": "https://github.com/GrahamCampbell"
|
||||
},
|
||||
{
|
||||
"name": "Michael Dowling",
|
||||
"email": "mtdowling@gmail.com",
|
||||
"homepage": "https://github.com/mtdowling"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Nyholm",
|
||||
"email": "tobias.nyholm@gmail.com",
|
||||
"homepage": "https://github.com/Nyholm"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Schultze",
|
||||
"email": "webmaster@tubo-world.de",
|
||||
"homepage": "https://github.com/Tobion"
|
||||
}
|
||||
],
|
||||
"description": "Guzzle promises library",
|
||||
"keywords": [
|
||||
"promise"
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/guzzle/promises/issues",
|
||||
"source": "https://github.com/guzzle/promises/tree/2.0.3"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://github.com/GrahamCampbell",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/Nyholm",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/guzzlehttp/promises",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"install-path": "../guzzlehttp/promises"
|
||||
},
|
||||
{
|
||||
"name": "guzzlehttp/psr7",
|
||||
"version": "2.7.0",
|
||||
"version_normalized": "2.7.0.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/guzzle/psr7.git",
|
||||
"reference": "a70f5c95fb43bc83f07c9c948baa0dc1829bf201"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/guzzle/psr7/zipball/a70f5c95fb43bc83f07c9c948baa0dc1829bf201",
|
||||
"reference": "a70f5c95fb43bc83f07c9c948baa0dc1829bf201",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.2.5 || ^8.0",
|
||||
"psr/http-factory": "^1.0",
|
||||
"psr/http-message": "^1.1 || ^2.0",
|
||||
"ralouphie/getallheaders": "^3.0"
|
||||
},
|
||||
"provide": {
|
||||
"psr/http-factory-implementation": "1.0",
|
||||
"psr/http-message-implementation": "1.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"bamarni/composer-bin-plugin": "^1.8.2",
|
||||
"http-interop/http-factory-tests": "0.9.0",
|
||||
"phpunit/phpunit": "^8.5.39 || ^9.6.20"
|
||||
},
|
||||
"suggest": {
|
||||
"laminas/laminas-httphandlerrunner": "Emit PSR-7 responses"
|
||||
},
|
||||
"time": "2024-07-18T11:15:46+00:00",
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"bamarni-bin": {
|
||||
"bin-links": true,
|
||||
"forward-command": false
|
||||
}
|
||||
},
|
||||
"installation-source": "dist",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"GuzzleHttp\\Psr7\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Graham Campbell",
|
||||
"email": "hello@gjcampbell.co.uk",
|
||||
"homepage": "https://github.com/GrahamCampbell"
|
||||
},
|
||||
{
|
||||
"name": "Michael Dowling",
|
||||
"email": "mtdowling@gmail.com",
|
||||
"homepage": "https://github.com/mtdowling"
|
||||
},
|
||||
{
|
||||
"name": "George Mponos",
|
||||
"email": "gmponos@gmail.com",
|
||||
"homepage": "https://github.com/gmponos"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Nyholm",
|
||||
"email": "tobias.nyholm@gmail.com",
|
||||
"homepage": "https://github.com/Nyholm"
|
||||
},
|
||||
{
|
||||
"name": "Márk Sági-Kazár",
|
||||
"email": "mark.sagikazar@gmail.com",
|
||||
"homepage": "https://github.com/sagikazarmark"
|
||||
},
|
||||
{
|
||||
"name": "Tobias Schultze",
|
||||
"email": "webmaster@tubo-world.de",
|
||||
"homepage": "https://github.com/Tobion"
|
||||
},
|
||||
{
|
||||
"name": "Márk Sági-Kazár",
|
||||
"email": "mark.sagikazar@gmail.com",
|
||||
"homepage": "https://sagikazarmark.hu"
|
||||
}
|
||||
],
|
||||
"description": "PSR-7 message implementation that also provides common utility methods",
|
||||
"keywords": [
|
||||
"http",
|
||||
"message",
|
||||
"psr-7",
|
||||
"request",
|
||||
"response",
|
||||
"stream",
|
||||
"uri",
|
||||
"url"
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/guzzle/psr7/issues",
|
||||
"source": "https://github.com/guzzle/psr7/tree/2.7.0"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://github.com/GrahamCampbell",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/Nyholm",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/guzzlehttp/psr7",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"install-path": "../guzzlehttp/psr7"
|
||||
},
|
||||
{
|
||||
"name": "laminas/laminas-escaper",
|
||||
"version": "2.13.0",
|
||||
|
|
@ -702,6 +1102,175 @@
|
|||
],
|
||||
"install-path": "../phpmailer/phpmailer"
|
||||
},
|
||||
{
|
||||
"name": "psr/http-client",
|
||||
"version": "1.0.3",
|
||||
"version_normalized": "1.0.3.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/php-fig/http-client.git",
|
||||
"reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/php-fig/http-client/zipball/bb5906edc1c324c9a05aa0873d40117941e5fa90",
|
||||
"reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.0 || ^8.0",
|
||||
"psr/http-message": "^1.0 || ^2.0"
|
||||
},
|
||||
"time": "2023-09-23T14:17:50+00:00",
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "1.0.x-dev"
|
||||
}
|
||||
},
|
||||
"installation-source": "dist",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Psr\\Http\\Client\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "PHP-FIG",
|
||||
"homepage": "https://www.php-fig.org/"
|
||||
}
|
||||
],
|
||||
"description": "Common interface for HTTP clients",
|
||||
"homepage": "https://github.com/php-fig/http-client",
|
||||
"keywords": [
|
||||
"http",
|
||||
"http-client",
|
||||
"psr",
|
||||
"psr-18"
|
||||
],
|
||||
"support": {
|
||||
"source": "https://github.com/php-fig/http-client"
|
||||
},
|
||||
"install-path": "../psr/http-client"
|
||||
},
|
||||
{
|
||||
"name": "psr/http-factory",
|
||||
"version": "1.1.0",
|
||||
"version_normalized": "1.1.0.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/php-fig/http-factory.git",
|
||||
"reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/php-fig/http-factory/zipball/2b4765fddfe3b508ac62f829e852b1501d3f6e8a",
|
||||
"reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=7.1",
|
||||
"psr/http-message": "^1.0 || ^2.0"
|
||||
},
|
||||
"time": "2024-04-15T12:06:14+00:00",
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "1.0.x-dev"
|
||||
}
|
||||
},
|
||||
"installation-source": "dist",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Psr\\Http\\Message\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "PHP-FIG",
|
||||
"homepage": "https://www.php-fig.org/"
|
||||
}
|
||||
],
|
||||
"description": "PSR-17: Common interfaces for PSR-7 HTTP message factories",
|
||||
"keywords": [
|
||||
"factory",
|
||||
"http",
|
||||
"message",
|
||||
"psr",
|
||||
"psr-17",
|
||||
"psr-7",
|
||||
"request",
|
||||
"response"
|
||||
],
|
||||
"support": {
|
||||
"source": "https://github.com/php-fig/http-factory"
|
||||
},
|
||||
"install-path": "../psr/http-factory"
|
||||
},
|
||||
{
|
||||
"name": "psr/http-message",
|
||||
"version": "2.0",
|
||||
"version_normalized": "2.0.0.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/php-fig/http-message.git",
|
||||
"reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/php-fig/http-message/zipball/402d35bcb92c70c026d1a6a9883f06b2ead23d71",
|
||||
"reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.2 || ^8.0"
|
||||
},
|
||||
"time": "2023-04-04T09:54:51+00:00",
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "2.0.x-dev"
|
||||
}
|
||||
},
|
||||
"installation-source": "dist",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Psr\\Http\\Message\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "PHP-FIG",
|
||||
"homepage": "https://www.php-fig.org/"
|
||||
}
|
||||
],
|
||||
"description": "Common interface for HTTP messages",
|
||||
"homepage": "https://github.com/php-fig/http-message",
|
||||
"keywords": [
|
||||
"http",
|
||||
"http-message",
|
||||
"psr",
|
||||
"psr-7",
|
||||
"request",
|
||||
"response"
|
||||
],
|
||||
"support": {
|
||||
"source": "https://github.com/php-fig/http-message/tree/2.0"
|
||||
},
|
||||
"install-path": "../psr/http-message"
|
||||
},
|
||||
{
|
||||
"name": "psr/log",
|
||||
"version": "3.0.0",
|
||||
|
|
@ -755,6 +1324,53 @@
|
|||
},
|
||||
"install-path": "../psr/log"
|
||||
},
|
||||
{
|
||||
"name": "ralouphie/getallheaders",
|
||||
"version": "3.0.3",
|
||||
"version_normalized": "3.0.3.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/ralouphie/getallheaders.git",
|
||||
"reference": "120b605dfeb996808c31b6477290a714d356e822"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/ralouphie/getallheaders/zipball/120b605dfeb996808c31b6477290a714d356e822",
|
||||
"reference": "120b605dfeb996808c31b6477290a714d356e822",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.6"
|
||||
},
|
||||
"require-dev": {
|
||||
"php-coveralls/php-coveralls": "^2.1",
|
||||
"phpunit/phpunit": "^5 || ^6.5"
|
||||
},
|
||||
"time": "2019-03-08T08:55:37+00:00",
|
||||
"type": "library",
|
||||
"installation-source": "dist",
|
||||
"autoload": {
|
||||
"files": [
|
||||
"src/getallheaders.php"
|
||||
]
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Ralph Khattar",
|
||||
"email": "ralph.khattar@gmail.com"
|
||||
}
|
||||
],
|
||||
"description": "A polyfill for getallheaders.",
|
||||
"support": {
|
||||
"issues": "https://github.com/ralouphie/getallheaders/issues",
|
||||
"source": "https://github.com/ralouphie/getallheaders/tree/develop"
|
||||
},
|
||||
"install-path": "../ralouphie/getallheaders"
|
||||
},
|
||||
{
|
||||
"name": "symfony/deprecation-contracts",
|
||||
"version": "v3.5.0",
|
||||
|
|
|
|||
94
vendor/composer/installed.php
vendored
94
vendor/composer/installed.php
vendored
|
|
@ -3,7 +3,7 @@
|
|||
'name' => 'getkirby/plainkit',
|
||||
'pretty_version' => 'dev-main',
|
||||
'version' => 'dev-main',
|
||||
'reference' => 'c98d5eb36b266cd487fe00ac87df199591ee9baa',
|
||||
'reference' => '2f836dde20404d744d921c386213a0d7df13313a',
|
||||
'type' => 'project',
|
||||
'install_path' => __DIR__ . '/../../',
|
||||
'aliases' => array(),
|
||||
|
|
@ -46,6 +46,15 @@
|
|||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'getbrevo/brevo-php' => array(
|
||||
'pretty_version' => 'v2.0.2',
|
||||
'version' => '2.0.2.0',
|
||||
'reference' => 'd090995afd88ff9d6f1284d7f9adaff0c6a58949',
|
||||
'type' => 'library',
|
||||
'install_path' => __DIR__ . '/../getbrevo/brevo-php',
|
||||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'getkirby/cms' => array(
|
||||
'pretty_version' => '4.3.0',
|
||||
'version' => '4.3.0.0',
|
||||
|
|
@ -67,12 +76,39 @@
|
|||
'getkirby/plainkit' => array(
|
||||
'pretty_version' => 'dev-main',
|
||||
'version' => 'dev-main',
|
||||
'reference' => 'c98d5eb36b266cd487fe00ac87df199591ee9baa',
|
||||
'reference' => '2f836dde20404d744d921c386213a0d7df13313a',
|
||||
'type' => 'project',
|
||||
'install_path' => __DIR__ . '/../../',
|
||||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'guzzlehttp/guzzle' => array(
|
||||
'pretty_version' => '7.9.2',
|
||||
'version' => '7.9.2.0',
|
||||
'reference' => 'd281ed313b989f213357e3be1a179f02196ac99b',
|
||||
'type' => 'library',
|
||||
'install_path' => __DIR__ . '/../guzzlehttp/guzzle',
|
||||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'guzzlehttp/promises' => array(
|
||||
'pretty_version' => '2.0.3',
|
||||
'version' => '2.0.3.0',
|
||||
'reference' => '6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8',
|
||||
'type' => 'library',
|
||||
'install_path' => __DIR__ . '/../guzzlehttp/promises',
|
||||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'guzzlehttp/psr7' => array(
|
||||
'pretty_version' => '2.7.0',
|
||||
'version' => '2.7.0.0',
|
||||
'reference' => 'a70f5c95fb43bc83f07c9c948baa0dc1829bf201',
|
||||
'type' => 'library',
|
||||
'install_path' => __DIR__ . '/../guzzlehttp/psr7',
|
||||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'laminas/laminas-escaper' => array(
|
||||
'pretty_version' => '2.13.0',
|
||||
'version' => '2.13.0.0',
|
||||
|
|
@ -115,6 +151,51 @@
|
|||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'psr/http-client' => array(
|
||||
'pretty_version' => '1.0.3',
|
||||
'version' => '1.0.3.0',
|
||||
'reference' => 'bb5906edc1c324c9a05aa0873d40117941e5fa90',
|
||||
'type' => 'library',
|
||||
'install_path' => __DIR__ . '/../psr/http-client',
|
||||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'psr/http-client-implementation' => array(
|
||||
'dev_requirement' => false,
|
||||
'provided' => array(
|
||||
0 => '1.0',
|
||||
),
|
||||
),
|
||||
'psr/http-factory' => array(
|
||||
'pretty_version' => '1.1.0',
|
||||
'version' => '1.1.0.0',
|
||||
'reference' => '2b4765fddfe3b508ac62f829e852b1501d3f6e8a',
|
||||
'type' => 'library',
|
||||
'install_path' => __DIR__ . '/../psr/http-factory',
|
||||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'psr/http-factory-implementation' => array(
|
||||
'dev_requirement' => false,
|
||||
'provided' => array(
|
||||
0 => '1.0',
|
||||
),
|
||||
),
|
||||
'psr/http-message' => array(
|
||||
'pretty_version' => '2.0',
|
||||
'version' => '2.0.0.0',
|
||||
'reference' => '402d35bcb92c70c026d1a6a9883f06b2ead23d71',
|
||||
'type' => 'library',
|
||||
'install_path' => __DIR__ . '/../psr/http-message',
|
||||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'psr/http-message-implementation' => array(
|
||||
'dev_requirement' => false,
|
||||
'provided' => array(
|
||||
0 => '1.0',
|
||||
),
|
||||
),
|
||||
'psr/log' => array(
|
||||
'pretty_version' => '3.0.0',
|
||||
'version' => '3.0.0.0',
|
||||
|
|
@ -124,6 +205,15 @@
|
|||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'ralouphie/getallheaders' => array(
|
||||
'pretty_version' => '3.0.3',
|
||||
'version' => '3.0.3.0',
|
||||
'reference' => '120b605dfeb996808c31b6477290a714d356e822',
|
||||
'type' => 'library',
|
||||
'install_path' => __DIR__ . '/../ralouphie/getallheaders',
|
||||
'aliases' => array(),
|
||||
'dev_requirement' => false,
|
||||
),
|
||||
'symfony/deprecation-contracts' => array(
|
||||
'pretty_version' => 'v3.5.0',
|
||||
'version' => '3.5.0.0',
|
||||
|
|
|
|||
2
vendor/getbrevo/brevo-php/.gitignore
vendored
Normal file
2
vendor/getbrevo/brevo-php/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
.DS_Store
|
||||
vendor
|
||||
7
vendor/getbrevo/brevo-php/.travis.yml
vendored
Normal file
7
vendor/getbrevo/brevo-php/.travis.yml
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
language: php
|
||||
sudo: false
|
||||
php:
|
||||
- 5.6
|
||||
- 7.0
|
||||
before_install: "composer install"
|
||||
script: "vendor/bin/phpunit"
|
||||
30
vendor/getbrevo/brevo-php/CHANGELOG.md
vendored
Normal file
30
vendor/getbrevo/brevo-php/CHANGELOG.md
vendored
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# Changelog
|
||||
|
||||
## 1.0.3 (2024-03-08)
|
||||
- Modification in Get all the contacts, contact can be filtered by segmentId and listIds as well
|
||||
**segmentId** | **int**| Id of the segment. **Either listIds or segmentId can be passed.** | [optional]
|
||||
**listIds** | [**int[]**](../Model/int.md)| Ids of the list. **Either listIds or segmentId can be passed.** | [optional]
|
||||
- Modification in Get a list's details
|
||||
startDate and endDate (YYYY-MM-DDTHH:mm:ss.SSSZ) support added.
|
||||
- Get order details route added in eCommerceAPI
|
||||
- Below routes added MasterAccountAPI
|
||||
Update a group of sub-accounts
|
||||
Create a new group of sub-accounts
|
||||
- Below routes added In UsersApi
|
||||
Update permission for a user
|
||||
Send invitation to user
|
||||
Revoke user permission
|
||||
Resend / Cancel invitation
|
||||
- In Return all your created WhatsApp templates source parameters also now supported
|
||||
**source** | **string**| source of the template | [optional]
|
||||
|
||||
## 1.0.2 (2023-07-17)
|
||||
- Added Coupons route
|
||||
- Added **previewText** | **string** | Preview text or preheader of the email campaign | [optional]
|
||||
- language support for Whatsapp template creation
|
||||
- Making WhatsAppCampaignsApi PSR-4 compliant.
|
||||
|
||||
## 1.0.1 (2023-05-28)
|
||||
- API's changed from sendinblue.com domain to api brevo.com domain
|
||||
- For installation follow this process
|
||||
- Follow reference example in order to use this SDK
|
||||
21
vendor/getbrevo/brevo-php/LICENSE.md
vendored
Normal file
21
vendor/getbrevo/brevo-php/LICENSE.md
vendored
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2019 Brevo
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
725
vendor/getbrevo/brevo-php/README.md
vendored
Normal file
725
vendor/getbrevo/brevo-php/README.md
vendored
Normal file
|
|
@ -0,0 +1,725 @@
|
|||
# Brevo's API v3 Php Library
|
||||
|
||||
Brevo's API exposes the entire Brevo features via a standardized programmatic interface. Please refer to the full [documentation](https://developers.brevo.com) to learn more.
|
||||
|
||||
This is the wrapper for the API. It implements all the features of the API v3.
|
||||
|
||||
Brevo's API matches the [OpenAPI v2 definition](https://www.openapis.org/). The specification can be downloaded [here](https://api.brevo.com/v3/swagger_definition.yml).
|
||||
|
||||
This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by Brevo:
|
||||
|
||||
- API version: 3.0.0
|
||||
- Build package: io.swagger.codegen.languages.PhpClientCodegen
|
||||
For more information, please visit [https://account.brevo.com/support](https://account.brevo.com/support)
|
||||
|
||||
## Requirements
|
||||
|
||||
PHP 5.6 and later
|
||||
|
||||
## Installation & Usage
|
||||
### Composer
|
||||
|
||||
To install the bindings via [Composer](http://getcomposer.org/):
|
||||
|
||||
Create a ```composer.json``` file in any directory & add below code in composer.json file.
|
||||
|
||||
```
|
||||
{
|
||||
"require": {
|
||||
"getbrevo/brevo-php": "1.x.x"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then run below commands in the same directory
|
||||
```
|
||||
composer require getbrevo/brevo-php "1.x.x"
|
||||
```
|
||||
|
||||
Further do:
|
||||
* run ``composer install`` to get these dependencies added to your vendor directory
|
||||
* add the autoloader to your application with this line: ``require("vendor/autoload.php")``
|
||||
|
||||
|
||||
## Tests
|
||||
|
||||
To run the unit tests:
|
||||
|
||||
```
|
||||
composer install
|
||||
./vendor/bin/phpunit
|
||||
```
|
||||
|
||||
## Getting Started
|
||||
|
||||
Please follow the [installation procedure](#installation--usage) and then run the following:
|
||||
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\AccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getAccount();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
|
||||
?>
|
||||
```
|
||||
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*AccountApi* | [**getAccount**](docs/Api/AccountApi.md#getaccount) | **GET** /account | Get your account information, plan and credits details
|
||||
*AccountApi* | [**getAccountActivity**](docs/Api/AccountApi.md#getaccountactivity) | **GET** /organization/activities | Get user activity logs
|
||||
*CompaniesApi* | [**companiesAttributesGet**](docs/Api/CompaniesApi.md#companiesattributesget) | **GET** /companies/attributes | Get company attributes
|
||||
*CompaniesApi* | [**companiesGet**](docs/Api/CompaniesApi.md#companiesget) | **GET** /companies | Get all companies
|
||||
*CompaniesApi* | [**companiesIdDelete**](docs/Api/CompaniesApi.md#companiesiddelete) | **DELETE** /companies/{id} | Delete a company
|
||||
*CompaniesApi* | [**companiesIdGet**](docs/Api/CompaniesApi.md#companiesidget) | **GET** /companies/{id} | Get a company
|
||||
*CompaniesApi* | [**companiesIdPatch**](docs/Api/CompaniesApi.md#companiesidpatch) | **PATCH** /companies/{id} | Update a company
|
||||
*CompaniesApi* | [**companiesLinkUnlinkIdPatch**](docs/Api/CompaniesApi.md#companieslinkunlinkidpatch) | **PATCH** /companies/link-unlink/{id} | Link and Unlink company with contacts and deals
|
||||
*CompaniesApi* | [**companiesPost**](docs/Api/CompaniesApi.md#companiespost) | **POST** /companies | Create a company
|
||||
*AttributesApi* | [**createAttribute**](docs/Api/AttributesApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
||||
*AttributesApi* | [**deleteAttribute**](docs/Api/AttributesApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
||||
*AttributesApi* | [**getAttributes**](docs/Api/AttributesApi.md#getattributes) | **GET** /contacts/attributes | List all attributes
|
||||
*AttributesApi* | [**updateAttribute**](docs/Api/AttributesApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
||||
*CRMApi* | [**crmNotesGet**](docs/Api/CRMApi.md#crmnotesget) | **GET** /crm/notes | Get all notes
|
||||
*CRMApi* | [**crmNotesIdDelete**](docs/Api/CRMApi.md#crmnotesiddelete) | **DELETE** /crm/notes/{id} | Delete a note
|
||||
*CRMApi* | [**crmNotesIdGet**](docs/Api/CRMApi.md#crmnotesidget) | **GET** /crm/notes/{id} | Get a note
|
||||
*CRMApi* | [**crmNotesIdPatch**](docs/Api/CRMApi.md#crmnotesidpatch) | **PATCH** /crm/notes/{id} | Update a note
|
||||
*CRMApi* | [**crmNotesPost**](docs/Api/CRMApi.md#crmnotespost) | **POST** /crm/notes | Create a note
|
||||
*CRMApi* | [**crmTasksGet**](docs/Api/CRMApi.md#crmtasksget) | **GET** /crm/tasks | Get all tasks
|
||||
*CRMApi* | [**crmTasksIdDelete**](docs/Api/CRMApi.md#crmtasksiddelete) | **DELETE** /crm/tasks/{id} | Delete a task
|
||||
*CRMApi* | [**crmTasksIdGet**](docs/Api/CRMApi.md#crmtasksidget) | **GET** /crm/tasks/{id} | Get a task
|
||||
*CRMApi* | [**crmTasksIdPatch**](docs/Api/CRMApi.md#crmtasksidpatch) | **PATCH** /crm/tasks/{id} | Update a task
|
||||
*CRMApi* | [**crmTasksPost**](docs/Api/CRMApi.md#crmtaskspost) | **POST** /crm/tasks | Create a task
|
||||
*CRMApi* | [**crmTasktypesGet**](docs/Api/CRMApi.md#crmtasktypesget) | **GET** /crm/tasktypes | Get all task types
|
||||
*ContactsApi* | [**addContactToList**](docs/Api/ContactsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
||||
*ContactsApi* | [**createAttribute**](docs/Api/ContactsApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
||||
*ContactsApi* | [**createContact**](docs/Api/ContactsApi.md#createcontact) | **POST** /contacts | Create a contact
|
||||
*ContactsApi* | [**createDoiContact**](docs/Api/ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
|
||||
*ContactsApi* | [**createFolder**](docs/Api/ContactsApi.md#createfolder) | **POST** /contacts/folders | Create a folder
|
||||
*ContactsApi* | [**createList**](docs/Api/ContactsApi.md#createlist) | **POST** /contacts/lists | Create a list
|
||||
*ContactsApi* | [**deleteAttribute**](docs/Api/ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
||||
*ContactsApi* | [**deleteContact**](docs/Api/ContactsApi.md#deletecontact) | **DELETE** /contacts/{identifier} | Delete a contact
|
||||
*ContactsApi* | [**deleteFolder**](docs/Api/ContactsApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
||||
*ContactsApi* | [**deleteList**](docs/Api/ContactsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list
|
||||
*ContactsApi* | [**getAttributes**](docs/Api/ContactsApi.md#getattributes) | **GET** /contacts/attributes | List all attributes
|
||||
*ContactsApi* | [**getContactInfo**](docs/Api/ContactsApi.md#getcontactinfo) | **GET** /contacts/{identifier} | Get a contact's details
|
||||
*ContactsApi* | [**getContactStats**](docs/Api/ContactsApi.md#getcontactstats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
|
||||
*ContactsApi* | [**getContacts**](docs/Api/ContactsApi.md#getcontacts) | **GET** /contacts | Get all the contacts
|
||||
*ContactsApi* | [**getContactsFromList**](docs/Api/ContactsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
||||
*ContactsApi* | [**getFolder**](docs/Api/ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
||||
*ContactsApi* | [**getFolderLists**](docs/Api/ContactsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
||||
*ContactsApi* | [**getFolders**](docs/Api/ContactsApi.md#getfolders) | **GET** /contacts/folders | Get all folders
|
||||
*ContactsApi* | [**getList**](docs/Api/ContactsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details
|
||||
*ContactsApi* | [**getLists**](docs/Api/ContactsApi.md#getlists) | **GET** /contacts/lists | Get all the lists
|
||||
*ContactsApi* | [**getSegments**](docs/Api/ContactsApi.md#getsegments) | **GET** /contacts/segments | Get all the Segments
|
||||
*ContactsApi* | [**importContacts**](docs/Api/ContactsApi.md#importcontacts) | **POST** /contacts/import | Import contacts
|
||||
*ContactsApi* | [**removeContactFromList**](docs/Api/ContactsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
||||
*ContactsApi* | [**requestContactExport**](docs/Api/ContactsApi.md#requestcontactexport) | **POST** /contacts/export | Export contacts
|
||||
*ContactsApi* | [**updateAttribute**](docs/Api/ContactsApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
||||
*ContactsApi* | [**updateBatchContacts**](docs/Api/ContactsApi.md#updatebatchcontacts) | **POST** /contacts/batch | Update multiple contacts
|
||||
*ContactsApi* | [**updateContact**](docs/Api/ContactsApi.md#updatecontact) | **PUT** /contacts/{identifier} | Update a contact
|
||||
*ContactsApi* | [**updateFolder**](docs/Api/ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
||||
*ContactsApi* | [**updateList**](docs/Api/ContactsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list
|
||||
*ConversationsApi* | [**conversationsAgentOnlinePingPost**](docs/Api/ConversationsApi.md#conversationsagentonlinepingpost) | **POST** /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes
|
||||
*ConversationsApi* | [**conversationsMessagesIdDelete**](docs/Api/ConversationsApi.md#conversationsmessagesiddelete) | **DELETE** /conversations/messages/{id} | Delete a message sent by an agent
|
||||
*ConversationsApi* | [**conversationsMessagesIdGet**](docs/Api/ConversationsApi.md#conversationsmessagesidget) | **GET** /conversations/messages/{id} | Get a message
|
||||
*ConversationsApi* | [**conversationsMessagesIdPut**](docs/Api/ConversationsApi.md#conversationsmessagesidput) | **PUT** /conversations/messages/{id} | Update a message sent by an agent
|
||||
*ConversationsApi* | [**conversationsMessagesPost**](docs/Api/ConversationsApi.md#conversationsmessagespost) | **POST** /conversations/messages | Send a message as an agent
|
||||
*ConversationsApi* | [**conversationsPushedMessagesIdDelete**](docs/Api/ConversationsApi.md#conversationspushedmessagesiddelete) | **DELETE** /conversations/pushedMessages/{id} | Delete an automated message
|
||||
*ConversationsApi* | [**conversationsPushedMessagesIdGet**](docs/Api/ConversationsApi.md#conversationspushedmessagesidget) | **GET** /conversations/pushedMessages/{id} | Get an automated message
|
||||
*ConversationsApi* | [**conversationsPushedMessagesIdPut**](docs/Api/ConversationsApi.md#conversationspushedmessagesidput) | **PUT** /conversations/pushedMessages/{id} | Update an automated message
|
||||
*ConversationsApi* | [**conversationsPushedMessagesPost**](docs/Api/ConversationsApi.md#conversationspushedmessagespost) | **POST** /conversations/pushedMessages | Send an automated message to a visitor
|
||||
*CouponsApi* | [**createCouponCollection**](docs/Api/CouponsApi.md#createcouponcollection) | **POST** /couponCollections | Create а coupon collection
|
||||
*CouponsApi* | [**createCoupons**](docs/Api/CouponsApi.md#createcoupons) | **POST** /coupons | Create coupons for a coupon collection
|
||||
*CouponsApi* | [**getCouponCollection**](docs/Api/CouponsApi.md#getcouponcollection) | **GET** /couponCollections/{id} | Get a coupon collection by id
|
||||
*CouponsApi* | [**getCouponCollections**](docs/Api/CouponsApi.md#getcouponcollections) | **GET** /couponCollections | Get all your coupon collections
|
||||
*CouponsApi* | [**updateCouponCollection**](docs/Api/CouponsApi.md#updatecouponcollection) | **PATCH** /couponCollections/{id} | Update a coupon collection by id
|
||||
*DealsApi* | [**crmAttributesDealsGet**](docs/Api/DealsApi.md#crmattributesdealsget) | **GET** /crm/attributes/deals | Get deal attributes
|
||||
*DealsApi* | [**crmDealsGet**](docs/Api/DealsApi.md#crmdealsget) | **GET** /crm/deals | Get all deals
|
||||
*DealsApi* | [**crmDealsIdDelete**](docs/Api/DealsApi.md#crmdealsiddelete) | **DELETE** /crm/deals/{id} | Delete a deal
|
||||
*DealsApi* | [**crmDealsIdGet**](docs/Api/DealsApi.md#crmdealsidget) | **GET** /crm/deals/{id} | Get a deal
|
||||
*DealsApi* | [**crmDealsIdPatch**](docs/Api/DealsApi.md#crmdealsidpatch) | **PATCH** /crm/deals/{id} | Update a deal
|
||||
*DealsApi* | [**crmDealsLinkUnlinkIdPatch**](docs/Api/DealsApi.md#crmdealslinkunlinkidpatch) | **PATCH** /crm/deals/link-unlink/{id} | Link and Unlink a deal with contacts and companies
|
||||
*DealsApi* | [**crmDealsPost**](docs/Api/DealsApi.md#crmdealspost) | **POST** /crm/deals | Create a deal
|
||||
*DealsApi* | [**crmPipelineDetailsAllGet**](docs/Api/DealsApi.md#crmpipelinedetailsallget) | **GET** /crm/pipeline/details/all | Get all pipelines
|
||||
*DealsApi* | [**crmPipelineDetailsGet**](docs/Api/DealsApi.md#crmpipelinedetailsget) | **GET** /crm/pipeline/details | Get pipeline stages
|
||||
*DealsApi* | [**crmPipelineDetailsPipelineIDGet**](docs/Api/DealsApi.md#crmpipelinedetailspipelineidget) | **GET** /crm/pipeline/details/{pipelineID} | Get a pipeline
|
||||
*DomainsApi* | [**authenticateDomain**](docs/Api/DomainsApi.md#authenticatedomain) | **PUT** /senders/domains/{domainName}/authenticate | Authenticate a domain
|
||||
*DomainsApi* | [**createDomain**](docs/Api/DomainsApi.md#createdomain) | **POST** /senders/domains | Create a new domain
|
||||
*DomainsApi* | [**deleteDomain**](docs/Api/DomainsApi.md#deletedomain) | **DELETE** /senders/domains/{domainName} | Delete a domain
|
||||
*DomainsApi* | [**getDomainConfiguration**](docs/Api/DomainsApi.md#getdomainconfiguration) | **GET** /senders/domains/{domainName} | Validate domain configuration
|
||||
*DomainsApi* | [**getDomains**](docs/Api/DomainsApi.md#getdomains) | **GET** /senders/domains | Get the list of all your domains
|
||||
*EcommerceApi* | [**createBatchOrder**](docs/Api/EcommerceApi.md#createbatchorder) | **POST** /orders/status/batch | Create orders in batch
|
||||
*EcommerceApi* | [**createOrder**](docs/Api/EcommerceApi.md#createorder) | **POST** /orders/status | Managing the status of the order
|
||||
*EcommerceApi* | [**createUpdateBatchCategory**](docs/Api/EcommerceApi.md#createupdatebatchcategory) | **POST** /categories/batch | Create categories in batch
|
||||
*EcommerceApi* | [**createUpdateBatchProducts**](docs/Api/EcommerceApi.md#createupdatebatchproducts) | **POST** /products/batch | Create products in batch
|
||||
*EcommerceApi* | [**createUpdateCategory**](docs/Api/EcommerceApi.md#createupdatecategory) | **POST** /categories | Create/Update a category
|
||||
*EcommerceApi* | [**createUpdateProduct**](docs/Api/EcommerceApi.md#createupdateproduct) | **POST** /products | Create/Update a product
|
||||
*EcommerceApi* | [**ecommerceActivatePost**](docs/Api/EcommerceApi.md#ecommerceactivatepost) | **POST** /ecommerce/activate | Activate the eCommerce app
|
||||
*EcommerceApi* | [**getCategories**](docs/Api/EcommerceApi.md#getcategories) | **GET** /categories | Return all your categories
|
||||
*EcommerceApi* | [**getCategoryInfo**](docs/Api/EcommerceApi.md#getcategoryinfo) | **GET** /categories/{id} | Get a category details
|
||||
*EcommerceApi* | [**getOrders**](docs/Api/EcommerceApi.md#getorders) | **GET** /orders | Get order details
|
||||
*EcommerceApi* | [**getProductInfo**](docs/Api/EcommerceApi.md#getproductinfo) | **GET** /products/{id} | Get a product's details
|
||||
*EcommerceApi* | [**getProducts**](docs/Api/EcommerceApi.md#getproducts) | **GET** /products | Return all your products
|
||||
*EmailCampaignsApi* | [**createEmailCampaign**](docs/Api/EmailCampaignsApi.md#createemailcampaign) | **POST** /emailCampaigns | Create an email campaign
|
||||
*EmailCampaignsApi* | [**deleteEmailCampaign**](docs/Api/EmailCampaignsApi.md#deleteemailcampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
||||
*EmailCampaignsApi* | [**emailExportRecipients**](docs/Api/EmailCampaignsApi.md#emailexportrecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
|
||||
*EmailCampaignsApi* | [**getAbTestCampaignResult**](docs/Api/EmailCampaignsApi.md#getabtestcampaignresult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results
|
||||
*EmailCampaignsApi* | [**getEmailCampaign**](docs/Api/EmailCampaignsApi.md#getemailcampaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report
|
||||
*EmailCampaignsApi* | [**getEmailCampaigns**](docs/Api/EmailCampaignsApi.md#getemailcampaigns) | **GET** /emailCampaigns | Return all your created email campaigns
|
||||
*EmailCampaignsApi* | [**getSharedTemplateUrl**](docs/Api/EmailCampaignsApi.md#getsharedtemplateurl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
||||
*EmailCampaignsApi* | [**sendEmailCampaignNow**](docs/Api/EmailCampaignsApi.md#sendemailcampaignnow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
||||
*EmailCampaignsApi* | [**sendReport**](docs/Api/EmailCampaignsApi.md#sendreport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign
|
||||
*EmailCampaignsApi* | [**sendTestEmail**](docs/Api/EmailCampaignsApi.md#sendtestemail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
||||
*EmailCampaignsApi* | [**updateCampaignStatus**](docs/Api/EmailCampaignsApi.md#updatecampaignstatus) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
||||
*EmailCampaignsApi* | [**updateEmailCampaign**](docs/Api/EmailCampaignsApi.md#updateemailcampaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
||||
*EmailCampaignsApi* | [**uploadImageToGallery**](docs/Api/EmailCampaignsApi.md#uploadimagetogallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
||||
*EventsApi* | [**createEvent**](docs/Api/EventsApi.md#createEvent) | **POST** /events | Create an event
|
||||
*FoldersApi* | [**createFolder**](docs/Api/FoldersApi.md#createfolder) | **POST** /contacts/folders | Create a folder
|
||||
*FoldersApi* | [**deleteFolder**](docs/Api/FoldersApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
||||
*FoldersApi* | [**getFolder**](docs/Api/FoldersApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
||||
*FoldersApi* | [**getFolderLists**](docs/Api/FoldersApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
||||
*FoldersApi* | [**getFolders**](docs/Api/FoldersApi.md#getfolders) | **GET** /contacts/folders | Get all folders
|
||||
*FoldersApi* | [**updateFolder**](docs/Api/FoldersApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
||||
*ExternalFeedsApi* | [**createExternalFeed**](docs/Api/ExternalFeedsApi.md#createexternalfeed) | **POST** /feeds | Create an external feed
|
||||
*ExternalFeedsApi* | [**deleteExternalFeed**](docs/Api/ExternalFeedsApi.md#deleteexternalfeed) | **DELETE** /feeds/{uuid} | Delete an external feed
|
||||
*ExternalFeedsApi* | [**getAllExternalFeeds**](docs/Api/ExternalFeedsApi.md#getallexternalfeeds) | **GET** /feeds | Fetch all external feeds
|
||||
*ExternalFeedsApi* | [**getExternalFeedByUUID**](docs/Api/ExternalFeedsApi.md#getexternalfeedbyuuid) | **GET** /feeds/{uuid} | Get an external feed by UUID
|
||||
*ExternalFeedsApi* | [**updateExternalFeed**](docs/Api/ExternalFeedsApi.md#updateexternalfeed) | **PUT** /feeds/{uuid} | Update an external feed
|
||||
*FilesApi* | [**crmFilesGet**](docs/Api/FilesApi.md#crmfilesget) | **GET** /crm/files | Get all files
|
||||
*FilesApi* | [**crmFilesIdDataGet**](docs/Api/FilesApi.md#crmfilesiddataget) | **GET** /crm/files/{id}/data | Get file details
|
||||
*FilesApi* | [**crmFilesIdDelete**](docs/Api/FilesApi.md#crmfilesiddelete) | **DELETE** /crm/files/{id} | Delete a file
|
||||
*FilesApi* | [**crmFilesIdGet**](docs/Api/FilesApi.md#crmfilesidget) | **GET** /crm/files/{id} | Download a file
|
||||
*FilesApi* | [**crmFilesPost**](docs/Api/FilesApi.md#crmfilespost) | **POST** /crm/files | Upload a file
|
||||
*InboundParsingApi* | [**getInboundEmailAttachment**](docs/Api/InboundParsingApi.md#getinboundemailattachment) | **GET** /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token.
|
||||
*InboundParsingApi* | [**getInboundEmailEvents**](docs/Api/InboundParsingApi.md#getinboundemailevents) | **GET** /inbound/events | Get the list of all the events for the received emails.
|
||||
*InboundParsingApi* | [**getInboundEmailEventsByUuid**](docs/Api/InboundParsingApi.md#getinboundemaileventsbyuuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email.
|
||||
*ListsApi* | [**addContactToList**](docs/Api/ListsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
||||
*ListsApi* | [**createList**](docs/Api/ListsApi.md#createlist) | **POST** /contacts/lists | Create a list
|
||||
*ListsApi* | [**deleteList**](docs/Api/ListsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list
|
||||
*ListsApi* | [**getContactsFromList**](docs/Api/ListsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
||||
*ListsApi* | [**getFolderLists**](docs/Api/ListsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
||||
*ListsApi* | [**getList**](docs/Api/ListsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details
|
||||
*ListsApi* | [**getLists**](docs/Api/ListsApi.md#getlists) | **GET** /contacts/lists | Get all the lists
|
||||
*ListsApi* | [**removeContactFromList**](docs/Api/ListsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
||||
*ListsApi* | [**updateList**](docs/Api/ListsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list
|
||||
*MasterAccountApi* | [**corporateGroupIdPut**](docs/Api/MasterAccountApi.md#corporategroupidput) | **PUT** /corporate/group/{id} | Update a group of sub-accounts
|
||||
*MasterAccountApi* | [**corporateGroupPost**](docs/Api/MasterAccountApi.md#corporategrouppost) | **POST** /corporate/group | Create a new group of sub-accounts
|
||||
*MasterAccountApi* | [**corporateMasterAccountGet**](docs/Api/MasterAccountApi.md#corporatemasteraccountget) | **GET** /corporate/masterAccount | Get the details of requested master account
|
||||
*MasterAccountApi* | [**corporateSubAccountGet**](docs/Api/MasterAccountApi.md#corporatesubaccountget) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
|
||||
*MasterAccountApi* | [**corporateSubAccountIdApplicationsTogglePut**](docs/Api/MasterAccountApi.md#corporatesubaccountidapplicationstoggleput) | **PUT** /corporate/subAccount/{id}/applications/toggle | Enable/disable sub-account application(s)
|
||||
*MasterAccountApi* | [**corporateSubAccountIdDelete**](docs/Api/MasterAccountApi.md#corporatesubaccountiddelete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
|
||||
*MasterAccountApi* | [**corporateSubAccountIdGet**](docs/Api/MasterAccountApi.md#corporatesubaccountidget) | **GET** /corporate/subAccount/{id} | Get sub-account details
|
||||
*MasterAccountApi* | [**corporateSubAccountIdPlanPut**](docs/Api/MasterAccountApi.md#corporatesubaccountidplanput) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
|
||||
*MasterAccountApi* | [**corporateSubAccountKeyPost**](docs/Api/MasterAccountApi.md#corporatesubaccountkeypost) | **POST** /corporate/subAccount/key | Create an API key for a sub-account
|
||||
*MasterAccountApi* | [**corporateSubAccountPost**](docs/Api/MasterAccountApi.md#corporatesubaccountpost) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
|
||||
*MasterAccountApi* | [**corporateSubAccountSsoTokenPost**](docs/Api/MasterAccountApi.md#corporatesubaccountssotokenpost) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Brevo
|
||||
*MasterAccountApi* | [**corporateUserRevokeEmailDelete**](docs/Api/MasterAccountApi.md#corporateuserrevokeemaildelete) | **DELETE** /corporate/user/revoke/{email} | Revoke an admin user
|
||||
*MasterAccountApi* | [**getAccountActivity**](docs/Api/MasterAccountApi.md#getaccountactivity) | **GET** /organization/activities | Get user activity logs
|
||||
*MasterAccountApi* | [**getCorporateInvitedUsersList**](docs/Api/MasterAccountApi.md#getcorporateinviteduserslist) | **GET** /corporate/invited/users | Get the list of all admin users
|
||||
*MasterAccountApi* | [**getSubAccountGroups**](docs/Api/MasterAccountApi.md#getsubaccountgroups) | **GET** /corporate/groups | Get the list of groups
|
||||
*MasterAccountApi* | [**inviteAdminUser**](docs/Api/MasterAccountApi.md#inviteadminuser) | **POST** /corporate/user/invitation/send | Send invitation to an admin user
|
||||
*NotesApi* | [**crmNotesGet**](docs/Api/NotesApi.md#crmnotesget) | **GET** /crm/notes | Get all notes
|
||||
*NotesApi* | [**crmNotesIdDelete**](docs/Api/NotesApi.md#crmnotesiddelete) | **DELETE** /crm/notes/{id} | Delete a note
|
||||
*NotesApi* | [**crmNotesIdGet**](docs/Api/NotesApi.md#crmnotesidget) | **GET** /crm/notes/{id} | Get a note
|
||||
*NotesApi* | [**crmNotesIdPatch**](docs/Api/NotesApi.md#crmnotesidpatch) | **PATCH** /crm/notes/{id} | Update a note
|
||||
*NotesApi* | [**crmNotesPost**](docs/Api/NotesApi.md#crmnotespost) | **POST** /crm/notes | Create a note
|
||||
*ProcessApi* | [**getProcess**](docs/Api/ProcessApi.md#getprocess) | **GET** /processes/{processId} | Return the informations for a process
|
||||
*ProcessApi* | [**getProcesses**](docs/Api/ProcessApi.md#getprocesses) | **GET** /processes | Return all the processes for your account
|
||||
*ResellerApi* | [**addCredits**](docs/Api/ResellerApi.md#addcredits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account
|
||||
*ResellerApi* | [**associateIpToChild**](docs/Api/ResellerApi.md#associateiptochild) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child
|
||||
*ResellerApi* | [**createChildDomain**](docs/Api/ResellerApi.md#createchilddomain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account
|
||||
*ResellerApi* | [**createResellerChild**](docs/Api/ResellerApi.md#createresellerchild) | **POST** /reseller/children | Creates a reseller child
|
||||
*ResellerApi* | [**deleteChildDomain**](docs/Api/ResellerApi.md#deletechilddomain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
||||
*ResellerApi* | [**deleteResellerChild**](docs/Api/ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied
|
||||
*ResellerApi* | [**dissociateIpFromChild**](docs/Api/ResellerApi.md#dissociateipfromchild) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child
|
||||
*ResellerApi* | [**getChildAccountCreationStatus**](docs/Api/ResellerApi.md#getchildaccountcreationstatus) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
||||
*ResellerApi* | [**getChildDomains**](docs/Api/ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account
|
||||
*ResellerApi* | [**getChildInfo**](docs/Api/ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childIdentifier} | Get a child account's details
|
||||
*ResellerApi* | [**getResellerChilds**](docs/Api/ResellerApi.md#getresellerchilds) | **GET** /reseller/children | Get the list of all children accounts
|
||||
*ResellerApi* | [**getSsoToken**](docs/Api/ResellerApi.md#getssotoken) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Brevo (SSO)
|
||||
*ResellerApi* | [**removeCredits**](docs/Api/ResellerApi.md#removecredits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account
|
||||
*ResellerApi* | [**updateChildAccountStatus**](docs/Api/ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied
|
||||
*ResellerApi* | [**updateChildDomain**](docs/Api/ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
||||
*ResellerApi* | [**updateResellerChild**](docs/Api/ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied
|
||||
*SMSCampaignsApi* | [**createSmsCampaign**](docs/Api/SMSCampaignsApi.md#createsmscampaign) | **POST** /smsCampaigns | Creates an SMS campaign
|
||||
*SMSCampaignsApi* | [**deleteSmsCampaign**](docs/Api/SMSCampaignsApi.md#deletesmscampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
|
||||
*SMSCampaignsApi* | [**getSmsCampaign**](docs/Api/SMSCampaignsApi.md#getsmscampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
|
||||
*SMSCampaignsApi* | [**getSmsCampaigns**](docs/Api/SMSCampaignsApi.md#getsmscampaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
|
||||
*SMSCampaignsApi* | [**requestSmsRecipientExport**](docs/Api/SMSCampaignsApi.md#requestsmsrecipientexport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
|
||||
*SMSCampaignsApi* | [**sendSmsCampaignNow**](docs/Api/SMSCampaignsApi.md#sendsmscampaignnow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
|
||||
*SMSCampaignsApi* | [**sendSmsReport**](docs/Api/SMSCampaignsApi.md#sendsmsreport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
|
||||
*SMSCampaignsApi* | [**sendTestSms**](docs/Api/SMSCampaignsApi.md#sendtestsms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
|
||||
*SMSCampaignsApi* | [**updateSmsCampaign**](docs/Api/SMSCampaignsApi.md#updatesmscampaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
|
||||
*SMSCampaignsApi* | [**updateSmsCampaignStatus**](docs/Api/SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
|
||||
*SendersApi* | [**createSender**](docs/Api/SendersApi.md#createsender) | **POST** /senders | Create a new sender
|
||||
*SendersApi* | [**deleteSender**](docs/Api/SendersApi.md#deletesender) | **DELETE** /senders/{senderId} | Delete a sender
|
||||
*SendersApi* | [**getIps**](docs/Api/SendersApi.md#getips) | **GET** /senders/ips | Get all the dedicated IPs for your account
|
||||
*SendersApi* | [**getIpsFromSender**](docs/Api/SendersApi.md#getipsfromsender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
|
||||
*SendersApi* | [**getSenders**](docs/Api/SendersApi.md#getsenders) | **GET** /senders | Get the list of all your senders
|
||||
*SendersApi* | [**updateSender**](docs/Api/SendersApi.md#updatesender) | **PUT** /senders/{senderId} | Update a sender
|
||||
*SendersApi* | [**validateSenderByOTP**](docs/Api/SendersApi.md#validatesenderbyotp) | **PUT** /senders/{senderId}/validate | Update a sender
|
||||
*TasksApi* | [**crmTasksGet**](docs/Api/TasksApi.md#crmtasksget) | **GET** /crm/tasks | Get all tasks
|
||||
*TasksApi* | [**crmTasksIdDelete**](docs/Api/TasksApi.md#crmtasksiddelete) | **DELETE** /crm/tasks/{id} | Delete a task
|
||||
*TasksApi* | [**crmTasksIdGet**](docs/Api/TasksApi.md#crmtasksidget) | **GET** /crm/tasks/{id} | Get a task
|
||||
*TasksApi* | [**crmTasksIdPatch**](docs/Api/TasksApi.md#crmtasksidpatch) | **PATCH** /crm/tasks/{id} | Update a task
|
||||
*TasksApi* | [**crmTasksPost**](docs/Api/TasksApi.md#crmtaskspost) | **POST** /crm/tasks | Create a task
|
||||
*TasksApi* | [**crmTasktypesGet**](docs/Api/TasksApi.md#crmtasktypesget) | **GET** /crm/tasktypes | Get all task types
|
||||
*TransactionalEmailsApi* | [**blockNewDomain**](docs/Api/TransactionalEmailsApi.md#blocknewdomain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
|
||||
*TransactionalEmailsApi* | [**createSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#createsmtptemplate) | **POST** /smtp/templates | Create an email template
|
||||
*TransactionalEmailsApi* | [**deleteBlockedDomain**](docs/Api/TransactionalEmailsApi.md#deleteblockeddomain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
|
||||
*TransactionalEmailsApi* | [**deleteHardbounces**](docs/Api/TransactionalEmailsApi.md#deletehardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
||||
*TransactionalEmailsApi* | [**deleteScheduledEmailById**](docs/Api/TransactionalEmailsApi.md#deletescheduledemailbyid) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
|
||||
*TransactionalEmailsApi* | [**deleteSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
||||
*TransactionalEmailsApi* | [**getAggregatedSmtpReport**](docs/Api/TransactionalEmailsApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
||||
*TransactionalEmailsApi* | [**getBlockedDomains**](docs/Api/TransactionalEmailsApi.md#getblockeddomains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
|
||||
*TransactionalEmailsApi* | [**getEmailEventReport**](docs/Api/TransactionalEmailsApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
||||
*TransactionalEmailsApi* | [**getScheduledEmailByBatchId**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbybatchid) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
|
||||
*TransactionalEmailsApi* | [**getScheduledEmailByMessageId**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbymessageid) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
|
||||
*TransactionalEmailsApi* | [**getSmtpReport**](docs/Api/TransactionalEmailsApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
||||
*TransactionalEmailsApi* | [**getSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template information
|
||||
*TransactionalEmailsApi* | [**getSmtpTemplates**](docs/Api/TransactionalEmailsApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of email templates
|
||||
*TransactionalEmailsApi* | [**getTransacBlockedContacts**](docs/Api/TransactionalEmailsApi.md#gettransacblockedcontacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
|
||||
*TransactionalEmailsApi* | [**getTransacEmailContent**](docs/Api/TransactionalEmailsApi.md#gettransacemailcontent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
||||
*TransactionalEmailsApi* | [**getTransacEmailsList**](docs/Api/TransactionalEmailsApi.md#gettransacemailslist) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
||||
*TransactionalEmailsApi* | [**sendTestTemplate**](docs/Api/TransactionalEmailsApi.md#sendtesttemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
||||
*TransactionalEmailsApi* | [**sendTransacEmail**](docs/Api/TransactionalEmailsApi.md#sendtransacemail) | **POST** /smtp/email | Send a transactional email
|
||||
*TransactionalEmailsApi* | [**smtpBlockedContactsEmailDelete**](docs/Api/TransactionalEmailsApi.md#smtpblockedcontactsemaildelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
||||
*TransactionalEmailsApi* | [**smtpLogIdentifierDelete**](docs/Api/TransactionalEmailsApi.md#smtplogidentifierdelete) | **DELETE** /smtp/log/{identifier} | Delete an SMTP transactional log
|
||||
*TransactionalEmailsApi* | [**updateSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#updatesmtptemplate) | **PUT** /smtp/templates/{templateId} | Update an email template
|
||||
*TransactionalSMSApi* | [**getSmsEvents**](docs/Api/TransactionalSMSApi.md#getsmsevents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
|
||||
*TransactionalSMSApi* | [**getTransacAggregatedSmsReport**](docs/Api/TransactionalSMSApi.md#gettransacaggregatedsmsreport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
|
||||
*TransactionalSMSApi* | [**getTransacSmsReport**](docs/Api/TransactionalSMSApi.md#gettransacsmsreport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
|
||||
*TransactionalSMSApi* | [**sendTransacSms**](docs/Api/TransactionalSMSApi.md#sendtransacsms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
|
||||
*TransactionalWhatsAppApi* | [**getWhatsappEventReport**](docs/Api/TransactionalWhatsAppApi.md#getwhatsappeventreport) | **GET** /whatsapp/statistics/events | Get all your WhatsApp activity (unaggregated events)
|
||||
*TransactionalWhatsAppApi* | [**sendWhatsappMessage**](docs/Api/TransactionalWhatsAppApi.md#sendwhatsappmessage) | **POST** /whatsapp/sendMessage | Send a WhatsApp message
|
||||
*UserApi* | [**editUserPermission**](docs/Api/UserApi.md#edituserpermission) | **POST** /organization/user/update/permissions | Update permission for a user
|
||||
*UserApi* | [**getInvitedUsersList**](docs/Api/UserApi.md#getinviteduserslist) | **GET** /organization/invited/users | Get the list of all your users
|
||||
*UserApi* | [**getUserPermission**](docs/Api/UserApi.md#getuserpermission) | **GET** /organization/user/{email}/permissions | Check user permission
|
||||
*UserApi* | [**inviteuser**](docs/Api/UserApi.md#inviteuser) | **POST** /organization/user/invitation/send | Send invitation to user
|
||||
*UserApi* | [**putRevokeUserPermission**](docs/Api/UserApi.md#putrevokeuserpermission) | **PUT** /organization/user/invitation/revoke/{email} | Revoke user permission
|
||||
*UserApi* | [**putresendcancelinvitation**](docs/Api/UserApi.md#putresendcancelinvitation) | **PUT** /organization/user/invitation/{action}/{email} | Resend / Cancel invitation
|
||||
*WebhooksApi* | [**createWebhook**](docs/Api/WebhooksApi.md#createwebhook) | **POST** /webhooks | Create a webhook
|
||||
*WebhooksApi* | [**deleteWebhook**](docs/Api/WebhooksApi.md#deletewebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
|
||||
*WebhooksApi* | [**exportWebhooksHistory**](docs/Api/WebhooksApi.md#exportwebhookshistory) | **POST** /webhooks/export | Export all webhook events
|
||||
*WebhooksApi* | [**getWebhook**](docs/Api/WebhooksApi.md#getwebhook) | **GET** /webhooks/{webhookId} | Get a webhook details
|
||||
*WebhooksApi* | [**getWebhooks**](docs/Api/WebhooksApi.md#getwebhooks) | **GET** /webhooks | Get all webhooks
|
||||
*WebhooksApi* | [**updateWebhook**](docs/Api/WebhooksApi.md#updatewebhook) | **PUT** /webhooks/{webhookId} | Update a webhook
|
||||
*WhatsAppCampaignsApi* | [**createWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#createwhatsappcampaign) | **POST** /whatsappCampaigns | Create and Send a WhatsApp campaign
|
||||
*WhatsAppCampaignsApi* | [**createWhatsAppTemplate**](docs/Api/WhatsAppCampaignsApi.md#createwhatsapptemplate) | **POST** /whatsppCampaigns/template | Create a WhatsApp template
|
||||
*WhatsAppCampaignsApi* | [**deleteWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#deletewhatsappcampaign) | **DELETE** /whatsappCampaigns/{campaignId} | Delete a WhatsApp campaign
|
||||
*WhatsAppCampaignsApi* | [**getWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#getwhatsappcampaign) | **GET** /whatsappCampaigns/{campaignId} | Get a WhatsApp campaign
|
||||
*WhatsAppCampaignsApi* | [**getWhatsAppCampaigns**](docs/Api/WhatsAppCampaignsApi.md#getwhatsappcampaigns) | **GET** /whatsappCampaigns | Return all your created WhatsApp campaigns
|
||||
*WhatsAppCampaignsApi* | [**getWhatsAppConfig**](docs/Api/WhatsAppCampaignsApi.md#getwhatsappconfig) | **GET** /whatsappCampaigns/config | Get your WhatsApp API account information
|
||||
*WhatsAppCampaignsApi* | [**getWhatsAppTemplates**](docs/Api/WhatsAppCampaignsApi.md#getwhatsapptemplates) | **GET** /whatsappCampaigns/template-list | Return all your created WhatsApp templates
|
||||
*WhatsAppCampaignsApi* | [**sendWhatsAppTemplateApproval**](docs/Api/WhatsAppCampaignsApi.md#sendwhatsapptemplateapproval) | **POST** /whatsappCampaigns/template/approval/{templateId} | Send your WhatsApp template for approval
|
||||
*WhatsAppCampaignsApi* | [**updateWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#updatewhatsappcampaign) | **PUT** /whatsappCampaigns/{campaignId} | Update a WhatsApp campaign
|
||||
|
||||
|
||||
## Documentation For Models
|
||||
|
||||
- [AbTestCampaignResult](docs/Model/AbTestCampaignResult.md)
|
||||
- [AbTestCampaignResultClickedLinks](docs/Model/AbTestCampaignResultClickedLinks.md)
|
||||
- [AbTestCampaignResultStatistics](docs/Model/AbTestCampaignResultStatistics.md)
|
||||
- [AbTestVersionClicks](docs/Model/AbTestVersionClicks.md)
|
||||
- [AbTestVersionClicksInner](docs/Model/AbTestVersionClicksInner.md)
|
||||
- [AbTestVersionStats](docs/Model/AbTestVersionStats.md)
|
||||
- [AddChildDomain](docs/Model/AddChildDomain.md)
|
||||
- [AddContactToList](docs/Model/AddContactToList.md)
|
||||
- [AddCredits](docs/Model/AddCredits.md)
|
||||
- [AuthenticateDomainModel](docs/Model/AuthenticateDomainModel.md)
|
||||
- [BlockDomain](docs/Model/BlockDomain.md)
|
||||
- [Body](docs/Model/Body.md)
|
||||
- [Body1](docs/Model/Body1.md)
|
||||
- [Body10](docs/Model/Body10.md)
|
||||
- [Body11](docs/Model/Body11.md)
|
||||
- [Body12](docs/Model/Body12.md)
|
||||
- [Body13](docs/Model/Body13.md)
|
||||
- [Body14](docs/Model/Body14.md)
|
||||
- [Body2](docs/Model/Body2.md)
|
||||
- [Body3](docs/Model/Body3.md)
|
||||
- [Body4](docs/Model/Body4.md)
|
||||
- [Body5](docs/Model/Body5.md)
|
||||
- [Body6](docs/Model/Body6.md)
|
||||
- [Body7](docs/Model/Body7.md)
|
||||
- [Body8](docs/Model/Body8.md)
|
||||
- [Body9](docs/Model/Body9.md)
|
||||
- [BodyVariablesItems](docs/Model/BodyVariablesItems.md)
|
||||
- [CompaniesList](docs/Model/CompaniesList.md)
|
||||
- [Company](docs/Model/Company.md)
|
||||
- [CompanyAttributes](docs/Model/CompanyAttributes.md)
|
||||
- [CompanyAttributesInner](docs/Model/CompanyAttributesInner.md)
|
||||
- [ComponentItems](docs/Model/ComponentItems.md)
|
||||
- [ConversationsMessage](docs/Model/ConversationsMessage.md)
|
||||
- [ConversationsMessageFile](docs/Model/ConversationsMessageFile.md)
|
||||
- [ConversationsMessageFileImageInfo](docs/Model/ConversationsMessageFileImageInfo.md)
|
||||
- [CreateApiKeyRequest](docs/Model/CreateApiKeyRequest.md)
|
||||
- [CreateApiKeyResponse](docs/Model/CreateApiKeyResponse.md)
|
||||
- [CreateAttribute](docs/Model/CreateAttribute.md)
|
||||
- [CreateAttributeEnumeration](docs/Model/CreateAttributeEnumeration.md)
|
||||
- [CreateCategoryModel](docs/Model/CreateCategoryModel.md)
|
||||
- [CreateChild](docs/Model/CreateChild.md)
|
||||
- [CreateContact](docs/Model/CreateContact.md)
|
||||
- [CreateCouponCollection](docs/Model/CreateCouponCollection.md)
|
||||
- [CreateCoupons](docs/Model/CreateCoupons.md)
|
||||
- [CreateDoiContact](docs/Model/CreateDoiContact.md)
|
||||
- [CreateDomain](docs/Model/CreateDomain.md)
|
||||
- [CreateDomainModel](docs/Model/CreateDomainModel.md)
|
||||
- [CreateDomainModelDnsRecords](docs/Model/CreateDomainModelDnsRecords.md)
|
||||
- [CreateDomainModelDnsRecordsDkimRecord](docs/Model/CreateDomainModelDnsRecordsDkimRecord.md)
|
||||
- [CreateEmailCampaign](docs/Model/CreateEmailCampaign.md)
|
||||
- [CreateEmailCampaignRecipients](docs/Model/CreateEmailCampaignRecipients.md)
|
||||
- [CreateEmailCampaignSender](docs/Model/CreateEmailCampaignSender.md)
|
||||
- [CreateExternalFeed](docs/Model/CreateExternalFeed.md)
|
||||
- [CreateList](docs/Model/CreateList.md)
|
||||
- [CreateModel](docs/Model/CreateModel.md)
|
||||
- [CreateProductModel](docs/Model/CreateProductModel.md)
|
||||
- [CreateReseller](docs/Model/CreateReseller.md)
|
||||
- [CreateSender](docs/Model/CreateSender.md)
|
||||
- [CreateSenderIps](docs/Model/CreateSenderIps.md)
|
||||
- [CreateSenderModel](docs/Model/CreateSenderModel.md)
|
||||
- [CreateSmsCampaign](docs/Model/CreateSmsCampaign.md)
|
||||
- [CreateSmsCampaignRecipients](docs/Model/CreateSmsCampaignRecipients.md)
|
||||
- [CreateSmtpEmail](docs/Model/CreateSmtpEmail.md)
|
||||
- [CreateSmtpTemplate](docs/Model/CreateSmtpTemplate.md)
|
||||
- [CreateSmtpTemplateSender](docs/Model/CreateSmtpTemplateSender.md)
|
||||
- [CreateSubAccount](docs/Model/CreateSubAccount.md)
|
||||
- [CreateSubAccountResponse](docs/Model/CreateSubAccountResponse.md)
|
||||
- [CreateUpdateBatchCategory](docs/Model/CreateUpdateBatchCategory.md)
|
||||
- [CreateUpdateBatchCategoryModel](docs/Model/CreateUpdateBatchCategoryModel.md)
|
||||
- [CreateUpdateBatchProducts](docs/Model/CreateUpdateBatchProducts.md)
|
||||
- [CreateUpdateBatchProductsModel](docs/Model/CreateUpdateBatchProductsModel.md)
|
||||
- [CreateUpdateCategories](docs/Model/CreateUpdateCategories.md)
|
||||
- [CreateUpdateCategory](docs/Model/CreateUpdateCategory.md)
|
||||
- [CreateUpdateContactModel](docs/Model/CreateUpdateContactModel.md)
|
||||
- [CreateUpdateFolder](docs/Model/CreateUpdateFolder.md)
|
||||
- [CreateUpdateProduct](docs/Model/CreateUpdateProduct.md)
|
||||
- [CreateUpdateProducts](docs/Model/CreateUpdateProducts.md)
|
||||
- [CreateWebhook](docs/Model/CreateWebhook.md)
|
||||
- [CreateWhatsAppCampaign](docs/Model/CreateWhatsAppCampaign.md)
|
||||
- [CreateWhatsAppCampaignRecipients](docs/Model/CreateWhatsAppCampaignRecipients.md)
|
||||
- [CreateWhatsAppTemplate](docs/Model/CreateWhatsAppTemplate.md)
|
||||
- [CreatedBatchId](docs/Model/CreatedBatchId.md)
|
||||
- [CreatedProcessId](docs/Model/CreatedProcessId.md)
|
||||
- [Deal](docs/Model/Deal.md)
|
||||
- [DealAttributes](docs/Model/DealAttributes.md)
|
||||
- [DealAttributesInner](docs/Model/DealAttributesInner.md)
|
||||
- [DealsList](docs/Model/DealsList.md)
|
||||
- [DeleteHardbounces](docs/Model/DeleteHardbounces.md)
|
||||
- [EmailExportRecipients](docs/Model/EmailExportRecipients.md)
|
||||
- [ErrorModel](docs/Model/ErrorModel.md)
|
||||
- [Event](docs/Model/Event.md)
|
||||
- [ExportWebhooksHistory](docs/Model/ExportWebhooksHistory.md)
|
||||
- [FileData](docs/Model/FileData.md)
|
||||
- [FileDownloadableLink](docs/Model/FileDownloadableLink.md)
|
||||
- [FileList](docs/Model/FileList.md)
|
||||
- [GetAccount](docs/Model/GetAccount.md)
|
||||
- [GetAccountActivity](docs/Model/GetAccountActivity.md)
|
||||
- [GetAccountActivityLogs](docs/Model/GetAccountActivityLogs.md)
|
||||
- [GetAccountMarketingAutomation](docs/Model/GetAccountMarketingAutomation.md)
|
||||
- [GetAccountPlan](docs/Model/GetAccountPlan.md)
|
||||
- [GetAccountRelay](docs/Model/GetAccountRelay.md)
|
||||
- [GetAccountRelayData](docs/Model/GetAccountRelayData.md)
|
||||
- [GetAggregatedReport](docs/Model/GetAggregatedReport.md)
|
||||
- [GetAllExternalFeeds](docs/Model/GetAllExternalFeeds.md)
|
||||
- [GetAllExternalFeedsFeeds](docs/Model/GetAllExternalFeedsFeeds.md)
|
||||
- [GetAttributes](docs/Model/GetAttributes.md)
|
||||
- [GetAttributesAttributes](docs/Model/GetAttributesAttributes.md)
|
||||
- [GetAttributesEnumeration](docs/Model/GetAttributesEnumeration.md)
|
||||
- [GetBlockedDomains](docs/Model/GetBlockedDomains.md)
|
||||
- [GetCampaignOverview](docs/Model/GetCampaignOverview.md)
|
||||
- [GetCampaignRecipients](docs/Model/GetCampaignRecipients.md)
|
||||
- [GetCampaignStats](docs/Model/GetCampaignStats.md)
|
||||
- [GetCategories](docs/Model/GetCategories.md)
|
||||
- [GetCategoryDetails](docs/Model/GetCategoryDetails.md)
|
||||
- [GetChildAccountCreationStatus](docs/Model/GetChildAccountCreationStatus.md)
|
||||
- [GetChildDomain](docs/Model/GetChildDomain.md)
|
||||
- [GetChildDomains](docs/Model/GetChildDomains.md)
|
||||
- [GetChildInfo](docs/Model/GetChildInfo.md)
|
||||
- [GetChildInfoApiKeys](docs/Model/GetChildInfoApiKeys.md)
|
||||
- [GetChildInfoApiKeysV2](docs/Model/GetChildInfoApiKeysV2.md)
|
||||
- [GetChildInfoApiKeysV3](docs/Model/GetChildInfoApiKeysV3.md)
|
||||
- [GetChildInfoCredits](docs/Model/GetChildInfoCredits.md)
|
||||
- [GetChildInfoStatistics](docs/Model/GetChildInfoStatistics.md)
|
||||
- [GetChildrenList](docs/Model/GetChildrenList.md)
|
||||
- [GetClient](docs/Model/GetClient.md)
|
||||
- [GetContactCampaignStats](docs/Model/GetContactCampaignStats.md)
|
||||
- [GetContactCampaignStatsClicked](docs/Model/GetContactCampaignStatsClicked.md)
|
||||
- [GetContactCampaignStatsOpened](docs/Model/GetContactCampaignStatsOpened.md)
|
||||
- [GetContactCampaignStatsTransacAttributes](docs/Model/GetContactCampaignStatsTransacAttributes.md)
|
||||
- [GetContactCampaignStatsUnsubscriptions](docs/Model/GetContactCampaignStatsUnsubscriptions.md)
|
||||
- [GetContactDetails](docs/Model/GetContactDetails.md)
|
||||
- [GetContacts](docs/Model/GetContacts.md)
|
||||
- [GetCorporateInvitedUsersList](docs/Model/GetCorporateInvitedUsersList.md)
|
||||
- [GetCorporateInvitedUsersListFeatureAccess](docs/Model/GetCorporateInvitedUsersListFeatureAccess.md)
|
||||
- [GetCorporateInvitedUsersListGroups](docs/Model/GetCorporateInvitedUsersListGroups.md)
|
||||
- [GetCorporateInvitedUsersListUsers](docs/Model/GetCorporateInvitedUsersListUsers.md)
|
||||
- [GetCouponCollection](docs/Model/GetCouponCollection.md)
|
||||
- [GetDeviceBrowserStats](docs/Model/GetDeviceBrowserStats.md)
|
||||
- [GetDomainConfigurationModel](docs/Model/GetDomainConfigurationModel.md)
|
||||
- [GetDomainsList](docs/Model/GetDomainsList.md)
|
||||
- [GetDomainsListDomains](docs/Model/GetDomainsListDomains.md)
|
||||
- [GetEmailCampaign](docs/Model/GetEmailCampaign.md)
|
||||
- [GetEmailCampaigns](docs/Model/GetEmailCampaigns.md)
|
||||
- [GetEmailEventReport](docs/Model/GetEmailEventReport.md)
|
||||
- [GetEmailEventReportEvents](docs/Model/GetEmailEventReportEvents.md)
|
||||
- [GetExtendedCampaignOverview](docs/Model/GetExtendedCampaignOverview.md)
|
||||
- [GetExtendedCampaignOverviewSender](docs/Model/GetExtendedCampaignOverviewSender.md)
|
||||
- [GetExtendedCampaignStats](docs/Model/GetExtendedCampaignStats.md)
|
||||
- [GetExtendedCampaignStatsGlobalStats](docs/Model/GetExtendedCampaignStatsGlobalStats.md)
|
||||
- [GetExtendedClient](docs/Model/GetExtendedClient.md)
|
||||
- [GetExtendedClientAddress](docs/Model/GetExtendedClientAddress.md)
|
||||
- [GetExtendedContactDetails](docs/Model/GetExtendedContactDetails.md)
|
||||
- [GetExtendedContactDetailsStatistics](docs/Model/GetExtendedContactDetailsStatistics.md)
|
||||
- [GetExtendedContactDetailsStatisticsClicked](docs/Model/GetExtendedContactDetailsStatisticsClicked.md)
|
||||
- [GetExtendedContactDetailsStatisticsDelivered](docs/Model/GetExtendedContactDetailsStatisticsDelivered.md)
|
||||
- [GetExtendedContactDetailsStatisticsLinks](docs/Model/GetExtendedContactDetailsStatisticsLinks.md)
|
||||
- [GetExtendedContactDetailsStatisticsMessagesSent](docs/Model/GetExtendedContactDetailsStatisticsMessagesSent.md)
|
||||
- [GetExtendedContactDetailsStatisticsOpened](docs/Model/GetExtendedContactDetailsStatisticsOpened.md)
|
||||
- [GetExtendedContactDetailsStatisticsUnsubscriptions](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptions.md)
|
||||
- [GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md)
|
||||
- [GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md)
|
||||
- [GetExtendedList](docs/Model/GetExtendedList.md)
|
||||
- [GetExtendedListCampaignStats](docs/Model/GetExtendedListCampaignStats.md)
|
||||
- [GetExternalFeedByUUID](docs/Model/GetExternalFeedByUUID.md)
|
||||
- [GetExternalFeedByUUIDHeaders](docs/Model/GetExternalFeedByUUIDHeaders.md)
|
||||
- [GetFolder](docs/Model/GetFolder.md)
|
||||
- [GetFolderLists](docs/Model/GetFolderLists.md)
|
||||
- [GetFolders](docs/Model/GetFolders.md)
|
||||
- [GetInboundEmailEvents](docs/Model/GetInboundEmailEvents.md)
|
||||
- [GetInboundEmailEventsByUuid](docs/Model/GetInboundEmailEventsByUuid.md)
|
||||
- [GetInboundEmailEventsByUuidAttachments](docs/Model/GetInboundEmailEventsByUuidAttachments.md)
|
||||
- [GetInboundEmailEventsByUuidLogs](docs/Model/GetInboundEmailEventsByUuidLogs.md)
|
||||
- [GetInboundEmailEventsEvents](docs/Model/GetInboundEmailEventsEvents.md)
|
||||
- [GetInvitedUsersList](docs/Model/GetInvitedUsersList.md)
|
||||
- [GetInvitedUsersListFeatureAccess](docs/Model/GetInvitedUsersListFeatureAccess.md)
|
||||
- [GetInvitedUsersListUsers](docs/Model/GetInvitedUsersListUsers.md)
|
||||
- [GetIp](docs/Model/GetIp.md)
|
||||
- [GetIpFromSender](docs/Model/GetIpFromSender.md)
|
||||
- [GetIps](docs/Model/GetIps.md)
|
||||
- [GetIpsFromSender](docs/Model/GetIpsFromSender.md)
|
||||
- [GetList](docs/Model/GetList.md)
|
||||
- [GetLists](docs/Model/GetLists.md)
|
||||
- [GetOrders](docs/Model/GetOrders.md)
|
||||
- [GetProcess](docs/Model/GetProcess.md)
|
||||
- [GetProcesses](docs/Model/GetProcesses.md)
|
||||
- [GetProductDetails](docs/Model/GetProductDetails.md)
|
||||
- [GetProducts](docs/Model/GetProducts.md)
|
||||
- [GetReports](docs/Model/GetReports.md)
|
||||
- [GetReportsReports](docs/Model/GetReportsReports.md)
|
||||
- [GetScheduledEmailByBatchId](docs/Model/GetScheduledEmailByBatchId.md)
|
||||
- [GetScheduledEmailByBatchIdBatches](docs/Model/GetScheduledEmailByBatchIdBatches.md)
|
||||
- [GetScheduledEmailByMessageId](docs/Model/GetScheduledEmailByMessageId.md)
|
||||
- [GetSegments](docs/Model/GetSegments.md)
|
||||
- [GetSegmentsSegments](docs/Model/GetSegmentsSegments.md)
|
||||
- [GetSendersList](docs/Model/GetSendersList.md)
|
||||
- [GetSendersListIps](docs/Model/GetSendersListIps.md)
|
||||
- [GetSendersListSenders](docs/Model/GetSendersListSenders.md)
|
||||
- [GetSharedTemplateUrl](docs/Model/GetSharedTemplateUrl.md)
|
||||
- [GetSmsCampaign](docs/Model/GetSmsCampaign.md)
|
||||
- [GetSmsCampaignOverview](docs/Model/GetSmsCampaignOverview.md)
|
||||
- [GetSmsCampaignRecipients](docs/Model/GetSmsCampaignRecipients.md)
|
||||
- [GetSmsCampaignStats](docs/Model/GetSmsCampaignStats.md)
|
||||
- [GetSmsCampaigns](docs/Model/GetSmsCampaigns.md)
|
||||
- [GetSmsEventReport](docs/Model/GetSmsEventReport.md)
|
||||
- [GetSmsEventReportEvents](docs/Model/GetSmsEventReportEvents.md)
|
||||
- [GetSmtpTemplateOverview](docs/Model/GetSmtpTemplateOverview.md)
|
||||
- [GetSmtpTemplateOverviewSender](docs/Model/GetSmtpTemplateOverviewSender.md)
|
||||
- [GetSmtpTemplates](docs/Model/GetSmtpTemplates.md)
|
||||
- [GetSsoToken](docs/Model/GetSsoToken.md)
|
||||
- [GetStatsByBrowser](docs/Model/GetStatsByBrowser.md)
|
||||
- [GetStatsByDevice](docs/Model/GetStatsByDevice.md)
|
||||
- [GetStatsByDomain](docs/Model/GetStatsByDomain.md)
|
||||
- [GetTransacAggregatedSmsReport](docs/Model/GetTransacAggregatedSmsReport.md)
|
||||
- [GetTransacBlockedContacts](docs/Model/GetTransacBlockedContacts.md)
|
||||
- [GetTransacBlockedContactsContacts](docs/Model/GetTransacBlockedContactsContacts.md)
|
||||
- [GetTransacBlockedContactsReason](docs/Model/GetTransacBlockedContactsReason.md)
|
||||
- [GetTransacEmailContent](docs/Model/GetTransacEmailContent.md)
|
||||
- [GetTransacEmailContentEvents](docs/Model/GetTransacEmailContentEvents.md)
|
||||
- [GetTransacEmailsList](docs/Model/GetTransacEmailsList.md)
|
||||
- [GetTransacEmailsListTransactionalEmails](docs/Model/GetTransacEmailsListTransactionalEmails.md)
|
||||
- [GetTransacSmsReport](docs/Model/GetTransacSmsReport.md)
|
||||
- [GetTransacSmsReportReports](docs/Model/GetTransacSmsReportReports.md)
|
||||
- [GetUserPermission](docs/Model/GetUserPermission.md)
|
||||
- [GetUserPermissionPrivileges](docs/Model/GetUserPermissionPrivileges.md)
|
||||
- [GetWATemplates](docs/Model/GetWATemplates.md)
|
||||
- [GetWATemplatesTemplates](docs/Model/GetWATemplatesTemplates.md)
|
||||
- [GetWebhook](docs/Model/GetWebhook.md)
|
||||
- [GetWebhookAuth](docs/Model/GetWebhookAuth.md)
|
||||
- [GetWebhookHeaders](docs/Model/GetWebhookHeaders.md)
|
||||
- [GetWebhooks](docs/Model/GetWebhooks.md)
|
||||
- [GetWhatsAppConfig](docs/Model/GetWhatsAppConfig.md)
|
||||
- [GetWhatsappCampaignOverview](docs/Model/GetWhatsappCampaignOverview.md)
|
||||
- [GetWhatsappCampaigns](docs/Model/GetWhatsappCampaigns.md)
|
||||
- [GetWhatsappCampaignsCampaigns](docs/Model/GetWhatsappCampaignsCampaigns.md)
|
||||
- [GetWhatsappEventReport](docs/Model/GetWhatsappEventReport.md)
|
||||
- [GetWhatsappEventReportEvents](docs/Model/GetWhatsappEventReportEvents.md)
|
||||
- [InlineResponse200](docs/Model/InlineResponse200.md)
|
||||
- [InlineResponse2001](docs/Model/InlineResponse2001.md)
|
||||
- [InlineResponse2002](docs/Model/InlineResponse2002.md)
|
||||
- [InlineResponse201](docs/Model/InlineResponse201.md)
|
||||
- [InlineResponse2011](docs/Model/InlineResponse2011.md)
|
||||
- [InlineResponse2012](docs/Model/InlineResponse2012.md)
|
||||
- [InlineResponse2013](docs/Model/InlineResponse2013.md)
|
||||
- [InlineResponse2014](docs/Model/InlineResponse2014.md)
|
||||
- [InlineResponse2015](docs/Model/InlineResponse2015.md)
|
||||
- [InviteAdminUser](docs/Model/InviteAdminUser.md)
|
||||
- [InviteAdminUserPrivileges](docs/Model/InviteAdminUserPrivileges.md)
|
||||
- [Inviteuser](docs/Model/Inviteuser.md)
|
||||
- [InviteuserPrivileges](docs/Model/InviteuserPrivileges.md)
|
||||
- [ManageIp](docs/Model/ManageIp.md)
|
||||
- [MasterDetailsResponse](docs/Model/MasterDetailsResponse.md)
|
||||
- [MasterDetailsResponseBillingInfo](docs/Model/MasterDetailsResponseBillingInfo.md)
|
||||
- [MasterDetailsResponseBillingInfoAddress](docs/Model/MasterDetailsResponseBillingInfoAddress.md)
|
||||
- [MasterDetailsResponseBillingInfoName](docs/Model/MasterDetailsResponseBillingInfoName.md)
|
||||
- [MasterDetailsResponsePlanInfo](docs/Model/MasterDetailsResponsePlanInfo.md)
|
||||
- [MasterDetailsResponsePlanInfoFeatures](docs/Model/MasterDetailsResponsePlanInfoFeatures.md)
|
||||
- [Note](docs/Model/Note.md)
|
||||
- [NoteData](docs/Model/NoteData.md)
|
||||
- [NoteId](docs/Model/NoteId.md)
|
||||
- [NoteList](docs/Model/NoteList.md)
|
||||
- [Order](docs/Model/Order.md)
|
||||
- [OrderBatch](docs/Model/OrderBatch.md)
|
||||
- [OrderBilling](docs/Model/OrderBilling.md)
|
||||
- [OrderProducts](docs/Model/OrderProducts.md)
|
||||
- [Otp](docs/Model/Otp.md)
|
||||
- [Pipeline](docs/Model/Pipeline.md)
|
||||
- [PipelineStage](docs/Model/PipelineStage.md)
|
||||
- [Pipelines](docs/Model/Pipelines.md)
|
||||
- [PostContactInfo](docs/Model/PostContactInfo.md)
|
||||
- [PostContactInfoContacts](docs/Model/PostContactInfoContacts.md)
|
||||
- [PostSendFailed](docs/Model/PostSendFailed.md)
|
||||
- [PostSendSmsTestFailed](docs/Model/PostSendSmsTestFailed.md)
|
||||
- [PutRevokeUserPermission](docs/Model/PutRevokeUserPermission.md)
|
||||
- [Putresendcancelinvitation](docs/Model/Putresendcancelinvitation.md)
|
||||
- [RemainingCreditModel](docs/Model/RemainingCreditModel.md)
|
||||
- [RemainingCreditModelChild](docs/Model/RemainingCreditModelChild.md)
|
||||
- [RemainingCreditModelReseller](docs/Model/RemainingCreditModelReseller.md)
|
||||
- [RemoveContactFromList](docs/Model/RemoveContactFromList.md)
|
||||
- [RemoveCredits](docs/Model/RemoveCredits.md)
|
||||
- [RequestContactExport](docs/Model/RequestContactExport.md)
|
||||
- [RequestContactExportCustomContactFilter](docs/Model/RequestContactExportCustomContactFilter.md)
|
||||
- [RequestContactImport](docs/Model/RequestContactImport.md)
|
||||
- [RequestContactImportJsonBody](docs/Model/RequestContactImportJsonBody.md)
|
||||
- [RequestContactImportNewList](docs/Model/RequestContactImportNewList.md)
|
||||
- [RequestSmsRecipientExport](docs/Model/RequestSmsRecipientExport.md)
|
||||
- [ScheduleSmtpEmail](docs/Model/ScheduleSmtpEmail.md)
|
||||
- [SendReport](docs/Model/SendReport.md)
|
||||
- [SendReportEmail](docs/Model/SendReportEmail.md)
|
||||
- [SendSms](docs/Model/SendSms.md)
|
||||
- [SendSmtpEmail](docs/Model/SendSmtpEmail.md)
|
||||
- [SendSmtpEmailAttachment](docs/Model/SendSmtpEmailAttachment.md)
|
||||
- [SendSmtpEmailBcc](docs/Model/SendSmtpEmailBcc.md)
|
||||
- [SendSmtpEmailCc](docs/Model/SendSmtpEmailCc.md)
|
||||
- [SendSmtpEmailMessageVersions](docs/Model/SendSmtpEmailMessageVersions.md)
|
||||
- [SendSmtpEmailReplyTo](docs/Model/SendSmtpEmailReplyTo.md)
|
||||
- [SendSmtpEmailReplyTo1](docs/Model/SendSmtpEmailReplyTo1.md)
|
||||
- [SendSmtpEmailSender](docs/Model/SendSmtpEmailSender.md)
|
||||
- [SendSmtpEmailTo](docs/Model/SendSmtpEmailTo.md)
|
||||
- [SendSmtpEmailTo1](docs/Model/SendSmtpEmailTo1.md)
|
||||
- [SendTestEmail](docs/Model/SendTestEmail.md)
|
||||
- [SendTestSms](docs/Model/SendTestSms.md)
|
||||
- [SendTransacSms](docs/Model/SendTransacSms.md)
|
||||
- [SendWhatsappMessage](docs/Model/SendWhatsappMessage.md)
|
||||
- [SsoTokenRequest](docs/Model/SsoTokenRequest.md)
|
||||
- [SubAccountAppsToggleRequest](docs/Model/SubAccountAppsToggleRequest.md)
|
||||
- [SubAccountDetailsResponse](docs/Model/SubAccountDetailsResponse.md)
|
||||
- [SubAccountDetailsResponsePlanInfo](docs/Model/SubAccountDetailsResponsePlanInfo.md)
|
||||
- [SubAccountDetailsResponsePlanInfoCredits](docs/Model/SubAccountDetailsResponsePlanInfoCredits.md)
|
||||
- [SubAccountDetailsResponsePlanInfoCreditsEmails](docs/Model/SubAccountDetailsResponsePlanInfoCreditsEmails.md)
|
||||
- [SubAccountDetailsResponsePlanInfoFeatures](docs/Model/SubAccountDetailsResponsePlanInfoFeatures.md)
|
||||
- [SubAccountDetailsResponsePlanInfoFeaturesInbox](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesInbox.md)
|
||||
- [SubAccountDetailsResponsePlanInfoFeaturesLandingPage](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md)
|
||||
- [SubAccountDetailsResponsePlanInfoFeaturesUsers](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesUsers.md)
|
||||
- [SubAccountUpdatePlanRequest](docs/Model/SubAccountUpdatePlanRequest.md)
|
||||
- [SubAccountUpdatePlanRequestCredits](docs/Model/SubAccountUpdatePlanRequestCredits.md)
|
||||
- [SubAccountUpdatePlanRequestFeatures](docs/Model/SubAccountUpdatePlanRequestFeatures.md)
|
||||
- [SubAccountsResponse](docs/Model/SubAccountsResponse.md)
|
||||
- [SubAccountsResponseSubAccounts](docs/Model/SubAccountsResponseSubAccounts.md)
|
||||
- [Task](docs/Model/Task.md)
|
||||
- [TaskList](docs/Model/TaskList.md)
|
||||
- [TaskReminder](docs/Model/TaskReminder.md)
|
||||
- [TaskTypes](docs/Model/TaskTypes.md)
|
||||
- [UpdateAttribute](docs/Model/UpdateAttribute.md)
|
||||
- [UpdateAttributeEnumeration](docs/Model/UpdateAttributeEnumeration.md)
|
||||
- [UpdateBatchContacts](docs/Model/UpdateBatchContacts.md)
|
||||
- [UpdateBatchContactsContacts](docs/Model/UpdateBatchContactsContacts.md)
|
||||
- [UpdateBatchContactsModel](docs/Model/UpdateBatchContactsModel.md)
|
||||
- [UpdateCampaignStatus](docs/Model/UpdateCampaignStatus.md)
|
||||
- [UpdateChild](docs/Model/UpdateChild.md)
|
||||
- [UpdateChildAccountStatus](docs/Model/UpdateChildAccountStatus.md)
|
||||
- [UpdateChildDomain](docs/Model/UpdateChildDomain.md)
|
||||
- [UpdateContact](docs/Model/UpdateContact.md)
|
||||
- [UpdateCouponCollection](docs/Model/UpdateCouponCollection.md)
|
||||
- [UpdateEmailCampaign](docs/Model/UpdateEmailCampaign.md)
|
||||
- [UpdateEmailCampaignRecipients](docs/Model/UpdateEmailCampaignRecipients.md)
|
||||
- [UpdateEmailCampaignSender](docs/Model/UpdateEmailCampaignSender.md)
|
||||
- [UpdateExternalFeed](docs/Model/UpdateExternalFeed.md)
|
||||
- [UpdateList](docs/Model/UpdateList.md)
|
||||
- [UpdateSender](docs/Model/UpdateSender.md)
|
||||
- [UpdateSmsCampaign](docs/Model/UpdateSmsCampaign.md)
|
||||
- [UpdateSmtpTemplate](docs/Model/UpdateSmtpTemplate.md)
|
||||
- [UpdateSmtpTemplateSender](docs/Model/UpdateSmtpTemplateSender.md)
|
||||
- [UpdateWebhook](docs/Model/UpdateWebhook.md)
|
||||
- [UpdateWhatsAppCampaign](docs/Model/UpdateWhatsAppCampaign.md)
|
||||
- [UploadImageModel](docs/Model/UploadImageModel.md)
|
||||
- [UploadImageToGallery](docs/Model/UploadImageToGallery.md)
|
||||
- [GetChildInfo](docs/Model/GetChildInfo.md)
|
||||
- [GetExtendedCampaignOverview](docs/Model/GetExtendedCampaignOverview.md)
|
||||
- [GetExtendedClient](docs/Model/GetExtendedClient.md)
|
||||
- [GetExtendedContactDetails](docs/Model/GetExtendedContactDetails.md)
|
||||
- [GetExtendedList](docs/Model/GetExtendedList.md)
|
||||
- [GetSmsCampaign](docs/Model/GetSmsCampaign.md)
|
||||
- [GetAccount](docs/Model/GetAccount.md)
|
||||
- [GetEmailCampaign](docs/Model/GetEmailCampaign.md)
|
||||
- [VariablesItems](docs/Model/VariablesItems.md)
|
||||
- [WhatsappCampStats](docs/Model/WhatsappCampStats.md)
|
||||
- [WhatsappCampTemplate](docs/Model/WhatsappCampTemplate.md)
|
||||
|
||||
|
||||
## Documentation For Authorization
|
||||
|
||||
|
||||
## api-key
|
||||
|
||||
The API key should be passed in the request headers as `api-key` for authentication.
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api-key
|
||||
- **Location**: HTTP header
|
||||
|
||||
## partner-key
|
||||
|
||||
The partner key should be passed in the request headers as `partner-key` along with `api-key` pair for successful authentication of partner (Optional).
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: partner-key
|
||||
- **Location**: HTTP header
|
||||
|
||||
|
||||
If you find a bug, please post the issue on [Github](https://github.com/getbrevo/brevo-php/issues).
|
||||
|
||||
As always, if you need additional assistance, drop us a note [here](https://account.brevo.com/support).
|
||||
43
vendor/getbrevo/brevo-php/composer.json
vendored
Executable file
43
vendor/getbrevo/brevo-php/composer.json
vendored
Executable file
|
|
@ -0,0 +1,43 @@
|
|||
{
|
||||
"name": "getbrevo/brevo-php",
|
||||
"description": "Official Brevo provided RESTFul API V3 php library",
|
||||
"keywords": [
|
||||
"brevo",
|
||||
"swagger",
|
||||
"php",
|
||||
"sdk",
|
||||
"api"
|
||||
],
|
||||
"homepage": "https://github.com/getbrevo/brevo-php",
|
||||
"license": "MIT",
|
||||
"authors": [
|
||||
{
|
||||
"name": "Brevo Developers",
|
||||
"email": "contact@brevo.com",
|
||||
"homepage": "https://www.brevo.com/"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=5.6",
|
||||
"ext-curl": "*",
|
||||
"ext-json": "*",
|
||||
"ext-mbstring": "*",
|
||||
"guzzlehttp/guzzle": "^7.4.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^4.8",
|
||||
"squizlabs/php_codesniffer": "~2.6",
|
||||
"friendsofphp/php-cs-fixer": "~1.12"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": { "Brevo\\Client\\" : "lib/" }
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": { "Brevo\\Client\\" : "test/" }
|
||||
},
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "1.x.x-dev"
|
||||
}
|
||||
}
|
||||
}
|
||||
2107
vendor/getbrevo/brevo-php/composer.lock
generated
vendored
Normal file
2107
vendor/getbrevo/brevo-php/composer.lock
generated
vendored
Normal file
File diff suppressed because it is too large
Load diff
126
vendor/getbrevo/brevo-php/docs/Api/AccountApi.md
vendored
Normal file
126
vendor/getbrevo/brevo-php/docs/Api/AccountApi.md
vendored
Normal file
|
|
@ -0,0 +1,126 @@
|
|||
# Brevo\Client\AccountApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**getAccount**](AccountApi.md#getAccount) | **GET** /account | Get your account information, plan and credits details
|
||||
[**getAccountActivity**](AccountApi.md#getAccountActivity) | **GET** /organization/activities | Get user activity logs
|
||||
|
||||
|
||||
# **getAccount**
|
||||
> \Brevo\Client\Model\GetAccount getAccount()
|
||||
|
||||
Get your account information, plan and credits details
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\AccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getAccount();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetAccount**](../Model/GetAccount.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getAccountActivity**
|
||||
> \Brevo\Client\Model\GetAccountActivity getAccountActivity($startDate, $endDate, $limit, $offset)
|
||||
|
||||
Get user activity logs
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\AccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search.
|
||||
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month.
|
||||
$limit = 10; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document in the page.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getAccountActivity($startDate, $endDate, $limit, $offset);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling AccountApi->getAccountActivity: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**startDate** | **string**| Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. | [optional]
|
||||
**endDate** | **string**| Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 10]
|
||||
**offset** | **int**| Index of the first document in the page. | [optional] [default to 0]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetAccountActivity**](../Model/GetAccountActivity.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
243
vendor/getbrevo/brevo-php/docs/Api/AttributesApi.md
vendored
Normal file
243
vendor/getbrevo/brevo-php/docs/Api/AttributesApi.md
vendored
Normal file
|
|
@ -0,0 +1,243 @@
|
|||
# Brevo\Client\AttributesApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createAttribute**](AttributesApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
||||
[**deleteAttribute**](AttributesApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
||||
[**getAttributes**](AttributesApi.md#getAttributes) | **GET** /contacts/attributes | List all attributes
|
||||
[**updateAttribute**](AttributesApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
||||
|
||||
|
||||
# **createAttribute**
|
||||
> createAttribute($attributeCategory, $attributeName, $createAttribute)
|
||||
|
||||
Create contact attribute
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\AttributesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
|
||||
$attributeName = "attributeName_example"; // string | Name of the attribute
|
||||
$createAttribute = new \Brevo\Client\Model\CreateAttribute(); // \Brevo\Client\Model\CreateAttribute | Values to create an attribute
|
||||
|
||||
try {
|
||||
$apiInstance->createAttribute($attributeCategory, $attributeName, $createAttribute);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling AttributesApi->createAttribute: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**attributeCategory** | **string**| Category of the attribute |
|
||||
**attributeName** | **string**| Name of the attribute |
|
||||
**createAttribute** | [**\Brevo\Client\Model\CreateAttribute**](../Model/CreateAttribute.md)| Values to create an attribute |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteAttribute**
|
||||
> deleteAttribute($attributeCategory, $attributeName)
|
||||
|
||||
Delete an attribute
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\AttributesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
|
||||
$attributeName = "attributeName_example"; // string | Name of the existing attribute
|
||||
|
||||
try {
|
||||
$apiInstance->deleteAttribute($attributeCategory, $attributeName);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling AttributesApi->deleteAttribute: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**attributeCategory** | **string**| Category of the attribute |
|
||||
**attributeName** | **string**| Name of the existing attribute |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getAttributes**
|
||||
> \Brevo\Client\Model\GetAttributes getAttributes()
|
||||
|
||||
List all attributes
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\AttributesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getAttributes();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling AttributesApi->getAttributes: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetAttributes**](../Model/GetAttributes.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateAttribute**
|
||||
> updateAttribute($attributeCategory, $attributeName, $updateAttribute)
|
||||
|
||||
Update contact attribute
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\AttributesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
|
||||
$attributeName = "attributeName_example"; // string | Name of the existing attribute
|
||||
$updateAttribute = new \Brevo\Client\Model\UpdateAttribute(); // \Brevo\Client\Model\UpdateAttribute | Values to update an attribute
|
||||
|
||||
try {
|
||||
$apiInstance->updateAttribute($attributeCategory, $attributeName, $updateAttribute);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling AttributesApi->updateAttribute: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**attributeCategory** | **string**| Category of the attribute |
|
||||
**attributeName** | **string**| Name of the existing attribute |
|
||||
**updateAttribute** | [**\Brevo\Client\Model\UpdateAttribute**](../Model/UpdateAttribute.md)| Values to update an attribute |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
678
vendor/getbrevo/brevo-php/docs/Api/CRMApi.md
vendored
Normal file
678
vendor/getbrevo/brevo-php/docs/Api/CRMApi.md
vendored
Normal file
|
|
@ -0,0 +1,678 @@
|
|||
# Brevo\Client\CRMApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**crmNotesGet**](CRMApi.md#crmNotesGet) | **GET** /crm/notes | Get all notes
|
||||
[**crmNotesIdDelete**](CRMApi.md#crmNotesIdDelete) | **DELETE** /crm/notes/{id} | Delete a note
|
||||
[**crmNotesIdGet**](CRMApi.md#crmNotesIdGet) | **GET** /crm/notes/{id} | Get a note
|
||||
[**crmNotesIdPatch**](CRMApi.md#crmNotesIdPatch) | **PATCH** /crm/notes/{id} | Update a note
|
||||
[**crmNotesPost**](CRMApi.md#crmNotesPost) | **POST** /crm/notes | Create a note
|
||||
[**crmTasksGet**](CRMApi.md#crmTasksGet) | **GET** /crm/tasks | Get all tasks
|
||||
[**crmTasksIdDelete**](CRMApi.md#crmTasksIdDelete) | **DELETE** /crm/tasks/{id} | Delete a task
|
||||
[**crmTasksIdGet**](CRMApi.md#crmTasksIdGet) | **GET** /crm/tasks/{id} | Get a task
|
||||
[**crmTasksIdPatch**](CRMApi.md#crmTasksIdPatch) | **PATCH** /crm/tasks/{id} | Update a task
|
||||
[**crmTasksPost**](CRMApi.md#crmTasksPost) | **POST** /crm/tasks | Create a task
|
||||
[**crmTasktypesGet**](CRMApi.md#crmTasktypesGet) | **GET** /crm/tasktypes | Get all task types
|
||||
|
||||
|
||||
# **crmNotesGet**
|
||||
> \Brevo\Client\Model\NoteList crmNotesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort)
|
||||
|
||||
Get all notes
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$entity = "entity_example"; // string | Filter by note entity type
|
||||
$entityIds = "entityIds_example"; // string | Filter by note entity IDs
|
||||
$dateFrom = 56; // int | dateFrom to date range filter type (timestamp in milliseconds)
|
||||
$dateTo = 56; // int | dateTo to date range filter type (timestamp in milliseconds)
|
||||
$offset = 789; // int | Index of the first document of the page
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmNotesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmNotesGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**entity** | **string**| Filter by note entity type | [optional]
|
||||
**entityIds** | **string**| Filter by note entity IDs | [optional]
|
||||
**dateFrom** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional]
|
||||
**dateTo** | **int**| dateTo to date range filter type (timestamp in milliseconds) | [optional]
|
||||
**offset** | **int**| Index of the first document of the page | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\NoteList**](../Model/NoteList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmNotesIdDelete**
|
||||
> crmNotesIdDelete($id)
|
||||
|
||||
Delete a note
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Note ID to delete
|
||||
|
||||
try {
|
||||
$apiInstance->crmNotesIdDelete($id);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmNotesIdDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Note ID to delete |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmNotesIdGet**
|
||||
> \Brevo\Client\Model\Note crmNotesIdGet($id)
|
||||
|
||||
Get a note
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Note ID to get
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmNotesIdGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmNotesIdGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Note ID to get |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Note**](../Model/Note.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmNotesIdPatch**
|
||||
> crmNotesIdPatch($id, $body)
|
||||
|
||||
Update a note
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Note ID to update
|
||||
$body = new \Brevo\Client\Model\NoteData(); // \Brevo\Client\Model\NoteData | Note data to update a note
|
||||
|
||||
try {
|
||||
$apiInstance->crmNotesIdPatch($id, $body);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmNotesIdPatch: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Note ID to update |
|
||||
**body** | [**\Brevo\Client\Model\NoteData**](../Model/NoteData.md)| Note data to update a note |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmNotesPost**
|
||||
> \Brevo\Client\Model\NoteId crmNotesPost($body)
|
||||
|
||||
Create a note
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$body = new \Brevo\Client\Model\NoteData(); // \Brevo\Client\Model\NoteData | Note data to create a note.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmNotesPost($body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmNotesPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**\Brevo\Client\Model\NoteData**](../Model/NoteData.md)| Note data to create a note. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\NoteId**](../Model/NoteId.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasksGet**
|
||||
> \Brevo\Client\Model\TaskList crmTasksGet($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy)
|
||||
|
||||
Get all tasks
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$filterType = "filterType_example"; // string | Filter by task type (ID)
|
||||
$filterStatus = "filterStatus_example"; // string | Filter by task status
|
||||
$filterDate = "filterDate_example"; // string | Filter by date
|
||||
$filterAssignTo = "filterAssignTo_example"; // string | Filter by assignTo id
|
||||
$filterContacts = "filterContacts_example"; // string | Filter by contact ids
|
||||
$filterDeals = "filterDeals_example"; // string | Filter by deals ids
|
||||
$filterCompanies = "filterCompanies_example"; // string | Filter by companies ids
|
||||
$dateFrom = 56; // int | dateFrom to date range filter type (timestamp in milliseconds)
|
||||
$dateTo = 56; // int | dateTo to date range filter type (timestamp in milliseconds)
|
||||
$offset = 789; // int | Index of the first document of the page
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
||||
$sortBy = "sortBy_example"; // string | The field used to sort field names.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmTasksGet($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmTasksGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filterType** | **string**| Filter by task type (ID) | [optional]
|
||||
**filterStatus** | **string**| Filter by task status | [optional]
|
||||
**filterDate** | **string**| Filter by date | [optional]
|
||||
**filterAssignTo** | **string**| Filter by assignTo id | [optional]
|
||||
**filterContacts** | **string**| Filter by contact ids | [optional]
|
||||
**filterDeals** | **string**| Filter by deals ids | [optional]
|
||||
**filterCompanies** | **string**| Filter by companies ids | [optional]
|
||||
**dateFrom** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional]
|
||||
**dateTo** | **int**| dateTo to date range filter type (timestamp in milliseconds) | [optional]
|
||||
**offset** | **int**| Index of the first document of the page | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional]
|
||||
**sortBy** | **string**| The field used to sort field names. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\TaskList**](../Model/TaskList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasksIdDelete**
|
||||
> crmTasksIdDelete($id)
|
||||
|
||||
Delete a task
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
|
||||
try {
|
||||
$apiInstance->crmTasksIdDelete($id);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmTasksIdDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasksIdGet**
|
||||
> \Brevo\Client\Model\Task crmTasksIdGet($id)
|
||||
|
||||
Get a task
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmTasksIdGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmTasksIdGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Task**](../Model/Task.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasksIdPatch**
|
||||
> crmTasksIdPatch($id, $body)
|
||||
|
||||
Update a task
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
$body = new \Brevo\Client\Model\Body1(); // \Brevo\Client\Model\Body1 | Updated task details.
|
||||
|
||||
try {
|
||||
$apiInstance->crmTasksIdPatch($id, $body);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmTasksIdPatch: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
**body** | [**\Brevo\Client\Model\Body1**](../Model/Body1.md)| Updated task details. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasksPost**
|
||||
> \Brevo\Client\Model\InlineResponse201 crmTasksPost($body)
|
||||
|
||||
Create a task
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$body = new \Brevo\Client\Model\Body(); // \Brevo\Client\Model\Body | Task name.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmTasksPost($body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmTasksPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**\Brevo\Client\Model\Body**](../Model/Body.md)| Task name. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InlineResponse201**](../Model/InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasktypesGet**
|
||||
> \Brevo\Client\Model\TaskTypes crmTasktypesGet()
|
||||
|
||||
Get all task types
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CRMApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmTasktypesGet();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CRMApi->crmTasktypesGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\TaskTypes**](../Model/TaskTypes.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
424
vendor/getbrevo/brevo-php/docs/Api/CompaniesApi.md
vendored
Normal file
424
vendor/getbrevo/brevo-php/docs/Api/CompaniesApi.md
vendored
Normal file
|
|
@ -0,0 +1,424 @@
|
|||
# Brevo\Client\CompaniesApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**companiesAttributesGet**](CompaniesApi.md#companiesAttributesGet) | **GET** /companies/attributes | Get company attributes
|
||||
[**companiesGet**](CompaniesApi.md#companiesGet) | **GET** /companies | Get all companies
|
||||
[**companiesIdDelete**](CompaniesApi.md#companiesIdDelete) | **DELETE** /companies/{id} | Delete a company
|
||||
[**companiesIdGet**](CompaniesApi.md#companiesIdGet) | **GET** /companies/{id} | Get a company
|
||||
[**companiesIdPatch**](CompaniesApi.md#companiesIdPatch) | **PATCH** /companies/{id} | Update a company
|
||||
[**companiesLinkUnlinkIdPatch**](CompaniesApi.md#companiesLinkUnlinkIdPatch) | **PATCH** /companies/link-unlink/{id} | Link and Unlink company with contacts and deals
|
||||
[**companiesPost**](CompaniesApi.md#companiesPost) | **POST** /companies | Create a company
|
||||
|
||||
|
||||
# **companiesAttributesGet**
|
||||
> \Brevo\Client\Model\CompanyAttributes companiesAttributesGet()
|
||||
|
||||
Get company attributes
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->companiesAttributesGet();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CompaniesApi->companiesAttributesGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CompanyAttributes**](../Model/CompanyAttributes.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **companiesGet**
|
||||
> \Brevo\Client\Model\CompaniesList companiesGet($filters, $linkedContactsIds, $linkedDealsIds, $page, $limit, $sort, $sortBy)
|
||||
|
||||
Get all companies
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$filters = "filters_example"; // string | Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"}
|
||||
$linkedContactsIds = 789; // int | Filter by linked contacts ids
|
||||
$linkedDealsIds = "linkedDealsIds_example"; // string | Filter by linked deals ids
|
||||
$page = 789; // int | Index of the first document of the page
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
||||
$sortBy = "sortBy_example"; // string | The field used to sort field names.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->companiesGet($filters, $linkedContactsIds, $linkedDealsIds, $page, $limit, $sort, $sortBy);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CompaniesApi->companiesGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filters** | **string**| Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} | [optional]
|
||||
**linkedContactsIds** | **int**| Filter by linked contacts ids | [optional]
|
||||
**linkedDealsIds** | **string**| Filter by linked deals ids | [optional]
|
||||
**page** | **int**| Index of the first document of the page | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional]
|
||||
**sortBy** | **string**| The field used to sort field names. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CompaniesList**](../Model/CompaniesList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **companiesIdDelete**
|
||||
> companiesIdDelete($id)
|
||||
|
||||
Delete a company
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
|
||||
try {
|
||||
$apiInstance->companiesIdDelete($id);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CompaniesApi->companiesIdDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **companiesIdGet**
|
||||
> \Brevo\Client\Model\Company companiesIdGet($id)
|
||||
|
||||
Get a company
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
|
||||
try {
|
||||
$result = $apiInstance->companiesIdGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CompaniesApi->companiesIdGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Company**](../Model/Company.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **companiesIdPatch**
|
||||
> \Brevo\Client\Model\Company companiesIdPatch($id, $body)
|
||||
|
||||
Update a company
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
$body = new \Brevo\Client\Model\Body3(); // \Brevo\Client\Model\Body3 | Updated company details.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->companiesIdPatch($id, $body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CompaniesApi->companiesIdPatch: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
**body** | [**\Brevo\Client\Model\Body3**](../Model/Body3.md)| Updated company details. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Company**](../Model/Company.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **companiesLinkUnlinkIdPatch**
|
||||
> companiesLinkUnlinkIdPatch($id, $body)
|
||||
|
||||
Link and Unlink company with contacts and deals
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
$body = new \Brevo\Client\Model\Body4(); // \Brevo\Client\Model\Body4 | Linked / Unlinked contacts and deals ids.
|
||||
|
||||
try {
|
||||
$apiInstance->companiesLinkUnlinkIdPatch($id, $body);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CompaniesApi->companiesLinkUnlinkIdPatch: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
**body** | [**\Brevo\Client\Model\Body4**](../Model/Body4.md)| Linked / Unlinked contacts and deals ids. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **companiesPost**
|
||||
> \Brevo\Client\Model\InlineResponse2001 companiesPost($body)
|
||||
|
||||
Create a company
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$body = new \Brevo\Client\Model\Body2(); // \Brevo\Client\Model\Body2 | Company create data.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->companiesPost($body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CompaniesApi->companiesPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**\Brevo\Client\Model\Body2**](../Model/Body2.md)| Company create data. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InlineResponse2001**](../Model/InlineResponse2001.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
1751
vendor/getbrevo/brevo-php/docs/Api/ContactsApi.md
vendored
Normal file
1751
vendor/getbrevo/brevo-php/docs/Api/ContactsApi.md
vendored
Normal file
File diff suppressed because it is too large
Load diff
539
vendor/getbrevo/brevo-php/docs/Api/ConversationsApi.md
vendored
Normal file
539
vendor/getbrevo/brevo-php/docs/Api/ConversationsApi.md
vendored
Normal file
|
|
@ -0,0 +1,539 @@
|
|||
# Brevo\Client\ConversationsApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**conversationsAgentOnlinePingPost**](ConversationsApi.md#conversationsAgentOnlinePingPost) | **POST** /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes
|
||||
[**conversationsMessagesIdDelete**](ConversationsApi.md#conversationsMessagesIdDelete) | **DELETE** /conversations/messages/{id} | Delete a message sent by an agent
|
||||
[**conversationsMessagesIdGet**](ConversationsApi.md#conversationsMessagesIdGet) | **GET** /conversations/messages/{id} | Get a message
|
||||
[**conversationsMessagesIdPut**](ConversationsApi.md#conversationsMessagesIdPut) | **PUT** /conversations/messages/{id} | Update a message sent by an agent
|
||||
[**conversationsMessagesPost**](ConversationsApi.md#conversationsMessagesPost) | **POST** /conversations/messages | Send a message as an agent
|
||||
[**conversationsPushedMessagesIdDelete**](ConversationsApi.md#conversationsPushedMessagesIdDelete) | **DELETE** /conversations/pushedMessages/{id} | Delete an automated message
|
||||
[**conversationsPushedMessagesIdGet**](ConversationsApi.md#conversationsPushedMessagesIdGet) | **GET** /conversations/pushedMessages/{id} | Get an automated message
|
||||
[**conversationsPushedMessagesIdPut**](ConversationsApi.md#conversationsPushedMessagesIdPut) | **PUT** /conversations/pushedMessages/{id} | Update an automated message
|
||||
[**conversationsPushedMessagesPost**](ConversationsApi.md#conversationsPushedMessagesPost) | **POST** /conversations/pushedMessages | Send an automated message to a visitor
|
||||
|
||||
|
||||
# **conversationsAgentOnlinePingPost**
|
||||
> conversationsAgentOnlinePingPost($body)
|
||||
|
||||
Sets agent’s status to online for 2-3 minutes
|
||||
|
||||
We recommend pinging this endpoint every minute for as long as the agent has to be considered online.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ConversationsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$body = new \Brevo\Client\Model\Body14(); // \Brevo\Client\Model\Body14 | Agent fields.
|
||||
|
||||
try {
|
||||
$apiInstance->conversationsAgentOnlinePingPost($body);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ConversationsApi->conversationsAgentOnlinePingPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**\Brevo\Client\Model\Body14**](../Model/Body14.md)| Agent fields. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **conversationsMessagesIdDelete**
|
||||
> conversationsMessagesIdDelete($id)
|
||||
|
||||
Delete a message sent by an agent
|
||||
|
||||
Only agents’ messages can be deleted.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ConversationsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | ID of the message
|
||||
|
||||
try {
|
||||
$apiInstance->conversationsMessagesIdDelete($id);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ConversationsApi->conversationsMessagesIdDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| ID of the message |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **conversationsMessagesIdGet**
|
||||
> \Brevo\Client\Model\ConversationsMessage conversationsMessagesIdGet($id)
|
||||
|
||||
Get a message
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ConversationsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | ID of the message
|
||||
|
||||
try {
|
||||
$result = $apiInstance->conversationsMessagesIdGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ConversationsApi->conversationsMessagesIdGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| ID of the message |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **conversationsMessagesIdPut**
|
||||
> \Brevo\Client\Model\ConversationsMessage conversationsMessagesIdPut($id, $body)
|
||||
|
||||
Update a message sent by an agent
|
||||
|
||||
Only agents’ messages can be edited.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ConversationsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | ID of the message
|
||||
$body = new \Brevo\Client\Model\Body11(); // \Brevo\Client\Model\Body11 |
|
||||
|
||||
try {
|
||||
$result = $apiInstance->conversationsMessagesIdPut($id, $body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ConversationsApi->conversationsMessagesIdPut: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| ID of the message |
|
||||
**body** | [**\Brevo\Client\Model\Body11**](../Model/Body11.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **conversationsMessagesPost**
|
||||
> \Brevo\Client\Model\ConversationsMessage conversationsMessagesPost($body)
|
||||
|
||||
Send a message as an agent
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ConversationsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$body = new \Brevo\Client\Model\Body10(); // \Brevo\Client\Model\Body10 | Message fields.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->conversationsMessagesPost($body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ConversationsApi->conversationsMessagesPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**\Brevo\Client\Model\Body10**](../Model/Body10.md)| Message fields. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **conversationsPushedMessagesIdDelete**
|
||||
> conversationsPushedMessagesIdDelete($id)
|
||||
|
||||
Delete an automated message
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ConversationsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | ID of the message
|
||||
|
||||
try {
|
||||
$apiInstance->conversationsPushedMessagesIdDelete($id);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ConversationsApi->conversationsPushedMessagesIdDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| ID of the message |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **conversationsPushedMessagesIdGet**
|
||||
> \Brevo\Client\Model\ConversationsMessage conversationsPushedMessagesIdGet($id)
|
||||
|
||||
Get an automated message
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ConversationsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | ID of the message sent previously
|
||||
|
||||
try {
|
||||
$result = $apiInstance->conversationsPushedMessagesIdGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ConversationsApi->conversationsPushedMessagesIdGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| ID of the message sent previously |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **conversationsPushedMessagesIdPut**
|
||||
> \Brevo\Client\Model\ConversationsMessage conversationsPushedMessagesIdPut($id, $body)
|
||||
|
||||
Update an automated message
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ConversationsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | ID of the message
|
||||
$body = new \Brevo\Client\Model\Body13(); // \Brevo\Client\Model\Body13 |
|
||||
|
||||
try {
|
||||
$result = $apiInstance->conversationsPushedMessagesIdPut($id, $body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ConversationsApi->conversationsPushedMessagesIdPut: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| ID of the message |
|
||||
**body** | [**\Brevo\Client\Model\Body13**](../Model/Body13.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **conversationsPushedMessagesPost**
|
||||
> \Brevo\Client\Model\ConversationsMessage conversationsPushedMessagesPost($body)
|
||||
|
||||
Send an automated message to a visitor
|
||||
|
||||
Example of automated messages: order status, announce new features in your web app, etc.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ConversationsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$body = new \Brevo\Client\Model\Body12(); // \Brevo\Client\Model\Body12 |
|
||||
|
||||
try {
|
||||
$result = $apiInstance->conversationsPushedMessagesPost($body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ConversationsApi->conversationsPushedMessagesPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**\Brevo\Client\Model\Body12**](../Model/Body12.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
303
vendor/getbrevo/brevo-php/docs/Api/CouponsApi.md
vendored
Normal file
303
vendor/getbrevo/brevo-php/docs/Api/CouponsApi.md
vendored
Normal file
|
|
@ -0,0 +1,303 @@
|
|||
# Brevo\Client\CouponsApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createCouponCollection**](CouponsApi.md#createCouponCollection) | **POST** /couponCollections | Create а coupon collection
|
||||
[**createCoupons**](CouponsApi.md#createCoupons) | **POST** /coupons | Create coupons for a coupon collection
|
||||
[**getCouponCollection**](CouponsApi.md#getCouponCollection) | **GET** /couponCollections/{id} | Get a coupon collection by id
|
||||
[**getCouponCollections**](CouponsApi.md#getCouponCollections) | **GET** /couponCollections | Get all your coupon collections
|
||||
[**updateCouponCollection**](CouponsApi.md#updateCouponCollection) | **PATCH** /couponCollections/{id} | Update a coupon collection by id
|
||||
|
||||
|
||||
# **createCouponCollection**
|
||||
> \Brevo\Client\Model\InlineResponse2013 createCouponCollection($createCouponCollection)
|
||||
|
||||
Create а coupon collection
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CouponsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createCouponCollection = new \Brevo\Client\Model\CreateCouponCollection(); // \Brevo\Client\Model\CreateCouponCollection | Values to create a coupon collection
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createCouponCollection($createCouponCollection);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CouponsApi->createCouponCollection: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createCouponCollection** | [**\Brevo\Client\Model\CreateCouponCollection**](../Model/CreateCouponCollection.md)| Values to create a coupon collection |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InlineResponse2013**](../Model/InlineResponse2013.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createCoupons**
|
||||
> createCoupons($createCoupons)
|
||||
|
||||
Create coupons for a coupon collection
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CouponsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createCoupons = new \Brevo\Client\Model\CreateCoupons(); // \Brevo\Client\Model\CreateCoupons | Values to create coupons
|
||||
|
||||
try {
|
||||
$apiInstance->createCoupons($createCoupons);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CouponsApi->createCoupons: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createCoupons** | [**\Brevo\Client\Model\CreateCoupons**](../Model/CreateCoupons.md)| Values to create coupons |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getCouponCollection**
|
||||
> \Brevo\Client\Model\GetCouponCollection getCouponCollection($id)
|
||||
|
||||
Get a coupon collection by id
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CouponsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Id of the collection to return
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getCouponCollection($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CouponsApi->getCouponCollection: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Id of the collection to return |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetCouponCollection**](../Model/GetCouponCollection.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getCouponCollections**
|
||||
> \Brevo\Client\Model\GetCouponCollection getCouponCollections($limit, $offset, $sort)
|
||||
|
||||
Get all your coupon collections
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CouponsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$limit = 50; // int | Number of documents returned per page
|
||||
$offset = 0; // int | Index of the first document on the page
|
||||
$sort = "desc"; // string | Sort the results by creation time in ascending/descending order
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getCouponCollections($limit, $offset, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CouponsApi->getCouponCollections: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**limit** | **int**| Number of documents returned per page | [optional] [default to 50]
|
||||
**offset** | **int**| Index of the first document on the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results by creation time in ascending/descending order | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetCouponCollection**](../Model/GetCouponCollection.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateCouponCollection**
|
||||
> \Brevo\Client\Model\InlineResponse2002 updateCouponCollection($id, $updateCouponCollection)
|
||||
|
||||
Update a coupon collection by id
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\CouponsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Id of the collection to update
|
||||
$updateCouponCollection = new \Brevo\Client\Model\UpdateCouponCollection(); // \Brevo\Client\Model\UpdateCouponCollection | Values to update the coupon collection
|
||||
|
||||
try {
|
||||
$result = $apiInstance->updateCouponCollection($id, $updateCouponCollection);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling CouponsApi->updateCouponCollection: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Id of the collection to update |
|
||||
**updateCouponCollection** | [**\Brevo\Client\Model\UpdateCouponCollection**](../Model/UpdateCouponCollection.md)| Values to update the coupon collection |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InlineResponse2002**](../Model/InlineResponse2002.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
591
vendor/getbrevo/brevo-php/docs/Api/DealsApi.md
vendored
Normal file
591
vendor/getbrevo/brevo-php/docs/Api/DealsApi.md
vendored
Normal file
|
|
@ -0,0 +1,591 @@
|
|||
# Brevo\Client\DealsApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**crmAttributesDealsGet**](DealsApi.md#crmAttributesDealsGet) | **GET** /crm/attributes/deals | Get deal attributes
|
||||
[**crmDealsGet**](DealsApi.md#crmDealsGet) | **GET** /crm/deals | Get all deals
|
||||
[**crmDealsIdDelete**](DealsApi.md#crmDealsIdDelete) | **DELETE** /crm/deals/{id} | Delete a deal
|
||||
[**crmDealsIdGet**](DealsApi.md#crmDealsIdGet) | **GET** /crm/deals/{id} | Get a deal
|
||||
[**crmDealsIdPatch**](DealsApi.md#crmDealsIdPatch) | **PATCH** /crm/deals/{id} | Update a deal
|
||||
[**crmDealsLinkUnlinkIdPatch**](DealsApi.md#crmDealsLinkUnlinkIdPatch) | **PATCH** /crm/deals/link-unlink/{id} | Link and Unlink a deal with contacts and companies
|
||||
[**crmDealsPost**](DealsApi.md#crmDealsPost) | **POST** /crm/deals | Create a deal
|
||||
[**crmPipelineDetailsAllGet**](DealsApi.md#crmPipelineDetailsAllGet) | **GET** /crm/pipeline/details/all | Get all pipelines
|
||||
[**crmPipelineDetailsGet**](DealsApi.md#crmPipelineDetailsGet) | **GET** /crm/pipeline/details | Get pipeline stages
|
||||
[**crmPipelineDetailsPipelineIDGet**](DealsApi.md#crmPipelineDetailsPipelineIDGet) | **GET** /crm/pipeline/details/{pipelineID} | Get a pipeline
|
||||
|
||||
|
||||
# **crmAttributesDealsGet**
|
||||
> \Brevo\Client\Model\DealAttributes crmAttributesDealsGet()
|
||||
|
||||
Get deal attributes
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DealsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmAttributesDealsGet();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DealsApi->crmAttributesDealsGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\DealAttributes**](../Model/DealAttributes.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmDealsGet**
|
||||
> \Brevo\Client\Model\DealsList crmDealsGet($filtersAttributesDealName, $filtersLinkedCompaniesIds, $filtersLinkedContactsIds, $offset, $limit, $sort, $sortBy)
|
||||
|
||||
Get all deals
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DealsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$filtersAttributesDealName = "filtersAttributesDealName_example"; // string | Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\"
|
||||
$filtersLinkedCompaniesIds = "filtersLinkedCompaniesIds_example"; // string | Filter by linked companies ids
|
||||
$filtersLinkedContactsIds = "filtersLinkedContactsIds_example"; // string | Filter by linked companies ids
|
||||
$offset = 789; // int | Index of the first document of the page
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
||||
$sortBy = "sortBy_example"; // string | The field used to sort field names.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmDealsGet($filtersAttributesDealName, $filtersLinkedCompaniesIds, $filtersLinkedContactsIds, $offset, $limit, $sort, $sortBy);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DealsApi->crmDealsGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filtersAttributesDealName** | **string**| Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\" | [optional]
|
||||
**filtersLinkedCompaniesIds** | **string**| Filter by linked companies ids | [optional]
|
||||
**filtersLinkedContactsIds** | **string**| Filter by linked companies ids | [optional]
|
||||
**offset** | **int**| Index of the first document of the page | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional]
|
||||
**sortBy** | **string**| The field used to sort field names. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\DealsList**](../Model/DealsList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmDealsIdDelete**
|
||||
> crmDealsIdDelete($id)
|
||||
|
||||
Delete a deal
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DealsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
|
||||
try {
|
||||
$apiInstance->crmDealsIdDelete($id);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DealsApi->crmDealsIdDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmDealsIdGet**
|
||||
> \Brevo\Client\Model\Deal crmDealsIdGet($id)
|
||||
|
||||
Get a deal
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DealsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmDealsIdGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DealsApi->crmDealsIdGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Deal**](../Model/Deal.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmDealsIdPatch**
|
||||
> crmDealsIdPatch($id, $body)
|
||||
|
||||
Update a deal
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DealsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
$body = new \Brevo\Client\Model\Body6(); // \Brevo\Client\Model\Body6 | Updated deal details.
|
||||
|
||||
try {
|
||||
$apiInstance->crmDealsIdPatch($id, $body);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DealsApi->crmDealsIdPatch: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
**body** | [**\Brevo\Client\Model\Body6**](../Model/Body6.md)| Updated deal details. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmDealsLinkUnlinkIdPatch**
|
||||
> crmDealsLinkUnlinkIdPatch($id, $body)
|
||||
|
||||
Link and Unlink a deal with contacts and companies
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DealsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
$body = new \Brevo\Client\Model\Body7(); // \Brevo\Client\Model\Body7 | Linked / Unlinked contacts and companies ids.
|
||||
|
||||
try {
|
||||
$apiInstance->crmDealsLinkUnlinkIdPatch($id, $body);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DealsApi->crmDealsLinkUnlinkIdPatch: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
**body** | [**\Brevo\Client\Model\Body7**](../Model/Body7.md)| Linked / Unlinked contacts and companies ids. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmDealsPost**
|
||||
> \Brevo\Client\Model\InlineResponse2011 crmDealsPost($body)
|
||||
|
||||
Create a deal
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DealsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$body = new \Brevo\Client\Model\Body5(); // \Brevo\Client\Model\Body5 | Deal create data.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmDealsPost($body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DealsApi->crmDealsPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**\Brevo\Client\Model\Body5**](../Model/Body5.md)| Deal create data. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InlineResponse2011**](../Model/InlineResponse2011.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmPipelineDetailsAllGet**
|
||||
> \Brevo\Client\Model\Pipelines crmPipelineDetailsAllGet()
|
||||
|
||||
Get all pipelines
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DealsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmPipelineDetailsAllGet();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DealsApi->crmPipelineDetailsAllGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Pipelines**](../Model/Pipelines.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmPipelineDetailsGet**
|
||||
> \Brevo\Client\Model\Pipeline crmPipelineDetailsGet()
|
||||
|
||||
Get pipeline stages
|
||||
|
||||
This endpoint is deprecated. Prefer /crm/pipeline/details/{pipelineID} instead.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DealsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmPipelineDetailsGet();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DealsApi->crmPipelineDetailsGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Pipeline**](../Model/Pipeline.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmPipelineDetailsPipelineIDGet**
|
||||
> \Brevo\Client\Model\Pipelines crmPipelineDetailsPipelineIDGet($pipelineID)
|
||||
|
||||
Get a pipeline
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DealsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$pipelineID = "pipelineID_example"; // string |
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmPipelineDetailsPipelineIDGet($pipelineID);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DealsApi->crmPipelineDetailsPipelineIDGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pipelineID** | **string**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Pipelines**](../Model/Pipelines.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
293
vendor/getbrevo/brevo-php/docs/Api/DomainsApi.md
vendored
Normal file
293
vendor/getbrevo/brevo-php/docs/Api/DomainsApi.md
vendored
Normal file
|
|
@ -0,0 +1,293 @@
|
|||
# Brevo\Client\DomainsApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**authenticateDomain**](DomainsApi.md#authenticateDomain) | **PUT** /senders/domains/{domainName}/authenticate | Authenticate a domain
|
||||
[**createDomain**](DomainsApi.md#createDomain) | **POST** /senders/domains | Create a new domain
|
||||
[**deleteDomain**](DomainsApi.md#deleteDomain) | **DELETE** /senders/domains/{domainName} | Delete a domain
|
||||
[**getDomainConfiguration**](DomainsApi.md#getDomainConfiguration) | **GET** /senders/domains/{domainName} | Validate domain configuration
|
||||
[**getDomains**](DomainsApi.md#getDomains) | **GET** /senders/domains | Get the list of all your domains
|
||||
|
||||
|
||||
# **authenticateDomain**
|
||||
> \Brevo\Client\Model\AuthenticateDomainModel authenticateDomain($domainName)
|
||||
|
||||
Authenticate a domain
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DomainsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$domainName = "domainName_example"; // string | Domain name
|
||||
|
||||
try {
|
||||
$result = $apiInstance->authenticateDomain($domainName);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DomainsApi->authenticateDomain: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**domainName** | **string**| Domain name |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\AuthenticateDomainModel**](../Model/AuthenticateDomainModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createDomain**
|
||||
> \Brevo\Client\Model\CreateDomainModel createDomain($domainName)
|
||||
|
||||
Create a new domain
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DomainsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$domainName = new \Brevo\Client\Model\CreateDomain(); // \Brevo\Client\Model\CreateDomain | domain's name
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createDomain($domainName);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DomainsApi->createDomain: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**domainName** | [**\Brevo\Client\Model\CreateDomain**](../Model/CreateDomain.md)| domain's name | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateDomainModel**](../Model/CreateDomainModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteDomain**
|
||||
> deleteDomain($domainName)
|
||||
|
||||
Delete a domain
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DomainsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$domainName = "domainName_example"; // string | Domain name
|
||||
|
||||
try {
|
||||
$apiInstance->deleteDomain($domainName);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DomainsApi->deleteDomain: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**domainName** | **string**| Domain name |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getDomainConfiguration**
|
||||
> \Brevo\Client\Model\GetDomainConfigurationModel getDomainConfiguration($domainName)
|
||||
|
||||
Validate domain configuration
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DomainsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$domainName = "domainName_example"; // string | Domain name
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getDomainConfiguration($domainName);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DomainsApi->getDomainConfiguration: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**domainName** | **string**| Domain name |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetDomainConfigurationModel**](../Model/GetDomainConfigurationModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getDomains**
|
||||
> \Brevo\Client\Model\GetDomainsList getDomains()
|
||||
|
||||
Get the list of all your domains
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\DomainsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getDomains();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling DomainsApi->getDomains: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetDomainsList**](../Model/GetDomainsList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
751
vendor/getbrevo/brevo-php/docs/Api/EcommerceApi.md
vendored
Normal file
751
vendor/getbrevo/brevo-php/docs/Api/EcommerceApi.md
vendored
Normal file
|
|
@ -0,0 +1,751 @@
|
|||
# Brevo\Client\EcommerceApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createBatchOrder**](EcommerceApi.md#createBatchOrder) | **POST** /orders/status/batch | Create orders in batch
|
||||
[**createOrder**](EcommerceApi.md#createOrder) | **POST** /orders/status | Managing the status of the order
|
||||
[**createUpdateBatchCategory**](EcommerceApi.md#createUpdateBatchCategory) | **POST** /categories/batch | Create categories in batch
|
||||
[**createUpdateBatchProducts**](EcommerceApi.md#createUpdateBatchProducts) | **POST** /products/batch | Create products in batch
|
||||
[**createUpdateCategory**](EcommerceApi.md#createUpdateCategory) | **POST** /categories | Create/Update a category
|
||||
[**createUpdateProduct**](EcommerceApi.md#createUpdateProduct) | **POST** /products | Create/Update a product
|
||||
[**ecommerceActivatePost**](EcommerceApi.md#ecommerceActivatePost) | **POST** /ecommerce/activate | Activate the eCommerce app
|
||||
[**getCategories**](EcommerceApi.md#getCategories) | **GET** /categories | Return all your categories
|
||||
[**getCategoryInfo**](EcommerceApi.md#getCategoryInfo) | **GET** /categories/{id} | Get a category details
|
||||
[**getOrders**](EcommerceApi.md#getOrders) | **GET** /orders | Get order details
|
||||
[**getProductInfo**](EcommerceApi.md#getProductInfo) | **GET** /products/{id} | Get a product's details
|
||||
[**getProducts**](EcommerceApi.md#getProducts) | **GET** /products | Return all your products
|
||||
|
||||
|
||||
# **createBatchOrder**
|
||||
> createBatchOrder($orderBatch)
|
||||
|
||||
Create orders in batch
|
||||
|
||||
Create multiple orders at one time instead of one order at a time
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$orderBatch = new \Brevo\Client\Model\OrderBatch(); // \Brevo\Client\Model\OrderBatch |
|
||||
|
||||
try {
|
||||
$apiInstance->createBatchOrder($orderBatch);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->createBatchOrder: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**orderBatch** | [**\Brevo\Client\Model\OrderBatch**](../Model/OrderBatch.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createOrder**
|
||||
> createOrder($order)
|
||||
|
||||
Managing the status of the order
|
||||
|
||||
Manages the transactional status of the order
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$order = new \Brevo\Client\Model\Order(); // \Brevo\Client\Model\Order |
|
||||
|
||||
try {
|
||||
$apiInstance->createOrder($order);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->createOrder: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**order** | [**\Brevo\Client\Model\Order**](../Model/Order.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createUpdateBatchCategory**
|
||||
> \Brevo\Client\Model\CreateUpdateBatchCategoryModel createUpdateBatchCategory($createUpdateBatchCategory)
|
||||
|
||||
Create categories in batch
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createUpdateBatchCategory = new \Brevo\Client\Model\CreateUpdateBatchCategory(); // \Brevo\Client\Model\CreateUpdateBatchCategory | Values to create a batch of categories
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createUpdateBatchCategory($createUpdateBatchCategory);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->createUpdateBatchCategory: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createUpdateBatchCategory** | [**\Brevo\Client\Model\CreateUpdateBatchCategory**](../Model/CreateUpdateBatchCategory.md)| Values to create a batch of categories |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateUpdateBatchCategoryModel**](../Model/CreateUpdateBatchCategoryModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createUpdateBatchProducts**
|
||||
> \Brevo\Client\Model\CreateUpdateBatchProductsModel createUpdateBatchProducts($createUpdateBatchProducts)
|
||||
|
||||
Create products in batch
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createUpdateBatchProducts = new \Brevo\Client\Model\CreateUpdateBatchProducts(); // \Brevo\Client\Model\CreateUpdateBatchProducts | Values to create a batch of products
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createUpdateBatchProducts($createUpdateBatchProducts);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->createUpdateBatchProducts: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createUpdateBatchProducts** | [**\Brevo\Client\Model\CreateUpdateBatchProducts**](../Model/CreateUpdateBatchProducts.md)| Values to create a batch of products |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateUpdateBatchProductsModel**](../Model/CreateUpdateBatchProductsModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createUpdateCategory**
|
||||
> \Brevo\Client\Model\CreateCategoryModel createUpdateCategory($createUpdateCategory)
|
||||
|
||||
Create/Update a category
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createUpdateCategory = new \Brevo\Client\Model\CreateUpdateCategory(); // \Brevo\Client\Model\CreateUpdateCategory | Values to create/update a category
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createUpdateCategory($createUpdateCategory);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->createUpdateCategory: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createUpdateCategory** | [**\Brevo\Client\Model\CreateUpdateCategory**](../Model/CreateUpdateCategory.md)| Values to create/update a category |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateCategoryModel**](../Model/CreateCategoryModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createUpdateProduct**
|
||||
> \Brevo\Client\Model\CreateProductModel createUpdateProduct($createUpdateProduct)
|
||||
|
||||
Create/Update a product
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createUpdateProduct = new \Brevo\Client\Model\CreateUpdateProduct(); // \Brevo\Client\Model\CreateUpdateProduct | Values to create/update a product
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createUpdateProduct($createUpdateProduct);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->createUpdateProduct: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createUpdateProduct** | [**\Brevo\Client\Model\CreateUpdateProduct**](../Model/CreateUpdateProduct.md)| Values to create/update a product |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateProductModel**](../Model/CreateProductModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **ecommerceActivatePost**
|
||||
> ecommerceActivatePost()
|
||||
|
||||
Activate the eCommerce app
|
||||
|
||||
Getting access to Brevo eCommerce.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$apiInstance->ecommerceActivatePost();
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->ecommerceActivatePost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getCategories**
|
||||
> \Brevo\Client\Model\GetCategories getCategories($limit, $offset, $sort, $ids, $name, $modifiedSince, $createdSince)
|
||||
|
||||
Return all your categories
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document in the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
$ids = array("ids_example"); // string[] | Filter by category ids
|
||||
$name = "name_example"; // string | Filter by category name
|
||||
$modifiedSince = "modifiedSince_example"; // string | Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
|
||||
$createdSince = "createdSince_example"; // string | Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getCategories($limit, $offset, $sort, $ids, $name, $modifiedSince, $createdSince);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->getCategories: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
**ids** | [**string[]**](../Model/string.md)| Filter by category ids | [optional]
|
||||
**name** | **string**| Filter by category name | [optional]
|
||||
**modifiedSince** | **string**| Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | [optional]
|
||||
**createdSince** | **string**| Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetCategories**](../Model/GetCategories.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getCategoryInfo**
|
||||
> \Brevo\Client\Model\GetCategoryDetails getCategoryInfo($id)
|
||||
|
||||
Get a category details
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Category ID
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getCategoryInfo($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->getCategoryInfo: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Category ID |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetCategoryDetails**](../Model/GetCategoryDetails.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getOrders**
|
||||
> \Brevo\Client\Model\GetOrders getOrders($limit, $offset, $sort, $modifiedSince, $createdSince)
|
||||
|
||||
Get order details
|
||||
|
||||
Get all the orders
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document in the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
$modifiedSince = "modifiedSince_example"; // string | Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
|
||||
$createdSince = "createdSince_example"; // string | Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getOrders($limit, $offset, $sort, $modifiedSince, $createdSince);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->getOrders: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
**modifiedSince** | **string**| Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | [optional]
|
||||
**createdSince** | **string**| Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetOrders**](../Model/GetOrders.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getProductInfo**
|
||||
> \Brevo\Client\Model\GetProductDetails getProductInfo($id)
|
||||
|
||||
Get a product's details
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Product ID
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getProductInfo($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->getProductInfo: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Product ID |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetProductDetails**](../Model/GetProductDetails.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getProducts**
|
||||
> \Brevo\Client\Model\GetProducts getProducts($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories, $modifiedSince, $createdSince)
|
||||
|
||||
Return all your products
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EcommerceApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document in the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
$ids = array("ids_example"); // string[] | Filter by product ids
|
||||
$name = "name_example"; // string | Filter by product name, minimum 3 characters should be present for search
|
||||
$priceLte = 8.14; // float | Price filter for products less than and equals to particular amount
|
||||
$priceGte = 8.14; // float | Price filter for products greater than and equals to particular amount
|
||||
$priceLt = 8.14; // float | Price filter for products less than particular amount
|
||||
$priceGt = 8.14; // float | Price filter for products greater than particular amount
|
||||
$priceEq = 8.14; // float | Price filter for products equals to particular amount
|
||||
$priceNe = 8.14; // float | Price filter for products not equals to particular amount
|
||||
$categories = array("categories_example"); // string[] | Filter by category ids
|
||||
$modifiedSince = "modifiedSince_example"; // string | Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
|
||||
$createdSince = "createdSince_example"; // string | Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getProducts($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories, $modifiedSince, $createdSince);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EcommerceApi->getProducts: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
**ids** | [**string[]**](../Model/string.md)| Filter by product ids | [optional]
|
||||
**name** | **string**| Filter by product name, minimum 3 characters should be present for search | [optional]
|
||||
**priceLte** | **float**| Price filter for products less than and equals to particular amount | [optional]
|
||||
**priceGte** | **float**| Price filter for products greater than and equals to particular amount | [optional]
|
||||
**priceLt** | **float**| Price filter for products less than particular amount | [optional]
|
||||
**priceGt** | **float**| Price filter for products greater than particular amount | [optional]
|
||||
**priceEq** | **float**| Price filter for products equals to particular amount | [optional]
|
||||
**priceNe** | **float**| Price filter for products not equals to particular amount | [optional]
|
||||
**categories** | [**string[]**](../Model/string.md)| Filter by category ids | [optional]
|
||||
**modifiedSince** | **string**| Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | [optional]
|
||||
**createdSince** | **string**| Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetProducts**](../Model/GetProducts.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
790
vendor/getbrevo/brevo-php/docs/Api/EmailCampaignsApi.md
vendored
Normal file
790
vendor/getbrevo/brevo-php/docs/Api/EmailCampaignsApi.md
vendored
Normal file
|
|
@ -0,0 +1,790 @@
|
|||
# Brevo\Client\EmailCampaignsApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createEmailCampaign**](EmailCampaignsApi.md#createEmailCampaign) | **POST** /emailCampaigns | Create an email campaign
|
||||
[**deleteEmailCampaign**](EmailCampaignsApi.md#deleteEmailCampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
||||
[**emailExportRecipients**](EmailCampaignsApi.md#emailExportRecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
|
||||
[**getAbTestCampaignResult**](EmailCampaignsApi.md#getAbTestCampaignResult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results
|
||||
[**getEmailCampaign**](EmailCampaignsApi.md#getEmailCampaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report
|
||||
[**getEmailCampaigns**](EmailCampaignsApi.md#getEmailCampaigns) | **GET** /emailCampaigns | Return all your created email campaigns
|
||||
[**getSharedTemplateUrl**](EmailCampaignsApi.md#getSharedTemplateUrl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
||||
[**sendEmailCampaignNow**](EmailCampaignsApi.md#sendEmailCampaignNow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
||||
[**sendReport**](EmailCampaignsApi.md#sendReport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign
|
||||
[**sendTestEmail**](EmailCampaignsApi.md#sendTestEmail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
||||
[**updateCampaignStatus**](EmailCampaignsApi.md#updateCampaignStatus) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
||||
[**updateEmailCampaign**](EmailCampaignsApi.md#updateEmailCampaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
||||
[**uploadImageToGallery**](EmailCampaignsApi.md#uploadImageToGallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
||||
|
||||
|
||||
# **createEmailCampaign**
|
||||
> \Brevo\Client\Model\CreateModel createEmailCampaign($emailCampaigns)
|
||||
|
||||
Create an email campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$emailCampaigns = new \Brevo\Client\Model\CreateEmailCampaign(); // \Brevo\Client\Model\CreateEmailCampaign | Values to create a campaign
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createEmailCampaign($emailCampaigns);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->createEmailCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**emailCampaigns** | [**\Brevo\Client\Model\CreateEmailCampaign**](../Model/CreateEmailCampaign.md)| Values to create a campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteEmailCampaign**
|
||||
> deleteEmailCampaign($campaignId)
|
||||
|
||||
Delete an email campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | id of the campaign
|
||||
|
||||
try {
|
||||
$apiInstance->deleteEmailCampaign($campaignId);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->deleteEmailCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| id of the campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **emailExportRecipients**
|
||||
> \Brevo\Client\Model\CreatedProcessId emailExportRecipients($campaignId, $recipientExport)
|
||||
|
||||
Export the recipients of an email campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the campaign
|
||||
$recipientExport = new \Brevo\Client\Model\EmailExportRecipients(); // \Brevo\Client\Model\EmailExportRecipients | Values to send for a recipient export request
|
||||
|
||||
try {
|
||||
$result = $apiInstance->emailExportRecipients($campaignId, $recipientExport);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->emailExportRecipients: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the campaign |
|
||||
**recipientExport** | [**\Brevo\Client\Model\EmailExportRecipients**](../Model/EmailExportRecipients.md)| Values to send for a recipient export request | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getAbTestCampaignResult**
|
||||
> \Brevo\Client\Model\AbTestCampaignResult getAbTestCampaignResult($campaignId)
|
||||
|
||||
Get an A/B test email campaign results
|
||||
|
||||
Obtain winning version of an A/B test email campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the A/B test campaign
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getAbTestCampaignResult($campaignId);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->getAbTestCampaignResult: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the A/B test campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\AbTestCampaignResult**](../Model/AbTestCampaignResult.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getEmailCampaign**
|
||||
> \Brevo\Client\Model\GetEmailCampaign getEmailCampaign($campaignId, $statistics)
|
||||
|
||||
Get an email campaign report
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the campaign
|
||||
$statistics = "statistics_example"; // string | Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getEmailCampaign($campaignId, $statistics);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->getEmailCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the campaign |
|
||||
**statistics** | **string**| Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetEmailCampaign**](../Model/GetEmailCampaign.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getEmailCampaigns**
|
||||
> \Brevo\Client\Model\GetEmailCampaigns getEmailCampaigns($type, $status, $statistics, $startDate, $endDate, $limit, $offset, $sort, $excludeHtmlContent)
|
||||
|
||||
Return all your created email campaigns
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$type = "type_example"; // string | Filter on the type of the campaigns
|
||||
$status = "status_example"; // string | Filter on the status of the campaign
|
||||
$statistics = "statistics_example"; // string | Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
|
||||
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
||||
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document in the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
$excludeHtmlContent = true; // bool | Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getEmailCampaigns($type, $status, $statistics, $startDate, $endDate, $limit, $offset, $sort, $excludeHtmlContent);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->getEmailCampaigns: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**type** | **string**| Filter on the type of the campaigns | [optional]
|
||||
**status** | **string**| Filter on the status of the campaign | [optional]
|
||||
**statistics** | **string**| Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. | [optional]
|
||||
**startDate** | **string**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
||||
**endDate** | **string**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
**excludeHtmlContent** | **bool**| Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetEmailCampaigns**](../Model/GetEmailCampaigns.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getSharedTemplateUrl**
|
||||
> \Brevo\Client\Model\GetSharedTemplateUrl getSharedTemplateUrl($campaignId)
|
||||
|
||||
Get a shared template url
|
||||
|
||||
Get a unique URL to share & import an email template from one Brevo account to another.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the campaign or template
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getSharedTemplateUrl($campaignId);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->getSharedTemplateUrl: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the campaign or template |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetSharedTemplateUrl**](../Model/GetSharedTemplateUrl.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **sendEmailCampaignNow**
|
||||
> sendEmailCampaignNow($campaignId)
|
||||
|
||||
Send an email campaign immediately, based on campaignId
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the campaign
|
||||
|
||||
try {
|
||||
$apiInstance->sendEmailCampaignNow($campaignId);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->sendEmailCampaignNow: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **sendReport**
|
||||
> sendReport($campaignId, $sendReport)
|
||||
|
||||
Send the report of a campaign
|
||||
|
||||
A PDF will be sent to the specified email addresses
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the campaign
|
||||
$sendReport = new \Brevo\Client\Model\SendReport(); // \Brevo\Client\Model\SendReport | Values for send a report
|
||||
|
||||
try {
|
||||
$apiInstance->sendReport($campaignId, $sendReport);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->sendReport: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the campaign |
|
||||
**sendReport** | [**\Brevo\Client\Model\SendReport**](../Model/SendReport.md)| Values for send a report |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **sendTestEmail**
|
||||
> sendTestEmail($campaignId, $emailTo)
|
||||
|
||||
Send an email campaign to your test list
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the campaign
|
||||
$emailTo = new \Brevo\Client\Model\SendTestEmail(); // \Brevo\Client\Model\SendTestEmail |
|
||||
|
||||
try {
|
||||
$apiInstance->sendTestEmail($campaignId, $emailTo);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->sendTestEmail: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the campaign |
|
||||
**emailTo** | [**\Brevo\Client\Model\SendTestEmail**](../Model/SendTestEmail.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateCampaignStatus**
|
||||
> updateCampaignStatus($campaignId, $status)
|
||||
|
||||
Update an email campaign status
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the campaign
|
||||
$status = new \Brevo\Client\Model\UpdateCampaignStatus(); // \Brevo\Client\Model\UpdateCampaignStatus | Status of the campaign
|
||||
|
||||
try {
|
||||
$apiInstance->updateCampaignStatus($campaignId, $status);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->updateCampaignStatus: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the campaign |
|
||||
**status** | [**\Brevo\Client\Model\UpdateCampaignStatus**](../Model/UpdateCampaignStatus.md)| Status of the campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateEmailCampaign**
|
||||
> updateEmailCampaign($campaignId, $emailCampaign)
|
||||
|
||||
Update an email campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the campaign
|
||||
$emailCampaign = new \Brevo\Client\Model\UpdateEmailCampaign(); // \Brevo\Client\Model\UpdateEmailCampaign | Values to update a campaign
|
||||
|
||||
try {
|
||||
$apiInstance->updateEmailCampaign($campaignId, $emailCampaign);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->updateEmailCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the campaign |
|
||||
**emailCampaign** | [**\Brevo\Client\Model\UpdateEmailCampaign**](../Model/UpdateEmailCampaign.md)| Values to update a campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **uploadImageToGallery**
|
||||
> \Brevo\Client\Model\UploadImageModel uploadImageToGallery($uploadImage)
|
||||
|
||||
Upload an image to your account's image gallery
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EmailCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$uploadImage = new \Brevo\Client\Model\UploadImageToGallery(); // \Brevo\Client\Model\UploadImageToGallery | Parameters to upload an image
|
||||
|
||||
try {
|
||||
$result = $apiInstance->uploadImageToGallery($uploadImage);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EmailCampaignsApi->uploadImageToGallery: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**uploadImage** | [**\Brevo\Client\Model\UploadImageToGallery**](../Model/UploadImageToGallery.md)| Parameters to upload an image |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\UploadImageModel**](../Model/UploadImageModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
67
vendor/getbrevo/brevo-php/docs/Api/EventsApi.md
vendored
Normal file
67
vendor/getbrevo/brevo-php/docs/Api/EventsApi.md
vendored
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
# Brevo\Client\EventsApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createEvent**](EventsApi.md#createEvent) | **POST** /events | Create an event
|
||||
|
||||
|
||||
# **createEvent**
|
||||
> createEvent($event)
|
||||
|
||||
Create an event
|
||||
|
||||
Create an event to track a contact's interaction.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\EventsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$event = new \Brevo\Client\Model\Event(); // \Brevo\Client\Model\Event |
|
||||
|
||||
try {
|
||||
$apiInstance->createEvent($event);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling EventsApi->createEvent: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**event** | [**\Brevo\Client\Model\Event**](../Model/Event.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
320
vendor/getbrevo/brevo-php/docs/Api/ExternalFeedsApi.md
vendored
Normal file
320
vendor/getbrevo/brevo-php/docs/Api/ExternalFeedsApi.md
vendored
Normal file
|
|
@ -0,0 +1,320 @@
|
|||
# Brevo\Client\ExternalFeedsApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createExternalFeed**](ExternalFeedsApi.md#createExternalFeed) | **POST** /feeds | Create an external feed
|
||||
[**deleteExternalFeed**](ExternalFeedsApi.md#deleteExternalFeed) | **DELETE** /feeds/{uuid} | Delete an external feed
|
||||
[**getAllExternalFeeds**](ExternalFeedsApi.md#getAllExternalFeeds) | **GET** /feeds | Fetch all external feeds
|
||||
[**getExternalFeedByUUID**](ExternalFeedsApi.md#getExternalFeedByUUID) | **GET** /feeds/{uuid} | Get an external feed by UUID
|
||||
[**updateExternalFeed**](ExternalFeedsApi.md#updateExternalFeed) | **PUT** /feeds/{uuid} | Update an external feed
|
||||
|
||||
|
||||
# **createExternalFeed**
|
||||
> \Brevo\Client\Model\InlineResponse2015 createExternalFeed($createExternalFeed)
|
||||
|
||||
Create an external feed
|
||||
|
||||
This endpoint will create an external feed.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ExternalFeedsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createExternalFeed = new \Brevo\Client\Model\CreateExternalFeed(); // \Brevo\Client\Model\CreateExternalFeed | Values to create a feed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createExternalFeed($createExternalFeed);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ExternalFeedsApi->createExternalFeed: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createExternalFeed** | [**\Brevo\Client\Model\CreateExternalFeed**](../Model/CreateExternalFeed.md)| Values to create a feed |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InlineResponse2015**](../Model/InlineResponse2015.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteExternalFeed**
|
||||
> deleteExternalFeed($uuid)
|
||||
|
||||
Delete an external feed
|
||||
|
||||
This endpoint will delete an external feed.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ExternalFeedsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$uuid = "uuid_example"; // string | UUID of the feed to delete
|
||||
|
||||
try {
|
||||
$apiInstance->deleteExternalFeed($uuid);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ExternalFeedsApi->deleteExternalFeed: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**uuid** | **string**| UUID of the feed to delete |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getAllExternalFeeds**
|
||||
> \Brevo\Client\Model\GetAllExternalFeeds getAllExternalFeeds($search, $startDate, $endDate, $sort, $authType, $limit, $offset)
|
||||
|
||||
Fetch all external feeds
|
||||
|
||||
This endpoint can fetch all created external feeds.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ExternalFeedsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$search = "search_example"; // string | Can be used to filter records by search keyword on feed name
|
||||
$startDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date.
|
||||
$endDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed.
|
||||
$authType = "authType_example"; // string | Filter the records by `authType` of the feed.
|
||||
$limit = 50; // int | Number of documents returned per page.
|
||||
$offset = 0; // int | Index of the first document on the page.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getAllExternalFeeds($search, $startDate, $endDate, $sort, $authType, $limit, $offset);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ExternalFeedsApi->getAllExternalFeeds: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**search** | **string**| Can be used to filter records by search keyword on feed name | [optional]
|
||||
**startDate** | **\DateTime**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. | [optional]
|
||||
**endDate** | **\DateTime**| Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. | [optional] [default to desc]
|
||||
**authType** | **string**| Filter the records by `authType` of the feed. | [optional]
|
||||
**limit** | **int**| Number of documents returned per page. | [optional] [default to 50]
|
||||
**offset** | **int**| Index of the first document on the page. | [optional] [default to 0]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetAllExternalFeeds**](../Model/GetAllExternalFeeds.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getExternalFeedByUUID**
|
||||
> \Brevo\Client\Model\GetExternalFeedByUUID getExternalFeedByUUID($uuid)
|
||||
|
||||
Get an external feed by UUID
|
||||
|
||||
This endpoint will update an external feed.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ExternalFeedsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$uuid = "uuid_example"; // string | UUID of the feed to fetch
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getExternalFeedByUUID($uuid);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ExternalFeedsApi->getExternalFeedByUUID: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**uuid** | **string**| UUID of the feed to fetch |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetExternalFeedByUUID**](../Model/GetExternalFeedByUUID.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateExternalFeed**
|
||||
> updateExternalFeed($uuid, $updateExternalFeed)
|
||||
|
||||
Update an external feed
|
||||
|
||||
This endpoint will update an external feed.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ExternalFeedsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$uuid = "uuid_example"; // string | UUID of the feed to update
|
||||
$updateExternalFeed = new \Brevo\Client\Model\UpdateExternalFeed(); // \Brevo\Client\Model\UpdateExternalFeed | Values to update a feed
|
||||
|
||||
try {
|
||||
$apiInstance->updateExternalFeed($uuid, $updateExternalFeed);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ExternalFeedsApi->updateExternalFeed: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**uuid** | **string**| UUID of the feed to update |
|
||||
**updateExternalFeed** | [**\Brevo\Client\Model\UpdateExternalFeed**](../Model/UpdateExternalFeed.md)| Values to update a feed |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
315
vendor/getbrevo/brevo-php/docs/Api/FilesApi.md
vendored
Normal file
315
vendor/getbrevo/brevo-php/docs/Api/FilesApi.md
vendored
Normal file
|
|
@ -0,0 +1,315 @@
|
|||
# Brevo\Client\FilesApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**crmFilesGet**](FilesApi.md#crmFilesGet) | **GET** /crm/files | Get all files
|
||||
[**crmFilesIdDataGet**](FilesApi.md#crmFilesIdDataGet) | **GET** /crm/files/{id}/data | Get file details
|
||||
[**crmFilesIdDelete**](FilesApi.md#crmFilesIdDelete) | **DELETE** /crm/files/{id} | Delete a file
|
||||
[**crmFilesIdGet**](FilesApi.md#crmFilesIdGet) | **GET** /crm/files/{id} | Download a file
|
||||
[**crmFilesPost**](FilesApi.md#crmFilesPost) | **POST** /crm/files | Upload a file
|
||||
|
||||
|
||||
# **crmFilesGet**
|
||||
> \Brevo\Client\Model\FileList crmFilesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort)
|
||||
|
||||
Get all files
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FilesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$entity = "entity_example"; // string | Filter by file entity type
|
||||
$entityIds = "entityIds_example"; // string | Filter by file entity IDs
|
||||
$dateFrom = 56; // int | dateFrom to date range filter type (timestamp in milliseconds)
|
||||
$dateTo = 56; // int | dateTo to date range filter type (timestamp in milliseconds)
|
||||
$offset = 789; // int | Index of the first document of the page
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmFilesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FilesApi->crmFilesGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**entity** | **string**| Filter by file entity type | [optional]
|
||||
**entityIds** | **string**| Filter by file entity IDs | [optional]
|
||||
**dateFrom** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional]
|
||||
**dateTo** | **int**| dateTo to date range filter type (timestamp in milliseconds) | [optional]
|
||||
**offset** | **int**| Index of the first document of the page | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\FileList**](../Model/FileList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmFilesIdDataGet**
|
||||
> \Brevo\Client\Model\FileData crmFilesIdDataGet($id)
|
||||
|
||||
Get file details
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FilesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | File id to get file data.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmFilesIdDataGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FilesApi->crmFilesIdDataGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| File id to get file data. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\FileData**](../Model/FileData.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmFilesIdDelete**
|
||||
> crmFilesIdDelete($id)
|
||||
|
||||
Delete a file
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FilesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | File id to delete.
|
||||
|
||||
try {
|
||||
$apiInstance->crmFilesIdDelete($id);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FilesApi->crmFilesIdDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| File id to delete. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmFilesIdGet**
|
||||
> \Brevo\Client\Model\FileDownloadableLink crmFilesIdGet($id)
|
||||
|
||||
Download a file
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FilesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | File id to download.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmFilesIdGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FilesApi->crmFilesIdGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| File id to download. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\FileDownloadableLink**](../Model/FileDownloadableLink.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmFilesPost**
|
||||
> \Brevo\Client\Model\FileData crmFilesPost($file, $dealId, $contactId, $companyId)
|
||||
|
||||
Upload a file
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FilesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$file = "/path/to/file.txt"; // \SplFileObject | File data to create a file.
|
||||
$dealId = "dealId_example"; // string | Deal id linked to a file
|
||||
$contactId = 789; // int | Contact id linked to a file
|
||||
$companyId = "companyId_example"; // string | Company id linked to a file
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmFilesPost($file, $dealId, $contactId, $companyId);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FilesApi->crmFilesPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**file** | **\SplFileObject**| File data to create a file. |
|
||||
**dealId** | **string**| Deal id linked to a file | [optional]
|
||||
**contactId** | **int**| Contact id linked to a file | [optional]
|
||||
**companyId** | **string**| Company id linked to a file | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\FileData**](../Model/FileData.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
366
vendor/getbrevo/brevo-php/docs/Api/FoldersApi.md
vendored
Normal file
366
vendor/getbrevo/brevo-php/docs/Api/FoldersApi.md
vendored
Normal file
|
|
@ -0,0 +1,366 @@
|
|||
# Brevo\Client\FoldersApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createFolder**](FoldersApi.md#createFolder) | **POST** /contacts/folders | Create a folder
|
||||
[**deleteFolder**](FoldersApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
||||
[**getFolder**](FoldersApi.md#getFolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
||||
[**getFolderLists**](FoldersApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
||||
[**getFolders**](FoldersApi.md#getFolders) | **GET** /contacts/folders | Get all folders
|
||||
[**updateFolder**](FoldersApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
||||
|
||||
|
||||
# **createFolder**
|
||||
> \Brevo\Client\Model\CreateModel createFolder($createFolder)
|
||||
|
||||
Create a folder
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FoldersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createFolder = new \Brevo\Client\Model\CreateUpdateFolder(); // \Brevo\Client\Model\CreateUpdateFolder | Name of the folder
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createFolder($createFolder);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FoldersApi->createFolder: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createFolder** | [**\Brevo\Client\Model\CreateUpdateFolder**](../Model/CreateUpdateFolder.md)| Name of the folder |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteFolder**
|
||||
> deleteFolder($folderId)
|
||||
|
||||
Delete a folder (and all its lists)
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FoldersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$folderId = 789; // int | Id of the folder
|
||||
|
||||
try {
|
||||
$apiInstance->deleteFolder($folderId);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FoldersApi->deleteFolder: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**folderId** | **int**| Id of the folder |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getFolder**
|
||||
> \Brevo\Client\Model\GetFolder getFolder($folderId)
|
||||
|
||||
Returns a folder's details
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FoldersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$folderId = 789; // int | id of the folder
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getFolder($folderId);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FoldersApi->getFolder: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**folderId** | **int**| id of the folder |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetFolder**](../Model/GetFolder.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getFolderLists**
|
||||
> \Brevo\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort)
|
||||
|
||||
Get lists in a folder
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FoldersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$folderId = 789; // int | Id of the folder
|
||||
$limit = 10; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document of the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FoldersApi->getFolderLists: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**folderId** | **int**| Id of the folder |
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 10]
|
||||
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetFolderLists**](../Model/GetFolderLists.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getFolders**
|
||||
> \Brevo\Client\Model\GetFolders getFolders($limit, $offset, $sort)
|
||||
|
||||
Get all folders
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FoldersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$limit = 10; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document of the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getFolders($limit, $offset, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FoldersApi->getFolders: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**limit** | **int**| Number of documents per page | [default to 10]
|
||||
**offset** | **int**| Index of the first document of the page | [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetFolders**](../Model/GetFolders.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateFolder**
|
||||
> updateFolder($folderId, $updateFolder)
|
||||
|
||||
Update a folder
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\FoldersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$folderId = 789; // int | Id of the folder
|
||||
$updateFolder = new \Brevo\Client\Model\CreateUpdateFolder(); // \Brevo\Client\Model\CreateUpdateFolder | Name of the folder
|
||||
|
||||
try {
|
||||
$apiInstance->updateFolder($folderId, $updateFolder);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling FoldersApi->updateFolder: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**folderId** | **int**| Id of the folder |
|
||||
**updateFolder** | [**\Brevo\Client\Model\CreateUpdateFolder**](../Model/CreateUpdateFolder.md)| Name of the folder |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
198
vendor/getbrevo/brevo-php/docs/Api/InboundParsingApi.md
vendored
Normal file
198
vendor/getbrevo/brevo-php/docs/Api/InboundParsingApi.md
vendored
Normal file
|
|
@ -0,0 +1,198 @@
|
|||
# Brevo\Client\InboundParsingApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**getInboundEmailAttachment**](InboundParsingApi.md#getInboundEmailAttachment) | **GET** /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token.
|
||||
[**getInboundEmailEvents**](InboundParsingApi.md#getInboundEmailEvents) | **GET** /inbound/events | Get the list of all the events for the received emails.
|
||||
[**getInboundEmailEventsByUuid**](InboundParsingApi.md#getInboundEmailEventsByUuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email.
|
||||
|
||||
|
||||
# **getInboundEmailAttachment**
|
||||
> \SplFileObject getInboundEmailAttachment($downloadToken)
|
||||
|
||||
Retrieve inbound attachment with download token.
|
||||
|
||||
This endpoint will retrieve inbound attachment with download token.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\InboundParsingApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$downloadToken = "downloadToken_example"; // string | Token to fetch a particular attachment
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getInboundEmailAttachment($downloadToken);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling InboundParsingApi->getInboundEmailAttachment: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**downloadToken** | **string**| Token to fetch a particular attachment |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\SplFileObject**](../Model/\SplFileObject.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getInboundEmailEvents**
|
||||
> \Brevo\Client\Model\GetInboundEmailEvents getInboundEmailEvents($sender, $startDate, $endDate, $limit, $offset, $sort)
|
||||
|
||||
Get the list of all the events for the received emails.
|
||||
|
||||
This endpoint will show the list of all the events for the received emails.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\InboundParsingApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$sender = "sender_example"; // string | Email address of the sender.
|
||||
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month.
|
||||
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
||||
$limit = 100; // int | Number of documents returned per page
|
||||
$offset = 0; // int | Index of the first document on the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getInboundEmailEvents($sender, $startDate, $endDate, $limit, $offset, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling InboundParsingApi->getInboundEmailEvents: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**sender** | **string**| Email address of the sender. | [optional]
|
||||
**startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
||||
**endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
||||
**limit** | **int**| Number of documents returned per page | [optional] [default to 100]
|
||||
**offset** | **int**| Index of the first document on the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetInboundEmailEvents**](../Model/GetInboundEmailEvents.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getInboundEmailEventsByUuid**
|
||||
> \Brevo\Client\Model\GetInboundEmailEventsByUuid getInboundEmailEventsByUuid($uuid)
|
||||
|
||||
Fetch all events history for one particular received email.
|
||||
|
||||
This endpoint will show the list of all events history for one particular received email.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\InboundParsingApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$uuid = "uuid_example"; // string | UUID to fetch events specific to recieved email
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getInboundEmailEventsByUuid($uuid);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling InboundParsingApi->getInboundEmailEventsByUuid: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**uuid** | **string**| UUID to fetch events specific to recieved email |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetInboundEmailEventsByUuid**](../Model/GetInboundEmailEventsByUuid.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
552
vendor/getbrevo/brevo-php/docs/Api/ListsApi.md
vendored
Normal file
552
vendor/getbrevo/brevo-php/docs/Api/ListsApi.md
vendored
Normal file
|
|
@ -0,0 +1,552 @@
|
|||
# Brevo\Client\ListsApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**addContactToList**](ListsApi.md#addContactToList) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
||||
[**createList**](ListsApi.md#createList) | **POST** /contacts/lists | Create a list
|
||||
[**deleteList**](ListsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list
|
||||
[**getContactsFromList**](ListsApi.md#getContactsFromList) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
||||
[**getFolderLists**](ListsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
||||
[**getList**](ListsApi.md#getList) | **GET** /contacts/lists/{listId} | Get a list's details
|
||||
[**getLists**](ListsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
|
||||
[**removeContactFromList**](ListsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
||||
[**updateList**](ListsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
|
||||
|
||||
|
||||
# **addContactToList**
|
||||
> \Brevo\Client\Model\PostContactInfo addContactToList($listId, $contactEmails)
|
||||
|
||||
Add existing contacts to a list
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ListsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$listId = 789; // int | Id of the list
|
||||
$contactEmails = new \Brevo\Client\Model\AddContactToList(); // \Brevo\Client\Model\AddContactToList | Emails addresses OR IDs of the contacts
|
||||
|
||||
try {
|
||||
$result = $apiInstance->addContactToList($listId, $contactEmails);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ListsApi->addContactToList: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**listId** | **int**| Id of the list |
|
||||
**contactEmails** | [**\Brevo\Client\Model\AddContactToList**](../Model/AddContactToList.md)| Emails addresses OR IDs of the contacts |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\PostContactInfo**](../Model/PostContactInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createList**
|
||||
> \Brevo\Client\Model\CreateModel createList($createList)
|
||||
|
||||
Create a list
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ListsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createList = new \Brevo\Client\Model\CreateList(); // \Brevo\Client\Model\CreateList | Values to create a list
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createList($createList);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ListsApi->createList: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createList** | [**\Brevo\Client\Model\CreateList**](../Model/CreateList.md)| Values to create a list |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteList**
|
||||
> deleteList($listId)
|
||||
|
||||
Delete a list
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ListsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$listId = 789; // int | Id of the list
|
||||
|
||||
try {
|
||||
$apiInstance->deleteList($listId);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ListsApi->deleteList: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**listId** | **int**| Id of the list |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getContactsFromList**
|
||||
> \Brevo\Client\Model\GetContacts getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort)
|
||||
|
||||
Get contacts in a list
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ListsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$listId = 789; // int | Id of the list
|
||||
$modifiedSince = "modifiedSince_example"; // string | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document of the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ListsApi->getContactsFromList: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**listId** | **int**| Id of the list |
|
||||
**modifiedSince** | **string**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetContacts**](../Model/GetContacts.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getFolderLists**
|
||||
> \Brevo\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort)
|
||||
|
||||
Get lists in a folder
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ListsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$folderId = 789; // int | Id of the folder
|
||||
$limit = 10; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document of the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ListsApi->getFolderLists: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**folderId** | **int**| Id of the folder |
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 10]
|
||||
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetFolderLists**](../Model/GetFolderLists.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getList**
|
||||
> \Brevo\Client\Model\GetExtendedList getList($listId)
|
||||
|
||||
Get a list's details
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ListsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$listId = 789; // int | Id of the list
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getList($listId);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ListsApi->getList: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**listId** | **int**| Id of the list |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetExtendedList**](../Model/GetExtendedList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getLists**
|
||||
> \Brevo\Client\Model\GetLists getLists($limit, $offset, $sort)
|
||||
|
||||
Get all the lists
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ListsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$limit = 10; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document of the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getLists($limit, $offset, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ListsApi->getLists: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 10]
|
||||
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetLists**](../Model/GetLists.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **removeContactFromList**
|
||||
> \Brevo\Client\Model\PostContactInfo removeContactFromList($listId, $contactEmails)
|
||||
|
||||
Delete a contact from a list
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ListsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$listId = 789; // int | Id of the list
|
||||
$contactEmails = new \Brevo\Client\Model\RemoveContactFromList(); // \Brevo\Client\Model\RemoveContactFromList | Emails addresses OR IDs of the contacts
|
||||
|
||||
try {
|
||||
$result = $apiInstance->removeContactFromList($listId, $contactEmails);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ListsApi->removeContactFromList: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**listId** | **int**| Id of the list |
|
||||
**contactEmails** | [**\Brevo\Client\Model\RemoveContactFromList**](../Model/RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\PostContactInfo**](../Model/PostContactInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateList**
|
||||
> updateList($listId, $updateList)
|
||||
|
||||
Update a list
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ListsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$listId = 789; // int | Id of the list
|
||||
$updateList = new \Brevo\Client\Model\UpdateList(); // \Brevo\Client\Model\UpdateList | Values to update a list
|
||||
|
||||
try {
|
||||
$apiInstance->updateList($listId, $updateList);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ListsApi->updateList: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**listId** | **int**| Id of the list |
|
||||
**updateList** | [**\Brevo\Client\Model\UpdateList**](../Model/UpdateList.md)| Values to update a list |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
961
vendor/getbrevo/brevo-php/docs/Api/MasterAccountApi.md
vendored
Normal file
961
vendor/getbrevo/brevo-php/docs/Api/MasterAccountApi.md
vendored
Normal file
|
|
@ -0,0 +1,961 @@
|
|||
# Brevo\Client\MasterAccountApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**corporateGroupIdPut**](MasterAccountApi.md#corporateGroupIdPut) | **PUT** /corporate/group/{id} | Update a group of sub-accounts
|
||||
[**corporateGroupPost**](MasterAccountApi.md#corporateGroupPost) | **POST** /corporate/group | Create a new group of sub-accounts
|
||||
[**corporateMasterAccountGet**](MasterAccountApi.md#corporateMasterAccountGet) | **GET** /corporate/masterAccount | Get the details of requested master account
|
||||
[**corporateSubAccountGet**](MasterAccountApi.md#corporateSubAccountGet) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
|
||||
[**corporateSubAccountIdApplicationsTogglePut**](MasterAccountApi.md#corporateSubAccountIdApplicationsTogglePut) | **PUT** /corporate/subAccount/{id}/applications/toggle | Enable/disable sub-account application(s)
|
||||
[**corporateSubAccountIdDelete**](MasterAccountApi.md#corporateSubAccountIdDelete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
|
||||
[**corporateSubAccountIdGet**](MasterAccountApi.md#corporateSubAccountIdGet) | **GET** /corporate/subAccount/{id} | Get sub-account details
|
||||
[**corporateSubAccountIdPlanPut**](MasterAccountApi.md#corporateSubAccountIdPlanPut) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
|
||||
[**corporateSubAccountKeyPost**](MasterAccountApi.md#corporateSubAccountKeyPost) | **POST** /corporate/subAccount/key | Create an API key for a sub-account
|
||||
[**corporateSubAccountPost**](MasterAccountApi.md#corporateSubAccountPost) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
|
||||
[**corporateSubAccountSsoTokenPost**](MasterAccountApi.md#corporateSubAccountSsoTokenPost) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Brevo
|
||||
[**corporateUserRevokeEmailDelete**](MasterAccountApi.md#corporateUserRevokeEmailDelete) | **DELETE** /corporate/user/revoke/{email} | Revoke an admin user
|
||||
[**getAccountActivity**](MasterAccountApi.md#getAccountActivity) | **GET** /organization/activities | Get user activity logs
|
||||
[**getCorporateInvitedUsersList**](MasterAccountApi.md#getCorporateInvitedUsersList) | **GET** /corporate/invited/users | Get the list of all admin users
|
||||
[**getSubAccountGroups**](MasterAccountApi.md#getSubAccountGroups) | **GET** /corporate/groups | Get the list of groups
|
||||
[**inviteAdminUser**](MasterAccountApi.md#inviteAdminUser) | **POST** /corporate/user/invitation/send | Send invitation to an admin user
|
||||
|
||||
|
||||
# **corporateGroupIdPut**
|
||||
> corporateGroupIdPut($id, $body)
|
||||
|
||||
Update a group of sub-accounts
|
||||
|
||||
This endpoint allows you to update a group of sub-accounts
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Id of the group
|
||||
$body = new \Brevo\Client\Model\Body1(); // \Brevo\Client\Model\Body1 | Group details to be updated.
|
||||
|
||||
try {
|
||||
$apiInstance->corporateGroupIdPut($id, $body);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateGroupIdPut: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Id of the group |
|
||||
**body** | [**\Brevo\Client\Model\Body1**](../Model/Body1.md)| Group details to be updated. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateGroupPost**
|
||||
> \Brevo\Client\Model\InlineResponse201 corporateGroupPost($body)
|
||||
|
||||
Create a new group of sub-accounts
|
||||
|
||||
This endpoint allows to create a group of sub-accounts
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$body = new \Brevo\Client\Model\Body(); // \Brevo\Client\Model\Body | Group details to be created.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->corporateGroupPost($body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateGroupPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**\Brevo\Client\Model\Body**](../Model/Body.md)| Group details to be created. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InlineResponse201**](../Model/InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateMasterAccountGet**
|
||||
> \Brevo\Client\Model\MasterDetailsResponse corporateMasterAccountGet()
|
||||
|
||||
Get the details of requested master account
|
||||
|
||||
This endpoint will provide the details of the master account.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->corporateMasterAccountGet();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateMasterAccountGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\MasterDetailsResponse**](../Model/MasterDetailsResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateSubAccountGet**
|
||||
> \Brevo\Client\Model\SubAccountsResponse corporateSubAccountGet($offset, $limit)
|
||||
|
||||
Get the list of all the sub-accounts of the master account.
|
||||
|
||||
This endpoint will provide the list all the sub-accounts of the master account.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$offset = 56; // int | Index of the first sub-account in the page
|
||||
$limit = 56; // int | Number of sub-accounts to be displayed on each page
|
||||
|
||||
try {
|
||||
$result = $apiInstance->corporateSubAccountGet($offset, $limit);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateSubAccountGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**offset** | **int**| Index of the first sub-account in the page |
|
||||
**limit** | **int**| Number of sub-accounts to be displayed on each page |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\SubAccountsResponse**](../Model/SubAccountsResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateSubAccountIdApplicationsTogglePut**
|
||||
> corporateSubAccountIdApplicationsTogglePut($id, $toggleApplications)
|
||||
|
||||
Enable/disable sub-account application(s)
|
||||
|
||||
API endpoint for the Corporate owner to enable/disable applications on the sub-account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = 789; // int | Id of the sub-account organization (mandatory)
|
||||
$toggleApplications = new \Brevo\Client\Model\SubAccountAppsToggleRequest(); // \Brevo\Client\Model\SubAccountAppsToggleRequest | List of applications to activate or deactivate on a sub-account
|
||||
|
||||
try {
|
||||
$apiInstance->corporateSubAccountIdApplicationsTogglePut($id, $toggleApplications);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateSubAccountIdApplicationsTogglePut: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Id of the sub-account organization (mandatory) |
|
||||
**toggleApplications** | [**\Brevo\Client\Model\SubAccountAppsToggleRequest**](../Model/SubAccountAppsToggleRequest.md)| List of applications to activate or deactivate on a sub-account |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateSubAccountIdDelete**
|
||||
> corporateSubAccountIdDelete($id)
|
||||
|
||||
Delete a sub-account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = 789; // int | Id of the sub-account organization to be deleted
|
||||
|
||||
try {
|
||||
$apiInstance->corporateSubAccountIdDelete($id);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateSubAccountIdDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Id of the sub-account organization to be deleted |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateSubAccountIdGet**
|
||||
> \Brevo\Client\Model\SubAccountDetailsResponse corporateSubAccountIdGet($id)
|
||||
|
||||
Get sub-account details
|
||||
|
||||
This endpoint will provide the details for the specified sub-account company
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = 789; // int | Id of the sub-account organization
|
||||
|
||||
try {
|
||||
$result = $apiInstance->corporateSubAccountIdGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateSubAccountIdGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Id of the sub-account organization |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\SubAccountDetailsResponse**](../Model/SubAccountDetailsResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateSubAccountIdPlanPut**
|
||||
> corporateSubAccountIdPlanPut($id, $updatePlanDetails)
|
||||
|
||||
Update sub-account plan
|
||||
|
||||
This endpoint will update the sub-account plan
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = 789; // int | Id of the sub-account organization
|
||||
$updatePlanDetails = new \Brevo\Client\Model\SubAccountUpdatePlanRequest(); // \Brevo\Client\Model\SubAccountUpdatePlanRequest | Values to update a sub-account plan
|
||||
|
||||
try {
|
||||
$apiInstance->corporateSubAccountIdPlanPut($id, $updatePlanDetails);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateSubAccountIdPlanPut: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Id of the sub-account organization |
|
||||
**updatePlanDetails** | [**\Brevo\Client\Model\SubAccountUpdatePlanRequest**](../Model/SubAccountUpdatePlanRequest.md)| Values to update a sub-account plan |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateSubAccountKeyPost**
|
||||
> \Brevo\Client\Model\CreateApiKeyResponse corporateSubAccountKeyPost($createApiKeyRequest)
|
||||
|
||||
Create an API key for a sub-account
|
||||
|
||||
This endpoint will generate an API v3 key for a sub account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createApiKeyRequest = new \Brevo\Client\Model\CreateApiKeyRequest(); // \Brevo\Client\Model\CreateApiKeyRequest | Values to generate API key for sub-account
|
||||
|
||||
try {
|
||||
$result = $apiInstance->corporateSubAccountKeyPost($createApiKeyRequest);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateSubAccountKeyPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createApiKeyRequest** | [**\Brevo\Client\Model\CreateApiKeyRequest**](../Model/CreateApiKeyRequest.md)| Values to generate API key for sub-account |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateApiKeyResponse**](../Model/CreateApiKeyResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateSubAccountPost**
|
||||
> \Brevo\Client\Model\CreateSubAccountResponse corporateSubAccountPost($subAccountCreate)
|
||||
|
||||
Create a new sub-account under a master account.
|
||||
|
||||
This endpoint will create a new sub-account under a master account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$subAccountCreate = new \Brevo\Client\Model\CreateSubAccount(); // \Brevo\Client\Model\CreateSubAccount | values to create new sub-account
|
||||
|
||||
try {
|
||||
$result = $apiInstance->corporateSubAccountPost($subAccountCreate);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateSubAccountPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**subAccountCreate** | [**\Brevo\Client\Model\CreateSubAccount**](../Model/CreateSubAccount.md)| values to create new sub-account |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateSubAccountResponse**](../Model/CreateSubAccountResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateSubAccountSsoTokenPost**
|
||||
> \Brevo\Client\Model\GetSsoToken corporateSubAccountSsoTokenPost($ssoTokenRequest)
|
||||
|
||||
Generate SSO token to access Brevo
|
||||
|
||||
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$ssoTokenRequest = new \Brevo\Client\Model\SsoTokenRequest(); // \Brevo\Client\Model\SsoTokenRequest | Values to generate SSO token for sub-account
|
||||
|
||||
try {
|
||||
$result = $apiInstance->corporateSubAccountSsoTokenPost($ssoTokenRequest);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateSubAccountSsoTokenPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ssoTokenRequest** | [**\Brevo\Client\Model\SsoTokenRequest**](../Model/SsoTokenRequest.md)| Values to generate SSO token for sub-account |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetSsoToken**](../Model/GetSsoToken.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **corporateUserRevokeEmailDelete**
|
||||
> corporateUserRevokeEmailDelete($email)
|
||||
|
||||
Revoke an admin user
|
||||
|
||||
This endpoint allows to revoke/remove an invited member of your Admin account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$email = "email_example"; // string | Email of the invited user
|
||||
|
||||
try {
|
||||
$apiInstance->corporateUserRevokeEmailDelete($email);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->corporateUserRevokeEmailDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**email** | **string**| Email of the invited user |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getAccountActivity**
|
||||
> \Brevo\Client\Model\GetAccountActivity getAccountActivity($startDate, $endDate, $limit, $offset)
|
||||
|
||||
Get user activity logs
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search.
|
||||
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month.
|
||||
$limit = 10; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document in the page.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getAccountActivity($startDate, $endDate, $limit, $offset);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->getAccountActivity: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**startDate** | **string**| Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. | [optional]
|
||||
**endDate** | **string**| Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 10]
|
||||
**offset** | **int**| Index of the first document in the page. | [optional] [default to 0]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetAccountActivity**](../Model/GetAccountActivity.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getCorporateInvitedUsersList**
|
||||
> \Brevo\Client\Model\GetCorporateInvitedUsersList getCorporateInvitedUsersList()
|
||||
|
||||
Get the list of all admin users
|
||||
|
||||
This endpoint allows you to list all Admin users of your Admin account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getCorporateInvitedUsersList();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->getCorporateInvitedUsersList: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetCorporateInvitedUsersList**](../Model/GetCorporateInvitedUsersList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getSubAccountGroups**
|
||||
> \Brevo\Client\Model\InlineResponse200[] getSubAccountGroups()
|
||||
|
||||
Get the list of groups
|
||||
|
||||
This endpoint allows you to list all groups created on your Admin account.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getSubAccountGroups();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->getSubAccountGroups: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InlineResponse200[]**](../Model/InlineResponse200.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **inviteAdminUser**
|
||||
> \Brevo\Client\Model\InviteAdminUser inviteAdminUser($sendInvitation)
|
||||
|
||||
Send invitation to an admin user
|
||||
|
||||
`This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - \"all\" - `api`: - \"none\" - `user_management`: - \"all\" - `app_management` | Not available in ENTv2: - \"all\" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited admin user.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\MasterAccountApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$sendInvitation = new \Brevo\Client\Model\InviteAdminUser(); // \Brevo\Client\Model\InviteAdminUser | Payload to send an invitation
|
||||
|
||||
try {
|
||||
$result = $apiInstance->inviteAdminUser($sendInvitation);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling MasterAccountApi->inviteAdminUser: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**sendInvitation** | [**\Brevo\Client\Model\InviteAdminUser**](../Model/InviteAdminUser.md)| Payload to send an invitation |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InviteAdminUser**](../Model/InviteAdminUser.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
310
vendor/getbrevo/brevo-php/docs/Api/NotesApi.md
vendored
Normal file
310
vendor/getbrevo/brevo-php/docs/Api/NotesApi.md
vendored
Normal file
|
|
@ -0,0 +1,310 @@
|
|||
# Brevo\Client\NotesApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**crmNotesGet**](NotesApi.md#crmNotesGet) | **GET** /crm/notes | Get all notes
|
||||
[**crmNotesIdDelete**](NotesApi.md#crmNotesIdDelete) | **DELETE** /crm/notes/{id} | Delete a note
|
||||
[**crmNotesIdGet**](NotesApi.md#crmNotesIdGet) | **GET** /crm/notes/{id} | Get a note
|
||||
[**crmNotesIdPatch**](NotesApi.md#crmNotesIdPatch) | **PATCH** /crm/notes/{id} | Update a note
|
||||
[**crmNotesPost**](NotesApi.md#crmNotesPost) | **POST** /crm/notes | Create a note
|
||||
|
||||
|
||||
# **crmNotesGet**
|
||||
> \Brevo\Client\Model\NoteList crmNotesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort)
|
||||
|
||||
Get all notes
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\NotesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$entity = "entity_example"; // string | Filter by note entity type
|
||||
$entityIds = "entityIds_example"; // string | Filter by note entity IDs
|
||||
$dateFrom = 56; // int | dateFrom to date range filter type (timestamp in milliseconds)
|
||||
$dateTo = 56; // int | dateTo to date range filter type (timestamp in milliseconds)
|
||||
$offset = 789; // int | Index of the first document of the page
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmNotesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling NotesApi->crmNotesGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**entity** | **string**| Filter by note entity type | [optional]
|
||||
**entityIds** | **string**| Filter by note entity IDs | [optional]
|
||||
**dateFrom** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional]
|
||||
**dateTo** | **int**| dateTo to date range filter type (timestamp in milliseconds) | [optional]
|
||||
**offset** | **int**| Index of the first document of the page | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\NoteList**](../Model/NoteList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmNotesIdDelete**
|
||||
> crmNotesIdDelete($id)
|
||||
|
||||
Delete a note
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\NotesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Note ID to delete
|
||||
|
||||
try {
|
||||
$apiInstance->crmNotesIdDelete($id);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling NotesApi->crmNotesIdDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Note ID to delete |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmNotesIdGet**
|
||||
> \Brevo\Client\Model\Note crmNotesIdGet($id)
|
||||
|
||||
Get a note
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\NotesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Note ID to get
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmNotesIdGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling NotesApi->crmNotesIdGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Note ID to get |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Note**](../Model/Note.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmNotesIdPatch**
|
||||
> crmNotesIdPatch($id, $body)
|
||||
|
||||
Update a note
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\NotesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string | Note ID to update
|
||||
$body = new \Brevo\Client\Model\NoteData(); // \Brevo\Client\Model\NoteData | Note data to update a note
|
||||
|
||||
try {
|
||||
$apiInstance->crmNotesIdPatch($id, $body);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling NotesApi->crmNotesIdPatch: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| Note ID to update |
|
||||
**body** | [**\Brevo\Client\Model\NoteData**](../Model/NoteData.md)| Note data to update a note |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmNotesPost**
|
||||
> \Brevo\Client\Model\NoteId crmNotesPost($body)
|
||||
|
||||
Create a note
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\NotesApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$body = new \Brevo\Client\Model\NoteData(); // \Brevo\Client\Model\NoteData | Note data to create a note.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmNotesPost($body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling NotesApi->crmNotesPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**\Brevo\Client\Model\NoteData**](../Model/NoteData.md)| Note data to create a note. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\NoteId**](../Model/NoteId.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
128
vendor/getbrevo/brevo-php/docs/Api/ProcessApi.md
vendored
Normal file
128
vendor/getbrevo/brevo-php/docs/Api/ProcessApi.md
vendored
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
# Brevo\Client\ProcessApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**getProcess**](ProcessApi.md#getProcess) | **GET** /processes/{processId} | Return the informations for a process
|
||||
[**getProcesses**](ProcessApi.md#getProcesses) | **GET** /processes | Return all the processes for your account
|
||||
|
||||
|
||||
# **getProcess**
|
||||
> \Brevo\Client\Model\GetProcess getProcess($processId)
|
||||
|
||||
Return the informations for a process
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ProcessApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$processId = 789; // int | Id of the process
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getProcess($processId);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ProcessApi->getProcess: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**processId** | **int**| Id of the process |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetProcess**](../Model/GetProcess.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getProcesses**
|
||||
> \Brevo\Client\Model\GetProcesses getProcesses($limit, $offset, $sort)
|
||||
|
||||
Return all the processes for your account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ProcessApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$limit = 10; // int | Number limitation for the result returned
|
||||
$offset = 0; // int | Beginning point in the list to retrieve from.
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getProcesses($limit, $offset, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ProcessApi->getProcesses: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**limit** | **int**| Number limitation for the result returned | [optional] [default to 10]
|
||||
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetProcesses**](../Model/GetProcesses.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
952
vendor/getbrevo/brevo-php/docs/Api/ResellerApi.md
vendored
Normal file
952
vendor/getbrevo/brevo-php/docs/Api/ResellerApi.md
vendored
Normal file
|
|
@ -0,0 +1,952 @@
|
|||
# Brevo\Client\ResellerApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**addCredits**](ResellerApi.md#addCredits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account
|
||||
[**associateIpToChild**](ResellerApi.md#associateIpToChild) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child
|
||||
[**createChildDomain**](ResellerApi.md#createChildDomain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account
|
||||
[**createResellerChild**](ResellerApi.md#createResellerChild) | **POST** /reseller/children | Creates a reseller child
|
||||
[**deleteChildDomain**](ResellerApi.md#deleteChildDomain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
||||
[**deleteResellerChild**](ResellerApi.md#deleteResellerChild) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied
|
||||
[**dissociateIpFromChild**](ResellerApi.md#dissociateIpFromChild) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child
|
||||
[**getChildAccountCreationStatus**](ResellerApi.md#getChildAccountCreationStatus) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
||||
[**getChildDomains**](ResellerApi.md#getChildDomains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account
|
||||
[**getChildInfo**](ResellerApi.md#getChildInfo) | **GET** /reseller/children/{childIdentifier} | Get a child account's details
|
||||
[**getResellerChilds**](ResellerApi.md#getResellerChilds) | **GET** /reseller/children | Get the list of all children accounts
|
||||
[**getSsoToken**](ResellerApi.md#getSsoToken) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Brevo (SSO)
|
||||
[**removeCredits**](ResellerApi.md#removeCredits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account
|
||||
[**updateChildAccountStatus**](ResellerApi.md#updateChildAccountStatus) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied
|
||||
[**updateChildDomain**](ResellerApi.md#updateChildDomain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
||||
[**updateResellerChild**](ResellerApi.md#updateResellerChild) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied
|
||||
|
||||
|
||||
# **addCredits**
|
||||
> \Brevo\Client\Model\RemainingCreditModel addCredits($childIdentifier, $addCredits)
|
||||
|
||||
Add Email and/or SMS credits to a specific child account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
$addCredits = new \Brevo\Client\Model\AddCredits(); // \Brevo\Client\Model\AddCredits | Values to post to add credit to a specific child account
|
||||
|
||||
try {
|
||||
$result = $apiInstance->addCredits($childIdentifier, $addCredits);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->addCredits: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
**addCredits** | [**\Brevo\Client\Model\AddCredits**](../Model/AddCredits.md)| Values to post to add credit to a specific child account |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\RemainingCreditModel**](../Model/RemainingCreditModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **associateIpToChild**
|
||||
> associateIpToChild($childIdentifier, $ip)
|
||||
|
||||
Associate a dedicated IP to the child
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
$ip = new \Brevo\Client\Model\ManageIp(); // \Brevo\Client\Model\ManageIp | IP to associate
|
||||
|
||||
try {
|
||||
$apiInstance->associateIpToChild($childIdentifier, $ip);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->associateIpToChild: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
**ip** | [**\Brevo\Client\Model\ManageIp**](../Model/ManageIp.md)| IP to associate |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createChildDomain**
|
||||
> createChildDomain($childIdentifier, $addChildDomain)
|
||||
|
||||
Create a domain for a child account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
$addChildDomain = new \Brevo\Client\Model\AddChildDomain(); // \Brevo\Client\Model\AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account.
|
||||
|
||||
try {
|
||||
$apiInstance->createChildDomain($childIdentifier, $addChildDomain);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->createChildDomain: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
**addChildDomain** | [**\Brevo\Client\Model\AddChildDomain**](../Model/AddChildDomain.md)| Sender domain to add for a specific child account. This will not be displayed to the parent account. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createResellerChild**
|
||||
> \Brevo\Client\Model\CreateReseller createResellerChild($resellerChild)
|
||||
|
||||
Creates a reseller child
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$resellerChild = new \Brevo\Client\Model\CreateChild(); // \Brevo\Client\Model\CreateChild | reseller child to add
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createResellerChild($resellerChild);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->createResellerChild: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**resellerChild** | [**\Brevo\Client\Model\CreateChild**](../Model/CreateChild.md)| reseller child to add | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateReseller**](../Model/CreateReseller.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteChildDomain**
|
||||
> deleteChildDomain($childIdentifier, $domainName)
|
||||
|
||||
Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
$domainName = "domainName_example"; // string | Pass the existing domain that needs to be deleted
|
||||
|
||||
try {
|
||||
$apiInstance->deleteChildDomain($childIdentifier, $domainName);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->deleteChildDomain: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
**domainName** | **string**| Pass the existing domain that needs to be deleted |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteResellerChild**
|
||||
> deleteResellerChild($childIdentifier)
|
||||
|
||||
Delete a single reseller child based on the child identifier supplied
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or child id of reseller's child
|
||||
|
||||
try {
|
||||
$apiInstance->deleteResellerChild($childIdentifier);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->deleteResellerChild: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or child id of reseller's child |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **dissociateIpFromChild**
|
||||
> dissociateIpFromChild($childIdentifier, $ip)
|
||||
|
||||
Dissociate a dedicated IP to the child
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
$ip = new \Brevo\Client\Model\ManageIp(); // \Brevo\Client\Model\ManageIp | IP to dissociate
|
||||
|
||||
try {
|
||||
$apiInstance->dissociateIpFromChild($childIdentifier, $ip);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->dissociateIpFromChild: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
**ip** | [**\Brevo\Client\Model\ManageIp**](../Model/ManageIp.md)| IP to dissociate |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getChildAccountCreationStatus**
|
||||
> \Brevo\Client\Model\GetChildAccountCreationStatus getChildAccountCreationStatus($childIdentifier)
|
||||
|
||||
Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getChildAccountCreationStatus($childIdentifier);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->getChildAccountCreationStatus: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetChildAccountCreationStatus**](../Model/GetChildAccountCreationStatus.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getChildDomains**
|
||||
> \Brevo\Client\Model\GetChildDomains getChildDomains($childIdentifier)
|
||||
|
||||
Get all sender domains for a specific child account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getChildDomains($childIdentifier);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->getChildDomains: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetChildDomains**](../Model/GetChildDomains.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getChildInfo**
|
||||
> \Brevo\Client\Model\GetChildInfo getChildInfo($childIdentifier)
|
||||
|
||||
Get a child account's details
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getChildInfo($childIdentifier);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->getChildInfo: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetChildInfo**](../Model/GetChildInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getResellerChilds**
|
||||
> \Brevo\Client\Model\GetChildrenList getResellerChilds($limit, $offset)
|
||||
|
||||
Get the list of all children accounts
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$limit = 10; // int | Number of documents for child accounts information per page
|
||||
$offset = 0; // int | Index of the first document in the page
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getResellerChilds($limit, $offset);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->getResellerChilds: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**limit** | **int**| Number of documents for child accounts information per page | [optional] [default to 10]
|
||||
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetChildrenList**](../Model/GetChildrenList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getSsoToken**
|
||||
> \Brevo\Client\Model\GetSsoToken getSsoToken($childIdentifier)
|
||||
|
||||
Get session token to access Brevo (SSO)
|
||||
|
||||
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getSsoToken($childIdentifier);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->getSsoToken: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetSsoToken**](../Model/GetSsoToken.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **removeCredits**
|
||||
> \Brevo\Client\Model\RemainingCreditModel removeCredits($childIdentifier, $removeCredits)
|
||||
|
||||
Remove Email and/or SMS credits from a specific child account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
$removeCredits = new \Brevo\Client\Model\RemoveCredits(); // \Brevo\Client\Model\RemoveCredits | Values to post to remove email or SMS credits from a specific child account
|
||||
|
||||
try {
|
||||
$result = $apiInstance->removeCredits($childIdentifier, $removeCredits);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->removeCredits: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
**removeCredits** | [**\Brevo\Client\Model\RemoveCredits**](../Model/RemoveCredits.md)| Values to post to remove email or SMS credits from a specific child account |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\RemainingCreditModel**](../Model/RemainingCreditModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateChildAccountStatus**
|
||||
> updateChildAccountStatus($childIdentifier, $updateChildAccountStatus)
|
||||
|
||||
Update info of reseller's child account status based on the childIdentifier supplied
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
$updateChildAccountStatus = new \Brevo\Client\Model\UpdateChildAccountStatus(); // \Brevo\Client\Model\UpdateChildAccountStatus | values to update in child account status
|
||||
|
||||
try {
|
||||
$apiInstance->updateChildAccountStatus($childIdentifier, $updateChildAccountStatus);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->updateChildAccountStatus: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
**updateChildAccountStatus** | [**\Brevo\Client\Model\UpdateChildAccountStatus**](../Model/UpdateChildAccountStatus.md)| values to update in child account status |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateChildDomain**
|
||||
> updateChildDomain($childIdentifier, $domainName, $updateChildDomain)
|
||||
|
||||
Update the sender domain of reseller's child based on the childIdentifier and domainName passed
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
$domainName = "domainName_example"; // string | Pass the existing domain that needs to be updated
|
||||
$updateChildDomain = new \Brevo\Client\Model\UpdateChildDomain(); // \Brevo\Client\Model\UpdateChildDomain | value to update for sender domain
|
||||
|
||||
try {
|
||||
$apiInstance->updateChildDomain($childIdentifier, $domainName, $updateChildDomain);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->updateChildDomain: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
**domainName** | **string**| Pass the existing domain that needs to be updated |
|
||||
**updateChildDomain** | [**\Brevo\Client\Model\UpdateChildDomain**](../Model/UpdateChildDomain.md)| value to update for sender domain |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateResellerChild**
|
||||
> updateResellerChild($childIdentifier, $resellerChild)
|
||||
|
||||
Update info of reseller's child based on the child identifier supplied
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\ResellerApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
|
||||
$resellerChild = new \Brevo\Client\Model\UpdateChild(); // \Brevo\Client\Model\UpdateChild | values to update in child profile
|
||||
|
||||
try {
|
||||
$apiInstance->updateResellerChild($childIdentifier, $resellerChild);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling ResellerApi->updateResellerChild: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**childIdentifier** | **string**| Either auth key or id of reseller's child |
|
||||
**resellerChild** | [**\Brevo\Client\Model\UpdateChild**](../Model/UpdateChild.md)| values to update in child profile |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
606
vendor/getbrevo/brevo-php/docs/Api/SMSCampaignsApi.md
vendored
Normal file
606
vendor/getbrevo/brevo-php/docs/Api/SMSCampaignsApi.md
vendored
Normal file
|
|
@ -0,0 +1,606 @@
|
|||
# Brevo\Client\SMSCampaignsApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createSmsCampaign**](SMSCampaignsApi.md#createSmsCampaign) | **POST** /smsCampaigns | Creates an SMS campaign
|
||||
[**deleteSmsCampaign**](SMSCampaignsApi.md#deleteSmsCampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
|
||||
[**getSmsCampaign**](SMSCampaignsApi.md#getSmsCampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
|
||||
[**getSmsCampaigns**](SMSCampaignsApi.md#getSmsCampaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
|
||||
[**requestSmsRecipientExport**](SMSCampaignsApi.md#requestSmsRecipientExport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
|
||||
[**sendSmsCampaignNow**](SMSCampaignsApi.md#sendSmsCampaignNow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
|
||||
[**sendSmsReport**](SMSCampaignsApi.md#sendSmsReport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
|
||||
[**sendTestSms**](SMSCampaignsApi.md#sendTestSms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
|
||||
[**updateSmsCampaign**](SMSCampaignsApi.md#updateSmsCampaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
|
||||
[**updateSmsCampaignStatus**](SMSCampaignsApi.md#updateSmsCampaignStatus) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
|
||||
|
||||
|
||||
# **createSmsCampaign**
|
||||
> \Brevo\Client\Model\CreateModel createSmsCampaign($createSmsCampaign)
|
||||
|
||||
Creates an SMS campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SMSCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createSmsCampaign = new \Brevo\Client\Model\CreateSmsCampaign(); // \Brevo\Client\Model\CreateSmsCampaign | Values to create an SMS Campaign
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createSmsCampaign($createSmsCampaign);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SMSCampaignsApi->createSmsCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createSmsCampaign** | [**\Brevo\Client\Model\CreateSmsCampaign**](../Model/CreateSmsCampaign.md)| Values to create an SMS Campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteSmsCampaign**
|
||||
> deleteSmsCampaign($campaignId)
|
||||
|
||||
Delete an SMS campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SMSCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | id of the SMS campaign
|
||||
|
||||
try {
|
||||
$apiInstance->deleteSmsCampaign($campaignId);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SMSCampaignsApi->deleteSmsCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| id of the SMS campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getSmsCampaign**
|
||||
> \Brevo\Client\Model\GetSmsCampaign getSmsCampaign($campaignId)
|
||||
|
||||
Get an SMS campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SMSCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | id of the SMS campaign
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getSmsCampaign($campaignId);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SMSCampaignsApi->getSmsCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| id of the SMS campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetSmsCampaign**](../Model/GetSmsCampaign.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getSmsCampaigns**
|
||||
> \Brevo\Client\Model\GetSmsCampaigns getSmsCampaigns($status, $startDate, $endDate, $limit, $offset, $sort)
|
||||
|
||||
Returns the information for all your created SMS campaigns
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SMSCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$status = "status_example"; // string | Status of campaign.
|
||||
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
||||
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
||||
$limit = 500; // int | Number limitation for the result returned
|
||||
$offset = 0; // int | Beginning point in the list to retrieve from.
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getSmsCampaigns($status, $startDate, $endDate, $limit, $offset, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SMSCampaignsApi->getSmsCampaigns: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**status** | **string**| Status of campaign. | [optional]
|
||||
**startDate** | **string**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
||||
**endDate** | **string**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
||||
**limit** | **int**| Number limitation for the result returned | [optional] [default to 500]
|
||||
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetSmsCampaigns**](../Model/GetSmsCampaigns.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **requestSmsRecipientExport**
|
||||
> \Brevo\Client\Model\CreatedProcessId requestSmsRecipientExport($campaignId, $recipientExport)
|
||||
|
||||
Export an SMS campaign's recipients
|
||||
|
||||
It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SMSCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | id of the campaign
|
||||
$recipientExport = new \Brevo\Client\Model\RequestSmsRecipientExport(); // \Brevo\Client\Model\RequestSmsRecipientExport | Values to send for a recipient export request
|
||||
|
||||
try {
|
||||
$result = $apiInstance->requestSmsRecipientExport($campaignId, $recipientExport);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SMSCampaignsApi->requestSmsRecipientExport: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| id of the campaign |
|
||||
**recipientExport** | [**\Brevo\Client\Model\RequestSmsRecipientExport**](../Model/RequestSmsRecipientExport.md)| Values to send for a recipient export request | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **sendSmsCampaignNow**
|
||||
> sendSmsCampaignNow($campaignId)
|
||||
|
||||
Send your SMS campaign immediately
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SMSCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | id of the campaign
|
||||
|
||||
try {
|
||||
$apiInstance->sendSmsCampaignNow($campaignId);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SMSCampaignsApi->sendSmsCampaignNow: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| id of the campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **sendSmsReport**
|
||||
> sendSmsReport($campaignId, $sendReport)
|
||||
|
||||
Send an SMS campaign's report
|
||||
|
||||
Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SMSCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | id of the campaign
|
||||
$sendReport = new \Brevo\Client\Model\SendReport(); // \Brevo\Client\Model\SendReport | Values for send a report
|
||||
|
||||
try {
|
||||
$apiInstance->sendSmsReport($campaignId, $sendReport);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SMSCampaignsApi->sendSmsReport: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| id of the campaign |
|
||||
**sendReport** | [**\Brevo\Client\Model\SendReport**](../Model/SendReport.md)| Values for send a report |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **sendTestSms**
|
||||
> sendTestSms($campaignId, $phoneNumber)
|
||||
|
||||
Send a test SMS campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SMSCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the SMS campaign
|
||||
$phoneNumber = new \Brevo\Client\Model\SendTestSms(); // \Brevo\Client\Model\SendTestSms | Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted
|
||||
|
||||
try {
|
||||
$apiInstance->sendTestSms($campaignId, $phoneNumber);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SMSCampaignsApi->sendTestSms: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the SMS campaign |
|
||||
**phoneNumber** | [**\Brevo\Client\Model\SendTestSms**](../Model/SendTestSms.md)| Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateSmsCampaign**
|
||||
> updateSmsCampaign($campaignId, $updateSmsCampaign)
|
||||
|
||||
Update an SMS campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SMSCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | id of the SMS campaign
|
||||
$updateSmsCampaign = new \Brevo\Client\Model\UpdateSmsCampaign(); // \Brevo\Client\Model\UpdateSmsCampaign | Values to update an SMS Campaign
|
||||
|
||||
try {
|
||||
$apiInstance->updateSmsCampaign($campaignId, $updateSmsCampaign);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SMSCampaignsApi->updateSmsCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| id of the SMS campaign |
|
||||
**updateSmsCampaign** | [**\Brevo\Client\Model\UpdateSmsCampaign**](../Model/UpdateSmsCampaign.md)| Values to update an SMS Campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateSmsCampaignStatus**
|
||||
> updateSmsCampaignStatus($campaignId, $status)
|
||||
|
||||
Update a campaign's status
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SMSCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | id of the campaign
|
||||
$status = new \Brevo\Client\Model\UpdateCampaignStatus(); // \Brevo\Client\Model\UpdateCampaignStatus | Status of the campaign.
|
||||
|
||||
try {
|
||||
$apiInstance->updateSmsCampaignStatus($campaignId, $status);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SMSCampaignsApi->updateSmsCampaignStatus: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| id of the campaign |
|
||||
**status** | [**\Brevo\Client\Model\UpdateCampaignStatus**](../Model/UpdateCampaignStatus.md)| Status of the campaign. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
413
vendor/getbrevo/brevo-php/docs/Api/SendersApi.md
vendored
Normal file
413
vendor/getbrevo/brevo-php/docs/Api/SendersApi.md
vendored
Normal file
|
|
@ -0,0 +1,413 @@
|
|||
# Brevo\Client\SendersApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createSender**](SendersApi.md#createSender) | **POST** /senders | Create a new sender
|
||||
[**deleteSender**](SendersApi.md#deleteSender) | **DELETE** /senders/{senderId} | Delete a sender
|
||||
[**getIps**](SendersApi.md#getIps) | **GET** /senders/ips | Get all the dedicated IPs for your account
|
||||
[**getIpsFromSender**](SendersApi.md#getIpsFromSender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
|
||||
[**getSenders**](SendersApi.md#getSenders) | **GET** /senders | Get the list of all your senders
|
||||
[**updateSender**](SendersApi.md#updateSender) | **PUT** /senders/{senderId} | Update a sender
|
||||
[**validateSenderByOTP**](SendersApi.md#validateSenderByOTP) | **PUT** /senders/{senderId}/validate | Update a sender
|
||||
|
||||
|
||||
# **createSender**
|
||||
> \Brevo\Client\Model\CreateSenderModel createSender($sender)
|
||||
|
||||
Create a new sender
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SendersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$sender = new \Brevo\Client\Model\CreateSender(); // \Brevo\Client\Model\CreateSender | sender's name
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createSender($sender);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SendersApi->createSender: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**sender** | [**\Brevo\Client\Model\CreateSender**](../Model/CreateSender.md)| sender's name | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateSenderModel**](../Model/CreateSenderModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteSender**
|
||||
> deleteSender($senderId)
|
||||
|
||||
Delete a sender
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SendersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$senderId = 789; // int | Id of the sender
|
||||
|
||||
try {
|
||||
$apiInstance->deleteSender($senderId);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SendersApi->deleteSender: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**senderId** | **int**| Id of the sender |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getIps**
|
||||
> \Brevo\Client\Model\GetIps getIps()
|
||||
|
||||
Get all the dedicated IPs for your account
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SendersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getIps();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SendersApi->getIps: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetIps**](../Model/GetIps.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getIpsFromSender**
|
||||
> \Brevo\Client\Model\GetIpsFromSender getIpsFromSender($senderId)
|
||||
|
||||
Get all the dedicated IPs for a sender
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SendersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$senderId = 789; // int | Id of the sender
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getIpsFromSender($senderId);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SendersApi->getIpsFromSender: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**senderId** | **int**| Id of the sender |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetIpsFromSender**](../Model/GetIpsFromSender.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getSenders**
|
||||
> \Brevo\Client\Model\GetSendersList getSenders($ip, $domain)
|
||||
|
||||
Get the list of all your senders
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SendersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$ip = "ip_example"; // string | Filter your senders for a specific ip (available for dedicated IP usage only)
|
||||
$domain = "domain_example"; // string | Filter your senders for a specific domain
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getSenders($ip, $domain);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SendersApi->getSenders: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ip** | **string**| Filter your senders for a specific ip (available for dedicated IP usage only) | [optional]
|
||||
**domain** | **string**| Filter your senders for a specific domain | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetSendersList**](../Model/GetSendersList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateSender**
|
||||
> updateSender($senderId, $sender)
|
||||
|
||||
Update a sender
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SendersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$senderId = 789; // int | Id of the sender
|
||||
$sender = new \Brevo\Client\Model\UpdateSender(); // \Brevo\Client\Model\UpdateSender | sender's name
|
||||
|
||||
try {
|
||||
$apiInstance->updateSender($senderId, $sender);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SendersApi->updateSender: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**senderId** | **int**| Id of the sender |
|
||||
**sender** | [**\Brevo\Client\Model\UpdateSender**](../Model/UpdateSender.md)| sender's name | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **validateSenderByOTP**
|
||||
> validateSenderByOTP($senderId, $otp)
|
||||
|
||||
Update a sender
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\SendersApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$senderId = 789; // int | Id of the sender
|
||||
$otp = new \Brevo\Client\Model\Otp(); // \Brevo\Client\Model\Otp | otp
|
||||
|
||||
try {
|
||||
$apiInstance->validateSenderByOTP($senderId, $otp);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling SendersApi->validateSenderByOTP: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**senderId** | **int**| Id of the sender |
|
||||
**otp** | [**\Brevo\Client\Model\Otp**](../Model/Otp.md)| otp | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
376
vendor/getbrevo/brevo-php/docs/Api/TasksApi.md
vendored
Normal file
376
vendor/getbrevo/brevo-php/docs/Api/TasksApi.md
vendored
Normal file
|
|
@ -0,0 +1,376 @@
|
|||
# Brevo\Client\TasksApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**crmTasksGet**](TasksApi.md#crmTasksGet) | **GET** /crm/tasks | Get all tasks
|
||||
[**crmTasksIdDelete**](TasksApi.md#crmTasksIdDelete) | **DELETE** /crm/tasks/{id} | Delete a task
|
||||
[**crmTasksIdGet**](TasksApi.md#crmTasksIdGet) | **GET** /crm/tasks/{id} | Get a task
|
||||
[**crmTasksIdPatch**](TasksApi.md#crmTasksIdPatch) | **PATCH** /crm/tasks/{id} | Update a task
|
||||
[**crmTasksPost**](TasksApi.md#crmTasksPost) | **POST** /crm/tasks | Create a task
|
||||
[**crmTasktypesGet**](TasksApi.md#crmTasktypesGet) | **GET** /crm/tasktypes | Get all task types
|
||||
|
||||
|
||||
# **crmTasksGet**
|
||||
> \Brevo\Client\Model\TaskList crmTasksGet($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy)
|
||||
|
||||
Get all tasks
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TasksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$filterType = "filterType_example"; // string | Filter by task type (ID)
|
||||
$filterStatus = "filterStatus_example"; // string | Filter by task status
|
||||
$filterDate = "filterDate_example"; // string | Filter by date
|
||||
$filterAssignTo = "filterAssignTo_example"; // string | Filter by assignTo id
|
||||
$filterContacts = "filterContacts_example"; // string | Filter by contact ids
|
||||
$filterDeals = "filterDeals_example"; // string | Filter by deals ids
|
||||
$filterCompanies = "filterCompanies_example"; // string | Filter by companies ids
|
||||
$dateFrom = 56; // int | dateFrom to date range filter type (timestamp in milliseconds)
|
||||
$dateTo = 56; // int | dateTo to date range filter type (timestamp in milliseconds)
|
||||
$offset = 789; // int | Index of the first document of the page
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
||||
$sortBy = "sortBy_example"; // string | The field used to sort field names.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmTasksGet($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TasksApi->crmTasksGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filterType** | **string**| Filter by task type (ID) | [optional]
|
||||
**filterStatus** | **string**| Filter by task status | [optional]
|
||||
**filterDate** | **string**| Filter by date | [optional]
|
||||
**filterAssignTo** | **string**| Filter by assignTo id | [optional]
|
||||
**filterContacts** | **string**| Filter by contact ids | [optional]
|
||||
**filterDeals** | **string**| Filter by deals ids | [optional]
|
||||
**filterCompanies** | **string**| Filter by companies ids | [optional]
|
||||
**dateFrom** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional]
|
||||
**dateTo** | **int**| dateTo to date range filter type (timestamp in milliseconds) | [optional]
|
||||
**offset** | **int**| Index of the first document of the page | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional]
|
||||
**sortBy** | **string**| The field used to sort field names. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\TaskList**](../Model/TaskList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasksIdDelete**
|
||||
> crmTasksIdDelete($id)
|
||||
|
||||
Delete a task
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TasksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
|
||||
try {
|
||||
$apiInstance->crmTasksIdDelete($id);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TasksApi->crmTasksIdDelete: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasksIdGet**
|
||||
> \Brevo\Client\Model\Task crmTasksIdGet($id)
|
||||
|
||||
Get a task
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TasksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmTasksIdGet($id);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TasksApi->crmTasksIdGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Task**](../Model/Task.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasksIdPatch**
|
||||
> crmTasksIdPatch($id, $body)
|
||||
|
||||
Update a task
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TasksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$id = "id_example"; // string |
|
||||
$body = new \Brevo\Client\Model\Body9(); // \Brevo\Client\Model\Body9 | Updated task details.
|
||||
|
||||
try {
|
||||
$apiInstance->crmTasksIdPatch($id, $body);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TasksApi->crmTasksIdPatch: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **string**| |
|
||||
**body** | [**\Brevo\Client\Model\Body9**](../Model/Body9.md)| Updated task details. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasksPost**
|
||||
> \Brevo\Client\Model\InlineResponse2012 crmTasksPost($body)
|
||||
|
||||
Create a task
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TasksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$body = new \Brevo\Client\Model\Body8(); // \Brevo\Client\Model\Body8 | Task name.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmTasksPost($body);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TasksApi->crmTasksPost: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**\Brevo\Client\Model\Body8**](../Model/Body8.md)| Task name. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InlineResponse2012**](../Model/InlineResponse2012.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **crmTasktypesGet**
|
||||
> \Brevo\Client\Model\TaskTypes crmTasktypesGet()
|
||||
|
||||
Get all task types
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TasksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->crmTasktypesGet();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TasksApi->crmTasktypesGet: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\TaskTypes**](../Model/TaskTypes.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
1379
vendor/getbrevo/brevo-php/docs/Api/TransactionalEmailsApi.md
vendored
Normal file
1379
vendor/getbrevo/brevo-php/docs/Api/TransactionalEmailsApi.md
vendored
Normal file
File diff suppressed because it is too large
Load diff
270
vendor/getbrevo/brevo-php/docs/Api/TransactionalSMSApi.md
vendored
Normal file
270
vendor/getbrevo/brevo-php/docs/Api/TransactionalSMSApi.md
vendored
Normal file
|
|
@ -0,0 +1,270 @@
|
|||
# Brevo\Client\TransactionalSMSApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**getSmsEvents**](TransactionalSMSApi.md#getSmsEvents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
|
||||
[**getTransacAggregatedSmsReport**](TransactionalSMSApi.md#getTransacAggregatedSmsReport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
|
||||
[**getTransacSmsReport**](TransactionalSMSApi.md#getTransacSmsReport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
|
||||
[**sendTransacSms**](TransactionalSMSApi.md#sendTransacSms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
|
||||
|
||||
|
||||
# **getSmsEvents**
|
||||
> \Brevo\Client\Model\GetSmsEventReport getSmsEvents($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags, $sort)
|
||||
|
||||
Get all your SMS activity (unaggregated events)
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TransactionalSMSApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
||||
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
||||
$offset = 0; // int | Index of the first document of the page
|
||||
$days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
||||
$phoneNumber = "phoneNumber_example"; // string | Filter the report for a specific phone number
|
||||
$event = "event_example"; // string | Filter the report for specific events
|
||||
$tags = "tags_example"; // string | Filter the report for specific tags passed as a serialized urlencoded array
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getSmsEvents($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TransactionalSMSApi->getSmsEvents: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
|
||||
**endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
||||
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
|
||||
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
||||
**phoneNumber** | **string**| Filter the report for a specific phone number | [optional]
|
||||
**event** | **string**| Filter the report for specific events | [optional]
|
||||
**tags** | **string**| Filter the report for specific tags passed as a serialized urlencoded array | [optional]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetSmsEventReport**](../Model/GetSmsEventReport.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getTransacAggregatedSmsReport**
|
||||
> \Brevo\Client\Model\GetTransacAggregatedSmsReport getTransacAggregatedSmsReport($startDate, $endDate, $days, $tag)
|
||||
|
||||
Get your SMS activity aggregated over a period of time
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TransactionalSMSApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
||||
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
||||
$days = 789; // int | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
||||
$tag = "tag_example"; // string | Filter on a tag
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getTransacAggregatedSmsReport($startDate, $endDate, $days, $tag);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TransactionalSMSApi->getTransacAggregatedSmsReport: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
|
||||
**endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
||||
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional]
|
||||
**tag** | **string**| Filter on a tag | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetTransacAggregatedSmsReport**](../Model/GetTransacAggregatedSmsReport.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getTransacSmsReport**
|
||||
> \Brevo\Client\Model\GetTransacSmsReport getTransacSmsReport($startDate, $endDate, $days, $tag, $sort)
|
||||
|
||||
Get your SMS activity aggregated per day
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TransactionalSMSApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
||||
$endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
||||
$days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
||||
$tag = "tag_example"; // string | Filter on a tag
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getTransacSmsReport($startDate, $endDate, $days, $tag, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TransactionalSMSApi->getTransacSmsReport: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
|
||||
**endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
||||
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
||||
**tag** | **string**| Filter on a tag | [optional]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetTransacSmsReport**](../Model/GetTransacSmsReport.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **sendTransacSms**
|
||||
> \Brevo\Client\Model\SendSms sendTransacSms($sendTransacSms)
|
||||
|
||||
Send SMS message to a mobile number
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TransactionalSMSApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$sendTransacSms = new \Brevo\Client\Model\SendTransacSms(); // \Brevo\Client\Model\SendTransacSms | Values to send a transactional SMS
|
||||
|
||||
try {
|
||||
$result = $apiInstance->sendTransacSms($sendTransacSms);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TransactionalSMSApi->sendTransacSms: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**sendTransacSms** | [**\Brevo\Client\Model\SendTransacSms**](../Model/SendTransacSms.md)| Values to send a transactional SMS |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\SendSms**](../Model/SendSms.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
142
vendor/getbrevo/brevo-php/docs/Api/TransactionalWhatsAppApi.md
vendored
Normal file
142
vendor/getbrevo/brevo-php/docs/Api/TransactionalWhatsAppApi.md
vendored
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
# Brevo\Client\TransactionalWhatsAppApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**getWhatsappEventReport**](TransactionalWhatsAppApi.md#getWhatsappEventReport) | **GET** /whatsapp/statistics/events | Get all your WhatsApp activity (unaggregated events)
|
||||
[**sendWhatsappMessage**](TransactionalWhatsAppApi.md#sendWhatsappMessage) | **POST** /whatsapp/sendMessage | Send a WhatsApp message
|
||||
|
||||
|
||||
# **getWhatsappEventReport**
|
||||
> \Brevo\Client\Model\GetWhatsappEventReport getWhatsappEventReport($limit, $offset, $startDate, $endDate, $days, $contactNumber, $event, $sort)
|
||||
|
||||
Get all your WhatsApp activity (unaggregated events)
|
||||
|
||||
This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days)
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TransactionalWhatsAppApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$limit = 2500; // int | Number limitation for the result returned
|
||||
$offset = 0; // int | Beginning point in the list to retrieve from
|
||||
$startDate = "startDate_example"; // string | **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
||||
$endDate = "endDate_example"; // string | **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
||||
$days = 789; // int | Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
|
||||
$contactNumber = "contactNumber_example"; // string | Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
|
||||
$event = "event_example"; // string | Filter the report for a specific event type
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getWhatsappEventReport($limit, $offset, $startDate, $endDate, $days, $contactNumber, $event, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TransactionalWhatsAppApi->getWhatsappEventReport: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**limit** | **int**| Number limitation for the result returned | [optional] [default to 2500]
|
||||
**offset** | **int**| Beginning point in the list to retrieve from | [optional] [default to 0]
|
||||
**startDate** | **string**| **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
|
||||
**endDate** | **string**| **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
|
||||
**days** | **int**| Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ | [optional]
|
||||
**contactNumber** | **string**| Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721) | [optional]
|
||||
**event** | **string**| Filter the report for a specific event type | [optional]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetWhatsappEventReport**](../Model/GetWhatsappEventReport.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **sendWhatsappMessage**
|
||||
> \Brevo\Client\Model\InlineResponse2014 sendWhatsappMessage($sendWhatsappMessage)
|
||||
|
||||
Send a WhatsApp message
|
||||
|
||||
This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Brevo platform to fetch the Template ID.**)
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\TransactionalWhatsAppApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$sendWhatsappMessage = new \Brevo\Client\Model\SendWhatsappMessage(); // \Brevo\Client\Model\SendWhatsappMessage | Values to send WhatsApp message
|
||||
|
||||
try {
|
||||
$result = $apiInstance->sendWhatsappMessage($sendWhatsappMessage);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling TransactionalWhatsAppApi->sendWhatsappMessage: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**sendWhatsappMessage** | [**\Brevo\Client\Model\SendWhatsappMessage**](../Model/SendWhatsappMessage.md)| Values to send WhatsApp message |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\InlineResponse2014**](../Model/InlineResponse2014.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
358
vendor/getbrevo/brevo-php/docs/Api/UserApi.md
vendored
Normal file
358
vendor/getbrevo/brevo-php/docs/Api/UserApi.md
vendored
Normal file
|
|
@ -0,0 +1,358 @@
|
|||
# Brevo\Client\UserApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**editUserPermission**](UserApi.md#editUserPermission) | **POST** /organization/user/update/permissions | Update permission for a user
|
||||
[**getInvitedUsersList**](UserApi.md#getInvitedUsersList) | **GET** /organization/invited/users | Get the list of all your users
|
||||
[**getUserPermission**](UserApi.md#getUserPermission) | **GET** /organization/user/{email}/permissions | Check user permission
|
||||
[**inviteuser**](UserApi.md#inviteuser) | **POST** /organization/user/invitation/send | Send invitation to user
|
||||
[**putRevokeUserPermission**](UserApi.md#putRevokeUserPermission) | **PUT** /organization/user/invitation/revoke/{email} | Revoke user permission
|
||||
[**putresendcancelinvitation**](UserApi.md#putresendcancelinvitation) | **PUT** /organization/user/invitation/{action}/{email} | Resend / Cancel invitation
|
||||
|
||||
|
||||
# **editUserPermission**
|
||||
> \Brevo\Client\Model\Inviteuser editUserPermission($updatePermissions)
|
||||
|
||||
Update permission for a user
|
||||
|
||||
`Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"send_schedule_suspend\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `facebook_ads`: - \"create_edit_delete\" - \"schedule_pause\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"manage_owned_deals_tasks_companies\" - \"manage_others_deals_tasks_companies\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" **Note**: - The privileges array remains the same as in the send invitation; the user simply needs to provide the permissions that need to be updated. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\UserApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$updatePermissions = new \Brevo\Client\Model\Inviteuser(); // \Brevo\Client\Model\Inviteuser | Values to update permissions for an invited user
|
||||
|
||||
try {
|
||||
$result = $apiInstance->editUserPermission($updatePermissions);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling UserApi->editUserPermission: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**updatePermissions** | [**\Brevo\Client\Model\Inviteuser**](../Model/Inviteuser.md)| Values to update permissions for an invited user |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Inviteuser**](../Model/Inviteuser.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getInvitedUsersList**
|
||||
> \Brevo\Client\Model\GetInvitedUsersList getInvitedUsersList()
|
||||
|
||||
Get the list of all your users
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\UserApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getInvitedUsersList();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling UserApi->getInvitedUsersList: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetInvitedUsersList**](../Model/GetInvitedUsersList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getUserPermission**
|
||||
> \Brevo\Client\Model\GetUserPermission getUserPermission($email)
|
||||
|
||||
Check user permission
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\UserApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$email = "email_example"; // string | Email of the invited user.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getUserPermission($email);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling UserApi->getUserPermission: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**email** | **string**| Email of the invited user. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetUserPermission**](../Model/GetUserPermission.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **inviteuser**
|
||||
> \Brevo\Client\Model\Inviteuser inviteuser($sendInvitation)
|
||||
|
||||
Send invitation to user
|
||||
|
||||
`Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"send_schedule_suspend\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `facebook_ads`: - \"create_edit_delete\" - \"schedule_pause\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"manage_owned_deals_tasks_companies\" - \"manage_others_deals_tasks_companies\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\UserApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$sendInvitation = new \Brevo\Client\Model\Inviteuser(); // \Brevo\Client\Model\Inviteuser | Values to create an invitation
|
||||
|
||||
try {
|
||||
$result = $apiInstance->inviteuser($sendInvitation);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling UserApi->inviteuser: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**sendInvitation** | [**\Brevo\Client\Model\Inviteuser**](../Model/Inviteuser.md)| Values to create an invitation |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Inviteuser**](../Model/Inviteuser.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **putRevokeUserPermission**
|
||||
> \Brevo\Client\Model\PutRevokeUserPermission putRevokeUserPermission($email)
|
||||
|
||||
Revoke user permission
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\UserApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$email = "email_example"; // string | Email of the invited user.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->putRevokeUserPermission($email);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling UserApi->putRevokeUserPermission: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**email** | **string**| Email of the invited user. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\PutRevokeUserPermission**](../Model/PutRevokeUserPermission.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **putresendcancelinvitation**
|
||||
> \Brevo\Client\Model\Putresendcancelinvitation putresendcancelinvitation($action, $email)
|
||||
|
||||
Resend / Cancel invitation
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\UserApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$action = "action_example"; // string | action
|
||||
$email = "email_example"; // string | Email of the invited user.
|
||||
|
||||
try {
|
||||
$result = $apiInstance->putresendcancelinvitation($action, $email);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling UserApi->putresendcancelinvitation: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**action** | **string**| action |
|
||||
**email** | **string**| Email of the invited user. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\Putresendcancelinvitation**](../Model/Putresendcancelinvitation.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
360
vendor/getbrevo/brevo-php/docs/Api/WebhooksApi.md
vendored
Normal file
360
vendor/getbrevo/brevo-php/docs/Api/WebhooksApi.md
vendored
Normal file
|
|
@ -0,0 +1,360 @@
|
|||
# Brevo\Client\WebhooksApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createWebhook**](WebhooksApi.md#createWebhook) | **POST** /webhooks | Create a webhook
|
||||
[**deleteWebhook**](WebhooksApi.md#deleteWebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
|
||||
[**exportWebhooksHistory**](WebhooksApi.md#exportWebhooksHistory) | **POST** /webhooks/export | Export all webhook events
|
||||
[**getWebhook**](WebhooksApi.md#getWebhook) | **GET** /webhooks/{webhookId} | Get a webhook details
|
||||
[**getWebhooks**](WebhooksApi.md#getWebhooks) | **GET** /webhooks | Get all webhooks
|
||||
[**updateWebhook**](WebhooksApi.md#updateWebhook) | **PUT** /webhooks/{webhookId} | Update a webhook
|
||||
|
||||
|
||||
# **createWebhook**
|
||||
> \Brevo\Client\Model\CreateModel createWebhook($createWebhook)
|
||||
|
||||
Create a webhook
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WebhooksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$createWebhook = new \Brevo\Client\Model\CreateWebhook(); // \Brevo\Client\Model\CreateWebhook | Values to create a webhook
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createWebhook($createWebhook);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WebhooksApi->createWebhook: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createWebhook** | [**\Brevo\Client\Model\CreateWebhook**](../Model/CreateWebhook.md)| Values to create a webhook |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteWebhook**
|
||||
> deleteWebhook($webhookId)
|
||||
|
||||
Delete a webhook
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WebhooksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$webhookId = 789; // int | Id of the webhook
|
||||
|
||||
try {
|
||||
$apiInstance->deleteWebhook($webhookId);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WebhooksApi->deleteWebhook: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**webhookId** | **int**| Id of the webhook |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **exportWebhooksHistory**
|
||||
> \Brevo\Client\Model\CreatedProcessId exportWebhooksHistory($exportWebhookHistory)
|
||||
|
||||
Export all webhook events
|
||||
|
||||
This endpoint will submit a request to get the history of webhooks in the CSV file. The link to download the CSV file will be sent to the webhook that was provided in the notifyURL.
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WebhooksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$exportWebhookHistory = new \Brevo\Client\Model\ExportWebhooksHistory(); // \Brevo\Client\Model\ExportWebhooksHistory | Values to submit for webhooks history
|
||||
|
||||
try {
|
||||
$result = $apiInstance->exportWebhooksHistory($exportWebhookHistory);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WebhooksApi->exportWebhooksHistory: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**exportWebhookHistory** | [**\Brevo\Client\Model\ExportWebhooksHistory**](../Model/ExportWebhooksHistory.md)| Values to submit for webhooks history |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getWebhook**
|
||||
> \Brevo\Client\Model\GetWebhook getWebhook($webhookId)
|
||||
|
||||
Get a webhook details
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WebhooksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$webhookId = 789; // int | Id of the webhook
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getWebhook($webhookId);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WebhooksApi->getWebhook: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**webhookId** | **int**| Id of the webhook |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetWebhook**](../Model/GetWebhook.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getWebhooks**
|
||||
> \Brevo\Client\Model\GetWebhooks getWebhooks($type, $sort)
|
||||
|
||||
Get all webhooks
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WebhooksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$type = "transactional"; // string | Filter on webhook type
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of webhook creation
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getWebhooks($type, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WebhooksApi->getWebhooks: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**type** | **string**| Filter on webhook type | [optional] [default to transactional]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of webhook creation | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetWebhooks**](../Model/GetWebhooks.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateWebhook**
|
||||
> updateWebhook($webhookId, $updateWebhook)
|
||||
|
||||
Update a webhook
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WebhooksApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$webhookId = 789; // int | Id of the webhook
|
||||
$updateWebhook = new \Brevo\Client\Model\UpdateWebhook(); // \Brevo\Client\Model\UpdateWebhook | Values to update a webhook
|
||||
|
||||
try {
|
||||
$apiInstance->updateWebhook($webhookId, $updateWebhook);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WebhooksApi->updateWebhook: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**webhookId** | **int**| Id of the webhook |
|
||||
**updateWebhook** | [**\Brevo\Client\Model\UpdateWebhook**](../Model/UpdateWebhook.md)| Values to update a webhook |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
543
vendor/getbrevo/brevo-php/docs/Api/WhatsAppCampaignsApi.md
vendored
Normal file
543
vendor/getbrevo/brevo-php/docs/Api/WhatsAppCampaignsApi.md
vendored
Normal file
|
|
@ -0,0 +1,543 @@
|
|||
# Brevo\Client\WhatsAppCampaignsApi
|
||||
|
||||
All URIs are relative to *https://api.brevo.com/v3*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createWhatsAppCampaign**](WhatsAppCampaignsApi.md#createWhatsAppCampaign) | **POST** /whatsappCampaigns | Create and Send a WhatsApp campaign
|
||||
[**createWhatsAppTemplate**](WhatsAppCampaignsApi.md#createWhatsAppTemplate) | **POST** /whatsppCampaigns/template | Create a WhatsApp template
|
||||
[**deleteWhatsAppCampaign**](WhatsAppCampaignsApi.md#deleteWhatsAppCampaign) | **DELETE** /whatsappCampaigns/{campaignId} | Delete a WhatsApp campaign
|
||||
[**getWhatsAppCampaign**](WhatsAppCampaignsApi.md#getWhatsAppCampaign) | **GET** /whatsappCampaigns/{campaignId} | Get a WhatsApp campaign
|
||||
[**getWhatsAppCampaigns**](WhatsAppCampaignsApi.md#getWhatsAppCampaigns) | **GET** /whatsappCampaigns | Return all your created WhatsApp campaigns
|
||||
[**getWhatsAppConfig**](WhatsAppCampaignsApi.md#getWhatsAppConfig) | **GET** /whatsappCampaigns/config | Get your WhatsApp API account information
|
||||
[**getWhatsAppTemplates**](WhatsAppCampaignsApi.md#getWhatsAppTemplates) | **GET** /whatsappCampaigns/template-list | Return all your created WhatsApp templates
|
||||
[**sendWhatsAppTemplateApproval**](WhatsAppCampaignsApi.md#sendWhatsAppTemplateApproval) | **POST** /whatsappCampaigns/template/approval/{templateId} | Send your WhatsApp template for approval
|
||||
[**updateWhatsAppCampaign**](WhatsAppCampaignsApi.md#updateWhatsAppCampaign) | **PUT** /whatsappCampaigns/{campaignId} | Update a WhatsApp campaign
|
||||
|
||||
|
||||
# **createWhatsAppCampaign**
|
||||
> \Brevo\Client\Model\CreateModel createWhatsAppCampaign($whatsAppCampaigns)
|
||||
|
||||
Create and Send a WhatsApp campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$whatsAppCampaigns = new \Brevo\Client\Model\CreateWhatsAppCampaign(); // \Brevo\Client\Model\CreateWhatsAppCampaign | Values to create a campaign
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createWhatsAppCampaign($whatsAppCampaigns);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WhatsAppCampaignsApi->createWhatsAppCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**whatsAppCampaigns** | [**\Brevo\Client\Model\CreateWhatsAppCampaign**](../Model/CreateWhatsAppCampaign.md)| Values to create a campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **createWhatsAppTemplate**
|
||||
> \Brevo\Client\Model\CreateModel createWhatsAppTemplate($whatsAppTemplates)
|
||||
|
||||
Create a WhatsApp template
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$whatsAppTemplates = new \Brevo\Client\Model\CreateWhatsAppTemplate(); // \Brevo\Client\Model\CreateWhatsAppTemplate | Values to create a template
|
||||
|
||||
try {
|
||||
$result = $apiInstance->createWhatsAppTemplate($whatsAppTemplates);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WhatsAppCampaignsApi->createWhatsAppTemplate: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**whatsAppTemplates** | [**\Brevo\Client\Model\CreateWhatsAppTemplate**](../Model/CreateWhatsAppTemplate.md)| Values to create a template |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **deleteWhatsAppCampaign**
|
||||
> deleteWhatsAppCampaign($campaignId)
|
||||
|
||||
Delete a WhatsApp campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | id of the campaign
|
||||
|
||||
try {
|
||||
$apiInstance->deleteWhatsAppCampaign($campaignId);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WhatsAppCampaignsApi->deleteWhatsAppCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| id of the campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getWhatsAppCampaign**
|
||||
> \Brevo\Client\Model\GetWhatsappCampaignOverview getWhatsAppCampaign($campaignId)
|
||||
|
||||
Get a WhatsApp campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the campaign
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getWhatsAppCampaign($campaignId);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WhatsAppCampaignsApi->getWhatsAppCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetWhatsappCampaignOverview**](../Model/GetWhatsappCampaignOverview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getWhatsAppCampaigns**
|
||||
> \Brevo\Client\Model\GetWhatsappCampaigns getWhatsAppCampaigns($startDate, $endDate, $limit, $offset, $sort)
|
||||
|
||||
Return all your created WhatsApp campaigns
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$startDate = "startDate_example"; // string | **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result**
|
||||
$endDate = "endDate_example"; // string | **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result**
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document in the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getWhatsAppCampaigns($startDate, $endDate, $limit, $offset, $sort);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WhatsAppCampaignsApi->getWhatsAppCampaigns: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**startDate** | **string**| **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** | [optional]
|
||||
**endDate** | **string**| **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetWhatsappCampaigns**](../Model/GetWhatsappCampaigns.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getWhatsAppConfig**
|
||||
> \Brevo\Client\Model\GetWhatsAppConfig getWhatsAppConfig()
|
||||
|
||||
Get your WhatsApp API account information
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getWhatsAppConfig();
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WhatsAppCampaignsApi->getWhatsAppConfig: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetWhatsAppConfig**](../Model/GetWhatsAppConfig.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **getWhatsAppTemplates**
|
||||
> \Brevo\Client\Model\GetWATemplates getWhatsAppTemplates($startDate, $endDate, $limit, $offset, $sort, $source)
|
||||
|
||||
Return all your created WhatsApp templates
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$startDate = "startDate_example"; // string | **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**
|
||||
$endDate = "endDate_example"; // string | **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**
|
||||
$limit = 50; // int | Number of documents per page
|
||||
$offset = 0; // int | Index of the first document in the page
|
||||
$sort = "desc"; // string | Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed
|
||||
$source = "source_example"; // string | source of the template
|
||||
|
||||
try {
|
||||
$result = $apiInstance->getWhatsAppTemplates($startDate, $endDate, $limit, $offset, $sort, $source);
|
||||
print_r($result);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WhatsAppCampaignsApi->getWhatsAppTemplates: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**startDate** | **string**| **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** | [optional]
|
||||
**endDate** | **string**| **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** | [optional]
|
||||
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||||
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
|
||||
**sort** | **string**| Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
||||
**source** | **string**| source of the template | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**\Brevo\Client\Model\GetWATemplates**](../Model/GetWATemplates.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **sendWhatsAppTemplateApproval**
|
||||
> sendWhatsAppTemplateApproval($templateId)
|
||||
|
||||
Send your WhatsApp template for approval
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$templateId = 789; // int | id of the campaign
|
||||
|
||||
try {
|
||||
$apiInstance->sendWhatsAppTemplateApproval($templateId);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WhatsAppCampaignsApi->sendWhatsAppTemplateApproval: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**templateId** | **int**| id of the campaign |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
# **updateWhatsAppCampaign**
|
||||
> updateWhatsAppCampaign($campaignId, $whatsAppCampaign)
|
||||
|
||||
Update a WhatsApp campaign
|
||||
|
||||
### Example
|
||||
```php
|
||||
<?php
|
||||
require_once(__DIR__ . '/vendor/autoload.php');
|
||||
|
||||
// Configure API key authorization: api-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||||
// Configure API key authorization: partner-key
|
||||
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||||
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||||
|
||||
$apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi(
|
||||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
|
||||
// This is optional, `GuzzleHttp\Client` will be used as default.
|
||||
new GuzzleHttp\Client(),
|
||||
$config
|
||||
);
|
||||
$campaignId = 789; // int | Id of the campaign
|
||||
$whatsAppCampaign = new \Brevo\Client\Model\UpdateWhatsAppCampaign(); // \Brevo\Client\Model\UpdateWhatsAppCampaign | values to update WhatsApp Campaign
|
||||
|
||||
try {
|
||||
$apiInstance->updateWhatsAppCampaign($campaignId, $whatsAppCampaign);
|
||||
} catch (Exception $e) {
|
||||
echo 'Exception when calling WhatsAppCampaignsApi->updateWhatsAppCampaign: ', $e->getMessage(), PHP_EOL;
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**campaignId** | **int**| Id of the campaign |
|
||||
**whatsAppCampaign** | [**\Brevo\Client\Model\UpdateWhatsAppCampaign**](../Model/UpdateWhatsAppCampaign.md)| values to update WhatsApp Campaign | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||||
|
||||
17
vendor/getbrevo/brevo-php/docs/Model/AbTestCampaignResult.md
vendored
Normal file
17
vendor/getbrevo/brevo-php/docs/Model/AbTestCampaignResult.md
vendored
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# AbTestCampaignResult
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**winningVersion** | **string** | Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending. | [optional]
|
||||
**winningCriteria** | **string** | Criteria choosen for winning version (Open/Click) | [optional]
|
||||
**winningSubjectLine** | **string** | Subject Line of current winning version | [optional]
|
||||
**openRate** | **string** | Open rate for current winning version | [optional]
|
||||
**clickRate** | **string** | Click rate for current winning version | [optional]
|
||||
**winningVersionRate** | **string** | Open/Click rate for the winner version | [optional]
|
||||
**statistics** | [**\Brevo\Client\Model\AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional]
|
||||
**clickedLinks** | [**\Brevo\Client\Model\AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/AbTestCampaignResultClickedLinks.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/AbTestCampaignResultClickedLinks.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# AbTestCampaignResultClickedLinks
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**versionA** | [**\Brevo\Client\Model\AbTestVersionClicks**](AbTestVersionClicks.md) | |
|
||||
**versionB** | [**\Brevo\Client\Model\AbTestVersionClicks**](AbTestVersionClicks.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
15
vendor/getbrevo/brevo-php/docs/Model/AbTestCampaignResultStatistics.md
vendored
Normal file
15
vendor/getbrevo/brevo-php/docs/Model/AbTestCampaignResultStatistics.md
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# AbTestCampaignResultStatistics
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**openers** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
||||
**clicks** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
||||
**unsubscribed** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
||||
**hardBounces** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
||||
**softBounces** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
||||
**complaints** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
9
vendor/getbrevo/brevo-php/docs/Model/AbTestVersionClicks.md
vendored
Normal file
9
vendor/getbrevo/brevo-php/docs/Model/AbTestVersionClicks.md
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
# AbTestVersionClicks
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
12
vendor/getbrevo/brevo-php/docs/Model/AbTestVersionClicksInner.md
vendored
Normal file
12
vendor/getbrevo/brevo-php/docs/Model/AbTestVersionClicksInner.md
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# AbTestVersionClicksInner
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**link** | **string** | URL of the link |
|
||||
**clicksCount** | **int** | Number of times a link is clicked |
|
||||
**clickRate** | **string** | Percentage of clicks of link with respect to total clicks |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/AbTestVersionStats.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/AbTestVersionStats.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# AbTestVersionStats
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**versionA** | **string** | percentage of an event for version A |
|
||||
**versionB** | **string** | percentage of an event for version B |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
10
vendor/getbrevo/brevo-php/docs/Model/AddChildDomain.md
vendored
Normal file
10
vendor/getbrevo/brevo-php/docs/Model/AddChildDomain.md
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
# AddChildDomain
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**domain** | **string** | Sender domain to add for a specific child account | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/AddContactToList.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/AddContactToList.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# AddContactToList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**emails** | **string[]** | Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
|
||||
**ids** | **int[]** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/AddCredits.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/AddCredits.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# AddCredits
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**sms** | **int** | Required if email credits are empty. SMS credits to be added to the child account | [optional]
|
||||
**email** | **int** | Required if sms credits are empty. Email credits to be added to the child account | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/AuthenticateDomainModel.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/AuthenticateDomainModel.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# AuthenticateDomainModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**domainName** | **string** | Domain |
|
||||
**message** | **string** | Success message |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
10
vendor/getbrevo/brevo-php/docs/Model/BlockDomain.md
vendored
Normal file
10
vendor/getbrevo/brevo-php/docs/Model/BlockDomain.md
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
# BlockDomain
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**domain** | **string** | name of the domain to be blocked |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/Body.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/Body.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# Body
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**groupName** | **string** | The name of the group of sub-accounts |
|
||||
**subAccountIds** | **int[]** | Pass the list of sub-account Ids to be included in the group | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/Body1.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/Body1.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# Body1
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**groupName** | **string** | The name of the group of sub-accounts |
|
||||
**subAccountIds** | **int[]** | Pass the list of sub-account Ids to be included in the group | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
15
vendor/getbrevo/brevo-php/docs/Model/Body10.md
vendored
Normal file
15
vendor/getbrevo/brevo-php/docs/Model/Body10.md
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# Body10
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**visitorId** | **string** | visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
|
||||
**text** | **string** | message text |
|
||||
**agentId** | **string** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
|
||||
**receivedFrom** | **string** | mark your messages to distinguish messages created by you from the others. | [optional]
|
||||
**agentEmail** | **string** | agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. | [optional]
|
||||
**agentName** | **string** | agent name | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
10
vendor/getbrevo/brevo-php/docs/Model/Body11.md
vendored
Normal file
10
vendor/getbrevo/brevo-php/docs/Model/Body11.md
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
# Body11
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**text** | **string** | edited message text |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
13
vendor/getbrevo/brevo-php/docs/Model/Body12.md
vendored
Normal file
13
vendor/getbrevo/brevo-php/docs/Model/Body12.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Body12
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**visitorId** | **string** | visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
|
||||
**text** | **string** | message text |
|
||||
**agentId** | **string** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set. | [optional]
|
||||
**groupId** | **string** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
10
vendor/getbrevo/brevo-php/docs/Model/Body13.md
vendored
Normal file
10
vendor/getbrevo/brevo-php/docs/Model/Body13.md
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
# Body13
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**text** | **string** | edited message text |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
13
vendor/getbrevo/brevo-php/docs/Model/Body14.md
vendored
Normal file
13
vendor/getbrevo/brevo-php/docs/Model/Body14.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Body14
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**agentId** | **string** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
|
||||
**receivedFrom** | **string** | mark your messages to distinguish messages created by you from the others. | [optional]
|
||||
**agentEmail** | **string** | agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically. | [optional]
|
||||
**agentName** | **string** | agent name. | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
12
vendor/getbrevo/brevo-php/docs/Model/Body2.md
vendored
Normal file
12
vendor/getbrevo/brevo-php/docs/Model/Body2.md
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# Body2
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | Name of company |
|
||||
**attributes** | **object** | Attributes for company creation | [optional]
|
||||
**countryCode** | **int** | Country code if phone_number is passed in attributes. | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
12
vendor/getbrevo/brevo-php/docs/Model/Body3.md
vendored
Normal file
12
vendor/getbrevo/brevo-php/docs/Model/Body3.md
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# Body3
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | Name of company | [optional]
|
||||
**attributes** | **object** | Attributes for company update | [optional]
|
||||
**countryCode** | **int** | Country code if phone_number is passed in attributes. | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
13
vendor/getbrevo/brevo-php/docs/Model/Body4.md
vendored
Normal file
13
vendor/getbrevo/brevo-php/docs/Model/Body4.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Body4
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**linkContactIds** | **int[]** | Contact ids for contacts to be linked with company | [optional]
|
||||
**unlinkContactIds** | **int[]** | Contact ids for contacts to be unlinked from company | [optional]
|
||||
**linkDealsIds** | **string[]** | Deals ids for deals to be linked with company | [optional]
|
||||
**unlinkDealsIds** | **string[]** | Deals ids for deals to be unlinked from company | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/Body5.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/Body5.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# Body5
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | Name of deal |
|
||||
**attributes** | **object** | Attributes for deal creation If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/Body6.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/Body6.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# Body6
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | Name of deal | [optional]
|
||||
**attributes** | **object** | Attributes for deal update If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
13
vendor/getbrevo/brevo-php/docs/Model/Body7.md
vendored
Normal file
13
vendor/getbrevo/brevo-php/docs/Model/Body7.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Body7
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**linkContactIds** | **int[]** | Contact ids for contacts to be linked with deal | [optional]
|
||||
**unlinkContactIds** | **int[]** | Contact ids for contacts to be unlinked from deal | [optional]
|
||||
**linkCompanyIds** | **string[]** | Company ids to be linked with deal | [optional]
|
||||
**unlinkCompanyIds** | **string[]** | Company ids to be unlinked from deal | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
20
vendor/getbrevo/brevo-php/docs/Model/Body8.md
vendored
Normal file
20
vendor/getbrevo/brevo-php/docs/Model/Body8.md
vendored
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
# Body8
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | Name of task |
|
||||
**duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
|
||||
**taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. |
|
||||
**date** | [**\DateTime**] | Task due date and time |
|
||||
**notes** | **string** | Notes added to a task | [optional]
|
||||
**done** | **bool** | Task marked as done | [optional]
|
||||
**assignToId** | **string** | User id to whom task is assigned | [optional]
|
||||
**contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional]
|
||||
**dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional]
|
||||
**companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional]
|
||||
**reminder** | [**\Brevo\Client\Model\TaskReminder**](TaskReminder.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
19
vendor/getbrevo/brevo-php/docs/Model/Body9.md
vendored
Normal file
19
vendor/getbrevo/brevo-php/docs/Model/Body9.md
vendored
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# Body9
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | Name of task | [optional]
|
||||
**duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
|
||||
**taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. | [optional]
|
||||
**date** | [**\DateTime**] | Task date/time | [optional]
|
||||
**notes** | **string** | Notes added to a task | [optional]
|
||||
**done** | **bool** | Task marked as done | [optional]
|
||||
**assignToId** | **string** | User id to whom task is assigned | [optional]
|
||||
**contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional]
|
||||
**dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional]
|
||||
**companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
9
vendor/getbrevo/brevo-php/docs/Model/BodyVariablesItems.md
vendored
Normal file
9
vendor/getbrevo/brevo-php/docs/Model/BodyVariablesItems.md
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
# BodyVariablesItems
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
10
vendor/getbrevo/brevo-php/docs/Model/CompaniesList.md
vendored
Normal file
10
vendor/getbrevo/brevo-php/docs/Model/CompaniesList.md
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
# CompaniesList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**items** | [**\Brevo\Client\Model\Company[]**](Company.md) | List of compaies | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
13
vendor/getbrevo/brevo-php/docs/Model/Company.md
vendored
Normal file
13
vendor/getbrevo/brevo-php/docs/Model/Company.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Company
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | Unique company id | [optional]
|
||||
**attributes** | **object** | Company attributes with values | [optional]
|
||||
**linkedContactsIds** | **int[]** | Contact ids for contacts linked to this company | [optional]
|
||||
**linkedDealsIds** | **string[]** | Deals ids for companies linked to this company | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
9
vendor/getbrevo/brevo-php/docs/Model/CompanyAttributes.md
vendored
Normal file
9
vendor/getbrevo/brevo-php/docs/Model/CompanyAttributes.md
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
# CompanyAttributes
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
14
vendor/getbrevo/brevo-php/docs/Model/CompanyAttributesInner.md
vendored
Normal file
14
vendor/getbrevo/brevo-php/docs/Model/CompanyAttributesInner.md
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# CompanyAttributesInner
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**internalName** | **string** | | [optional]
|
||||
**label** | **string** | | [optional]
|
||||
**attributeTypeName** | **string** | | [optional]
|
||||
**attributeOptions** | **object[]** | | [optional]
|
||||
**isRequired** | **bool** | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/ComponentItems.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/ComponentItems.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# ComponentItems
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **string** | | [optional]
|
||||
**text** | **string** | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
17
vendor/getbrevo/brevo-php/docs/Model/Contact.md
vendored
Normal file
17
vendor/getbrevo/brevo-php/docs/Model/Contact.md
vendored
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# Contact
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**virtualNextTask** | **object** | Next incomplete task of contact | [optional]
|
||||
**email** | **string** | Contact email |
|
||||
**assignToId** | **string** | User id to whom contact is assigned | [optional]
|
||||
**contactsId** | **int** | Contact id | [optional]
|
||||
**crmLists** | **object** | CRM lists in which contact is added |
|
||||
**attributes** | **object** | Contact attributes e.g firstname / lastname / SMS etc. | [optional]
|
||||
**createdAt** | [**\DateTime**] | Contact created date/time | [optional]
|
||||
**updatedAt** | [**\DateTime**] | Contact updated date/time | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
14
vendor/getbrevo/brevo-php/docs/Model/ConversationsMessageFile.md
vendored
Normal file
14
vendor/getbrevo/brevo-php/docs/Model/ConversationsMessageFile.md
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# ConversationsMessageFile
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**filename** | **string** | Name of the file | [optional]
|
||||
**size** | **int** | Size in bytes | [optional]
|
||||
**isImage** | **bool** | Whether the file is an image | [optional]
|
||||
**url** | **string** | URL of the file | [optional]
|
||||
**imageInfo** | [**\Brevo\Client\Model\ConversationsMessageFileImageInfo**](ConversationsMessageFileImageInfo.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
19
vendor/getbrevo/brevo-php/docs/Model/Conversationsmessage.md
vendored
Normal file
19
vendor/getbrevo/brevo-php/docs/Model/Conversationsmessage.md
vendored
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# ConversationsMessage
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | Message ID. It can be used for further manipulations with the message. | [optional]
|
||||
**type** | **string** | `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. | [optional]
|
||||
**text** | **string** | Message text or name of the attached file | [optional]
|
||||
**visitorId** | **string** | visitor’s ID | [optional]
|
||||
**agentId** | **string** | ID of the agent on whose behalf the message was sent (only in messages sent by an agent). | [optional]
|
||||
**agentName** | **string** | Agent’s name as displayed to the visitor. Only in the messages sent by an agent. | [optional]
|
||||
**createdAt** | **int** | Timestamp in milliseconds. | [optional]
|
||||
**isPushed** | **bool** | `true` for pushed messages | [optional]
|
||||
**receivedFrom** | **string** | In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. | [optional]
|
||||
**file** | [**\Brevo\Client\Model\ConversationsMessageFile**](ConversationsMessageFile.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
12
vendor/getbrevo/brevo-php/docs/Model/ConversationsmessageFileImageInfo.md
vendored
Normal file
12
vendor/getbrevo/brevo-php/docs/Model/ConversationsmessageFileImageInfo.md
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# ConversationsMessageFileImageInfo
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**width** | **int** | Width of the image | [optional]
|
||||
**height** | **int** | height of the image | [optional]
|
||||
**previewUrl** | **string** | URL of the preview | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/CreateApiKeyRequest.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/CreateApiKeyRequest.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# CreateApiKeyRequest
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Id of the sub-account organization |
|
||||
**name** | **string** | Name of the API key | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/CreateApiKeyResponse.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/CreateApiKeyResponse.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# CreateApiKeyResponse
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**status** | **string** | Status of the API operation. | [optional]
|
||||
**key** | **string** | API Key | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
13
vendor/getbrevo/brevo-php/docs/Model/CreateAttribute.md
vendored
Normal file
13
vendor/getbrevo/brevo-php/docs/Model/CreateAttribute.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# CreateAttribute
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**value** | **string** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
|
||||
**isRecurring** | **bool** | Type of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
|
||||
**enumeration** | [**\Brevo\Client\Model\CreateAttributeEnumeration[]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional]
|
||||
**type** | **string** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/CreateAttributeEnumeration.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/CreateAttributeEnumeration.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# CreateAttributeEnumeration
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**value** | **int** | Id of the value |
|
||||
**label** | **string** | Label of the value |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
10
vendor/getbrevo/brevo-php/docs/Model/CreateCategoryModel.md
vendored
Normal file
10
vendor/getbrevo/brevo-php/docs/Model/CreateCategoryModel.md
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
# CreateCategoryModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | ID of the category when a new category is created | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
15
vendor/getbrevo/brevo-php/docs/Model/CreateChild.md
vendored
Normal file
15
vendor/getbrevo/brevo-php/docs/Model/CreateChild.md
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# CreateChild
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **string** | Email address to create the child account |
|
||||
**firstName** | **string** | First name to use to create the child account |
|
||||
**lastName** | **string** | Last name to use to create the child account |
|
||||
**companyName** | **string** | Company name to use to create the child account |
|
||||
**password** | **string** | Password for the child account to login |
|
||||
**language** | **string** | Language of the child account | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
17
vendor/getbrevo/brevo-php/docs/Model/CreateContact.md
vendored
Normal file
17
vendor/getbrevo/brevo-php/docs/Model/CreateContact.md
vendored
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# CreateContact
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **string** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {'SMS':'+91xxxxxxxxxx'} or {'SMS':'0091xxxxxxxxxx'} | [optional]
|
||||
**extId** | **string** | Pass your own Id to create a contact. | [optional]
|
||||
**attributes** | **object** | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored.These attributes must be present in your Brevo account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional]
|
||||
**emailBlacklisted** | **bool** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
|
||||
**smsBlacklisted** | **bool** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
|
||||
**listIds** | **int[]** | Ids of the lists to add the contact to | [optional]
|
||||
**updateEnabled** | **bool** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false]
|
||||
**smtpBlacklistSender** | **string[]** | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/CreateCouponCollection.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/CreateCouponCollection.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# CreateCouponCollection
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **object** | Name of the collection with no white spaces between words |
|
||||
**defaultCoupon** | **object** | A default coupon to be used in case there are no coupons left |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/CreateCoupons.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/CreateCoupons.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# CreateCoupons
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**collectionId** | **string** | The id of the coupon collection for which the coupons will be created |
|
||||
**coupons** | **string[]** | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
15
vendor/getbrevo/brevo-php/docs/Model/CreateDoiContact.md
vendored
Normal file
15
vendor/getbrevo/brevo-php/docs/Model/CreateDoiContact.md
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# CreateDoiContact
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **string** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. |
|
||||
**attributes** | **object** | Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional]
|
||||
**includeListIds** | **int[]** | Lists under user account where contact should be added |
|
||||
**excludeListIds** | **int[]** | Lists under user account where contact should not be added | [optional]
|
||||
**templateId** | **int** | Id of the Double opt-in (DOI) template |
|
||||
**redirectionUrl** | **string** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
10
vendor/getbrevo/brevo-php/docs/Model/CreateDomain.md
vendored
Normal file
10
vendor/getbrevo/brevo-php/docs/Model/CreateDomain.md
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
# CreateDomain
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | Domain name |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
13
vendor/getbrevo/brevo-php/docs/Model/CreateDomainModel.md
vendored
Normal file
13
vendor/getbrevo/brevo-php/docs/Model/CreateDomainModel.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# CreateDomainModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | ID of the Domain created |
|
||||
**domainName** | **string** | Domain | [optional]
|
||||
**message** | **string** | Success message | [optional]
|
||||
**dnsRecords** | [**\Brevo\Client\Model\CreateDomainModelDnsRecords**](CreateDomainModelDnsRecords.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
11
vendor/getbrevo/brevo-php/docs/Model/CreateDomainModelDnsRecords.md
vendored
Normal file
11
vendor/getbrevo/brevo-php/docs/Model/CreateDomainModelDnsRecords.md
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# CreateDomainModelDnsRecords
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dkimRecord** | [**\Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) | | [optional]
|
||||
**brevoCode** | [**\Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
13
vendor/getbrevo/brevo-php/docs/Model/CreateDomainModelDnsRecordsDkimRecord.md
vendored
Normal file
13
vendor/getbrevo/brevo-php/docs/Model/CreateDomainModelDnsRecordsDkimRecord.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# CreateDomainModelDnsRecordsDkimRecord
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **string** | | [optional]
|
||||
**value** | **string** | | [optional]
|
||||
**hostName** | **string** | | [optional]
|
||||
**status** | **bool** | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
40
vendor/getbrevo/brevo-php/docs/Model/CreateEmailCampaign.md
vendored
Normal file
40
vendor/getbrevo/brevo-php/docs/Model/CreateEmailCampaign.md
vendored
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# CreateEmailCampaign
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**tag** | **string** | Tag of the campaign | [optional]
|
||||
**sender** | [**\Brevo\Client\Model\CreateEmailCampaignSender**](CreateEmailCampaignSender.md) | |
|
||||
**name** | **string** | Name of the campaign |
|
||||
**htmlContent** | **string** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional]
|
||||
**htmlUrl** | **string** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional]
|
||||
**templateId** | **int** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
|
||||
**scheduledAt** | **string** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
|
||||
**subject** | **string** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
|
||||
**previewText** | **string** | Preview text or preheader of the email campaign | [optional]
|
||||
**replyTo** | **string** | Email on which the campaign recipients will be able to reply to | [optional]
|
||||
**toField** | **string** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
|
||||
**recipients** | [**\Brevo\Client\Model\CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional]
|
||||
**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
|
||||
**inlineImageActivation** | **bool** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
|
||||
**mirrorActive** | **bool** | Use true to enable the mirror link | [optional]
|
||||
**footer** | **string** | Footer of the email campaign | [optional]
|
||||
**header** | **string** | Header of the email campaign | [optional]
|
||||
**utmCampaign** | **string** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
|
||||
**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME:\"Doe\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
|
||||
**sendAtBestTime** | **bool** | Set this to true if you want to send your campaign at best time. | [optional] [default to false]
|
||||
**abTesting** | **bool** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
|
||||
**subjectA** | **string** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
|
||||
**subjectB** | **string** | Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
|
||||
**splitRule** | **int** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional]
|
||||
**winnerCriteria** | **string** | Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [optional]
|
||||
**winnerDelay** | **int** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [optional]
|
||||
**ipWarmupEnable** | **bool** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
|
||||
**initialQuota** | **int** | Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional]
|
||||
**increaseRate** | **int** | Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional]
|
||||
**unsubscriptionPageId** | **string** | Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used. | [optional]
|
||||
**updateFormId** | **string** | Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used. | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
12
vendor/getbrevo/brevo-php/docs/Model/CreateEmailCampaignRecipients.md
vendored
Normal file
12
vendor/getbrevo/brevo-php/docs/Model/CreateEmailCampaignRecipients.md
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# CreateEmailCampaignRecipients
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**exclusionListIds** | **int[]** | List ids to exclude from the campaign | [optional]
|
||||
**listIds** | **int[]** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional]
|
||||
**segmentIds** | **int[]** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue