Skip to content

Commit

Permalink
Merge pull request #21 from getbrevo/NWF-723
Browse files Browse the repository at this point in the history
NWF-723 : Update PHP SDK to sync all the latest swagger changes
  • Loading branch information
preetishishodia7 authored Mar 8, 2024
2 parents 6c3286e + 351832c commit 2c987a7
Show file tree
Hide file tree
Showing 186 changed files with 14,727 additions and 2,838 deletions.
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# 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]
Expand Down
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ Class | Method | HTTP request | Description
*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
Expand Down Expand Up @@ -224,6 +225,8 @@ Class | Method | HTTP request | Description
*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)
Expand All @@ -233,7 +236,11 @@ Class | Method | HTTP request | Description
*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
Expand Down Expand Up @@ -300,19 +307,23 @@ Class | Method | HTTP request | Description
*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* | [**smtpLogMessageIdDelete**](docs/Api/TransactionalEmailsApi.md#smtplogmessageiddelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
*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 transactional events
*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
Expand Down Expand Up @@ -345,6 +356,8 @@ Class | Method | HTTP request | Description
- [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)
Expand Down Expand Up @@ -458,6 +471,10 @@ Class | Method | HTTP request | Description
- [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)
Expand Down Expand Up @@ -504,6 +521,7 @@ Class | Method | HTTP request | Description
- [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)
Expand Down Expand Up @@ -548,6 +566,8 @@ Class | Method | HTTP request | Description
- [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)
Expand All @@ -557,11 +577,17 @@ Class | Method | HTTP request | Description
- [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)
Expand All @@ -585,6 +611,8 @@ Class | Method | HTTP request | Description
- [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)
Expand Down
16 changes: 8 additions & 8 deletions docs/Api/CompaniesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ $apiInstance = new Brevo\Client\Api\CompaniesApi(
$config
);
$id = "id_example"; // string |
$body = new \Brevo\Client\Model\Body1(); // \Brevo\Client\Model\Body1 | Updated company details.
$body = new \Brevo\Client\Model\Body3(); // \Brevo\Client\Model\Body3 | Updated company details.

try {
$result = $apiInstance->companiesIdPatch($id, $body);
Expand All @@ -290,7 +290,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **string**| |
**body** | [**\Brevo\Client\Model\Body1**](../Model/Body1.md)| Updated company details. |
**body** | [**\Brevo\Client\Model\Body3**](../Model/Body3.md)| Updated company details. |

### Return type

Expand Down Expand Up @@ -333,7 +333,7 @@ $apiInstance = new Brevo\Client\Api\CompaniesApi(
$config
);
$id = "id_example"; // string |
$body = new \Brevo\Client\Model\Body2(); // \Brevo\Client\Model\Body2 | Linked / Unlinked contacts and deals ids.
$body = new \Brevo\Client\Model\Body4(); // \Brevo\Client\Model\Body4 | Linked / Unlinked contacts and deals ids.

try {
$apiInstance->companiesLinkUnlinkIdPatch($id, $body);
Expand All @@ -348,7 +348,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **string**| |
**body** | [**\Brevo\Client\Model\Body2**](../Model/Body2.md)| Linked / Unlinked contacts and deals ids. |
**body** | [**\Brevo\Client\Model\Body4**](../Model/Body4.md)| Linked / Unlinked contacts and deals ids. |

### Return type

Expand All @@ -366,7 +366,7 @@ void (empty response body)
[[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\InlineResponse200 companiesPost($body)
> \Brevo\Client\Model\InlineResponse2001 companiesPost($body)
Create a company

Expand All @@ -390,7 +390,7 @@ $apiInstance = new Brevo\Client\Api\CompaniesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \Brevo\Client\Model\Body(); // \Brevo\Client\Model\Body | Company create data.
$body = new \Brevo\Client\Model\Body2(); // \Brevo\Client\Model\Body2 | Company create data.

try {
$result = $apiInstance->companiesPost($body);
Expand All @@ -405,11 +405,11 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**\Brevo\Client\Model\Body**](../Model/Body.md)| Company create data. |
**body** | [**\Brevo\Client\Model\Body2**](../Model/Body2.md)| Company create data. |

### Return type

[**\Brevo\Client\Model\InlineResponse200**](../Model/InlineResponse200.md)
[**\Brevo\Client\Model\InlineResponse2001**](../Model/InlineResponse2001.md)

### Authorization

Expand Down
Loading

0 comments on commit 2c987a7

Please sign in to comment.