diff --git a/README.md b/README.md index 8afe397..519bd27 100644 --- a/README.md +++ b/README.md @@ -92,14 +92,12 @@ Class | Method | HTTP request | Description *AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute *AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes *AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute -*CRMApi* | [**crm_files_id_data_get**](docs/CRMApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file details -*CRMApi* | [**crm_files_id_delete**](docs/CRMApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete a file -*CRMApi* | [**crm_files_id_get**](docs/CRMApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download a file -*CRMApi* | [**crm_files_post**](docs/CRMApi.md#crm_files_post) | **POST** /crm/files | Upload a file +*CRMApi* | [**crm_notes_get**](docs/CRMApi.md#crm_notes_get) | **GET** /crm/notes | Get all notes *CRMApi* | [**crm_notes_id_delete**](docs/CRMApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete a note *CRMApi* | [**crm_notes_id_get**](docs/CRMApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get a note *CRMApi* | [**crm_notes_id_patch**](docs/CRMApi.md#crm_notes_id_patch) | **PATCH** /crm/notes/{id} | Update a note *CRMApi* | [**crm_notes_post**](docs/CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a note +*CRMApi* | [**crm_tasks_get**](docs/CRMApi.md#crm_tasks_get) | **GET** /crm/tasks | Get all tasks *CRMApi* | [**crm_tasks_id_delete**](docs/CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task *CRMApi* | [**crm_tasks_id_get**](docs/CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task *CRMApi* | [**crm_tasks_id_patch**](docs/CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task @@ -212,10 +210,13 @@ Class | Method | HTTP request | Description *TransactionalEmailsApi* | [**create_smtp_template**](docs/TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template *TransactionalEmailsApi* | [**delete_blocked_domain**](docs/TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains *TransactionalEmailsApi* | [**delete_hardbounces**](docs/TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces +*TransactionalEmailsApi* | [**delete_scheduled_email_by_id**](docs/TransactionalEmailsApi.md#delete_scheduled_email_by_id) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId *TransactionalEmailsApi* | [**delete_smtp_template**](docs/TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template *TransactionalEmailsApi* | [**get_aggregated_smtp_report**](docs/TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time *TransactionalEmailsApi* | [**get_blocked_domains**](docs/TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains *TransactionalEmailsApi* | [**get_email_event_report**](docs/TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) +*TransactionalEmailsApi* | [**get_scheduled_email_by_batch_id**](docs/TransactionalEmailsApi.md#get_scheduled_email_by_batch_id) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId +*TransactionalEmailsApi* | [**get_scheduled_email_by_message_id**](docs/TransactionalEmailsApi.md#get_scheduled_email_by_message_id) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId *TransactionalEmailsApi* | [**get_smtp_report**](docs/TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day *TransactionalEmailsApi* | [**get_smtp_template**](docs/TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information *TransactionalEmailsApi* | [**get_smtp_templates**](docs/TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates @@ -248,7 +249,6 @@ Class | Method | HTTP request | Description - [BlockDomain](docs/BlockDomain.md) - [Body](docs/Body.md) - [Body1](docs/Body1.md) - - [Contact](docs/Contact.md) - [CreateAttribute](docs/CreateAttribute.md) - [CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md) - [CreateChild](docs/CreateChild.md) @@ -269,6 +269,7 @@ Class | Method | HTTP request | Description - [CreateSmtpTemplate](docs/CreateSmtpTemplate.md) - [CreateSmtpTemplateSender](docs/CreateSmtpTemplateSender.md) - [CreateSubAccount](docs/CreateSubAccount.md) + - [CreateSubAccountResponse](docs/CreateSubAccountResponse.md) - [CreateUpdateContactModel](docs/CreateUpdateContactModel.md) - [CreateUpdateFolder](docs/CreateUpdateFolder.md) - [CreateWebhook](docs/CreateWebhook.md) @@ -276,7 +277,6 @@ Class | Method | HTTP request | Description - [DeleteHardbounces](docs/DeleteHardbounces.md) - [EmailExportRecipients](docs/EmailExportRecipients.md) - [ErrorModel](docs/ErrorModel.md) - - [FileData](docs/FileData.md) - [GetAccountMarketingAutomation](docs/GetAccountMarketingAutomation.md) - [GetAccountPlan](docs/GetAccountPlan.md) - [GetAccountRelay](docs/GetAccountRelay.md) @@ -341,6 +341,9 @@ Class | Method | HTTP request | Description - [GetProcesses](docs/GetProcesses.md) - [GetReports](docs/GetReports.md) - [GetReportsReports](docs/GetReportsReports.md) + - [GetScheduledEmailByBatchId](docs/GetScheduledEmailByBatchId.md) + - [GetScheduledEmailByBatchIdBatches](docs/GetScheduledEmailByBatchIdBatches.md) + - [GetScheduledEmailByMessageId](docs/GetScheduledEmailByMessageId.md) - [GetSendersList](docs/GetSendersList.md) - [GetSendersListIps](docs/GetSendersListIps.md) - [GetSendersListSenders](docs/GetSendersListSenders.md) @@ -369,6 +372,7 @@ Class | Method | HTTP request | Description - [GetTransacSmsReportReports](docs/GetTransacSmsReportReports.md) - [GetWebhook](docs/GetWebhook.md) - [GetWebhooks](docs/GetWebhooks.md) + - [InlineResponse201](docs/InlineResponse201.md) - [ManageIp](docs/ManageIp.md) - [MasterDetailsResponse](docs/MasterDetailsResponse.md) - [MasterDetailsResponseBillingInfo](docs/MasterDetailsResponseBillingInfo.md) @@ -378,6 +382,8 @@ Class | Method | HTTP request | Description - [MasterDetailsResponsePlanInfoFeatures](docs/MasterDetailsResponsePlanInfoFeatures.md) - [Note](docs/Note.md) - [NoteData](docs/NoteData.md) + - [NoteId](docs/NoteId.md) + - [NoteList](docs/NoteList.md) - [PostContactInfo](docs/PostContactInfo.md) - [PostContactInfoContacts](docs/PostContactInfoContacts.md) - [PostSendFailed](docs/PostSendFailed.md) @@ -392,6 +398,7 @@ Class | Method | HTTP request | Description - [RequestContactImport](docs/RequestContactImport.md) - [RequestContactImportNewList](docs/RequestContactImportNewList.md) - [RequestSmsRecipientExport](docs/RequestSmsRecipientExport.md) + - [ScheduleSmtpEmail](docs/ScheduleSmtpEmail.md) - [SendReport](docs/SendReport.md) - [SendReportEmail](docs/SendReportEmail.md) - [SendSms](docs/SendSms.md) @@ -423,6 +430,7 @@ Class | Method | HTTP request | Description - [SubAccountsResponse](docs/SubAccountsResponse.md) - [SubAccountsResponseSubAccounts](docs/SubAccountsResponseSubAccounts.md) - [Task](docs/Task.md) + - [TaskList](docs/TaskList.md) - [TaskReminder](docs/TaskReminder.md) - [TaskTypes](docs/TaskTypes.md) - [UpdateAttribute](docs/UpdateAttribute.md) diff --git a/docs/Body.md b/docs/Body.md index ef51d70..1259552 100644 --- a/docs/Body.md +++ b/docs/Body.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Name of task | -**duration** | **int** | Duration of task | [optional] +**duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] **task_type_id** | **str** | Id for type of task e.g Call / Email / Meeting etc. | -**_date** | **datetime** | Task date/time | +**_date** | **datetime** | Task due date and time | **notes** | **str** | Notes added to a task | [optional] **done** | **bool** | Task marked as done | [optional] **assign_to_id** | **str** | User id to whom task is assigned | [optional] diff --git a/docs/Body1.md b/docs/Body1.md index 8e97e5d..e4488ba 100644 --- a/docs/Body1.md +++ b/docs/Body1.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Name of task | -**duration** | **int** | Duration of task | [optional] +**duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] **task_type_id** | **str** | Id for type of task e.g Call / Email / Meeting etc. | **_date** | **datetime** | Task date/time | **notes** | **str** | Notes added to a task | [optional] diff --git a/docs/CRMApi.md b/docs/CRMApi.md index 13d1994..0fc7d81 100644 --- a/docs/CRMApi.md +++ b/docs/CRMApi.md @@ -4,14 +4,12 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**crm_files_id_data_get**](CRMApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file details -[**crm_files_id_delete**](CRMApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete a file -[**crm_files_id_get**](CRMApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download a file -[**crm_files_post**](CRMApi.md#crm_files_post) | **POST** /crm/files | Upload a file +[**crm_notes_get**](CRMApi.md#crm_notes_get) | **GET** /crm/notes | Get all notes [**crm_notes_id_delete**](CRMApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete a note [**crm_notes_id_get**](CRMApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get a note [**crm_notes_id_patch**](CRMApi.md#crm_notes_id_patch) | **PATCH** /crm/notes/{id} | Update a note [**crm_notes_post**](CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a note +[**crm_tasks_get**](CRMApi.md#crm_tasks_get) | **GET** /crm/tasks | Get all tasks [**crm_tasks_id_delete**](CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task [**crm_tasks_id_get**](CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task [**crm_tasks_id_patch**](CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task @@ -19,10 +17,10 @@ Method | HTTP request | Description [**crm_tasktypes_get**](CRMApi.md#crm_tasktypes_get) | **GET** /crm/tasktypes | Get all task types -# **crm_files_id_data_get** -> FileData crm_files_id_data_get(id) +# **crm_notes_get** +> NoteList crm_notes_get(entity=entity, entity_ids=entity_ids, date_from=date_from, date_to=date_to, offset=offset, limit=limit, sort=sort) -Get file details +Get all notes ### Example ```python @@ -45,25 +43,37 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.CRMApi(sib_api_v3_sdk.ApiClient(configuration)) -id = 'id_example' # str | File id to get file data. +entity = 'entity_example' # str | Filter by note entity type (optional) +entity_ids = 'entity_ids_example' # str | Filter by note entity IDs (optional) +date_from = 56 # int | dateFrom to date range filter type (timestamp in milliseconds) (optional) +date_to = 56 # int | dateTo to date range filter type (timestamp in milliseconds) (optional) +offset = 789 # int | Index of the first document of the page (optional) +limit = 50 # int | Number of documents per page (optional) (default to 50) +sort = 'sort_example' # str | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) try: - # Get file details - api_response = api_instance.crm_files_id_data_get(id) + # Get all notes + api_response = api_instance.crm_notes_get(entity=entity, entity_ids=entity_ids, date_from=date_from, date_to=date_to, offset=offset, limit=limit, sort=sort) pprint(api_response) except ApiException as e: - print("Exception when calling CRMApi->crm_files_id_data_get: %s\n" % e) + print("Exception when calling CRMApi->crm_notes_get: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| File id to get file data. | + **entity** | **str**| Filter by note entity type | [optional] + **entity_ids** | **str**| Filter by note entity IDs | [optional] + **date_from** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional] + **date_to** | **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** | **str**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] ### Return type -[**FileData**](FileData.md) +[**NoteList**](NoteList.md) ### Authorization @@ -76,66 +86,10 @@ 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) -# **crm_files_id_delete** -> crm_files_id_delete(id) - -Delete a file - -### Example -```python -from __future__ import print_function -import time -import sib_api_v3_sdk -from sib_api_v3_sdk.rest import ApiException -from pprint import pprint - -# Configure API key authorization: api-key -configuration = sib_api_v3_sdk.Configuration() -configuration.api_key['api-key'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api-key'] = 'Bearer' -# Configure API key authorization: partner-key -configuration = sib_api_v3_sdk.Configuration() -configuration.api_key['partner-key'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['partner-key'] = 'Bearer' - -# create an instance of the API class -api_instance = sib_api_v3_sdk.CRMApi(sib_api_v3_sdk.ApiClient(configuration)) -id = 'id_example' # str | File id to delete. - -try: - # Delete a file - api_instance.crm_files_id_delete(id) -except ApiException as e: - print("Exception when calling CRMApi->crm_files_id_delete: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| 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) - -# **crm_files_id_get** -> crm_files_id_get(id) +# **crm_notes_id_delete** +> crm_notes_id_delete(id) -Download a file +Delete a note ### Example ```python @@ -158,20 +112,20 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.CRMApi(sib_api_v3_sdk.ApiClient(configuration)) -id = 'id_example' # str | File id to download. +id = 'id_example' # str | Note ID to delete try: - # Download a file - api_instance.crm_files_id_get(id) + # Delete a note + api_instance.crm_notes_id_delete(id) except ApiException as e: - print("Exception when calling CRMApi->crm_files_id_get: %s\n" % e) + print("Exception when calling CRMApi->crm_notes_id_delete: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| File id to download. | + **id** | **str**| Note ID to delete | ### Return type @@ -188,10 +142,10 @@ 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) -# **crm_files_post** -> FileData crm_files_post(file, deals_ids=deals_ids) +# **crm_notes_id_get** +> Note crm_notes_id_get(id) -Upload a file +Get a note ### Example ```python @@ -214,83 +168,25 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.CRMApi(sib_api_v3_sdk.ApiClient(configuration)) -file = '/path/to/file.txt' # file | File data to create a file. -deals_ids = ['deals_ids_example'] # list[str] | Deal ids linked to a file (optional) +id = 'id_example' # str | Note ID to get try: - # Upload a file - api_response = api_instance.crm_files_post(file, deals_ids=deals_ids) + # Get a note + api_response = api_instance.crm_notes_id_get(id) pprint(api_response) except ApiException as e: - print("Exception when calling CRMApi->crm_files_post: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file** | **file**| File data to create a file. | - **deals_ids** | [**list[str]**](str.md)| Deal ids linked to a file | [optional] - -### Return type - -[**FileData**](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) - -# **crm_notes_id_delete** -> crm_notes_id_delete(id) - -Delete a note - -### Example -```python -from __future__ import print_function -import time -import sib_api_v3_sdk -from sib_api_v3_sdk.rest import ApiException -from pprint import pprint - -# Configure API key authorization: api-key -configuration = sib_api_v3_sdk.Configuration() -configuration.api_key['api-key'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api-key'] = 'Bearer' -# Configure API key authorization: partner-key -configuration = sib_api_v3_sdk.Configuration() -configuration.api_key['partner-key'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['partner-key'] = 'Bearer' - -# create an instance of the API class -api_instance = sib_api_v3_sdk.CRMApi(sib_api_v3_sdk.ApiClient(configuration)) -id = 'id_example' # str | Note ID to delete - -try: - # Delete a note - api_instance.crm_notes_id_delete(id) -except ApiException as e: - print("Exception when calling CRMApi->crm_notes_id_delete: %s\n" % e) + print("Exception when calling CRMApi->crm_notes_id_get: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Note ID to delete | + **id** | **str**| Note ID to get | ### Return type -void (empty response body) +[**Note**](Note.md) ### Authorization @@ -303,10 +199,10 @@ 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) -# **crm_notes_id_get** -> Note crm_notes_id_get(id) +# **crm_notes_id_patch** +> crm_notes_id_patch(id, body) -Get a note +Update a note ### Example ```python @@ -329,25 +225,26 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.CRMApi(sib_api_v3_sdk.ApiClient(configuration)) -id = 'id_example' # str | Note ID to get +id = 'id_example' # str | Note ID to update +body = sib_api_v3_sdk.NoteData() # NoteData | Note data to update a note try: - # Get a note - api_response = api_instance.crm_notes_id_get(id) - pprint(api_response) + # Update a note + api_instance.crm_notes_id_patch(id, body) except ApiException as e: - print("Exception when calling CRMApi->crm_notes_id_get: %s\n" % e) + print("Exception when calling CRMApi->crm_notes_id_patch: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Note ID to get | + **id** | **str**| Note ID to update | + **body** | [**NoteData**](NoteData.md)| Note data to update a note | ### Return type -[**Note**](Note.md) +void (empty response body) ### Authorization @@ -360,10 +257,10 @@ 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) -# **crm_notes_id_patch** -> Note crm_notes_id_patch(id, body) +# **crm_notes_post** +> NoteId crm_notes_post(body) -Update a note +Create a note ### Example ```python @@ -386,27 +283,25 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.CRMApi(sib_api_v3_sdk.ApiClient(configuration)) -id = 'id_example' # str | Note ID to update -body = sib_api_v3_sdk.NoteData() # NoteData | Note data to update a note +body = sib_api_v3_sdk.NoteData() # NoteData | Note data to create a note. try: - # Update a note - api_response = api_instance.crm_notes_id_patch(id, body) + # Create a note + api_response = api_instance.crm_notes_post(body) pprint(api_response) except ApiException as e: - print("Exception when calling CRMApi->crm_notes_id_patch: %s\n" % e) + print("Exception when calling CRMApi->crm_notes_post: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Note ID to update | - **body** | [**NoteData**](NoteData.md)| Note data to update a note | + **body** | [**NoteData**](NoteData.md)| Note data to create a note. | ### Return type -[**Note**](Note.md) +[**NoteId**](NoteId.md) ### Authorization @@ -419,10 +314,10 @@ 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) -# **crm_notes_post** -> Note crm_notes_post(body) +# **crm_tasks_get** +> TaskList crm_tasks_get(filter_type=filter_type, filter_status=filter_status, filter_date=filter_date, filter_assign_to=filter_assign_to, filter_contacts=filter_contacts, filter_deals=filter_deals, filter_companies=filter_companies, date_from=date_from, date_to=date_to, offset=offset, limit=limit, sort=sort, sort_by=sort_by) -Create a note +Get all tasks ### Example ```python @@ -445,25 +340,49 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.CRMApi(sib_api_v3_sdk.ApiClient(configuration)) -body = sib_api_v3_sdk.NoteData() # NoteData | Note data to create a note. +filter_type = 'filter_type_example' # str | Filter by task type (ID) (optional) +filter_status = 'filter_status_example' # str | Filter by task status (optional) +filter_date = 'filter_date_example' # str | Filter by date (optional) +filter_assign_to = 'filter_assign_to_example' # str | Filter by assignTo id (optional) +filter_contacts = 'filter_contacts_example' # str | Filter by contact ids (optional) +filter_deals = 'filter_deals_example' # str | Filter by deals ids (optional) +filter_companies = 'filter_companies_example' # str | Filter by companies ids (optional) +date_from = 56 # int | dateFrom to date range filter type (timestamp in milliseconds) (optional) +date_to = 56 # int | dateTo to date range filter type (timestamp in milliseconds) (optional) +offset = 789 # int | Index of the first document of the page (optional) +limit = 50 # int | Number of documents per page (optional) (default to 50) +sort = 'sort_example' # str | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) +sort_by = 'sort_by_example' # str | The field used to sort field names. (optional) try: - # Create a note - api_response = api_instance.crm_notes_post(body) + # Get all tasks + api_response = api_instance.crm_tasks_get(filter_type=filter_type, filter_status=filter_status, filter_date=filter_date, filter_assign_to=filter_assign_to, filter_contacts=filter_contacts, filter_deals=filter_deals, filter_companies=filter_companies, date_from=date_from, date_to=date_to, offset=offset, limit=limit, sort=sort, sort_by=sort_by) pprint(api_response) except ApiException as e: - print("Exception when calling CRMApi->crm_notes_post: %s\n" % e) + print("Exception when calling CRMApi->crm_tasks_get: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NoteData**](NoteData.md)| Note data to create a note. | + **filter_type** | **str**| Filter by task type (ID) | [optional] + **filter_status** | **str**| Filter by task status | [optional] + **filter_date** | **str**| Filter by date | [optional] + **filter_assign_to** | **str**| Filter by assignTo id | [optional] + **filter_contacts** | **str**| Filter by contact ids | [optional] + **filter_deals** | **str**| Filter by deals ids | [optional] + **filter_companies** | **str**| Filter by companies ids | [optional] + **date_from** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional] + **date_to** | **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** | **str**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] + **sort_by** | **str**| The field used to sort field names. | [optional] ### Return type -[**Note**](Note.md) +[**TaskList**](TaskList.md) ### Authorization @@ -590,7 +509,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) # **crm_tasks_id_patch** -> Task crm_tasks_id_patch(id, body) +> crm_tasks_id_patch(id, body) Update a task @@ -620,8 +539,7 @@ body = sib_api_v3_sdk.Body1() # Body1 | Updated task details. try: # Update a task - api_response = api_instance.crm_tasks_id_patch(id, body) - pprint(api_response) + api_instance.crm_tasks_id_patch(id, body) except ApiException as e: print("Exception when calling CRMApi->crm_tasks_id_patch: %s\n" % e) ``` @@ -635,7 +553,7 @@ Name | Type | Description | Notes ### Return type -[**Task**](Task.md) +void (empty response body) ### Authorization @@ -649,7 +567,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) # **crm_tasks_post** -> Task crm_tasks_post(body) +> InlineResponse201 crm_tasks_post(body) Create a task @@ -692,7 +610,7 @@ Name | Type | Description | Notes ### Return type -[**Task**](Task.md) +[**InlineResponse201**](InlineResponse201.md) ### Authorization diff --git a/docs/ContactsApi.md b/docs/ContactsApi.md index 6cd0561..b15d55f 100644 --- a/docs/ContactsApi.md +++ b/docs/ContactsApi.md @@ -660,7 +660,7 @@ This endpoint does not need any parameter. [[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) # **get_contact_info** -> GetExtendedContactDetails get_contact_info(identifier) +> GetExtendedContactDetails get_contact_info(identifier, start_date=start_date, end_date=end_date) Get a contact's details @@ -688,10 +688,12 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) identifier = 'identifier_example' # str | Email (urlencoded) OR ID of the contact OR its SMS attribute value +start_date = NULL # 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 (optional) +end_date = NULL # 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. (optional) try: # Get a contact's details - api_response = api_instance.get_contact_info(identifier) + api_response = api_instance.get_contact_info(identifier, start_date=start_date, end_date=end_date) pprint(api_response) except ApiException as e: print("Exception when calling ContactsApi->get_contact_info: %s\n" % e) @@ -702,6 +704,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **str**| Email (urlencoded) OR ID of the contact OR its SMS attribute value | + **start_date** | [**object**](.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] + **end_date** | [**object**](.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] ### Return type diff --git a/docs/CreateContact.md b/docs/CreateContact.md index 19190e2..3114d41 100644 --- a/docs/CreateContact.md +++ b/docs/CreateContact.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **str** | 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] -**attributes** | **object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [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. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional] **email_blacklisted** | **bool** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] **sms_blacklisted** | **bool** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] **list_ids** | **list[int]** | Ids of the lists to add the contact to | [optional] diff --git a/docs/CreateSubAccount.md b/docs/CreateSubAccount.md index 3664d47..cdf9e94 100644 --- a/docs/CreateSubAccount.md +++ b/docs/CreateSubAccount.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**company_name** | **str** | Name of the organization | +**company_name** | **str** | Set the name of the sub-account company | **email** | **str** | Email address for the organization | -**language** | **str** | Language for identifying localization information | [optional] -**timezone** | **str** | Request timezone of the client | [optional] +**language** | **str** | Set the language of the sub-account | [optional] +**timezone** | **str** | Set the timezone of the sub-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) diff --git a/docs/CreateSubAccountResponse.md b/docs/CreateSubAccountResponse.md new file mode 100644 index 0000000..c723c78 --- /dev/null +++ b/docs/CreateSubAccountResponse.md @@ -0,0 +1,10 @@ +# CreateSubAccountResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | ID of the sub-account created | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EmailCampaignsApi.md b/docs/EmailCampaignsApi.md index 53a5058..741e47e 100644 --- a/docs/EmailCampaignsApi.md +++ b/docs/EmailCampaignsApi.md @@ -337,7 +337,7 @@ type = 'type_example' # str | Filter on the type of the campaigns (optional) status = 'status_example' # str | Filter on the status of the campaign (optional) start_date = 'start_date_example' # str | 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) end_date = 'end_date_example' # str | 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 = 500 # int | Number of documents per page (optional) (default to 500) +limit = 50 # int | Number of documents per page (optional) (default to 50) offset = 0 # int | Index of the first document in the page (optional) (default to 0) sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) @@ -357,7 +357,7 @@ Name | Type | Description | Notes **status** | **str**| Filter on the status of the campaign | [optional] **start_date** | **str**| 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] **end_date** | **str**| 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 500] + **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** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] diff --git a/docs/GetCampaignStats.md b/docs/GetCampaignStats.md index 69132bb..0d8aaf8 100644 --- a/docs/GetCampaignStats.md +++ b/docs/GetCampaignStats.md @@ -13,6 +13,8 @@ Name | Type | Description | Notes **hard_bounces** | **int** | Number of harbounce for the campaign | **unique_views** | **int** | Number of unique openings for the campaign | **trackable_views** | **int** | Recipients without any privacy protection option enabled in their email client | +**trackable_views_rate** | **float** | Rate of recipients without any privacy protection option enabled in their email client | [optional] +**estimated_views** | **int** | Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails | [optional] **unsubscriptions** | **int** | Number of unsubscription for the campaign | **viewed** | **int** | Number of openings for the campaign | **deferred** | **int** | Number of deferred emails for the campaign | [optional] diff --git a/docs/GetScheduledEmailByBatchId.md b/docs/GetScheduledEmailByBatchId.md new file mode 100644 index 0000000..cb29c39 --- /dev/null +++ b/docs/GetScheduledEmailByBatchId.md @@ -0,0 +1,11 @@ +# GetScheduledEmailByBatchId + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Total number of batches | [optional] +**batches** | [**list[GetScheduledEmailByBatchIdBatches]**](GetScheduledEmailByBatchIdBatches.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) + + diff --git a/docs/GetScheduledEmailByBatchIdBatches.md b/docs/GetScheduledEmailByBatchIdBatches.md new file mode 100644 index 0000000..c14c710 --- /dev/null +++ b/docs/GetScheduledEmailByBatchIdBatches.md @@ -0,0 +1,12 @@ +# GetScheduledEmailByBatchIdBatches + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scheduled_at** | **datetime** | Datetime for which the batch was scheduled | +**created_at** | **datetime** | Datetime on which the batch was scheduled | +**status** | **str** | Current status of the scheduled batch | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetScheduledEmailByMessageId.md b/docs/GetScheduledEmailByMessageId.md new file mode 100644 index 0000000..b6088cf --- /dev/null +++ b/docs/GetScheduledEmailByMessageId.md @@ -0,0 +1,12 @@ +# GetScheduledEmailByMessageId + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scheduled_at** | **datetime** | Datetime for which the email was scheduled | +**created_at** | **datetime** | Datetime on which the email was scheduled | +**status** | **str** | Current status of the scheduled email | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetSsoToken.md b/docs/GetSsoToken.md index 529df18..59ec3bc 100644 --- a/docs/GetSsoToken.md +++ b/docs/GetSsoToken.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**token** | **str** | Session token. It will remain valid for a short period of time only. | +**token** | **str** | Session token, it will remain valid for 15 days. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse201.md b/docs/InlineResponse201.md new file mode 100644 index 0000000..4a6a5d9 --- /dev/null +++ b/docs/InlineResponse201.md @@ -0,0 +1,10 @@ +# InlineResponse201 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique task id | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MasterAccountApi.md b/docs/MasterAccountApi.md index 32a7477..0cbe292 100644 --- a/docs/MasterAccountApi.md +++ b/docs/MasterAccountApi.md @@ -96,7 +96,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.MasterAccountApi(sib_api_v3_sdk.ApiClient(configuration)) -offset = 56 # int | Page number of sub-accounts listing +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: @@ -111,7 +111,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **offset** | **int**| Page number of sub-accounts listing | + **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 @@ -190,7 +190,7 @@ void (empty response body) Get sub-account details -This endpoint will provide the details of specified sub-account organization +This endpoint will provide the details for the specified sub-account company ### Example ```python @@ -305,7 +305,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) # **corporate_sub_account_post** -> CreateModel corporate_sub_account_post(sub_account_create) +> CreateSubAccountResponse corporate_sub_account_post(sub_account_create) Create a new sub-account under a master account. @@ -350,7 +350,7 @@ Name | Type | Description | Notes ### Return type -[**CreateModel**](CreateModel.md) +[**CreateSubAccountResponse**](CreateSubAccountResponse.md) ### Authorization @@ -368,7 +368,7 @@ Name | Type | Description | Notes Generate SSO token to access Sendinblue -This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced with actual token. +This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token. ### Example ```python diff --git a/docs/NoteId.md b/docs/NoteId.md new file mode 100644 index 0000000..c7f7fbf --- /dev/null +++ b/docs/NoteId.md @@ -0,0 +1,10 @@ +# NoteId + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique note Id | [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) + + diff --git a/docs/NoteList.md b/docs/NoteList.md new file mode 100644 index 0000000..0d98d3e --- /dev/null +++ b/docs/NoteList.md @@ -0,0 +1,9 @@ +# NoteList + +## 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) + + diff --git a/docs/RequestContactImport.md b/docs/RequestContactImport.md index dfd88ce..e78f52d 100644 --- a/docs/RequestContactImport.md +++ b/docs/RequestContactImport.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**file_url** | **str** | Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv | [optional] -**file_body** | **str** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional] +**file_url** | **str** | Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json | [optional] +**file_body** | **str** | Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional] +**json_body** | **list[dict(str, object)]** | **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. | [optional] **list_ids** | **list[int]** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional] **notify_url** | **str** | URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] **new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional] diff --git a/docs/ScheduleSmtpEmail.md b/docs/ScheduleSmtpEmail.md new file mode 100644 index 0000000..a061900 --- /dev/null +++ b/docs/ScheduleSmtpEmail.md @@ -0,0 +1,12 @@ +# ScheduleSmtpEmail + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message_id** | **str** | Message ID of the transactional email scheduled | [optional] +**message_ids** | **list[str]** | | [optional] +**batch_id** | **str** | Batch ID of the batch transactional email scheduled | [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) + + diff --git a/docs/SendSmtpEmail.md b/docs/SendSmtpEmail.md index 1ffb7b2..9c0668b 100644 --- a/docs/SendSmtpEmail.md +++ b/docs/SendSmtpEmail.md @@ -17,6 +17,8 @@ Name | Type | Description | Notes **params** | **object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional] **message_versions** | [**list[SendSmtpEmailMessageVersions]**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional] **tags** | **list[str]** | Tag your emails to find them more easily | [optional] +**scheduled_at** | **datetime** | UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. | [optional] +**batch_id** | **str** | Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. | [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) diff --git a/docs/SubAccountDetailsResponsePlanInfoCredits.md b/docs/SubAccountDetailsResponsePlanInfoCredits.md index 90690d5..94fc190 100644 --- a/docs/SubAccountDetailsResponsePlanInfoCredits.md +++ b/docs/SubAccountDetailsResponsePlanInfoCredits.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sms** | **int** | Sms quota of the sub-account | [optional] +**sms** | **int** | SMS credits remaining on the sub-account | [optional] **emails** | [**SubAccountDetailsResponsePlanInfoCreditsEmails**](SubAccountDetailsResponsePlanInfoCreditsEmails.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) diff --git a/docs/SubAccountsResponseSubAccounts.md b/docs/SubAccountsResponseSubAccounts.md index bc41b8b..89ab93e 100644 --- a/docs/SubAccountsResponseSubAccounts.md +++ b/docs/SubAccountsResponseSubAccounts.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | client id of sub-account organization | -**company_name** | **str** | Name of sub-account organization | -**active** | **bool** | Whether organization is active or not | -**created_at** | **int** | timestamp when the organization was created | +**id** | **int** | id of the sub-account | +**company_name** | **str** | Name of the sub-account company | +**active** | **bool** | Whether the sub-account is active or not | +**created_at** | **int** | Timestamp when the sub-account was created | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Task.md b/docs/Task.md index 016d41e..e9a9ace 100644 --- a/docs/Task.md +++ b/docs/Task.md @@ -3,23 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**first_contact** | [**Contact**](Contact.md) | | [optional] **id** | **str** | Unique task id | [optional] **task_type_id** | **str** | Id for type of task e.g Call / Email / Meeting etc. | **name** | **str** | Name of task | **contacts_ids** | **list[int]** | Contact ids for contacts linked to this task | [optional] -**contacts** | [**list[Contact]**](Contact.md) | Contact details for contacts linked to this task | [optional] **deals_ids** | **list[str]** | Deal ids for deals a task is linked to | [optional] **companies_ids** | **list[str]** | Companies ids for companies a task is linked to | [optional] -**assign_to_id** | **str** | User id to whom task is assigned | [optional] -**_date** | **datetime** | Task date/time | -**duration** | **int** | Duration of task | [optional] -**notes** | **str** | Notes added to a task | [optional] -**done** | **bool** | Task marked as done | [optional] -**reminder** | [**TaskReminder**](TaskReminder.md) | Task reminder date/time for a task | [optional] -**created_at** | **datetime** | Task created date/time | [optional] -**updated_at** | **datetime** | Task update date/time | [optional] -**refs** | **object** | | [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) diff --git a/docs/TaskList.md b/docs/TaskList.md new file mode 100644 index 0000000..a4de9d4 --- /dev/null +++ b/docs/TaskList.md @@ -0,0 +1,10 @@ +# TaskList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**list[Task]**](Task.md) | List of tasks | [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) + + diff --git a/docs/TaskReminder.md b/docs/TaskReminder.md index 34d42f9..6811b68 100644 --- a/docs/TaskReminder.md +++ b/docs/TaskReminder.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **int** | Value of time unit before reminder is to be sent | **unit** | **str** | Unit of time before reminder is to be sent | -**types** | **list[str]** | Type of task reminder | +**types** | **list[str]** | Type of task reminder e.g email, push | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TaskTypes.md b/docs/TaskTypes.md index 99675a9..3b240d0 100644 --- a/docs/TaskTypes.md +++ b/docs/TaskTypes.md @@ -4,7 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Id of task type | [optional] -**icon** | **str** | Icon of task type | [optional] **title** | **str** | Title of task type | [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) diff --git a/docs/TransactionalEmailsApi.md b/docs/TransactionalEmailsApi.md index 829eee1..7d4bde2 100644 --- a/docs/TransactionalEmailsApi.md +++ b/docs/TransactionalEmailsApi.md @@ -8,10 +8,13 @@ Method | HTTP request | Description [**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template [**delete_blocked_domain**](TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains [**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces +[**delete_scheduled_email_by_id**](TransactionalEmailsApi.md#delete_scheduled_email_by_id) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId [**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template [**get_aggregated_smtp_report**](TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time [**get_blocked_domains**](TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains [**get_email_event_report**](TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) +[**get_scheduled_email_by_batch_id**](TransactionalEmailsApi.md#get_scheduled_email_by_batch_id) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId +[**get_scheduled_email_by_message_id**](TransactionalEmailsApi.md#get_scheduled_email_by_message_id) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId [**get_smtp_report**](TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day [**get_smtp_template**](TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information [**get_smtp_templates**](TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates @@ -256,6 +259,64 @@ 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) +# **delete_scheduled_email_by_id** +> delete_scheduled_email_by_id(identifier) + +Delete scheduled emails by batchId or messageId + +Delete scheduled batch of emails by batchId or single scheduled email by messageId + +### Example +```python +from __future__ import print_function +import time +import sib_api_v3_sdk +from sib_api_v3_sdk.rest import ApiException +from pprint import pprint + +# Configure API key authorization: api-key +configuration = sib_api_v3_sdk.Configuration() +configuration.api_key['api-key'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['api-key'] = 'Bearer' +# Configure API key authorization: partner-key +configuration = sib_api_v3_sdk.Configuration() +configuration.api_key['partner-key'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['partner-key'] = 'Bearer' + +# create an instance of the API class +api_instance = sib_api_v3_sdk.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration)) +identifier = 'identifier_example' # str | The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. + +try: + # Delete scheduled emails by batchId or messageId + api_instance.delete_scheduled_email_by_id(identifier) +except ApiException as e: + print("Exception when calling TransactionalEmailsApi->delete_scheduled_email_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **str**| The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. | + +### 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) + # **delete_smtp_template** > delete_smtp_template(template_id) @@ -511,6 +572,140 @@ 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) +# **get_scheduled_email_by_batch_id** +> GetScheduledEmailByBatchId get_scheduled_email_by_batch_id(batch_id, start_date=start_date, end_date=end_date, sort=sort, status=status, limit=limit, offset=offset) + +Fetch scheduled emails by batchId + +Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old) + +### Example +```python +from __future__ import print_function +import time +import sib_api_v3_sdk +from sib_api_v3_sdk.rest import ApiException +from pprint import pprint + +# Configure API key authorization: api-key +configuration = sib_api_v3_sdk.Configuration() +configuration.api_key['api-key'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['api-key'] = 'Bearer' +# Configure API key authorization: partner-key +configuration = sib_api_v3_sdk.Configuration() +configuration.api_key['partner-key'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['partner-key'] = 'Bearer' + +# create an instance of the API class +api_instance = sib_api_v3_sdk.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration)) +batch_id = 'batch_id_example' # str | The batchId of scheduled emails batch (Should be a valid UUIDv4) +start_date = '2013-10-20' # date | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) +end_date = '2013-10-20' # date | 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 = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) +status = 'status_example' # str | Filter the records by `status` of the scheduled email batch or message. (optional) +limit = 100 # int | Number of documents returned per page (optional) (default to 100) +offset = 0 # int | Index of the first document on the page (optional) (default to 0) + +try: + # Fetch scheduled emails by batchId + api_response = api_instance.get_scheduled_email_by_batch_id(batch_id, start_date=start_date, end_date=end_date, sort=sort, status=status, limit=limit, offset=offset) + pprint(api_response) +except ApiException as e: + print("Exception when calling TransactionalEmailsApi->get_scheduled_email_by_batch_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **batch_id** | **str**| The batchId of scheduled emails batch (Should be a valid UUIDv4) | + **start_date** | **date**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional] + **end_date** | **date**| 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** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] + **status** | **str**| Filter the records by `status` of the scheduled email batch or message. | [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] + +### Return type + +[**GetScheduledEmailByBatchId**](GetScheduledEmailByBatchId.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) + +# **get_scheduled_email_by_message_id** +> GetScheduledEmailByMessageId get_scheduled_email_by_message_id(message_id, start_date=start_date, end_date=end_date) + +Fetch scheduled email by messageId + +Fetch scheduled email by messageId (Can retrieve data upto 30 days old) + +### Example +```python +from __future__ import print_function +import time +import sib_api_v3_sdk +from sib_api_v3_sdk.rest import ApiException +from pprint import pprint + +# Configure API key authorization: api-key +configuration = sib_api_v3_sdk.Configuration() +configuration.api_key['api-key'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['api-key'] = 'Bearer' +# Configure API key authorization: partner-key +configuration = sib_api_v3_sdk.Configuration() +configuration.api_key['partner-key'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['partner-key'] = 'Bearer' + +# create an instance of the API class +api_instance = sib_api_v3_sdk.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration)) +message_id = 'message_id_example' # str | The messageId of scheduled email +start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) +end_date = '2013-10-20' # date | 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) + +try: + # Fetch scheduled email by messageId + api_response = api_instance.get_scheduled_email_by_message_id(message_id, start_date=start_date, end_date=end_date) + pprint(api_response) +except ApiException as e: + print("Exception when calling TransactionalEmailsApi->get_scheduled_email_by_message_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **message_id** | **str**| The messageId of scheduled email | + **start_date** | **date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional] + **end_date** | **date**| 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] + +### Return type + +[**GetScheduledEmailByMessageId**](GetScheduledEmailByMessageId.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) + # **get_smtp_report** > GetReports get_smtp_report(limit=limit, offset=offset, start_date=start_date, end_date=end_date, days=days, tag=tag, sort=sort) diff --git a/docs/UpdateContact.md b/docs/UpdateContact.md index 8e2e03e..1ea2bc3 100644 --- a/docs/UpdateContact.md +++ b/docs/UpdateContact.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | **object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional] +**attributes** | **object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional] **email_blacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] **sms_blacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] **list_ids** | **list[int]** | Ids of the lists to add the contact to | [optional] diff --git a/docs/UpdateEmailCampaign.md b/docs/UpdateEmailCampaign.md index 9bf0fe4..9c1ba3d 100644 --- a/docs/UpdateEmailCampaign.md +++ b/docs/UpdateEmailCampaign.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **tag** | **str** | Tag of the campaign | [optional] **sender** | [**UpdateEmailCampaignSender**](UpdateEmailCampaignSender.md) | | [optional] **name** | **str** | Name of the campaign | [optional] -**html_content** | **str** | Body of the message (HTML version). REQUIRED if htmlUrl is empty | [optional] +**html_content** | **str** | Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty | [optional] **html_url** | **str** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] **scheduled_at** | **str** | UTC date-time on which the campaign has to run (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** | **str** | Subject of the campaign | [optional] diff --git a/docs/UpdateSmtpTemplate.md b/docs/UpdateSmtpTemplate.md index d9598d8..5cceb78 100644 --- a/docs/UpdateSmtpTemplate.md +++ b/docs/UpdateSmtpTemplate.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **tag** | **str** | Tag of the template | [optional] **sender** | [**UpdateSmtpTemplateSender**](UpdateSmtpTemplateSender.md) | | [optional] **template_name** | **str** | Name of the template | [optional] -**html_content** | **str** | Required if htmlUrl is empty. Body of the message (HTML must have more than 10 characters) | [optional] +**html_content** | **str** | Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) | [optional] **html_url** | **str** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] **subject** | **str** | Subject of the email | [optional] **reply_to** | **str** | Email on which campaign recipients will be able to reply to | [optional] diff --git a/setup.py b/setup.py index 41cf0ed..4da08f2 100644 --- a/setup.py +++ b/setup.py @@ -14,7 +14,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "sib-api-v3-sdk" -VERSION = "7.4.0" +VERSION = "7.5.0" # To install the library, run the following # # python setup.py install diff --git a/sib_api_v3_sdk/__init__.py b/sib_api_v3_sdk/__init__.py index c572b10..b11c530 100644 --- a/sib_api_v3_sdk/__init__.py +++ b/sib_api_v3_sdk/__init__.py @@ -49,7 +49,6 @@ from sib_api_v3_sdk.models.block_domain import BlockDomain from sib_api_v3_sdk.models.body import Body from sib_api_v3_sdk.models.body1 import Body1 -from sib_api_v3_sdk.models.contact import Contact from sib_api_v3_sdk.models.create_attribute import CreateAttribute from sib_api_v3_sdk.models.create_attribute_enumeration import CreateAttributeEnumeration from sib_api_v3_sdk.models.create_child import CreateChild @@ -70,6 +69,7 @@ from sib_api_v3_sdk.models.create_smtp_template import CreateSmtpTemplate from sib_api_v3_sdk.models.create_smtp_template_sender import CreateSmtpTemplateSender from sib_api_v3_sdk.models.create_sub_account import CreateSubAccount +from sib_api_v3_sdk.models.create_sub_account_response import CreateSubAccountResponse from sib_api_v3_sdk.models.create_update_contact_model import CreateUpdateContactModel from sib_api_v3_sdk.models.create_update_folder import CreateUpdateFolder from sib_api_v3_sdk.models.create_webhook import CreateWebhook @@ -77,7 +77,6 @@ from sib_api_v3_sdk.models.delete_hardbounces import DeleteHardbounces from sib_api_v3_sdk.models.email_export_recipients import EmailExportRecipients from sib_api_v3_sdk.models.error_model import ErrorModel -from sib_api_v3_sdk.models.file_data import FileData from sib_api_v3_sdk.models.get_account_marketing_automation import GetAccountMarketingAutomation from sib_api_v3_sdk.models.get_account_plan import GetAccountPlan from sib_api_v3_sdk.models.get_account_relay import GetAccountRelay @@ -142,6 +141,9 @@ from sib_api_v3_sdk.models.get_processes import GetProcesses from sib_api_v3_sdk.models.get_reports import GetReports from sib_api_v3_sdk.models.get_reports_reports import GetReportsReports +from sib_api_v3_sdk.models.get_scheduled_email_by_batch_id import GetScheduledEmailByBatchId +from sib_api_v3_sdk.models.get_scheduled_email_by_batch_id_batches import GetScheduledEmailByBatchIdBatches +from sib_api_v3_sdk.models.get_scheduled_email_by_message_id import GetScheduledEmailByMessageId from sib_api_v3_sdk.models.get_senders_list import GetSendersList from sib_api_v3_sdk.models.get_senders_list_ips import GetSendersListIps from sib_api_v3_sdk.models.get_senders_list_senders import GetSendersListSenders @@ -170,6 +172,7 @@ from sib_api_v3_sdk.models.get_transac_sms_report_reports import GetTransacSmsReportReports from sib_api_v3_sdk.models.get_webhook import GetWebhook from sib_api_v3_sdk.models.get_webhooks import GetWebhooks +from sib_api_v3_sdk.models.inline_response201 import InlineResponse201 from sib_api_v3_sdk.models.manage_ip import ManageIp from sib_api_v3_sdk.models.master_details_response import MasterDetailsResponse from sib_api_v3_sdk.models.master_details_response_billing_info import MasterDetailsResponseBillingInfo @@ -179,6 +182,8 @@ from sib_api_v3_sdk.models.master_details_response_plan_info_features import MasterDetailsResponsePlanInfoFeatures from sib_api_v3_sdk.models.note import Note from sib_api_v3_sdk.models.note_data import NoteData +from sib_api_v3_sdk.models.note_id import NoteId +from sib_api_v3_sdk.models.note_list import NoteList from sib_api_v3_sdk.models.post_contact_info import PostContactInfo from sib_api_v3_sdk.models.post_contact_info_contacts import PostContactInfoContacts from sib_api_v3_sdk.models.post_send_failed import PostSendFailed @@ -193,6 +198,7 @@ from sib_api_v3_sdk.models.request_contact_import import RequestContactImport from sib_api_v3_sdk.models.request_contact_import_new_list import RequestContactImportNewList from sib_api_v3_sdk.models.request_sms_recipient_export import RequestSmsRecipientExport +from sib_api_v3_sdk.models.schedule_smtp_email import ScheduleSmtpEmail from sib_api_v3_sdk.models.send_report import SendReport from sib_api_v3_sdk.models.send_report_email import SendReportEmail from sib_api_v3_sdk.models.send_sms import SendSms @@ -224,6 +230,7 @@ from sib_api_v3_sdk.models.sub_accounts_response import SubAccountsResponse from sib_api_v3_sdk.models.sub_accounts_response_sub_accounts import SubAccountsResponseSubAccounts from sib_api_v3_sdk.models.task import Task +from sib_api_v3_sdk.models.task_list import TaskList from sib_api_v3_sdk.models.task_reminder import TaskReminder from sib_api_v3_sdk.models.task_types import TaskTypes from sib_api_v3_sdk.models.update_attribute import UpdateAttribute diff --git a/sib_api_v3_sdk/api/contacts_api.py b/sib_api_v3_sdk/api/contacts_api.py index 9a2511b..23e9082 100644 --- a/sib_api_v3_sdk/api/contacts_api.py +++ b/sib_api_v3_sdk/api/contacts_api.py @@ -1135,6 +1135,8 @@ def get_contact_info(self, identifier, **kwargs): # noqa: E501 :param async_req bool :param str identifier: Email (urlencoded) OR ID of the contact OR its SMS attribute value (required) + :param object start_date: **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate + :param object end_date: **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. :return: GetExtendedContactDetails If the method is called asynchronously, returns the request thread. @@ -1157,12 +1159,14 @@ def get_contact_info_with_http_info(self, identifier, **kwargs): # noqa: E501 :param async_req bool :param str identifier: Email (urlencoded) OR ID of the contact OR its SMS attribute value (required) + :param object start_date: **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate + :param object end_date: **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. :return: GetExtendedContactDetails If the method is called asynchronously, returns the request thread. """ - all_params = ['identifier'] # noqa: E501 + all_params = ['identifier', 'start_date', 'end_date'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1189,6 +1193,10 @@ def get_contact_info_with_http_info(self, identifier, **kwargs): # noqa: E501 path_params['identifier'] = params['identifier'] # noqa: E501 query_params = [] + if 'start_date' in params: + query_params.append(('startDate', params['start_date'])) # noqa: E501 + if 'end_date' in params: + query_params.append(('endDate', params['end_date'])) # noqa: E501 header_params = {} diff --git a/sib_api_v3_sdk/api/crm_api.py b/sib_api_v3_sdk/api/crm_api.py index a0dc7ca..6597da1 100644 --- a/sib_api_v3_sdk/api/crm_api.py +++ b/sib_api_v3_sdk/api/crm_api.py @@ -33,43 +33,55 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def crm_files_id_data_get(self, id, **kwargs): # noqa: E501 - """Get file details # noqa: E501 + def crm_notes_get(self, **kwargs): # noqa: E501 + """Get all notes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_files_id_data_get(id, async_req=True) + >>> thread = api.crm_notes_get(async_req=True) >>> result = thread.get() :param async_req bool - :param str id: File id to get file data. (required) - :return: FileData + :param str entity: Filter by note entity type + :param str entity_ids: Filter by note entity IDs + :param int date_from: dateFrom to date range filter type (timestamp in milliseconds) + :param int date_to: dateTo to date range filter type (timestamp in milliseconds) + :param int offset: Index of the first document of the page + :param int limit: Number of documents per page + :param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed + :return: NoteList If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.crm_files_id_data_get_with_http_info(id, **kwargs) # noqa: E501 + return self.crm_notes_get_with_http_info(**kwargs) # noqa: E501 else: - (data) = self.crm_files_id_data_get_with_http_info(id, **kwargs) # noqa: E501 + (data) = self.crm_notes_get_with_http_info(**kwargs) # noqa: E501 return data - def crm_files_id_data_get_with_http_info(self, id, **kwargs): # noqa: E501 - """Get file details # noqa: E501 + def crm_notes_get_with_http_info(self, **kwargs): # noqa: E501 + """Get all notes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_files_id_data_get_with_http_info(id, async_req=True) + >>> thread = api.crm_notes_get_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool - :param str id: File id to get file data. (required) - :return: FileData + :param str entity: Filter by note entity type + :param str entity_ids: Filter by note entity IDs + :param int date_from: dateFrom to date range filter type (timestamp in milliseconds) + :param int date_to: dateTo to date range filter type (timestamp in milliseconds) + :param int offset: Index of the first document of the page + :param int limit: Number of documents per page + :param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed + :return: NoteList If the method is called asynchronously, returns the request thread. """ - all_params = ['id'] # noqa: E501 + all_params = ['entity', 'entity_ids', 'date_from', 'date_to', 'offset', 'limit', 'sort'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -80,22 +92,30 @@ def crm_files_id_data_get_with_http_info(self, id, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method crm_files_id_data_get" % key + " to method crm_notes_get" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params or - params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `crm_files_id_data_get`") # noqa: E501 collection_formats = {} path_params = {} - if 'id' in params: - path_params['id'] = params['id'] # noqa: E501 query_params = [] + if 'entity' in params: + query_params.append(('entity', params['entity'])) # noqa: E501 + if 'entity_ids' in params: + query_params.append(('entityIds', params['entity_ids'])) # noqa: E501 + if 'date_from' in params: + query_params.append(('dateFrom', params['date_from'])) # noqa: E501 + if 'date_to' in params: + query_params.append(('dateTo', params['date_to'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'sort' in params: + query_params.append(('sort', params['sort'])) # noqa: E501 header_params = {} @@ -115,14 +135,14 @@ def crm_files_id_data_get_with_http_info(self, id, **kwargs): # noqa: E501 auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/crm/files/{id}/data', 'GET', + '/crm/notes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FileData', # noqa: E501 + response_type='NoteList', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -130,37 +150,37 @@ def crm_files_id_data_get_with_http_info(self, id, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def crm_files_id_delete(self, id, **kwargs): # noqa: E501 - """Delete a file # noqa: E501 + def crm_notes_id_delete(self, id, **kwargs): # noqa: E501 + """Delete a note # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_files_id_delete(id, async_req=True) + >>> thread = api.crm_notes_id_delete(id, async_req=True) >>> result = thread.get() :param async_req bool - :param str id: File id to delete. (required) + :param str id: Note ID to delete (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.crm_files_id_delete_with_http_info(id, **kwargs) # noqa: E501 + return self.crm_notes_id_delete_with_http_info(id, **kwargs) # noqa: E501 else: - (data) = self.crm_files_id_delete_with_http_info(id, **kwargs) # noqa: E501 + (data) = self.crm_notes_id_delete_with_http_info(id, **kwargs) # noqa: E501 return data - def crm_files_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 - """Delete a file # noqa: E501 + def crm_notes_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 + """Delete a note # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_files_id_delete_with_http_info(id, async_req=True) + >>> thread = api.crm_notes_id_delete_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool - :param str id: File id to delete. (required) + :param str id: Note ID to delete (required) :return: None If the method is called asynchronously, returns the request thread. @@ -177,14 +197,14 @@ def crm_files_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method crm_files_id_delete" % key + " to method crm_notes_id_delete" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params or params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `crm_files_id_delete`") # noqa: E501 + raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_delete`") # noqa: E501 collection_formats = {} @@ -212,7 +232,7 @@ def crm_files_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/crm/files/{id}', 'DELETE', + '/crm/notes/{id}', 'DELETE', path_params, query_params, header_params, @@ -227,38 +247,38 @@ def crm_files_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def crm_files_id_get(self, id, **kwargs): # noqa: E501 - """Download a file # noqa: E501 + def crm_notes_id_get(self, id, **kwargs): # noqa: E501 + """Get a note # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_files_id_get(id, async_req=True) + >>> thread = api.crm_notes_id_get(id, async_req=True) >>> result = thread.get() :param async_req bool - :param str id: File id to download. (required) - :return: None + :param str id: Note ID to get (required) + :return: Note If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.crm_files_id_get_with_http_info(id, **kwargs) # noqa: E501 + return self.crm_notes_id_get_with_http_info(id, **kwargs) # noqa: E501 else: - (data) = self.crm_files_id_get_with_http_info(id, **kwargs) # noqa: E501 + (data) = self.crm_notes_id_get_with_http_info(id, **kwargs) # noqa: E501 return data - def crm_files_id_get_with_http_info(self, id, **kwargs): # noqa: E501 - """Download a file # noqa: E501 + def crm_notes_id_get_with_http_info(self, id, **kwargs): # noqa: E501 + """Get a note # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_files_id_get_with_http_info(id, async_req=True) + >>> thread = api.crm_notes_id_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool - :param str id: File id to download. (required) - :return: None + :param str id: Note ID to get (required) + :return: Note If the method is called asynchronously, returns the request thread. """ @@ -274,14 +294,14 @@ def crm_files_id_get_with_http_info(self, id, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method crm_files_id_get" % key + " to method crm_notes_id_get" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params or params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `crm_files_id_get`") # noqa: E501 + raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_get`") # noqa: E501 collection_formats = {} @@ -309,116 +329,14 @@ def crm_files_id_get_with_http_info(self, id, **kwargs): # noqa: E501 auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/crm/files/{id}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 - auth_settings=auth_settings, - async_req=params.get('async_req'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def crm_files_post(self, file, **kwargs): # noqa: E501 - """Upload a file # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_files_post(file, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param file file: File data to create a file. (required) - :param list[str] deals_ids: Deal ids linked to a file - :return: FileData - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.crm_files_post_with_http_info(file, **kwargs) # noqa: E501 - else: - (data) = self.crm_files_post_with_http_info(file, **kwargs) # noqa: E501 - return data - - def crm_files_post_with_http_info(self, file, **kwargs): # noqa: E501 - """Upload a file # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_files_post_with_http_info(file, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param file file: File data to create a file. (required) - :param list[str] deals_ids: Deal ids linked to a file - :return: FileData - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['file', 'deals_ids'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in six.iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method crm_files_post" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'file' is set - if ('file' not in params or - params['file'] is None): - raise ValueError("Missing the required parameter `file` when calling `crm_files_post`") # noqa: E501 - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] # noqa: E501 - if 'deals_ids' in params: - form_params.append(('dealsIds', params['deals_ids'])) # noqa: E501 - collection_formats['dealsIds'] = 'csv' # noqa: E501 - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 - ['multipart/form-data']) # noqa: E501 - - # Authentication setting - auth_settings = ['api-key', 'partner-key'] # noqa: E501 - - return self.api_client.call_api( - '/crm/files', 'POST', + '/crm/notes/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FileData', # noqa: E501 + response_type='Note', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -426,43 +344,45 @@ def crm_files_post_with_http_info(self, file, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def crm_notes_id_delete(self, id, **kwargs): # noqa: E501 - """Delete a note # noqa: E501 + def crm_notes_id_patch(self, id, body, **kwargs): # noqa: E501 + """Update a note # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_notes_id_delete(id, async_req=True) + >>> thread = api.crm_notes_id_patch(id, body, async_req=True) >>> result = thread.get() :param async_req bool - :param str id: Note ID to delete (required) + :param str id: Note ID to update (required) + :param NoteData body: Note data to update a note (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.crm_notes_id_delete_with_http_info(id, **kwargs) # noqa: E501 + return self.crm_notes_id_patch_with_http_info(id, body, **kwargs) # noqa: E501 else: - (data) = self.crm_notes_id_delete_with_http_info(id, **kwargs) # noqa: E501 + (data) = self.crm_notes_id_patch_with_http_info(id, body, **kwargs) # noqa: E501 return data - def crm_notes_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 - """Delete a note # noqa: E501 + def crm_notes_id_patch_with_http_info(self, id, body, **kwargs): # noqa: E501 + """Update a note # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_notes_id_delete_with_http_info(id, async_req=True) + >>> thread = api.crm_notes_id_patch_with_http_info(id, body, async_req=True) >>> result = thread.get() :param async_req bool - :param str id: Note ID to delete (required) + :param str id: Note ID to update (required) + :param NoteData body: Note data to update a note (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['id'] # noqa: E501 + all_params = ['id', 'body'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -473,14 +393,18 @@ def crm_notes_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method crm_notes_id_delete" % key + " to method crm_notes_id_patch" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params or params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_delete`") # noqa: E501 + raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_patch`") # noqa: E501 + # verify the required parameter 'body' is set + if ('body' not in params or + params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `crm_notes_id_patch`") # noqa: E501 collection_formats = {} @@ -496,6 +420,8 @@ def crm_notes_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 local_var_files = {} body_params = None + if 'body' in params: + body_params = params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -508,7 +434,7 @@ def crm_notes_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/crm/notes/{id}', 'DELETE', + '/crm/notes/{id}', 'PATCH', path_params, query_params, header_params, @@ -523,142 +449,43 @@ def crm_notes_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def crm_notes_id_get(self, id, **kwargs): # noqa: E501 - """Get a note # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_notes_id_get(id, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str id: Note ID to get (required) - :return: Note - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.crm_notes_id_get_with_http_info(id, **kwargs) # noqa: E501 - else: - (data) = self.crm_notes_id_get_with_http_info(id, **kwargs) # noqa: E501 - return data - - def crm_notes_id_get_with_http_info(self, id, **kwargs): # noqa: E501 - """Get a note # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_notes_id_get_with_http_info(id, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str id: Note ID to get (required) - :return: Note - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in six.iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method crm_notes_id_get" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params or - params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_get`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'id' in params: - path_params['id'] = params['id'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api-key', 'partner-key'] # noqa: E501 - - return self.api_client.call_api( - '/crm/notes/{id}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='Note', # noqa: E501 - auth_settings=auth_settings, - async_req=params.get('async_req'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def crm_notes_id_patch(self, id, body, **kwargs): # noqa: E501 - """Update a note # noqa: E501 + def crm_notes_post(self, body, **kwargs): # noqa: E501 + """Create a note # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_notes_id_patch(id, body, async_req=True) + >>> thread = api.crm_notes_post(body, async_req=True) >>> result = thread.get() :param async_req bool - :param str id: Note ID to update (required) - :param NoteData body: Note data to update a note (required) - :return: Note + :param NoteData body: Note data to create a note. (required) + :return: NoteId If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.crm_notes_id_patch_with_http_info(id, body, **kwargs) # noqa: E501 + return self.crm_notes_post_with_http_info(body, **kwargs) # noqa: E501 else: - (data) = self.crm_notes_id_patch_with_http_info(id, body, **kwargs) # noqa: E501 + (data) = self.crm_notes_post_with_http_info(body, **kwargs) # noqa: E501 return data - def crm_notes_id_patch_with_http_info(self, id, body, **kwargs): # noqa: E501 - """Update a note # noqa: E501 + def crm_notes_post_with_http_info(self, body, **kwargs): # noqa: E501 + """Create a note # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_notes_id_patch_with_http_info(id, body, async_req=True) + >>> thread = api.crm_notes_post_with_http_info(body, async_req=True) >>> result = thread.get() :param async_req bool - :param str id: Note ID to update (required) - :param NoteData body: Note data to update a note (required) - :return: Note + :param NoteData body: Note data to create a note. (required) + :return: NoteId If the method is called asynchronously, returns the request thread. """ - all_params = ['id', 'body'] # noqa: E501 + all_params = ['body'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -669,24 +496,18 @@ def crm_notes_id_patch_with_http_info(self, id, body, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method crm_notes_id_patch" % key + " to method crm_notes_post" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params or - params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_patch`") # noqa: E501 # verify the required parameter 'body' is set if ('body' not in params or params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `crm_notes_id_patch`") # noqa: E501 + raise ValueError("Missing the required parameter `body` when calling `crm_notes_post`") # noqa: E501 collection_formats = {} path_params = {} - if 'id' in params: - path_params['id'] = params['id'] # noqa: E501 query_params = [] @@ -710,14 +531,14 @@ def crm_notes_id_patch_with_http_info(self, id, body, **kwargs): # noqa: E501 auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/crm/notes/{id}', 'PATCH', + '/crm/notes', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='Note', # noqa: E501 + response_type='NoteId', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -725,43 +546,67 @@ def crm_notes_id_patch_with_http_info(self, id, body, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def crm_notes_post(self, body, **kwargs): # noqa: E501 - """Create a note # noqa: E501 + def crm_tasks_get(self, **kwargs): # noqa: E501 + """Get all tasks # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_notes_post(body, async_req=True) + >>> thread = api.crm_tasks_get(async_req=True) >>> result = thread.get() :param async_req bool - :param NoteData body: Note data to create a note. (required) - :return: Note + :param str filter_type: Filter by task type (ID) + :param str filter_status: Filter by task status + :param str filter_date: Filter by date + :param str filter_assign_to: Filter by assignTo id + :param str filter_contacts: Filter by contact ids + :param str filter_deals: Filter by deals ids + :param str filter_companies: Filter by companies ids + :param int date_from: dateFrom to date range filter type (timestamp in milliseconds) + :param int date_to: dateTo to date range filter type (timestamp in milliseconds) + :param int offset: Index of the first document of the page + :param int limit: Number of documents per page + :param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed + :param str sort_by: The field used to sort field names. + :return: TaskList If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.crm_notes_post_with_http_info(body, **kwargs) # noqa: E501 + return self.crm_tasks_get_with_http_info(**kwargs) # noqa: E501 else: - (data) = self.crm_notes_post_with_http_info(body, **kwargs) # noqa: E501 + (data) = self.crm_tasks_get_with_http_info(**kwargs) # noqa: E501 return data - def crm_notes_post_with_http_info(self, body, **kwargs): # noqa: E501 - """Create a note # noqa: E501 + def crm_tasks_get_with_http_info(self, **kwargs): # noqa: E501 + """Get all tasks # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.crm_notes_post_with_http_info(body, async_req=True) + >>> thread = api.crm_tasks_get_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool - :param NoteData body: Note data to create a note. (required) - :return: Note + :param str filter_type: Filter by task type (ID) + :param str filter_status: Filter by task status + :param str filter_date: Filter by date + :param str filter_assign_to: Filter by assignTo id + :param str filter_contacts: Filter by contact ids + :param str filter_deals: Filter by deals ids + :param str filter_companies: Filter by companies ids + :param int date_from: dateFrom to date range filter type (timestamp in milliseconds) + :param int date_to: dateTo to date range filter type (timestamp in milliseconds) + :param int offset: Index of the first document of the page + :param int limit: Number of documents per page + :param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed + :param str sort_by: The field used to sort field names. + :return: TaskList If the method is called asynchronously, returns the request thread. """ - all_params = ['body'] # noqa: E501 + all_params = ['filter_type', 'filter_status', 'filter_date', 'filter_assign_to', 'filter_contacts', 'filter_deals', 'filter_companies', 'date_from', 'date_to', 'offset', 'limit', 'sort', 'sort_by'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -772,20 +617,42 @@ def crm_notes_post_with_http_info(self, body, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method crm_notes_post" % key + " to method crm_tasks_get" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'body' is set - if ('body' not in params or - params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `crm_notes_post`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] + if 'filter_type' in params: + query_params.append(('filter[type]', params['filter_type'])) # noqa: E501 + if 'filter_status' in params: + query_params.append(('filter[status]', params['filter_status'])) # noqa: E501 + if 'filter_date' in params: + query_params.append(('filter[date]', params['filter_date'])) # noqa: E501 + if 'filter_assign_to' in params: + query_params.append(('filter[assignTo]', params['filter_assign_to'])) # noqa: E501 + if 'filter_contacts' in params: + query_params.append(('filter[contacts]', params['filter_contacts'])) # noqa: E501 + if 'filter_deals' in params: + query_params.append(('filter[deals]', params['filter_deals'])) # noqa: E501 + if 'filter_companies' in params: + query_params.append(('filter[companies]', params['filter_companies'])) # noqa: E501 + if 'date_from' in params: + query_params.append(('dateFrom', params['date_from'])) # noqa: E501 + if 'date_to' in params: + query_params.append(('dateTo', params['date_to'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'sort' in params: + query_params.append(('sort', params['sort'])) # noqa: E501 + if 'sort_by' in params: + query_params.append(('sortBy', params['sort_by'])) # noqa: E501 header_params = {} @@ -793,8 +660,6 @@ def crm_notes_post_with_http_info(self, body, **kwargs): # noqa: E501 local_var_files = {} body_params = None - if 'body' in params: - body_params = params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -807,14 +672,14 @@ def crm_notes_post_with_http_info(self, body, **kwargs): # noqa: E501 auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/crm/notes', 'POST', + '/crm/tasks', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='Note', # noqa: E501 + response_type='TaskList', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1027,7 +892,7 @@ def crm_tasks_id_patch(self, id, body, **kwargs): # noqa: E501 :param async_req bool :param str id: (required) :param Body1 body: Updated task details. (required) - :return: Task + :return: None If the method is called asynchronously, returns the request thread. """ @@ -1049,7 +914,7 @@ def crm_tasks_id_patch_with_http_info(self, id, body, **kwargs): # noqa: E501 :param async_req bool :param str id: (required) :param Body1 body: Updated task details. (required) - :return: Task + :return: None If the method is called asynchronously, returns the request thread. """ @@ -1113,7 +978,7 @@ def crm_tasks_id_patch_with_http_info(self, id, body, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='Task', # noqa: E501 + response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1131,7 +996,7 @@ def crm_tasks_post(self, body, **kwargs): # noqa: E501 :param async_req bool :param Body body: Task name. (required) - :return: Task + :return: InlineResponse201 If the method is called asynchronously, returns the request thread. """ @@ -1152,7 +1017,7 @@ def crm_tasks_post_with_http_info(self, body, **kwargs): # noqa: E501 :param async_req bool :param Body body: Task name. (required) - :return: Task + :return: InlineResponse201 If the method is called asynchronously, returns the request thread. """ @@ -1210,7 +1075,7 @@ def crm_tasks_post_with_http_info(self, body, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='Task', # noqa: E501 + response_type='InlineResponse201', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/sib_api_v3_sdk/api/email_campaigns_api.py b/sib_api_v3_sdk/api/email_campaigns_api.py index b777f41..edc0dbc 100644 --- a/sib_api_v3_sdk/api/email_campaigns_api.py +++ b/sib_api_v3_sdk/api/email_campaigns_api.py @@ -588,8 +588,8 @@ def get_email_campaigns_with_http_info(self, **kwargs): # noqa: E501 params[key] = val del params['kwargs'] - if 'limit' in params and params['limit'] > 1000: # noqa: E501 - raise ValueError("Invalid value for parameter `limit` when calling `get_email_campaigns`, must be a value less than or equal to `1000`") # noqa: E501 + if 'limit' in params and params['limit'] > 100: # noqa: E501 + raise ValueError("Invalid value for parameter `limit` when calling `get_email_campaigns`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} diff --git a/sib_api_v3_sdk/api/master_account_api.py b/sib_api_v3_sdk/api/master_account_api.py index 6abb47f..e07ee3e 100644 --- a/sib_api_v3_sdk/api/master_account_api.py +++ b/sib_api_v3_sdk/api/master_account_api.py @@ -134,7 +134,7 @@ def corporate_sub_account_get(self, offset, limit, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :param int offset: Page number of sub-accounts listing (required) + :param int offset: Index of the first sub-account in the page (required) :param int limit: Number of sub-accounts to be displayed on each page (required) :return: SubAccountsResponse If the method is called asynchronously, @@ -157,7 +157,7 @@ def corporate_sub_account_get_with_http_info(self, offset, limit, **kwargs): # >>> result = thread.get() :param async_req bool - :param int offset: Page number of sub-accounts listing (required) + :param int offset: Index of the first sub-account in the page (required) :param int limit: Number of sub-accounts to be displayed on each page (required) :return: SubAccountsResponse If the method is called asynchronously, @@ -331,7 +331,7 @@ def corporate_sub_account_id_delete_with_http_info(self, id, **kwargs): # noqa: def corporate_sub_account_id_get(self, id, **kwargs): # noqa: E501 """Get sub-account details # noqa: E501 - This endpoint will provide the details of specified sub-account organization # noqa: E501 + This endpoint will provide the details for the specified sub-account company # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.corporate_sub_account_id_get(id, async_req=True) @@ -353,7 +353,7 @@ def corporate_sub_account_id_get(self, id, **kwargs): # noqa: E501 def corporate_sub_account_id_get_with_http_info(self, id, **kwargs): # noqa: E501 """Get sub-account details # noqa: E501 - This endpoint will provide the details of specified sub-account organization # noqa: E501 + This endpoint will provide the details for the specified sub-account company # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.corporate_sub_account_id_get_with_http_info(id, async_req=True) @@ -545,7 +545,7 @@ def corporate_sub_account_post(self, sub_account_create, **kwargs): # noqa: E50 :param async_req bool :param CreateSubAccount sub_account_create: values to create new sub-account (required) - :return: CreateModel + :return: CreateSubAccountResponse If the method is called asynchronously, returns the request thread. """ @@ -567,7 +567,7 @@ def corporate_sub_account_post_with_http_info(self, sub_account_create, **kwargs :param async_req bool :param CreateSubAccount sub_account_create: values to create new sub-account (required) - :return: CreateModel + :return: CreateSubAccountResponse If the method is called asynchronously, returns the request thread. """ @@ -625,7 +625,7 @@ def corporate_sub_account_post_with_http_info(self, sub_account_create, **kwargs body=body_params, post_params=form_params, files=local_var_files, - response_type='CreateModel', # noqa: E501 + response_type='CreateSubAccountResponse', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -636,7 +636,7 @@ def corporate_sub_account_post_with_http_info(self, sub_account_create, **kwargs def corporate_sub_account_sso_token_post(self, sso_token_request, **kwargs): # noqa: E501 """Generate SSO token to access Sendinblue # noqa: E501 - This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced with actual token. # noqa: E501 + This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.corporate_sub_account_sso_token_post(sso_token_request, async_req=True) @@ -658,7 +658,7 @@ def corporate_sub_account_sso_token_post(self, sso_token_request, **kwargs): # def corporate_sub_account_sso_token_post_with_http_info(self, sso_token_request, **kwargs): # noqa: E501 """Generate SSO token to access Sendinblue # noqa: E501 - This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced with actual token. # noqa: E501 + This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.corporate_sub_account_sso_token_post_with_http_info(sso_token_request, async_req=True) diff --git a/sib_api_v3_sdk/api/transactional_emails_api.py b/sib_api_v3_sdk/api/transactional_emails_api.py index eca00bc..508adaa 100644 --- a/sib_api_v3_sdk/api/transactional_emails_api.py +++ b/sib_api_v3_sdk/api/transactional_emails_api.py @@ -423,6 +423,105 @@ def delete_hardbounces_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def delete_scheduled_email_by_id(self, identifier, **kwargs): # noqa: E501 + """Delete scheduled emails by batchId or messageId # noqa: E501 + + Delete scheduled batch of emails by batchId or single scheduled email by messageId # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_scheduled_email_by_id(identifier, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str identifier: The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.delete_scheduled_email_by_id_with_http_info(identifier, **kwargs) # noqa: E501 + else: + (data) = self.delete_scheduled_email_by_id_with_http_info(identifier, **kwargs) # noqa: E501 + return data + + def delete_scheduled_email_by_id_with_http_info(self, identifier, **kwargs): # noqa: E501 + """Delete scheduled emails by batchId or messageId # noqa: E501 + + Delete scheduled batch of emails by batchId or single scheduled email by messageId # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_scheduled_email_by_id_with_http_info(identifier, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str identifier: The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['identifier'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_scheduled_email_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'identifier' is set + if ('identifier' not in params or + params['identifier'] is None): + raise ValueError("Missing the required parameter `identifier` when calling `delete_scheduled_email_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'identifier' in params: + path_params['identifier'] = params['identifier'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['api-key', 'partner-key'] # noqa: E501 + + return self.api_client.call_api( + '/smtp/email/{identifier}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def delete_smtp_template(self, template_id, **kwargs): # noqa: E501 """Delete an inactive email template # noqa: E501 @@ -855,6 +954,238 @@ def get_email_event_report_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_scheduled_email_by_batch_id(self, batch_id, **kwargs): # noqa: E501 + """Fetch scheduled emails by batchId # noqa: E501 + + Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_scheduled_email_by_batch_id(batch_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str batch_id: The batchId of scheduled emails batch (Should be a valid UUIDv4) (required) + :param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. + :param date end_date: 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. + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed + :param str status: Filter the records by `status` of the scheduled email batch or message. + :param int limit: Number of documents returned per page + :param int offset: Index of the first document on the page + :return: GetScheduledEmailByBatchId + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_scheduled_email_by_batch_id_with_http_info(batch_id, **kwargs) # noqa: E501 + else: + (data) = self.get_scheduled_email_by_batch_id_with_http_info(batch_id, **kwargs) # noqa: E501 + return data + + def get_scheduled_email_by_batch_id_with_http_info(self, batch_id, **kwargs): # noqa: E501 + """Fetch scheduled emails by batchId # noqa: E501 + + Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_scheduled_email_by_batch_id_with_http_info(batch_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str batch_id: The batchId of scheduled emails batch (Should be a valid UUIDv4) (required) + :param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. + :param date end_date: 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. + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed + :param str status: Filter the records by `status` of the scheduled email batch or message. + :param int limit: Number of documents returned per page + :param int offset: Index of the first document on the page + :return: GetScheduledEmailByBatchId + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['batch_id', 'start_date', 'end_date', 'sort', 'status', 'limit', 'offset'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_scheduled_email_by_batch_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'batch_id' is set + if ('batch_id' not in params or + params['batch_id'] is None): + raise ValueError("Missing the required parameter `batch_id` when calling `get_scheduled_email_by_batch_id`") # noqa: E501 + + if 'limit' in params and params['limit'] > 500: # noqa: E501 + raise ValueError("Invalid value for parameter `limit` when calling `get_scheduled_email_by_batch_id`, must be a value less than or equal to `500`") # noqa: E501 + collection_formats = {} + + path_params = {} + if 'batch_id' in params: + path_params['batchId'] = params['batch_id'] # noqa: E501 + + query_params = [] + if 'start_date' in params: + query_params.append(('startDate', params['start_date'])) # noqa: E501 + if 'end_date' in params: + query_params.append(('endDate', params['end_date'])) # noqa: E501 + if 'sort' in params: + query_params.append(('sort', params['sort'])) # noqa: E501 + if 'status' in params: + query_params.append(('status', params['status'])) # noqa: E501 + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['api-key', 'partner-key'] # noqa: E501 + + return self.api_client.call_api( + '/smtp/emailStatus/{batchId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='GetScheduledEmailByBatchId', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_scheduled_email_by_message_id(self, message_id, **kwargs): # noqa: E501 + """Fetch scheduled email by messageId # noqa: E501 + + Fetch scheduled email by messageId (Can retrieve data upto 30 days old) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_scheduled_email_by_message_id(message_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str message_id: The messageId of scheduled email (required) + :param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. + :param date end_date: 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. + :return: GetScheduledEmailByMessageId + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_scheduled_email_by_message_id_with_http_info(message_id, **kwargs) # noqa: E501 + else: + (data) = self.get_scheduled_email_by_message_id_with_http_info(message_id, **kwargs) # noqa: E501 + return data + + def get_scheduled_email_by_message_id_with_http_info(self, message_id, **kwargs): # noqa: E501 + """Fetch scheduled email by messageId # noqa: E501 + + Fetch scheduled email by messageId (Can retrieve data upto 30 days old) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_scheduled_email_by_message_id_with_http_info(message_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str message_id: The messageId of scheduled email (required) + :param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. + :param date end_date: 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. + :return: GetScheduledEmailByMessageId + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['message_id', 'start_date', 'end_date'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_scheduled_email_by_message_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'message_id' is set + if ('message_id' not in params or + params['message_id'] is None): + raise ValueError("Missing the required parameter `message_id` when calling `get_scheduled_email_by_message_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'message_id' in params: + path_params['messageId'] = params['message_id'] # noqa: E501 + + query_params = [] + if 'start_date' in params: + query_params.append(('startDate', params['start_date'])) # noqa: E501 + if 'end_date' in params: + query_params.append(('endDate', params['end_date'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['api-key', 'partner-key'] # noqa: E501 + + return self.api_client.call_api( + '/smtp/emailStatus/{messageId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='GetScheduledEmailByMessageId', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_smtp_report(self, **kwargs): # noqa: E501 """Get your transactional email activity aggregated per day # noqa: E501 diff --git a/sib_api_v3_sdk/models/__init__.py b/sib_api_v3_sdk/models/__init__.py index 9425a8f..b2cdc69 100644 --- a/sib_api_v3_sdk/models/__init__.py +++ b/sib_api_v3_sdk/models/__init__.py @@ -27,7 +27,6 @@ from sib_api_v3_sdk.models.block_domain import BlockDomain from sib_api_v3_sdk.models.body import Body from sib_api_v3_sdk.models.body1 import Body1 -from sib_api_v3_sdk.models.contact import Contact from sib_api_v3_sdk.models.create_attribute import CreateAttribute from sib_api_v3_sdk.models.create_attribute_enumeration import CreateAttributeEnumeration from sib_api_v3_sdk.models.create_child import CreateChild @@ -48,6 +47,7 @@ from sib_api_v3_sdk.models.create_smtp_template import CreateSmtpTemplate from sib_api_v3_sdk.models.create_smtp_template_sender import CreateSmtpTemplateSender from sib_api_v3_sdk.models.create_sub_account import CreateSubAccount +from sib_api_v3_sdk.models.create_sub_account_response import CreateSubAccountResponse from sib_api_v3_sdk.models.create_update_contact_model import CreateUpdateContactModel from sib_api_v3_sdk.models.create_update_folder import CreateUpdateFolder from sib_api_v3_sdk.models.create_webhook import CreateWebhook @@ -55,7 +55,6 @@ from sib_api_v3_sdk.models.delete_hardbounces import DeleteHardbounces from sib_api_v3_sdk.models.email_export_recipients import EmailExportRecipients from sib_api_v3_sdk.models.error_model import ErrorModel -from sib_api_v3_sdk.models.file_data import FileData from sib_api_v3_sdk.models.get_account_marketing_automation import GetAccountMarketingAutomation from sib_api_v3_sdk.models.get_account_plan import GetAccountPlan from sib_api_v3_sdk.models.get_account_relay import GetAccountRelay @@ -120,6 +119,9 @@ from sib_api_v3_sdk.models.get_processes import GetProcesses from sib_api_v3_sdk.models.get_reports import GetReports from sib_api_v3_sdk.models.get_reports_reports import GetReportsReports +from sib_api_v3_sdk.models.get_scheduled_email_by_batch_id import GetScheduledEmailByBatchId +from sib_api_v3_sdk.models.get_scheduled_email_by_batch_id_batches import GetScheduledEmailByBatchIdBatches +from sib_api_v3_sdk.models.get_scheduled_email_by_message_id import GetScheduledEmailByMessageId from sib_api_v3_sdk.models.get_senders_list import GetSendersList from sib_api_v3_sdk.models.get_senders_list_ips import GetSendersListIps from sib_api_v3_sdk.models.get_senders_list_senders import GetSendersListSenders @@ -148,6 +150,7 @@ from sib_api_v3_sdk.models.get_transac_sms_report_reports import GetTransacSmsReportReports from sib_api_v3_sdk.models.get_webhook import GetWebhook from sib_api_v3_sdk.models.get_webhooks import GetWebhooks +from sib_api_v3_sdk.models.inline_response201 import InlineResponse201 from sib_api_v3_sdk.models.manage_ip import ManageIp from sib_api_v3_sdk.models.master_details_response import MasterDetailsResponse from sib_api_v3_sdk.models.master_details_response_billing_info import MasterDetailsResponseBillingInfo @@ -157,6 +160,8 @@ from sib_api_v3_sdk.models.master_details_response_plan_info_features import MasterDetailsResponsePlanInfoFeatures from sib_api_v3_sdk.models.note import Note from sib_api_v3_sdk.models.note_data import NoteData +from sib_api_v3_sdk.models.note_id import NoteId +from sib_api_v3_sdk.models.note_list import NoteList from sib_api_v3_sdk.models.post_contact_info import PostContactInfo from sib_api_v3_sdk.models.post_contact_info_contacts import PostContactInfoContacts from sib_api_v3_sdk.models.post_send_failed import PostSendFailed @@ -171,6 +176,7 @@ from sib_api_v3_sdk.models.request_contact_import import RequestContactImport from sib_api_v3_sdk.models.request_contact_import_new_list import RequestContactImportNewList from sib_api_v3_sdk.models.request_sms_recipient_export import RequestSmsRecipientExport +from sib_api_v3_sdk.models.schedule_smtp_email import ScheduleSmtpEmail from sib_api_v3_sdk.models.send_report import SendReport from sib_api_v3_sdk.models.send_report_email import SendReportEmail from sib_api_v3_sdk.models.send_sms import SendSms @@ -202,6 +208,7 @@ from sib_api_v3_sdk.models.sub_accounts_response import SubAccountsResponse from sib_api_v3_sdk.models.sub_accounts_response_sub_accounts import SubAccountsResponseSubAccounts from sib_api_v3_sdk.models.task import Task +from sib_api_v3_sdk.models.task_list import TaskList from sib_api_v3_sdk.models.task_reminder import TaskReminder from sib_api_v3_sdk.models.task_types import TaskTypes from sib_api_v3_sdk.models.update_attribute import UpdateAttribute diff --git a/sib_api_v3_sdk/models/body.py b/sib_api_v3_sdk/models/body.py index 31c2dfc..ff490d6 100644 --- a/sib_api_v3_sdk/models/body.py +++ b/sib_api_v3_sdk/models/body.py @@ -123,7 +123,7 @@ def name(self, name): def duration(self): """Gets the duration of this Body. # noqa: E501 - Duration of task # noqa: E501 + Duration of task in milliseconds [1 minute = 60000 ms] # noqa: E501 :return: The duration of this Body. # noqa: E501 :rtype: int @@ -134,11 +134,13 @@ def duration(self): def duration(self, duration): """Sets the duration of this Body. - Duration of task # noqa: E501 + Duration of task in milliseconds [1 minute = 60000 ms] # noqa: E501 :param duration: The duration of this Body. # noqa: E501 :type: int """ + if duration is not None and duration < 0: # noqa: E501 + raise ValueError("Invalid value for `duration`, must be a value greater than or equal to `0`") # noqa: E501 self._duration = duration @@ -171,7 +173,7 @@ def task_type_id(self, task_type_id): def _date(self): """Gets the _date of this Body. # noqa: E501 - Task date/time # noqa: E501 + Task due date and time # noqa: E501 :return: The _date of this Body. # noqa: E501 :rtype: datetime @@ -182,7 +184,7 @@ def _date(self): def _date(self, _date): """Sets the _date of this Body. - Task date/time # noqa: E501 + Task due date and time # noqa: E501 :param _date: The _date of this Body. # noqa: E501 :type: datetime diff --git a/sib_api_v3_sdk/models/body1.py b/sib_api_v3_sdk/models/body1.py index 4705861..4f94941 100644 --- a/sib_api_v3_sdk/models/body1.py +++ b/sib_api_v3_sdk/models/body1.py @@ -123,7 +123,7 @@ def name(self, name): def duration(self): """Gets the duration of this Body1. # noqa: E501 - Duration of task # noqa: E501 + Duration of task in milliseconds [1 minute = 60000 ms] # noqa: E501 :return: The duration of this Body1. # noqa: E501 :rtype: int @@ -134,7 +134,7 @@ def duration(self): def duration(self, duration): """Sets the duration of this Body1. - Duration of task # noqa: E501 + Duration of task in milliseconds [1 minute = 60000 ms] # noqa: E501 :param duration: The duration of this Body1. # noqa: E501 :type: int diff --git a/sib_api_v3_sdk/models/create_contact.py b/sib_api_v3_sdk/models/create_contact.py index 79f72e8..f02acca 100644 --- a/sib_api_v3_sdk/models/create_contact.py +++ b/sib_api_v3_sdk/models/create_contact.py @@ -104,7 +104,7 @@ def email(self, email): def attributes(self): """Gets the attributes of this CreateContact. # noqa: E501 - Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} # noqa: E501 + Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} # noqa: E501 :return: The attributes of this CreateContact. # noqa: E501 :rtype: object @@ -115,7 +115,7 @@ def attributes(self): def attributes(self, attributes): """Sets the attributes of this CreateContact. - Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} # noqa: E501 + Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} # noqa: E501 :param attributes: The attributes of this CreateContact. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/create_sub_account.py b/sib_api_v3_sdk/models/create_sub_account.py index ebdace3..5dac1bc 100644 --- a/sib_api_v3_sdk/models/create_sub_account.py +++ b/sib_api_v3_sdk/models/create_sub_account.py @@ -64,7 +64,7 @@ def __init__(self, company_name=None, email=None, language=None, timezone=None): def company_name(self): """Gets the company_name of this CreateSubAccount. # noqa: E501 - Name of the organization # noqa: E501 + Set the name of the sub-account company # noqa: E501 :return: The company_name of this CreateSubAccount. # noqa: E501 :rtype: str @@ -75,7 +75,7 @@ def company_name(self): def company_name(self, company_name): """Sets the company_name of this CreateSubAccount. - Name of the organization # noqa: E501 + Set the name of the sub-account company # noqa: E501 :param company_name: The company_name of this CreateSubAccount. # noqa: E501 :type: str @@ -114,7 +114,7 @@ def email(self, email): def language(self): """Gets the language of this CreateSubAccount. # noqa: E501 - Language for identifying localization information # noqa: E501 + Set the language of the sub-account # noqa: E501 :return: The language of this CreateSubAccount. # noqa: E501 :rtype: str @@ -125,7 +125,7 @@ def language(self): def language(self, language): """Sets the language of this CreateSubAccount. - Language for identifying localization information # noqa: E501 + Set the language of the sub-account # noqa: E501 :param language: The language of this CreateSubAccount. # noqa: E501 :type: str @@ -143,7 +143,7 @@ def language(self, language): def timezone(self): """Gets the timezone of this CreateSubAccount. # noqa: E501 - Request timezone of the client # noqa: E501 + Set the timezone of the sub-account # noqa: E501 :return: The timezone of this CreateSubAccount. # noqa: E501 :rtype: str @@ -154,7 +154,7 @@ def timezone(self): def timezone(self, timezone): """Sets the timezone of this CreateSubAccount. - Request timezone of the client # noqa: E501 + Set the timezone of the sub-account # noqa: E501 :param timezone: The timezone of this CreateSubAccount. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/create_sub_account_response.py b/sib_api_v3_sdk/models/create_sub_account_response.py new file mode 100644 index 0000000..0863a9a --- /dev/null +++ b/sib_api_v3_sdk/models/create_sub_account_response.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class CreateSubAccountResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'int' + } + + attribute_map = { + 'id': 'id' + } + + def __init__(self, id=None): # noqa: E501 + """CreateSubAccountResponse - a model defined in Swagger""" # noqa: E501 + + self._id = None + self.discriminator = None + + self.id = id + + @property + def id(self): + """Gets the id of this CreateSubAccountResponse. # noqa: E501 + + ID of the sub-account created # noqa: E501 + + :return: The id of this CreateSubAccountResponse. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this CreateSubAccountResponse. + + ID of the sub-account created # noqa: E501 + + :param id: The id of this CreateSubAccountResponse. # noqa: E501 + :type: int + """ + if id is None: + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateSubAccountResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateSubAccountResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/get_campaign_stats.py b/sib_api_v3_sdk/models/get_campaign_stats.py index 1d53376..69e2912 100644 --- a/sib_api_v3_sdk/models/get_campaign_stats.py +++ b/sib_api_v3_sdk/models/get_campaign_stats.py @@ -41,6 +41,8 @@ class GetCampaignStats(object): 'hard_bounces': 'int', 'unique_views': 'int', 'trackable_views': 'int', + 'trackable_views_rate': 'float', + 'estimated_views': 'int', 'unsubscriptions': 'int', 'viewed': 'int', 'deferred': 'int', @@ -58,13 +60,15 @@ class GetCampaignStats(object): 'hard_bounces': 'hardBounces', 'unique_views': 'uniqueViews', 'trackable_views': 'trackableViews', + 'trackable_views_rate': 'trackableViewsRate', + 'estimated_views': 'estimatedViews', 'unsubscriptions': 'unsubscriptions', 'viewed': 'viewed', 'deferred': 'deferred', 'return_bounce': 'returnBounce' } - def __init__(self, list_id=None, unique_clicks=None, clickers=None, complaints=None, delivered=None, sent=None, soft_bounces=None, hard_bounces=None, unique_views=None, trackable_views=None, unsubscriptions=None, viewed=None, deferred=None, return_bounce=None): # noqa: E501 + def __init__(self, list_id=None, unique_clicks=None, clickers=None, complaints=None, delivered=None, sent=None, soft_bounces=None, hard_bounces=None, unique_views=None, trackable_views=None, trackable_views_rate=None, estimated_views=None, unsubscriptions=None, viewed=None, deferred=None, return_bounce=None): # noqa: E501 """GetCampaignStats - a model defined in Swagger""" # noqa: E501 self._list_id = None @@ -77,6 +81,8 @@ def __init__(self, list_id=None, unique_clicks=None, clickers=None, complaints=N self._hard_bounces = None self._unique_views = None self._trackable_views = None + self._trackable_views_rate = None + self._estimated_views = None self._unsubscriptions = None self._viewed = None self._deferred = None @@ -94,6 +100,10 @@ def __init__(self, list_id=None, unique_clicks=None, clickers=None, complaints=N self.hard_bounces = hard_bounces self.unique_views = unique_views self.trackable_views = trackable_views + if trackable_views_rate is not None: + self.trackable_views_rate = trackable_views_rate + if estimated_views is not None: + self.estimated_views = estimated_views self.unsubscriptions = unsubscriptions self.viewed = viewed if deferred is not None: @@ -349,6 +359,52 @@ def trackable_views(self, trackable_views): self._trackable_views = trackable_views + @property + def trackable_views_rate(self): + """Gets the trackable_views_rate of this GetCampaignStats. # noqa: E501 + + Rate of recipients without any privacy protection option enabled in their email client # noqa: E501 + + :return: The trackable_views_rate of this GetCampaignStats. # noqa: E501 + :rtype: float + """ + return self._trackable_views_rate + + @trackable_views_rate.setter + def trackable_views_rate(self, trackable_views_rate): + """Sets the trackable_views_rate of this GetCampaignStats. + + Rate of recipients without any privacy protection option enabled in their email client # noqa: E501 + + :param trackable_views_rate: The trackable_views_rate of this GetCampaignStats. # noqa: E501 + :type: float + """ + + self._trackable_views_rate = trackable_views_rate + + @property + def estimated_views(self): + """Gets the estimated_views of this GetCampaignStats. # noqa: E501 + + Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails # noqa: E501 + + :return: The estimated_views of this GetCampaignStats. # noqa: E501 + :rtype: int + """ + return self._estimated_views + + @estimated_views.setter + def estimated_views(self, estimated_views): + """Sets the estimated_views of this GetCampaignStats. + + Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails # noqa: E501 + + :param estimated_views: The estimated_views of this GetCampaignStats. # noqa: E501 + :type: int + """ + + self._estimated_views = estimated_views + @property def unsubscriptions(self): """Gets the unsubscriptions of this GetCampaignStats. # noqa: E501 diff --git a/sib_api_v3_sdk/models/get_scheduled_email_by_batch_id.py b/sib_api_v3_sdk/models/get_scheduled_email_by_batch_id.py new file mode 100644 index 0000000..3705014 --- /dev/null +++ b/sib_api_v3_sdk/models/get_scheduled_email_by_batch_id.py @@ -0,0 +1,143 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class GetScheduledEmailByBatchId(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'count': 'int', + 'batches': 'list[GetScheduledEmailByBatchIdBatches]' + } + + attribute_map = { + 'count': 'count', + 'batches': 'batches' + } + + def __init__(self, count=None, batches=None): # noqa: E501 + """GetScheduledEmailByBatchId - a model defined in Swagger""" # noqa: E501 + + self._count = None + self._batches = None + self.discriminator = None + + if count is not None: + self.count = count + if batches is not None: + self.batches = batches + + @property + def count(self): + """Gets the count of this GetScheduledEmailByBatchId. # noqa: E501 + + Total number of batches # noqa: E501 + + :return: The count of this GetScheduledEmailByBatchId. # noqa: E501 + :rtype: int + """ + return self._count + + @count.setter + def count(self, count): + """Sets the count of this GetScheduledEmailByBatchId. + + Total number of batches # noqa: E501 + + :param count: The count of this GetScheduledEmailByBatchId. # noqa: E501 + :type: int + """ + + self._count = count + + @property + def batches(self): + """Gets the batches of this GetScheduledEmailByBatchId. # noqa: E501 + + + :return: The batches of this GetScheduledEmailByBatchId. # noqa: E501 + :rtype: list[GetScheduledEmailByBatchIdBatches] + """ + return self._batches + + @batches.setter + def batches(self, batches): + """Sets the batches of this GetScheduledEmailByBatchId. + + + :param batches: The batches of this GetScheduledEmailByBatchId. # noqa: E501 + :type: list[GetScheduledEmailByBatchIdBatches] + """ + + self._batches = batches + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(GetScheduledEmailByBatchId, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, GetScheduledEmailByBatchId): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/get_scheduled_email_by_batch_id_batches.py b/sib_api_v3_sdk/models/get_scheduled_email_by_batch_id_batches.py new file mode 100644 index 0000000..9e64d14 --- /dev/null +++ b/sib_api_v3_sdk/models/get_scheduled_email_by_batch_id_batches.py @@ -0,0 +1,182 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class GetScheduledEmailByBatchIdBatches(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'scheduled_at': 'datetime', + 'created_at': 'datetime', + 'status': 'str' + } + + attribute_map = { + 'scheduled_at': 'scheduledAt', + 'created_at': 'createdAt', + 'status': 'status' + } + + def __init__(self, scheduled_at=None, created_at=None, status=None): # noqa: E501 + """GetScheduledEmailByBatchIdBatches - a model defined in Swagger""" # noqa: E501 + + self._scheduled_at = None + self._created_at = None + self._status = None + self.discriminator = None + + self.scheduled_at = scheduled_at + self.created_at = created_at + self.status = status + + @property + def scheduled_at(self): + """Gets the scheduled_at of this GetScheduledEmailByBatchIdBatches. # noqa: E501 + + Datetime for which the batch was scheduled # noqa: E501 + + :return: The scheduled_at of this GetScheduledEmailByBatchIdBatches. # noqa: E501 + :rtype: datetime + """ + return self._scheduled_at + + @scheduled_at.setter + def scheduled_at(self, scheduled_at): + """Sets the scheduled_at of this GetScheduledEmailByBatchIdBatches. + + Datetime for which the batch was scheduled # noqa: E501 + + :param scheduled_at: The scheduled_at of this GetScheduledEmailByBatchIdBatches. # noqa: E501 + :type: datetime + """ + if scheduled_at is None: + raise ValueError("Invalid value for `scheduled_at`, must not be `None`") # noqa: E501 + + self._scheduled_at = scheduled_at + + @property + def created_at(self): + """Gets the created_at of this GetScheduledEmailByBatchIdBatches. # noqa: E501 + + Datetime on which the batch was scheduled # noqa: E501 + + :return: The created_at of this GetScheduledEmailByBatchIdBatches. # noqa: E501 + :rtype: datetime + """ + return self._created_at + + @created_at.setter + def created_at(self, created_at): + """Sets the created_at of this GetScheduledEmailByBatchIdBatches. + + Datetime on which the batch was scheduled # noqa: E501 + + :param created_at: The created_at of this GetScheduledEmailByBatchIdBatches. # noqa: E501 + :type: datetime + """ + if created_at is None: + raise ValueError("Invalid value for `created_at`, must not be `None`") # noqa: E501 + + self._created_at = created_at + + @property + def status(self): + """Gets the status of this GetScheduledEmailByBatchIdBatches. # noqa: E501 + + Current status of the scheduled batch # noqa: E501 + + :return: The status of this GetScheduledEmailByBatchIdBatches. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetScheduledEmailByBatchIdBatches. + + Current status of the scheduled batch # noqa: E501 + + :param status: The status of this GetScheduledEmailByBatchIdBatches. # noqa: E501 + :type: str + """ + if status is None: + raise ValueError("Invalid value for `status`, must not be `None`") # noqa: E501 + allowed_values = ["inProgress", "queued", "processed", "error"] # noqa: E501 + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501 + .format(status, allowed_values) + ) + + self._status = status + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(GetScheduledEmailByBatchIdBatches, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, GetScheduledEmailByBatchIdBatches): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/get_scheduled_email_by_message_id.py b/sib_api_v3_sdk/models/get_scheduled_email_by_message_id.py new file mode 100644 index 0000000..da9d056 --- /dev/null +++ b/sib_api_v3_sdk/models/get_scheduled_email_by_message_id.py @@ -0,0 +1,182 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class GetScheduledEmailByMessageId(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'scheduled_at': 'datetime', + 'created_at': 'datetime', + 'status': 'str' + } + + attribute_map = { + 'scheduled_at': 'scheduledAt', + 'created_at': 'createdAt', + 'status': 'status' + } + + def __init__(self, scheduled_at=None, created_at=None, status=None): # noqa: E501 + """GetScheduledEmailByMessageId - a model defined in Swagger""" # noqa: E501 + + self._scheduled_at = None + self._created_at = None + self._status = None + self.discriminator = None + + self.scheduled_at = scheduled_at + self.created_at = created_at + self.status = status + + @property + def scheduled_at(self): + """Gets the scheduled_at of this GetScheduledEmailByMessageId. # noqa: E501 + + Datetime for which the email was scheduled # noqa: E501 + + :return: The scheduled_at of this GetScheduledEmailByMessageId. # noqa: E501 + :rtype: datetime + """ + return self._scheduled_at + + @scheduled_at.setter + def scheduled_at(self, scheduled_at): + """Sets the scheduled_at of this GetScheduledEmailByMessageId. + + Datetime for which the email was scheduled # noqa: E501 + + :param scheduled_at: The scheduled_at of this GetScheduledEmailByMessageId. # noqa: E501 + :type: datetime + """ + if scheduled_at is None: + raise ValueError("Invalid value for `scheduled_at`, must not be `None`") # noqa: E501 + + self._scheduled_at = scheduled_at + + @property + def created_at(self): + """Gets the created_at of this GetScheduledEmailByMessageId. # noqa: E501 + + Datetime on which the email was scheduled # noqa: E501 + + :return: The created_at of this GetScheduledEmailByMessageId. # noqa: E501 + :rtype: datetime + """ + return self._created_at + + @created_at.setter + def created_at(self, created_at): + """Sets the created_at of this GetScheduledEmailByMessageId. + + Datetime on which the email was scheduled # noqa: E501 + + :param created_at: The created_at of this GetScheduledEmailByMessageId. # noqa: E501 + :type: datetime + """ + if created_at is None: + raise ValueError("Invalid value for `created_at`, must not be `None`") # noqa: E501 + + self._created_at = created_at + + @property + def status(self): + """Gets the status of this GetScheduledEmailByMessageId. # noqa: E501 + + Current status of the scheduled email # noqa: E501 + + :return: The status of this GetScheduledEmailByMessageId. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetScheduledEmailByMessageId. + + Current status of the scheduled email # noqa: E501 + + :param status: The status of this GetScheduledEmailByMessageId. # noqa: E501 + :type: str + """ + if status is None: + raise ValueError("Invalid value for `status`, must not be `None`") # noqa: E501 + allowed_values = ["inProgress", "queued", "processed", "error"] # noqa: E501 + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501 + .format(status, allowed_values) + ) + + self._status = status + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(GetScheduledEmailByMessageId, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, GetScheduledEmailByMessageId): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/get_sso_token.py b/sib_api_v3_sdk/models/get_sso_token.py index fddda8d..1eddbf1 100644 --- a/sib_api_v3_sdk/models/get_sso_token.py +++ b/sib_api_v3_sdk/models/get_sso_token.py @@ -50,7 +50,7 @@ def __init__(self, token=None): # noqa: E501 def token(self): """Gets the token of this GetSsoToken. # noqa: E501 - Session token. It will remain valid for a short period of time only. # noqa: E501 + Session token, it will remain valid for 15 days. # noqa: E501 :return: The token of this GetSsoToken. # noqa: E501 :rtype: str @@ -61,7 +61,7 @@ def token(self): def token(self, token): """Sets the token of this GetSsoToken. - Session token. It will remain valid for a short period of time only. # noqa: E501 + Session token, it will remain valid for 15 days. # noqa: E501 :param token: The token of this GetSsoToken. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/inline_response201.py b/sib_api_v3_sdk/models/inline_response201.py new file mode 100644 index 0000000..7e81212 --- /dev/null +++ b/sib_api_v3_sdk/models/inline_response201.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class InlineResponse201(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str' + } + + attribute_map = { + 'id': 'id' + } + + def __init__(self, id=None): # noqa: E501 + """InlineResponse201 - a model defined in Swagger""" # noqa: E501 + + self._id = None + self.discriminator = None + + self.id = id + + @property + def id(self): + """Gets the id of this InlineResponse201. # noqa: E501 + + Unique task id # noqa: E501 + + :return: The id of this InlineResponse201. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this InlineResponse201. + + Unique task id # noqa: E501 + + :param id: The id of this InlineResponse201. # noqa: E501 + :type: str + """ + if id is None: + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponse201, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponse201): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/note_id.py b/sib_api_v3_sdk/models/note_id.py new file mode 100644 index 0000000..6340ac3 --- /dev/null +++ b/sib_api_v3_sdk/models/note_id.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class NoteId(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str' + } + + attribute_map = { + 'id': 'id' + } + + def __init__(self, id=None): # noqa: E501 + """NoteId - a model defined in Swagger""" # noqa: E501 + + self._id = None + self.discriminator = None + + if id is not None: + self.id = id + + @property + def id(self): + """Gets the id of this NoteId. # noqa: E501 + + Unique note Id # noqa: E501 + + :return: The id of this NoteId. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this NoteId. + + Unique note Id # noqa: E501 + + :param id: The id of this NoteId. # noqa: E501 + :type: str + """ + + self._id = id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(NoteId, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NoteId): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/note_list.py b/sib_api_v3_sdk/models/note_list.py new file mode 100644 index 0000000..6a3887f --- /dev/null +++ b/sib_api_v3_sdk/models/note_list.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class NoteList(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + + attribute_map = { + } + + def __init__(self): # noqa: E501 + """NoteList - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(NoteList, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NoteList): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/request_contact_import.py b/sib_api_v3_sdk/models/request_contact_import.py index 56bd991..6ce73f6 100644 --- a/sib_api_v3_sdk/models/request_contact_import.py +++ b/sib_api_v3_sdk/models/request_contact_import.py @@ -33,6 +33,7 @@ class RequestContactImport(object): swagger_types = { 'file_url': 'str', 'file_body': 'str', + 'json_body': 'list[dict(str, object)]', 'list_ids': 'list[int]', 'notify_url': 'str', 'new_list': 'RequestContactImportNewList', @@ -45,6 +46,7 @@ class RequestContactImport(object): attribute_map = { 'file_url': 'fileUrl', 'file_body': 'fileBody', + 'json_body': 'jsonBody', 'list_ids': 'listIds', 'notify_url': 'notifyUrl', 'new_list': 'newList', @@ -54,11 +56,12 @@ class RequestContactImport(object): 'empty_contacts_attributes': 'emptyContactsAttributes' } - def __init__(self, file_url=None, file_body=None, list_ids=None, notify_url=None, new_list=None, email_blacklist=False, sms_blacklist=False, update_existing_contacts=True, empty_contacts_attributes=False): # noqa: E501 + def __init__(self, file_url=None, file_body=None, json_body=None, list_ids=None, notify_url=None, new_list=None, email_blacklist=False, sms_blacklist=False, update_existing_contacts=True, empty_contacts_attributes=False): # noqa: E501 """RequestContactImport - a model defined in Swagger""" # noqa: E501 self._file_url = None self._file_body = None + self._json_body = None self._list_ids = None self._notify_url = None self._new_list = None @@ -72,6 +75,8 @@ def __init__(self, file_url=None, file_body=None, list_ids=None, notify_url=None self.file_url = file_url if file_body is not None: self.file_body = file_body + if json_body is not None: + self.json_body = json_body if list_ids is not None: self.list_ids = list_ids if notify_url is not None: @@ -91,7 +96,7 @@ def __init__(self, file_url=None, file_body=None, list_ids=None, notify_url=None def file_url(self): """Gets the file_url of this RequestContactImport. # noqa: E501 - Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv # noqa: E501 + Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json # noqa: E501 :return: The file_url of this RequestContactImport. # noqa: E501 :rtype: str @@ -102,7 +107,7 @@ def file_url(self): def file_url(self, file_url): """Sets the file_url of this RequestContactImport. - Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv # noqa: E501 + Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json # noqa: E501 :param file_url: The file_url of this RequestContactImport. # noqa: E501 :type: str @@ -114,7 +119,7 @@ def file_url(self, file_url): def file_body(self): """Gets the file_body of this RequestContactImport. # noqa: E501 - Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. # noqa: E501 + Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. # noqa: E501 :return: The file_body of this RequestContactImport. # noqa: E501 :rtype: str @@ -125,7 +130,7 @@ def file_body(self): def file_body(self, file_body): """Sets the file_body of this RequestContactImport. - Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. # noqa: E501 + Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. # noqa: E501 :param file_body: The file_body of this RequestContactImport. # noqa: E501 :type: str @@ -133,6 +138,29 @@ def file_body(self, file_body): self._file_body = file_body + @property + def json_body(self): + """Gets the json_body of this RequestContactImport. # noqa: E501 + + **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. # noqa: E501 + + :return: The json_body of this RequestContactImport. # noqa: E501 + :rtype: list[dict(str, object)] + """ + return self._json_body + + @json_body.setter + def json_body(self, json_body): + """Sets the json_body of this RequestContactImport. + + **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. # noqa: E501 + + :param json_body: The json_body of this RequestContactImport. # noqa: E501 + :type: list[dict(str, object)] + """ + + self._json_body = json_body + @property def list_ids(self): """Gets the list_ids of this RequestContactImport. # noqa: E501 diff --git a/sib_api_v3_sdk/models/schedule_smtp_email.py b/sib_api_v3_sdk/models/schedule_smtp_email.py new file mode 100644 index 0000000..7d10d89 --- /dev/null +++ b/sib_api_v3_sdk/models/schedule_smtp_email.py @@ -0,0 +1,171 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class ScheduleSmtpEmail(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'message_id': 'str', + 'message_ids': 'list[str]', + 'batch_id': 'str' + } + + attribute_map = { + 'message_id': 'messageId', + 'message_ids': 'messageIds', + 'batch_id': 'batchId' + } + + def __init__(self, message_id=None, message_ids=None, batch_id=None): # noqa: E501 + """ScheduleSmtpEmail - a model defined in Swagger""" # noqa: E501 + + self._message_id = None + self._message_ids = None + self._batch_id = None + self.discriminator = None + + if message_id is not None: + self.message_id = message_id + if message_ids is not None: + self.message_ids = message_ids + if batch_id is not None: + self.batch_id = batch_id + + @property + def message_id(self): + """Gets the message_id of this ScheduleSmtpEmail. # noqa: E501 + + Message ID of the transactional email scheduled # noqa: E501 + + :return: The message_id of this ScheduleSmtpEmail. # noqa: E501 + :rtype: str + """ + return self._message_id + + @message_id.setter + def message_id(self, message_id): + """Sets the message_id of this ScheduleSmtpEmail. + + Message ID of the transactional email scheduled # noqa: E501 + + :param message_id: The message_id of this ScheduleSmtpEmail. # noqa: E501 + :type: str + """ + + self._message_id = message_id + + @property + def message_ids(self): + """Gets the message_ids of this ScheduleSmtpEmail. # noqa: E501 + + + :return: The message_ids of this ScheduleSmtpEmail. # noqa: E501 + :rtype: list[str] + """ + return self._message_ids + + @message_ids.setter + def message_ids(self, message_ids): + """Sets the message_ids of this ScheduleSmtpEmail. + + + :param message_ids: The message_ids of this ScheduleSmtpEmail. # noqa: E501 + :type: list[str] + """ + + self._message_ids = message_ids + + @property + def batch_id(self): + """Gets the batch_id of this ScheduleSmtpEmail. # noqa: E501 + + Batch ID of the batch transactional email scheduled # noqa: E501 + + :return: The batch_id of this ScheduleSmtpEmail. # noqa: E501 + :rtype: str + """ + return self._batch_id + + @batch_id.setter + def batch_id(self, batch_id): + """Sets the batch_id of this ScheduleSmtpEmail. + + Batch ID of the batch transactional email scheduled # noqa: E501 + + :param batch_id: The batch_id of this ScheduleSmtpEmail. # noqa: E501 + :type: str + """ + + self._batch_id = batch_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ScheduleSmtpEmail, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScheduleSmtpEmail): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/send_smtp_email.py b/sib_api_v3_sdk/models/send_smtp_email.py index ab84e8c..e447214 100644 --- a/sib_api_v3_sdk/models/send_smtp_email.py +++ b/sib_api_v3_sdk/models/send_smtp_email.py @@ -44,7 +44,9 @@ class SendSmtpEmail(object): 'template_id': 'int', 'params': 'object', 'message_versions': 'list[SendSmtpEmailMessageVersions]', - 'tags': 'list[str]' + 'tags': 'list[str]', + 'scheduled_at': 'datetime', + 'batch_id': 'str' } attribute_map = { @@ -61,10 +63,12 @@ class SendSmtpEmail(object): 'template_id': 'templateId', 'params': 'params', 'message_versions': 'messageVersions', - 'tags': 'tags' + 'tags': 'tags', + 'scheduled_at': 'scheduledAt', + 'batch_id': 'batchId' } - def __init__(self, sender=None, to=None, bcc=None, cc=None, html_content=None, text_content=None, subject=None, reply_to=None, attachment=None, headers=None, template_id=None, params=None, message_versions=None, tags=None): # noqa: E501 + def __init__(self, sender=None, to=None, bcc=None, cc=None, html_content=None, text_content=None, subject=None, reply_to=None, attachment=None, headers=None, template_id=None, params=None, message_versions=None, tags=None, scheduled_at=None, batch_id=None): # noqa: E501 """SendSmtpEmail - a model defined in Swagger""" # noqa: E501 self._sender = None @@ -81,6 +85,8 @@ def __init__(self, sender=None, to=None, bcc=None, cc=None, html_content=None, t self._params = None self._message_versions = None self._tags = None + self._scheduled_at = None + self._batch_id = None self.discriminator = None if sender is not None: @@ -111,6 +117,10 @@ def __init__(self, sender=None, to=None, bcc=None, cc=None, html_content=None, t self.message_versions = message_versions if tags is not None: self.tags = tags + if scheduled_at is not None: + self.scheduled_at = scheduled_at + if batch_id is not None: + self.batch_id = batch_id @property def sender(self): @@ -430,6 +440,52 @@ def tags(self, tags): self._tags = tags + @property + def scheduled_at(self): + """Gets the scheduled_at of this SendSmtpEmail. # noqa: E501 + + UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. # noqa: E501 + + :return: The scheduled_at of this SendSmtpEmail. # noqa: E501 + :rtype: datetime + """ + return self._scheduled_at + + @scheduled_at.setter + def scheduled_at(self, scheduled_at): + """Sets the scheduled_at of this SendSmtpEmail. + + UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. # noqa: E501 + + :param scheduled_at: The scheduled_at of this SendSmtpEmail. # noqa: E501 + :type: datetime + """ + + self._scheduled_at = scheduled_at + + @property + def batch_id(self): + """Gets the batch_id of this SendSmtpEmail. # noqa: E501 + + Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. # noqa: E501 + + :return: The batch_id of this SendSmtpEmail. # noqa: E501 + :rtype: str + """ + return self._batch_id + + @batch_id.setter + def batch_id(self, batch_id): + """Sets the batch_id of this SendSmtpEmail. + + Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. # noqa: E501 + + :param batch_id: The batch_id of this SendSmtpEmail. # noqa: E501 + :type: str + """ + + self._batch_id = batch_id + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/sub_account_details_response_plan_info_credits.py b/sib_api_v3_sdk/models/sub_account_details_response_plan_info_credits.py index 37ff8d6..b02d8ac 100644 --- a/sib_api_v3_sdk/models/sub_account_details_response_plan_info_credits.py +++ b/sib_api_v3_sdk/models/sub_account_details_response_plan_info_credits.py @@ -56,7 +56,7 @@ def __init__(self, sms=None, emails=None): # noqa: E501 def sms(self): """Gets the sms of this SubAccountDetailsResponsePlanInfoCredits. # noqa: E501 - Sms quota of the sub-account # noqa: E501 + SMS credits remaining on the sub-account # noqa: E501 :return: The sms of this SubAccountDetailsResponsePlanInfoCredits. # noqa: E501 :rtype: int @@ -67,7 +67,7 @@ def sms(self): def sms(self, sms): """Sets the sms of this SubAccountDetailsResponsePlanInfoCredits. - Sms quota of the sub-account # noqa: E501 + SMS credits remaining on the sub-account # noqa: E501 :param sms: The sms of this SubAccountDetailsResponsePlanInfoCredits. # noqa: E501 :type: int diff --git a/sib_api_v3_sdk/models/sub_accounts_response_sub_accounts.py b/sib_api_v3_sdk/models/sub_accounts_response_sub_accounts.py index 84c961f..1bf0ee3 100644 --- a/sib_api_v3_sdk/models/sub_accounts_response_sub_accounts.py +++ b/sib_api_v3_sdk/models/sub_accounts_response_sub_accounts.py @@ -62,7 +62,7 @@ def __init__(self, id=None, company_name=None, active=None, created_at=None): # def id(self): """Gets the id of this SubAccountsResponseSubAccounts. # noqa: E501 - client id of sub-account organization # noqa: E501 + id of the sub-account # noqa: E501 :return: The id of this SubAccountsResponseSubAccounts. # noqa: E501 :rtype: int @@ -73,7 +73,7 @@ def id(self): def id(self, id): """Sets the id of this SubAccountsResponseSubAccounts. - client id of sub-account organization # noqa: E501 + id of the sub-account # noqa: E501 :param id: The id of this SubAccountsResponseSubAccounts. # noqa: E501 :type: int @@ -87,7 +87,7 @@ def id(self, id): def company_name(self): """Gets the company_name of this SubAccountsResponseSubAccounts. # noqa: E501 - Name of sub-account organization # noqa: E501 + Name of the sub-account company # noqa: E501 :return: The company_name of this SubAccountsResponseSubAccounts. # noqa: E501 :rtype: str @@ -98,7 +98,7 @@ def company_name(self): def company_name(self, company_name): """Sets the company_name of this SubAccountsResponseSubAccounts. - Name of sub-account organization # noqa: E501 + Name of the sub-account company # noqa: E501 :param company_name: The company_name of this SubAccountsResponseSubAccounts. # noqa: E501 :type: str @@ -112,7 +112,7 @@ def company_name(self, company_name): def active(self): """Gets the active of this SubAccountsResponseSubAccounts. # noqa: E501 - Whether organization is active or not # noqa: E501 + Whether the sub-account is active or not # noqa: E501 :return: The active of this SubAccountsResponseSubAccounts. # noqa: E501 :rtype: bool @@ -123,7 +123,7 @@ def active(self): def active(self, active): """Sets the active of this SubAccountsResponseSubAccounts. - Whether organization is active or not # noqa: E501 + Whether the sub-account is active or not # noqa: E501 :param active: The active of this SubAccountsResponseSubAccounts. # noqa: E501 :type: bool @@ -137,7 +137,7 @@ def active(self, active): def created_at(self): """Gets the created_at of this SubAccountsResponseSubAccounts. # noqa: E501 - timestamp when the organization was created # noqa: E501 + Timestamp when the sub-account was created # noqa: E501 :return: The created_at of this SubAccountsResponseSubAccounts. # noqa: E501 :rtype: int @@ -148,7 +148,7 @@ def created_at(self): def created_at(self, created_at): """Sets the created_at of this SubAccountsResponseSubAccounts. - timestamp when the organization was created # noqa: E501 + Timestamp when the sub-account was created # noqa: E501 :param created_at: The created_at of this SubAccountsResponseSubAccounts. # noqa: E501 :type: int diff --git a/sib_api_v3_sdk/models/task.py b/sib_api_v3_sdk/models/task.py index 06caef0..4038b91 100644 --- a/sib_api_v3_sdk/models/task.py +++ b/sib_api_v3_sdk/models/task.py @@ -31,119 +31,44 @@ class Task(object): and the value is json key in definition. """ swagger_types = { - 'first_contact': 'Contact', 'id': 'str', 'task_type_id': 'str', 'name': 'str', 'contacts_ids': 'list[int]', - 'contacts': 'list[Contact]', 'deals_ids': 'list[str]', - 'companies_ids': 'list[str]', - 'assign_to_id': 'str', - '_date': 'datetime', - 'duration': 'int', - 'notes': 'str', - 'done': 'bool', - 'reminder': 'TaskReminder', - 'created_at': 'datetime', - 'updated_at': 'datetime', - 'refs': 'object' + 'companies_ids': 'list[str]' } attribute_map = { - 'first_contact': 'firstContact', 'id': 'id', 'task_type_id': 'taskTypeId', 'name': 'name', 'contacts_ids': 'contactsIds', - 'contacts': 'contacts', 'deals_ids': 'dealsIds', - 'companies_ids': 'companiesIds', - 'assign_to_id': 'assignToId', - '_date': 'date', - 'duration': 'duration', - 'notes': 'notes', - 'done': 'done', - 'reminder': 'reminder', - 'created_at': 'createdAt', - 'updated_at': 'updatedAt', - 'refs': 'refs' + 'companies_ids': 'companiesIds' } - def __init__(self, first_contact=None, id=None, task_type_id=None, name=None, contacts_ids=None, contacts=None, deals_ids=None, companies_ids=None, assign_to_id=None, _date=None, duration=None, notes=None, done=None, reminder=None, created_at=None, updated_at=None, refs=None): # noqa: E501 + def __init__(self, id=None, task_type_id=None, name=None, contacts_ids=None, deals_ids=None, companies_ids=None): # noqa: E501 """Task - a model defined in Swagger""" # noqa: E501 - self._first_contact = None self._id = None self._task_type_id = None self._name = None self._contacts_ids = None - self._contacts = None self._deals_ids = None self._companies_ids = None - self._assign_to_id = None - self.__date = None - self._duration = None - self._notes = None - self._done = None - self._reminder = None - self._created_at = None - self._updated_at = None - self._refs = None self.discriminator = None - if first_contact is not None: - self.first_contact = first_contact if id is not None: self.id = id self.task_type_id = task_type_id self.name = name if contacts_ids is not None: self.contacts_ids = contacts_ids - if contacts is not None: - self.contacts = contacts if deals_ids is not None: self.deals_ids = deals_ids if companies_ids is not None: self.companies_ids = companies_ids - if assign_to_id is not None: - self.assign_to_id = assign_to_id - self._date = _date - if duration is not None: - self.duration = duration - if notes is not None: - self.notes = notes - if done is not None: - self.done = done - if reminder is not None: - self.reminder = reminder - if created_at is not None: - self.created_at = created_at - if updated_at is not None: - self.updated_at = updated_at - if refs is not None: - self.refs = refs - - @property - def first_contact(self): - """Gets the first_contact of this Task. # noqa: E501 - - - :return: The first_contact of this Task. # noqa: E501 - :rtype: Contact - """ - return self._first_contact - - @first_contact.setter - def first_contact(self, first_contact): - """Sets the first_contact of this Task. - - - :param first_contact: The first_contact of this Task. # noqa: E501 - :type: Contact - """ - - self._first_contact = first_contact @property def id(self): @@ -241,29 +166,6 @@ def contacts_ids(self, contacts_ids): self._contacts_ids = contacts_ids - @property - def contacts(self): - """Gets the contacts of this Task. # noqa: E501 - - Contact details for contacts linked to this task # noqa: E501 - - :return: The contacts of this Task. # noqa: E501 - :rtype: list[Contact] - """ - return self._contacts - - @contacts.setter - def contacts(self, contacts): - """Sets the contacts of this Task. - - Contact details for contacts linked to this task # noqa: E501 - - :param contacts: The contacts of this Task. # noqa: E501 - :type: list[Contact] - """ - - self._contacts = contacts - @property def deals_ids(self): """Gets the deals_ids of this Task. # noqa: E501 @@ -310,213 +212,6 @@ def companies_ids(self, companies_ids): self._companies_ids = companies_ids - @property - def assign_to_id(self): - """Gets the assign_to_id of this Task. # noqa: E501 - - User id to whom task is assigned # noqa: E501 - - :return: The assign_to_id of this Task. # noqa: E501 - :rtype: str - """ - return self._assign_to_id - - @assign_to_id.setter - def assign_to_id(self, assign_to_id): - """Sets the assign_to_id of this Task. - - User id to whom task is assigned # noqa: E501 - - :param assign_to_id: The assign_to_id of this Task. # noqa: E501 - :type: str - """ - - self._assign_to_id = assign_to_id - - @property - def _date(self): - """Gets the _date of this Task. # noqa: E501 - - Task date/time # noqa: E501 - - :return: The _date of this Task. # noqa: E501 - :rtype: datetime - """ - return self.__date - - @_date.setter - def _date(self, _date): - """Sets the _date of this Task. - - Task date/time # noqa: E501 - - :param _date: The _date of this Task. # noqa: E501 - :type: datetime - """ - if _date is None: - raise ValueError("Invalid value for `_date`, must not be `None`") # noqa: E501 - - self.__date = _date - - @property - def duration(self): - """Gets the duration of this Task. # noqa: E501 - - Duration of task # noqa: E501 - - :return: The duration of this Task. # noqa: E501 - :rtype: int - """ - return self._duration - - @duration.setter - def duration(self, duration): - """Sets the duration of this Task. - - Duration of task # noqa: E501 - - :param duration: The duration of this Task. # noqa: E501 - :type: int - """ - - self._duration = duration - - @property - def notes(self): - """Gets the notes of this Task. # noqa: E501 - - Notes added to a task # noqa: E501 - - :return: The notes of this Task. # noqa: E501 - :rtype: str - """ - return self._notes - - @notes.setter - def notes(self, notes): - """Sets the notes of this Task. - - Notes added to a task # noqa: E501 - - :param notes: The notes of this Task. # noqa: E501 - :type: str - """ - - self._notes = notes - - @property - def done(self): - """Gets the done of this Task. # noqa: E501 - - Task marked as done # noqa: E501 - - :return: The done of this Task. # noqa: E501 - :rtype: bool - """ - return self._done - - @done.setter - def done(self, done): - """Sets the done of this Task. - - Task marked as done # noqa: E501 - - :param done: The done of this Task. # noqa: E501 - :type: bool - """ - - self._done = done - - @property - def reminder(self): - """Gets the reminder of this Task. # noqa: E501 - - Task reminder date/time for a task # noqa: E501 - - :return: The reminder of this Task. # noqa: E501 - :rtype: TaskReminder - """ - return self._reminder - - @reminder.setter - def reminder(self, reminder): - """Sets the reminder of this Task. - - Task reminder date/time for a task # noqa: E501 - - :param reminder: The reminder of this Task. # noqa: E501 - :type: TaskReminder - """ - - self._reminder = reminder - - @property - def created_at(self): - """Gets the created_at of this Task. # noqa: E501 - - Task created date/time # noqa: E501 - - :return: The created_at of this Task. # noqa: E501 - :rtype: datetime - """ - return self._created_at - - @created_at.setter - def created_at(self, created_at): - """Sets the created_at of this Task. - - Task created date/time # noqa: E501 - - :param created_at: The created_at of this Task. # noqa: E501 - :type: datetime - """ - - self._created_at = created_at - - @property - def updated_at(self): - """Gets the updated_at of this Task. # noqa: E501 - - Task update date/time # noqa: E501 - - :return: The updated_at of this Task. # noqa: E501 - :rtype: datetime - """ - return self._updated_at - - @updated_at.setter - def updated_at(self, updated_at): - """Sets the updated_at of this Task. - - Task update date/time # noqa: E501 - - :param updated_at: The updated_at of this Task. # noqa: E501 - :type: datetime - """ - - self._updated_at = updated_at - - @property - def refs(self): - """Gets the refs of this Task. # noqa: E501 - - - :return: The refs of this Task. # noqa: E501 - :rtype: object - """ - return self._refs - - @refs.setter - def refs(self, refs): - """Sets the refs of this Task. - - - :param refs: The refs of this Task. # noqa: E501 - :type: object - """ - - self._refs = refs - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/task_list.py b/sib_api_v3_sdk/models/task_list.py new file mode 100644 index 0000000..3792743 --- /dev/null +++ b/sib_api_v3_sdk/models/task_list.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class TaskList(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'items': 'list[Task]' + } + + attribute_map = { + 'items': 'items' + } + + def __init__(self, items=None): # noqa: E501 + """TaskList - a model defined in Swagger""" # noqa: E501 + + self._items = None + self.discriminator = None + + if items is not None: + self.items = items + + @property + def items(self): + """Gets the items of this TaskList. # noqa: E501 + + List of tasks # noqa: E501 + + :return: The items of this TaskList. # noqa: E501 + :rtype: list[Task] + """ + return self._items + + @items.setter + def items(self, items): + """Sets the items of this TaskList. + + List of tasks # noqa: E501 + + :param items: The items of this TaskList. # noqa: E501 + :type: list[Task] + """ + + self._items = items + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TaskList, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TaskList): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/task_reminder.py b/sib_api_v3_sdk/models/task_reminder.py index b8e08dd..961009b 100644 --- a/sib_api_v3_sdk/models/task_reminder.py +++ b/sib_api_v3_sdk/models/task_reminder.py @@ -114,7 +114,7 @@ def unit(self, unit): def types(self): """Gets the types of this TaskReminder. # noqa: E501 - Type of task reminder # noqa: E501 + Type of task reminder e.g email, push # noqa: E501 :return: The types of this TaskReminder. # noqa: E501 :rtype: list[str] @@ -125,7 +125,7 @@ def types(self): def types(self, types): """Sets the types of this TaskReminder. - Type of task reminder # noqa: E501 + Type of task reminder e.g email, push # noqa: E501 :param types: The types of this TaskReminder. # noqa: E501 :type: list[str] diff --git a/sib_api_v3_sdk/models/task_types.py b/sib_api_v3_sdk/models/task_types.py index 816fbf5..80172ee 100644 --- a/sib_api_v3_sdk/models/task_types.py +++ b/sib_api_v3_sdk/models/task_types.py @@ -32,28 +32,23 @@ class TaskTypes(object): """ swagger_types = { 'id': 'str', - 'icon': 'str', 'title': 'str' } attribute_map = { 'id': 'id', - 'icon': 'icon', 'title': 'title' } - def __init__(self, id=None, icon=None, title=None): # noqa: E501 + def __init__(self, id=None, title=None): # noqa: E501 """TaskTypes - a model defined in Swagger""" # noqa: E501 self._id = None - self._icon = None self._title = None self.discriminator = None if id is not None: self.id = id - if icon is not None: - self.icon = icon if title is not None: self.title = title @@ -80,29 +75,6 @@ def id(self, id): self._id = id - @property - def icon(self): - """Gets the icon of this TaskTypes. # noqa: E501 - - Icon of task type # noqa: E501 - - :return: The icon of this TaskTypes. # noqa: E501 - :rtype: str - """ - return self._icon - - @icon.setter - def icon(self, icon): - """Sets the icon of this TaskTypes. - - Icon of task type # noqa: E501 - - :param icon: The icon of this TaskTypes. # noqa: E501 - :type: str - """ - - self._icon = icon - @property def title(self): """Gets the title of this TaskTypes. # noqa: E501 diff --git a/sib_api_v3_sdk/models/update_contact.py b/sib_api_v3_sdk/models/update_contact.py index 97d9f73..05e11ea 100644 --- a/sib_api_v3_sdk/models/update_contact.py +++ b/sib_api_v3_sdk/models/update_contact.py @@ -76,7 +76,7 @@ def __init__(self, attributes=None, email_blacklisted=None, sms_blacklisted=None def attributes(self): """Gets the attributes of this UpdateContact. # noqa: E501 - Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} # noqa: E501 + Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} # noqa: E501 :return: The attributes of this UpdateContact. # noqa: E501 :rtype: object @@ -87,7 +87,7 @@ def attributes(self): def attributes(self, attributes): """Sets the attributes of this UpdateContact. - Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} # noqa: E501 + Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} # noqa: E501 :param attributes: The attributes of this UpdateContact. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/update_email_campaign.py b/sib_api_v3_sdk/models/update_email_campaign.py index d76b07d..629439a 100644 --- a/sib_api_v3_sdk/models/update_email_campaign.py +++ b/sib_api_v3_sdk/models/update_email_campaign.py @@ -253,7 +253,7 @@ def name(self, name): def html_content(self): """Gets the html_content of this UpdateEmailCampaign. # noqa: E501 - Body of the message (HTML version). REQUIRED if htmlUrl is empty # noqa: E501 + Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty # noqa: E501 :return: The html_content of this UpdateEmailCampaign. # noqa: E501 :rtype: str @@ -264,7 +264,7 @@ def html_content(self): def html_content(self, html_content): """Sets the html_content of this UpdateEmailCampaign. - Body of the message (HTML version). REQUIRED if htmlUrl is empty # noqa: E501 + Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty # noqa: E501 :param html_content: The html_content of this UpdateEmailCampaign. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/update_smtp_template.py b/sib_api_v3_sdk/models/update_smtp_template.py index 61770ec..9ae33cb 100644 --- a/sib_api_v3_sdk/models/update_smtp_template.py +++ b/sib_api_v3_sdk/models/update_smtp_template.py @@ -163,7 +163,7 @@ def template_name(self, template_name): def html_content(self): """Gets the html_content of this UpdateSmtpTemplate. # noqa: E501 - Required if htmlUrl is empty. Body of the message (HTML must have more than 10 characters) # noqa: E501 + Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) # noqa: E501 :return: The html_content of this UpdateSmtpTemplate. # noqa: E501 :rtype: str @@ -174,7 +174,7 @@ def html_content(self): def html_content(self, html_content): """Sets the html_content of this UpdateSmtpTemplate. - Required if htmlUrl is empty. Body of the message (HTML must have more than 10 characters) # noqa: E501 + Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) # noqa: E501 :param html_content: The html_content of this UpdateSmtpTemplate. # noqa: E501 :type: str diff --git a/test/test_create_sub_account_response.py b/test/test_create_sub_account_response.py new file mode 100644 index 0000000..06b5542 --- /dev/null +++ b/test/test_create_sub_account_response.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.create_sub_account_response import CreateSubAccountResponse # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestCreateSubAccountResponse(unittest.TestCase): + """CreateSubAccountResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateSubAccountResponse(self): + """Test CreateSubAccountResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.create_sub_account_response.CreateSubAccountResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_scheduled_email_by_batch_id.py b/test/test_get_scheduled_email_by_batch_id.py new file mode 100644 index 0000000..111ebd5 --- /dev/null +++ b/test/test_get_scheduled_email_by_batch_id.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.get_scheduled_email_by_batch_id import GetScheduledEmailByBatchId # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestGetScheduledEmailByBatchId(unittest.TestCase): + """GetScheduledEmailByBatchId unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetScheduledEmailByBatchId(self): + """Test GetScheduledEmailByBatchId""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.get_scheduled_email_by_batch_id.GetScheduledEmailByBatchId() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_scheduled_email_by_batch_id_batches.py b/test/test_get_scheduled_email_by_batch_id_batches.py new file mode 100644 index 0000000..ccf533d --- /dev/null +++ b/test/test_get_scheduled_email_by_batch_id_batches.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.get_scheduled_email_by_batch_id_batches import GetScheduledEmailByBatchIdBatches # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestGetScheduledEmailByBatchIdBatches(unittest.TestCase): + """GetScheduledEmailByBatchIdBatches unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetScheduledEmailByBatchIdBatches(self): + """Test GetScheduledEmailByBatchIdBatches""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.get_scheduled_email_by_batch_id_batches.GetScheduledEmailByBatchIdBatches() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_scheduled_email_by_message_id.py b/test/test_get_scheduled_email_by_message_id.py new file mode 100644 index 0000000..cb1bebf --- /dev/null +++ b/test/test_get_scheduled_email_by_message_id.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.get_scheduled_email_by_message_id import GetScheduledEmailByMessageId # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestGetScheduledEmailByMessageId(unittest.TestCase): + """GetScheduledEmailByMessageId unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetScheduledEmailByMessageId(self): + """Test GetScheduledEmailByMessageId""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.get_scheduled_email_by_message_id.GetScheduledEmailByMessageId() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response201.py b/test/test_inline_response201.py new file mode 100644 index 0000000..7d6e1a7 --- /dev/null +++ b/test/test_inline_response201.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.inline_response201 import InlineResponse201 # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestInlineResponse201(unittest.TestCase): + """InlineResponse201 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse201(self): + """Test InlineResponse201""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.inline_response201.InlineResponse201() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_note_id.py b/test/test_note_id.py new file mode 100644 index 0000000..05ada79 --- /dev/null +++ b/test/test_note_id.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.note_id import NoteId # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestNoteId(unittest.TestCase): + """NoteId unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNoteId(self): + """Test NoteId""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.note_id.NoteId() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_note_list.py b/test/test_note_list.py new file mode 100644 index 0000000..787b0dd --- /dev/null +++ b/test/test_note_list.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.note_list import NoteList # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestNoteList(unittest.TestCase): + """NoteList unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNoteList(self): + """Test NoteList""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.note_list.NoteList() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_schedule_smtp_email.py b/test/test_schedule_smtp_email.py new file mode 100644 index 0000000..efcfccb --- /dev/null +++ b/test/test_schedule_smtp_email.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.schedule_smtp_email import ScheduleSmtpEmail # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestScheduleSmtpEmail(unittest.TestCase): + """ScheduleSmtpEmail unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testScheduleSmtpEmail(self): + """Test ScheduleSmtpEmail""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.schedule_smtp_email.ScheduleSmtpEmail() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_task_list.py b/test/test_task_list.py new file mode 100644 index 0000000..fbd761a --- /dev/null +++ b/test/test_task_list.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.task_list import TaskList # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestTaskList(unittest.TestCase): + """TaskList unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTaskList(self): + """Test TaskList""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.task_list.TaskList() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main()