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.

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 | getaccount | GET /account | Get your account information, plan and credits details *AttributesApi* | createattribute | POST /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute AttributesApi | deleteattribute | DELETE /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute *AttributesApi* | getattributes | GET /contacts/attributes | List all attributes AttributesApi | updateattribute | PUT /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute *ContactsApi* | addcontacttolist | POST /contacts/lists/{listId}/contacts/add | Add existing contacts to a list ContactsApi | createattribute | POST /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute *ContactsApi* | createcontact | POST /contacts | Create a contact ContactsApi | createdoicontact | POST /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow ContactsApi | createfolder | POST /contacts/folders | Create a folder *ContactsApi* | createlist | POST /contacts/lists | Create a list ContactsApi | deleteattribute | DELETE /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute *ContactsApi* | deletecontact | DELETE /contacts/{email} | Delete a contact ContactsApi | deletefolder | DELETE /contacts/folders/{folderId} | Delete a folder (and all its lists) *ContactsApi* | deletelist | DELETE /contacts/lists/{listId} | Delete a list ContactsApi | getattributes | GET /contacts/attributes | List all attributes *ContactsApi* | getcontactinfo | GET /contacts/{email} | Get a contact's details *ContactsApi* | getcontactstats | GET /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact *ContactsApi* | getcontacts | GET /contacts | Get all the contacts ContactsApi | getcontactsfromlist | GET /contacts/lists/{listId}/contacts | Get contacts in a list *ContactsApi* | getfolder | GET /contacts/folders/{folderId} | Returns a folder's details ContactsApi | getfolderlists | GET /contacts/folders/{folderId}/lists | Get lists in a folder ContactsApi | getfolders | GET /contacts/folders | Get all folders *ContactsApi* | getlist | GET /contacts/lists/{listId} | Get a list's details ContactsApi | getlists | GET /contacts/lists | Get all the lists *ContactsApi* | importcontacts | POST /contacts/import | Import contacts ContactsApi | removecontactfromlist | POST /contacts/lists/{listId}/contacts/remove | Delete a contact from a list *ContactsApi* | requestcontactexport | POST /contacts/export | Export contacts *ContactsApi* | updateattribute | PUT /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute ContactsApi | updatecontact | PUT /contacts/{email} | Update a contact *ContactsApi* | updatefolder | PUT /contacts/folders/{folderId} | Update a folder ContactsApi | updatelist | PUT /contacts/lists/{listId} | Update a list *EmailCampaignsApi* | createemailcampaign | POST /emailCampaigns | Create an email campaign *EmailCampaignsApi* | deleteemailcampaign | DELETE /emailCampaigns/{campaignId} | Delete an email campaign *EmailCampaignsApi* | emailexportrecipients | POST /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign *EmailCampaignsApi* | getabtestcampaignresult | GET /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results *EmailCampaignsApi* | getemailcampaign | GET /emailCampaigns/{campaignId} | Get an email campaign report *EmailCampaignsApi* | getemailcampaigns | GET /emailCampaigns | Return all your created email campaigns *EmailCampaignsApi* | getsharedtemplateurl | GET /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url EmailCampaignsApi | sendemailcampaignnow | POST /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId *EmailCampaignsApi* | sendreport | POST /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign EmailCampaignsApi | sendtestemail | POST /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list EmailCampaignsApi | updatecampaignstatus | PUT /emailCampaigns/{campaignId}/status | Update an email campaign status EmailCampaignsApi | updateemailcampaign | PUT /emailCampaigns/{campaignId} | Update an email campaign EmailCampaignsApi | uploadimagetogallery | POST /emailCampaigns/images | Upload an image to your account's image gallery *FoldersApi* | createfolder | POST /contacts/folders | Create a folder FoldersApi | deletefolder | DELETE /contacts/folders/{folderId} | Delete a folder (and all its lists) *FoldersApi* | getfolder | GET /contacts/folders/{folderId} | Returns a folder's details FoldersApi | getfolderlists | GET /contacts/folders/{folderId}/lists | Get lists in a folder FoldersApi | getfolders | GET /contacts/folders | Get all folders *FoldersApi* | updatefolder | PUT /contacts/folders/{folderId} | Update a folder ListsApi | addcontacttolist | POST /contacts/lists/{listId}/contacts/add | Add existing contacts to a list *ListsApi* | createlist | POST /contacts/lists | Create a list ListsApi | deletelist | DELETE /contacts/lists/{listId} | Delete a list *ListsApi* | getcontactsfromlist | GET /contacts/lists/{listId}/contacts | Get contacts in a list ListsApi | getfolderlists | GET /contacts/folders/{folderId}/lists | Get lists in a folder ListsApi | getlist | GET /contacts/lists/{listId} | Get a list's details *ListsApi* | getlists | GET /contacts/lists | Get all the lists ListsApi | removecontactfromlist | POST /contacts/lists/{listId}/contacts/remove | Delete a contact from a list *ListsApi* | updatelist | PUT /contacts/lists/{listId} | Update a list ProcessApi | getprocess | GET /processes/{processId} | Return the informations for a process *ProcessApi* | getprocesses | GET /processes | Return all the processes for your account ResellerApi | addcredits | POST /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account *ResellerApi* | associateiptochild | POST /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child ResellerApi | createchilddomain | POST /reseller/children/{childIdentifier}/domains | Create a domain for a child account ResellerApi | createresellerchild | POST /reseller/children | Creates a reseller child ResellerApi | deletechilddomain | DELETE /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed ResellerApi | deleteresellerchild | DELETE /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied ResellerApi | dissociateipfromchild | POST /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child *ResellerApi* | getchildaccountcreationstatus | 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* | getchilddomains | GET /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account *ResellerApi* | getchildinfo | GET /reseller/children/{childIdentifier} | Get a child account's details *ResellerApi* | getresellerchilds | GET /reseller/children | Get the list of all children accounts *ResellerApi* | getssotoken | GET /reseller/children/{childIdentifier}/auth | Get session token to access Sendinblue (SSO) *ResellerApi* | removecredits | POST /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account ResellerApi | updatechildaccountstatus | PUT /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the identifier supplied *ResellerApi* | updatechilddomain | PUT /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed *ResellerApi* | updateresellerchild | PUT /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied *SmsCampaignsApi* | createsmscampaign | POST /smsCampaigns | Creates an SMS campaign *SmsCampaignsApi* | deletesmscampaign | DELETE /smsCampaigns/{campaignId} | Delete an SMS campaign *SmsCampaignsApi* | getsmscampaign | GET /smsCampaigns/{campaignId} | Get an SMS campaign *SmsCampaignsApi* | getsmscampaigns | GET /smsCampaigns | Returns the information for all your created SMS campaigns *SmsCampaignsApi* | requestsmsrecipientexport | POST /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients SmsCampaignsApi | sendsmscampaignnow | POST /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately *SmsCampaignsApi* | sendsmsreport | POST /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report *SmsCampaignsApi* | sendtestsms | POST /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign *SmsCampaignsApi* | updatesmscampaign | PUT /smsCampaigns/{campaignId} | Update an SMS campaign *SmsCampaignsApi* | updatesmscampaignstatus | PUT /smsCampaigns/{campaignId}/status | Update a campaign's status SmtpApi | blocknewdomain | POST /smtp/blockedDomains | Add a new domain to the list of blocked domains SmtpApi | createsmtptemplate | POST /smtp/templates | Create an email template SmtpApi | deleteblockeddomain | DELETE /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains SmtpApi | deletehardbounces | POST /smtp/deleteHardbounces | Delete hardbounces *SmtpApi* | deletesmtptemplate | DELETE /smtp/templates/{templateId} | Delete an inactive email template *SmtpApi* | getaggregatedsmtpreport | GET /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time SmtpApi | getblockeddomains | GET /smtp/blockedDomains | Get the list of blocked domains SmtpApi | getemaileventreport | GET /smtp/statistics/events | Get all your transactional email activity (unaggregated events) *SmtpApi* | getsmtpreport | GET /smtp/statistics/reports | Get your transactional email activity aggregated per day *SmtpApi* | getsmtptemplate | GET /smtp/templates/{templateId} | Returns the template information *SmtpApi* | getsmtptemplates | GET /smtp/templates | Get the list of email templates *SmtpApi* | gettransacblockedcontacts | GET /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts SmtpApi | gettransacemailcontent | GET /smtp/emails/{uuid} | Get the personalized content of a sent transactional email *SmtpApi* | gettransacemailslist | GET /smtp/emails | Get the list of transactional emails on the basis of allowed filters SmtpApi | sendtemplate | POST /smtp/templates/{templateId}/send | Send a template *SmtpApi* | sendtesttemplate | POST /smtp/templates/{templateId}/sendTest | Send a template to your test list *SmtpApi* | sendtransacemail | POST /smtp/email | Send a transactional email *SmtpApi* | smtpblockedcontactsemaildelete | DELETE /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact *SmtpApi* | smtplogmessageiddelete | DELETE /smtp/log/{messageId} | Delete an SMTP transactional log *SmtpApi* | updatesmtptemplate | PUT /smtp/templates/{templateId} | Update an email template *SendersApi* | createsender | POST /senders | Create a new sender SendersApi | deletesender | DELETE /senders/{senderId} | Delete a sender *SendersApi* | getips | GET /senders/ips | Get all the dedicated IPs for your account SendersApi | getipsfromsender | GET /senders/{senderId}/ips | Get all the dedicated IPs for a sender *SendersApi* | getsenders | GET /senders | Get the list of all your senders SendersApi | updatesender | PUT /senders/{senderId} | Update a sender *TransactionalSmsApi* | getsmsevents | GET /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) *TransactionalSmsApi* | gettransacaggregatedsmsreport | GET /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time *TransactionalSmsApi* | gettransacsmsreport | GET /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day TransactionalSmsApi | sendtransacsms | POST /transactionalSMS/sms | Send SMS message to a mobile number WebhooksApi | createwebhook | POST /webhooks | Create a webhook *WebhooksApi* | deletewebhook | DELETE /webhooks/{webhookId} | Delete a webhook WebhooksApi | getwebhook | GET /webhooks/{webhookId} | Get a webhook details *WebhooksApi* | getwebhooks | 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