3 stable releases

3.3.0	May 27, 2024
3.1.0	Dec 11, 2022
3.0.0	Nov 27, 2022

#209 in Email

MIT license

1MB
11K SLoC

Rust API client for sendinblue v3

Generated using: https://github.com/OpenAPITools/openapi-generator

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

For more information, please visit https://account.sendinblue.com/support

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

API version: 3.0.0
Package version: 3.0.0
Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named sendinblue-v3 and add the following to Cargo.toml under [dependencies]:

sendinblue-v3 = 3.0.0

Documentation for API Endpoints

All URIs are relative to https://api.sendinblue.com/v3

Class	Method	HTTP request	Description
AccountApi	get_account	GET /account	Get your account information, plan and credits details
AttributesApi	create_attribute	POST /contacts/attributes/{attributeCategory}/{attributeName}	Create contact attribute
AttributesApi	delete_attribute	DELETE /contacts/attributes/{attributeCategory}/{attributeName}	Delete an attribute
AttributesApi	get_attributes	GET /contacts/attributes	List all attributes
AttributesApi	update_attribute	PUT /contacts/attributes/{attributeCategory}/{attributeName}	Update contact attribute
ContactsApi	add_contact_to_list	POST /contacts/lists/{listId}/contacts/add	Add existing contacts to a list
ContactsApi	create_attribute	POST /contacts/attributes/{attributeCategory}/{attributeName}	Create contact attribute
ContactsApi	create_contact	POST /contacts	Create a contact
ContactsApi	create_doi_contact	POST /contacts/doubleOptinConfirmation	Create Contact via DOI (Double-Opt-In) Flow
ContactsApi	create_folder	POST /contacts/folders	Create a folder
ContactsApi	create_list	POST /contacts/lists	Create a list
ContactsApi	delete_attribute	DELETE /contacts/attributes/{attributeCategory}/{attributeName}	Delete an attribute
ContactsApi	delete_contact	DELETE /contacts/{email}	Delete a contact
ContactsApi	delete_folder	DELETE /contacts/folders/{folderId}	Delete a folder (and all its lists)
ContactsApi	delete_list	DELETE /contacts/lists/{listId}	Delete a list
ContactsApi	get_attributes	GET /contacts/attributes	List all attributes
ContactsApi	get_contact_info	GET /contacts/{email}	Get a contact's details
ContactsApi	get_contact_stats	GET /contacts/{email}/campaignStats	Get email campaigns' statistics for a contact
ContactsApi	get_contacts	GET /contacts	Get all the contacts
ContactsApi	get_contacts_from_list	GET /contacts/lists/{listId}/contacts	Get contacts in a list
ContactsApi	get_folder	GET /contacts/folders/{folderId}	Returns a folder's details
ContactsApi	get_folder_lists	GET /contacts/folders/{folderId}/lists	Get lists in a folder
ContactsApi	get_folders	GET /contacts/folders	Get all folders
ContactsApi	get_list	GET /contacts/lists/{listId}	Get a list's details
ContactsApi	get_lists	GET /contacts/lists	Get all the lists
ContactsApi	import_contacts	POST /contacts/import	Import contacts
ContactsApi	remove_contact_from_list	POST /contacts/lists/{listId}/contacts/remove	Delete a contact from a list
ContactsApi	request_contact_export	POST /contacts/export	Export contacts
ContactsApi	update_attribute	PUT /contacts/attributes/{attributeCategory}/{attributeName}	Update contact attribute
ContactsApi	update_contact	PUT /contacts/{email}	Update a contact
ContactsApi	update_folder	PUT /contacts/folders/{folderId}	Update a folder
ContactsApi	update_list	PUT /contacts/lists/{listId}	Update a list
EmailCampaignsApi	create_email_campaign	POST /emailCampaigns	Create an email campaign
EmailCampaignsApi	delete_email_campaign	DELETE /emailCampaigns/{campaignId}	Delete an email campaign
EmailCampaignsApi	email_export_recipients	POST /emailCampaigns/{campaignId}/exportRecipients	Export the recipients of an email campaign
EmailCampaignsApi	get_ab_test_campaign_result	GET /emailCampaigns/{campaignId}/abTestCampaignResult	Get an A/B test email campaign results
EmailCampaignsApi	get_email_campaign	GET /emailCampaigns/{campaignId}	Get an email campaign report
EmailCampaignsApi	get_email_campaigns	GET /emailCampaigns	Return all your created email campaigns
EmailCampaignsApi	get_shared_template_url	GET /emailCampaigns/{campaignId}/sharedUrl	Get a shared template url
EmailCampaignsApi	send_email_campaign_now	POST /emailCampaigns/{campaignId}/sendNow	Send an email campaign immediately, based on campaignId
EmailCampaignsApi	send_report	POST /emailCampaigns/{campaignId}/sendReport	Send the report of a campaign
EmailCampaignsApi	send_test_email	POST /emailCampaigns/{campaignId}/sendTest	Send an email campaign to your test list
EmailCampaignsApi	update_campaign_status	PUT /emailCampaigns/{campaignId}/status	Update an email campaign status
EmailCampaignsApi	update_email_campaign	PUT /emailCampaigns/{campaignId}	Update an email campaign
EmailCampaignsApi	upload_image_to_gallery	POST /emailCampaigns/images	Upload an image to your account's image gallery
FoldersApi	create_folder	POST /contacts/folders	Create a folder
FoldersApi	delete_folder	DELETE /contacts/folders/{folderId}	Delete a folder (and all its lists)
FoldersApi	get_folder	GET /contacts/folders/{folderId}	Returns a folder's details
FoldersApi	get_folder_lists	GET /contacts/folders/{folderId}/lists	Get lists in a folder
FoldersApi	get_folders	GET /contacts/folders	Get all folders
FoldersApi	update_folder	PUT /contacts/folders/{folderId}	Update a folder
ListsApi	add_contact_to_list	POST /contacts/lists/{listId}/contacts/add	Add existing contacts to a list
ListsApi	create_list	POST /contacts/lists	Create a list
ListsApi	delete_list	DELETE /contacts/lists/{listId}	Delete a list
ListsApi	get_contacts_from_list	GET /contacts/lists/{listId}/contacts	Get contacts in a list
ListsApi	get_folder_lists	GET /contacts/folders/{folderId}/lists	Get lists in a folder
ListsApi	get_list	GET /contacts/lists/{listId}	Get a list's details
ListsApi	get_lists	GET /contacts/lists	Get all the lists
ListsApi	remove_contact_from_list	POST /contacts/lists/{listId}/contacts/remove	Delete a contact from a list
ListsApi	update_list	PUT /contacts/lists/{listId}	Update a list
ProcessApi	get_process	GET /processes/{processId}	Return the informations for a process
ProcessApi	get_processes	GET /processes	Return all the processes for your account
ResellerApi	add_credits	POST /reseller/children/{childIdentifier}/credits/add	Add Email and/or SMS credits to a specific child account
ResellerApi	associate_ip_to_child	POST /reseller/children/{childIdentifier}/ips/associate	Associate a dedicated IP to the child
ResellerApi	create_child_domain	POST /reseller/children/{childIdentifier}/domains	Create a domain for a child account
ResellerApi	create_reseller_child	POST /reseller/children	Creates a reseller child
ResellerApi	delete_child_domain	DELETE /reseller/children/{childIdentifier}/domains/{domainName}	Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
ResellerApi	delete_reseller_child	DELETE /reseller/children/{childIdentifier}	Delete a single reseller child based on the child identifier supplied
ResellerApi	dissociate_ip_from_child	POST /reseller/children/{childIdentifier}/ips/dissociate	Dissociate a dedicated IP to the child
ResellerApi	get_child_account_creation_status	GET /reseller/children/{childIdentifier}/accountCreationStatus	Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childIdentifier supplied
ResellerApi	get_child_domains	GET /reseller/children/{childIdentifier}/domains	Get all sender domains for a specific child account
ResellerApi	get_child_info	GET /reseller/children/{childIdentifier}	Get a child account's details
ResellerApi	get_reseller_childs	GET /reseller/children	Get the list of all children accounts
ResellerApi	get_sso_token	GET /reseller/children/{childIdentifier}/auth	Get session token to access Sendinblue (SSO)
ResellerApi	remove_credits	POST /reseller/children/{childIdentifier}/credits/remove	Remove Email and/or SMS credits from a specific child account
ResellerApi	update_child_account_status	PUT /reseller/children/{childIdentifier}/accountStatus	Update info of reseller's child account status based on the identifier supplied
ResellerApi	update_child_domain	PUT /reseller/children/{childIdentifier}/domains/{domainName}	Update the sender domain of reseller's child based on the childIdentifier and domainName passed
ResellerApi	update_reseller_child	PUT /reseller/children/{childIdentifier}	Update info of reseller's child based on the child identifier supplied
SmsCampaignsApi	create_sms_campaign	POST /smsCampaigns	Creates an SMS campaign
SmsCampaignsApi	delete_sms_campaign	DELETE /smsCampaigns/{campaignId}	Delete an SMS campaign
SmsCampaignsApi	get_sms_campaign	GET /smsCampaigns/{campaignId}	Get an SMS campaign
SmsCampaignsApi	get_sms_campaigns	GET /smsCampaigns	Returns the information for all your created SMS campaigns
SmsCampaignsApi	request_sms_recipient_export	POST /smsCampaigns/{campaignId}/exportRecipients	Export an SMS campaign's recipients
SmsCampaignsApi	send_sms_campaign_now	POST /smsCampaigns/{campaignId}/sendNow	Send your SMS campaign immediately
SmsCampaignsApi	send_sms_report	POST /smsCampaigns/{campaignId}/sendReport	Send an SMS campaign's report
SmsCampaignsApi	send_test_sms	POST /smsCampaigns/{campaignId}/sendTest	Send a test SMS campaign
SmsCampaignsApi	update_sms_campaign	PUT /smsCampaigns/{campaignId}	Update an SMS campaign
SmsCampaignsApi	update_sms_campaign_status	PUT /smsCampaigns/{campaignId}/status	Update a campaign's status
SmtpApi	block_new_domain	POST /smtp/blockedDomains	Add a new domain to the list of blocked domains
SmtpApi	create_smtp_template	POST /smtp/templates	Create an email template
SmtpApi	delete_blocked_domain	DELETE /smtp/blockedDomains/{domain}	Unblock an existing domain from the list of blocked domains
SmtpApi	delete_hardbounces	POST /smtp/deleteHardbounces	Delete hardbounces
SmtpApi	delete_smtp_template	DELETE /smtp/templates/{templateId}	Delete an inactive email template
SmtpApi	get_aggregated_smtp_report	GET /smtp/statistics/aggregatedReport	Get your transactional email activity aggregated over a period of time
SmtpApi	get_blocked_domains	GET /smtp/blockedDomains	Get the list of blocked domains
SmtpApi	get_email_event_report	GET /smtp/statistics/events	Get all your transactional email activity (unaggregated events)
SmtpApi	get_smtp_report	GET /smtp/statistics/reports	Get your transactional email activity aggregated per day
SmtpApi	get_smtp_template	GET /smtp/templates/{templateId}	Returns the template information
SmtpApi	get_smtp_templates	GET /smtp/templates	Get the list of email templates
SmtpApi	get_transac_blocked_contacts	GET /smtp/blockedContacts	Get the list of blocked or unsubscribed transactional contacts
SmtpApi	get_transac_email_content	GET /smtp/emails/{uuid}	Get the personalized content of a sent transactional email
SmtpApi	get_transac_emails_list	GET /smtp/emails	Get the list of transactional emails on the basis of allowed filters
SmtpApi	send_template	POST /smtp/templates/{templateId}/send	Send a template
SmtpApi	send_test_template	POST /smtp/templates/{templateId}/sendTest	Send a template to your test list
SmtpApi	send_transac_email	POST /smtp/email	Send a transactional email
SmtpApi	smtp_blocked_contacts_email_delete	DELETE /smtp/blockedContacts/{email}	Unblock or resubscribe a transactional contact
SmtpApi	smtp_log_message_id_delete	DELETE /smtp/log/{messageId}	Delete an SMTP transactional log
SmtpApi	update_smtp_template	PUT /smtp/templates/{templateId}	Update an email template
SendersApi	create_sender	POST /senders	Create a new sender
SendersApi	delete_sender	DELETE /senders/{senderId}	Delete a sender
SendersApi	get_ips	GET /senders/ips	Get all the dedicated IPs for your account
SendersApi	get_ips_from_sender	GET /senders/{senderId}/ips	Get all the dedicated IPs for a sender
SendersApi	get_senders	GET /senders	Get the list of all your senders
SendersApi	update_sender	PUT /senders/{senderId}	Update a sender
TransactionalSmsApi	get_sms_events	GET /transactionalSMS/statistics/events	Get all your SMS activity (unaggregated events)
TransactionalSmsApi	get_transac_aggregated_sms_report	GET /transactionalSMS/statistics/aggregatedReport	Get your SMS activity aggregated over a period of time
TransactionalSmsApi	get_transac_sms_report	GET /transactionalSMS/statistics/reports	Get your SMS activity aggregated per day
TransactionalSmsApi	send_transac_sms	POST /transactionalSMS/sms	Send SMS message to a mobile number
WebhooksApi	create_webhook	POST /webhooks	Create a webhook
WebhooksApi	delete_webhook	DELETE /webhooks/{webhookId}	Delete a webhook
WebhooksApi	get_webhook	GET /webhooks/{webhookId}	Get a webhook details
WebhooksApi	get_webhooks	GET /webhooks	Get all webhooks
WebhooksApi	update_webhook	PUT /webhooks/{webhookId}	Update a webhook

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

contact@sendinblue.com

Dependencies

~5–17MB
~217K SLoC