diff --git a/README.md b/README.md index 9abc4ba..2d3fa04 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' api_instance = sib_api_v3_sdk.AccountApi(sib_api_v3_sdk.ApiClient(configuration)) try: - # Get your account informations, plans and credits details + # Get your account information, plan and credits details api_response = api_instance.get_account() pprint(api_response) except ApiException as e: @@ -87,100 +87,102 @@ All URIs are relative to *https://api.sendinblue.com/v3* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*AccountApi* | [**get_account**](docs/AccountApi.md#get_account) | **GET** /account | Get your account informations, plans and credits details -*AttributesApi* | [**create_attribute**](docs/AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute -*AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute -*AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes -*AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute +*AccountApi* | [**get_account**](docs/AccountApi.md#get_account) | **GET** /account | Get your account information, plan and credits details +*AttributesApi* | [**create_attribute**](docs/AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute +*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 *ContactsApi* | [**add_contact_to_list**](docs/ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list -*ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute +*ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute *ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /contacts | Create a contact +*ContactsApi* | [**create_doi_contact**](docs/ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create a contact to trigger the DOI workflow from a Landing Page form *ContactsApi* | [**create_folder**](docs/ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder *ContactsApi* | [**create_list**](docs/ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list -*ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute -*ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Deletes a contact +*ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute +*ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Delete a contact *ContactsApi* | [**delete_folder**](docs/ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) *ContactsApi* | [**delete_list**](docs/ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list -*ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes -*ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Retrieves contact informations -*ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get the campaigns statistics for a contact +*ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes +*ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Get a contact's details +*ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact *ContactsApi* | [**get_contacts**](docs/ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts -*ContactsApi* | [**get_contacts_from_list**](docs/ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list -*ContactsApi* | [**get_folder**](docs/ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details -*ContactsApi* | [**get_folder_lists**](docs/ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -*ContactsApi* | [**get_folders**](docs/ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all the folders -*ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list +*ContactsApi* | [**get_contacts_from_list**](docs/ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list +*ContactsApi* | [**get_folder**](docs/ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details +*ContactsApi* | [**get_folder_lists**](docs/ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +*ContactsApi* | [**get_folders**](docs/ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all folders +*ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details *ContactsApi* | [**get_lists**](docs/ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists *ContactsApi* | [**import_contacts**](docs/ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts -*ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list +*ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list *ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts -*ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute -*ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact -*ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder +*ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute +*ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Update a contact +*ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder *ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list *EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign *EmailCampaignsApi* | [**delete_email_campaign**](docs/EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign -*EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign -*EmailCampaignsApi* | [**get_ab_test_campaign_result**](docs/EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get A/B test email campaign result -*EmailCampaignsApi* | [**get_email_campaign**](docs/EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations -*EmailCampaignsApi* | [**get_email_campaigns**](docs/EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns +*EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign +*EmailCampaignsApi* | [**get_ab_test_campaign_result**](docs/EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results +*EmailCampaignsApi* | [**get_email_campaign**](docs/EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report +*EmailCampaignsApi* | [**get_email_campaigns**](docs/EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created email campaigns *EmailCampaignsApi* | [**get_shared_template_url**](docs/EmailCampaignsApi.md#get_shared_template_url) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url *EmailCampaignsApi* | [**send_email_campaign_now**](docs/EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId -*EmailCampaignsApi* | [**send_report**](docs/EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns +*EmailCampaignsApi* | [**send_report**](docs/EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign *EmailCampaignsApi* | [**send_test_email**](docs/EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list -*EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status -*EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign +*EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status +*EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign +*EmailCampaignsApi* | [**upload_image_to_gallery**](docs/EmailCampaignsApi.md#upload_image_to_gallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery *FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder *FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) -*FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details -*FoldersApi* | [**get_folder_lists**](docs/FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -*FoldersApi* | [**get_folders**](docs/FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all the folders -*FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder +*FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details +*FoldersApi* | [**get_folder_lists**](docs/FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +*FoldersApi* | [**get_folders**](docs/FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all folders +*FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder *ListsApi* | [**add_contact_to_list**](docs/ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list *ListsApi* | [**create_list**](docs/ListsApi.md#create_list) | **POST** /contacts/lists | Create a list *ListsApi* | [**delete_list**](docs/ListsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list -*ListsApi* | [**get_contacts_from_list**](docs/ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list -*ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -*ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list +*ListsApi* | [**get_contacts_from_list**](docs/ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list +*ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +*ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details *ListsApi* | [**get_lists**](docs/ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists -*ListsApi* | [**remove_contact_from_list**](docs/ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list +*ListsApi* | [**remove_contact_from_list**](docs/ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list *ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list *ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process *ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account *ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account *ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child -*ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Creates a domain for a child account +*ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Create a domain for a child account *ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child -*ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed -*ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied +*ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Delete the sender domain of the reseller child based on the childAuthKey and domainName passed +*ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Delete a single reseller child based on the childAuthKey supplied *ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child -*ResellerApi* | [**get_child_account_creation_status**](docs/ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied -*ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account -*ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account -*ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts +*ResellerApi* | [**get_child_account_creation_status**](docs/ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied +*ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Get all sender domains for a specific child account +*ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Get a child account's details +*ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Get the list of all children accounts *ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO) *ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account -*ResellerApi* | [**update_child_account_status**](docs/ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied -*ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed -*ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied +*ResellerApi* | [**update_child_account_status**](docs/ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Update info of reseller's child account status based on the childAuthKey supplied +*ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Update the sender domain of reseller's child based on the childAuthKey and domainName passed +*ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Update info of reseller's child based on the childAuthKey supplied *SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign -*SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign +*SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign *SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign -*SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns -*SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign. +*SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns +*SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients *SMSCampaignsApi* | [**send_sms_campaign_now**](docs/SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately -*SMSCampaignsApi* | [**send_sms_report**](docs/SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns -*SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS -*SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign -*SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status -*SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create a transactional email template +*SMSCampaignsApi* | [**send_sms_report**](docs/SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report +*SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign +*SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign +*SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status +*SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template *SMTPApi* | [**delete_hardbounces**](docs/SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces -*SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive transactional email template +*SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template *SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time *SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) *SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day -*SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template informations -*SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of transactional email templates +*SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information +*SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates *SMTPApi* | [**get_transac_blocked_contacts**](docs/SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts *SMTPApi* | [**get_transac_email_content**](docs/SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email *SMTPApi* | [**get_transac_emails_list**](docs/SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters @@ -189,17 +191,17 @@ Class | Method | HTTP request | Description *SMTPApi* | [**send_transac_email**](docs/SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email *SMTPApi* | [**smtp_blocked_contacts_email_delete**](docs/SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact *SMTPApi* | [**smtp_log_message_id_delete**](docs/SMTPApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log -*SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates a transactional email templates +*SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template *SendersApi* | [**create_sender**](docs/SendersApi.md#create_sender) | **POST** /senders | Create a new sender *SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender -*SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips | Return all the dedicated IPs for your account -*SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Return all the dedicated IPs for a sender +*SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips | Get all the dedicated IPs for your account +*SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender *SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders *SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender -*TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all the SMS activity (unaggregated events) +*TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) *TransactionalSMSApi* | [**get_transac_aggregated_sms_report**](docs/TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time *TransactionalSMSApi* | [**get_transac_sms_report**](docs/TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day -*TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to the specified mobile number +*TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to a mobile number *WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook *WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook *WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook details @@ -217,6 +219,7 @@ Class | Method | HTTP request | Description - [CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md) - [CreateChild](docs/CreateChild.md) - [CreateContact](docs/CreateContact.md) + - [CreateDoiContact](docs/CreateDoiContact.md) - [CreateEmailCampaign](docs/CreateEmailCampaign.md) - [CreateEmailCampaignRecipients](docs/CreateEmailCampaignRecipients.md) - [CreateEmailCampaignSender](docs/CreateEmailCampaignSender.md) @@ -370,6 +373,7 @@ Class | Method | HTTP request | Description - [UpdateSmtpTemplate](docs/UpdateSmtpTemplate.md) - [UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md) - [UpdateWebhook](docs/UpdateWebhook.md) + - [UploadImageToGallery](docs/UploadImageToGallery.md) - [GetChildInfo](docs/GetChildInfo.md) - [GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md) - [GetExtendedClient](docs/GetExtendedClient.md) diff --git a/docs/AccountApi.md b/docs/AccountApi.md index 6685483..85f74bb 100644 --- a/docs/AccountApi.md +++ b/docs/AccountApi.md @@ -4,13 +4,13 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account informations, plans and credits details +[**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account information, plan and credits details # **get_account** > GetAccount get_account() -Get your account informations, plans and credits details +Get your account information, plan and credits details ### Example ```python @@ -35,7 +35,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' api_instance = sib_api_v3_sdk.AccountApi(sib_api_v3_sdk.ApiClient(configuration)) try: - # Get your account informations, plans and credits details + # Get your account information, plan and credits details api_response = api_instance.get_account() pprint(api_response) except ApiException as e: diff --git a/docs/AddContactToList.md b/docs/AddContactToList.md index cd4dd84..7c3ac19 100644 --- a/docs/AddContactToList.md +++ b/docs/AddContactToList.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**emails** | **list[str]** | Emails to add to a list | [optional] +**emails** | **list[str]** | Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AttributesApi.md b/docs/AttributesApi.md index 04e5329..618431c 100644 --- a/docs/AttributesApi.md +++ b/docs/AttributesApi.md @@ -4,16 +4,16 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute -[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute -[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes -[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute +[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute +[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute +[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes +[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute # **create_attribute** > create_attribute(attribute_category, attribute_name, create_attribute) -Creates contact attribute +Create contact attribute ### Example ```python @@ -41,7 +41,7 @@ attribute_name = 'attribute_name_example' # str | Name of the attribute create_attribute = sib_api_v3_sdk.CreateAttribute() # CreateAttribute | Values to create an attribute try: - # Creates contact attribute + # Create contact attribute api_instance.create_attribute(attribute_category, attribute_name, create_attribute) except ApiException as e: print("Exception when calling AttributesApi->create_attribute: %s\n" % e) @@ -73,7 +73,7 @@ void (empty response body) # **delete_attribute** > delete_attribute(attribute_category, attribute_name) -Deletes an attribute +Delete an attribute ### Example ```python @@ -100,7 +100,7 @@ attribute_category = 'attribute_category_example' # str | Category of the attrib attribute_name = 'attribute_name_example' # str | Name of the existing attribute try: - # Deletes an attribute + # Delete an attribute api_instance.delete_attribute(attribute_category, attribute_name) except ApiException as e: print("Exception when calling AttributesApi->delete_attribute: %s\n" % e) @@ -131,7 +131,7 @@ void (empty response body) # **get_attributes** > GetAttributes get_attributes() -Lists all attributes +List all attributes ### Example ```python @@ -156,7 +156,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' api_instance = sib_api_v3_sdk.AttributesApi(sib_api_v3_sdk.ApiClient(configuration)) try: - # Lists all attributes + # List all attributes api_response = api_instance.get_attributes() pprint(api_response) except ApiException as e: @@ -184,7 +184,7 @@ This endpoint does not need any parameter. # **update_attribute** > update_attribute(attribute_category, attribute_name, update_attribute) -Updates contact attribute +Update contact attribute ### Example ```python @@ -212,7 +212,7 @@ attribute_name = 'attribute_name_example' # str | Name of the existing attribute update_attribute = sib_api_v3_sdk.UpdateAttribute() # UpdateAttribute | Values to update an attribute try: - # Updates contact attribute + # Update contact attribute api_instance.update_attribute(attribute_category, attribute_name, update_attribute) except ApiException as e: print("Exception when calling AttributesApi->update_attribute: %s\n" % e) diff --git a/docs/ContactsApi.md b/docs/ContactsApi.md index ae8e7c0..0d54d50 100644 --- a/docs/ContactsApi.md +++ b/docs/ContactsApi.md @@ -5,30 +5,31 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**add_contact_to_list**](ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list -[**create_attribute**](ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute +[**create_attribute**](ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute [**create_contact**](ContactsApi.md#create_contact) | **POST** /contacts | Create a contact +[**create_doi_contact**](ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create a contact to trigger the DOI workflow from a Landing Page form [**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder [**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list -[**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute -[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Deletes a contact +[**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute +[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Delete a contact [**delete_folder**](ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) [**delete_list**](ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list -[**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes -[**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Retrieves contact informations -[**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get the campaigns statistics for a contact +[**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes +[**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Get a contact's details +[**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact [**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts -[**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list -[**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details -[**get_folder_lists**](ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -[**get_folders**](ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all the folders -[**get_list**](ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list +[**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list +[**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details +[**get_folder_lists**](ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +[**get_folders**](ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all folders +[**get_list**](ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details [**get_lists**](ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists [**import_contacts**](ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts -[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list +[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list [**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts -[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute -[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact -[**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder +[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute +[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Update a contact +[**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder [**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list @@ -94,7 +95,7 @@ Name | Type | Description | Notes # **create_attribute** > create_attribute(attribute_category, attribute_name, create_attribute) -Creates contact attribute +Create contact attribute ### Example ```python @@ -122,7 +123,7 @@ attribute_name = 'attribute_name_example' # str | Name of the attribute create_attribute = sib_api_v3_sdk.CreateAttribute() # CreateAttribute | Values to create an attribute try: - # Creates contact attribute + # Create contact attribute api_instance.create_attribute(attribute_category, attribute_name, create_attribute) except ApiException as e: print("Exception when calling ContactsApi->create_attribute: %s\n" % e) @@ -208,6 +209,62 @@ 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) +# **create_doi_contact** +> create_doi_contact(create_doi_contact) + +Create a contact to trigger the DOI workflow from a Landing Page form + +### 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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) +create_doi_contact = sib_api_v3_sdk.CreateDoiContact() # CreateDoiContact | Values to create the DOI contact + +try: + # Create a contact to trigger the DOI workflow from a Landing Page form + api_instance.create_doi_contact(create_doi_contact) +except ApiException as e: + print("Exception when calling ContactsApi->create_doi_contact: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_doi_contact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the DOI contact | + +### 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) + # **create_folder** > CreateModel create_folder(create_folder) @@ -325,7 +382,7 @@ Name | Type | Description | Notes # **delete_attribute** > delete_attribute(attribute_category, attribute_name) -Deletes an attribute +Delete an attribute ### Example ```python @@ -352,7 +409,7 @@ attribute_category = 'attribute_category_example' # str | Category of the attrib attribute_name = 'attribute_name_example' # str | Name of the existing attribute try: - # Deletes an attribute + # Delete an attribute api_instance.delete_attribute(attribute_category, attribute_name) except ApiException as e: print("Exception when calling ContactsApi->delete_attribute: %s\n" % e) @@ -383,7 +440,7 @@ void (empty response body) # **delete_contact** > delete_contact(email) -Deletes a contact +Delete a contact ### Example ```python @@ -409,7 +466,7 @@ api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration email = 'email_example' # str | Email (urlencoded) of the contact try: - # Deletes a contact + # Delete a contact api_instance.delete_contact(email) except ApiException as e: print("Exception when calling ContactsApi->delete_contact: %s\n" % e) @@ -551,7 +608,7 @@ void (empty response body) # **get_attributes** > GetAttributes get_attributes() -Lists all attributes +List all attributes ### Example ```python @@ -576,7 +633,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) try: - # Lists all attributes + # List all attributes api_response = api_instance.get_attributes() pprint(api_response) except ApiException as e: @@ -604,7 +661,7 @@ This endpoint does not need any parameter. # **get_contact_info** > GetExtendedContactDetails get_contact_info(email) -Retrieves contact informations +Get a contact's details ### Example ```python @@ -630,7 +687,7 @@ api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration email = 'email_example' # str | Email (urlencoded) of the contact OR its SMS attribute value try: - # Retrieves contact informations + # Get a contact's details api_response = api_instance.get_contact_info(email) pprint(api_response) except ApiException as e: @@ -659,9 +716,9 @@ 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_contact_stats** -> GetContactCampaignStats get_contact_stats(email) +> GetContactCampaignStats get_contact_stats(email, start_date=start_date, end_date=end_date) -Get the campaigns statistics for a contact +Get email campaigns' statistics for a contact ### Example ```python @@ -685,10 +742,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)) email = 'email_example' # str | Email address (urlencoded) of the contact +start_date = '2013-10-20' # 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 (optional) +end_date = '2013-10-20' # 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 (optional) try: - # Get the campaigns statistics for a contact - api_response = api_instance.get_contact_stats(email) + # Get email campaigns' statistics for a contact + api_response = api_instance.get_contact_stats(email, start_date=start_date, end_date=end_date) pprint(api_response) except ApiException as e: print("Exception when calling ContactsApi->get_contact_stats: %s\n" % e) @@ -699,6 +758,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **email** | **str**| Email address (urlencoded) of the contact | + **start_date** | **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 | [optional] + **end_date** | **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 | [optional] ### Return type @@ -779,7 +840,7 @@ Name | Type | Description | Notes # **get_contacts_from_list** > GetContacts get_contacts_from_list(list_id, modified_since=modified_since, limit=limit, offset=offset) -Get the contacts in a list +Get contacts in a list ### Example ```python @@ -808,7 +869,7 @@ limit = 50 # int | Number of documents per page (optional) (default to 50) offset = 0 # int | Index of the first document of the page (optional) (default to 0) try: - # Get the contacts in a list + # Get contacts in a list api_response = api_instance.get_contacts_from_list(list_id, modified_since=modified_since, limit=limit, offset=offset) pprint(api_response) except ApiException as e: @@ -842,7 +903,7 @@ Name | Type | Description | Notes # **get_folder** > GetFolder get_folder(folder_id) -Returns folder details +Returns a folder's details ### Example ```python @@ -868,7 +929,7 @@ api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration folder_id = 789 # int | id of the folder try: - # Returns folder details + # Returns a folder's details api_response = api_instance.get_folder(folder_id) pprint(api_response) except ApiException as e: @@ -899,7 +960,7 @@ Name | Type | Description | Notes # **get_folder_lists** > GetFolderLists get_folder_lists(folder_id, limit=limit, offset=offset) -Get the lists in a folder +Get lists in a folder ### Example ```python @@ -927,7 +988,7 @@ limit = 10 # int | Number of documents per page (optional) (default to 10) offset = 0 # int | Index of the first document of the page (optional) (default to 0) try: - # Get the lists in a folder + # Get lists in a folder api_response = api_instance.get_folder_lists(folder_id, limit=limit, offset=offset) pprint(api_response) except ApiException as e: @@ -960,7 +1021,7 @@ Name | Type | Description | Notes # **get_folders** > GetFolders get_folders(limit, offset) -Get all the folders +Get all folders ### Example ```python @@ -987,7 +1048,7 @@ limit = 10 # int | Number of documents per page (default to 10) offset = 0 # int | Index of the first document of the page (default to 0) try: - # Get all the folders + # Get all folders api_response = api_instance.get_folders(limit, offset) pprint(api_response) except ApiException as e: @@ -1019,7 +1080,7 @@ Name | Type | Description | Notes # **get_list** > GetExtendedList get_list(list_id) -Get the details of a list +Get a list's details ### Example ```python @@ -1045,7 +1106,7 @@ api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration list_id = 789 # int | Id of the list try: - # Get the details of a list + # Get a list's details api_response = api_instance.get_list(list_id) pprint(api_response) except ApiException as e: @@ -1194,7 +1255,7 @@ Name | Type | Description | Notes # **remove_contact_from_list** > PostContactInfo remove_contact_from_list(list_id, contact_emails) -Remove existing contacts from a list +Delete a contact from a list ### Example ```python @@ -1221,7 +1282,7 @@ list_id = 789 # int | Id of the list contact_emails = sib_api_v3_sdk.RemoveContactFromList() # RemoveContactFromList | Emails adresses of the contact try: - # Remove existing contacts from a list + # Delete a contact from a list api_response = api_instance.remove_contact_from_list(list_id, contact_emails) pprint(api_response) except ApiException as e: @@ -1312,7 +1373,7 @@ Name | Type | Description | Notes # **update_attribute** > update_attribute(attribute_category, attribute_name, update_attribute) -Updates contact attribute +Update contact attribute ### Example ```python @@ -1340,7 +1401,7 @@ attribute_name = 'attribute_name_example' # str | Name of the existing attribute update_attribute = sib_api_v3_sdk.UpdateAttribute() # UpdateAttribute | Values to update an attribute try: - # Updates contact attribute + # Update contact attribute api_instance.update_attribute(attribute_category, attribute_name, update_attribute) except ApiException as e: print("Exception when calling ContactsApi->update_attribute: %s\n" % e) @@ -1372,7 +1433,7 @@ void (empty response body) # **update_contact** > update_contact(email, update_contact) -Updates a contact +Update a contact ### Example ```python @@ -1399,7 +1460,7 @@ email = 'email_example' # str | Email (urlencoded) of the contact update_contact = sib_api_v3_sdk.UpdateContact() # UpdateContact | Values to update a contact try: - # Updates a contact + # Update a contact api_instance.update_contact(email, update_contact) except ApiException as e: print("Exception when calling ContactsApi->update_contact: %s\n" % e) @@ -1430,7 +1491,7 @@ void (empty response body) # **update_folder** > update_folder(folder_id, update_folder) -Update a contact folder +Update a folder ### Example ```python @@ -1457,7 +1518,7 @@ folder_id = 789 # int | Id of the folder update_folder = sib_api_v3_sdk.CreateUpdateFolder() # CreateUpdateFolder | Name of the folder try: - # Update a contact folder + # Update a folder api_instance.update_folder(folder_id, update_folder) except ApiException as e: print("Exception when calling ContactsApi->update_folder: %s\n" % e) diff --git a/docs/CreateAttribute.md b/docs/CreateAttribute.md index 8cc6209..3ca7ca5 100644 --- a/docs/CreateAttribute.md +++ b/docs/CreateAttribute.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **str** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] -**enumeration** | [**list[CreateAttributeEnumeration]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional] +**enumeration** | [**list[CreateAttributeEnumeration]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional] **type** | **str** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateContact.md b/docs/CreateContact.md index db76a69..19190e2 100644 --- a/docs/CreateContact.md +++ b/docs/CreateContact.md @@ -3,8 +3,8 @@ ## Properties 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] +**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] **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/CreateEmailCampaign.md b/docs/CreateEmailCampaign.md index c00f6c2..274d53c 100644 --- a/docs/CreateEmailCampaign.md +++ b/docs/CreateEmailCampaign.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **footer** | **str** | Footer of the email campaign | [optional] **header** | **str** | Header of the email campaign | [optional] **utm_campaign** | **str** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] -**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] +**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] **send_at_best_time** | **bool** | Set this to true if you want to send your campaign at best time. | [optional] [default to False] **ab_testing** | **bool** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to False] **subject_a** | **str** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional] diff --git a/docs/EmailCampaignsApi.md b/docs/EmailCampaignsApi.md index 5db2256..96e0169 100644 --- a/docs/EmailCampaignsApi.md +++ b/docs/EmailCampaignsApi.md @@ -6,16 +6,17 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create_email_campaign**](EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign [**delete_email_campaign**](EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign -[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign -[**get_ab_test_campaign_result**](EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get A/B test email campaign result -[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations -[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns +[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign +[**get_ab_test_campaign_result**](EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results +[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report +[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created email campaigns [**get_shared_template_url**](EmailCampaignsApi.md#get_shared_template_url) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url [**send_email_campaign_now**](EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId -[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns +[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign [**send_test_email**](EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list -[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status -[**update_email_campaign**](EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign +[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status +[**update_email_campaign**](EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign +[**upload_image_to_gallery**](EmailCampaignsApi.md#upload_image_to_gallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery # **create_email_campaign** @@ -134,7 +135,7 @@ void (empty response body) # **email_export_recipients** > CreatedProcessId email_export_recipients(campaign_id, recipient_export=recipient_export) -Export the recipients of a campaign +Export the recipients of an email campaign ### Example ```python @@ -161,7 +162,7 @@ campaign_id = 789 # int | Id of the campaign recipient_export = sib_api_v3_sdk.EmailExportRecipients() # EmailExportRecipients | Values to send for a recipient export request (optional) try: - # Export the recipients of a campaign + # Export the recipients of an email campaign api_response = api_instance.email_export_recipients(campaign_id, recipient_export=recipient_export) pprint(api_response) except ApiException as e: @@ -193,7 +194,7 @@ Name | Type | Description | Notes # **get_ab_test_campaign_result** > AbTestCampaignResult get_ab_test_campaign_result(campaign_id) -Get A/B test email campaign result +Get an A/B test email campaign results Obtain winning version of an A/B test email campaign @@ -221,7 +222,7 @@ api_instance = sib_api_v3_sdk.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configu campaign_id = 789 # int | Id of the A/B test campaign try: - # Get A/B test email campaign result + # Get an A/B test email campaign results api_response = api_instance.get_ab_test_campaign_result(campaign_id) pprint(api_response) except ApiException as e: @@ -252,7 +253,7 @@ Name | Type | Description | Notes # **get_email_campaign** > GetEmailCampaign get_email_campaign(campaign_id) -Get campaign informations +Get an email campaign report ### Example ```python @@ -278,7 +279,7 @@ api_instance = sib_api_v3_sdk.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configu campaign_id = 789 # int | Id of the campaign try: - # Get campaign informations + # Get an email campaign report api_response = api_instance.get_email_campaign(campaign_id) pprint(api_response) except ApiException as e: @@ -309,7 +310,7 @@ Name | Type | Description | Notes # **get_email_campaigns** > GetEmailCampaigns get_email_campaigns(type=type, status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset) -Return all your created campaigns +Return all your created email campaigns ### Example ```python @@ -340,7 +341,7 @@ limit = 500 # int | Number of documents per page (optional) (default to 500) offset = 0 # int | Index of the first document in the page (optional) (default to 0) try: - # Return all your created campaigns + # Return all your created email campaigns api_response = api_instance.get_email_campaigns(type=type, status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset) pprint(api_response) except ApiException as e: @@ -491,7 +492,7 @@ void (empty response body) # **send_report** > send_report(campaign_id, send_report) -Send the report of a campaigns +Send the report of a campaign A PDF will be sent to the specified email addresses @@ -520,7 +521,7 @@ campaign_id = 789 # int | Id of the campaign send_report = sib_api_v3_sdk.SendReport() # SendReport | Values for send a report try: - # Send the report of a campaigns + # Send the report of a campaign api_instance.send_report(campaign_id, send_report) except ApiException as e: print("Exception when calling EmailCampaignsApi->send_report: %s\n" % e) @@ -609,7 +610,7 @@ void (empty response body) # **update_campaign_status** > update_campaign_status(campaign_id, status) -Update a campaign status +Update an email campaign status ### Example ```python @@ -636,7 +637,7 @@ campaign_id = 789 # int | Id of the campaign status = sib_api_v3_sdk.UpdateCampaignStatus() # UpdateCampaignStatus | Status of the campaign try: - # Update a campaign status + # Update an email campaign status api_instance.update_campaign_status(campaign_id, status) except ApiException as e: print("Exception when calling EmailCampaignsApi->update_campaign_status: %s\n" % e) @@ -667,7 +668,7 @@ void (empty response body) # **update_email_campaign** > update_email_campaign(campaign_id, email_campaign) -Update a campaign +Update an email campaign ### Example ```python @@ -694,7 +695,7 @@ campaign_id = 789 # int | Id of the campaign email_campaign = sib_api_v3_sdk.UpdateEmailCampaign() # UpdateEmailCampaign | Values to update a campaign try: - # Update a campaign + # Update an email campaign api_instance.update_email_campaign(campaign_id, email_campaign) except ApiException as e: print("Exception when calling EmailCampaignsApi->update_email_campaign: %s\n" % e) @@ -722,3 +723,59 @@ 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) +# **upload_image_to_gallery** +> upload_image_to_gallery(upload_image) + +Upload an image to your account's image gallery + +### 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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) +upload_image = sib_api_v3_sdk.UploadImageToGallery() # UploadImageToGallery | Parameters to upload an image + +try: + # Upload an image to your account's image gallery + api_instance.upload_image_to_gallery(upload_image) +except ApiException as e: + print("Exception when calling EmailCampaignsApi->upload_image_to_gallery: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **upload_image** | [**UploadImageToGallery**](UploadImageToGallery.md)| Parameters to upload an image | + +### 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) + diff --git a/docs/FoldersApi.md b/docs/FoldersApi.md index 2fbcead..b6f793a 100644 --- a/docs/FoldersApi.md +++ b/docs/FoldersApi.md @@ -6,10 +6,10 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create_folder**](FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder [**delete_folder**](FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) -[**get_folder**](FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details -[**get_folder_lists**](FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -[**get_folders**](FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all the folders -[**update_folder**](FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder +[**get_folder**](FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details +[**get_folder_lists**](FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +[**get_folders**](FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all folders +[**update_folder**](FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder # **create_folder** @@ -128,7 +128,7 @@ void (empty response body) # **get_folder** > GetFolder get_folder(folder_id) -Returns folder details +Returns a folder's details ### Example ```python @@ -154,7 +154,7 @@ api_instance = sib_api_v3_sdk.FoldersApi(sib_api_v3_sdk.ApiClient(configuration) folder_id = 789 # int | id of the folder try: - # Returns folder details + # Returns a folder's details api_response = api_instance.get_folder(folder_id) pprint(api_response) except ApiException as e: @@ -185,7 +185,7 @@ Name | Type | Description | Notes # **get_folder_lists** > GetFolderLists get_folder_lists(folder_id, limit=limit, offset=offset) -Get the lists in a folder +Get lists in a folder ### Example ```python @@ -213,7 +213,7 @@ limit = 10 # int | Number of documents per page (optional) (default to 10) offset = 0 # int | Index of the first document of the page (optional) (default to 0) try: - # Get the lists in a folder + # Get lists in a folder api_response = api_instance.get_folder_lists(folder_id, limit=limit, offset=offset) pprint(api_response) except ApiException as e: @@ -246,7 +246,7 @@ Name | Type | Description | Notes # **get_folders** > GetFolders get_folders(limit, offset) -Get all the folders +Get all folders ### Example ```python @@ -273,7 +273,7 @@ limit = 10 # int | Number of documents per page (default to 10) offset = 0 # int | Index of the first document of the page (default to 0) try: - # Get all the folders + # Get all folders api_response = api_instance.get_folders(limit, offset) pprint(api_response) except ApiException as e: @@ -305,7 +305,7 @@ Name | Type | Description | Notes # **update_folder** > update_folder(folder_id, update_folder) -Update a contact folder +Update a folder ### Example ```python @@ -332,7 +332,7 @@ folder_id = 789 # int | Id of the folder update_folder = sib_api_v3_sdk.CreateUpdateFolder() # CreateUpdateFolder | Name of the folder try: - # Update a contact folder + # Update a folder api_instance.update_folder(folder_id, update_folder) except ApiException as e: print("Exception when calling FoldersApi->update_folder: %s\n" % e) diff --git a/docs/GetTransacBlockedContactsContacts.md b/docs/GetTransacBlockedContactsContacts.md index 9870fbc..130103e 100644 --- a/docs/GetTransacBlockedContactsContacts.md +++ b/docs/GetTransacBlockedContactsContacts.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **email** | **str** | Email address of the blocked or unsubscribed contact | **sender_email** | **str** | Sender email address of the blocked or unsubscribed contact | **reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | | -**blocked_at** | **date** | Date when the contact was blocked or unsubscribed on | +**blocked_at** | **datetime** | Date when the contact was blocked or unsubscribed on | [[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/GetTransacEmailsListTransactionalEmails.md b/docs/GetTransacEmailsListTransactionalEmails.md index 3d4cc26..6c68cf2 100644 --- a/docs/GetTransacEmailsListTransactionalEmails.md +++ b/docs/GetTransacEmailsListTransactionalEmails.md @@ -9,6 +9,8 @@ Name | Type | Description | Notes **message_id** | **str** | Message Id of the sent email | **uuid** | **str** | Unique id of the email sent to a particular contact | **_date** | **datetime** | Date on which transactional email was sent | +**_from** | **str** | Email address of the sender from which the email was sent | [optional] +**tags** | **list[str]** | Tags used for your email | [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/ListsApi.md b/docs/ListsApi.md index 336448b..4123d8e 100644 --- a/docs/ListsApi.md +++ b/docs/ListsApi.md @@ -7,11 +7,11 @@ Method | HTTP request | Description [**add_contact_to_list**](ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list [**create_list**](ListsApi.md#create_list) | **POST** /contacts/lists | Create a list [**delete_list**](ListsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list -[**get_contacts_from_list**](ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list -[**get_folder_lists**](ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -[**get_list**](ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list +[**get_contacts_from_list**](ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list +[**get_folder_lists**](ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +[**get_list**](ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details [**get_lists**](ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists -[**remove_contact_from_list**](ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list +[**remove_contact_from_list**](ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list [**update_list**](ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list @@ -190,7 +190,7 @@ void (empty response body) # **get_contacts_from_list** > GetContacts get_contacts_from_list(list_id, modified_since=modified_since, limit=limit, offset=offset) -Get the contacts in a list +Get contacts in a list ### Example ```python @@ -219,7 +219,7 @@ limit = 50 # int | Number of documents per page (optional) (default to 50) offset = 0 # int | Index of the first document of the page (optional) (default to 0) try: - # Get the contacts in a list + # Get contacts in a list api_response = api_instance.get_contacts_from_list(list_id, modified_since=modified_since, limit=limit, offset=offset) pprint(api_response) except ApiException as e: @@ -253,7 +253,7 @@ Name | Type | Description | Notes # **get_folder_lists** > GetFolderLists get_folder_lists(folder_id, limit=limit, offset=offset) -Get the lists in a folder +Get lists in a folder ### Example ```python @@ -281,7 +281,7 @@ limit = 10 # int | Number of documents per page (optional) (default to 10) offset = 0 # int | Index of the first document of the page (optional) (default to 0) try: - # Get the lists in a folder + # Get lists in a folder api_response = api_instance.get_folder_lists(folder_id, limit=limit, offset=offset) pprint(api_response) except ApiException as e: @@ -314,7 +314,7 @@ Name | Type | Description | Notes # **get_list** > GetExtendedList get_list(list_id) -Get the details of a list +Get a list's details ### Example ```python @@ -340,7 +340,7 @@ api_instance = sib_api_v3_sdk.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) list_id = 789 # int | Id of the list try: - # Get the details of a list + # Get a list's details api_response = api_instance.get_list(list_id) pprint(api_response) except ApiException as e: @@ -430,7 +430,7 @@ Name | Type | Description | Notes # **remove_contact_from_list** > PostContactInfo remove_contact_from_list(list_id, contact_emails) -Remove existing contacts from a list +Delete a contact from a list ### Example ```python @@ -457,7 +457,7 @@ list_id = 789 # int | Id of the list contact_emails = sib_api_v3_sdk.RemoveContactFromList() # RemoveContactFromList | Emails adresses of the contact try: - # Remove existing contacts from a list + # Delete a contact from a list api_response = api_instance.remove_contact_from_list(list_id, contact_emails) pprint(api_response) except ApiException as e: diff --git a/docs/RemainingCreditModelChild.md b/docs/RemainingCreditModelChild.md index 73a94d2..55cfa94 100644 --- a/docs/RemainingCreditModelChild.md +++ b/docs/RemainingCreditModelChild.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sms** | **int** | SMS Credits remaining for child account | -**email** | **int** | Email Credits remaining for child account | +**sms** | **float** | SMS Credits remaining for child account | +**email** | **float** | Email Credits remaining for child account | [[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/RemainingCreditModelReseller.md b/docs/RemainingCreditModelReseller.md index b88b3bc..9daa792 100644 --- a/docs/RemainingCreditModelReseller.md +++ b/docs/RemainingCreditModelReseller.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sms** | **int** | SMS Credits remaining for reseller account | -**email** | **int** | Email Credits remaining for reseller account | +**sms** | **float** | SMS Credits remaining for reseller account | +**email** | **float** | Email Credits remaining for reseller account | [[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/RemoveContactFromList.md b/docs/RemoveContactFromList.md index 14500d3..8f0cd97 100644 --- a/docs/RemoveContactFromList.md +++ b/docs/RemoveContactFromList.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**emails** | **list[str]** | Required if 'all' is false. Emails to remove from a list | [optional] +**emails** | **list[str]** | Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional] **all** | **bool** | Required if 'emails' is empty. Remove all existing contacts from a list | [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/RequestContactExport.md b/docs/RequestContactExport.md index e841601..44b1f93 100644 --- a/docs/RequestContactExport.md +++ b/docs/RequestContactExport.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **export_attributes** | **list[str]** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional] -**contact_filter** | **object** | This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. | [optional] +**contact_filter** | **object** | This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {\"blacklisted\":true} will export all the blacklisted contacts. | [optional] **custom_contact_filter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | [optional] **notify_url** | **str** | Webhook that will be called once the export process is finished | [optional] diff --git a/docs/RequestContactImport.md b/docs/RequestContactImport.md index 03e6852..b26545a 100644 --- a/docs/RequestContactImport.md +++ b/docs/RequestContactImport.md @@ -4,7 +4,7 @@ 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 | [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] **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 export process is finished | [optional] **new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional] diff --git a/docs/ResellerApi.md b/docs/ResellerApi.md index 51b538d..ea5a33a 100644 --- a/docs/ResellerApi.md +++ b/docs/ResellerApi.md @@ -6,20 +6,20 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**add_credits**](ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account [**associate_ip_to_child**](ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child -[**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Creates a domain for a child account +[**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Create a domain for a child account [**create_reseller_child**](ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child -[**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed -[**delete_reseller_child**](ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied +[**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Delete the sender domain of the reseller child based on the childAuthKey and domainName passed +[**delete_reseller_child**](ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Delete a single reseller child based on the childAuthKey supplied [**dissociate_ip_from_child**](ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child -[**get_child_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied -[**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account -[**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account -[**get_reseller_childs**](ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts +[**get_child_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied +[**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Get all sender domains for a specific child account +[**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Get a child account's details +[**get_reseller_childs**](ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Get the list of all children accounts [**get_sso_token**](ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO) [**remove_credits**](ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account -[**update_child_account_status**](ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied -[**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed -[**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied +[**update_child_account_status**](ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Update info of reseller's child account status based on the childAuthKey supplied +[**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Update the sender domain of reseller's child based on the childAuthKey and domainName passed +[**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Update info of reseller's child based on the childAuthKey supplied # **add_credits** @@ -142,7 +142,7 @@ void (empty response body) # **create_child_domain** > create_child_domain(child_auth_key, add_child_domain) -Creates a domain for a child account +Create a domain for a child account ### Example ```python @@ -169,7 +169,7 @@ child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child add_child_domain = sib_api_v3_sdk.AddChildDomain() # AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account. try: - # Creates a domain for a child account + # Create a domain for a child account api_instance.create_child_domain(child_auth_key, add_child_domain) except ApiException as e: print("Exception when calling ResellerApi->create_child_domain: %s\n" % e) @@ -257,7 +257,7 @@ Name | Type | Description | Notes # **delete_child_domain** > delete_child_domain(child_auth_key, domain_name) -Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed +Delete the sender domain of the reseller child based on the childAuthKey and domainName passed ### Example ```python @@ -284,7 +284,7 @@ child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child domain_name = 'domain_name_example' # str | Pass the existing domain that needs to be deleted try: - # Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed + # Delete the sender domain of the reseller child based on the childAuthKey and domainName passed api_instance.delete_child_domain(child_auth_key, domain_name) except ApiException as e: print("Exception when calling ResellerApi->delete_child_domain: %s\n" % e) @@ -315,7 +315,7 @@ void (empty response body) # **delete_reseller_child** > delete_reseller_child(child_auth_key) -Deletes a single reseller child based on the childAuthKey supplied +Delete a single reseller child based on the childAuthKey supplied ### Example ```python @@ -341,7 +341,7 @@ api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child try: - # Deletes a single reseller child based on the childAuthKey supplied + # Delete a single reseller child based on the childAuthKey supplied api_instance.delete_reseller_child(child_auth_key) except ApiException as e: print("Exception when calling ResellerApi->delete_reseller_child: %s\n" % e) @@ -429,7 +429,7 @@ void (empty response body) # **get_child_account_creation_status** > GetChildAccountCreationStatus get_child_account_creation_status(child_auth_key) -Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied +Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied ### Example ```python @@ -455,7 +455,7 @@ api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child try: - # Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied + # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied api_response = api_instance.get_child_account_creation_status(child_auth_key) pprint(api_response) except ApiException as e: @@ -486,7 +486,7 @@ Name | Type | Description | Notes # **get_child_domains** > GetChildDomains get_child_domains(child_auth_key) -Gets all the sender domains of a specific child account +Get all sender domains for a specific child account ### Example ```python @@ -512,7 +512,7 @@ api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child try: - # Gets all the sender domains of a specific child account + # Get all sender domains for a specific child account api_response = api_instance.get_child_domains(child_auth_key) pprint(api_response) except ApiException as e: @@ -543,7 +543,7 @@ Name | Type | Description | Notes # **get_child_info** > GetChildInfo get_child_info(child_auth_key) -Gets the info about a specific child account +Get a child account's details ### Example ```python @@ -569,7 +569,7 @@ api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child try: - # Gets the info about a specific child account + # Get a child account's details api_response = api_instance.get_child_info(child_auth_key) pprint(api_response) except ApiException as e: @@ -600,7 +600,7 @@ Name | Type | Description | Notes # **get_reseller_childs** > GetChildrenList get_reseller_childs(limit=limit, offset=offset) -Gets the list of all reseller's children accounts +Get the list of all children accounts ### Example ```python @@ -627,7 +627,7 @@ limit = 10 # int | Number of documents for child accounts information per page ( offset = 0 # int | Index of the first document in the page (optional) (default to 0) try: - # Gets the list of all reseller's children accounts + # Get the list of all children accounts api_response = api_instance.get_reseller_childs(limit=limit, offset=offset) pprint(api_response) except ApiException as e: @@ -777,7 +777,7 @@ Name | Type | Description | Notes # **update_child_account_status** > update_child_account_status(child_auth_key, update_child_account_status) -Updates infos of reseller's child account status based on the childAuthKey supplied +Update info of reseller's child account status based on the childAuthKey supplied ### Example ```python @@ -804,7 +804,7 @@ child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child update_child_account_status = sib_api_v3_sdk.UpdateChildAccountStatus() # UpdateChildAccountStatus | values to update in child account status try: - # Updates infos of reseller's child account status based on the childAuthKey supplied + # Update info of reseller's child account status based on the childAuthKey supplied api_instance.update_child_account_status(child_auth_key, update_child_account_status) except ApiException as e: print("Exception when calling ResellerApi->update_child_account_status: %s\n" % e) @@ -835,7 +835,7 @@ void (empty response body) # **update_child_domain** > update_child_domain(child_auth_key, domain_name, update_child_domain) -Updates the sender domain of reseller's child based on the childAuthKey and domainName passed +Update the sender domain of reseller's child based on the childAuthKey and domainName passed ### Example ```python @@ -863,7 +863,7 @@ domain_name = 'domain_name_example' # str | Pass the existing domain that needs update_child_domain = sib_api_v3_sdk.UpdateChildDomain() # UpdateChildDomain | value to update for sender domain try: - # Updates the sender domain of reseller's child based on the childAuthKey and domainName passed + # Update the sender domain of reseller's child based on the childAuthKey and domainName passed api_instance.update_child_domain(child_auth_key, domain_name, update_child_domain) except ApiException as e: print("Exception when calling ResellerApi->update_child_domain: %s\n" % e) @@ -895,7 +895,7 @@ void (empty response body) # **update_reseller_child** > update_reseller_child(child_auth_key, reseller_child) -Updates infos of reseller's child based on the childAuthKey supplied +Update info of reseller's child based on the childAuthKey supplied ### Example ```python @@ -922,7 +922,7 @@ child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child reseller_child = sib_api_v3_sdk.UpdateChild() # UpdateChild | values to update in child profile try: - # Updates infos of reseller's child based on the childAuthKey supplied + # Update info of reseller's child based on the childAuthKey supplied api_instance.update_reseller_child(child_auth_key, reseller_child) except ApiException as e: print("Exception when calling ResellerApi->update_reseller_child: %s\n" % e) diff --git a/docs/SMSCampaignsApi.md b/docs/SMSCampaignsApi.md index 5afa04d..7749d52 100644 --- a/docs/SMSCampaignsApi.md +++ b/docs/SMSCampaignsApi.md @@ -5,15 +5,15 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_sms_campaign**](SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign -[**delete_sms_campaign**](SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign +[**delete_sms_campaign**](SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign [**get_sms_campaign**](SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign -[**get_sms_campaigns**](SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns -[**request_sms_recipient_export**](SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign. +[**get_sms_campaigns**](SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns +[**request_sms_recipient_export**](SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients [**send_sms_campaign_now**](SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately -[**send_sms_report**](SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns -[**send_test_sms**](SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS -[**update_sms_campaign**](SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign -[**update_sms_campaign_status**](SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status +[**send_sms_report**](SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report +[**send_test_sms**](SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign +[**update_sms_campaign**](SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign +[**update_sms_campaign_status**](SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status # **create_sms_campaign** @@ -76,7 +76,7 @@ Name | Type | Description | Notes # **delete_sms_campaign** > delete_sms_campaign(campaign_id) -Delete the SMS campaign +Delete an SMS campaign ### Example ```python @@ -102,7 +102,7 @@ api_instance = sib_api_v3_sdk.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configura campaign_id = 789 # int | id of the SMS campaign try: - # Delete the SMS campaign + # Delete an SMS campaign api_instance.delete_sms_campaign(campaign_id) except ApiException as e: print("Exception when calling SMSCampaignsApi->delete_sms_campaign: %s\n" % e) @@ -189,7 +189,7 @@ Name | Type | Description | Notes # **get_sms_campaigns** > GetSmsCampaigns get_sms_campaigns(status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset) -Returns the informations for all your created SMS campaigns +Returns the information for all your created SMS campaigns ### Example ```python @@ -219,7 +219,7 @@ limit = 500 # int | Number limitation for the result returned (optional) (defaul offset = 0 # int | Beginning point in the list to retrieve from. (optional) (default to 0) try: - # Returns the informations for all your created SMS campaigns + # Returns the information for all your created SMS campaigns api_response = api_instance.get_sms_campaigns(status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset) pprint(api_response) except ApiException as e: @@ -254,7 +254,7 @@ Name | Type | Description | Notes # **request_sms_recipient_export** > CreatedProcessId request_sms_recipient_export(campaign_id, recipient_export=recipient_export) -Exports the recipients of the specified campaign. +Export an SMS campaign's recipients It returns the background process ID which on completion calls the notify URL that you have set in the input. @@ -283,7 +283,7 @@ campaign_id = 789 # int | id of the campaign recipient_export = sib_api_v3_sdk.RequestSmsRecipientExport() # RequestSmsRecipientExport | Values to send for a recipient export request (optional) try: - # Exports the recipients of the specified campaign. + # Export an SMS campaign's recipients api_response = api_instance.request_sms_recipient_export(campaign_id, recipient_export=recipient_export) pprint(api_response) except ApiException as e: @@ -371,7 +371,7 @@ void (empty response body) # **send_sms_report** > send_sms_report(campaign_id, send_report) -Send report of SMS campaigns +Send an SMS campaign's report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. @@ -400,7 +400,7 @@ campaign_id = 789 # int | id of the campaign send_report = sib_api_v3_sdk.SendReport() # SendReport | Values for send a report try: - # Send report of SMS campaigns + # Send an SMS campaign's report api_instance.send_sms_report(campaign_id, send_report) except ApiException as e: print("Exception when calling SMSCampaignsApi->send_sms_report: %s\n" % e) @@ -431,7 +431,7 @@ void (empty response body) # **send_test_sms** > send_test_sms(campaign_id, phone_number) -Send an SMS +Send a test SMS campaign ### Example ```python @@ -458,7 +458,7 @@ campaign_id = 789 # int | Id of the SMS campaign phone_number = sib_api_v3_sdk.SendTestSms() # SendTestSms | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted try: - # Send an SMS + # Send a test SMS campaign api_instance.send_test_sms(campaign_id, phone_number) except ApiException as e: print("Exception when calling SMSCampaignsApi->send_test_sms: %s\n" % e) @@ -489,7 +489,7 @@ void (empty response body) # **update_sms_campaign** > update_sms_campaign(campaign_id, update_sms_campaign) -Updates an SMS campaign +Update an SMS campaign ### Example ```python @@ -516,7 +516,7 @@ campaign_id = 789 # int | id of the SMS campaign update_sms_campaign = sib_api_v3_sdk.UpdateSmsCampaign() # UpdateSmsCampaign | Values to update an SMS Campaign try: - # Updates an SMS campaign + # Update an SMS campaign api_instance.update_sms_campaign(campaign_id, update_sms_campaign) except ApiException as e: print("Exception when calling SMSCampaignsApi->update_sms_campaign: %s\n" % e) @@ -547,7 +547,7 @@ void (empty response body) # **update_sms_campaign_status** > update_sms_campaign_status(campaign_id, status) -Update the campaign status +Update a campaign's status ### Example ```python @@ -574,7 +574,7 @@ campaign_id = 789 # int | id of the campaign status = sib_api_v3_sdk.UpdateCampaignStatus() # UpdateCampaignStatus | Status of the campaign. try: - # Update the campaign status + # Update a campaign's status api_instance.update_sms_campaign_status(campaign_id, status) except ApiException as e: print("Exception when calling SMSCampaignsApi->update_sms_campaign_status: %s\n" % e) diff --git a/docs/SMTPApi.md b/docs/SMTPApi.md index 7b06205..a8c576d 100644 --- a/docs/SMTPApi.md +++ b/docs/SMTPApi.md @@ -4,14 +4,14 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_smtp_template**](SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create a transactional email template +[**create_smtp_template**](SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template [**delete_hardbounces**](SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces -[**delete_smtp_template**](SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive transactional email template +[**delete_smtp_template**](SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template [**get_aggregated_smtp_report**](SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time [**get_email_event_report**](SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) [**get_smtp_report**](SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day -[**get_smtp_template**](SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template informations -[**get_smtp_templates**](SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of transactional email templates +[**get_smtp_template**](SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information +[**get_smtp_templates**](SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates [**get_transac_blocked_contacts**](SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts [**get_transac_email_content**](SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email [**get_transac_emails_list**](SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters @@ -20,13 +20,13 @@ Method | HTTP request | Description [**send_transac_email**](SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email [**smtp_blocked_contacts_email_delete**](SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact [**smtp_log_message_id_delete**](SMTPApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log -[**update_smtp_template**](SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates a transactional email templates +[**update_smtp_template**](SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template # **create_smtp_template** > CreateModel create_smtp_template(smtp_template) -Create a transactional email template +Create an email template ### Example ```python @@ -52,7 +52,7 @@ api_instance = sib_api_v3_sdk.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) smtp_template = sib_api_v3_sdk.CreateSmtpTemplate() # CreateSmtpTemplate | values to update in transactional email template try: - # Create a transactional email template + # Create an email template api_response = api_instance.create_smtp_template(smtp_template) pprint(api_response) except ApiException as e: @@ -141,7 +141,7 @@ void (empty response body) # **delete_smtp_template** > delete_smtp_template(template_id) -Delete an inactive transactional email template +Delete an inactive email template ### Example ```python @@ -167,7 +167,7 @@ api_instance = sib_api_v3_sdk.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) template_id = 789 # int | id of the template try: - # Delete an inactive transactional email template + # Delete an inactive email template api_instance.delete_smtp_template(template_id) except ApiException as e: print("Exception when calling SMTPApi->delete_smtp_template: %s\n" % e) @@ -402,7 +402,7 @@ Name | Type | Description | Notes # **get_smtp_template** > GetSmtpTemplateOverview get_smtp_template(template_id) -Returns the template informations +Returns the template information ### Example ```python @@ -428,7 +428,7 @@ api_instance = sib_api_v3_sdk.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) template_id = 789 # int | id of the template try: - # Returns the template informations + # Returns the template information api_response = api_instance.get_smtp_template(template_id) pprint(api_response) except ApiException as e: @@ -459,7 +459,7 @@ Name | Type | Description | Notes # **get_smtp_templates** > GetSmtpTemplates get_smtp_templates(template_status=template_status, limit=limit, offset=offset) -Get the list of transactional email templates +Get the list of email templates ### Example ```python @@ -487,7 +487,7 @@ limit = 50 # int | Number of documents returned per page (optional) (default to offset = 0 # int | Index of the first document in the page (optional) (default to 0) try: - # Get the list of transactional email templates + # Get the list of email templates api_response = api_instance.get_smtp_templates(template_status=template_status, limit=limit, offset=offset) pprint(api_response) except ApiException as e: @@ -670,7 +670,7 @@ api_instance = sib_api_v3_sdk.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) email = 'email_example' # str | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional) template_id = 789 # int | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional) message_id = 'message_id_example' # str | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional) -start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) +start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (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: @@ -688,7 +688,7 @@ Name | Type | Description | Notes **email** | **str**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional] **template_id** | **int**| Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | [optional] **message_id** | **str**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional] - **start_date** | **str**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] + **start_date** | **date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [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 @@ -997,7 +997,7 @@ void (empty response body) # **update_smtp_template** > update_smtp_template(template_id, smtp_template) -Updates a transactional email templates +Update an email template ### Example ```python @@ -1024,7 +1024,7 @@ template_id = 789 # int | id of the template smtp_template = sib_api_v3_sdk.UpdateSmtpTemplate() # UpdateSmtpTemplate | values to update in transactional email template try: - # Updates a transactional email templates + # Update an email template api_instance.update_smtp_template(template_id, smtp_template) except ApiException as e: print("Exception when calling SMTPApi->update_smtp_template: %s\n" % e) diff --git a/docs/SendEmail.md b/docs/SendEmail.md index 8ddaade..8a9c995 100644 --- a/docs/SendEmail.md +++ b/docs/SendEmail.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes **email_cc** | **list[str]** | List of the email addresses of the recipients in cc | [optional] **reply_to** | **str** | Email address which shall be used by campaign recipients to reply back | [optional] **attachment_url** | **str** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] -**attachment** | [**list[SendEmailAttachment]**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. | [optional] -**headers** | **object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional] -**attributes** | **object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional] +**attachment** | [**list[SendEmailAttachment]**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}]. | [optional] +**headers** | **object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, {\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"} | [optional] +**attributes** | **object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"} | [optional] **tags** | **list[str]** | Tag your emails to find them more easily | [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 e126163..7d32329 100644 --- a/docs/SendSmtpEmail.md +++ b/docs/SendSmtpEmail.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional] -**to** | [**list[SendSmtpEmailTo]**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] | +**to** | [**list[SendSmtpEmailTo]**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | **bcc** | [**list[SendSmtpEmailBcc]**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional] **cc** | [**list[SendSmtpEmailCc]**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional] **html_content** | **str** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional] @@ -12,9 +12,9 @@ Name | Type | Description | Notes **subject** | **str** | Subject of the message. Mandatory if 'templateId' is not passed | [optional] **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional] **attachment** | [**list[SendSmtpEmailAttachment]**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] -**headers** | **object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional] +**headers** | **object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional] **template_id** | **int** | Id of the template | [optional] -**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] +**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] **tags** | **list[str]** | Tag your emails to find them more easily | [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/SendersApi.md b/docs/SendersApi.md index 02b5ad4..f0336d3 100644 --- a/docs/SendersApi.md +++ b/docs/SendersApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create_sender**](SendersApi.md#create_sender) | **POST** /senders | Create a new sender [**delete_sender**](SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender -[**get_ips**](SendersApi.md#get_ips) | **GET** /senders/ips | Return all the dedicated IPs for your account -[**get_ips_from_sender**](SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Return all the dedicated IPs for a sender +[**get_ips**](SendersApi.md#get_ips) | **GET** /senders/ips | Get all the dedicated IPs for your account +[**get_ips_from_sender**](SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender [**get_senders**](SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders [**update_sender**](SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender @@ -128,7 +128,7 @@ void (empty response body) # **get_ips** > GetIps get_ips() -Return all the dedicated IPs for your account +Get all the dedicated IPs for your account ### Example ```python @@ -153,7 +153,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' api_instance = sib_api_v3_sdk.SendersApi(sib_api_v3_sdk.ApiClient(configuration)) try: - # Return all the dedicated IPs for your account + # Get all the dedicated IPs for your account api_response = api_instance.get_ips() pprint(api_response) except ApiException as e: @@ -181,7 +181,7 @@ This endpoint does not need any parameter. # **get_ips_from_sender** > GetIpsFromSender get_ips_from_sender(sender_id) -Return all the dedicated IPs for a sender +Get all the dedicated IPs for a sender ### Example ```python @@ -207,7 +207,7 @@ api_instance = sib_api_v3_sdk.SendersApi(sib_api_v3_sdk.ApiClient(configuration) sender_id = 789 # int | Id of the sender try: - # Return all the dedicated IPs for a sender + # Get all the dedicated IPs for a sender api_response = api_instance.get_ips_from_sender(sender_id) pprint(api_response) except ApiException as e: diff --git a/docs/TransactionalSMSApi.md b/docs/TransactionalSMSApi.md index 7e7fd20..cb073c7 100644 --- a/docs/TransactionalSMSApi.md +++ b/docs/TransactionalSMSApi.md @@ -4,16 +4,16 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_sms_events**](TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all the SMS activity (unaggregated events) +[**get_sms_events**](TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) [**get_transac_aggregated_sms_report**](TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time [**get_transac_sms_report**](TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day -[**send_transac_sms**](TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to the specified mobile number +[**send_transac_sms**](TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to a mobile number # **get_sms_events** > GetSmsEventReport get_sms_events(limit=limit, start_date=start_date, end_date=end_date, offset=offset, days=days, phone_number=phone_number, event=event, tags=tags) -Get all the SMS activity (unaggregated events) +Get all your SMS activity (unaggregated events) ### Example ```python @@ -46,7 +46,7 @@ event = 'event_example' # str | Filter the report for specific events (optional) tags = 'tags_example' # str | Filter the report for specific tags passed as a serialized urlencoded array (optional) try: - # Get all the SMS activity (unaggregated events) + # Get all your SMS activity (unaggregated events) api_response = api_instance.get_sms_events(limit=limit, start_date=start_date, end_date=end_date, offset=offset, days=days, phone_number=phone_number, event=event, tags=tags) pprint(api_response) except ApiException as e: @@ -210,7 +210,7 @@ Name | Type | Description | Notes # **send_transac_sms** > SendSms send_transac_sms(send_transac_sms) -Send the SMS campaign to the specified mobile number +Send the SMS campaign to a mobile number ### Example ```python @@ -236,7 +236,7 @@ api_instance = sib_api_v3_sdk.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(confi send_transac_sms = sib_api_v3_sdk.SendTransacSms() # SendTransacSms | Values to send a transactional SMS try: - # Send the SMS campaign to the specified mobile number + # Send the SMS campaign to a mobile number api_response = api_instance.send_transac_sms(send_transac_sms) pprint(api_response) except ApiException as e: diff --git a/docs/UpdateAttribute.md b/docs/UpdateAttribute.md index b1efb93..e32536a 100644 --- a/docs/UpdateAttribute.md +++ b/docs/UpdateAttribute.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **str** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional] -**enumeration** | [**list[UpdateAttributeEnumeration]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional] +**enumeration** | [**list[UpdateAttributeEnumeration]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional] [[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/UpdateContact.md b/docs/UpdateContact.md index 9ccf9ad..8e2e03e 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'} `{ \"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 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] **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 ce5015d..c07d8a6 100644 --- a/docs/UpdateEmailCampaign.md +++ b/docs/UpdateEmailCampaign.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **footer** | **str** | Footer of the email campaign | [optional] **header** | **str** | Header of the email campaign | [optional] **utm_campaign** | **str** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] -**params** | **object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] +**params** | **object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] **send_at_best_time** | **bool** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [optional] **ab_testing** | **bool** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to False] **subject_a** | **str** | Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional] diff --git a/docs/UploadImageToGallery.md b/docs/UploadImageToGallery.md new file mode 100644 index 0000000..0f7bbed --- /dev/null +++ b/docs/UploadImageToGallery.md @@ -0,0 +1,11 @@ +# UploadImageToGallery + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**image_url** | **str** | The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. | +**name** | **str** | Name of the image. | [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/setup.py b/setup.py index ec7faad..55e1a4b 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 = "6.1.0" +VERSION = "6.2.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 f0a11f9..c1e2f7c 100644 --- a/sib_api_v3_sdk/__init__.py +++ b/sib_api_v3_sdk/__init__.py @@ -42,6 +42,7 @@ from sib_api_v3_sdk.models.create_attribute_enumeration import CreateAttributeEnumeration from sib_api_v3_sdk.models.create_child import CreateChild from sib_api_v3_sdk.models.create_contact import CreateContact +from sib_api_v3_sdk.models.create_doi_contact import CreateDoiContact from sib_api_v3_sdk.models.create_email_campaign import CreateEmailCampaign from sib_api_v3_sdk.models.create_email_campaign_recipients import CreateEmailCampaignRecipients from sib_api_v3_sdk.models.create_email_campaign_sender import CreateEmailCampaignSender @@ -195,6 +196,7 @@ from sib_api_v3_sdk.models.update_smtp_template import UpdateSmtpTemplate from sib_api_v3_sdk.models.update_smtp_template_sender import UpdateSmtpTemplateSender from sib_api_v3_sdk.models.update_webhook import UpdateWebhook +from sib_api_v3_sdk.models.upload_image_to_gallery import UploadImageToGallery from sib_api_v3_sdk.models.get_child_info import GetChildInfo from sib_api_v3_sdk.models.get_extended_campaign_overview import GetExtendedCampaignOverview from sib_api_v3_sdk.models.get_extended_client import GetExtendedClient diff --git a/sib_api_v3_sdk/api/account_api.py b/sib_api_v3_sdk/api/account_api.py index 21206b0..4eda387 100644 --- a/sib_api_v3_sdk/api/account_api.py +++ b/sib_api_v3_sdk/api/account_api.py @@ -34,7 +34,7 @@ def __init__(self, api_client=None): self.api_client = api_client def get_account(self, **kwargs): # noqa: E501 - """Get your account informations, plans and credits details # noqa: E501 + """Get your account information, plan and credits details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -54,7 +54,7 @@ def get_account(self, **kwargs): # noqa: E501 return data def get_account_with_http_info(self, **kwargs): # noqa: E501 - """Get your account informations, plans and credits details # noqa: E501 + """Get your account information, plan and credits details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/api/attributes_api.py b/sib_api_v3_sdk/api/attributes_api.py index 1e5bc67..aac9e2b 100644 --- a/sib_api_v3_sdk/api/attributes_api.py +++ b/sib_api_v3_sdk/api/attributes_api.py @@ -34,7 +34,7 @@ def __init__(self, api_client=None): self.api_client = api_client def create_attribute(self, attribute_category, attribute_name, create_attribute, **kwargs): # noqa: E501 - """Creates contact attribute # noqa: E501 + """Create contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -57,7 +57,7 @@ def create_attribute(self, attribute_category, attribute_name, create_attribute, return data def create_attribute_with_http_info(self, attribute_category, attribute_name, create_attribute, **kwargs): # noqa: E501 - """Creates contact attribute # noqa: E501 + """Create contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -147,7 +147,7 @@ def create_attribute_with_http_info(self, attribute_category, attribute_name, cr collection_formats=collection_formats) def delete_attribute(self, attribute_category, attribute_name, **kwargs): # noqa: E501 - """Deletes an attribute # noqa: E501 + """Delete an attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -169,7 +169,7 @@ def delete_attribute(self, attribute_category, attribute_name, **kwargs): # noq return data def delete_attribute_with_http_info(self, attribute_category, attribute_name, **kwargs): # noqa: E501 - """Deletes an attribute # noqa: E501 + """Delete an attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -252,7 +252,7 @@ def delete_attribute_with_http_info(self, attribute_category, attribute_name, ** collection_formats=collection_formats) def get_attributes(self, **kwargs): # noqa: E501 - """Lists all attributes # noqa: E501 + """List all attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -272,7 +272,7 @@ def get_attributes(self, **kwargs): # noqa: E501 return data def get_attributes_with_http_info(self, **kwargs): # noqa: E501 - """Lists all attributes # noqa: E501 + """List all attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -341,7 +341,7 @@ def get_attributes_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def update_attribute(self, attribute_category, attribute_name, update_attribute, **kwargs): # noqa: E501 - """Updates contact attribute # noqa: E501 + """Update contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -364,7 +364,7 @@ def update_attribute(self, attribute_category, attribute_name, update_attribute, return data def update_attribute_with_http_info(self, attribute_category, attribute_name, update_attribute, **kwargs): # noqa: E501 - """Updates contact attribute # noqa: E501 + """Update contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/api/contacts_api.py b/sib_api_v3_sdk/api/contacts_api.py index 9d5337e..1cc87bf 100644 --- a/sib_api_v3_sdk/api/contacts_api.py +++ b/sib_api_v3_sdk/api/contacts_api.py @@ -139,7 +139,7 @@ def add_contact_to_list_with_http_info(self, list_id, contact_emails, **kwargs): collection_formats=collection_formats) def create_attribute(self, attribute_category, attribute_name, create_attribute, **kwargs): # noqa: E501 - """Creates contact attribute # noqa: E501 + """Create contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -162,7 +162,7 @@ def create_attribute(self, attribute_category, attribute_name, create_attribute, return data def create_attribute_with_http_info(self, attribute_category, attribute_name, create_attribute, **kwargs): # noqa: E501 - """Creates contact attribute # noqa: E501 + """Create contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -348,6 +348,103 @@ def create_contact_with_http_info(self, create_contact, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def create_doi_contact(self, create_doi_contact, **kwargs): # noqa: E501 + """Create a contact to trigger the DOI workflow from a Landing Page form # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_doi_contact(create_doi_contact, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateDoiContact create_doi_contact: Values to create the DOI contact (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.create_doi_contact_with_http_info(create_doi_contact, **kwargs) # noqa: E501 + else: + (data) = self.create_doi_contact_with_http_info(create_doi_contact, **kwargs) # noqa: E501 + return data + + def create_doi_contact_with_http_info(self, create_doi_contact, **kwargs): # noqa: E501 + """Create a contact to trigger the DOI workflow from a Landing Page form # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_doi_contact_with_http_info(create_doi_contact, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateDoiContact create_doi_contact: Values to create the DOI contact (required) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['create_doi_contact'] # 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 create_doi_contact" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'create_doi_contact' is set + if ('create_doi_contact' not in params or + params['create_doi_contact'] is None): + raise ValueError("Missing the required parameter `create_doi_contact` when calling `create_doi_contact`") # noqa: E501 + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'create_doi_contact' in params: + body_params = params['create_doi_contact'] + # 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( + '/contacts/doubleOptinConfirmation', 'POST', + 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 create_folder(self, create_folder, **kwargs): # noqa: E501 """Create a folder # noqa: E501 @@ -543,7 +640,7 @@ def create_list_with_http_info(self, create_list, **kwargs): # noqa: E501 collection_formats=collection_formats) def delete_attribute(self, attribute_category, attribute_name, **kwargs): # noqa: E501 - """Deletes an attribute # noqa: E501 + """Delete an attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -565,7 +662,7 @@ def delete_attribute(self, attribute_category, attribute_name, **kwargs): # noq return data def delete_attribute_with_http_info(self, attribute_category, attribute_name, **kwargs): # noqa: E501 - """Deletes an attribute # noqa: E501 + """Delete an attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -648,7 +745,7 @@ def delete_attribute_with_http_info(self, attribute_category, attribute_name, ** collection_formats=collection_formats) def delete_contact(self, email, **kwargs): # noqa: E501 - """Deletes a contact # noqa: E501 + """Delete a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -669,7 +766,7 @@ def delete_contact(self, email, **kwargs): # noqa: E501 return data def delete_contact_with_http_info(self, email, **kwargs): # noqa: E501 - """Deletes a contact # noqa: E501 + """Delete a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -939,7 +1036,7 @@ def delete_list_with_http_info(self, list_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_attributes(self, **kwargs): # noqa: E501 - """Lists all attributes # noqa: E501 + """List all attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -959,7 +1056,7 @@ def get_attributes(self, **kwargs): # noqa: E501 return data def get_attributes_with_http_info(self, **kwargs): # noqa: E501 - """Lists all attributes # noqa: E501 + """List all attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1028,7 +1125,7 @@ def get_attributes_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_contact_info(self, email, **kwargs): # noqa: E501 - """Retrieves contact informations # noqa: E501 + """Get a contact's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1049,7 +1146,7 @@ def get_contact_info(self, email, **kwargs): # noqa: E501 return data def get_contact_info_with_http_info(self, email, **kwargs): # noqa: E501 - """Retrieves contact informations # noqa: E501 + """Get a contact's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1125,7 +1222,7 @@ def get_contact_info_with_http_info(self, email, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_contact_stats(self, email, **kwargs): # noqa: E501 - """Get the campaigns statistics for a contact # noqa: E501 + """Get email campaigns' statistics for a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1134,6 +1231,8 @@ def get_contact_stats(self, email, **kwargs): # noqa: E501 :param async_req bool :param str email: Email address (urlencoded) of the contact (required) + :param date 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 date 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: GetContactCampaignStats If the method is called asynchronously, returns the request thread. @@ -1146,7 +1245,7 @@ def get_contact_stats(self, email, **kwargs): # noqa: E501 return data def get_contact_stats_with_http_info(self, email, **kwargs): # noqa: E501 - """Get the campaigns statistics for a contact # noqa: E501 + """Get email campaigns' statistics for a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1155,12 +1254,14 @@ def get_contact_stats_with_http_info(self, email, **kwargs): # noqa: E501 :param async_req bool :param str email: Email address (urlencoded) of the contact (required) + :param date 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 date 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: GetContactCampaignStats If the method is called asynchronously, returns the request thread. """ - all_params = ['email'] # noqa: E501 + all_params = ['email', 'start_date', 'end_date'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1187,6 +1288,10 @@ def get_contact_stats_with_http_info(self, email, **kwargs): # noqa: E501 path_params['email'] = params['email'] # 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 = {} @@ -1325,7 +1430,7 @@ def get_contacts_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_contacts_from_list(self, list_id, **kwargs): # noqa: E501 - """Get the contacts in a list # noqa: E501 + """Get contacts in a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1349,7 +1454,7 @@ def get_contacts_from_list(self, list_id, **kwargs): # noqa: E501 return data def get_contacts_from_list_with_http_info(self, list_id, **kwargs): # noqa: E501 - """Get the contacts in a list # noqa: E501 + """Get contacts in a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1436,7 +1541,7 @@ def get_contacts_from_list_with_http_info(self, list_id, **kwargs): # noqa: E50 collection_formats=collection_formats) def get_folder(self, folder_id, **kwargs): # noqa: E501 - """Returns folder details # noqa: E501 + """Returns a folder's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1457,7 +1562,7 @@ def get_folder(self, folder_id, **kwargs): # noqa: E501 return data def get_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 - """Returns folder details # noqa: E501 + """Returns a folder's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1533,7 +1638,7 @@ def get_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_folder_lists(self, folder_id, **kwargs): # noqa: E501 - """Get the lists in a folder # noqa: E501 + """Get lists in a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1556,7 +1661,7 @@ def get_folder_lists(self, folder_id, **kwargs): # noqa: E501 return data def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 - """Get the lists in a folder # noqa: E501 + """Get lists in a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1640,7 +1745,7 @@ def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_folders(self, limit, offset, **kwargs): # noqa: E501 - """Get all the folders # noqa: E501 + """Get all folders # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1662,7 +1767,7 @@ def get_folders(self, limit, offset, **kwargs): # noqa: E501 return data def get_folders_with_http_info(self, limit, offset, **kwargs): # noqa: E501 - """Get all the folders # noqa: E501 + """Get all folders # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1747,7 +1852,7 @@ def get_folders_with_http_info(self, limit, offset, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_list(self, list_id, **kwargs): # noqa: E501 - """Get the details of a list # noqa: E501 + """Get a list's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1768,7 +1873,7 @@ def get_list(self, list_id, **kwargs): # noqa: E501 return data def get_list_with_http_info(self, list_id, **kwargs): # noqa: E501 - """Get the details of a list # noqa: E501 + """Get a list's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2042,7 +2147,7 @@ def import_contacts_with_http_info(self, request_contact_import, **kwargs): # n collection_formats=collection_formats) def remove_contact_from_list(self, list_id, contact_emails, **kwargs): # noqa: E501 - """Remove existing contacts from a list # noqa: E501 + """Delete a contact from a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2064,7 +2169,7 @@ def remove_contact_from_list(self, list_id, contact_emails, **kwargs): # noqa: return data def remove_contact_from_list_with_http_info(self, list_id, contact_emails, **kwargs): # noqa: E501 - """Remove existing contacts from a list # noqa: E501 + """Delete a contact from a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2246,7 +2351,7 @@ def request_contact_export_with_http_info(self, request_contact_export, **kwargs collection_formats=collection_formats) def update_attribute(self, attribute_category, attribute_name, update_attribute, **kwargs): # noqa: E501 - """Updates contact attribute # noqa: E501 + """Update contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2269,7 +2374,7 @@ def update_attribute(self, attribute_category, attribute_name, update_attribute, return data def update_attribute_with_http_info(self, attribute_category, attribute_name, update_attribute, **kwargs): # noqa: E501 - """Updates contact attribute # noqa: E501 + """Update contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2359,7 +2464,7 @@ def update_attribute_with_http_info(self, attribute_category, attribute_name, up collection_formats=collection_formats) def update_contact(self, email, update_contact, **kwargs): # noqa: E501 - """Updates a contact # noqa: E501 + """Update a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2381,7 +2486,7 @@ def update_contact(self, email, update_contact, **kwargs): # noqa: E501 return data def update_contact_with_http_info(self, email, update_contact, **kwargs): # noqa: E501 - """Updates a contact # noqa: E501 + """Update a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2464,7 +2569,7 @@ def update_contact_with_http_info(self, email, update_contact, **kwargs): # noq collection_formats=collection_formats) def update_folder(self, folder_id, update_folder, **kwargs): # noqa: E501 - """Update a contact folder # noqa: E501 + """Update a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2486,7 +2591,7 @@ def update_folder(self, folder_id, update_folder, **kwargs): # noqa: E501 return data def update_folder_with_http_info(self, folder_id, update_folder, **kwargs): # noqa: E501 - """Update a contact folder # noqa: E501 + """Update a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/api/email_campaigns_api.py b/sib_api_v3_sdk/api/email_campaigns_api.py index d644c3c..3dfe94f 100644 --- a/sib_api_v3_sdk/api/email_campaigns_api.py +++ b/sib_api_v3_sdk/api/email_campaigns_api.py @@ -228,7 +228,7 @@ def delete_email_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: collection_formats=collection_formats) def email_export_recipients(self, campaign_id, **kwargs): # noqa: E501 - """Export the recipients of a campaign # noqa: E501 + """Export the recipients of an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -250,7 +250,7 @@ def email_export_recipients(self, campaign_id, **kwargs): # noqa: E501 return data def email_export_recipients_with_http_info(self, campaign_id, **kwargs): # noqa: E501 - """Export the recipients of a campaign # noqa: E501 + """Export the recipients of an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -329,7 +329,7 @@ def email_export_recipients_with_http_info(self, campaign_id, **kwargs): # noqa collection_formats=collection_formats) def get_ab_test_campaign_result(self, campaign_id, **kwargs): # noqa: E501 - """Get A/B test email campaign result # noqa: E501 + """Get an A/B test email campaign results # noqa: E501 Obtain winning version of an A/B test email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -351,7 +351,7 @@ def get_ab_test_campaign_result(self, campaign_id, **kwargs): # noqa: E501 return data def get_ab_test_campaign_result_with_http_info(self, campaign_id, **kwargs): # noqa: E501 - """Get A/B test email campaign result # noqa: E501 + """Get an A/B test email campaign results # noqa: E501 Obtain winning version of an A/B test email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -428,7 +428,7 @@ def get_ab_test_campaign_result_with_http_info(self, campaign_id, **kwargs): # collection_formats=collection_formats) def get_email_campaign(self, campaign_id, **kwargs): # noqa: E501 - """Get campaign informations # noqa: E501 + """Get an email campaign report # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -449,7 +449,7 @@ def get_email_campaign(self, campaign_id, **kwargs): # noqa: E501 return data def get_email_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501 - """Get campaign informations # noqa: E501 + """Get an email campaign report # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -525,7 +525,7 @@ def get_email_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E50 collection_formats=collection_formats) def get_email_campaigns(self, **kwargs): # noqa: E501 - """Return all your created campaigns # noqa: E501 + """Return all your created email campaigns # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -551,7 +551,7 @@ def get_email_campaigns(self, **kwargs): # noqa: E501 return data def get_email_campaigns_with_http_info(self, **kwargs): # noqa: E501 - """Return all your created campaigns # noqa: E501 + """Return all your created email campaigns # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -836,7 +836,7 @@ def send_email_campaign_now_with_http_info(self, campaign_id, **kwargs): # noqa collection_formats=collection_formats) def send_report(self, campaign_id, send_report, **kwargs): # noqa: E501 - """Send the report of a campaigns # noqa: E501 + """Send the report of a campaign # noqa: E501 A PDF will be sent to the specified email addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -859,7 +859,7 @@ def send_report(self, campaign_id, send_report, **kwargs): # noqa: E501 return data def send_report_with_http_info(self, campaign_id, send_report, **kwargs): # noqa: E501 - """Send the report of a campaigns # noqa: E501 + """Send the report of a campaign # noqa: E501 A PDF will be sent to the specified email addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -1048,7 +1048,7 @@ def send_test_email_with_http_info(self, campaign_id, email_to, **kwargs): # no collection_formats=collection_formats) def update_campaign_status(self, campaign_id, status, **kwargs): # noqa: E501 - """Update a campaign status # noqa: E501 + """Update an email campaign status # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1070,7 +1070,7 @@ def update_campaign_status(self, campaign_id, status, **kwargs): # noqa: E501 return data def update_campaign_status_with_http_info(self, campaign_id, status, **kwargs): # noqa: E501 - """Update a campaign status # noqa: E501 + """Update an email campaign status # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1153,7 +1153,7 @@ def update_campaign_status_with_http_info(self, campaign_id, status, **kwargs): collection_formats=collection_formats) def update_email_campaign(self, campaign_id, email_campaign, **kwargs): # noqa: E501 - """Update a campaign # noqa: E501 + """Update an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1175,7 +1175,7 @@ def update_email_campaign(self, campaign_id, email_campaign, **kwargs): # noqa: return data def update_email_campaign_with_http_info(self, campaign_id, email_campaign, **kwargs): # noqa: E501 - """Update a campaign # noqa: E501 + """Update an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1256,3 +1256,100 @@ def update_email_campaign_with_http_info(self, campaign_id, email_campaign, **kw _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + + def upload_image_to_gallery(self, upload_image, **kwargs): # noqa: E501 + """Upload an image to your account's image gallery # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upload_image_to_gallery(upload_image, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UploadImageToGallery upload_image: Parameters to upload an image (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.upload_image_to_gallery_with_http_info(upload_image, **kwargs) # noqa: E501 + else: + (data) = self.upload_image_to_gallery_with_http_info(upload_image, **kwargs) # noqa: E501 + return data + + def upload_image_to_gallery_with_http_info(self, upload_image, **kwargs): # noqa: E501 + """Upload an image to your account's image gallery # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upload_image_to_gallery_with_http_info(upload_image, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UploadImageToGallery upload_image: Parameters to upload an image (required) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['upload_image'] # 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 upload_image_to_gallery" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'upload_image' is set + if ('upload_image' not in params or + params['upload_image'] is None): + raise ValueError("Missing the required parameter `upload_image` when calling `upload_image_to_gallery`") # noqa: E501 + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'upload_image' in params: + body_params = params['upload_image'] + # 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( + '/emailCampaigns/images', 'POST', + 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) diff --git a/sib_api_v3_sdk/api/folders_api.py b/sib_api_v3_sdk/api/folders_api.py index 4d87d19..974a502 100644 --- a/sib_api_v3_sdk/api/folders_api.py +++ b/sib_api_v3_sdk/api/folders_api.py @@ -228,7 +228,7 @@ def delete_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_folder(self, folder_id, **kwargs): # noqa: E501 - """Returns folder details # noqa: E501 + """Returns a folder's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -249,7 +249,7 @@ def get_folder(self, folder_id, **kwargs): # noqa: E501 return data def get_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 - """Returns folder details # noqa: E501 + """Returns a folder's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -325,7 +325,7 @@ def get_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_folder_lists(self, folder_id, **kwargs): # noqa: E501 - """Get the lists in a folder # noqa: E501 + """Get lists in a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -348,7 +348,7 @@ def get_folder_lists(self, folder_id, **kwargs): # noqa: E501 return data def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 - """Get the lists in a folder # noqa: E501 + """Get lists in a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -432,7 +432,7 @@ def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_folders(self, limit, offset, **kwargs): # noqa: E501 - """Get all the folders # noqa: E501 + """Get all folders # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -454,7 +454,7 @@ def get_folders(self, limit, offset, **kwargs): # noqa: E501 return data def get_folders_with_http_info(self, limit, offset, **kwargs): # noqa: E501 - """Get all the folders # noqa: E501 + """Get all folders # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -539,7 +539,7 @@ def get_folders_with_http_info(self, limit, offset, **kwargs): # noqa: E501 collection_formats=collection_formats) def update_folder(self, folder_id, update_folder, **kwargs): # noqa: E501 - """Update a contact folder # noqa: E501 + """Update a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -561,7 +561,7 @@ def update_folder(self, folder_id, update_folder, **kwargs): # noqa: E501 return data def update_folder_with_http_info(self, folder_id, update_folder, **kwargs): # noqa: E501 - """Update a contact folder # noqa: E501 + """Update a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/api/lists_api.py b/sib_api_v3_sdk/api/lists_api.py index 9fde2ce..db19356 100644 --- a/sib_api_v3_sdk/api/lists_api.py +++ b/sib_api_v3_sdk/api/lists_api.py @@ -333,7 +333,7 @@ def delete_list_with_http_info(self, list_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_contacts_from_list(self, list_id, **kwargs): # noqa: E501 - """Get the contacts in a list # noqa: E501 + """Get contacts in a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -357,7 +357,7 @@ def get_contacts_from_list(self, list_id, **kwargs): # noqa: E501 return data def get_contacts_from_list_with_http_info(self, list_id, **kwargs): # noqa: E501 - """Get the contacts in a list # noqa: E501 + """Get contacts in a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -444,7 +444,7 @@ def get_contacts_from_list_with_http_info(self, list_id, **kwargs): # noqa: E50 collection_formats=collection_formats) def get_folder_lists(self, folder_id, **kwargs): # noqa: E501 - """Get the lists in a folder # noqa: E501 + """Get lists in a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -467,7 +467,7 @@ def get_folder_lists(self, folder_id, **kwargs): # noqa: E501 return data def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 - """Get the lists in a folder # noqa: E501 + """Get lists in a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -551,7 +551,7 @@ def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_list(self, list_id, **kwargs): # noqa: E501 - """Get the details of a list # noqa: E501 + """Get a list's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -572,7 +572,7 @@ def get_list(self, list_id, **kwargs): # noqa: E501 return data def get_list_with_http_info(self, list_id, **kwargs): # noqa: E501 - """Get the details of a list # noqa: E501 + """Get a list's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -747,7 +747,7 @@ def get_lists_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def remove_contact_from_list(self, list_id, contact_emails, **kwargs): # noqa: E501 - """Remove existing contacts from a list # noqa: E501 + """Delete a contact from a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -769,7 +769,7 @@ def remove_contact_from_list(self, list_id, contact_emails, **kwargs): # noqa: return data def remove_contact_from_list_with_http_info(self, list_id, contact_emails, **kwargs): # noqa: E501 - """Remove existing contacts from a list # noqa: E501 + """Delete a contact from a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/api/reseller_api.py b/sib_api_v3_sdk/api/reseller_api.py index 39aa6e8..643c065 100644 --- a/sib_api_v3_sdk/api/reseller_api.py +++ b/sib_api_v3_sdk/api/reseller_api.py @@ -244,7 +244,7 @@ def associate_ip_to_child_with_http_info(self, child_auth_key, ip, **kwargs): # collection_formats=collection_formats) def create_child_domain(self, child_auth_key, add_child_domain, **kwargs): # noqa: E501 - """Creates a domain for a child account # noqa: E501 + """Create a domain for a child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -266,7 +266,7 @@ def create_child_domain(self, child_auth_key, add_child_domain, **kwargs): # no return data def create_child_domain_with_http_info(self, child_auth_key, add_child_domain, **kwargs): # noqa: E501 - """Creates a domain for a child account # noqa: E501 + """Create a domain for a child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -442,7 +442,7 @@ def create_reseller_child_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def delete_child_domain(self, child_auth_key, domain_name, **kwargs): # noqa: E501 - """Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed # noqa: E501 + """Delete the sender domain of the reseller child based on the childAuthKey and domainName passed # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -464,7 +464,7 @@ def delete_child_domain(self, child_auth_key, domain_name, **kwargs): # noqa: E return data def delete_child_domain_with_http_info(self, child_auth_key, domain_name, **kwargs): # noqa: E501 - """Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed # noqa: E501 + """Delete the sender domain of the reseller child based on the childAuthKey and domainName passed # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -547,7 +547,7 @@ def delete_child_domain_with_http_info(self, child_auth_key, domain_name, **kwar collection_formats=collection_formats) def delete_reseller_child(self, child_auth_key, **kwargs): # noqa: E501 - """Deletes a single reseller child based on the childAuthKey supplied # noqa: E501 + """Delete a single reseller child based on the childAuthKey supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -568,7 +568,7 @@ def delete_reseller_child(self, child_auth_key, **kwargs): # noqa: E501 return data def delete_reseller_child_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 - """Deletes a single reseller child based on the childAuthKey supplied # noqa: E501 + """Delete a single reseller child based on the childAuthKey supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -749,7 +749,7 @@ def dissociate_ip_from_child_with_http_info(self, child_auth_key, ip, **kwargs): collection_formats=collection_formats) def get_child_account_creation_status(self, child_auth_key, **kwargs): # noqa: E501 - """Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied # noqa: E501 + """Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -770,7 +770,7 @@ def get_child_account_creation_status(self, child_auth_key, **kwargs): # noqa: return data def get_child_account_creation_status_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 - """Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied # noqa: E501 + """Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -846,7 +846,7 @@ def get_child_account_creation_status_with_http_info(self, child_auth_key, **kwa collection_formats=collection_formats) def get_child_domains(self, child_auth_key, **kwargs): # noqa: E501 - """Gets all the sender domains of a specific child account # noqa: E501 + """Get all sender domains for a specific child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -867,7 +867,7 @@ def get_child_domains(self, child_auth_key, **kwargs): # noqa: E501 return data def get_child_domains_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 - """Gets all the sender domains of a specific child account # noqa: E501 + """Get all sender domains for a specific child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -943,7 +943,7 @@ def get_child_domains_with_http_info(self, child_auth_key, **kwargs): # noqa: E collection_formats=collection_formats) def get_child_info(self, child_auth_key, **kwargs): # noqa: E501 - """Gets the info about a specific child account # noqa: E501 + """Get a child account's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -964,7 +964,7 @@ def get_child_info(self, child_auth_key, **kwargs): # noqa: E501 return data def get_child_info_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 - """Gets the info about a specific child account # noqa: E501 + """Get a child account's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1040,7 +1040,7 @@ def get_child_info_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_reseller_childs(self, **kwargs): # noqa: E501 - """Gets the list of all reseller's children accounts # noqa: E501 + """Get the list of all children accounts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1062,7 +1062,7 @@ def get_reseller_childs(self, **kwargs): # noqa: E501 return data def get_reseller_childs_with_http_info(self, **kwargs): # noqa: E501 - """Gets the list of all reseller's children accounts # noqa: E501 + """Get the list of all children accounts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1343,7 +1343,7 @@ def remove_credits_with_http_info(self, child_auth_key, remove_credits, **kwargs collection_formats=collection_formats) def update_child_account_status(self, child_auth_key, update_child_account_status, **kwargs): # noqa: E501 - """Updates infos of reseller's child account status based on the childAuthKey supplied # noqa: E501 + """Update info of reseller's child account status based on the childAuthKey supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1365,7 +1365,7 @@ def update_child_account_status(self, child_auth_key, update_child_account_statu return data def update_child_account_status_with_http_info(self, child_auth_key, update_child_account_status, **kwargs): # noqa: E501 - """Updates infos of reseller's child account status based on the childAuthKey supplied # noqa: E501 + """Update info of reseller's child account status based on the childAuthKey supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1448,7 +1448,7 @@ def update_child_account_status_with_http_info(self, child_auth_key, update_chil collection_formats=collection_formats) def update_child_domain(self, child_auth_key, domain_name, update_child_domain, **kwargs): # noqa: E501 - """Updates the sender domain of reseller's child based on the childAuthKey and domainName passed # noqa: E501 + """Update the sender domain of reseller's child based on the childAuthKey and domainName passed # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1471,7 +1471,7 @@ def update_child_domain(self, child_auth_key, domain_name, update_child_domain, return data def update_child_domain_with_http_info(self, child_auth_key, domain_name, update_child_domain, **kwargs): # noqa: E501 - """Updates the sender domain of reseller's child based on the childAuthKey and domainName passed # noqa: E501 + """Update the sender domain of reseller's child based on the childAuthKey and domainName passed # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1561,7 +1561,7 @@ def update_child_domain_with_http_info(self, child_auth_key, domain_name, update collection_formats=collection_formats) def update_reseller_child(self, child_auth_key, reseller_child, **kwargs): # noqa: E501 - """Updates infos of reseller's child based on the childAuthKey supplied # noqa: E501 + """Update info of reseller's child based on the childAuthKey supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1583,7 +1583,7 @@ def update_reseller_child(self, child_auth_key, reseller_child, **kwargs): # no return data def update_reseller_child_with_http_info(self, child_auth_key, reseller_child, **kwargs): # noqa: E501 - """Updates infos of reseller's child based on the childAuthKey supplied # noqa: E501 + """Update info of reseller's child based on the childAuthKey supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/api/senders_api.py b/sib_api_v3_sdk/api/senders_api.py index d8094e9..7464df7 100644 --- a/sib_api_v3_sdk/api/senders_api.py +++ b/sib_api_v3_sdk/api/senders_api.py @@ -224,7 +224,7 @@ def delete_sender_with_http_info(self, sender_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_ips(self, **kwargs): # noqa: E501 - """Return all the dedicated IPs for your account # noqa: E501 + """Get all the dedicated IPs for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -244,7 +244,7 @@ def get_ips(self, **kwargs): # noqa: E501 return data def get_ips_with_http_info(self, **kwargs): # noqa: E501 - """Return all the dedicated IPs for your account # noqa: E501 + """Get all the dedicated IPs for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -313,7 +313,7 @@ def get_ips_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_ips_from_sender(self, sender_id, **kwargs): # noqa: E501 - """Return all the dedicated IPs for a sender # noqa: E501 + """Get all the dedicated IPs for a sender # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -334,7 +334,7 @@ def get_ips_from_sender(self, sender_id, **kwargs): # noqa: E501 return data def get_ips_from_sender_with_http_info(self, sender_id, **kwargs): # noqa: E501 - """Return all the dedicated IPs for a sender # noqa: E501 + """Get all the dedicated IPs for a sender # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/api/sms_campaigns_api.py b/sib_api_v3_sdk/api/sms_campaigns_api.py index 0f25c01..21bf8ec 100644 --- a/sib_api_v3_sdk/api/sms_campaigns_api.py +++ b/sib_api_v3_sdk/api/sms_campaigns_api.py @@ -131,7 +131,7 @@ def create_sms_campaign_with_http_info(self, create_sms_campaign, **kwargs): # collection_formats=collection_formats) def delete_sms_campaign(self, campaign_id, **kwargs): # noqa: E501 - """Delete the SMS campaign # noqa: E501 + """Delete an SMS campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -152,7 +152,7 @@ def delete_sms_campaign(self, campaign_id, **kwargs): # noqa: E501 return data def delete_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501 - """Delete the SMS campaign # noqa: E501 + """Delete an SMS campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -325,7 +325,7 @@ def get_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_sms_campaigns(self, **kwargs): # noqa: E501 - """Returns the informations for all your created SMS campaigns # noqa: E501 + """Returns the information for all your created SMS campaigns # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -350,7 +350,7 @@ def get_sms_campaigns(self, **kwargs): # noqa: E501 return data def get_sms_campaigns_with_http_info(self, **kwargs): # noqa: E501 - """Returns the informations for all your created SMS campaigns # noqa: E501 + """Returns the information for all your created SMS campaigns # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -436,7 +436,7 @@ def get_sms_campaigns_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def request_sms_recipient_export(self, campaign_id, **kwargs): # noqa: E501 - """Exports the recipients of the specified campaign. # noqa: E501 + """Export an SMS campaign's recipients # noqa: E501 It returns the background process ID which on completion calls the notify URL that you have set in the input. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -459,7 +459,7 @@ def request_sms_recipient_export(self, campaign_id, **kwargs): # noqa: E501 return data def request_sms_recipient_export_with_http_info(self, campaign_id, **kwargs): # noqa: E501 - """Exports the recipients of the specified campaign. # noqa: E501 + """Export an SMS campaign's recipients # noqa: E501 It returns the background process ID which on completion calls the notify URL that you have set in the input. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -636,7 +636,7 @@ def send_sms_campaign_now_with_http_info(self, campaign_id, **kwargs): # noqa: collection_formats=collection_formats) def send_sms_report(self, campaign_id, send_report, **kwargs): # noqa: E501 - """Send report of SMS campaigns # noqa: E501 + """Send an SMS campaign's report # noqa: E501 Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -659,7 +659,7 @@ def send_sms_report(self, campaign_id, send_report, **kwargs): # noqa: E501 return data def send_sms_report_with_http_info(self, campaign_id, send_report, **kwargs): # noqa: E501 - """Send report of SMS campaigns # noqa: E501 + """Send an SMS campaign's report # noqa: E501 Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -743,7 +743,7 @@ def send_sms_report_with_http_info(self, campaign_id, send_report, **kwargs): # collection_formats=collection_formats) def send_test_sms(self, campaign_id, phone_number, **kwargs): # noqa: E501 - """Send an SMS # noqa: E501 + """Send a test SMS campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -765,7 +765,7 @@ def send_test_sms(self, campaign_id, phone_number, **kwargs): # noqa: E501 return data def send_test_sms_with_http_info(self, campaign_id, phone_number, **kwargs): # noqa: E501 - """Send an SMS # noqa: E501 + """Send a test SMS campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -848,7 +848,7 @@ def send_test_sms_with_http_info(self, campaign_id, phone_number, **kwargs): # collection_formats=collection_formats) def update_sms_campaign(self, campaign_id, update_sms_campaign, **kwargs): # noqa: E501 - """Updates an SMS campaign # noqa: E501 + """Update an SMS campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -870,7 +870,7 @@ def update_sms_campaign(self, campaign_id, update_sms_campaign, **kwargs): # no return data def update_sms_campaign_with_http_info(self, campaign_id, update_sms_campaign, **kwargs): # noqa: E501 - """Updates an SMS campaign # noqa: E501 + """Update an SMS campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -953,7 +953,7 @@ def update_sms_campaign_with_http_info(self, campaign_id, update_sms_campaign, * collection_formats=collection_formats) def update_sms_campaign_status(self, campaign_id, status, **kwargs): # noqa: E501 - """Update the campaign status # noqa: E501 + """Update a campaign's status # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -975,7 +975,7 @@ def update_sms_campaign_status(self, campaign_id, status, **kwargs): # noqa: E5 return data def update_sms_campaign_status_with_http_info(self, campaign_id, status, **kwargs): # noqa: E501 - """Update the campaign status # noqa: E501 + """Update a campaign's status # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/api/smtp_api.py b/sib_api_v3_sdk/api/smtp_api.py index 9962b56..1db71aa 100644 --- a/sib_api_v3_sdk/api/smtp_api.py +++ b/sib_api_v3_sdk/api/smtp_api.py @@ -34,7 +34,7 @@ def __init__(self, api_client=None): self.api_client = api_client def create_smtp_template(self, smtp_template, **kwargs): # noqa: E501 - """Create a transactional email template # noqa: E501 + """Create an email template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -55,7 +55,7 @@ def create_smtp_template(self, smtp_template, **kwargs): # noqa: E501 return data def create_smtp_template_with_http_info(self, smtp_template, **kwargs): # noqa: E501 - """Create a transactional email template # noqa: E501 + """Create an email template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -226,7 +226,7 @@ def delete_hardbounces_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def delete_smtp_template(self, template_id, **kwargs): # noqa: E501 - """Delete an inactive transactional email template # noqa: E501 + """Delete an inactive email template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -247,7 +247,7 @@ def delete_smtp_template(self, template_id, **kwargs): # noqa: E501 return data def delete_smtp_template_with_http_info(self, template_id, **kwargs): # noqa: E501 - """Delete an inactive transactional email template # noqa: E501 + """Delete an inactive email template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -674,7 +674,7 @@ def get_smtp_report_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_smtp_template(self, template_id, **kwargs): # noqa: E501 - """Returns the template informations # noqa: E501 + """Returns the template information # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -695,7 +695,7 @@ def get_smtp_template(self, template_id, **kwargs): # noqa: E501 return data def get_smtp_template_with_http_info(self, template_id, **kwargs): # noqa: E501 - """Returns the template informations # noqa: E501 + """Returns the template information # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -771,7 +771,7 @@ def get_smtp_template_with_http_info(self, template_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_smtp_templates(self, **kwargs): # noqa: E501 - """Get the list of transactional email templates # noqa: E501 + """Get the list of email templates # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -794,7 +794,7 @@ def get_smtp_templates(self, **kwargs): # noqa: E501 return data def get_smtp_templates_with_http_info(self, **kwargs): # noqa: E501 - """Get the list of transactional email templates # noqa: E501 + """Get the list of email templates # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1095,7 +1095,7 @@ def get_transac_emails_list(self, **kwargs): # noqa: E501 :param str email: Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. :param int template_id: Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. :param str message_id: Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. - :param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. + :param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. :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: GetTransacEmailsList If the method is called asynchronously, @@ -1121,7 +1121,7 @@ def get_transac_emails_list_with_http_info(self, **kwargs): # noqa: E501 :param str email: Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. :param int template_id: Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. :param str message_id: Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. - :param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. + :param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. :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: GetTransacEmailsList If the method is called asynchronously, @@ -1697,7 +1697,7 @@ def smtp_log_message_id_delete_with_http_info(self, message_id, **kwargs): # no collection_formats=collection_formats) def update_smtp_template(self, template_id, smtp_template, **kwargs): # noqa: E501 - """Updates a transactional email templates # noqa: E501 + """Update an email template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1719,7 +1719,7 @@ def update_smtp_template(self, template_id, smtp_template, **kwargs): # noqa: E return data def update_smtp_template_with_http_info(self, template_id, smtp_template, **kwargs): # noqa: E501 - """Updates a transactional email templates # noqa: E501 + """Update an email template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/api/transactional_sms_api.py b/sib_api_v3_sdk/api/transactional_sms_api.py index 185275f..86a0f9d 100644 --- a/sib_api_v3_sdk/api/transactional_sms_api.py +++ b/sib_api_v3_sdk/api/transactional_sms_api.py @@ -34,7 +34,7 @@ def __init__(self, api_client=None): self.api_client = api_client def get_sms_events(self, **kwargs): # noqa: E501 - """Get all the SMS activity (unaggregated events) # noqa: E501 + """Get all your SMS activity (unaggregated events) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -62,7 +62,7 @@ def get_sms_events(self, **kwargs): # noqa: E501 return data def get_sms_events_with_http_info(self, **kwargs): # noqa: E501 - """Get all the SMS activity (unaggregated events) # noqa: E501 + """Get all your SMS activity (unaggregated events) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -367,7 +367,7 @@ def get_transac_sms_report_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def send_transac_sms(self, send_transac_sms, **kwargs): # noqa: E501 - """Send the SMS campaign to the specified mobile number # noqa: E501 + """Send the SMS campaign to a mobile number # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -388,7 +388,7 @@ def send_transac_sms(self, send_transac_sms, **kwargs): # noqa: E501 return data def send_transac_sms_with_http_info(self, send_transac_sms, **kwargs): # noqa: E501 - """Send the SMS campaign to the specified mobile number # noqa: E501 + """Send the SMS campaign to a mobile number # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/models/__init__.py b/sib_api_v3_sdk/models/__init__.py index e9e02f7..2cf213f 100644 --- a/sib_api_v3_sdk/models/__init__.py +++ b/sib_api_v3_sdk/models/__init__.py @@ -23,6 +23,7 @@ from sib_api_v3_sdk.models.create_attribute_enumeration import CreateAttributeEnumeration from sib_api_v3_sdk.models.create_child import CreateChild from sib_api_v3_sdk.models.create_contact import CreateContact +from sib_api_v3_sdk.models.create_doi_contact import CreateDoiContact from sib_api_v3_sdk.models.create_email_campaign import CreateEmailCampaign from sib_api_v3_sdk.models.create_email_campaign_recipients import CreateEmailCampaignRecipients from sib_api_v3_sdk.models.create_email_campaign_sender import CreateEmailCampaignSender @@ -176,6 +177,7 @@ from sib_api_v3_sdk.models.update_smtp_template import UpdateSmtpTemplate from sib_api_v3_sdk.models.update_smtp_template_sender import UpdateSmtpTemplateSender from sib_api_v3_sdk.models.update_webhook import UpdateWebhook +from sib_api_v3_sdk.models.upload_image_to_gallery import UploadImageToGallery from sib_api_v3_sdk.models.get_child_info import GetChildInfo from sib_api_v3_sdk.models.get_extended_campaign_overview import GetExtendedCampaignOverview from sib_api_v3_sdk.models.get_extended_client import GetExtendedClient diff --git a/sib_api_v3_sdk/models/add_contact_to_list.py b/sib_api_v3_sdk/models/add_contact_to_list.py index a436d7d..ca56c82 100644 --- a/sib_api_v3_sdk/models/add_contact_to_list.py +++ b/sib_api_v3_sdk/models/add_contact_to_list.py @@ -51,7 +51,7 @@ def __init__(self, emails=None): # noqa: E501 def emails(self): """Gets the emails of this AddContactToList. # noqa: E501 - Emails to add to a list # noqa: E501 + Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. # noqa: E501 :return: The emails of this AddContactToList. # noqa: E501 :rtype: list[str] @@ -62,7 +62,7 @@ def emails(self): def emails(self, emails): """Sets the emails of this AddContactToList. - Emails to add to a list # noqa: E501 + Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. # noqa: E501 :param emails: The emails of this AddContactToList. # noqa: E501 :type: list[str] diff --git a/sib_api_v3_sdk/models/create_attribute.py b/sib_api_v3_sdk/models/create_attribute.py index bc017fc..c7da06d 100644 --- a/sib_api_v3_sdk/models/create_attribute.py +++ b/sib_api_v3_sdk/models/create_attribute.py @@ -84,7 +84,7 @@ def value(self, value): def enumeration(self): """Gets the enumeration of this CreateAttribute. # noqa: E501 - List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] # noqa: E501 + List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] # noqa: E501 :return: The enumeration of this CreateAttribute. # noqa: E501 :rtype: list[CreateAttributeEnumeration] @@ -95,7 +95,7 @@ def enumeration(self): def enumeration(self, enumeration): """Sets the enumeration of this CreateAttribute. - List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] # noqa: E501 + List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] # noqa: E501 :param enumeration: The enumeration of this CreateAttribute. # noqa: E501 :type: list[CreateAttributeEnumeration] diff --git a/sib_api_v3_sdk/models/create_contact.py b/sib_api_v3_sdk/models/create_contact.py index 7ef8259..79f72e8 100644 --- a/sib_api_v3_sdk/models/create_contact.py +++ b/sib_api_v3_sdk/models/create_contact.py @@ -81,7 +81,7 @@ def __init__(self, email=None, attributes=None, email_blacklisted=None, sms_blac def email(self): """Gets the email of this CreateContact. # noqa: E501 - 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'} # noqa: E501 + 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\"} # noqa: E501 :return: The email of this CreateContact. # noqa: E501 :rtype: str @@ -92,7 +92,7 @@ def email(self): def email(self, email): """Sets the email of this CreateContact. - 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'} # noqa: E501 + 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\"} # noqa: E501 :param email: The email of this CreateContact. # noqa: E501 :type: str @@ -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. 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. 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_doi_contact.py b/sib_api_v3_sdk/models/create_doi_contact.py new file mode 100644 index 0000000..36666e1 --- /dev/null +++ b/sib_api_v3_sdk/models/create_doi_contact.py @@ -0,0 +1,260 @@ +# 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 CreateDoiContact(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 = { + 'email': 'str', + 'attributes': 'object', + 'include_list_ids': 'list[int]', + 'exclude_list_ids': 'list[int]', + 'template_id': 'int', + 'redirection_url': 'str' + } + + attribute_map = { + 'email': 'email', + 'attributes': 'attributes', + 'include_list_ids': 'includeListIds', + 'exclude_list_ids': 'excludeListIds', + 'template_id': 'templateId', + 'redirection_url': 'redirectionUrl' + } + + def __init__(self, email=None, attributes=None, include_list_ids=None, exclude_list_ids=None, template_id=None, redirection_url=None): # noqa: E501 + """CreateDoiContact - a model defined in Swagger""" # noqa: E501 + + self._email = None + self._attributes = None + self._include_list_ids = None + self._exclude_list_ids = None + self._template_id = None + self._redirection_url = None + self.discriminator = None + + self.email = email + if attributes is not None: + self.attributes = attributes + self.include_list_ids = include_list_ids + if exclude_list_ids is not None: + self.exclude_list_ids = exclude_list_ids + self.template_id = template_id + if redirection_url is not None: + self.redirection_url = redirection_url + + @property + def email(self): + """Gets the email of this CreateDoiContact. # noqa: E501 + + Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. # noqa: E501 + + :return: The email of this CreateDoiContact. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this CreateDoiContact. + + Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. # noqa: E501 + + :param email: The email of this CreateDoiContact. # noqa: E501 + :type: str + """ + if email is None: + raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501 + + self._email = email + + @property + def attributes(self): + """Gets the attributes of this CreateDoiContact. # 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 + + :return: The attributes of this CreateDoiContact. # noqa: E501 + :rtype: object + """ + return self._attributes + + @attributes.setter + def attributes(self, attributes): + """Sets the attributes of this CreateDoiContact. + + 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 + + :param attributes: The attributes of this CreateDoiContact. # noqa: E501 + :type: object + """ + + self._attributes = attributes + + @property + def include_list_ids(self): + """Gets the include_list_ids of this CreateDoiContact. # noqa: E501 + + Lists under user account where contact should be added # noqa: E501 + + :return: The include_list_ids of this CreateDoiContact. # noqa: E501 + :rtype: list[int] + """ + return self._include_list_ids + + @include_list_ids.setter + def include_list_ids(self, include_list_ids): + """Sets the include_list_ids of this CreateDoiContact. + + Lists under user account where contact should be added # noqa: E501 + + :param include_list_ids: The include_list_ids of this CreateDoiContact. # noqa: E501 + :type: list[int] + """ + if include_list_ids is None: + raise ValueError("Invalid value for `include_list_ids`, must not be `None`") # noqa: E501 + + self._include_list_ids = include_list_ids + + @property + def exclude_list_ids(self): + """Gets the exclude_list_ids of this CreateDoiContact. # noqa: E501 + + Lists under user account where contact should not be added # noqa: E501 + + :return: The exclude_list_ids of this CreateDoiContact. # noqa: E501 + :rtype: list[int] + """ + return self._exclude_list_ids + + @exclude_list_ids.setter + def exclude_list_ids(self, exclude_list_ids): + """Sets the exclude_list_ids of this CreateDoiContact. + + Lists under user account where contact should not be added # noqa: E501 + + :param exclude_list_ids: The exclude_list_ids of this CreateDoiContact. # noqa: E501 + :type: list[int] + """ + + self._exclude_list_ids = exclude_list_ids + + @property + def template_id(self): + """Gets the template_id of this CreateDoiContact. # noqa: E501 + + Id of the DOI template # noqa: E501 + + :return: The template_id of this CreateDoiContact. # noqa: E501 + :rtype: int + """ + return self._template_id + + @template_id.setter + def template_id(self, template_id): + """Sets the template_id of this CreateDoiContact. + + Id of the DOI template # noqa: E501 + + :param template_id: The template_id of this CreateDoiContact. # noqa: E501 + :type: int + """ + if template_id is None: + raise ValueError("Invalid value for `template_id`, must not be `None`") # noqa: E501 + + self._template_id = template_id + + @property + def redirection_url(self): + """Gets the redirection_url of this CreateDoiContact. # noqa: E501 + + URL of the web page that user will be redirected to after clicking on the double opt in URL. # noqa: E501 + + :return: The redirection_url of this CreateDoiContact. # noqa: E501 + :rtype: str + """ + return self._redirection_url + + @redirection_url.setter + def redirection_url(self, redirection_url): + """Sets the redirection_url of this CreateDoiContact. + + URL of the web page that user will be redirected to after clicking on the double opt in URL. # noqa: E501 + + :param redirection_url: The redirection_url of this CreateDoiContact. # noqa: E501 + :type: str + """ + + self._redirection_url = redirection_url + + 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(CreateDoiContact, 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, CreateDoiContact): + 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/create_email_campaign.py b/sib_api_v3_sdk/models/create_email_campaign.py index 3ece3ed..4b015e8 100644 --- a/sib_api_v3_sdk/models/create_email_campaign.py +++ b/sib_api_v3_sdk/models/create_email_campaign.py @@ -575,7 +575,7 @@ def utm_campaign(self, utm_campaign): def params(self): """Gets the params of this CreateEmailCampaign. # noqa: E501 - Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 + Pass the set of attributes to customize the type classic campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 :return: The params of this CreateEmailCampaign. # noqa: E501 :rtype: object @@ -586,7 +586,7 @@ def params(self): def params(self, params): """Sets the params of this CreateEmailCampaign. - Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 + Pass the set of attributes to customize the type classic campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 :param params: The params of this CreateEmailCampaign. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/get_transac_blocked_contacts_contacts.py b/sib_api_v3_sdk/models/get_transac_blocked_contacts_contacts.py index 02a84ff..0787b8e 100644 --- a/sib_api_v3_sdk/models/get_transac_blocked_contacts_contacts.py +++ b/sib_api_v3_sdk/models/get_transac_blocked_contacts_contacts.py @@ -34,7 +34,7 @@ class GetTransacBlockedContactsContacts(object): 'email': 'str', 'sender_email': 'str', 'reason': 'GetTransacBlockedContactsReason', - 'blocked_at': 'date' + 'blocked_at': 'datetime' } attribute_map = { @@ -138,7 +138,7 @@ def blocked_at(self): Date when the contact was blocked or unsubscribed on # noqa: E501 :return: The blocked_at of this GetTransacBlockedContactsContacts. # noqa: E501 - :rtype: date + :rtype: datetime """ return self._blocked_at @@ -149,7 +149,7 @@ def blocked_at(self, blocked_at): Date when the contact was blocked or unsubscribed on # noqa: E501 :param blocked_at: The blocked_at of this GetTransacBlockedContactsContacts. # noqa: E501 - :type: date + :type: datetime """ if blocked_at is None: raise ValueError("Invalid value for `blocked_at`, must not be `None`") # noqa: E501 diff --git a/sib_api_v3_sdk/models/get_transac_emails_list_transactional_emails.py b/sib_api_v3_sdk/models/get_transac_emails_list_transactional_emails.py index dbf4519..e4a0ccd 100644 --- a/sib_api_v3_sdk/models/get_transac_emails_list_transactional_emails.py +++ b/sib_api_v3_sdk/models/get_transac_emails_list_transactional_emails.py @@ -36,7 +36,9 @@ class GetTransacEmailsListTransactionalEmails(object): 'template_id': 'int', 'message_id': 'str', 'uuid': 'str', - '_date': 'datetime' + '_date': 'datetime', + '_from': 'str', + 'tags': 'list[str]' } attribute_map = { @@ -45,10 +47,12 @@ class GetTransacEmailsListTransactionalEmails(object): 'template_id': 'templateId', 'message_id': 'messageId', 'uuid': 'uuid', - '_date': 'date' + '_date': 'date', + '_from': 'from', + 'tags': 'tags' } - def __init__(self, email=None, subject=None, template_id=None, message_id=None, uuid=None, _date=None): # noqa: E501 + def __init__(self, email=None, subject=None, template_id=None, message_id=None, uuid=None, _date=None, _from=None, tags=None): # noqa: E501 """GetTransacEmailsListTransactionalEmails - a model defined in Swagger""" # noqa: E501 self._email = None @@ -57,6 +61,8 @@ def __init__(self, email=None, subject=None, template_id=None, message_id=None, self._message_id = None self._uuid = None self.__date = None + self.__from = None + self._tags = None self.discriminator = None self.email = email @@ -66,6 +72,10 @@ def __init__(self, email=None, subject=None, template_id=None, message_id=None, self.message_id = message_id self.uuid = uuid self._date = _date + if _from is not None: + self._from = _from + if tags is not None: + self.tags = tags @property def email(self): @@ -215,6 +225,52 @@ def _date(self, _date): self.__date = _date + @property + def _from(self): + """Gets the _from of this GetTransacEmailsListTransactionalEmails. # noqa: E501 + + Email address of the sender from which the email was sent # noqa: E501 + + :return: The _from of this GetTransacEmailsListTransactionalEmails. # noqa: E501 + :rtype: str + """ + return self.__from + + @_from.setter + def _from(self, _from): + """Sets the _from of this GetTransacEmailsListTransactionalEmails. + + Email address of the sender from which the email was sent # noqa: E501 + + :param _from: The _from of this GetTransacEmailsListTransactionalEmails. # noqa: E501 + :type: str + """ + + self.__from = _from + + @property + def tags(self): + """Gets the tags of this GetTransacEmailsListTransactionalEmails. # noqa: E501 + + Tags used for your email # noqa: E501 + + :return: The tags of this GetTransacEmailsListTransactionalEmails. # noqa: E501 + :rtype: list[str] + """ + return self._tags + + @tags.setter + def tags(self, tags): + """Sets the tags of this GetTransacEmailsListTransactionalEmails. + + Tags used for your email # noqa: E501 + + :param tags: The tags of this GetTransacEmailsListTransactionalEmails. # noqa: E501 + :type: list[str] + """ + + self._tags = tags + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/remaining_credit_model_child.py b/sib_api_v3_sdk/models/remaining_credit_model_child.py index 5a72c34..8319634 100644 --- a/sib_api_v3_sdk/models/remaining_credit_model_child.py +++ b/sib_api_v3_sdk/models/remaining_credit_model_child.py @@ -31,8 +31,8 @@ class RemainingCreditModelChild(object): and the value is json key in definition. """ swagger_types = { - 'sms': 'int', - 'email': 'int' + 'sms': 'float', + 'email': 'float' } attribute_map = { @@ -57,7 +57,7 @@ def sms(self): SMS Credits remaining for child account # noqa: E501 :return: The sms of this RemainingCreditModelChild. # noqa: E501 - :rtype: int + :rtype: float """ return self._sms @@ -68,7 +68,7 @@ def sms(self, sms): SMS Credits remaining for child account # noqa: E501 :param sms: The sms of this RemainingCreditModelChild. # noqa: E501 - :type: int + :type: float """ if sms is None: raise ValueError("Invalid value for `sms`, must not be `None`") # noqa: E501 @@ -82,7 +82,7 @@ def email(self): Email Credits remaining for child account # noqa: E501 :return: The email of this RemainingCreditModelChild. # noqa: E501 - :rtype: int + :rtype: float """ return self._email @@ -93,7 +93,7 @@ def email(self, email): Email Credits remaining for child account # noqa: E501 :param email: The email of this RemainingCreditModelChild. # noqa: E501 - :type: int + :type: float """ if email is None: raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501 diff --git a/sib_api_v3_sdk/models/remaining_credit_model_reseller.py b/sib_api_v3_sdk/models/remaining_credit_model_reseller.py index 1380603..d1c9799 100644 --- a/sib_api_v3_sdk/models/remaining_credit_model_reseller.py +++ b/sib_api_v3_sdk/models/remaining_credit_model_reseller.py @@ -31,8 +31,8 @@ class RemainingCreditModelReseller(object): and the value is json key in definition. """ swagger_types = { - 'sms': 'int', - 'email': 'int' + 'sms': 'float', + 'email': 'float' } attribute_map = { @@ -57,7 +57,7 @@ def sms(self): SMS Credits remaining for reseller account # noqa: E501 :return: The sms of this RemainingCreditModelReseller. # noqa: E501 - :rtype: int + :rtype: float """ return self._sms @@ -68,7 +68,7 @@ def sms(self, sms): SMS Credits remaining for reseller account # noqa: E501 :param sms: The sms of this RemainingCreditModelReseller. # noqa: E501 - :type: int + :type: float """ if sms is None: raise ValueError("Invalid value for `sms`, must not be `None`") # noqa: E501 @@ -82,7 +82,7 @@ def email(self): Email Credits remaining for reseller account # noqa: E501 :return: The email of this RemainingCreditModelReseller. # noqa: E501 - :rtype: int + :rtype: float """ return self._email @@ -93,7 +93,7 @@ def email(self, email): Email Credits remaining for reseller account # noqa: E501 :param email: The email of this RemainingCreditModelReseller. # noqa: E501 - :type: int + :type: float """ if email is None: raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501 diff --git a/sib_api_v3_sdk/models/remove_contact_from_list.py b/sib_api_v3_sdk/models/remove_contact_from_list.py index f2e7ba8..f249fc4 100644 --- a/sib_api_v3_sdk/models/remove_contact_from_list.py +++ b/sib_api_v3_sdk/models/remove_contact_from_list.py @@ -56,7 +56,7 @@ def __init__(self, emails=None, all=None): # noqa: E501 def emails(self): """Gets the emails of this RemoveContactFromList. # noqa: E501 - Required if 'all' is false. Emails to remove from a list # noqa: E501 + Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. # noqa: E501 :return: The emails of this RemoveContactFromList. # noqa: E501 :rtype: list[str] @@ -67,7 +67,7 @@ def emails(self): def emails(self, emails): """Sets the emails of this RemoveContactFromList. - Required if 'all' is false. Emails to remove from a list # noqa: E501 + Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. # noqa: E501 :param emails: The emails of this RemoveContactFromList. # noqa: E501 :type: list[str] diff --git a/sib_api_v3_sdk/models/request_contact_export.py b/sib_api_v3_sdk/models/request_contact_export.py index a903368..8ab8940 100644 --- a/sib_api_v3_sdk/models/request_contact_export.py +++ b/sib_api_v3_sdk/models/request_contact_export.py @@ -89,7 +89,7 @@ def export_attributes(self, export_attributes): def contact_filter(self): """Gets the contact_filter of this RequestContactExport. # noqa: E501 - This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. # noqa: E501 + This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {\"blacklisted\":true} will export all the blacklisted contacts. # noqa: E501 :return: The contact_filter of this RequestContactExport. # noqa: E501 :rtype: object @@ -100,7 +100,7 @@ def contact_filter(self): def contact_filter(self, contact_filter): """Sets the contact_filter of this RequestContactExport. - This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. # noqa: E501 + This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {\"blacklisted\":true} will export all the blacklisted contacts. # noqa: E501 :param contact_filter: The contact_filter of this RequestContactExport. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/request_contact_import.py b/sib_api_v3_sdk/models/request_contact_import.py index b6dab7f..a5eac64 100644 --- a/sib_api_v3_sdk/models/request_contact_import.py +++ b/sib_api_v3_sdk/models/request_contact_import.py @@ -114,7 +114,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 # 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 :return: The file_body of this RequestContactImport. # noqa: E501 :rtype: str @@ -125,7 +125,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 # 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 :param file_body: The file_body of this RequestContactImport. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/send_email.py b/sib_api_v3_sdk/models/send_email.py index cc1591b..2336b9d 100644 --- a/sib_api_v3_sdk/models/send_email.py +++ b/sib_api_v3_sdk/models/send_email.py @@ -207,7 +207,7 @@ def attachment_url(self, attachment_url): def attachment(self): """Gets the attachment of this SendEmail. # noqa: E501 - Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. # noqa: E501 + Pass the list of content (base64 encoded) and name of the attachment. For example, [{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}]. # noqa: E501 :return: The attachment of this SendEmail. # noqa: E501 :rtype: list[SendEmailAttachment] @@ -218,7 +218,7 @@ def attachment(self): def attachment(self, attachment): """Sets the attachment of this SendEmail. - Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. # noqa: E501 + Pass the list of content (base64 encoded) and name of the attachment. For example, [{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}]. # noqa: E501 :param attachment: The attachment of this SendEmail. # noqa: E501 :type: list[SendEmailAttachment] @@ -230,7 +230,7 @@ def attachment(self, attachment): def headers(self): """Gets the headers of this SendEmail. # noqa: E501 - Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} # noqa: E501 + Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, {\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"} # noqa: E501 :return: The headers of this SendEmail. # noqa: E501 :rtype: object @@ -241,7 +241,7 @@ def headers(self): def headers(self, headers): """Sets the headers of this SendEmail. - Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} # noqa: E501 + Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, {\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"} # noqa: E501 :param headers: The headers of this SendEmail. # noqa: E501 :type: object @@ -253,7 +253,7 @@ def headers(self, headers): def attributes(self): """Gets the attributes of this SendEmail. # noqa: E501 - Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} # noqa: E501 + Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"} # noqa: E501 :return: The attributes of this SendEmail. # noqa: E501 :rtype: object @@ -264,7 +264,7 @@ def attributes(self): def attributes(self, attributes): """Sets the attributes of this SendEmail. - Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} # noqa: E501 + Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"} # noqa: E501 :param attributes: The attributes of this SendEmail. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/send_smtp_email.py b/sib_api_v3_sdk/models/send_smtp_email.py index 3c5263e..03a3c73 100644 --- a/sib_api_v3_sdk/models/send_smtp_email.py +++ b/sib_api_v3_sdk/models/send_smtp_email.py @@ -131,7 +131,7 @@ def sender(self, sender): def to(self): """Gets the to of this SendSmtpEmail. # noqa: E501 - List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] # noqa: E501 + List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] # noqa: E501 :return: The to of this SendSmtpEmail. # noqa: E501 :rtype: list[SendSmtpEmailTo] @@ -142,7 +142,7 @@ def to(self): def to(self, to): """Sets the to of this SendSmtpEmail. - List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] # noqa: E501 + List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] # noqa: E501 :param to: The to of this SendSmtpEmail. # noqa: E501 :type: list[SendSmtpEmailTo] @@ -315,7 +315,7 @@ def attachment(self, attachment): def headers(self): """Gets the headers of this SendSmtpEmail. # noqa: E501 - Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. # noqa: E501 + Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. # noqa: E501 :return: The headers of this SendSmtpEmail. # noqa: E501 :rtype: object @@ -326,7 +326,7 @@ def headers(self): def headers(self, headers): """Sets the headers of this SendSmtpEmail. - Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. # noqa: E501 + Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. # noqa: E501 :param headers: The headers of this SendSmtpEmail. # noqa: E501 :type: object @@ -361,7 +361,7 @@ def template_id(self, template_id): def params(self): """Gets the params of this SendSmtpEmail. # noqa: E501 - 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. # noqa: E501 + 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. # noqa: E501 :return: The params of this SendSmtpEmail. # noqa: E501 :rtype: object @@ -372,7 +372,7 @@ def params(self): def params(self, params): """Sets the params of this SendSmtpEmail. - 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. # noqa: E501 + 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. # noqa: E501 :param params: The params of this SendSmtpEmail. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/update_attribute.py b/sib_api_v3_sdk/models/update_attribute.py index 9b73db6..6c669e5 100644 --- a/sib_api_v3_sdk/models/update_attribute.py +++ b/sib_api_v3_sdk/models/update_attribute.py @@ -79,7 +79,7 @@ def value(self, value): def enumeration(self): """Gets the enumeration of this UpdateAttribute. # noqa: E501 - List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] # noqa: E501 + List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] # noqa: E501 :return: The enumeration of this UpdateAttribute. # noqa: E501 :rtype: list[UpdateAttributeEnumeration] @@ -90,7 +90,7 @@ def enumeration(self): def enumeration(self, enumeration): """Sets the enumeration of this UpdateAttribute. - List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] # noqa: E501 + List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] # noqa: E501 :param enumeration: The enumeration of this UpdateAttribute. # noqa: E501 :type: list[UpdateAttributeEnumeration] diff --git a/sib_api_v3_sdk/models/update_contact.py b/sib_api_v3_sdk/models/update_contact.py index cbd9a98..97d9f73 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'} `{ \"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 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 :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'} `{ \"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 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 :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 a595ba9..132f5db 100644 --- a/sib_api_v3_sdk/models/update_email_campaign.py +++ b/sib_api_v3_sdk/models/update_email_campaign.py @@ -573,7 +573,7 @@ def utm_campaign(self, utm_campaign): def params(self): """Gets the params of this UpdateEmailCampaign. # noqa: E501 - Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 + Pass the set of attributes to customize the type 'classic' campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 :return: The params of this UpdateEmailCampaign. # noqa: E501 :rtype: object @@ -584,7 +584,7 @@ def params(self): def params(self, params): """Sets the params of this UpdateEmailCampaign. - Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 + Pass the set of attributes to customize the type 'classic' campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 :param params: The params of this UpdateEmailCampaign. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/upload_image_to_gallery.py b/sib_api_v3_sdk/models/upload_image_to_gallery.py new file mode 100644 index 0000000..aaf867f --- /dev/null +++ b/sib_api_v3_sdk/models/upload_image_to_gallery.py @@ -0,0 +1,146 @@ +# 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 UploadImageToGallery(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 = { + 'image_url': 'str', + 'name': 'str' + } + + attribute_map = { + 'image_url': 'imageUrl', + 'name': 'name' + } + + def __init__(self, image_url=None, name=None): # noqa: E501 + """UploadImageToGallery - a model defined in Swagger""" # noqa: E501 + + self._image_url = None + self._name = None + self.discriminator = None + + self.image_url = image_url + if name is not None: + self.name = name + + @property + def image_url(self): + """Gets the image_url of this UploadImageToGallery. # noqa: E501 + + The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. # noqa: E501 + + :return: The image_url of this UploadImageToGallery. # noqa: E501 + :rtype: str + """ + return self._image_url + + @image_url.setter + def image_url(self, image_url): + """Sets the image_url of this UploadImageToGallery. + + The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. # noqa: E501 + + :param image_url: The image_url of this UploadImageToGallery. # noqa: E501 + :type: str + """ + if image_url is None: + raise ValueError("Invalid value for `image_url`, must not be `None`") # noqa: E501 + + self._image_url = image_url + + @property + def name(self): + """Gets the name of this UploadImageToGallery. # noqa: E501 + + Name of the image. # noqa: E501 + + :return: The name of this UploadImageToGallery. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this UploadImageToGallery. + + Name of the image. # noqa: E501 + + :param name: The name of this UploadImageToGallery. # noqa: E501 + :type: str + """ + + self._name = name + + 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(UploadImageToGallery, 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, UploadImageToGallery): + 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/test/test_account_api.py b/test/test_account_api.py index f567cc0..e3028a2 100644 --- a/test/test_account_api.py +++ b/test/test_account_api.py @@ -32,7 +32,7 @@ def tearDown(self): def test_get_account(self): """Test case for get_account - Get your account informations, plans and credits details # noqa: E501 + Get your account information, plan and credits details # noqa: E501 """ pass diff --git a/test/test_attributes_api.py b/test/test_attributes_api.py index dc85355..6a2958b 100644 --- a/test/test_attributes_api.py +++ b/test/test_attributes_api.py @@ -32,28 +32,28 @@ def tearDown(self): def test_create_attribute(self): """Test case for create_attribute - Creates contact attribute # noqa: E501 + Create contact attribute # noqa: E501 """ pass def test_delete_attribute(self): """Test case for delete_attribute - Deletes an attribute # noqa: E501 + Delete an attribute # noqa: E501 """ pass def test_get_attributes(self): """Test case for get_attributes - Lists all attributes # noqa: E501 + List all attributes # noqa: E501 """ pass def test_update_attribute(self): """Test case for update_attribute - Updates contact attribute # noqa: E501 + Update contact attribute # noqa: E501 """ pass diff --git a/test/test_contacts_api.py b/test/test_contacts_api.py index af7c11e..42e2be4 100644 --- a/test/test_contacts_api.py +++ b/test/test_contacts_api.py @@ -39,7 +39,7 @@ def test_add_contact_to_list(self): def test_create_attribute(self): """Test case for create_attribute - Creates contact attribute # noqa: E501 + Create contact attribute # noqa: E501 """ pass @@ -50,6 +50,13 @@ def test_create_contact(self): """ pass + def test_create_doi_contact(self): + """Test case for create_doi_contact + + Create a contact to trigger the DOI workflow from a Landing Page form # noqa: E501 + """ + pass + def test_create_folder(self): """Test case for create_folder @@ -67,14 +74,14 @@ def test_create_list(self): def test_delete_attribute(self): """Test case for delete_attribute - Deletes an attribute # noqa: E501 + Delete an attribute # noqa: E501 """ pass def test_delete_contact(self): """Test case for delete_contact - Deletes a contact # noqa: E501 + Delete a contact # noqa: E501 """ pass @@ -95,21 +102,21 @@ def test_delete_list(self): def test_get_attributes(self): """Test case for get_attributes - Lists all attributes # noqa: E501 + List all attributes # noqa: E501 """ pass def test_get_contact_info(self): """Test case for get_contact_info - Retrieves contact informations # noqa: E501 + Get a contact's details # noqa: E501 """ pass def test_get_contact_stats(self): """Test case for get_contact_stats - Get the campaigns statistics for a contact # noqa: E501 + Get email campaigns' statistics for a contact # noqa: E501 """ pass @@ -123,35 +130,35 @@ def test_get_contacts(self): def test_get_contacts_from_list(self): """Test case for get_contacts_from_list - Get the contacts in a list # noqa: E501 + Get contacts in a list # noqa: E501 """ pass def test_get_folder(self): """Test case for get_folder - Returns folder details # noqa: E501 + Returns a folder's details # noqa: E501 """ pass def test_get_folder_lists(self): """Test case for get_folder_lists - Get the lists in a folder # noqa: E501 + Get lists in a folder # noqa: E501 """ pass def test_get_folders(self): """Test case for get_folders - Get all the folders # noqa: E501 + Get all folders # noqa: E501 """ pass def test_get_list(self): """Test case for get_list - Get the details of a list # noqa: E501 + Get a list's details # noqa: E501 """ pass @@ -172,7 +179,7 @@ def test_import_contacts(self): def test_remove_contact_from_list(self): """Test case for remove_contact_from_list - Remove existing contacts from a list # noqa: E501 + Delete a contact from a list # noqa: E501 """ pass @@ -186,21 +193,21 @@ def test_request_contact_export(self): def test_update_attribute(self): """Test case for update_attribute - Updates contact attribute # noqa: E501 + Update contact attribute # noqa: E501 """ pass def test_update_contact(self): """Test case for update_contact - Updates a contact # noqa: E501 + Update a contact # noqa: E501 """ pass def test_update_folder(self): """Test case for update_folder - Update a contact folder # noqa: E501 + Update a folder # noqa: E501 """ pass diff --git a/test/test_create_doi_contact.py b/test/test_create_doi_contact.py new file mode 100644 index 0000000..a449854 --- /dev/null +++ b/test/test_create_doi_contact.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_doi_contact import CreateDoiContact # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestCreateDoiContact(unittest.TestCase): + """CreateDoiContact unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateDoiContact(self): + """Test CreateDoiContact""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.create_doi_contact.CreateDoiContact() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_email_campaigns_api.py b/test/test_email_campaigns_api.py index 4a5d106..d5f7229 100644 --- a/test/test_email_campaigns_api.py +++ b/test/test_email_campaigns_api.py @@ -46,28 +46,28 @@ def test_delete_email_campaign(self): def test_email_export_recipients(self): """Test case for email_export_recipients - Export the recipients of a campaign # noqa: E501 + Export the recipients of an email campaign # noqa: E501 """ pass def test_get_ab_test_campaign_result(self): """Test case for get_ab_test_campaign_result - Get A/B test email campaign result # noqa: E501 + Get an A/B test email campaign results # noqa: E501 """ pass def test_get_email_campaign(self): """Test case for get_email_campaign - Get campaign informations # noqa: E501 + Get an email campaign report # noqa: E501 """ pass def test_get_email_campaigns(self): """Test case for get_email_campaigns - Return all your created campaigns # noqa: E501 + Return all your created email campaigns # noqa: E501 """ pass @@ -88,7 +88,7 @@ def test_send_email_campaign_now(self): def test_send_report(self): """Test case for send_report - Send the report of a campaigns # noqa: E501 + Send the report of a campaign # noqa: E501 """ pass @@ -102,14 +102,21 @@ def test_send_test_email(self): def test_update_campaign_status(self): """Test case for update_campaign_status - Update a campaign status # noqa: E501 + Update an email campaign status # noqa: E501 """ pass def test_update_email_campaign(self): """Test case for update_email_campaign - Update a campaign # noqa: E501 + Update an email campaign # noqa: E501 + """ + pass + + def test_upload_image_to_gallery(self): + """Test case for upload_image_to_gallery + + Upload an image to your account's image gallery # noqa: E501 """ pass diff --git a/test/test_folders_api.py b/test/test_folders_api.py index 1bc1888..403c56e 100644 --- a/test/test_folders_api.py +++ b/test/test_folders_api.py @@ -46,28 +46,28 @@ def test_delete_folder(self): def test_get_folder(self): """Test case for get_folder - Returns folder details # noqa: E501 + Returns a folder's details # noqa: E501 """ pass def test_get_folder_lists(self): """Test case for get_folder_lists - Get the lists in a folder # noqa: E501 + Get lists in a folder # noqa: E501 """ pass def test_get_folders(self): """Test case for get_folders - Get all the folders # noqa: E501 + Get all folders # noqa: E501 """ pass def test_update_folder(self): """Test case for update_folder - Update a contact folder # noqa: E501 + Update a folder # noqa: E501 """ pass diff --git a/test/test_lists_api.py b/test/test_lists_api.py index 0634ea7..ae73950 100644 --- a/test/test_lists_api.py +++ b/test/test_lists_api.py @@ -53,21 +53,21 @@ def test_delete_list(self): def test_get_contacts_from_list(self): """Test case for get_contacts_from_list - Get the contacts in a list # noqa: E501 + Get contacts in a list # noqa: E501 """ pass def test_get_folder_lists(self): """Test case for get_folder_lists - Get the lists in a folder # noqa: E501 + Get lists in a folder # noqa: E501 """ pass def test_get_list(self): """Test case for get_list - Get the details of a list # noqa: E501 + Get a list's details # noqa: E501 """ pass @@ -81,7 +81,7 @@ def test_get_lists(self): def test_remove_contact_from_list(self): """Test case for remove_contact_from_list - Remove existing contacts from a list # noqa: E501 + Delete a contact from a list # noqa: E501 """ pass diff --git a/test/test_reseller_api.py b/test/test_reseller_api.py index eb571e5..c9eb99a 100644 --- a/test/test_reseller_api.py +++ b/test/test_reseller_api.py @@ -46,7 +46,7 @@ def test_associate_ip_to_child(self): def test_create_child_domain(self): """Test case for create_child_domain - Creates a domain for a child account # noqa: E501 + Create a domain for a child account # noqa: E501 """ pass @@ -60,14 +60,14 @@ def test_create_reseller_child(self): def test_delete_child_domain(self): """Test case for delete_child_domain - Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed # noqa: E501 + Delete the sender domain of the reseller child based on the childAuthKey and domainName passed # noqa: E501 """ pass def test_delete_reseller_child(self): """Test case for delete_reseller_child - Deletes a single reseller child based on the childAuthKey supplied # noqa: E501 + Delete a single reseller child based on the childAuthKey supplied # noqa: E501 """ pass @@ -81,28 +81,28 @@ def test_dissociate_ip_from_child(self): def test_get_child_account_creation_status(self): """Test case for get_child_account_creation_status - Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied # noqa: E501 + Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied # noqa: E501 """ pass def test_get_child_domains(self): """Test case for get_child_domains - Gets all the sender domains of a specific child account # noqa: E501 + Get all sender domains for a specific child account # noqa: E501 """ pass def test_get_child_info(self): """Test case for get_child_info - Gets the info about a specific child account # noqa: E501 + Get a child account's details # noqa: E501 """ pass def test_get_reseller_childs(self): """Test case for get_reseller_childs - Gets the list of all reseller's children accounts # noqa: E501 + Get the list of all children accounts # noqa: E501 """ pass @@ -123,21 +123,21 @@ def test_remove_credits(self): def test_update_child_account_status(self): """Test case for update_child_account_status - Updates infos of reseller's child account status based on the childAuthKey supplied # noqa: E501 + Update info of reseller's child account status based on the childAuthKey supplied # noqa: E501 """ pass def test_update_child_domain(self): """Test case for update_child_domain - Updates the sender domain of reseller's child based on the childAuthKey and domainName passed # noqa: E501 + Update the sender domain of reseller's child based on the childAuthKey and domainName passed # noqa: E501 """ pass def test_update_reseller_child(self): """Test case for update_reseller_child - Updates infos of reseller's child based on the childAuthKey supplied # noqa: E501 + Update info of reseller's child based on the childAuthKey supplied # noqa: E501 """ pass diff --git a/test/test_senders_api.py b/test/test_senders_api.py index 94afa05..09e7475 100644 --- a/test/test_senders_api.py +++ b/test/test_senders_api.py @@ -46,14 +46,14 @@ def test_delete_sender(self): def test_get_ips(self): """Test case for get_ips - Return all the dedicated IPs for your account # noqa: E501 + Get all the dedicated IPs for your account # noqa: E501 """ pass def test_get_ips_from_sender(self): """Test case for get_ips_from_sender - Return all the dedicated IPs for a sender # noqa: E501 + Get all the dedicated IPs for a sender # noqa: E501 """ pass diff --git a/test/test_sms_campaigns_api.py b/test/test_sms_campaigns_api.py index 87ba56d..3737c41 100644 --- a/test/test_sms_campaigns_api.py +++ b/test/test_sms_campaigns_api.py @@ -39,7 +39,7 @@ def test_create_sms_campaign(self): def test_delete_sms_campaign(self): """Test case for delete_sms_campaign - Delete the SMS campaign # noqa: E501 + Delete an SMS campaign # noqa: E501 """ pass @@ -53,14 +53,14 @@ def test_get_sms_campaign(self): def test_get_sms_campaigns(self): """Test case for get_sms_campaigns - Returns the informations for all your created SMS campaigns # noqa: E501 + Returns the information for all your created SMS campaigns # noqa: E501 """ pass def test_request_sms_recipient_export(self): """Test case for request_sms_recipient_export - Exports the recipients of the specified campaign. # noqa: E501 + Export an SMS campaign's recipients # noqa: E501 """ pass @@ -74,28 +74,28 @@ def test_send_sms_campaign_now(self): def test_send_sms_report(self): """Test case for send_sms_report - Send report of SMS campaigns # noqa: E501 + Send an SMS campaign's report # noqa: E501 """ pass def test_send_test_sms(self): """Test case for send_test_sms - Send an SMS # noqa: E501 + Send a test SMS campaign # noqa: E501 """ pass def test_update_sms_campaign(self): """Test case for update_sms_campaign - Updates an SMS campaign # noqa: E501 + Update an SMS campaign # noqa: E501 """ pass def test_update_sms_campaign_status(self): """Test case for update_sms_campaign_status - Update the campaign status # noqa: E501 + Update a campaign's status # noqa: E501 """ pass diff --git a/test/test_smtp_api.py b/test/test_smtp_api.py index 2543bab..f6f27d1 100644 --- a/test/test_smtp_api.py +++ b/test/test_smtp_api.py @@ -32,7 +32,7 @@ def tearDown(self): def test_create_smtp_template(self): """Test case for create_smtp_template - Create a transactional email template # noqa: E501 + Create an email template # noqa: E501 """ pass @@ -46,7 +46,7 @@ def test_delete_hardbounces(self): def test_delete_smtp_template(self): """Test case for delete_smtp_template - Delete an inactive transactional email template # noqa: E501 + Delete an inactive email template # noqa: E501 """ pass @@ -74,14 +74,14 @@ def test_get_smtp_report(self): def test_get_smtp_template(self): """Test case for get_smtp_template - Returns the template informations # noqa: E501 + Returns the template information # noqa: E501 """ pass def test_get_smtp_templates(self): """Test case for get_smtp_templates - Get the list of transactional email templates # noqa: E501 + Get the list of email templates # noqa: E501 """ pass @@ -144,7 +144,7 @@ def test_smtp_log_message_id_delete(self): def test_update_smtp_template(self): """Test case for update_smtp_template - Updates a transactional email templates # noqa: E501 + Update an email template # noqa: E501 """ pass diff --git a/test/test_transactional_sms_api.py b/test/test_transactional_sms_api.py index 2a0534f..fe138d2 100644 --- a/test/test_transactional_sms_api.py +++ b/test/test_transactional_sms_api.py @@ -32,7 +32,7 @@ def tearDown(self): def test_get_sms_events(self): """Test case for get_sms_events - Get all the SMS activity (unaggregated events) # noqa: E501 + Get all your SMS activity (unaggregated events) # noqa: E501 """ pass @@ -53,7 +53,7 @@ def test_get_transac_sms_report(self): def test_send_transac_sms(self): """Test case for send_transac_sms - Send the SMS campaign to the specified mobile number # noqa: E501 + Send the SMS campaign to a mobile number # noqa: E501 """ pass diff --git a/test/test_upload_image_to_gallery.py b/test/test_upload_image_to_gallery.py new file mode 100644 index 0000000..a686655 --- /dev/null +++ b/test/test_upload_image_to_gallery.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.upload_image_to_gallery import UploadImageToGallery # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestUploadImageToGallery(unittest.TestCase): + """UploadImageToGallery unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUploadImageToGallery(self): + """Test UploadImageToGallery""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.upload_image_to_gallery.UploadImageToGallery() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main()