Skip to content

WF-2702 : sdk updated to latest features #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2023
Merged

WF-2702 : sdk updated to latest features #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,13 +158,13 @@ Class | Method | HTTP request | Description
*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* | [**crmPipelineDetailsGet**](docs/Api/DealsApi.md#crmpipelinedetailsget) | **GET** /crm/pipeline/details | Get pipeline stages
*EcommerceApi* | [**createBatchOrder**](docs/Api/EcommerceApi.md#createbatchorder) | **POST** /orders/status/batch | Maintains a batch of orders
*EcommerceApi* | [**createOrder**](docs/Api/EcommerceApi.md#createorder) | **POST** /orders/status | Maintains every transactional status of the order
*EcommerceApi* | [**createUpdateBatchCategory**](docs/Api/EcommerceApi.md#createupdatebatchcategory) | **POST** /categories/batch | Create the categories in a batch
*EcommerceApi* | [**createUpdateBatchProducts**](docs/Api/EcommerceApi.md#createupdatebatchproducts) | **POST** /products/batch | Creates the products in a batch
*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 | **Fulfills the eCommerce pre-requisites**
*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* | [**getProductInfo**](docs/Api/EcommerceApi.md#getproductinfo) | **GET** /products/{id} | Get a product's details
Expand Down Expand Up @@ -210,6 +210,7 @@ Class | Method | HTTP request | Description
*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 Sendinblue
*NotesApi* | [**crmNotesGet**](docs/Api/NotesApi.md#crmnotesget) | **GET** /crm/notes | Get all notes
Expand Down Expand Up @@ -284,11 +285,15 @@ Class | Method | HTTP request | Description
*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
*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* | [**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* | [**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


## Documentation For Models
Expand Down Expand Up @@ -316,13 +321,17 @@ Class | Method | HTTP request | Description
- [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)
Expand Down Expand Up @@ -478,9 +487,13 @@ Class | Method | HTTP request | Description
- [GetTransacSmsReportReports](docs/Model/GetTransacSmsReportReports.md)
- [GetWebhook](docs/Model/GetWebhook.md)
- [GetWebhooks](docs/Model/GetWebhooks.md)
- [GetWhatsappCampaignOverview](docs/Model/GetWhatsappCampaignOverview.md)
- [GetWhatsappEventReport](docs/Model/GetWhatsappEventReport.md)
- [GetWhatsappEventReportEvents](docs/Model/GetWhatsappEventReportEvents.md)
- [InlineResponse200](docs/Model/InlineResponse200.md)
- [InlineResponse201](docs/Model/InlineResponse201.md)
- [InlineResponse2011](docs/Model/InlineResponse2011.md)
- [InlineResponse2012](docs/Model/InlineResponse2012.md)
- [ManageIp](docs/Model/ManageIp.md)
- [MasterDetailsResponse](docs/Model/MasterDetailsResponse.md)
- [MasterDetailsResponseBillingInfo](docs/Model/MasterDetailsResponseBillingInfo.md)
Expand Down Expand Up @@ -529,6 +542,7 @@ Class | Method | HTTP request | Description
- [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)
- [SubAccountDetailsResponse](docs/Model/SubAccountDetailsResponse.md)
- [SubAccountDetailsResponsePlanInfo](docs/Model/SubAccountDetailsResponsePlanInfo.md)
Expand Down Expand Up @@ -576,6 +590,9 @@ Class | Method | HTTP request | Description
- [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
Expand Down
8 changes: 4 additions & 4 deletions docs/Api/ContactsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,8 +687,8 @@ $apiInstance = new SendinBlue\Client\Api\ContactsApi(
$config
);
$identifier = "identifier_example"; // string | Email (urlencoded) OR ID of the contact OR its SMS attribute value
$startDate = new \stdClass; // object | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
$endDate = new \stdClass; // object | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate.
$startDate = "startDate_example"; // string | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
$endDate = "endDate_example"; // string | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate.

try {
$result = $apiInstance->getContactInfo($identifier, $startDate, $endDate);
Expand All @@ -704,8 +704,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | **string**| Email (urlencoded) OR ID of the contact OR its SMS attribute value |
**startDate** | [**object**](../Model/.md)| **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
**endDate** | [**object**](../Model/.md)| **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. | [optional]
**startDate** | **string**| **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
**endDate** | **string**| **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. | [optional]

### Return type

Expand Down
42 changes: 28 additions & 14 deletions docs/Api/EcommerceApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ All URIs are relative to *https://api.sendinblue.com/v3*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createBatchOrder**](EcommerceApi.md#createBatchOrder) | **POST** /orders/status/batch | Maintains a batch of orders
[**createOrder**](EcommerceApi.md#createOrder) | **POST** /orders/status | Maintains every transactional status of the order
[**createUpdateBatchCategory**](EcommerceApi.md#createUpdateBatchCategory) | **POST** /categories/batch | Create the categories in a batch
[**createUpdateBatchProducts**](EcommerceApi.md#createUpdateBatchProducts) | **POST** /products/batch | Creates the products in a batch
[**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 | **Fulfills the eCommerce pre-requisites**
[**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
[**getProductInfo**](EcommerceApi.md#getProductInfo) | **GET** /products/{id} | Get a product's details
Expand All @@ -20,7 +20,9 @@ Method | HTTP request | Description
# **createBatchOrder**
> createBatchOrder($orderBatch)

Maintains a batch of orders
Create orders in batch

Create multiple orders at one time instead of one order at a time

### Example
```php
Expand Down Expand Up @@ -76,7 +78,9 @@ void (empty response body)
# **createOrder**
> createOrder($order)

Maintains every transactional status of the order
Managing the status of the order

Manages the transactional status of the order

### Example
```php
Expand Down Expand Up @@ -132,7 +136,7 @@ void (empty response body)
# **createUpdateBatchCategory**
> \SendinBlue\Client\Model\CreateUpdateBatchCategoryModel createUpdateBatchCategory($createUpdateBatchCategory)

Create the categories in a batch
Create categories in batch

### Example
```php
Expand Down Expand Up @@ -189,7 +193,7 @@ Name | Type | Description | Notes
# **createUpdateBatchProducts**
> \SendinBlue\Client\Model\CreateUpdateBatchProductsModel createUpdateBatchProducts($createUpdateBatchProducts)

Creates the products in a batch
Create products in batch

### Example
```php
Expand Down Expand Up @@ -360,7 +364,9 @@ Name | Type | Description | Notes
# **ecommerceActivatePost**
> ecommerceActivatePost()

**Fulfills the eCommerce pre-requisites**
Activate the eCommerce app

Getting access to Sendinblue eCommerce.

### Example
```php
Expand Down Expand Up @@ -410,7 +416,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)

# **getCategories**
> \SendinBlue\Client\Model\GetCategories getCategories($limit, $offset, $sort, $ids)
> \SendinBlue\Client\Model\GetCategories getCategories($limit, $offset, $sort, $ids, $name)

Return all your categories

Expand Down Expand Up @@ -438,9 +444,10 @@ $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

try {
$result = $apiInstance->getCategories($limit, $offset, $sort, $ids);
$result = $apiInstance->getCategories($limit, $offset, $sort, $ids, $name);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EcommerceApi->getCategories: ', $e->getMessage(), PHP_EOL;
Expand All @@ -456,6 +463,7 @@ Name | Type | Description | Notes
**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]

### Return type

Expand Down Expand Up @@ -587,7 +595,7 @@ Name | Type | Description | Notes
[[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**
> \SendinBlue\Client\Model\GetProducts getProducts($limit, $offset, $sort, $ids)
> \SendinBlue\Client\Model\GetProducts getProducts($limit, $offset, $sort, $ids, $name, $price, $categories)

Return all your products

Expand Down Expand Up @@ -615,9 +623,12 @@ $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
$price = array("price_example"); // string[] | Filter by product price, like price[lte]
$categories = array("categories_example"); // string[] | Filter by category ids

try {
$result = $apiInstance->getProducts($limit, $offset, $sort, $ids);
$result = $apiInstance->getProducts($limit, $offset, $sort, $ids, $name, $price, $categories);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EcommerceApi->getProducts: ', $e->getMessage(), PHP_EOL;
Expand All @@ -633,6 +644,9 @@ Name | Type | Description | Notes
**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]
**price** | [**string[]**](../Model/string.md)| Filter by product price, like price[lte] | [optional]
**categories** | [**string[]**](../Model/string.md)| Filter by category ids | [optional]

### Return type

Expand Down
Loading