diff --git a/README.md b/README.md index f4e3f72..3b64f2d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ SendinBlue's API matches the [OpenAPI v2 definition](https://www.openapis.org/). This C# SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by SendinBlue: - API version: 3.0.0 -- SDK version: 2.1.0 +- SDK version: 2.1.1 - Build package: io.swagger.codegen.languages.CSharpClientCodegen For more information, please visit [https://account.sendinblue.com/support](https://account.sendinblue.com/support) @@ -68,7 +68,7 @@ namespace Example try { - // Get your account informations, plans and credits details + // Get your account information, plan and credits details GetAccount result = apiInstance.GetAccount(); Debug.WriteLine(result); } @@ -88,100 +88,102 @@ All URIs are relative to *https://api.sendinblue.com/v3* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*AccountApi* | [**GetAccount**](docs/AccountApi.md#getaccount) | **GET** /account | Get your account informations, plans and credits details -*AttributesApi* | [**CreateAttribute**](docs/AttributesApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute -*AttributesApi* | [**DeleteAttribute**](docs/AttributesApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute -*AttributesApi* | [**GetAttributes**](docs/AttributesApi.md#getattributes) | **GET** /contacts/attributes | Lists all attributes -*AttributesApi* | [**UpdateAttribute**](docs/AttributesApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute +*AccountApi* | [**GetAccount**](docs/AccountApi.md#getaccount) | **GET** /account | Get your account information, plan and credits details +*AttributesApi* | [**CreateAttribute**](docs/AttributesApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute +*AttributesApi* | [**DeleteAttribute**](docs/AttributesApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute +*AttributesApi* | [**GetAttributes**](docs/AttributesApi.md#getattributes) | **GET** /contacts/attributes | List all attributes +*AttributesApi* | [**UpdateAttribute**](docs/AttributesApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute *ContactsApi* | [**AddContactToList**](docs/ContactsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list -*ContactsApi* | [**CreateAttribute**](docs/ContactsApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute +*ContactsApi* | [**CreateAttribute**](docs/ContactsApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute *ContactsApi* | [**CreateContact**](docs/ContactsApi.md#createcontact) | **POST** /contacts | Create a contact +*ContactsApi* | [**CreateDoiContact**](docs/ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create a contact to trigger the DOI workflow from a Landing Page form *ContactsApi* | [**CreateFolder**](docs/ContactsApi.md#createfolder) | **POST** /contacts/folders | Create a folder *ContactsApi* | [**CreateList**](docs/ContactsApi.md#createlist) | **POST** /contacts/lists | Create a list -*ContactsApi* | [**DeleteAttribute**](docs/ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute -*ContactsApi* | [**DeleteContact**](docs/ContactsApi.md#deletecontact) | **DELETE** /contacts/{email} | Deletes a contact +*ContactsApi* | [**DeleteAttribute**](docs/ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute +*ContactsApi* | [**DeleteContact**](docs/ContactsApi.md#deletecontact) | **DELETE** /contacts/{email} | Delete a contact *ContactsApi* | [**DeleteFolder**](docs/ContactsApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) *ContactsApi* | [**DeleteList**](docs/ContactsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list -*ContactsApi* | [**GetAttributes**](docs/ContactsApi.md#getattributes) | **GET** /contacts/attributes | Lists all attributes -*ContactsApi* | [**GetContactInfo**](docs/ContactsApi.md#getcontactinfo) | **GET** /contacts/{email} | Retrieves contact informations -*ContactsApi* | [**GetContactStats**](docs/ContactsApi.md#getcontactstats) | **GET** /contacts/{email}/campaignStats | Get the campaigns statistics for a contact +*ContactsApi* | [**GetAttributes**](docs/ContactsApi.md#getattributes) | **GET** /contacts/attributes | List all attributes +*ContactsApi* | [**GetContactInfo**](docs/ContactsApi.md#getcontactinfo) | **GET** /contacts/{email} | Get a contact's details +*ContactsApi* | [**GetContactStats**](docs/ContactsApi.md#getcontactstats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact *ContactsApi* | [**GetContacts**](docs/ContactsApi.md#getcontacts) | **GET** /contacts | Get all the contacts -*ContactsApi* | [**GetContactsFromList**](docs/ContactsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list -*ContactsApi* | [**GetFolder**](docs/ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns folder details -*ContactsApi* | [**GetFolderLists**](docs/ContactsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -*ContactsApi* | [**GetFolders**](docs/ContactsApi.md#getfolders) | **GET** /contacts/folders | Get all the folders -*ContactsApi* | [**GetList**](docs/ContactsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get the details of a list +*ContactsApi* | [**GetContactsFromList**](docs/ContactsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list +*ContactsApi* | [**GetFolder**](docs/ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details +*ContactsApi* | [**GetFolderLists**](docs/ContactsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +*ContactsApi* | [**GetFolders**](docs/ContactsApi.md#getfolders) | **GET** /contacts/folders | Get all folders +*ContactsApi* | [**GetList**](docs/ContactsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details *ContactsApi* | [**GetLists**](docs/ContactsApi.md#getlists) | **GET** /contacts/lists | Get all the lists *ContactsApi* | [**ImportContacts**](docs/ContactsApi.md#importcontacts) | **POST** /contacts/import | Import contacts -*ContactsApi* | [**RemoveContactFromList**](docs/ContactsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list +*ContactsApi* | [**RemoveContactFromList**](docs/ContactsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list *ContactsApi* | [**RequestContactExport**](docs/ContactsApi.md#requestcontactexport) | **POST** /contacts/export | Export contacts -*ContactsApi* | [**UpdateAttribute**](docs/ContactsApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute -*ContactsApi* | [**UpdateContact**](docs/ContactsApi.md#updatecontact) | **PUT** /contacts/{email} | Updates a contact -*ContactsApi* | [**UpdateFolder**](docs/ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a contact folder +*ContactsApi* | [**UpdateAttribute**](docs/ContactsApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute +*ContactsApi* | [**UpdateContact**](docs/ContactsApi.md#updatecontact) | **PUT** /contacts/{email} | Update a contact +*ContactsApi* | [**UpdateFolder**](docs/ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder *ContactsApi* | [**UpdateList**](docs/ContactsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list *EmailCampaignsApi* | [**CreateEmailCampaign**](docs/EmailCampaignsApi.md#createemailcampaign) | **POST** /emailCampaigns | Create an email campaign *EmailCampaignsApi* | [**DeleteEmailCampaign**](docs/EmailCampaignsApi.md#deleteemailcampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign -*EmailCampaignsApi* | [**EmailExportRecipients**](docs/EmailCampaignsApi.md#emailexportrecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign -*EmailCampaignsApi* | [**GetAbTestCampaignResult**](docs/EmailCampaignsApi.md#getabtestcampaignresult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get A/B test email campaign result -*EmailCampaignsApi* | [**GetEmailCampaign**](docs/EmailCampaignsApi.md#getemailcampaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations -*EmailCampaignsApi* | [**GetEmailCampaigns**](docs/EmailCampaignsApi.md#getemailcampaigns) | **GET** /emailCampaigns | Return all your created campaigns +*EmailCampaignsApi* | [**EmailExportRecipients**](docs/EmailCampaignsApi.md#emailexportrecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign +*EmailCampaignsApi* | [**GetAbTestCampaignResult**](docs/EmailCampaignsApi.md#getabtestcampaignresult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results +*EmailCampaignsApi* | [**GetEmailCampaign**](docs/EmailCampaignsApi.md#getemailcampaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report +*EmailCampaignsApi* | [**GetEmailCampaigns**](docs/EmailCampaignsApi.md#getemailcampaigns) | **GET** /emailCampaigns | Return all your created email campaigns *EmailCampaignsApi* | [**GetSharedTemplateUrl**](docs/EmailCampaignsApi.md#getsharedtemplateurl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url *EmailCampaignsApi* | [**SendEmailCampaignNow**](docs/EmailCampaignsApi.md#sendemailcampaignnow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId -*EmailCampaignsApi* | [**SendReport**](docs/EmailCampaignsApi.md#sendreport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns +*EmailCampaignsApi* | [**SendReport**](docs/EmailCampaignsApi.md#sendreport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign *EmailCampaignsApi* | [**SendTestEmail**](docs/EmailCampaignsApi.md#sendtestemail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list -*EmailCampaignsApi* | [**UpdateCampaignStatus**](docs/EmailCampaignsApi.md#updatecampaignstatus) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status -*EmailCampaignsApi* | [**UpdateEmailCampaign**](docs/EmailCampaignsApi.md#updateemailcampaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign +*EmailCampaignsApi* | [**UpdateCampaignStatus**](docs/EmailCampaignsApi.md#updatecampaignstatus) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status +*EmailCampaignsApi* | [**UpdateEmailCampaign**](docs/EmailCampaignsApi.md#updateemailcampaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign +*EmailCampaignsApi* | [**UploadImageToGallery**](docs/EmailCampaignsApi.md#uploadimagetogallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery *FoldersApi* | [**CreateFolder**](docs/FoldersApi.md#createfolder) | **POST** /contacts/folders | Create a folder *FoldersApi* | [**DeleteFolder**](docs/FoldersApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) -*FoldersApi* | [**GetFolder**](docs/FoldersApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns folder details -*FoldersApi* | [**GetFolderLists**](docs/FoldersApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -*FoldersApi* | [**GetFolders**](docs/FoldersApi.md#getfolders) | **GET** /contacts/folders | Get all the folders -*FoldersApi* | [**UpdateFolder**](docs/FoldersApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a contact folder +*FoldersApi* | [**GetFolder**](docs/FoldersApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details +*FoldersApi* | [**GetFolderLists**](docs/FoldersApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +*FoldersApi* | [**GetFolders**](docs/FoldersApi.md#getfolders) | **GET** /contacts/folders | Get all folders +*FoldersApi* | [**UpdateFolder**](docs/FoldersApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder *ListsApi* | [**AddContactToList**](docs/ListsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list *ListsApi* | [**CreateList**](docs/ListsApi.md#createlist) | **POST** /contacts/lists | Create a list *ListsApi* | [**DeleteList**](docs/ListsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list -*ListsApi* | [**GetContactsFromList**](docs/ListsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list -*ListsApi* | [**GetFolderLists**](docs/ListsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -*ListsApi* | [**GetList**](docs/ListsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get the details of a list +*ListsApi* | [**GetContactsFromList**](docs/ListsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list +*ListsApi* | [**GetFolderLists**](docs/ListsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +*ListsApi* | [**GetList**](docs/ListsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details *ListsApi* | [**GetLists**](docs/ListsApi.md#getlists) | **GET** /contacts/lists | Get all the lists -*ListsApi* | [**RemoveContactFromList**](docs/ListsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list +*ListsApi* | [**RemoveContactFromList**](docs/ListsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list *ListsApi* | [**UpdateList**](docs/ListsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list *ProcessApi* | [**GetProcess**](docs/ProcessApi.md#getprocess) | **GET** /processes/{processId} | Return the informations for a process *ProcessApi* | [**GetProcesses**](docs/ProcessApi.md#getprocesses) | **GET** /processes | Return all the processes for your account *ResellerApi* | [**AddCredits**](docs/ResellerApi.md#addcredits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account *ResellerApi* | [**AssociateIpToChild**](docs/ResellerApi.md#associateiptochild) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child -*ResellerApi* | [**CreateChildDomain**](docs/ResellerApi.md#createchilddomain) | **POST** /reseller/children/{childAuthKey}/domains | Creates a domain for a child account +*ResellerApi* | [**CreateChildDomain**](docs/ResellerApi.md#createchilddomain) | **POST** /reseller/children/{childAuthKey}/domains | Create a domain for a child account *ResellerApi* | [**CreateResellerChild**](docs/ResellerApi.md#createresellerchild) | **POST** /reseller/children | Creates a reseller child -*ResellerApi* | [**DeleteChildDomain**](docs/ResellerApi.md#deletechilddomain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed -*ResellerApi* | [**DeleteResellerChild**](docs/ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied +*ResellerApi* | [**DeleteChildDomain**](docs/ResellerApi.md#deletechilddomain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Delete the sender domain of the reseller child based on the childAuthKey and domainName passed +*ResellerApi* | [**DeleteResellerChild**](docs/ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childAuthKey} | Delete a single reseller child based on the childAuthKey supplied *ResellerApi* | [**DissociateIpFromChild**](docs/ResellerApi.md#dissociateipfromchild) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child -*ResellerApi* | [**GetChildAccountCreationStatus**](docs/ResellerApi.md#getchildaccountcreationstatus) | **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* | [**GetChildDomains**](docs/ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account -*ResellerApi* | [**GetChildInfo**](docs/ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account -*ResellerApi* | [**GetResellerChilds**](docs/ResellerApi.md#getresellerchilds) | **GET** /reseller/children | Gets the list of all reseller's children accounts +*ResellerApi* | [**GetChildAccountCreationStatus**](docs/ResellerApi.md#getchildaccountcreationstatus) | **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* | [**GetChildDomains**](docs/ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childAuthKey}/domains | Get all sender domains for a specific child account +*ResellerApi* | [**GetChildInfo**](docs/ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childAuthKey} | Get a child account's details +*ResellerApi* | [**GetResellerChilds**](docs/ResellerApi.md#getresellerchilds) | **GET** /reseller/children | Get the list of all children accounts *ResellerApi* | [**GetSsoToken**](docs/ResellerApi.md#getssotoken) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO) *ResellerApi* | [**RemoveCredits**](docs/ResellerApi.md#removecredits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account -*ResellerApi* | [**UpdateChildAccountStatus**](docs/ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied -*ResellerApi* | [**UpdateChildDomain**](docs/ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed -*ResellerApi* | [**UpdateResellerChild**](docs/ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied +*ResellerApi* | [**UpdateChildAccountStatus**](docs/ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Update info of reseller's child account status based on the childAuthKey supplied +*ResellerApi* | [**UpdateChildDomain**](docs/ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Update the sender domain of reseller's child based on the childAuthKey and domainName passed +*ResellerApi* | [**UpdateResellerChild**](docs/ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childAuthKey} | Update info of reseller's child based on the childAuthKey supplied *SMSCampaignsApi* | [**CreateSmsCampaign**](docs/SMSCampaignsApi.md#createsmscampaign) | **POST** /smsCampaigns | Creates an SMS campaign -*SMSCampaignsApi* | [**DeleteSmsCampaign**](docs/SMSCampaignsApi.md#deletesmscampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign +*SMSCampaignsApi* | [**DeleteSmsCampaign**](docs/SMSCampaignsApi.md#deletesmscampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign *SMSCampaignsApi* | [**GetSmsCampaign**](docs/SMSCampaignsApi.md#getsmscampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign -*SMSCampaignsApi* | [**GetSmsCampaigns**](docs/SMSCampaignsApi.md#getsmscampaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns -*SMSCampaignsApi* | [**RequestSmsRecipientExport**](docs/SMSCampaignsApi.md#requestsmsrecipientexport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign. +*SMSCampaignsApi* | [**GetSmsCampaigns**](docs/SMSCampaignsApi.md#getsmscampaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns +*SMSCampaignsApi* | [**RequestSmsRecipientExport**](docs/SMSCampaignsApi.md#requestsmsrecipientexport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients *SMSCampaignsApi* | [**SendSmsCampaignNow**](docs/SMSCampaignsApi.md#sendsmscampaignnow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately -*SMSCampaignsApi* | [**SendSmsReport**](docs/SMSCampaignsApi.md#sendsmsreport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns -*SMSCampaignsApi* | [**SendTestSms**](docs/SMSCampaignsApi.md#sendtestsms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS -*SMSCampaignsApi* | [**UpdateSmsCampaign**](docs/SMSCampaignsApi.md#updatesmscampaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign -*SMSCampaignsApi* | [**UpdateSmsCampaignStatus**](docs/SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status -*SMTPApi* | [**CreateSmtpTemplate**](docs/SMTPApi.md#createsmtptemplate) | **POST** /smtp/templates | Create a transactional email template +*SMSCampaignsApi* | [**SendSmsReport**](docs/SMSCampaignsApi.md#sendsmsreport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report +*SMSCampaignsApi* | [**SendTestSms**](docs/SMSCampaignsApi.md#sendtestsms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign +*SMSCampaignsApi* | [**UpdateSmsCampaign**](docs/SMSCampaignsApi.md#updatesmscampaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign +*SMSCampaignsApi* | [**UpdateSmsCampaignStatus**](docs/SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status +*SMTPApi* | [**CreateSmtpTemplate**](docs/SMTPApi.md#createsmtptemplate) | **POST** /smtp/templates | Create an email template *SMTPApi* | [**DeleteHardbounces**](docs/SMTPApi.md#deletehardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces -*SMTPApi* | [**DeleteSmtpTemplate**](docs/SMTPApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive transactional email template +*SMTPApi* | [**DeleteSmtpTemplate**](docs/SMTPApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template *SMTPApi* | [**GetAggregatedSmtpReport**](docs/SMTPApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time *SMTPApi* | [**GetEmailEventReport**](docs/SMTPApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) *SMTPApi* | [**GetSmtpReport**](docs/SMTPApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day -*SMTPApi* | [**GetSmtpTemplate**](docs/SMTPApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template informations -*SMTPApi* | [**GetSmtpTemplates**](docs/SMTPApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of transactional email templates +*SMTPApi* | [**GetSmtpTemplate**](docs/SMTPApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template information +*SMTPApi* | [**GetSmtpTemplates**](docs/SMTPApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of email templates *SMTPApi* | [**GetTransacBlockedContacts**](docs/SMTPApi.md#gettransacblockedcontacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts *SMTPApi* | [**GetTransacEmailContent**](docs/SMTPApi.md#gettransacemailcontent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email *SMTPApi* | [**GetTransacEmailsList**](docs/SMTPApi.md#gettransacemailslist) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters @@ -190,17 +192,17 @@ Class | Method | HTTP request | Description *SMTPApi* | [**SendTransacEmail**](docs/SMTPApi.md#sendtransacemail) | **POST** /smtp/email | Send a transactional email *SMTPApi* | [**SmtpBlockedContactsEmailDelete**](docs/SMTPApi.md#smtpblockedcontactsemaildelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact *SMTPApi* | [**SmtpLogMessageIdDelete**](docs/SMTPApi.md#smtplogmessageiddelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log -*SMTPApi* | [**UpdateSmtpTemplate**](docs/SMTPApi.md#updatesmtptemplate) | **PUT** /smtp/templates/{templateId} | Updates a transactional email templates +*SMTPApi* | [**UpdateSmtpTemplate**](docs/SMTPApi.md#updatesmtptemplate) | **PUT** /smtp/templates/{templateId} | Update an email template *SendersApi* | [**CreateSender**](docs/SendersApi.md#createsender) | **POST** /senders | Create a new sender *SendersApi* | [**DeleteSender**](docs/SendersApi.md#deletesender) | **DELETE** /senders/{senderId} | Delete a sender -*SendersApi* | [**GetIps**](docs/SendersApi.md#getips) | **GET** /senders/ips | Return all the dedicated IPs for your account -*SendersApi* | [**GetIpsFromSender**](docs/SendersApi.md#getipsfromsender) | **GET** /senders/{senderId}/ips | Return all the dedicated IPs for a sender +*SendersApi* | [**GetIps**](docs/SendersApi.md#getips) | **GET** /senders/ips | Get all the dedicated IPs for your account +*SendersApi* | [**GetIpsFromSender**](docs/SendersApi.md#getipsfromsender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender *SendersApi* | [**GetSenders**](docs/SendersApi.md#getsenders) | **GET** /senders | Get the list of all your senders *SendersApi* | [**UpdateSender**](docs/SendersApi.md#updatesender) | **PUT** /senders/{senderId} | Update a sender -*TransactionalSMSApi* | [**GetSmsEvents**](docs/TransactionalSMSApi.md#getsmsevents) | **GET** /transactionalSMS/statistics/events | Get all the SMS activity (unaggregated events) +*TransactionalSMSApi* | [**GetSmsEvents**](docs/TransactionalSMSApi.md#getsmsevents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) *TransactionalSMSApi* | [**GetTransacAggregatedSmsReport**](docs/TransactionalSMSApi.md#gettransacaggregatedsmsreport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time *TransactionalSMSApi* | [**GetTransacSmsReport**](docs/TransactionalSMSApi.md#gettransacsmsreport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day -*TransactionalSMSApi* | [**SendTransacSms**](docs/TransactionalSMSApi.md#sendtransacsms) | **POST** /transactionalSMS/sms | Send the SMS campaign to the specified mobile number +*TransactionalSMSApi* | [**SendTransacSms**](docs/TransactionalSMSApi.md#sendtransacsms) | **POST** /transactionalSMS/sms | Send the SMS campaign to a mobile number *WebhooksApi* | [**CreateWebhook**](docs/WebhooksApi.md#createwebhook) | **POST** /webhooks | Create a webhook *WebhooksApi* | [**DeleteWebhook**](docs/WebhooksApi.md#deletewebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook *WebhooksApi* | [**GetWebhook**](docs/WebhooksApi.md#getwebhook) | **GET** /webhooks/{webhookId} | Get a webhook details @@ -208,6 +210,7 @@ Class | Method | HTTP request | Description *WebhooksApi* | [**UpdateWebhook**](docs/WebhooksApi.md#updatewebhook) | **PUT** /webhooks/{webhookId} | Update a webhook + ## Documentation for Models - [Model.AbTestCampaignResult](docs/AbTestCampaignResult.md) @@ -218,6 +221,7 @@ Class | Method | HTTP request | Description - [Model.CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md) - [Model.CreateChild](docs/CreateChild.md) - [Model.CreateContact](docs/CreateContact.md) + - [Model.CreateDoiContact](docs/CreateDoiContact.md) - [Model.CreateEmailCampaign](docs/CreateEmailCampaign.md) - [Model.CreateEmailCampaignRecipients](docs/CreateEmailCampaignRecipients.md) - [Model.CreateEmailCampaignSender](docs/CreateEmailCampaignSender.md) @@ -371,6 +375,7 @@ Class | Method | HTTP request | Description - [Model.UpdateSmtpTemplate](docs/UpdateSmtpTemplate.md) - [Model.UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md) - [Model.UpdateWebhook](docs/UpdateWebhook.md) + - [Model.UploadImageToGallery](docs/UploadImageToGallery.md) - [Model.GetChildInfo](docs/GetChildInfo.md) - [Model.GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md) - [Model.GetExtendedClient](docs/GetExtendedClient.md) diff --git a/docs/AccountApi.md b/docs/AccountApi.md index 434f632..dc4ad97 100644 --- a/docs/AccountApi.md +++ b/docs/AccountApi.md @@ -4,14 +4,14 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**GetAccount**](AccountApi.md#getaccount) | **GET** /account | Get your account informations, plans and credits details +[**GetAccount**](AccountApi.md#getaccount) | **GET** /account | Get your account information, plan and credits details # **GetAccount** > GetAccount GetAccount () -Get your account informations, plans and credits details +Get your account information, plan and credits details ### Example ```csharp @@ -40,7 +40,7 @@ namespace Example try { - // Get your account informations, plans and credits details + // Get your account information, plan and credits details GetAccount result = apiInstance.GetAccount(); Debug.WriteLine(result); } diff --git a/docs/AddContactToList.md b/docs/AddContactToList.md index 9801726..2b949bc 100644 --- a/docs/AddContactToList.md +++ b/docs/AddContactToList.md @@ -3,7 +3,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Emails** | **List<string>** | Emails to add to a list | [optional] +**Emails** | **List<string>** | 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 3a54d39..325a303 100644 --- a/docs/AttributesApi.md +++ b/docs/AttributesApi.md @@ -4,17 +4,17 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**CreateAttribute**](AttributesApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute -[**DeleteAttribute**](AttributesApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute -[**GetAttributes**](AttributesApi.md#getattributes) | **GET** /contacts/attributes | Lists all attributes -[**UpdateAttribute**](AttributesApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute +[**CreateAttribute**](AttributesApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute +[**DeleteAttribute**](AttributesApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute +[**GetAttributes**](AttributesApi.md#getattributes) | **GET** /contacts/attributes | List all attributes +[**UpdateAttribute**](AttributesApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute # **CreateAttribute** > void CreateAttribute (string attributeCategory, string attributeName, CreateAttribute createAttribute) -Creates contact attribute +Create contact attribute ### Example ```csharp @@ -46,7 +46,7 @@ namespace Example try { - // Creates contact attribute + // Create contact attribute apiInstance.CreateAttribute(attributeCategory, attributeName, createAttribute); } catch (Exception e) @@ -85,7 +85,7 @@ void (empty response body) # **DeleteAttribute** > void DeleteAttribute (string attributeCategory, string attributeName) -Deletes an attribute +Delete an attribute ### Example ```csharp @@ -116,7 +116,7 @@ namespace Example try { - // Deletes an attribute + // Delete an attribute apiInstance.DeleteAttribute(attributeCategory, attributeName); } catch (Exception e) @@ -154,7 +154,7 @@ void (empty response body) # **GetAttributes** > GetAttributes GetAttributes () -Lists all attributes +List all attributes ### Example ```csharp @@ -183,7 +183,7 @@ namespace Example try { - // Lists all attributes + // List all attributes GetAttributes result = apiInstance.GetAttributes(); Debug.WriteLine(result); } @@ -218,7 +218,7 @@ This endpoint does not need any parameter. # **UpdateAttribute** > void UpdateAttribute (string attributeCategory, string attributeName, UpdateAttribute updateAttribute) -Updates contact attribute +Update contact attribute ### Example ```csharp @@ -250,7 +250,7 @@ namespace Example try { - // Updates contact attribute + // Update contact attribute apiInstance.UpdateAttribute(attributeCategory, attributeName, updateAttribute); } catch (Exception e) diff --git a/docs/ContactsApi.md b/docs/ContactsApi.md index 05c6269..be61176 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 ------------- | ------------- | ------------- [**AddContactToList**](ContactsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list -[**CreateAttribute**](ContactsApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute +[**CreateAttribute**](ContactsApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute [**CreateContact**](ContactsApi.md#createcontact) | **POST** /contacts | Create a contact +[**CreateDoiContact**](ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create a contact to trigger the DOI workflow from a Landing Page form [**CreateFolder**](ContactsApi.md#createfolder) | **POST** /contacts/folders | Create a folder [**CreateList**](ContactsApi.md#createlist) | **POST** /contacts/lists | Create a list -[**DeleteAttribute**](ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute -[**DeleteContact**](ContactsApi.md#deletecontact) | **DELETE** /contacts/{email} | Deletes a contact +[**DeleteAttribute**](ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute +[**DeleteContact**](ContactsApi.md#deletecontact) | **DELETE** /contacts/{email} | Delete a contact [**DeleteFolder**](ContactsApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) [**DeleteList**](ContactsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list -[**GetAttributes**](ContactsApi.md#getattributes) | **GET** /contacts/attributes | Lists all attributes -[**GetContactInfo**](ContactsApi.md#getcontactinfo) | **GET** /contacts/{email} | Retrieves contact informations -[**GetContactStats**](ContactsApi.md#getcontactstats) | **GET** /contacts/{email}/campaignStats | Get the campaigns statistics for a contact +[**GetAttributes**](ContactsApi.md#getattributes) | **GET** /contacts/attributes | List all attributes +[**GetContactInfo**](ContactsApi.md#getcontactinfo) | **GET** /contacts/{email} | Get a contact's details +[**GetContactStats**](ContactsApi.md#getcontactstats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact [**GetContacts**](ContactsApi.md#getcontacts) | **GET** /contacts | Get all the contacts -[**GetContactsFromList**](ContactsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list -[**GetFolder**](ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns folder details -[**GetFolderLists**](ContactsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -[**GetFolders**](ContactsApi.md#getfolders) | **GET** /contacts/folders | Get all the folders -[**GetList**](ContactsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get the details of a list +[**GetContactsFromList**](ContactsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list +[**GetFolder**](ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details +[**GetFolderLists**](ContactsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +[**GetFolders**](ContactsApi.md#getfolders) | **GET** /contacts/folders | Get all folders +[**GetList**](ContactsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details [**GetLists**](ContactsApi.md#getlists) | **GET** /contacts/lists | Get all the lists [**ImportContacts**](ContactsApi.md#importcontacts) | **POST** /contacts/import | Import contacts -[**RemoveContactFromList**](ContactsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list +[**RemoveContactFromList**](ContactsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list [**RequestContactExport**](ContactsApi.md#requestcontactexport) | **POST** /contacts/export | Export contacts -[**UpdateAttribute**](ContactsApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute -[**UpdateContact**](ContactsApi.md#updatecontact) | **PUT** /contacts/{email} | Updates a contact -[**UpdateFolder**](ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a contact folder +[**UpdateAttribute**](ContactsApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute +[**UpdateContact**](ContactsApi.md#updatecontact) | **PUT** /contacts/{email} | Update a contact +[**UpdateFolder**](ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder [**UpdateList**](ContactsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list @@ -106,7 +107,7 @@ Name | Type | Description | Notes # **CreateAttribute** > void CreateAttribute (string attributeCategory, string attributeName, CreateAttribute createAttribute) -Creates contact attribute +Create contact attribute ### Example ```csharp @@ -138,7 +139,7 @@ namespace Example try { - // Creates contact attribute + // Create contact attribute apiInstance.CreateAttribute(attributeCategory, attributeName, createAttribute); } catch (Exception e) @@ -241,6 +242,73 @@ 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) + +# **CreateDoiContact** +> void CreateDoiContact (CreateDoiContact createDoiContact) + +Create a contact to trigger the DOI workflow from a Landing Page form + +### Example +```csharp +using System; +using System.Diagnostics; +using sib_api_v3_sdk.Api; +using sib_api_v3_sdk.Client; +using sib_api_v3_sdk.Model; + +namespace Example +{ + public class CreateDoiContactExample + { + public void main() + { + // Configure API key authorization: api-key + Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY"); + // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed + // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer"); + // Configure API key authorization: partner-key + Configuration.Default.AddApiKey("partner-key", "YOUR_API_KEY"); + // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed + // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); + + var apiInstance = new ContactsApi(); + var createDoiContact = new CreateDoiContact(); // CreateDoiContact | Values to create the DOI contact + + try + { + // Create a contact to trigger the DOI workflow from a Landing Page form + apiInstance.CreateDoiContact(createDoiContact); + } + catch (Exception e) + { + Debug.Print("Exception when calling ContactsApi.CreateDoiContact: " + e.Message ); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createDoiContact** | [**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) + # **CreateFolder** > CreateModel CreateFolder (CreateUpdateFolder createFolder) @@ -381,7 +449,7 @@ Name | Type | Description | Notes # **DeleteAttribute** > void DeleteAttribute (string attributeCategory, string attributeName) -Deletes an attribute +Delete an attribute ### Example ```csharp @@ -412,7 +480,7 @@ namespace Example try { - // Deletes an attribute + // Delete an attribute apiInstance.DeleteAttribute(attributeCategory, attributeName); } catch (Exception e) @@ -450,7 +518,7 @@ void (empty response body) # **DeleteContact** > void DeleteContact (string email) -Deletes a contact +Delete a contact ### Example ```csharp @@ -480,7 +548,7 @@ namespace Example try { - // Deletes a contact + // Delete a contact apiInstance.DeleteContact(email); } catch (Exception e) @@ -651,7 +719,7 @@ void (empty response body) # **GetAttributes** > GetAttributes GetAttributes () -Lists all attributes +List all attributes ### Example ```csharp @@ -680,7 +748,7 @@ namespace Example try { - // Lists all attributes + // List all attributes GetAttributes result = apiInstance.GetAttributes(); Debug.WriteLine(result); } @@ -715,7 +783,7 @@ This endpoint does not need any parameter. # **GetContactInfo** > GetExtendedContactDetails GetContactInfo (string email) -Retrieves contact informations +Get a contact's details ### Example ```csharp @@ -745,7 +813,7 @@ namespace Example try { - // Retrieves contact informations + // Get a contact's details GetExtendedContactDetails result = apiInstance.GetContactInfo(email); Debug.WriteLine(result); } @@ -781,9 +849,9 @@ Name | Type | Description | Notes # **GetContactStats** -> GetContactCampaignStats GetContactStats (string email) +> GetContactCampaignStats GetContactStats (string email, DateTime? startDate = null, DateTime? endDate = null) -Get the campaigns statistics for a contact +Get email campaigns' statistics for a contact ### Example ```csharp @@ -810,11 +878,13 @@ namespace Example var apiInstance = new ContactsApi(); var email = email_example; // string | Email address (urlencoded) of the contact + var startDate = 2013-10-20; // DateTime? | 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) + var endDate = 2013-10-20; // DateTime? | 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 - GetContactCampaignStats result = apiInstance.GetContactStats(email); + // Get email campaigns' statistics for a contact + GetContactCampaignStats result = apiInstance.GetContactStats(email, startDate, endDate); Debug.WriteLine(result); } catch (Exception e) @@ -831,6 +901,8 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **email** | **string**| Email address (urlencoded) of the contact | + **startDate** | **DateTime?**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional] + **endDate** | **DateTime?**| 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 @@ -923,7 +995,7 @@ Name | Type | Description | Notes # **GetContactsFromList** > GetContacts GetContactsFromList (long? listId, DateTime? modifiedSince = null, long? limit = null, long? offset = null) -Get the contacts in a list +Get contacts in a list ### Example ```csharp @@ -956,7 +1028,7 @@ namespace Example try { - // Get the contacts in a list + // Get contacts in a list GetContacts result = apiInstance.GetContactsFromList(listId, modifiedSince, limit, offset); Debug.WriteLine(result); } @@ -997,7 +1069,7 @@ Name | Type | Description | Notes # **GetFolder** > GetFolder GetFolder (long? folderId) -Returns folder details +Returns a folder's details ### Example ```csharp @@ -1027,7 +1099,7 @@ namespace Example try { - // Returns folder details + // Returns a folder's details GetFolder result = apiInstance.GetFolder(folderId); Debug.WriteLine(result); } @@ -1065,7 +1137,7 @@ Name | Type | Description | Notes # **GetFolderLists** > GetFolderLists GetFolderLists (long? folderId, long? limit = null, long? offset = null) -Get the lists in a folder +Get lists in a folder ### Example ```csharp @@ -1097,7 +1169,7 @@ namespace Example try { - // Get the lists in a folder + // Get lists in a folder GetFolderLists result = apiInstance.GetFolderLists(folderId, limit, offset); Debug.WriteLine(result); } @@ -1137,7 +1209,7 @@ Name | Type | Description | Notes # **GetFolders** > GetFolders GetFolders (long? limit, long? offset) -Get all the folders +Get all folders ### Example ```csharp @@ -1168,7 +1240,7 @@ namespace Example try { - // Get all the folders + // Get all folders GetFolders result = apiInstance.GetFolders(limit, offset); Debug.WriteLine(result); } @@ -1207,7 +1279,7 @@ Name | Type | Description | Notes # **GetList** > GetExtendedList GetList (long? listId) -Get the details of a list +Get a list's details ### Example ```csharp @@ -1237,7 +1309,7 @@ namespace Example try { - // Get the details of a list + // Get a list's details GetExtendedList result = apiInstance.GetList(listId); Debug.WriteLine(result); } @@ -1415,7 +1487,7 @@ Name | Type | Description | Notes # **RemoveContactFromList** > PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromList contactEmails) -Remove existing contacts from a list +Delete a contact from a list ### Example ```csharp @@ -1446,7 +1518,7 @@ namespace Example try { - // Remove existing contacts from a list + // Delete a contact from a list PostContactInfo result = apiInstance.RemoveContactFromList(listId, contactEmails); Debug.WriteLine(result); } @@ -1555,7 +1627,7 @@ Name | Type | Description | Notes # **UpdateAttribute** > void UpdateAttribute (string attributeCategory, string attributeName, UpdateAttribute updateAttribute) -Updates contact attribute +Update contact attribute ### Example ```csharp @@ -1587,7 +1659,7 @@ namespace Example try { - // Updates contact attribute + // Update contact attribute apiInstance.UpdateAttribute(attributeCategory, attributeName, updateAttribute); } catch (Exception e) @@ -1626,7 +1698,7 @@ void (empty response body) # **UpdateContact** > void UpdateContact (string email, UpdateContact updateContact) -Updates a contact +Update a contact ### Example ```csharp @@ -1657,7 +1729,7 @@ namespace Example try { - // Updates a contact + // Update a contact apiInstance.UpdateContact(email, updateContact); } catch (Exception e) @@ -1695,7 +1767,7 @@ void (empty response body) # **UpdateFolder** > void UpdateFolder (long? folderId, CreateUpdateFolder updateFolder) -Update a contact folder +Update a folder ### Example ```csharp @@ -1726,7 +1798,7 @@ namespace Example try { - // Update a contact folder + // Update a folder apiInstance.UpdateFolder(folderId, updateFolder); } catch (Exception e) diff --git a/docs/CreateAttribute.md b/docs/CreateAttribute.md index 2243d6d..12a9085 100644 --- a/docs/CreateAttribute.md +++ b/docs/CreateAttribute.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Value** | **string** | 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** | **string** | 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 ac8ce56..05a9206 100644 --- a/docs/CreateContact.md +++ b/docs/CreateContact.md @@ -3,8 +3,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Email** | **string** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. For example {'SMS':'+91xxxxxxxxxx'} | [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** | **string** | 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] **EmailBlacklisted** | **bool?** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] **SmsBlacklisted** | **bool?** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] **ListIds** | **List<long?>** | Ids of the lists to add the contact to | [optional] diff --git a/docs/CreateDoiContact.md b/docs/CreateDoiContact.md new file mode 100644 index 0000000..1a9e934 --- /dev/null +++ b/docs/CreateDoiContact.md @@ -0,0 +1,14 @@ +# sib_api_v3_sdk.Model.CreateDoiContact +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Email** | **string** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. | +**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] +**IncludeListIds** | **List<long?>** | Lists under user account where contact should be added | +**ExcludeListIds** | **List<long?>** | Lists under user account where contact should not be added | [optional] +**TemplateId** | **long?** | Id of the DOI template | +**RedirectionUrl** | **string** | URL of the web page that user will be redirected to after clicking on the double opt in URL. | [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/CreateEmailCampaign.md b/docs/CreateEmailCampaign.md index 6b33cfc..862ac48 100644 --- a/docs/CreateEmailCampaign.md +++ b/docs/CreateEmailCampaign.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **Footer** | **string** | Footer of the email campaign | [optional] **Header** | **string** | Header of the email campaign | [optional] **UtmCampaign** | **string** | 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] **SendAtBestTime** | **bool?** | Set this to true if you want to send your campaign at best time. | [optional] [default to false] **AbTesting** | **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] **SubjectA** | **string** | 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 9094442..e877c2d 100644 --- a/docs/EmailCampaignsApi.md +++ b/docs/EmailCampaignsApi.md @@ -6,16 +6,17 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**CreateEmailCampaign**](EmailCampaignsApi.md#createemailcampaign) | **POST** /emailCampaigns | Create an email campaign [**DeleteEmailCampaign**](EmailCampaignsApi.md#deleteemailcampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign -[**EmailExportRecipients**](EmailCampaignsApi.md#emailexportrecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign -[**GetAbTestCampaignResult**](EmailCampaignsApi.md#getabtestcampaignresult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get A/B test email campaign result -[**GetEmailCampaign**](EmailCampaignsApi.md#getemailcampaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations -[**GetEmailCampaigns**](EmailCampaignsApi.md#getemailcampaigns) | **GET** /emailCampaigns | Return all your created campaigns +[**EmailExportRecipients**](EmailCampaignsApi.md#emailexportrecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign +[**GetAbTestCampaignResult**](EmailCampaignsApi.md#getabtestcampaignresult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results +[**GetEmailCampaign**](EmailCampaignsApi.md#getemailcampaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report +[**GetEmailCampaigns**](EmailCampaignsApi.md#getemailcampaigns) | **GET** /emailCampaigns | Return all your created email campaigns [**GetSharedTemplateUrl**](EmailCampaignsApi.md#getsharedtemplateurl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url [**SendEmailCampaignNow**](EmailCampaignsApi.md#sendemailcampaignnow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId -[**SendReport**](EmailCampaignsApi.md#sendreport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns +[**SendReport**](EmailCampaignsApi.md#sendreport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign [**SendTestEmail**](EmailCampaignsApi.md#sendtestemail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list -[**UpdateCampaignStatus**](EmailCampaignsApi.md#updatecampaignstatus) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status -[**UpdateEmailCampaign**](EmailCampaignsApi.md#updateemailcampaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign +[**UpdateCampaignStatus**](EmailCampaignsApi.md#updatecampaignstatus) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status +[**UpdateEmailCampaign**](EmailCampaignsApi.md#updateemailcampaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign +[**UploadImageToGallery**](EmailCampaignsApi.md#uploadimagetogallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery @@ -157,7 +158,7 @@ void (empty response body) # **EmailExportRecipients** > CreatedProcessId EmailExportRecipients (long? campaignId, EmailExportRecipients recipientExport = null) -Export the recipients of a campaign +Export the recipients of an email campaign ### Example ```csharp @@ -188,7 +189,7 @@ namespace Example try { - // Export the recipients of a campaign + // Export the recipients of an email campaign CreatedProcessId result = apiInstance.EmailExportRecipients(campaignId, recipientExport); Debug.WriteLine(result); } @@ -227,7 +228,7 @@ Name | Type | Description | Notes # **GetAbTestCampaignResult** > AbTestCampaignResult GetAbTestCampaignResult (long? campaignId) -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 @@ -259,7 +260,7 @@ namespace Example try { - // Get A/B test email campaign result + // Get an A/B test email campaign results AbTestCampaignResult result = apiInstance.GetAbTestCampaignResult(campaignId); Debug.WriteLine(result); } @@ -297,7 +298,7 @@ Name | Type | Description | Notes # **GetEmailCampaign** > GetEmailCampaign GetEmailCampaign (long? campaignId) -Get campaign informations +Get an email campaign report ### Example ```csharp @@ -327,7 +328,7 @@ namespace Example try { - // Get campaign informations + // Get an email campaign report GetEmailCampaign result = apiInstance.GetEmailCampaign(campaignId); Debug.WriteLine(result); } @@ -365,7 +366,7 @@ Name | Type | Description | Notes # **GetEmailCampaigns** > GetEmailCampaigns GetEmailCampaigns (string type = null, string status = null, DateTime? startDate = null, DateTime? endDate = null, long? limit = null, long? offset = null) -Return all your created campaigns +Return all your created email campaigns ### Example ```csharp @@ -400,7 +401,7 @@ namespace Example try { - // Return all your created campaigns + // Return all your created email campaigns GetEmailCampaigns result = apiInstance.GetEmailCampaigns(type, status, startDate, endDate, limit, offset); Debug.WriteLine(result); } @@ -580,7 +581,7 @@ void (empty response body) # **SendReport** > void SendReport (long? campaignId, SendReport sendReport) -Send the report of a campaigns +Send the report of a campaign A PDF will be sent to the specified email addresses @@ -613,7 +614,7 @@ namespace Example try { - // Send the report of a campaigns + // Send the report of a campaign apiInstance.SendReport(campaignId, sendReport); } catch (Exception e) @@ -720,7 +721,7 @@ void (empty response body) # **UpdateCampaignStatus** > void UpdateCampaignStatus (long? campaignId, UpdateCampaignStatus status) -Update a campaign status +Update an email campaign status ### Example ```csharp @@ -751,7 +752,7 @@ namespace Example try { - // Update a campaign status + // Update an email campaign status apiInstance.UpdateCampaignStatus(campaignId, status); } catch (Exception e) @@ -789,7 +790,7 @@ void (empty response body) # **UpdateEmailCampaign** > void UpdateEmailCampaign (long? campaignId, UpdateEmailCampaign emailCampaign) -Update a campaign +Update an email campaign ### Example ```csharp @@ -820,7 +821,7 @@ namespace Example try { - // Update a campaign + // Update an email campaign apiInstance.UpdateEmailCampaign(campaignId, emailCampaign); } catch (Exception e) @@ -854,3 +855,70 @@ 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) + +# **UploadImageToGallery** +> void UploadImageToGallery (UploadImageToGallery uploadImage) + +Upload an image to your account's image gallery + +### Example +```csharp +using System; +using System.Diagnostics; +using sib_api_v3_sdk.Api; +using sib_api_v3_sdk.Client; +using sib_api_v3_sdk.Model; + +namespace Example +{ + public class UploadImageToGalleryExample + { + public void main() + { + // Configure API key authorization: api-key + Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY"); + // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed + // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer"); + // Configure API key authorization: partner-key + Configuration.Default.AddApiKey("partner-key", "YOUR_API_KEY"); + // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed + // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); + + var apiInstance = new EmailCampaignsApi(); + var uploadImage = new UploadImageToGallery(); // UploadImageToGallery | Parameters to upload an image + + try + { + // Upload an image to your account's image gallery + apiInstance.UploadImageToGallery(uploadImage); + } + catch (Exception e) + { + Debug.Print("Exception when calling EmailCampaignsApi.UploadImageToGallery: " + e.Message ); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uploadImage** | [**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 e33b31d..7f590ab 100644 --- a/docs/FoldersApi.md +++ b/docs/FoldersApi.md @@ -6,10 +6,10 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**CreateFolder**](FoldersApi.md#createfolder) | **POST** /contacts/folders | Create a folder [**DeleteFolder**](FoldersApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) -[**GetFolder**](FoldersApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns folder details -[**GetFolderLists**](FoldersApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -[**GetFolders**](FoldersApi.md#getfolders) | **GET** /contacts/folders | Get all the folders -[**UpdateFolder**](FoldersApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a contact folder +[**GetFolder**](FoldersApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details +[**GetFolderLists**](FoldersApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +[**GetFolders**](FoldersApi.md#getfolders) | **GET** /contacts/folders | Get all folders +[**UpdateFolder**](FoldersApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder @@ -151,7 +151,7 @@ void (empty response body) # **GetFolder** > GetFolder GetFolder (long? folderId) -Returns folder details +Returns a folder's details ### Example ```csharp @@ -181,7 +181,7 @@ namespace Example try { - // Returns folder details + // Returns a folder's details GetFolder result = apiInstance.GetFolder(folderId); Debug.WriteLine(result); } @@ -219,7 +219,7 @@ Name | Type | Description | Notes # **GetFolderLists** > GetFolderLists GetFolderLists (long? folderId, long? limit = null, long? offset = null) -Get the lists in a folder +Get lists in a folder ### Example ```csharp @@ -251,7 +251,7 @@ namespace Example try { - // Get the lists in a folder + // Get lists in a folder GetFolderLists result = apiInstance.GetFolderLists(folderId, limit, offset); Debug.WriteLine(result); } @@ -291,7 +291,7 @@ Name | Type | Description | Notes # **GetFolders** > GetFolders GetFolders (long? limit, long? offset) -Get all the folders +Get all folders ### Example ```csharp @@ -322,7 +322,7 @@ namespace Example try { - // Get all the folders + // Get all folders GetFolders result = apiInstance.GetFolders(limit, offset); Debug.WriteLine(result); } @@ -361,7 +361,7 @@ Name | Type | Description | Notes # **UpdateFolder** > void UpdateFolder (long? folderId, CreateUpdateFolder updateFolder) -Update a contact folder +Update a folder ### Example ```csharp @@ -392,7 +392,7 @@ namespace Example try { - // Update a contact folder + // Update a folder apiInstance.UpdateFolder(folderId, updateFolder); } catch (Exception e) diff --git a/docs/GetAccountPlan.md b/docs/GetAccountPlan.md index 46c1358..900bafc 100644 --- a/docs/GetAccountPlan.md +++ b/docs/GetAccountPlan.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **string** | Displays the plan type of the user | -**CreditsType** | **string** | This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. | +**CreditsType** | **string** | This is the type of the credit, "Send Limit" is one of the possible types of credit of a user. "Send Limit" implies the total number of emails you can send to the subscribers in your account. | **Credits** | **float?** | Remaining credits of the user | -**StartDate** | **DateTime?** | Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) | [optional] -**EndDate** | **DateTime?** | Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) | [optional] +**StartDate** | **DateTime?** | Date of the period from which the plan will start (only available for "subscription" and "reseller" plan type) | [optional] +**EndDate** | **DateTime?** | Date of the period from which the plan will end (only available for "subscription" and "reseller" plan type) | [optional] **UserLimit** | **int?** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetAttributesAttributes.md b/docs/GetAttributesAttributes.md index 1078599..9b03342 100644 --- a/docs/GetAttributesAttributes.md +++ b/docs/GetAttributesAttributes.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **Name** | **string** | Name of the attribute | **Category** | **string** | Category of the attribute | **Type** | **string** | Type of the attribute | [optional] -**Enumeration** | [**List<GetAttributesEnumeration>**](GetAttributesEnumeration.md) | Parameter only available for \"category\" type attributes. | [optional] +**Enumeration** | [**List<GetAttributesEnumeration>**](GetAttributesEnumeration.md) | Parameter only available for "category" type attributes. | [optional] **CalculatedValue** | **string** | Calculated value formula | [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/GetAttributesEnumeration.md b/docs/GetAttributesEnumeration.md index 6a8de68..7a70f6a 100644 --- a/docs/GetAttributesEnumeration.md +++ b/docs/GetAttributesEnumeration.md @@ -3,8 +3,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | **long?** | ID of Value of the \"category\" type attribute | -**Label** | **string** | Label of the \"category\" type attribute | +**Value** | **long?** | ID of Value of the "category" type attribute | +**Label** | **string** | Label of the "category" type attribute | [[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/GetEmailCampaign.md b/docs/GetEmailCampaign.md index 968fcf9..4c0fc93 100644 --- a/docs/GetEmailCampaign.md +++ b/docs/GetEmailCampaign.md @@ -20,8 +20,8 @@ Name | Type | Description | Notes **Header** | **string** | Header of the campaign | **Footer** | **string** | Footer of the campaign | **Sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | | -**ReplyTo** | **string** | Email defined as the \"Reply to\" of the campaign | -**ToField** | **string** | Customisation of the \"to\" field of the campaign | +**ReplyTo** | **string** | Email defined as the "Reply to" of the campaign | +**ToField** | **string** | Customisation of the "to" field of the campaign | **HtmlContent** | **string** | HTML content of the campaign | **ShareLink** | **string** | Link to share the campaign on social medias | [optional] **Tag** | **string** | Tag of the campaign | diff --git a/docs/GetExtendedCampaignOverview.md b/docs/GetExtendedCampaignOverview.md index e5e3836..c8b3ee1 100644 --- a/docs/GetExtendedCampaignOverview.md +++ b/docs/GetExtendedCampaignOverview.md @@ -20,8 +20,8 @@ Name | Type | Description | Notes **Header** | **string** | Header of the campaign | **Footer** | **string** | Footer of the campaign | **Sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | | -**ReplyTo** | **string** | Email defined as the \"Reply to\" of the campaign | -**ToField** | **string** | Customisation of the \"to\" field of the campaign | +**ReplyTo** | **string** | Email defined as the "Reply to" of the campaign | +**ToField** | **string** | Customisation of the "to" field of the campaign | **HtmlContent** | **string** | HTML content of the campaign | **ShareLink** | **string** | Link to share the campaign on social medias | [optional] **Tag** | **string** | Tag of the campaign | diff --git a/docs/GetSmtpTemplateOverview.md b/docs/GetSmtpTemplateOverview.md index af41f91..c98d7f4 100644 --- a/docs/GetSmtpTemplateOverview.md +++ b/docs/GetSmtpTemplateOverview.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **IsActive** | **bool?** | Status of template (true=active, false=inactive) | **TestSent** | **bool?** | Status of test sending for the template (true=test email has been sent, false=test email has not been sent) | **Sender** | [**GetSmtpTemplateOverviewSender**](GetSmtpTemplateOverviewSender.md) | | -**ReplyTo** | **string** | Email defined as the \"Reply to\" for the template | -**ToField** | **string** | Customisation of the \"to\" field for the template | +**ReplyTo** | **string** | Email defined as the "Reply to" for the template | +**ToField** | **string** | Customisation of the "to" field for the template | **Tag** | **string** | Tag of the template | **HtmlContent** | **string** | HTML content of the template | **CreatedAt** | **DateTime?** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | diff --git a/docs/GetTransacEmailsListTransactionalEmails.md b/docs/GetTransacEmailsListTransactionalEmails.md index c71be9f..69f3d16 100644 --- a/docs/GetTransacEmailsListTransactionalEmails.md +++ b/docs/GetTransacEmailsListTransactionalEmails.md @@ -9,6 +9,8 @@ Name | Type | Description | Notes **MessageId** | **string** | Message Id of the sent email | **Uuid** | **string** | Unique id of the email sent to a particular contact | **Date** | **DateTime?** | Date on which transactional email was sent | +**From** | **string** | Email address of the sender from which the email was sent | [optional] +**Tags** | **List<string>** | 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 8a98206..7ee4ced 100644 --- a/docs/ListsApi.md +++ b/docs/ListsApi.md @@ -7,11 +7,11 @@ Method | HTTP request | Description [**AddContactToList**](ListsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list [**CreateList**](ListsApi.md#createlist) | **POST** /contacts/lists | Create a list [**DeleteList**](ListsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list -[**GetContactsFromList**](ListsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list -[**GetFolderLists**](ListsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder -[**GetList**](ListsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get the details of a list +[**GetContactsFromList**](ListsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list +[**GetFolderLists**](ListsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder +[**GetList**](ListsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details [**GetLists**](ListsApi.md#getlists) | **GET** /contacts/lists | Get all the lists -[**RemoveContactFromList**](ListsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list +[**RemoveContactFromList**](ListsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list [**UpdateList**](ListsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list @@ -224,7 +224,7 @@ void (empty response body) # **GetContactsFromList** > GetContacts GetContactsFromList (long? listId, DateTime? modifiedSince = null, long? limit = null, long? offset = null) -Get the contacts in a list +Get contacts in a list ### Example ```csharp @@ -257,7 +257,7 @@ namespace Example try { - // Get the contacts in a list + // Get contacts in a list GetContacts result = apiInstance.GetContactsFromList(listId, modifiedSince, limit, offset); Debug.WriteLine(result); } @@ -298,7 +298,7 @@ Name | Type | Description | Notes # **GetFolderLists** > GetFolderLists GetFolderLists (long? folderId, long? limit = null, long? offset = null) -Get the lists in a folder +Get lists in a folder ### Example ```csharp @@ -330,7 +330,7 @@ namespace Example try { - // Get the lists in a folder + // Get lists in a folder GetFolderLists result = apiInstance.GetFolderLists(folderId, limit, offset); Debug.WriteLine(result); } @@ -370,7 +370,7 @@ Name | Type | Description | Notes # **GetList** > GetExtendedList GetList (long? listId) -Get the details of a list +Get a list's details ### Example ```csharp @@ -400,7 +400,7 @@ namespace Example try { - // Get the details of a list + // Get a list's details GetExtendedList result = apiInstance.GetList(listId); Debug.WriteLine(result); } @@ -508,7 +508,7 @@ Name | Type | Description | Notes # **RemoveContactFromList** > PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromList contactEmails) -Remove existing contacts from a list +Delete a contact from a list ### Example ```csharp @@ -539,7 +539,7 @@ namespace Example try { - // Remove existing contacts from a list + // Delete a contact from a list PostContactInfo result = apiInstance.RemoveContactFromList(listId, contactEmails); Debug.WriteLine(result); } diff --git a/docs/PostContactInfoContacts.md b/docs/PostContactInfoContacts.md index 807b51a..846b72c 100644 --- a/docs/PostContactInfoContacts.md +++ b/docs/PostContactInfoContacts.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Success** | **List<string>** | | [optional] **Failure** | **List<string>** | | [optional] -**Total** | **long?** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional] +**Total** | **long?** | Displays the count of total number of contacts removed from list when user opts for "all" option. | [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/RemainingCreditModelChild.md b/docs/RemainingCreditModelChild.md index f9f4cc0..707c27d 100644 --- a/docs/RemainingCreditModelChild.md +++ b/docs/RemainingCreditModelChild.md @@ -3,8 +3,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Sms** | **long?** | SMS Credits remaining for child account | -**Email** | **long?** | Email Credits remaining for child account | +**Sms** | **double?** | SMS Credits remaining for child account | +**Email** | **double?** | 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 3bc6376..0b84347 100644 --- a/docs/RemainingCreditModelReseller.md +++ b/docs/RemainingCreditModelReseller.md @@ -3,8 +3,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Sms** | **long?** | SMS Credits remaining for reseller account | -**Email** | **long?** | Email Credits remaining for reseller account | +**Sms** | **double?** | SMS Credits remaining for reseller account | +**Email** | **double?** | 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 b9444b1..51f4ba8 100644 --- a/docs/RemoveContactFromList.md +++ b/docs/RemoveContactFromList.md @@ -3,7 +3,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Emails** | **List<string>** | Required if 'all' is false. Emails to remove from a list | [optional] +**Emails** | **List<string>** | 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 45721ba..c0fb14a 100644 --- a/docs/RequestContactExport.md +++ b/docs/RequestContactExport.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ExportAttributes** | **List<string>** | 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] -**ContactFilter** | **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] +**ContactFilter** | **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] **CustomContactFilter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | [optional] **NotifyUrl** | **string** | Webhook that will be called once the export process is finished | [optional] diff --git a/docs/RequestContactImport.md b/docs/RequestContactImport.md index bb7a643..b0fea14 100644 --- a/docs/RequestContactImport.md +++ b/docs/RequestContactImport.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **FileUrl** | **string** | Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv | [optional] -**FileBody** | **string** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes | [optional] +**FileBody** | **string** | 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] **ListIds** | **List<long?>** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional] **NotifyUrl** | **string** | URL that will be called once the export process is finished | [optional] **NewList** | [**RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional] diff --git a/docs/ResellerApi.md b/docs/ResellerApi.md index a66ed96..a13de9c 100644 --- a/docs/ResellerApi.md +++ b/docs/ResellerApi.md @@ -6,20 +6,20 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**AddCredits**](ResellerApi.md#addcredits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account [**AssociateIpToChild**](ResellerApi.md#associateiptochild) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child -[**CreateChildDomain**](ResellerApi.md#createchilddomain) | **POST** /reseller/children/{childAuthKey}/domains | Creates a domain for a child account +[**CreateChildDomain**](ResellerApi.md#createchilddomain) | **POST** /reseller/children/{childAuthKey}/domains | Create a domain for a child account [**CreateResellerChild**](ResellerApi.md#createresellerchild) | **POST** /reseller/children | Creates a reseller child -[**DeleteChildDomain**](ResellerApi.md#deletechilddomain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed -[**DeleteResellerChild**](ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied +[**DeleteChildDomain**](ResellerApi.md#deletechilddomain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Delete the sender domain of the reseller child based on the childAuthKey and domainName passed +[**DeleteResellerChild**](ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childAuthKey} | Delete a single reseller child based on the childAuthKey supplied [**DissociateIpFromChild**](ResellerApi.md#dissociateipfromchild) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child -[**GetChildAccountCreationStatus**](ResellerApi.md#getchildaccountcreationstatus) | **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 -[**GetChildDomains**](ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account -[**GetChildInfo**](ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account -[**GetResellerChilds**](ResellerApi.md#getresellerchilds) | **GET** /reseller/children | Gets the list of all reseller's children accounts +[**GetChildAccountCreationStatus**](ResellerApi.md#getchildaccountcreationstatus) | **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 +[**GetChildDomains**](ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childAuthKey}/domains | Get all sender domains for a specific child account +[**GetChildInfo**](ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childAuthKey} | Get a child account's details +[**GetResellerChilds**](ResellerApi.md#getresellerchilds) | **GET** /reseller/children | Get the list of all children accounts [**GetSsoToken**](ResellerApi.md#getssotoken) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO) [**RemoveCredits**](ResellerApi.md#removecredits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account -[**UpdateChildAccountStatus**](ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied -[**UpdateChildDomain**](ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed -[**UpdateResellerChild**](ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied +[**UpdateChildAccountStatus**](ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Update info of reseller's child account status based on the childAuthKey supplied +[**UpdateChildDomain**](ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Update the sender domain of reseller's child based on the childAuthKey and domainName passed +[**UpdateResellerChild**](ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childAuthKey} | Update info of reseller's child based on the childAuthKey supplied @@ -165,7 +165,7 @@ void (empty response body) # **CreateChildDomain** > void CreateChildDomain (string childAuthKey, AddChildDomain addChildDomain) -Creates a domain for a child account +Create a domain for a child account ### Example ```csharp @@ -196,7 +196,7 @@ namespace Example try { - // Creates a domain for a child account + // Create a domain for a child account apiInstance.CreateChildDomain(childAuthKey, addChildDomain); } catch (Exception e) @@ -302,7 +302,7 @@ Name | Type | Description | Notes # **DeleteChildDomain** > void DeleteChildDomain (string childAuthKey, string domainName) -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 ```csharp @@ -333,7 +333,7 @@ namespace Example 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 apiInstance.DeleteChildDomain(childAuthKey, domainName); } catch (Exception e) @@ -371,7 +371,7 @@ void (empty response body) # **DeleteResellerChild** > void DeleteResellerChild (string childAuthKey) -Deletes a single reseller child based on the childAuthKey supplied +Delete a single reseller child based on the childAuthKey supplied ### Example ```csharp @@ -401,7 +401,7 @@ namespace Example try { - // Deletes a single reseller child based on the childAuthKey supplied + // Delete a single reseller child based on the childAuthKey supplied apiInstance.DeleteResellerChild(childAuthKey); } catch (Exception e) @@ -507,7 +507,7 @@ void (empty response body) # **GetChildAccountCreationStatus** > GetChildAccountCreationStatus GetChildAccountCreationStatus (string childAuthKey) -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 ```csharp @@ -537,7 +537,7 @@ namespace Example 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 GetChildAccountCreationStatus result = apiInstance.GetChildAccountCreationStatus(childAuthKey); Debug.WriteLine(result); } @@ -575,7 +575,7 @@ Name | Type | Description | Notes # **GetChildDomains** > GetChildDomains GetChildDomains (string childAuthKey) -Gets all the sender domains of a specific child account +Get all sender domains for a specific child account ### Example ```csharp @@ -605,7 +605,7 @@ namespace Example try { - // Gets all the sender domains of a specific child account + // Get all sender domains for a specific child account GetChildDomains result = apiInstance.GetChildDomains(childAuthKey); Debug.WriteLine(result); } @@ -643,7 +643,7 @@ Name | Type | Description | Notes # **GetChildInfo** > GetChildInfo GetChildInfo (string childAuthKey) -Gets the info about a specific child account +Get a child account's details ### Example ```csharp @@ -673,7 +673,7 @@ namespace Example try { - // Gets the info about a specific child account + // Get a child account's details GetChildInfo result = apiInstance.GetChildInfo(childAuthKey); Debug.WriteLine(result); } @@ -711,7 +711,7 @@ Name | Type | Description | Notes # **GetResellerChilds** > GetChildrenList GetResellerChilds (long? limit = null, long? offset = null) -Gets the list of all reseller's children accounts +Get the list of all children accounts ### Example ```csharp @@ -742,7 +742,7 @@ namespace Example try { - // Gets the list of all reseller's children accounts + // Get the list of all children accounts GetChildrenList result = apiInstance.GetResellerChilds(limit, offset); Debug.WriteLine(result); } @@ -921,7 +921,7 @@ Name | Type | Description | Notes # **UpdateChildAccountStatus** > void UpdateChildAccountStatus (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus) -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 ```csharp @@ -952,7 +952,7 @@ namespace Example 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 apiInstance.UpdateChildAccountStatus(childAuthKey, updateChildAccountStatus); } catch (Exception e) @@ -990,7 +990,7 @@ void (empty response body) # **UpdateChildDomain** > void UpdateChildDomain (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain) -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 ```csharp @@ -1022,7 +1022,7 @@ namespace Example 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 apiInstance.UpdateChildDomain(childAuthKey, domainName, updateChildDomain); } catch (Exception e) @@ -1061,7 +1061,7 @@ void (empty response body) # **UpdateResellerChild** > void UpdateResellerChild (string childAuthKey, UpdateChild resellerChild) -Updates infos of reseller's child based on the childAuthKey supplied +Update info of reseller's child based on the childAuthKey supplied ### Example ```csharp @@ -1092,7 +1092,7 @@ namespace Example try { - // Updates infos of reseller's child based on the childAuthKey supplied + // Update info of reseller's child based on the childAuthKey supplied apiInstance.UpdateResellerChild(childAuthKey, resellerChild); } catch (Exception e) diff --git a/docs/SMSCampaignsApi.md b/docs/SMSCampaignsApi.md index 4806b0e..633cd0d 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 ------------- | ------------- | ------------- [**CreateSmsCampaign**](SMSCampaignsApi.md#createsmscampaign) | **POST** /smsCampaigns | Creates an SMS campaign -[**DeleteSmsCampaign**](SMSCampaignsApi.md#deletesmscampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign +[**DeleteSmsCampaign**](SMSCampaignsApi.md#deletesmscampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign [**GetSmsCampaign**](SMSCampaignsApi.md#getsmscampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign -[**GetSmsCampaigns**](SMSCampaignsApi.md#getsmscampaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns -[**RequestSmsRecipientExport**](SMSCampaignsApi.md#requestsmsrecipientexport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign. +[**GetSmsCampaigns**](SMSCampaignsApi.md#getsmscampaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns +[**RequestSmsRecipientExport**](SMSCampaignsApi.md#requestsmsrecipientexport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients [**SendSmsCampaignNow**](SMSCampaignsApi.md#sendsmscampaignnow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately -[**SendSmsReport**](SMSCampaignsApi.md#sendsmsreport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns -[**SendTestSms**](SMSCampaignsApi.md#sendtestsms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS -[**UpdateSmsCampaign**](SMSCampaignsApi.md#updatesmscampaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign -[**UpdateSmsCampaignStatus**](SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status +[**SendSmsReport**](SMSCampaignsApi.md#sendsmsreport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report +[**SendTestSms**](SMSCampaignsApi.md#sendtestsms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign +[**UpdateSmsCampaign**](SMSCampaignsApi.md#updatesmscampaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign +[**UpdateSmsCampaignStatus**](SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status @@ -88,7 +88,7 @@ Name | Type | Description | Notes # **DeleteSmsCampaign** > void DeleteSmsCampaign (long? campaignId) -Delete the SMS campaign +Delete an SMS campaign ### Example ```csharp @@ -118,7 +118,7 @@ namespace Example try { - // Delete the SMS campaign + // Delete an SMS campaign apiInstance.DeleteSmsCampaign(campaignId); } catch (Exception e) @@ -223,7 +223,7 @@ Name | Type | Description | Notes # **GetSmsCampaigns** > GetSmsCampaigns GetSmsCampaigns (string status = null, DateTime? startDate = null, DateTime? endDate = null, long? limit = null, long? offset = null) -Returns the informations for all your created SMS campaigns +Returns the information for all your created SMS campaigns ### Example ```csharp @@ -257,7 +257,7 @@ namespace Example try { - // Returns the informations for all your created SMS campaigns + // Returns the information for all your created SMS campaigns GetSmsCampaigns result = apiInstance.GetSmsCampaigns(status, startDate, endDate, limit, offset); Debug.WriteLine(result); } @@ -299,7 +299,7 @@ Name | Type | Description | Notes # **RequestSmsRecipientExport** > CreatedProcessId RequestSmsRecipientExport (long? campaignId, RequestSmsRecipientExport recipientExport = null) -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. @@ -332,7 +332,7 @@ namespace Example try { - // Exports the recipients of the specified campaign. + // Export an SMS campaign's recipients CreatedProcessId result = apiInstance.RequestSmsRecipientExport(campaignId, recipientExport); Debug.WriteLine(result); } @@ -438,7 +438,7 @@ void (empty response body) # **SendSmsReport** > void SendSmsReport (long? campaignId, SendReport sendReport) -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. @@ -471,7 +471,7 @@ namespace Example try { - // Send report of SMS campaigns + // Send an SMS campaign's report apiInstance.SendSmsReport(campaignId, sendReport); } catch (Exception e) @@ -509,7 +509,7 @@ void (empty response body) # **SendTestSms** > void SendTestSms (long? campaignId, SendTestSms phoneNumber) -Send an SMS +Send a test SMS campaign ### Example ```csharp @@ -540,7 +540,7 @@ namespace Example try { - // Send an SMS + // Send a test SMS campaign apiInstance.SendTestSms(campaignId, phoneNumber); } catch (Exception e) @@ -578,7 +578,7 @@ void (empty response body) # **UpdateSmsCampaign** > void UpdateSmsCampaign (long? campaignId, UpdateSmsCampaign updateSmsCampaign) -Updates an SMS campaign +Update an SMS campaign ### Example ```csharp @@ -609,7 +609,7 @@ namespace Example try { - // Updates an SMS campaign + // Update an SMS campaign apiInstance.UpdateSmsCampaign(campaignId, updateSmsCampaign); } catch (Exception e) @@ -647,7 +647,7 @@ void (empty response body) # **UpdateSmsCampaignStatus** > void UpdateSmsCampaignStatus (long? campaignId, UpdateCampaignStatus status) -Update the campaign status +Update a campaign's status ### Example ```csharp @@ -678,7 +678,7 @@ namespace Example try { - // Update the campaign status + // Update a campaign's status apiInstance.UpdateSmsCampaignStatus(campaignId, status); } catch (Exception e) diff --git a/docs/SMTPApi.md b/docs/SMTPApi.md index b4a8d91..f32896b 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 ------------- | ------------- | ------------- -[**CreateSmtpTemplate**](SMTPApi.md#createsmtptemplate) | **POST** /smtp/templates | Create a transactional email template +[**CreateSmtpTemplate**](SMTPApi.md#createsmtptemplate) | **POST** /smtp/templates | Create an email template [**DeleteHardbounces**](SMTPApi.md#deletehardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces -[**DeleteSmtpTemplate**](SMTPApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive transactional email template +[**DeleteSmtpTemplate**](SMTPApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template [**GetAggregatedSmtpReport**](SMTPApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time [**GetEmailEventReport**](SMTPApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) [**GetSmtpReport**](SMTPApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day -[**GetSmtpTemplate**](SMTPApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template informations -[**GetSmtpTemplates**](SMTPApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of transactional email templates +[**GetSmtpTemplate**](SMTPApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template information +[**GetSmtpTemplates**](SMTPApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of email templates [**GetTransacBlockedContacts**](SMTPApi.md#gettransacblockedcontacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts [**GetTransacEmailContent**](SMTPApi.md#gettransacemailcontent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email [**GetTransacEmailsList**](SMTPApi.md#gettransacemailslist) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters @@ -20,14 +20,14 @@ Method | HTTP request | Description [**SendTransacEmail**](SMTPApi.md#sendtransacemail) | **POST** /smtp/email | Send a transactional email [**SmtpBlockedContactsEmailDelete**](SMTPApi.md#smtpblockedcontactsemaildelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact [**SmtpLogMessageIdDelete**](SMTPApi.md#smtplogmessageiddelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log -[**UpdateSmtpTemplate**](SMTPApi.md#updatesmtptemplate) | **PUT** /smtp/templates/{templateId} | Updates a transactional email templates +[**UpdateSmtpTemplate**](SMTPApi.md#updatesmtptemplate) | **PUT** /smtp/templates/{templateId} | Update an email template # **CreateSmtpTemplate** > CreateModel CreateSmtpTemplate (CreateSmtpTemplate smtpTemplate) -Create a transactional email template +Create an email template ### Example ```csharp @@ -57,7 +57,7 @@ namespace Example try { - // Create a transactional email template + // Create an email template CreateModel result = apiInstance.CreateSmtpTemplate(smtpTemplate); Debug.WriteLine(result); } @@ -164,7 +164,7 @@ void (empty response body) # **DeleteSmtpTemplate** > void DeleteSmtpTemplate (long? templateId) -Delete an inactive transactional email template +Delete an inactive email template ### Example ```csharp @@ -194,7 +194,7 @@ namespace Example try { - // Delete an inactive transactional email template + // Delete an inactive email template apiInstance.DeleteSmtpTemplate(templateId); } catch (Exception e) @@ -469,7 +469,7 @@ Name | Type | Description | Notes # **GetSmtpTemplate** > GetSmtpTemplateOverview GetSmtpTemplate (long? templateId) -Returns the template informations +Returns the template information ### Example ```csharp @@ -499,7 +499,7 @@ namespace Example try { - // Returns the template informations + // Returns the template information GetSmtpTemplateOverview result = apiInstance.GetSmtpTemplate(templateId); Debug.WriteLine(result); } @@ -537,7 +537,7 @@ Name | Type | Description | Notes # **GetSmtpTemplates** > GetSmtpTemplates GetSmtpTemplates (bool? templateStatus = null, long? limit = null, long? offset = null) -Get the list of transactional email templates +Get the list of email templates ### Example ```csharp @@ -569,7 +569,7 @@ namespace Example try { - // Get the list of transactional email templates + // Get the list of email templates GetSmtpTemplates result = apiInstance.GetSmtpTemplates(templateStatus, limit, offset); Debug.WriteLine(result); } @@ -751,7 +751,7 @@ Name | Type | Description | Notes # **GetTransacEmailsList** -> GetTransacEmailsList GetTransacEmailsList (string email = null, long? templateId = null, string messageId = null, string startDate = null, DateTime? endDate = null) +> GetTransacEmailsList GetTransacEmailsList (string email = null, long? templateId = null, string messageId = null, DateTime? startDate = null, DateTime? endDate = null) Get the list of transactional emails on the basis of allowed filters @@ -784,7 +784,7 @@ namespace Example var email = email_example; // string | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional) var templateId = 789; // long? | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional) var messageId = messageId_example; // string | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional) - var startDate = startDate_example; // string | 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) + var startDate = 2013-10-20; // DateTime? | 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) var endDate = 2013-10-20; // DateTime? | 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 @@ -809,7 +809,7 @@ Name | Type | Description | Notes **email** | **string**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional] **templateId** | **long?**| Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | [optional] **messageId** | **string**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional] - **startDate** | **string**| 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] + **startDate** | **DateTime?**| 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] **endDate** | **DateTime?**| 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 @@ -1174,7 +1174,7 @@ void (empty response body) # **UpdateSmtpTemplate** > void UpdateSmtpTemplate (long? templateId, UpdateSmtpTemplate smtpTemplate) -Updates a transactional email templates +Update an email template ### Example ```csharp @@ -1205,7 +1205,7 @@ namespace Example try { - // Updates a transactional email templates + // Update an email template apiInstance.UpdateSmtpTemplate(templateId, smtpTemplate); } catch (Exception e) diff --git a/docs/SendEmail.md b/docs/SendEmail.md index a23e6cf..1fff009 100644 --- a/docs/SendEmail.md +++ b/docs/SendEmail.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes **EmailCc** | **List<string>** | List of the email addresses of the recipients in cc | [optional] **ReplyTo** | **string** | Email address which shall be used by campaign recipients to reply back | [optional] **AttachmentUrl** | **string** | 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<string>** | 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 e337a36..6326e15 100644 --- a/docs/SendSmtpEmail.md +++ b/docs/SendSmtpEmail.md @@ -4,17 +4,17 @@ 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] **HtmlContent** | **string** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional] **TextContent** | **string** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional] **Subject** | **string** | Subject of the message. Mandatory if 'templateId' is not passed | [optional] **ReplyTo** | [**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] +**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. 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] **TemplateId** | **long?** | 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<string>** | 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 18623d9..95c80e0 100644 --- a/docs/SendersApi.md +++ b/docs/SendersApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**CreateSender**](SendersApi.md#createsender) | **POST** /senders | Create a new sender [**DeleteSender**](SendersApi.md#deletesender) | **DELETE** /senders/{senderId} | Delete a sender -[**GetIps**](SendersApi.md#getips) | **GET** /senders/ips | Return all the dedicated IPs for your account -[**GetIpsFromSender**](SendersApi.md#getipsfromsender) | **GET** /senders/{senderId}/ips | Return all the dedicated IPs for a sender +[**GetIps**](SendersApi.md#getips) | **GET** /senders/ips | Get all the dedicated IPs for your account +[**GetIpsFromSender**](SendersApi.md#getipsfromsender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender [**GetSenders**](SendersApi.md#getsenders) | **GET** /senders | Get the list of all your senders [**UpdateSender**](SendersApi.md#updatesender) | **PUT** /senders/{senderId} | Update a sender @@ -151,7 +151,7 @@ void (empty response body) # **GetIps** > GetIps GetIps () -Return all the dedicated IPs for your account +Get all the dedicated IPs for your account ### Example ```csharp @@ -180,7 +180,7 @@ namespace Example try { - // Return all the dedicated IPs for your account + // Get all the dedicated IPs for your account GetIps result = apiInstance.GetIps(); Debug.WriteLine(result); } @@ -215,7 +215,7 @@ This endpoint does not need any parameter. # **GetIpsFromSender** > GetIpsFromSender GetIpsFromSender (long? senderId) -Return all the dedicated IPs for a sender +Get all the dedicated IPs for a sender ### Example ```csharp @@ -245,7 +245,7 @@ namespace Example try { - // Return all the dedicated IPs for a sender + // Get all the dedicated IPs for a sender GetIpsFromSender result = apiInstance.GetIpsFromSender(senderId); Debug.WriteLine(result); } diff --git a/docs/TransactionalSMSApi.md b/docs/TransactionalSMSApi.md index e718058..b003bd9 100644 --- a/docs/TransactionalSMSApi.md +++ b/docs/TransactionalSMSApi.md @@ -4,17 +4,17 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**GetSmsEvents**](TransactionalSMSApi.md#getsmsevents) | **GET** /transactionalSMS/statistics/events | Get all the SMS activity (unaggregated events) +[**GetSmsEvents**](TransactionalSMSApi.md#getsmsevents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) [**GetTransacAggregatedSmsReport**](TransactionalSMSApi.md#gettransacaggregatedsmsreport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time [**GetTransacSmsReport**](TransactionalSMSApi.md#gettransacsmsreport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day -[**SendTransacSms**](TransactionalSMSApi.md#sendtransacsms) | **POST** /transactionalSMS/sms | Send the SMS campaign to the specified mobile number +[**SendTransacSms**](TransactionalSMSApi.md#sendtransacsms) | **POST** /transactionalSMS/sms | Send the SMS campaign to a mobile number # **GetSmsEvents** > GetSmsEventReport GetSmsEvents (long? limit = null, string startDate = null, string endDate = null, long? offset = null, int? days = null, string phoneNumber = null, string _event = null, string tags = null) -Get all the SMS activity (unaggregated events) +Get all your SMS activity (unaggregated events) ### Example ```csharp @@ -51,7 +51,7 @@ namespace Example try { - // Get all the SMS activity (unaggregated events) + // Get all your SMS activity (unaggregated events) GetSmsEventReport result = apiInstance.GetSmsEvents(limit, startDate, endDate, offset, days, phoneNumber, _event, tags); Debug.WriteLine(result); } @@ -244,7 +244,7 @@ Name | Type | Description | Notes # **SendTransacSms** > SendSms SendTransacSms (SendTransacSms sendTransacSms) -Send the SMS campaign to the specified mobile number +Send the SMS campaign to a mobile number ### Example ```csharp @@ -274,7 +274,7 @@ namespace Example try { - // Send the SMS campaign to the specified mobile number + // Send the SMS campaign to a mobile number SendSms result = apiInstance.SendTransacSms(sendTransacSms); Debug.WriteLine(result); } diff --git a/docs/UpdateAttribute.md b/docs/UpdateAttribute.md index 97e9c91..3bbf394 100644 --- a/docs/UpdateAttribute.md +++ b/docs/UpdateAttribute.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Value** | **string** | 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 0030f84..ec60017 100644 --- a/docs/UpdateContact.md +++ b/docs/UpdateContact.md @@ -3,7 +3,7 @@ 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. | [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] **EmailBlacklisted** | **bool?** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] **SmsBlacklisted** | **bool?** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] **ListIds** | **List<long?>** | Ids of the lists to add the contact to | [optional] diff --git a/docs/UpdateEmailCampaign.md b/docs/UpdateEmailCampaign.md index 9bbdfcb..84d8467 100644 --- a/docs/UpdateEmailCampaign.md +++ b/docs/UpdateEmailCampaign.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **Footer** | **string** | Footer of the email campaign | [optional] **Header** | **string** | Header of the email campaign | [optional] **UtmCampaign** | **string** | 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] **SendAtBestTime** | **bool?** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [optional] **AbTesting** | **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] **SubjectA** | **string** | 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..f060308 --- /dev/null +++ b/docs/UploadImageToGallery.md @@ -0,0 +1,10 @@ +# sib_api_v3_sdk.Model.UploadImageToGallery +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ImageUrl** | **string** | 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** | **string** | 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/sib_api_v3_sdk.sln b/sib_api_v3_sdk.sln index db22ec0..1ff9ad3 100644 --- a/sib_api_v3_sdk.sln +++ b/sib_api_v3_sdk.sln @@ -1,8 +1,8 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 15 -VisualStudioVersion = 15.0.28307.1022 +VisualStudioVersion = 15.0.28307.1062 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "sib_api_v3_sdk", "src\sib_api_v3_sdk\sib_api_v3_sdk.csproj", "{6C3156D9-31D5-4550-8E91-1BBAF88A5264}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "sib_api_v3_sdk", "src\sib_api_v3_sdk\sib_api_v3_sdk.csproj", "{75EF6C98-7CE6-4CC2-9A41-3A2FDB95DA3E}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -10,15 +10,15 @@ Global Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {6C3156D9-31D5-4550-8E91-1BBAF88A5264}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {6C3156D9-31D5-4550-8E91-1BBAF88A5264}.Debug|Any CPU.Build.0 = Debug|Any CPU - {6C3156D9-31D5-4550-8E91-1BBAF88A5264}.Release|Any CPU.ActiveCfg = Release|Any CPU - {6C3156D9-31D5-4550-8E91-1BBAF88A5264}.Release|Any CPU.Build.0 = Release|Any CPU + {75EF6C98-7CE6-4CC2-9A41-3A2FDB95DA3E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {75EF6C98-7CE6-4CC2-9A41-3A2FDB95DA3E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {75EF6C98-7CE6-4CC2-9A41-3A2FDB95DA3E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {75EF6C98-7CE6-4CC2-9A41-3A2FDB95DA3E}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution - SolutionGuid = {3E0E34C5-05C9-4975-BD57-02170BC5A67B} + SolutionGuid = {770ACEF6-7AF8-4718-BB40-6C28EEEA0058} EndGlobalSection EndGlobal diff --git a/src/sib_api_v3_sdk/Api/AccountApi.cs b/src/sib_api_v3_sdk/Api/AccountApi.cs index 375f475..3493243 100644 --- a/src/sib_api_v3_sdk/Api/AccountApi.cs +++ b/src/sib_api_v3_sdk/Api/AccountApi.cs @@ -25,7 +25,7 @@ public interface IAccountApi : IApiAccessor { #region Synchronous Operations /// - /// Get your account informations, plans and credits details + /// Get your account information, plan and credits details /// /// /// @@ -35,7 +35,7 @@ public interface IAccountApi : IApiAccessor GetAccount GetAccount (); /// - /// Get your account informations, plans and credits details + /// Get your account information, plan and credits details /// /// /// @@ -46,7 +46,7 @@ public interface IAccountApi : IApiAccessor #endregion Synchronous Operations #region Asynchronous Operations /// - /// Get your account informations, plans and credits details + /// Get your account information, plan and credits details /// /// /// @@ -56,7 +56,7 @@ public interface IAccountApi : IApiAccessor System.Threading.Tasks.Task GetAccountAsync (); /// - /// Get your account informations, plans and credits details + /// Get your account information, plan and credits details /// /// /// @@ -165,7 +165,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// Get your account informations, plans and credits details + /// Get your account information, plan and credits details /// /// Thrown when fails to make API call /// GetAccount @@ -176,7 +176,7 @@ public GetAccount GetAccount () } /// - /// Get your account informations, plans and credits details + /// Get your account information, plan and credits details /// /// Thrown when fails to make API call /// ApiResponse of GetAccount @@ -236,7 +236,7 @@ public ApiResponse< GetAccount > GetAccountWithHttpInfo () } /// - /// Get your account informations, plans and credits details + /// Get your account information, plan and credits details /// /// Thrown when fails to make API call /// Task of GetAccount @@ -248,7 +248,7 @@ public async System.Threading.Tasks.Task GetAccountAsync () } /// - /// Get your account informations, plans and credits details + /// Get your account information, plan and credits details /// /// Thrown when fails to make API call /// Task of ApiResponse (GetAccount) diff --git a/src/sib_api_v3_sdk/Api/AttributesApi.cs b/src/sib_api_v3_sdk/Api/AttributesApi.cs index d819488..ffa4a8e 100644 --- a/src/sib_api_v3_sdk/Api/AttributesApi.cs +++ b/src/sib_api_v3_sdk/Api/AttributesApi.cs @@ -25,7 +25,7 @@ public interface IAttributesApi : IApiAccessor { #region Synchronous Operations /// - /// Creates contact attribute + /// Create contact attribute /// /// /// @@ -38,7 +38,7 @@ public interface IAttributesApi : IApiAccessor void CreateAttribute (string attributeCategory, string attributeName, CreateAttribute createAttribute); /// - /// Creates contact attribute + /// Create contact attribute /// /// /// @@ -50,7 +50,7 @@ public interface IAttributesApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse CreateAttributeWithHttpInfo (string attributeCategory, string attributeName, CreateAttribute createAttribute); /// - /// Deletes an attribute + /// Delete an attribute /// /// /// @@ -62,7 +62,7 @@ public interface IAttributesApi : IApiAccessor void DeleteAttribute (string attributeCategory, string attributeName); /// - /// Deletes an attribute + /// Delete an attribute /// /// /// @@ -73,7 +73,7 @@ public interface IAttributesApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse DeleteAttributeWithHttpInfo (string attributeCategory, string attributeName); /// - /// Lists all attributes + /// List all attributes /// /// /// @@ -83,7 +83,7 @@ public interface IAttributesApi : IApiAccessor GetAttributes GetAttributes (); /// - /// Lists all attributes + /// List all attributes /// /// /// @@ -92,7 +92,7 @@ public interface IAttributesApi : IApiAccessor /// ApiResponse of GetAttributes ApiResponse GetAttributesWithHttpInfo (); /// - /// Updates contact attribute + /// Update contact attribute /// /// /// @@ -105,7 +105,7 @@ public interface IAttributesApi : IApiAccessor void UpdateAttribute (string attributeCategory, string attributeName, UpdateAttribute updateAttribute); /// - /// Updates contact attribute + /// Update contact attribute /// /// /// @@ -119,7 +119,7 @@ public interface IAttributesApi : IApiAccessor #endregion Synchronous Operations #region Asynchronous Operations /// - /// Creates contact attribute + /// Create contact attribute /// /// /// @@ -132,7 +132,7 @@ public interface IAttributesApi : IApiAccessor System.Threading.Tasks.Task CreateAttributeAsync (string attributeCategory, string attributeName, CreateAttribute createAttribute); /// - /// Creates contact attribute + /// Create contact attribute /// /// /// @@ -144,7 +144,7 @@ public interface IAttributesApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> CreateAttributeAsyncWithHttpInfo (string attributeCategory, string attributeName, CreateAttribute createAttribute); /// - /// Deletes an attribute + /// Delete an attribute /// /// /// @@ -156,7 +156,7 @@ public interface IAttributesApi : IApiAccessor System.Threading.Tasks.Task DeleteAttributeAsync (string attributeCategory, string attributeName); /// - /// Deletes an attribute + /// Delete an attribute /// /// /// @@ -167,7 +167,7 @@ public interface IAttributesApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> DeleteAttributeAsyncWithHttpInfo (string attributeCategory, string attributeName); /// - /// Lists all attributes + /// List all attributes /// /// /// @@ -177,7 +177,7 @@ public interface IAttributesApi : IApiAccessor System.Threading.Tasks.Task GetAttributesAsync (); /// - /// Lists all attributes + /// List all attributes /// /// /// @@ -186,7 +186,7 @@ public interface IAttributesApi : IApiAccessor /// Task of ApiResponse (GetAttributes) System.Threading.Tasks.Task> GetAttributesAsyncWithHttpInfo (); /// - /// Updates contact attribute + /// Update contact attribute /// /// /// @@ -199,7 +199,7 @@ public interface IAttributesApi : IApiAccessor System.Threading.Tasks.Task UpdateAttributeAsync (string attributeCategory, string attributeName, UpdateAttribute updateAttribute); /// - /// Updates contact attribute + /// Update contact attribute /// /// /// @@ -311,7 +311,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// Creates contact attribute + /// Create contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -324,7 +324,7 @@ public void CreateAttribute (string attributeCategory, string attributeName, Cre } /// - /// Creates contact attribute + /// Create contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -406,7 +406,7 @@ public ApiResponse CreateAttributeWithHttpInfo (string attributeCategory } /// - /// Creates contact attribute + /// Create contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -420,7 +420,7 @@ public async System.Threading.Tasks.Task CreateAttributeAsync (string attributeC } /// - /// Creates contact attribute + /// Create contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -502,7 +502,7 @@ public async System.Threading.Tasks.Task> CreateAttributeAsy } /// - /// Deletes an attribute + /// Delete an attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -514,7 +514,7 @@ public void DeleteAttribute (string attributeCategory, string attributeName) } /// - /// Deletes an attribute + /// Delete an attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -584,7 +584,7 @@ public ApiResponse DeleteAttributeWithHttpInfo (string attributeCategory } /// - /// Deletes an attribute + /// Delete an attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -597,7 +597,7 @@ public async System.Threading.Tasks.Task DeleteAttributeAsync (string attributeC } /// - /// Deletes an attribute + /// Delete an attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -667,7 +667,7 @@ public async System.Threading.Tasks.Task> DeleteAttributeAsy } /// - /// Lists all attributes + /// List all attributes /// /// Thrown when fails to make API call /// GetAttributes @@ -678,7 +678,7 @@ public GetAttributes GetAttributes () } /// - /// Lists all attributes + /// List all attributes /// /// Thrown when fails to make API call /// ApiResponse of GetAttributes @@ -738,7 +738,7 @@ public ApiResponse< GetAttributes > GetAttributesWithHttpInfo () } /// - /// Lists all attributes + /// List all attributes /// /// Thrown when fails to make API call /// Task of GetAttributes @@ -750,7 +750,7 @@ public async System.Threading.Tasks.Task GetAttributesAsync () } /// - /// Lists all attributes + /// List all attributes /// /// Thrown when fails to make API call /// Task of ApiResponse (GetAttributes) @@ -810,7 +810,7 @@ public async System.Threading.Tasks.Task> GetAttribut } /// - /// Updates contact attribute + /// Update contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -823,7 +823,7 @@ public void UpdateAttribute (string attributeCategory, string attributeName, Upd } /// - /// Updates contact attribute + /// Update contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -905,7 +905,7 @@ public ApiResponse UpdateAttributeWithHttpInfo (string attributeCategory } /// - /// Updates contact attribute + /// Update contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -919,7 +919,7 @@ public async System.Threading.Tasks.Task UpdateAttributeAsync (string attributeC } /// - /// Updates contact attribute + /// Update contact attribute /// /// Thrown when fails to make API call /// Category of the attribute diff --git a/src/sib_api_v3_sdk/Api/ContactsApi.cs b/src/sib_api_v3_sdk/Api/ContactsApi.cs index c0e0127..cc3aa28 100644 --- a/src/sib_api_v3_sdk/Api/ContactsApi.cs +++ b/src/sib_api_v3_sdk/Api/ContactsApi.cs @@ -48,7 +48,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of PostContactInfo ApiResponse AddContactToListWithHttpInfo (long? listId, AddContactToList contactEmails); /// - /// Creates contact attribute + /// Create contact attribute /// /// /// @@ -61,7 +61,7 @@ public interface IContactsApi : IApiAccessor void CreateAttribute (string attributeCategory, string attributeName, CreateAttribute createAttribute); /// - /// Creates contact attribute + /// Create contact attribute /// /// /// @@ -94,6 +94,27 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of CreateUpdateContactModel ApiResponse CreateContactWithHttpInfo (CreateContact createContact); /// + /// Create a contact to trigger the DOI workflow from a Landing Page form + /// + /// + /// + /// + /// Thrown when fails to make API call + /// Values to create the DOI contact + /// + void CreateDoiContact (CreateDoiContact createDoiContact); + + /// + /// Create a contact to trigger the DOI workflow from a Landing Page form + /// + /// + /// + /// + /// Thrown when fails to make API call + /// Values to create the DOI contact + /// ApiResponse of Object(void) + ApiResponse CreateDoiContactWithHttpInfo (CreateDoiContact createDoiContact); + /// /// Create a folder /// /// @@ -136,7 +157,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of CreateModel ApiResponse CreateListWithHttpInfo (CreateList createList); /// - /// Deletes an attribute + /// Delete an attribute /// /// /// @@ -148,7 +169,7 @@ public interface IContactsApi : IApiAccessor void DeleteAttribute (string attributeCategory, string attributeName); /// - /// Deletes an attribute + /// Delete an attribute /// /// /// @@ -159,7 +180,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse DeleteAttributeWithHttpInfo (string attributeCategory, string attributeName); /// - /// Deletes a contact + /// Delete a contact /// /// /// @@ -170,7 +191,7 @@ public interface IContactsApi : IApiAccessor void DeleteContact (string email); /// - /// Deletes a contact + /// Delete a contact /// /// /// @@ -222,7 +243,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse DeleteListWithHttpInfo (long? listId); /// - /// Lists all attributes + /// List all attributes /// /// /// @@ -232,7 +253,7 @@ public interface IContactsApi : IApiAccessor GetAttributes GetAttributes (); /// - /// Lists all attributes + /// List all attributes /// /// /// @@ -241,7 +262,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of GetAttributes ApiResponse GetAttributesWithHttpInfo (); /// - /// Retrieves contact informations + /// Get a contact's details /// /// /// @@ -252,7 +273,7 @@ public interface IContactsApi : IApiAccessor GetExtendedContactDetails GetContactInfo (string email); /// - /// Retrieves contact informations + /// Get a contact's details /// /// /// @@ -262,26 +283,30 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of GetExtendedContactDetails ApiResponse GetContactInfoWithHttpInfo (string email); /// - /// Get the campaigns statistics for a contact + /// Get email campaigns' statistics for a contact /// /// /// /// /// Thrown when fails to make API call /// Email address (urlencoded) of the contact + /// 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) + /// 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) /// GetContactCampaignStats - GetContactCampaignStats GetContactStats (string email); + GetContactCampaignStats GetContactStats (string email, DateTime? startDate = null, DateTime? endDate = null); /// - /// Get the campaigns statistics for a contact + /// Get email campaigns' statistics for a contact /// /// /// /// /// Thrown when fails to make API call /// Email address (urlencoded) of the contact + /// 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) + /// 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) /// ApiResponse of GetContactCampaignStats - ApiResponse GetContactStatsWithHttpInfo (string email); + ApiResponse GetContactStatsWithHttpInfo (string email, DateTime? startDate = null, DateTime? endDate = null); /// /// Get all the contacts /// @@ -308,7 +333,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of GetContacts ApiResponse GetContactsWithHttpInfo (long? limit = null, long? offset = null, DateTime? modifiedSince = null); /// - /// Get the contacts in a list + /// Get contacts in a list /// /// /// @@ -322,7 +347,7 @@ public interface IContactsApi : IApiAccessor GetContacts GetContactsFromList (long? listId, DateTime? modifiedSince = null, long? limit = null, long? offset = null); /// - /// Get the contacts in a list + /// Get contacts in a list /// /// /// @@ -335,7 +360,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of GetContacts ApiResponse GetContactsFromListWithHttpInfo (long? listId, DateTime? modifiedSince = null, long? limit = null, long? offset = null); /// - /// Returns folder details + /// Returns a folder's details /// /// /// @@ -346,7 +371,7 @@ public interface IContactsApi : IApiAccessor GetFolder GetFolder (long? folderId); /// - /// Returns folder details + /// Returns a folder's details /// /// /// @@ -356,7 +381,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of GetFolder ApiResponse GetFolderWithHttpInfo (long? folderId); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -369,7 +394,7 @@ public interface IContactsApi : IApiAccessor GetFolderLists GetFolderLists (long? folderId, long? limit = null, long? offset = null); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -381,7 +406,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of GetFolderLists ApiResponse GetFolderListsWithHttpInfo (long? folderId, long? limit = null, long? offset = null); /// - /// Get all the folders + /// Get all folders /// /// /// @@ -393,7 +418,7 @@ public interface IContactsApi : IApiAccessor GetFolders GetFolders (long? limit, long? offset); /// - /// Get all the folders + /// Get all folders /// /// /// @@ -404,7 +429,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of GetFolders ApiResponse GetFoldersWithHttpInfo (long? limit, long? offset); /// - /// Get the details of a list + /// Get a list's details /// /// /// @@ -415,7 +440,7 @@ public interface IContactsApi : IApiAccessor GetExtendedList GetList (long? listId); /// - /// Get the details of a list + /// Get a list's details /// /// /// @@ -469,7 +494,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of CreatedProcessId ApiResponse ImportContactsWithHttpInfo (RequestContactImport requestContactImport); /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// /// @@ -481,7 +506,7 @@ public interface IContactsApi : IApiAccessor PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromList contactEmails); /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// /// @@ -513,7 +538,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of CreatedProcessId ApiResponse RequestContactExportWithHttpInfo (RequestContactExport requestContactExport); /// - /// Updates contact attribute + /// Update contact attribute /// /// /// @@ -526,7 +551,7 @@ public interface IContactsApi : IApiAccessor void UpdateAttribute (string attributeCategory, string attributeName, UpdateAttribute updateAttribute); /// - /// Updates contact attribute + /// Update contact attribute /// /// /// @@ -538,7 +563,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse UpdateAttributeWithHttpInfo (string attributeCategory, string attributeName, UpdateAttribute updateAttribute); /// - /// Updates a contact + /// Update a contact /// /// /// @@ -550,7 +575,7 @@ public interface IContactsApi : IApiAccessor void UpdateContact (string email, UpdateContact updateContact); /// - /// Updates a contact + /// Update a contact /// /// /// @@ -561,7 +586,7 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse UpdateContactWithHttpInfo (string email, UpdateContact updateContact); /// - /// Update a contact folder + /// Update a folder /// /// /// @@ -573,7 +598,7 @@ public interface IContactsApi : IApiAccessor void UpdateFolder (long? folderId, CreateUpdateFolder updateFolder); /// - /// Update a contact folder + /// Update a folder /// /// /// @@ -632,7 +657,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (PostContactInfo) System.Threading.Tasks.Task> AddContactToListAsyncWithHttpInfo (long? listId, AddContactToList contactEmails); /// - /// Creates contact attribute + /// Create contact attribute /// /// /// @@ -645,7 +670,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task CreateAttributeAsync (string attributeCategory, string attributeName, CreateAttribute createAttribute); /// - /// Creates contact attribute + /// Create contact attribute /// /// /// @@ -678,6 +703,27 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (CreateUpdateContactModel) System.Threading.Tasks.Task> CreateContactAsyncWithHttpInfo (CreateContact createContact); /// + /// Create a contact to trigger the DOI workflow from a Landing Page form + /// + /// + /// + /// + /// Thrown when fails to make API call + /// Values to create the DOI contact + /// Task of void + System.Threading.Tasks.Task CreateDoiContactAsync (CreateDoiContact createDoiContact); + + /// + /// Create a contact to trigger the DOI workflow from a Landing Page form + /// + /// + /// + /// + /// Thrown when fails to make API call + /// Values to create the DOI contact + /// Task of ApiResponse + System.Threading.Tasks.Task> CreateDoiContactAsyncWithHttpInfo (CreateDoiContact createDoiContact); + /// /// Create a folder /// /// @@ -720,7 +766,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (CreateModel) System.Threading.Tasks.Task> CreateListAsyncWithHttpInfo (CreateList createList); /// - /// Deletes an attribute + /// Delete an attribute /// /// /// @@ -732,7 +778,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task DeleteAttributeAsync (string attributeCategory, string attributeName); /// - /// Deletes an attribute + /// Delete an attribute /// /// /// @@ -743,7 +789,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> DeleteAttributeAsyncWithHttpInfo (string attributeCategory, string attributeName); /// - /// Deletes a contact + /// Delete a contact /// /// /// @@ -754,7 +800,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task DeleteContactAsync (string email); /// - /// Deletes a contact + /// Delete a contact /// /// /// @@ -806,7 +852,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> DeleteListAsyncWithHttpInfo (long? listId); /// - /// Lists all attributes + /// List all attributes /// /// /// @@ -816,7 +862,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task GetAttributesAsync (); /// - /// Lists all attributes + /// List all attributes /// /// /// @@ -825,7 +871,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (GetAttributes) System.Threading.Tasks.Task> GetAttributesAsyncWithHttpInfo (); /// - /// Retrieves contact informations + /// Get a contact's details /// /// /// @@ -836,7 +882,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task GetContactInfoAsync (string email); /// - /// Retrieves contact informations + /// Get a contact's details /// /// /// @@ -846,26 +892,30 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (GetExtendedContactDetails) System.Threading.Tasks.Task> GetContactInfoAsyncWithHttpInfo (string email); /// - /// Get the campaigns statistics for a contact + /// Get email campaigns' statistics for a contact /// /// /// /// /// Thrown when fails to make API call /// Email address (urlencoded) of the contact + /// 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) + /// 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) /// Task of GetContactCampaignStats - System.Threading.Tasks.Task GetContactStatsAsync (string email); + System.Threading.Tasks.Task GetContactStatsAsync (string email, DateTime? startDate = null, DateTime? endDate = null); /// - /// Get the campaigns statistics for a contact + /// Get email campaigns' statistics for a contact /// /// /// /// /// Thrown when fails to make API call /// Email address (urlencoded) of the contact + /// 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) + /// 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) /// Task of ApiResponse (GetContactCampaignStats) - System.Threading.Tasks.Task> GetContactStatsAsyncWithHttpInfo (string email); + System.Threading.Tasks.Task> GetContactStatsAsyncWithHttpInfo (string email, DateTime? startDate = null, DateTime? endDate = null); /// /// Get all the contacts /// @@ -892,7 +942,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (GetContacts) System.Threading.Tasks.Task> GetContactsAsyncWithHttpInfo (long? limit = null, long? offset = null, DateTime? modifiedSince = null); /// - /// Get the contacts in a list + /// Get contacts in a list /// /// /// @@ -906,7 +956,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task GetContactsFromListAsync (long? listId, DateTime? modifiedSince = null, long? limit = null, long? offset = null); /// - /// Get the contacts in a list + /// Get contacts in a list /// /// /// @@ -919,7 +969,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (GetContacts) System.Threading.Tasks.Task> GetContactsFromListAsyncWithHttpInfo (long? listId, DateTime? modifiedSince = null, long? limit = null, long? offset = null); /// - /// Returns folder details + /// Returns a folder's details /// /// /// @@ -930,7 +980,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task GetFolderAsync (long? folderId); /// - /// Returns folder details + /// Returns a folder's details /// /// /// @@ -940,7 +990,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (GetFolder) System.Threading.Tasks.Task> GetFolderAsyncWithHttpInfo (long? folderId); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -953,7 +1003,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task GetFolderListsAsync (long? folderId, long? limit = null, long? offset = null); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -965,7 +1015,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (GetFolderLists) System.Threading.Tasks.Task> GetFolderListsAsyncWithHttpInfo (long? folderId, long? limit = null, long? offset = null); /// - /// Get all the folders + /// Get all folders /// /// /// @@ -977,7 +1027,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task GetFoldersAsync (long? limit, long? offset); /// - /// Get all the folders + /// Get all folders /// /// /// @@ -988,7 +1038,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (GetFolders) System.Threading.Tasks.Task> GetFoldersAsyncWithHttpInfo (long? limit, long? offset); /// - /// Get the details of a list + /// Get a list's details /// /// /// @@ -999,7 +1049,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task GetListAsync (long? listId); /// - /// Get the details of a list + /// Get a list's details /// /// /// @@ -1053,7 +1103,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (CreatedProcessId) System.Threading.Tasks.Task> ImportContactsAsyncWithHttpInfo (RequestContactImport requestContactImport); /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// /// @@ -1065,7 +1115,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task RemoveContactFromListAsync (long? listId, RemoveContactFromList contactEmails); /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// /// @@ -1097,7 +1147,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse (CreatedProcessId) System.Threading.Tasks.Task> RequestContactExportAsyncWithHttpInfo (RequestContactExport requestContactExport); /// - /// Updates contact attribute + /// Update contact attribute /// /// /// @@ -1110,7 +1160,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task UpdateAttributeAsync (string attributeCategory, string attributeName, UpdateAttribute updateAttribute); /// - /// Updates contact attribute + /// Update contact attribute /// /// /// @@ -1122,7 +1172,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> UpdateAttributeAsyncWithHttpInfo (string attributeCategory, string attributeName, UpdateAttribute updateAttribute); /// - /// Updates a contact + /// Update a contact /// /// /// @@ -1134,7 +1184,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task UpdateContactAsync (string email, UpdateContact updateContact); /// - /// Updates a contact + /// Update a contact /// /// /// @@ -1145,7 +1195,7 @@ public interface IContactsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> UpdateContactAsyncWithHttpInfo (string email, UpdateContact updateContact); /// - /// Update a contact folder + /// Update a folder /// /// /// @@ -1157,7 +1207,7 @@ public interface IContactsApi : IApiAccessor System.Threading.Tasks.Task UpdateFolderAsync (long? folderId, CreateUpdateFolder updateFolder); /// - /// Update a contact folder + /// Update a folder /// /// /// @@ -1472,7 +1522,7 @@ public async System.Threading.Tasks.Task> AddContac } /// - /// Creates contact attribute + /// Create contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -1485,7 +1535,7 @@ public void CreateAttribute (string attributeCategory, string attributeName, Cre } /// - /// Creates contact attribute + /// Create contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -1567,7 +1617,7 @@ public ApiResponse CreateAttributeWithHttpInfo (string attributeCategory } /// - /// Creates contact attribute + /// Create contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -1581,7 +1631,7 @@ public async System.Threading.Tasks.Task CreateAttributeAsync (string attributeC } /// - /// Creates contact attribute + /// Create contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -1831,6 +1881,173 @@ public async System.Threading.Tasks.Task> (CreateUpdateContactModel) this.Configuration.ApiClient.Deserialize(localVarResponse, typeof(CreateUpdateContactModel))); } + /// + /// Create a contact to trigger the DOI workflow from a Landing Page form + /// + /// Thrown when fails to make API call + /// Values to create the DOI contact + /// + public void CreateDoiContact (CreateDoiContact createDoiContact) + { + CreateDoiContactWithHttpInfo(createDoiContact); + } + + /// + /// Create a contact to trigger the DOI workflow from a Landing Page form + /// + /// Thrown when fails to make API call + /// Values to create the DOI contact + /// ApiResponse of Object(void) + public ApiResponse CreateDoiContactWithHttpInfo (CreateDoiContact createDoiContact) + { + // verify the required parameter 'createDoiContact' is set + if (createDoiContact == null) + throw new ApiException(400, "Missing required parameter 'createDoiContact' when calling ContactsApi->CreateDoiContact"); + + var localVarPath = "./contacts/doubleOptinConfirmation"; + var localVarPathParams = new Dictionary(); + var localVarQueryParams = new List>(); + var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); + var localVarFormParams = new Dictionary(); + var localVarFileParams = new Dictionary(); + Object localVarPostBody = null; + + // to determine the Content-Type header + String[] localVarHttpContentTypes = new String[] { + "application/json" + }; + String localVarHttpContentType = this.Configuration.ApiClient.SelectHeaderContentType(localVarHttpContentTypes); + + // to determine the Accept header + String[] localVarHttpHeaderAccepts = new String[] { + "application/json" + }; + String localVarHttpHeaderAccept = this.Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); + if (localVarHttpHeaderAccept != null) + localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); + + if (createDoiContact != null && createDoiContact.GetType() != typeof(byte[])) + { + localVarPostBody = this.Configuration.ApiClient.Serialize(createDoiContact); // http body (model) parameter + } + else + { + localVarPostBody = createDoiContact; // byte array + } + + // authentication (api-key) required + if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) + { + localVarHeaderParams["api-key"] = this.Configuration.GetApiKeyWithPrefix("api-key"); + } + // authentication (partner-key) required + if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("partner-key"))) + { + localVarHeaderParams["partner-key"] = this.Configuration.GetApiKeyWithPrefix("partner-key"); + } + + // make the HTTP request + IRestResponse localVarResponse = (IRestResponse) this.Configuration.ApiClient.CallApi(localVarPath, + Method.POST, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarFileParams, + localVarPathParams, localVarHttpContentType); + + int localVarStatusCode = (int) localVarResponse.StatusCode; + + if (ExceptionFactory != null) + { + Exception exception = ExceptionFactory("CreateDoiContact", localVarResponse); + if (exception != null) throw exception; + } + + return new ApiResponse(localVarStatusCode, + localVarResponse.Headers.ToDictionary(x => x.Key, x => x.Value.ToString()), + null); + } + + /// + /// Create a contact to trigger the DOI workflow from a Landing Page form + /// + /// Thrown when fails to make API call + /// Values to create the DOI contact + /// Task of void + public async System.Threading.Tasks.Task CreateDoiContactAsync (CreateDoiContact createDoiContact) + { + await CreateDoiContactAsyncWithHttpInfo(createDoiContact); + + } + + /// + /// Create a contact to trigger the DOI workflow from a Landing Page form + /// + /// Thrown when fails to make API call + /// Values to create the DOI contact + /// Task of ApiResponse + public async System.Threading.Tasks.Task> CreateDoiContactAsyncWithHttpInfo (CreateDoiContact createDoiContact) + { + // verify the required parameter 'createDoiContact' is set + if (createDoiContact == null) + throw new ApiException(400, "Missing required parameter 'createDoiContact' when calling ContactsApi->CreateDoiContact"); + + var localVarPath = "./contacts/doubleOptinConfirmation"; + var localVarPathParams = new Dictionary(); + var localVarQueryParams = new List>(); + var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); + var localVarFormParams = new Dictionary(); + var localVarFileParams = new Dictionary(); + Object localVarPostBody = null; + + // to determine the Content-Type header + String[] localVarHttpContentTypes = new String[] { + "application/json" + }; + String localVarHttpContentType = this.Configuration.ApiClient.SelectHeaderContentType(localVarHttpContentTypes); + + // to determine the Accept header + String[] localVarHttpHeaderAccepts = new String[] { + "application/json" + }; + String localVarHttpHeaderAccept = this.Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); + if (localVarHttpHeaderAccept != null) + localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); + + if (createDoiContact != null && createDoiContact.GetType() != typeof(byte[])) + { + localVarPostBody = this.Configuration.ApiClient.Serialize(createDoiContact); // http body (model) parameter + } + else + { + localVarPostBody = createDoiContact; // byte array + } + + // authentication (api-key) required + if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) + { + localVarHeaderParams["api-key"] = this.Configuration.GetApiKeyWithPrefix("api-key"); + } + // authentication (partner-key) required + if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("partner-key"))) + { + localVarHeaderParams["partner-key"] = this.Configuration.GetApiKeyWithPrefix("partner-key"); + } + + // make the HTTP request + IRestResponse localVarResponse = (IRestResponse) await this.Configuration.ApiClient.CallApiAsync(localVarPath, + Method.POST, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarFileParams, + localVarPathParams, localVarHttpContentType); + + int localVarStatusCode = (int) localVarResponse.StatusCode; + + if (ExceptionFactory != null) + { + Exception exception = ExceptionFactory("CreateDoiContact", localVarResponse); + if (exception != null) throw exception; + } + + return new ApiResponse(localVarStatusCode, + localVarResponse.Headers.ToDictionary(x => x.Key, x => x.Value.ToString()), + null); + } + /// /// Create a folder /// @@ -2170,7 +2387,7 @@ public async System.Threading.Tasks.Task> CreateListAsy } /// - /// Deletes an attribute + /// Delete an attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -2182,7 +2399,7 @@ public void DeleteAttribute (string attributeCategory, string attributeName) } /// - /// Deletes an attribute + /// Delete an attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -2252,7 +2469,7 @@ public ApiResponse DeleteAttributeWithHttpInfo (string attributeCategory } /// - /// Deletes an attribute + /// Delete an attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -2265,7 +2482,7 @@ public async System.Threading.Tasks.Task DeleteAttributeAsync (string attributeC } /// - /// Deletes an attribute + /// Delete an attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -2335,7 +2552,7 @@ public async System.Threading.Tasks.Task> DeleteAttributeAsy } /// - /// Deletes a contact + /// Delete a contact /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact @@ -2346,7 +2563,7 @@ public void DeleteContact (string email) } /// - /// Deletes a contact + /// Delete a contact /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact @@ -2411,7 +2628,7 @@ public ApiResponse DeleteContactWithHttpInfo (string email) } /// - /// Deletes a contact + /// Delete a contact /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact @@ -2423,7 +2640,7 @@ public async System.Threading.Tasks.Task DeleteContactAsync (string email) } /// - /// Deletes a contact + /// Delete a contact /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact @@ -2794,7 +3011,7 @@ public async System.Threading.Tasks.Task> DeleteListAsyncWit } /// - /// Lists all attributes + /// List all attributes /// /// Thrown when fails to make API call /// GetAttributes @@ -2805,7 +3022,7 @@ public GetAttributes GetAttributes () } /// - /// Lists all attributes + /// List all attributes /// /// Thrown when fails to make API call /// ApiResponse of GetAttributes @@ -2865,7 +3082,7 @@ public ApiResponse< GetAttributes > GetAttributesWithHttpInfo () } /// - /// Lists all attributes + /// List all attributes /// /// Thrown when fails to make API call /// Task of GetAttributes @@ -2877,7 +3094,7 @@ public async System.Threading.Tasks.Task GetAttributesAsync () } /// - /// Lists all attributes + /// List all attributes /// /// Thrown when fails to make API call /// Task of ApiResponse (GetAttributes) @@ -2937,7 +3154,7 @@ public async System.Threading.Tasks.Task> GetAttribut } /// - /// Retrieves contact informations + /// Get a contact's details /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact OR its SMS attribute value @@ -2949,7 +3166,7 @@ public GetExtendedContactDetails GetContactInfo (string email) } /// - /// Retrieves contact informations + /// Get a contact's details /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact OR its SMS attribute value @@ -3014,7 +3231,7 @@ public ApiResponse< GetExtendedContactDetails > GetContactInfoWithHttpInfo (stri } /// - /// Retrieves contact informations + /// Get a contact's details /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact OR its SMS attribute value @@ -3027,7 +3244,7 @@ public async System.Threading.Tasks.Task GetContactIn } /// - /// Retrieves contact informations + /// Get a contact's details /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact OR its SMS attribute value @@ -3092,24 +3309,28 @@ public async System.Threading.Tasks.Task> } /// - /// Get the campaigns statistics for a contact + /// Get email campaigns' statistics for a contact /// /// Thrown when fails to make API call /// Email address (urlencoded) of the contact + /// 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) + /// 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) /// GetContactCampaignStats - public GetContactCampaignStats GetContactStats (string email) + public GetContactCampaignStats GetContactStats (string email, DateTime? startDate = null, DateTime? endDate = null) { - ApiResponse localVarResponse = GetContactStatsWithHttpInfo(email); + ApiResponse localVarResponse = GetContactStatsWithHttpInfo(email, startDate, endDate); return localVarResponse.Data; } /// - /// Get the campaigns statistics for a contact + /// Get email campaigns' statistics for a contact /// /// Thrown when fails to make API call /// Email address (urlencoded) of the contact + /// 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) + /// 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) /// ApiResponse of GetContactCampaignStats - public ApiResponse< GetContactCampaignStats > GetContactStatsWithHttpInfo (string email) + public ApiResponse< GetContactCampaignStats > GetContactStatsWithHttpInfo (string email, DateTime? startDate = null, DateTime? endDate = null) { // verify the required parameter 'email' is set if (email == null) @@ -3138,6 +3359,8 @@ public ApiResponse< GetContactCampaignStats > GetContactStatsWithHttpInfo (strin localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); if (email != null) localVarPathParams.Add("email", this.Configuration.ApiClient.ParameterToString(email)); // path parameter + if (startDate != null) localVarQueryParams.AddRange(this.Configuration.ApiClient.ParameterToKeyValuePairs("", "startDate", startDate)); // query parameter + if (endDate != null) localVarQueryParams.AddRange(this.Configuration.ApiClient.ParameterToKeyValuePairs("", "endDate", endDate)); // query parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -3169,25 +3392,29 @@ public ApiResponse< GetContactCampaignStats > GetContactStatsWithHttpInfo (strin } /// - /// Get the campaigns statistics for a contact + /// Get email campaigns' statistics for a contact /// /// Thrown when fails to make API call /// Email address (urlencoded) of the contact + /// 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) + /// 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) /// Task of GetContactCampaignStats - public async System.Threading.Tasks.Task GetContactStatsAsync (string email) + public async System.Threading.Tasks.Task GetContactStatsAsync (string email, DateTime? startDate = null, DateTime? endDate = null) { - ApiResponse localVarResponse = await GetContactStatsAsyncWithHttpInfo(email); + ApiResponse localVarResponse = await GetContactStatsAsyncWithHttpInfo(email, startDate, endDate); return localVarResponse.Data; } /// - /// Get the campaigns statistics for a contact + /// Get email campaigns' statistics for a contact /// /// Thrown when fails to make API call /// Email address (urlencoded) of the contact + /// 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) + /// 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) /// Task of ApiResponse (GetContactCampaignStats) - public async System.Threading.Tasks.Task> GetContactStatsAsyncWithHttpInfo (string email) + public async System.Threading.Tasks.Task> GetContactStatsAsyncWithHttpInfo (string email, DateTime? startDate = null, DateTime? endDate = null) { // verify the required parameter 'email' is set if (email == null) @@ -3216,6 +3443,8 @@ public async System.Threading.Tasks.Task> G localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); if (email != null) localVarPathParams.Add("email", this.Configuration.ApiClient.ParameterToString(email)); // path parameter + if (startDate != null) localVarQueryParams.AddRange(this.Configuration.ApiClient.ParameterToKeyValuePairs("", "startDate", startDate)); // query parameter + if (endDate != null) localVarQueryParams.AddRange(this.Configuration.ApiClient.ParameterToKeyValuePairs("", "endDate", endDate)); // query parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -3408,7 +3637,7 @@ public async System.Threading.Tasks.Task> GetContactsAs } /// - /// Get the contacts in a list + /// Get contacts in a list /// /// Thrown when fails to make API call /// Id of the list @@ -3423,7 +3652,7 @@ public GetContacts GetContactsFromList (long? listId, DateTime? modifiedSince = } /// - /// Get the contacts in a list + /// Get contacts in a list /// /// Thrown when fails to make API call /// Id of the list @@ -3494,7 +3723,7 @@ public ApiResponse< GetContacts > GetContactsFromListWithHttpInfo (long? listId, } /// - /// Get the contacts in a list + /// Get contacts in a list /// /// Thrown when fails to make API call /// Id of the list @@ -3510,7 +3739,7 @@ public async System.Threading.Tasks.Task GetContactsFromListAsync ( } /// - /// Get the contacts in a list + /// Get contacts in a list /// /// Thrown when fails to make API call /// Id of the list @@ -3581,7 +3810,7 @@ public async System.Threading.Tasks.Task> GetContactsFr } /// - /// Returns folder details + /// Returns a folder's details /// /// Thrown when fails to make API call /// id of the folder @@ -3593,7 +3822,7 @@ public GetFolder GetFolder (long? folderId) } /// - /// Returns folder details + /// Returns a folder's details /// /// Thrown when fails to make API call /// id of the folder @@ -3658,7 +3887,7 @@ public ApiResponse< GetFolder > GetFolderWithHttpInfo (long? folderId) } /// - /// Returns folder details + /// Returns a folder's details /// /// Thrown when fails to make API call /// id of the folder @@ -3671,7 +3900,7 @@ public async System.Threading.Tasks.Task GetFolderAsync (long? folder } /// - /// Returns folder details + /// Returns a folder's details /// /// Thrown when fails to make API call /// id of the folder @@ -3736,7 +3965,7 @@ public async System.Threading.Tasks.Task> GetFolderAsyncW } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -3750,7 +3979,7 @@ public GetFolderLists GetFolderLists (long? folderId, long? limit = null, long? } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -3819,7 +4048,7 @@ public ApiResponse< GetFolderLists > GetFolderListsWithHttpInfo (long? folderId, } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -3834,7 +4063,7 @@ public async System.Threading.Tasks.Task GetFolderListsAsync (lo } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -3903,7 +4132,7 @@ public async System.Threading.Tasks.Task> GetFolderL } /// - /// Get all the folders + /// Get all folders /// /// Thrown when fails to make API call /// Number of documents per page @@ -3916,7 +4145,7 @@ public GetFolders GetFolders (long? limit, long? offset) } /// - /// Get all the folders + /// Get all folders /// /// Thrown when fails to make API call /// Number of documents per page @@ -3986,7 +4215,7 @@ public ApiResponse< GetFolders > GetFoldersWithHttpInfo (long? limit, long? offs } /// - /// Get all the folders + /// Get all folders /// /// Thrown when fails to make API call /// Number of documents per page @@ -4000,7 +4229,7 @@ public async System.Threading.Tasks.Task GetFoldersAsync (long? limi } /// - /// Get all the folders + /// Get all folders /// /// Thrown when fails to make API call /// Number of documents per page @@ -4070,7 +4299,7 @@ public async System.Threading.Tasks.Task> GetFoldersAsyn } /// - /// Get the details of a list + /// Get a list's details /// /// Thrown when fails to make API call /// Id of the list @@ -4082,7 +4311,7 @@ public GetExtendedList GetList (long? listId) } /// - /// Get the details of a list + /// Get a list's details /// /// Thrown when fails to make API call /// Id of the list @@ -4147,7 +4376,7 @@ public ApiResponse< GetExtendedList > GetListWithHttpInfo (long? listId) } /// - /// Get the details of a list + /// Get a list's details /// /// Thrown when fails to make API call /// Id of the list @@ -4160,7 +4389,7 @@ public async System.Threading.Tasks.Task GetListAsync (long? li } /// - /// Get the details of a list + /// Get a list's details /// /// Thrown when fails to make API call /// Id of the list @@ -4549,7 +4778,7 @@ public async System.Threading.Tasks.Task> ImportCo } /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// Thrown when fails to make API call /// Id of the list @@ -4562,7 +4791,7 @@ public PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromLis } /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// Thrown when fails to make API call /// Id of the list @@ -4639,7 +4868,7 @@ public ApiResponse< PostContactInfo > RemoveContactFromListWithHttpInfo (long? l } /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// Thrown when fails to make API call /// Id of the list @@ -4653,7 +4882,7 @@ public async System.Threading.Tasks.Task RemoveContactFromListA } /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// Thrown when fails to make API call /// Id of the list @@ -4899,7 +5128,7 @@ public async System.Threading.Tasks.Task> RequestC } /// - /// Updates contact attribute + /// Update contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -4912,7 +5141,7 @@ public void UpdateAttribute (string attributeCategory, string attributeName, Upd } /// - /// Updates contact attribute + /// Update contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -4994,7 +5223,7 @@ public ApiResponse UpdateAttributeWithHttpInfo (string attributeCategory } /// - /// Updates contact attribute + /// Update contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -5008,7 +5237,7 @@ public async System.Threading.Tasks.Task UpdateAttributeAsync (string attributeC } /// - /// Updates contact attribute + /// Update contact attribute /// /// Thrown when fails to make API call /// Category of the attribute @@ -5090,7 +5319,7 @@ public async System.Threading.Tasks.Task> UpdateAttributeAsy } /// - /// Updates a contact + /// Update a contact /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact @@ -5102,7 +5331,7 @@ public void UpdateContact (string email, UpdateContact updateContact) } /// - /// Updates a contact + /// Update a contact /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact @@ -5179,7 +5408,7 @@ public ApiResponse UpdateContactWithHttpInfo (string email, UpdateContac } /// - /// Updates a contact + /// Update a contact /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact @@ -5192,7 +5421,7 @@ public async System.Threading.Tasks.Task UpdateContactAsync (string email, Updat } /// - /// Updates a contact + /// Update a contact /// /// Thrown when fails to make API call /// Email (urlencoded) of the contact @@ -5269,7 +5498,7 @@ public async System.Threading.Tasks.Task> UpdateContactAsync } /// - /// Update a contact folder + /// Update a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -5281,7 +5510,7 @@ public void UpdateFolder (long? folderId, CreateUpdateFolder updateFolder) } /// - /// Update a contact folder + /// Update a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -5358,7 +5587,7 @@ public ApiResponse UpdateFolderWithHttpInfo (long? folderId, CreateUpdat } /// - /// Update a contact folder + /// Update a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -5371,7 +5600,7 @@ public async System.Threading.Tasks.Task UpdateFolderAsync (long? folderId, Crea } /// - /// Update a contact folder + /// Update a folder /// /// Thrown when fails to make API call /// Id of the folder diff --git a/src/sib_api_v3_sdk/Api/EmailCampaignsApi.cs b/src/sib_api_v3_sdk/Api/EmailCampaignsApi.cs index e1fbdea..f0be901 100644 --- a/src/sib_api_v3_sdk/Api/EmailCampaignsApi.cs +++ b/src/sib_api_v3_sdk/Api/EmailCampaignsApi.cs @@ -67,7 +67,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse DeleteEmailCampaignWithHttpInfo (long? campaignId); /// - /// Export the recipients of a campaign + /// Export the recipients of an email campaign /// /// /// @@ -79,7 +79,7 @@ public interface IEmailCampaignsApi : IApiAccessor CreatedProcessId EmailExportRecipients (long? campaignId, EmailExportRecipients recipientExport = null); /// - /// Export the recipients of a campaign + /// Export the recipients of an email campaign /// /// /// @@ -90,7 +90,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// ApiResponse of CreatedProcessId ApiResponse EmailExportRecipientsWithHttpInfo (long? campaignId, EmailExportRecipients recipientExport = null); /// - /// 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 @@ -101,7 +101,7 @@ public interface IEmailCampaignsApi : IApiAccessor AbTestCampaignResult GetAbTestCampaignResult (long? campaignId); /// - /// 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 @@ -111,7 +111,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// ApiResponse of AbTestCampaignResult ApiResponse GetAbTestCampaignResultWithHttpInfo (long? campaignId); /// - /// Get campaign informations + /// Get an email campaign report /// /// /// @@ -122,7 +122,7 @@ public interface IEmailCampaignsApi : IApiAccessor GetEmailCampaign GetEmailCampaign (long? campaignId); /// - /// Get campaign informations + /// Get an email campaign report /// /// /// @@ -132,7 +132,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// ApiResponse of GetEmailCampaign ApiResponse GetEmailCampaignWithHttpInfo (long? campaignId); /// - /// Return all your created campaigns + /// Return all your created email campaigns /// /// /// @@ -148,7 +148,7 @@ public interface IEmailCampaignsApi : IApiAccessor GetEmailCampaigns GetEmailCampaigns (string type = null, string status = null, DateTime? startDate = null, DateTime? endDate = null, long? limit = null, long? offset = null); /// - /// Return all your created campaigns + /// Return all your created email campaigns /// /// /// @@ -205,7 +205,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse SendEmailCampaignNowWithHttpInfo (long? campaignId); /// - /// Send the report of a campaigns + /// Send the report of a campaign /// /// /// A PDF will be sent to the specified email addresses @@ -217,7 +217,7 @@ public interface IEmailCampaignsApi : IApiAccessor void SendReport (long? campaignId, SendReport sendReport); /// - /// Send the report of a campaigns + /// Send the report of a campaign /// /// /// A PDF will be sent to the specified email addresses @@ -251,7 +251,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse SendTestEmailWithHttpInfo (long? campaignId, SendTestEmail emailTo); /// - /// Update a campaign status + /// Update an email campaign status /// /// /// @@ -263,7 +263,7 @@ public interface IEmailCampaignsApi : IApiAccessor void UpdateCampaignStatus (long? campaignId, UpdateCampaignStatus status); /// - /// Update a campaign status + /// Update an email campaign status /// /// /// @@ -274,7 +274,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse UpdateCampaignStatusWithHttpInfo (long? campaignId, UpdateCampaignStatus status); /// - /// Update a campaign + /// Update an email campaign /// /// /// @@ -286,7 +286,7 @@ public interface IEmailCampaignsApi : IApiAccessor void UpdateEmailCampaign (long? campaignId, UpdateEmailCampaign emailCampaign); /// - /// Update a campaign + /// Update an email campaign /// /// /// @@ -296,6 +296,27 @@ public interface IEmailCampaignsApi : IApiAccessor /// Values to update a campaign /// ApiResponse of Object(void) ApiResponse UpdateEmailCampaignWithHttpInfo (long? campaignId, UpdateEmailCampaign emailCampaign); + /// + /// Upload an image to your account's image gallery + /// + /// + /// + /// + /// Thrown when fails to make API call + /// Parameters to upload an image + /// + void UploadImageToGallery (UploadImageToGallery uploadImage); + + /// + /// Upload an image to your account's image gallery + /// + /// + /// + /// + /// Thrown when fails to make API call + /// Parameters to upload an image + /// ApiResponse of Object(void) + ApiResponse UploadImageToGalleryWithHttpInfo (UploadImageToGallery uploadImage); #endregion Synchronous Operations #region Asynchronous Operations /// @@ -341,7 +362,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> DeleteEmailCampaignAsyncWithHttpInfo (long? campaignId); /// - /// Export the recipients of a campaign + /// Export the recipients of an email campaign /// /// /// @@ -353,7 +374,7 @@ public interface IEmailCampaignsApi : IApiAccessor System.Threading.Tasks.Task EmailExportRecipientsAsync (long? campaignId, EmailExportRecipients recipientExport = null); /// - /// Export the recipients of a campaign + /// Export the recipients of an email campaign /// /// /// @@ -364,7 +385,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// Task of ApiResponse (CreatedProcessId) System.Threading.Tasks.Task> EmailExportRecipientsAsyncWithHttpInfo (long? campaignId, EmailExportRecipients recipientExport = null); /// - /// 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 @@ -375,7 +396,7 @@ public interface IEmailCampaignsApi : IApiAccessor System.Threading.Tasks.Task GetAbTestCampaignResultAsync (long? campaignId); /// - /// 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 @@ -385,7 +406,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// Task of ApiResponse (AbTestCampaignResult) System.Threading.Tasks.Task> GetAbTestCampaignResultAsyncWithHttpInfo (long? campaignId); /// - /// Get campaign informations + /// Get an email campaign report /// /// /// @@ -396,7 +417,7 @@ public interface IEmailCampaignsApi : IApiAccessor System.Threading.Tasks.Task GetEmailCampaignAsync (long? campaignId); /// - /// Get campaign informations + /// Get an email campaign report /// /// /// @@ -406,7 +427,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// Task of ApiResponse (GetEmailCampaign) System.Threading.Tasks.Task> GetEmailCampaignAsyncWithHttpInfo (long? campaignId); /// - /// Return all your created campaigns + /// Return all your created email campaigns /// /// /// @@ -422,7 +443,7 @@ public interface IEmailCampaignsApi : IApiAccessor System.Threading.Tasks.Task GetEmailCampaignsAsync (string type = null, string status = null, DateTime? startDate = null, DateTime? endDate = null, long? limit = null, long? offset = null); /// - /// Return all your created campaigns + /// Return all your created email campaigns /// /// /// @@ -479,7 +500,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> SendEmailCampaignNowAsyncWithHttpInfo (long? campaignId); /// - /// Send the report of a campaigns + /// Send the report of a campaign /// /// /// A PDF will be sent to the specified email addresses @@ -491,7 +512,7 @@ public interface IEmailCampaignsApi : IApiAccessor System.Threading.Tasks.Task SendReportAsync (long? campaignId, SendReport sendReport); /// - /// Send the report of a campaigns + /// Send the report of a campaign /// /// /// A PDF will be sent to the specified email addresses @@ -525,7 +546,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> SendTestEmailAsyncWithHttpInfo (long? campaignId, SendTestEmail emailTo); /// - /// Update a campaign status + /// Update an email campaign status /// /// /// @@ -537,7 +558,7 @@ public interface IEmailCampaignsApi : IApiAccessor System.Threading.Tasks.Task UpdateCampaignStatusAsync (long? campaignId, UpdateCampaignStatus status); /// - /// Update a campaign status + /// Update an email campaign status /// /// /// @@ -548,7 +569,7 @@ public interface IEmailCampaignsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> UpdateCampaignStatusAsyncWithHttpInfo (long? campaignId, UpdateCampaignStatus status); /// - /// Update a campaign + /// Update an email campaign /// /// /// @@ -560,7 +581,7 @@ public interface IEmailCampaignsApi : IApiAccessor System.Threading.Tasks.Task UpdateEmailCampaignAsync (long? campaignId, UpdateEmailCampaign emailCampaign); /// - /// Update a campaign + /// Update an email campaign /// /// /// @@ -570,6 +591,27 @@ public interface IEmailCampaignsApi : IApiAccessor /// Values to update a campaign /// Task of ApiResponse System.Threading.Tasks.Task> UpdateEmailCampaignAsyncWithHttpInfo (long? campaignId, UpdateEmailCampaign emailCampaign); + /// + /// Upload an image to your account's image gallery + /// + /// + /// + /// + /// Thrown when fails to make API call + /// Parameters to upload an image + /// Task of void + System.Threading.Tasks.Task UploadImageToGalleryAsync (UploadImageToGallery uploadImage); + + /// + /// Upload an image to your account's image gallery + /// + /// + /// + /// + /// Thrown when fails to make API call + /// Parameters to upload an image + /// Task of ApiResponse + System.Threading.Tasks.Task> UploadImageToGalleryAsyncWithHttpInfo (UploadImageToGallery uploadImage); #endregion Asynchronous Operations } @@ -993,7 +1035,7 @@ public async System.Threading.Tasks.Task> DeleteEmailCampaig } /// - /// Export the recipients of a campaign + /// Export the recipients of an email campaign /// /// Thrown when fails to make API call /// Id of the campaign @@ -1006,7 +1048,7 @@ public CreatedProcessId EmailExportRecipients (long? campaignId, EmailExportReci } /// - /// Export the recipients of a campaign + /// Export the recipients of an email campaign /// /// Thrown when fails to make API call /// Id of the campaign @@ -1080,7 +1122,7 @@ public ApiResponse< CreatedProcessId > EmailExportRecipientsWithHttpInfo (long? } /// - /// Export the recipients of a campaign + /// Export the recipients of an email campaign /// /// Thrown when fails to make API call /// Id of the campaign @@ -1094,7 +1136,7 @@ public async System.Threading.Tasks.Task EmailExportRecipients } /// - /// Export the recipients of a campaign + /// Export the recipients of an email campaign /// /// Thrown when fails to make API call /// Id of the campaign @@ -1168,7 +1210,7 @@ public async System.Threading.Tasks.Task> EmailExp } /// - /// Get A/B test email campaign result Obtain winning version of an A/B test email campaign + /// Get an A/B test email campaign results Obtain winning version of an A/B test email campaign /// /// Thrown when fails to make API call /// Id of the A/B test campaign @@ -1180,7 +1222,7 @@ public AbTestCampaignResult GetAbTestCampaignResult (long? campaignId) } /// - /// Get A/B test email campaign result Obtain winning version of an A/B test email campaign + /// Get an A/B test email campaign results Obtain winning version of an A/B test email campaign /// /// Thrown when fails to make API call /// Id of the A/B test campaign @@ -1245,7 +1287,7 @@ public ApiResponse< AbTestCampaignResult > GetAbTestCampaignResultWithHttpInfo ( } /// - /// Get A/B test email campaign result Obtain winning version of an A/B test email campaign + /// Get an A/B test email campaign results Obtain winning version of an A/B test email campaign /// /// Thrown when fails to make API call /// Id of the A/B test campaign @@ -1258,7 +1300,7 @@ public async System.Threading.Tasks.Task GetAbTestCampaign } /// - /// Get A/B test email campaign result Obtain winning version of an A/B test email campaign + /// Get an A/B test email campaign results Obtain winning version of an A/B test email campaign /// /// Thrown when fails to make API call /// Id of the A/B test campaign @@ -1323,7 +1365,7 @@ public async System.Threading.Tasks.Task> GetA } /// - /// Get campaign informations + /// Get an email campaign report /// /// Thrown when fails to make API call /// Id of the campaign @@ -1335,7 +1377,7 @@ public GetEmailCampaign GetEmailCampaign (long? campaignId) } /// - /// Get campaign informations + /// Get an email campaign report /// /// Thrown when fails to make API call /// Id of the campaign @@ -1400,7 +1442,7 @@ public ApiResponse< GetEmailCampaign > GetEmailCampaignWithHttpInfo (long? campa } /// - /// Get campaign informations + /// Get an email campaign report /// /// Thrown when fails to make API call /// Id of the campaign @@ -1413,7 +1455,7 @@ public async System.Threading.Tasks.Task GetEmailCampaignAsync } /// - /// Get campaign informations + /// Get an email campaign report /// /// Thrown when fails to make API call /// Id of the campaign @@ -1478,7 +1520,7 @@ public async System.Threading.Tasks.Task> GetEmail } /// - /// Return all your created campaigns + /// Return all your created email campaigns /// /// Thrown when fails to make API call /// Filter on the type of the campaigns (optional) @@ -1495,7 +1537,7 @@ public GetEmailCampaigns GetEmailCampaigns (string type = null, string status = } /// - /// Return all your created campaigns + /// Return all your created email campaigns /// /// Thrown when fails to make API call /// Filter on the type of the campaigns (optional) @@ -1567,7 +1609,7 @@ public ApiResponse< GetEmailCampaigns > GetEmailCampaignsWithHttpInfo (string ty } /// - /// Return all your created campaigns + /// Return all your created email campaigns /// /// Thrown when fails to make API call /// Filter on the type of the campaigns (optional) @@ -1585,7 +1627,7 @@ public async System.Threading.Tasks.Task GetEmailCampaignsAsy } /// - /// Return all your created campaigns + /// Return all your created email campaigns /// /// Thrown when fails to make API call /// Filter on the type of the campaigns (optional) @@ -1965,7 +2007,7 @@ public async System.Threading.Tasks.Task> SendEmailCampaignN } /// - /// Send the report of a campaigns A PDF will be sent to the specified email addresses + /// Send the report of a campaign A PDF will be sent to the specified email addresses /// /// Thrown when fails to make API call /// Id of the campaign @@ -1977,7 +2019,7 @@ public void SendReport (long? campaignId, SendReport sendReport) } /// - /// Send the report of a campaigns A PDF will be sent to the specified email addresses + /// Send the report of a campaign A PDF will be sent to the specified email addresses /// /// Thrown when fails to make API call /// Id of the campaign @@ -2054,7 +2096,7 @@ public ApiResponse SendReportWithHttpInfo (long? campaignId, SendReport } /// - /// Send the report of a campaigns A PDF will be sent to the specified email addresses + /// Send the report of a campaign A PDF will be sent to the specified email addresses /// /// Thrown when fails to make API call /// Id of the campaign @@ -2067,7 +2109,7 @@ public async System.Threading.Tasks.Task SendReportAsync (long? campaignId, Send } /// - /// Send the report of a campaigns A PDF will be sent to the specified email addresses + /// Send the report of a campaign A PDF will be sent to the specified email addresses /// /// Thrown when fails to make API call /// Id of the campaign @@ -2323,7 +2365,7 @@ public async System.Threading.Tasks.Task> SendTestEmailAsync } /// - /// Update a campaign status + /// Update an email campaign status /// /// Thrown when fails to make API call /// Id of the campaign @@ -2335,7 +2377,7 @@ public void UpdateCampaignStatus (long? campaignId, UpdateCampaignStatus status) } /// - /// Update a campaign status + /// Update an email campaign status /// /// Thrown when fails to make API call /// Id of the campaign @@ -2412,7 +2454,7 @@ public ApiResponse UpdateCampaignStatusWithHttpInfo (long? campaignId, U } /// - /// Update a campaign status + /// Update an email campaign status /// /// Thrown when fails to make API call /// Id of the campaign @@ -2425,7 +2467,7 @@ public async System.Threading.Tasks.Task UpdateCampaignStatusAsync (long? campai } /// - /// Update a campaign status + /// Update an email campaign status /// /// Thrown when fails to make API call /// Id of the campaign @@ -2502,7 +2544,7 @@ public async System.Threading.Tasks.Task> UpdateCampaignStat } /// - /// Update a campaign + /// Update an email campaign /// /// Thrown when fails to make API call /// Id of the campaign @@ -2514,7 +2556,7 @@ public void UpdateEmailCampaign (long? campaignId, UpdateEmailCampaign emailCamp } /// - /// Update a campaign + /// Update an email campaign /// /// Thrown when fails to make API call /// Id of the campaign @@ -2591,7 +2633,7 @@ public ApiResponse UpdateEmailCampaignWithHttpInfo (long? campaignId, Up } /// - /// Update a campaign + /// Update an email campaign /// /// Thrown when fails to make API call /// Id of the campaign @@ -2604,7 +2646,7 @@ public async System.Threading.Tasks.Task UpdateEmailCampaignAsync (long? campaig } /// - /// Update a campaign + /// Update an email campaign /// /// Thrown when fails to make API call /// Id of the campaign @@ -2680,5 +2722,172 @@ public async System.Threading.Tasks.Task> UpdateEmailCampaig null); } + /// + /// Upload an image to your account's image gallery + /// + /// Thrown when fails to make API call + /// Parameters to upload an image + /// + public void UploadImageToGallery (UploadImageToGallery uploadImage) + { + UploadImageToGalleryWithHttpInfo(uploadImage); + } + + /// + /// Upload an image to your account's image gallery + /// + /// Thrown when fails to make API call + /// Parameters to upload an image + /// ApiResponse of Object(void) + public ApiResponse UploadImageToGalleryWithHttpInfo (UploadImageToGallery uploadImage) + { + // verify the required parameter 'uploadImage' is set + if (uploadImage == null) + throw new ApiException(400, "Missing required parameter 'uploadImage' when calling EmailCampaignsApi->UploadImageToGallery"); + + var localVarPath = "./emailCampaigns/images"; + var localVarPathParams = new Dictionary(); + var localVarQueryParams = new List>(); + var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); + var localVarFormParams = new Dictionary(); + var localVarFileParams = new Dictionary(); + Object localVarPostBody = null; + + // to determine the Content-Type header + String[] localVarHttpContentTypes = new String[] { + "application/json" + }; + String localVarHttpContentType = this.Configuration.ApiClient.SelectHeaderContentType(localVarHttpContentTypes); + + // to determine the Accept header + String[] localVarHttpHeaderAccepts = new String[] { + "application/json" + }; + String localVarHttpHeaderAccept = this.Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); + if (localVarHttpHeaderAccept != null) + localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); + + if (uploadImage != null && uploadImage.GetType() != typeof(byte[])) + { + localVarPostBody = this.Configuration.ApiClient.Serialize(uploadImage); // http body (model) parameter + } + else + { + localVarPostBody = uploadImage; // byte array + } + + // authentication (api-key) required + if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) + { + localVarHeaderParams["api-key"] = this.Configuration.GetApiKeyWithPrefix("api-key"); + } + // authentication (partner-key) required + if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("partner-key"))) + { + localVarHeaderParams["partner-key"] = this.Configuration.GetApiKeyWithPrefix("partner-key"); + } + + // make the HTTP request + IRestResponse localVarResponse = (IRestResponse) this.Configuration.ApiClient.CallApi(localVarPath, + Method.POST, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarFileParams, + localVarPathParams, localVarHttpContentType); + + int localVarStatusCode = (int) localVarResponse.StatusCode; + + if (ExceptionFactory != null) + { + Exception exception = ExceptionFactory("UploadImageToGallery", localVarResponse); + if (exception != null) throw exception; + } + + return new ApiResponse(localVarStatusCode, + localVarResponse.Headers.ToDictionary(x => x.Key, x => x.Value.ToString()), + null); + } + + /// + /// Upload an image to your account's image gallery + /// + /// Thrown when fails to make API call + /// Parameters to upload an image + /// Task of void + public async System.Threading.Tasks.Task UploadImageToGalleryAsync (UploadImageToGallery uploadImage) + { + await UploadImageToGalleryAsyncWithHttpInfo(uploadImage); + + } + + /// + /// Upload an image to your account's image gallery + /// + /// Thrown when fails to make API call + /// Parameters to upload an image + /// Task of ApiResponse + public async System.Threading.Tasks.Task> UploadImageToGalleryAsyncWithHttpInfo (UploadImageToGallery uploadImage) + { + // verify the required parameter 'uploadImage' is set + if (uploadImage == null) + throw new ApiException(400, "Missing required parameter 'uploadImage' when calling EmailCampaignsApi->UploadImageToGallery"); + + var localVarPath = "./emailCampaigns/images"; + var localVarPathParams = new Dictionary(); + var localVarQueryParams = new List>(); + var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); + var localVarFormParams = new Dictionary(); + var localVarFileParams = new Dictionary(); + Object localVarPostBody = null; + + // to determine the Content-Type header + String[] localVarHttpContentTypes = new String[] { + "application/json" + }; + String localVarHttpContentType = this.Configuration.ApiClient.SelectHeaderContentType(localVarHttpContentTypes); + + // to determine the Accept header + String[] localVarHttpHeaderAccepts = new String[] { + "application/json" + }; + String localVarHttpHeaderAccept = this.Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); + if (localVarHttpHeaderAccept != null) + localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); + + if (uploadImage != null && uploadImage.GetType() != typeof(byte[])) + { + localVarPostBody = this.Configuration.ApiClient.Serialize(uploadImage); // http body (model) parameter + } + else + { + localVarPostBody = uploadImage; // byte array + } + + // authentication (api-key) required + if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) + { + localVarHeaderParams["api-key"] = this.Configuration.GetApiKeyWithPrefix("api-key"); + } + // authentication (partner-key) required + if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("partner-key"))) + { + localVarHeaderParams["partner-key"] = this.Configuration.GetApiKeyWithPrefix("partner-key"); + } + + // make the HTTP request + IRestResponse localVarResponse = (IRestResponse) await this.Configuration.ApiClient.CallApiAsync(localVarPath, + Method.POST, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarFileParams, + localVarPathParams, localVarHttpContentType); + + int localVarStatusCode = (int) localVarResponse.StatusCode; + + if (ExceptionFactory != null) + { + Exception exception = ExceptionFactory("UploadImageToGallery", localVarResponse); + if (exception != null) throw exception; + } + + return new ApiResponse(localVarStatusCode, + localVarResponse.Headers.ToDictionary(x => x.Key, x => x.Value.ToString()), + null); + } + } } diff --git a/src/sib_api_v3_sdk/Api/FoldersApi.cs b/src/sib_api_v3_sdk/Api/FoldersApi.cs index 4e427d3..abfbd59 100644 --- a/src/sib_api_v3_sdk/Api/FoldersApi.cs +++ b/src/sib_api_v3_sdk/Api/FoldersApi.cs @@ -67,7 +67,7 @@ public interface IFoldersApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse DeleteFolderWithHttpInfo (long? folderId); /// - /// Returns folder details + /// Returns a folder's details /// /// /// @@ -78,7 +78,7 @@ public interface IFoldersApi : IApiAccessor GetFolder GetFolder (long? folderId); /// - /// Returns folder details + /// Returns a folder's details /// /// /// @@ -88,7 +88,7 @@ public interface IFoldersApi : IApiAccessor /// ApiResponse of GetFolder ApiResponse GetFolderWithHttpInfo (long? folderId); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -101,7 +101,7 @@ public interface IFoldersApi : IApiAccessor GetFolderLists GetFolderLists (long? folderId, long? limit = null, long? offset = null); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -113,7 +113,7 @@ public interface IFoldersApi : IApiAccessor /// ApiResponse of GetFolderLists ApiResponse GetFolderListsWithHttpInfo (long? folderId, long? limit = null, long? offset = null); /// - /// Get all the folders + /// Get all folders /// /// /// @@ -125,7 +125,7 @@ public interface IFoldersApi : IApiAccessor GetFolders GetFolders (long? limit, long? offset); /// - /// Get all the folders + /// Get all folders /// /// /// @@ -136,7 +136,7 @@ public interface IFoldersApi : IApiAccessor /// ApiResponse of GetFolders ApiResponse GetFoldersWithHttpInfo (long? limit, long? offset); /// - /// Update a contact folder + /// Update a folder /// /// /// @@ -148,7 +148,7 @@ public interface IFoldersApi : IApiAccessor void UpdateFolder (long? folderId, CreateUpdateFolder updateFolder); /// - /// Update a contact folder + /// Update a folder /// /// /// @@ -203,7 +203,7 @@ public interface IFoldersApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> DeleteFolderAsyncWithHttpInfo (long? folderId); /// - /// Returns folder details + /// Returns a folder's details /// /// /// @@ -214,7 +214,7 @@ public interface IFoldersApi : IApiAccessor System.Threading.Tasks.Task GetFolderAsync (long? folderId); /// - /// Returns folder details + /// Returns a folder's details /// /// /// @@ -224,7 +224,7 @@ public interface IFoldersApi : IApiAccessor /// Task of ApiResponse (GetFolder) System.Threading.Tasks.Task> GetFolderAsyncWithHttpInfo (long? folderId); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -237,7 +237,7 @@ public interface IFoldersApi : IApiAccessor System.Threading.Tasks.Task GetFolderListsAsync (long? folderId, long? limit = null, long? offset = null); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -249,7 +249,7 @@ public interface IFoldersApi : IApiAccessor /// Task of ApiResponse (GetFolderLists) System.Threading.Tasks.Task> GetFolderListsAsyncWithHttpInfo (long? folderId, long? limit = null, long? offset = null); /// - /// Get all the folders + /// Get all folders /// /// /// @@ -261,7 +261,7 @@ public interface IFoldersApi : IApiAccessor System.Threading.Tasks.Task GetFoldersAsync (long? limit, long? offset); /// - /// Get all the folders + /// Get all folders /// /// /// @@ -272,7 +272,7 @@ public interface IFoldersApi : IApiAccessor /// Task of ApiResponse (GetFolders) System.Threading.Tasks.Task> GetFoldersAsyncWithHttpInfo (long? limit, long? offset); /// - /// Update a contact folder + /// Update a folder /// /// /// @@ -284,7 +284,7 @@ public interface IFoldersApi : IApiAccessor System.Threading.Tasks.Task UpdateFolderAsync (long? folderId, CreateUpdateFolder updateFolder); /// - /// Update a contact folder + /// Update a folder /// /// /// @@ -717,7 +717,7 @@ public async System.Threading.Tasks.Task> DeleteFolderAsyncW } /// - /// Returns folder details + /// Returns a folder's details /// /// Thrown when fails to make API call /// id of the folder @@ -729,7 +729,7 @@ public GetFolder GetFolder (long? folderId) } /// - /// Returns folder details + /// Returns a folder's details /// /// Thrown when fails to make API call /// id of the folder @@ -794,7 +794,7 @@ public ApiResponse< GetFolder > GetFolderWithHttpInfo (long? folderId) } /// - /// Returns folder details + /// Returns a folder's details /// /// Thrown when fails to make API call /// id of the folder @@ -807,7 +807,7 @@ public async System.Threading.Tasks.Task GetFolderAsync (long? folder } /// - /// Returns folder details + /// Returns a folder's details /// /// Thrown when fails to make API call /// id of the folder @@ -872,7 +872,7 @@ public async System.Threading.Tasks.Task> GetFolderAsyncW } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -886,7 +886,7 @@ public GetFolderLists GetFolderLists (long? folderId, long? limit = null, long? } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -955,7 +955,7 @@ public ApiResponse< GetFolderLists > GetFolderListsWithHttpInfo (long? folderId, } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -970,7 +970,7 @@ public async System.Threading.Tasks.Task GetFolderListsAsync (lo } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -1039,7 +1039,7 @@ public async System.Threading.Tasks.Task> GetFolderL } /// - /// Get all the folders + /// Get all folders /// /// Thrown when fails to make API call /// Number of documents per page @@ -1052,7 +1052,7 @@ public GetFolders GetFolders (long? limit, long? offset) } /// - /// Get all the folders + /// Get all folders /// /// Thrown when fails to make API call /// Number of documents per page @@ -1122,7 +1122,7 @@ public ApiResponse< GetFolders > GetFoldersWithHttpInfo (long? limit, long? offs } /// - /// Get all the folders + /// Get all folders /// /// Thrown when fails to make API call /// Number of documents per page @@ -1136,7 +1136,7 @@ public async System.Threading.Tasks.Task GetFoldersAsync (long? limi } /// - /// Get all the folders + /// Get all folders /// /// Thrown when fails to make API call /// Number of documents per page @@ -1206,7 +1206,7 @@ public async System.Threading.Tasks.Task> GetFoldersAsyn } /// - /// Update a contact folder + /// Update a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -1218,7 +1218,7 @@ public void UpdateFolder (long? folderId, CreateUpdateFolder updateFolder) } /// - /// Update a contact folder + /// Update a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -1295,7 +1295,7 @@ public ApiResponse UpdateFolderWithHttpInfo (long? folderId, CreateUpdat } /// - /// Update a contact folder + /// Update a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -1308,7 +1308,7 @@ public async System.Threading.Tasks.Task UpdateFolderAsync (long? folderId, Crea } /// - /// Update a contact folder + /// Update a folder /// /// Thrown when fails to make API call /// Id of the folder diff --git a/src/sib_api_v3_sdk/Api/ListsApi.cs b/src/sib_api_v3_sdk/Api/ListsApi.cs index 20ac291..61baaac 100644 --- a/src/sib_api_v3_sdk/Api/ListsApi.cs +++ b/src/sib_api_v3_sdk/Api/ListsApi.cs @@ -90,7 +90,7 @@ public interface IListsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse DeleteListWithHttpInfo (long? listId); /// - /// Get the contacts in a list + /// Get contacts in a list /// /// /// @@ -104,7 +104,7 @@ public interface IListsApi : IApiAccessor GetContacts GetContactsFromList (long? listId, DateTime? modifiedSince = null, long? limit = null, long? offset = null); /// - /// Get the contacts in a list + /// Get contacts in a list /// /// /// @@ -117,7 +117,7 @@ public interface IListsApi : IApiAccessor /// ApiResponse of GetContacts ApiResponse GetContactsFromListWithHttpInfo (long? listId, DateTime? modifiedSince = null, long? limit = null, long? offset = null); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -130,7 +130,7 @@ public interface IListsApi : IApiAccessor GetFolderLists GetFolderLists (long? folderId, long? limit = null, long? offset = null); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -142,7 +142,7 @@ public interface IListsApi : IApiAccessor /// ApiResponse of GetFolderLists ApiResponse GetFolderListsWithHttpInfo (long? folderId, long? limit = null, long? offset = null); /// - /// Get the details of a list + /// Get a list's details /// /// /// @@ -153,7 +153,7 @@ public interface IListsApi : IApiAccessor GetExtendedList GetList (long? listId); /// - /// Get the details of a list + /// Get a list's details /// /// /// @@ -186,7 +186,7 @@ public interface IListsApi : IApiAccessor /// ApiResponse of GetLists ApiResponse GetListsWithHttpInfo (long? limit = null, long? offset = null); /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// /// @@ -198,7 +198,7 @@ public interface IListsApi : IApiAccessor PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromList contactEmails); /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// /// @@ -299,7 +299,7 @@ public interface IListsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> DeleteListAsyncWithHttpInfo (long? listId); /// - /// Get the contacts in a list + /// Get contacts in a list /// /// /// @@ -313,7 +313,7 @@ public interface IListsApi : IApiAccessor System.Threading.Tasks.Task GetContactsFromListAsync (long? listId, DateTime? modifiedSince = null, long? limit = null, long? offset = null); /// - /// Get the contacts in a list + /// Get contacts in a list /// /// /// @@ -326,7 +326,7 @@ public interface IListsApi : IApiAccessor /// Task of ApiResponse (GetContacts) System.Threading.Tasks.Task> GetContactsFromListAsyncWithHttpInfo (long? listId, DateTime? modifiedSince = null, long? limit = null, long? offset = null); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -339,7 +339,7 @@ public interface IListsApi : IApiAccessor System.Threading.Tasks.Task GetFolderListsAsync (long? folderId, long? limit = null, long? offset = null); /// - /// Get the lists in a folder + /// Get lists in a folder /// /// /// @@ -351,7 +351,7 @@ public interface IListsApi : IApiAccessor /// Task of ApiResponse (GetFolderLists) System.Threading.Tasks.Task> GetFolderListsAsyncWithHttpInfo (long? folderId, long? limit = null, long? offset = null); /// - /// Get the details of a list + /// Get a list's details /// /// /// @@ -362,7 +362,7 @@ public interface IListsApi : IApiAccessor System.Threading.Tasks.Task GetListAsync (long? listId); /// - /// Get the details of a list + /// Get a list's details /// /// /// @@ -395,7 +395,7 @@ public interface IListsApi : IApiAccessor /// Task of ApiResponse (GetLists) System.Threading.Tasks.Task> GetListsAsyncWithHttpInfo (long? limit = null, long? offset = null); /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// /// @@ -407,7 +407,7 @@ public interface IListsApi : IApiAccessor System.Threading.Tasks.Task RemoveContactFromListAsync (long? listId, RemoveContactFromList contactEmails); /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// /// @@ -1044,7 +1044,7 @@ public async System.Threading.Tasks.Task> DeleteListAsyncWit } /// - /// Get the contacts in a list + /// Get contacts in a list /// /// Thrown when fails to make API call /// Id of the list @@ -1059,7 +1059,7 @@ public GetContacts GetContactsFromList (long? listId, DateTime? modifiedSince = } /// - /// Get the contacts in a list + /// Get contacts in a list /// /// Thrown when fails to make API call /// Id of the list @@ -1130,7 +1130,7 @@ public ApiResponse< GetContacts > GetContactsFromListWithHttpInfo (long? listId, } /// - /// Get the contacts in a list + /// Get contacts in a list /// /// Thrown when fails to make API call /// Id of the list @@ -1146,7 +1146,7 @@ public async System.Threading.Tasks.Task GetContactsFromListAsync ( } /// - /// Get the contacts in a list + /// Get contacts in a list /// /// Thrown when fails to make API call /// Id of the list @@ -1217,7 +1217,7 @@ public async System.Threading.Tasks.Task> GetContactsFr } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -1231,7 +1231,7 @@ public GetFolderLists GetFolderLists (long? folderId, long? limit = null, long? } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -1300,7 +1300,7 @@ public ApiResponse< GetFolderLists > GetFolderListsWithHttpInfo (long? folderId, } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -1315,7 +1315,7 @@ public async System.Threading.Tasks.Task GetFolderListsAsync (lo } /// - /// Get the lists in a folder + /// Get lists in a folder /// /// Thrown when fails to make API call /// Id of the folder @@ -1384,7 +1384,7 @@ public async System.Threading.Tasks.Task> GetFolderL } /// - /// Get the details of a list + /// Get a list's details /// /// Thrown when fails to make API call /// Id of the list @@ -1396,7 +1396,7 @@ public GetExtendedList GetList (long? listId) } /// - /// Get the details of a list + /// Get a list's details /// /// Thrown when fails to make API call /// Id of the list @@ -1461,7 +1461,7 @@ public ApiResponse< GetExtendedList > GetListWithHttpInfo (long? listId) } /// - /// Get the details of a list + /// Get a list's details /// /// Thrown when fails to make API call /// Id of the list @@ -1474,7 +1474,7 @@ public async System.Threading.Tasks.Task GetListAsync (long? li } /// - /// Get the details of a list + /// Get a list's details /// /// Thrown when fails to make API call /// Id of the list @@ -1694,7 +1694,7 @@ public async System.Threading.Tasks.Task> GetListsAsyncWit } /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// Thrown when fails to make API call /// Id of the list @@ -1707,7 +1707,7 @@ public PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromLis } /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// Thrown when fails to make API call /// Id of the list @@ -1784,7 +1784,7 @@ public ApiResponse< PostContactInfo > RemoveContactFromListWithHttpInfo (long? l } /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// Thrown when fails to make API call /// Id of the list @@ -1798,7 +1798,7 @@ public async System.Threading.Tasks.Task RemoveContactFromListA } /// - /// Remove existing contacts from a list + /// Delete a contact from a list /// /// Thrown when fails to make API call /// Id of the list diff --git a/src/sib_api_v3_sdk/Api/ResellerApi.cs b/src/sib_api_v3_sdk/Api/ResellerApi.cs index 3595030..af49778 100644 --- a/src/sib_api_v3_sdk/Api/ResellerApi.cs +++ b/src/sib_api_v3_sdk/Api/ResellerApi.cs @@ -71,7 +71,7 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse AssociateIpToChildWithHttpInfo (string childAuthKey, ManageIp ip); /// - /// Creates a domain for a child account + /// Create a domain for a child account /// /// /// @@ -83,7 +83,7 @@ public interface IResellerApi : IApiAccessor void CreateChildDomain (string childAuthKey, AddChildDomain addChildDomain); /// - /// Creates a domain for a child account + /// Create a domain for a child account /// /// /// @@ -115,7 +115,7 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of CreateReseller ApiResponse CreateResellerChildWithHttpInfo (CreateChild resellerChild = null); /// - /// 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 /// /// /// @@ -127,7 +127,7 @@ public interface IResellerApi : IApiAccessor void DeleteChildDomain (string childAuthKey, string domainName); /// - /// 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 /// /// /// @@ -138,7 +138,7 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse DeleteChildDomainWithHttpInfo (string childAuthKey, string domainName); /// - /// Deletes a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the childAuthKey supplied /// /// /// @@ -149,7 +149,7 @@ public interface IResellerApi : IApiAccessor void DeleteResellerChild (string childAuthKey); /// - /// Deletes a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the childAuthKey supplied /// /// /// @@ -182,7 +182,7 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse DissociateIpFromChildWithHttpInfo (string childAuthKey, ManageIp ip); /// - /// 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 /// /// /// @@ -193,7 +193,7 @@ public interface IResellerApi : IApiAccessor GetChildAccountCreationStatus GetChildAccountCreationStatus (string childAuthKey); /// - /// 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 /// /// /// @@ -203,7 +203,7 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of GetChildAccountCreationStatus ApiResponse GetChildAccountCreationStatusWithHttpInfo (string childAuthKey); /// - /// Gets all the sender domains of a specific child account + /// Get all sender domains for a specific child account /// /// /// @@ -214,7 +214,7 @@ public interface IResellerApi : IApiAccessor GetChildDomains GetChildDomains (string childAuthKey); /// - /// Gets all the sender domains of a specific child account + /// Get all sender domains for a specific child account /// /// /// @@ -224,7 +224,7 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of GetChildDomains ApiResponse GetChildDomainsWithHttpInfo (string childAuthKey); /// - /// Gets the info about a specific child account + /// Get a child account's details /// /// /// @@ -235,7 +235,7 @@ public interface IResellerApi : IApiAccessor GetChildInfo GetChildInfo (string childAuthKey); /// - /// Gets the info about a specific child account + /// Get a child account's details /// /// /// @@ -245,7 +245,7 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of GetChildInfo ApiResponse GetChildInfoWithHttpInfo (string childAuthKey); /// - /// Gets the list of all reseller's children accounts + /// Get the list of all children accounts /// /// /// @@ -257,7 +257,7 @@ public interface IResellerApi : IApiAccessor GetChildrenList GetResellerChilds (long? limit = null, long? offset = null); /// - /// Gets the list of all reseller's children accounts + /// Get the list of all children accounts /// /// /// @@ -312,7 +312,7 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of RemainingCreditModel ApiResponse RemoveCreditsWithHttpInfo (string childAuthKey, RemoveCredits removeCredits); /// - /// 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 /// /// /// @@ -324,7 +324,7 @@ public interface IResellerApi : IApiAccessor void UpdateChildAccountStatus (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus); /// - /// 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 /// /// /// @@ -335,7 +335,7 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse UpdateChildAccountStatusWithHttpInfo (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus); /// - /// 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 /// /// /// @@ -348,7 +348,7 @@ public interface IResellerApi : IApiAccessor void UpdateChildDomain (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain); /// - /// 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 /// /// /// @@ -360,7 +360,7 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse UpdateChildDomainWithHttpInfo (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain); /// - /// Updates infos of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the childAuthKey supplied /// /// /// @@ -372,7 +372,7 @@ public interface IResellerApi : IApiAccessor void UpdateResellerChild (string childAuthKey, UpdateChild resellerChild); /// - /// Updates infos of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the childAuthKey supplied /// /// /// @@ -431,7 +431,7 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> AssociateIpToChildAsyncWithHttpInfo (string childAuthKey, ManageIp ip); /// - /// Creates a domain for a child account + /// Create a domain for a child account /// /// /// @@ -443,7 +443,7 @@ public interface IResellerApi : IApiAccessor System.Threading.Tasks.Task CreateChildDomainAsync (string childAuthKey, AddChildDomain addChildDomain); /// - /// Creates a domain for a child account + /// Create a domain for a child account /// /// /// @@ -475,7 +475,7 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse (CreateReseller) System.Threading.Tasks.Task> CreateResellerChildAsyncWithHttpInfo (CreateChild resellerChild = null); /// - /// 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 /// /// /// @@ -487,7 +487,7 @@ public interface IResellerApi : IApiAccessor System.Threading.Tasks.Task DeleteChildDomainAsync (string childAuthKey, string domainName); /// - /// 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 /// /// /// @@ -498,7 +498,7 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> DeleteChildDomainAsyncWithHttpInfo (string childAuthKey, string domainName); /// - /// Deletes a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the childAuthKey supplied /// /// /// @@ -509,7 +509,7 @@ public interface IResellerApi : IApiAccessor System.Threading.Tasks.Task DeleteResellerChildAsync (string childAuthKey); /// - /// Deletes a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the childAuthKey supplied /// /// /// @@ -542,7 +542,7 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> DissociateIpFromChildAsyncWithHttpInfo (string childAuthKey, ManageIp ip); /// - /// 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 /// /// /// @@ -553,7 +553,7 @@ public interface IResellerApi : IApiAccessor System.Threading.Tasks.Task GetChildAccountCreationStatusAsync (string childAuthKey); /// - /// 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 /// /// /// @@ -563,7 +563,7 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse (GetChildAccountCreationStatus) System.Threading.Tasks.Task> GetChildAccountCreationStatusAsyncWithHttpInfo (string childAuthKey); /// - /// Gets all the sender domains of a specific child account + /// Get all sender domains for a specific child account /// /// /// @@ -574,7 +574,7 @@ public interface IResellerApi : IApiAccessor System.Threading.Tasks.Task GetChildDomainsAsync (string childAuthKey); /// - /// Gets all the sender domains of a specific child account + /// Get all sender domains for a specific child account /// /// /// @@ -584,7 +584,7 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse (GetChildDomains) System.Threading.Tasks.Task> GetChildDomainsAsyncWithHttpInfo (string childAuthKey); /// - /// Gets the info about a specific child account + /// Get a child account's details /// /// /// @@ -595,7 +595,7 @@ public interface IResellerApi : IApiAccessor System.Threading.Tasks.Task GetChildInfoAsync (string childAuthKey); /// - /// Gets the info about a specific child account + /// Get a child account's details /// /// /// @@ -605,7 +605,7 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse (GetChildInfo) System.Threading.Tasks.Task> GetChildInfoAsyncWithHttpInfo (string childAuthKey); /// - /// Gets the list of all reseller's children accounts + /// Get the list of all children accounts /// /// /// @@ -617,7 +617,7 @@ public interface IResellerApi : IApiAccessor System.Threading.Tasks.Task GetResellerChildsAsync (long? limit = null, long? offset = null); /// - /// Gets the list of all reseller's children accounts + /// Get the list of all children accounts /// /// /// @@ -672,7 +672,7 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse (RemainingCreditModel) System.Threading.Tasks.Task> RemoveCreditsAsyncWithHttpInfo (string childAuthKey, RemoveCredits removeCredits); /// - /// 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 /// /// /// @@ -684,7 +684,7 @@ public interface IResellerApi : IApiAccessor System.Threading.Tasks.Task UpdateChildAccountStatusAsync (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus); /// - /// 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 /// /// /// @@ -695,7 +695,7 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> UpdateChildAccountStatusAsyncWithHttpInfo (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus); /// - /// 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 /// /// /// @@ -708,7 +708,7 @@ public interface IResellerApi : IApiAccessor System.Threading.Tasks.Task UpdateChildDomainAsync (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain); /// - /// 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 /// /// /// @@ -720,7 +720,7 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> UpdateChildDomainAsyncWithHttpInfo (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain); /// - /// Updates infos of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the childAuthKey supplied /// /// /// @@ -732,7 +732,7 @@ public interface IResellerApi : IApiAccessor System.Threading.Tasks.Task UpdateResellerChildAsync (string childAuthKey, UpdateChild resellerChild); /// - /// Updates infos of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the childAuthKey supplied /// /// /// @@ -1203,7 +1203,7 @@ public async System.Threading.Tasks.Task> AssociateIpToChild } /// - /// Creates a domain for a child account + /// Create a domain for a child account /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1215,7 +1215,7 @@ public void CreateChildDomain (string childAuthKey, AddChildDomain addChildDomai } /// - /// Creates a domain for a child account + /// Create a domain for a child account /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1292,7 +1292,7 @@ public ApiResponse CreateChildDomainWithHttpInfo (string childAuthKey, A } /// - /// Creates a domain for a child account + /// Create a domain for a child account /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1305,7 +1305,7 @@ public async System.Threading.Tasks.Task CreateChildDomainAsync (string childAut } /// - /// Creates a domain for a child account + /// Create a domain for a child account /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1545,7 +1545,7 @@ public async System.Threading.Tasks.Task> CreateRese } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1557,7 +1557,7 @@ public void DeleteChildDomain (string childAuthKey, string domainName) } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1627,7 +1627,7 @@ public ApiResponse DeleteChildDomainWithHttpInfo (string childAuthKey, s } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1640,7 +1640,7 @@ public async System.Threading.Tasks.Task DeleteChildDomainAsync (string childAut } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1710,7 +1710,7 @@ public async System.Threading.Tasks.Task> DeleteChildDomainA } /// - /// Deletes a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the childAuthKey supplied /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1721,7 +1721,7 @@ public void DeleteResellerChild (string childAuthKey) } /// - /// Deletes a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the childAuthKey supplied /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1786,7 +1786,7 @@ public ApiResponse DeleteResellerChildWithHttpInfo (string childAuthKey) } /// - /// Deletes a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the childAuthKey supplied /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -1798,7 +1798,7 @@ public async System.Threading.Tasks.Task DeleteResellerChildAsync (string childA } /// - /// Deletes a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the childAuthKey supplied /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2042,7 +2042,7 @@ public async System.Threading.Tasks.Task> DissociateIpFromCh } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2054,7 +2054,7 @@ public GetChildAccountCreationStatus GetChildAccountCreationStatus (string child } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2119,7 +2119,7 @@ public ApiResponse< GetChildAccountCreationStatus > GetChildAccountCreationStatu } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2132,7 +2132,7 @@ public async System.Threading.Tasks.Task GetChild } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2197,7 +2197,7 @@ public async System.Threading.Tasks.Task - /// Gets all the sender domains of a specific child account + /// Get all sender domains for a specific child account /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2209,7 +2209,7 @@ public GetChildDomains GetChildDomains (string childAuthKey) } /// - /// Gets all the sender domains of a specific child account + /// Get all sender domains for a specific child account /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2274,7 +2274,7 @@ public ApiResponse< GetChildDomains > GetChildDomainsWithHttpInfo (string childA } /// - /// Gets all the sender domains of a specific child account + /// Get all sender domains for a specific child account /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2287,7 +2287,7 @@ public async System.Threading.Tasks.Task GetChildDomainsAsync ( } /// - /// Gets all the sender domains of a specific child account + /// Get all sender domains for a specific child account /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2352,7 +2352,7 @@ public async System.Threading.Tasks.Task> GetChildD } /// - /// Gets the info about a specific child account + /// Get a child account's details /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2364,7 +2364,7 @@ public GetChildInfo GetChildInfo (string childAuthKey) } /// - /// Gets the info about a specific child account + /// Get a child account's details /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2429,7 +2429,7 @@ public ApiResponse< GetChildInfo > GetChildInfoWithHttpInfo (string childAuthKey } /// - /// Gets the info about a specific child account + /// Get a child account's details /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2442,7 +2442,7 @@ public async System.Threading.Tasks.Task GetChildInfoAsync (string } /// - /// Gets the info about a specific child account + /// Get a child account's details /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -2507,7 +2507,7 @@ public async System.Threading.Tasks.Task> GetChildInfo } /// - /// Gets the list of all reseller's children accounts + /// Get the list of all children accounts /// /// Thrown when fails to make API call /// Number of documents for child accounts information per page (optional, default to 10) @@ -2520,7 +2520,7 @@ public GetChildrenList GetResellerChilds (long? limit = null, long? offset = nul } /// - /// Gets the list of all reseller's children accounts + /// Get the list of all children accounts /// /// Thrown when fails to make API call /// Number of documents for child accounts information per page (optional, default to 10) @@ -2584,7 +2584,7 @@ public ApiResponse< GetChildrenList > GetResellerChildsWithHttpInfo (long? limit } /// - /// Gets the list of all reseller's children accounts + /// Get the list of all children accounts /// /// Thrown when fails to make API call /// Number of documents for child accounts information per page (optional, default to 10) @@ -2598,7 +2598,7 @@ public async System.Threading.Tasks.Task GetResellerChildsAsync } /// - /// Gets the list of all reseller's children accounts + /// Get the list of all children accounts /// /// Thrown when fails to make API call /// Number of documents for child accounts information per page (optional, default to 10) @@ -2998,7 +2998,7 @@ public async System.Threading.Tasks.Task> Remo } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3010,7 +3010,7 @@ public void UpdateChildAccountStatus (string childAuthKey, UpdateChildAccountSta } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3087,7 +3087,7 @@ public ApiResponse UpdateChildAccountStatusWithHttpInfo (string childAut } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3100,7 +3100,7 @@ public async System.Threading.Tasks.Task UpdateChildAccountStatusAsync (string c } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3177,7 +3177,7 @@ public async System.Threading.Tasks.Task> UpdateChildAccount } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3190,7 +3190,7 @@ public void UpdateChildDomain (string childAuthKey, string domainName, UpdateChi } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3272,7 +3272,7 @@ public ApiResponse UpdateChildDomainWithHttpInfo (string childAuthKey, s } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3286,7 +3286,7 @@ public async System.Threading.Tasks.Task UpdateChildDomainAsync (string childAut } /// - /// 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 /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3368,7 +3368,7 @@ public async System.Threading.Tasks.Task> UpdateChildDomainA } /// - /// Updates infos of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the childAuthKey supplied /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3380,7 +3380,7 @@ public void UpdateResellerChild (string childAuthKey, UpdateChild resellerChild) } /// - /// Updates infos of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the childAuthKey supplied /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3457,7 +3457,7 @@ public ApiResponse UpdateResellerChildWithHttpInfo (string childAuthKey, } /// - /// Updates infos of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the childAuthKey supplied /// /// Thrown when fails to make API call /// auth key of reseller's child @@ -3470,7 +3470,7 @@ public async System.Threading.Tasks.Task UpdateResellerChildAsync (string childA } /// - /// Updates infos of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the childAuthKey supplied /// /// Thrown when fails to make API call /// auth key of reseller's child diff --git a/src/sib_api_v3_sdk/Api/SMSCampaignsApi.cs b/src/sib_api_v3_sdk/Api/SMSCampaignsApi.cs index 4e7fa92..2c69fd2 100644 --- a/src/sib_api_v3_sdk/Api/SMSCampaignsApi.cs +++ b/src/sib_api_v3_sdk/Api/SMSCampaignsApi.cs @@ -46,7 +46,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// ApiResponse of CreateModel ApiResponse CreateSmsCampaignWithHttpInfo (CreateSmsCampaign createSmsCampaign); /// - /// Delete the SMS campaign + /// Delete an SMS campaign /// /// /// @@ -57,7 +57,7 @@ public interface ISMSCampaignsApi : IApiAccessor void DeleteSmsCampaign (long? campaignId); /// - /// Delete the SMS campaign + /// Delete an SMS campaign /// /// /// @@ -88,7 +88,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// ApiResponse of GetSmsCampaign ApiResponse GetSmsCampaignWithHttpInfo (long? campaignId); /// - /// Returns the informations for all your created SMS campaigns + /// Returns the information for all your created SMS campaigns /// /// /// @@ -103,7 +103,7 @@ public interface ISMSCampaignsApi : IApiAccessor GetSmsCampaigns GetSmsCampaigns (string status = null, DateTime? startDate = null, DateTime? endDate = null, long? limit = null, long? offset = null); /// - /// Returns the informations for all your created SMS campaigns + /// Returns the information for all your created SMS campaigns /// /// /// @@ -117,7 +117,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// ApiResponse of GetSmsCampaigns ApiResponse GetSmsCampaignsWithHttpInfo (string status = null, DateTime? startDate = null, DateTime? endDate = null, long? limit = null, long? offset = null); /// - /// 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. @@ -129,7 +129,7 @@ public interface ISMSCampaignsApi : IApiAccessor CreatedProcessId RequestSmsRecipientExport (long? campaignId, RequestSmsRecipientExport recipientExport = null); /// - /// 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. @@ -161,7 +161,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse SendSmsCampaignNowWithHttpInfo (long? campaignId); /// - /// 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. @@ -173,7 +173,7 @@ public interface ISMSCampaignsApi : IApiAccessor void SendSmsReport (long? campaignId, SendReport sendReport); /// - /// 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. @@ -184,7 +184,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse SendSmsReportWithHttpInfo (long? campaignId, SendReport sendReport); /// - /// Send an SMS + /// Send a test SMS campaign /// /// /// @@ -196,7 +196,7 @@ public interface ISMSCampaignsApi : IApiAccessor void SendTestSms (long? campaignId, SendTestSms phoneNumber); /// - /// Send an SMS + /// Send a test SMS campaign /// /// /// @@ -207,7 +207,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse SendTestSmsWithHttpInfo (long? campaignId, SendTestSms phoneNumber); /// - /// Updates an SMS campaign + /// Update an SMS campaign /// /// /// @@ -219,7 +219,7 @@ public interface ISMSCampaignsApi : IApiAccessor void UpdateSmsCampaign (long? campaignId, UpdateSmsCampaign updateSmsCampaign); /// - /// Updates an SMS campaign + /// Update an SMS campaign /// /// /// @@ -230,7 +230,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse UpdateSmsCampaignWithHttpInfo (long? campaignId, UpdateSmsCampaign updateSmsCampaign); /// - /// Update the campaign status + /// Update a campaign's status /// /// /// @@ -242,7 +242,7 @@ public interface ISMSCampaignsApi : IApiAccessor void UpdateSmsCampaignStatus (long? campaignId, UpdateCampaignStatus status); /// - /// Update the campaign status + /// Update a campaign's status /// /// /// @@ -276,7 +276,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// Task of ApiResponse (CreateModel) System.Threading.Tasks.Task> CreateSmsCampaignAsyncWithHttpInfo (CreateSmsCampaign createSmsCampaign); /// - /// Delete the SMS campaign + /// Delete an SMS campaign /// /// /// @@ -287,7 +287,7 @@ public interface ISMSCampaignsApi : IApiAccessor System.Threading.Tasks.Task DeleteSmsCampaignAsync (long? campaignId); /// - /// Delete the SMS campaign + /// Delete an SMS campaign /// /// /// @@ -318,7 +318,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// Task of ApiResponse (GetSmsCampaign) System.Threading.Tasks.Task> GetSmsCampaignAsyncWithHttpInfo (long? campaignId); /// - /// Returns the informations for all your created SMS campaigns + /// Returns the information for all your created SMS campaigns /// /// /// @@ -333,7 +333,7 @@ public interface ISMSCampaignsApi : IApiAccessor System.Threading.Tasks.Task GetSmsCampaignsAsync (string status = null, DateTime? startDate = null, DateTime? endDate = null, long? limit = null, long? offset = null); /// - /// Returns the informations for all your created SMS campaigns + /// Returns the information for all your created SMS campaigns /// /// /// @@ -347,7 +347,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// Task of ApiResponse (GetSmsCampaigns) System.Threading.Tasks.Task> GetSmsCampaignsAsyncWithHttpInfo (string status = null, DateTime? startDate = null, DateTime? endDate = null, long? limit = null, long? offset = null); /// - /// 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. @@ -359,7 +359,7 @@ public interface ISMSCampaignsApi : IApiAccessor System.Threading.Tasks.Task RequestSmsRecipientExportAsync (long? campaignId, RequestSmsRecipientExport recipientExport = null); /// - /// 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. @@ -391,7 +391,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> SendSmsCampaignNowAsyncWithHttpInfo (long? campaignId); /// - /// 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. @@ -403,7 +403,7 @@ public interface ISMSCampaignsApi : IApiAccessor System.Threading.Tasks.Task SendSmsReportAsync (long? campaignId, SendReport sendReport); /// - /// 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. @@ -414,7 +414,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> SendSmsReportAsyncWithHttpInfo (long? campaignId, SendReport sendReport); /// - /// Send an SMS + /// Send a test SMS campaign /// /// /// @@ -426,7 +426,7 @@ public interface ISMSCampaignsApi : IApiAccessor System.Threading.Tasks.Task SendTestSmsAsync (long? campaignId, SendTestSms phoneNumber); /// - /// Send an SMS + /// Send a test SMS campaign /// /// /// @@ -437,7 +437,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> SendTestSmsAsyncWithHttpInfo (long? campaignId, SendTestSms phoneNumber); /// - /// Updates an SMS campaign + /// Update an SMS campaign /// /// /// @@ -449,7 +449,7 @@ public interface ISMSCampaignsApi : IApiAccessor System.Threading.Tasks.Task UpdateSmsCampaignAsync (long? campaignId, UpdateSmsCampaign updateSmsCampaign); /// - /// Updates an SMS campaign + /// Update an SMS campaign /// /// /// @@ -460,7 +460,7 @@ public interface ISMSCampaignsApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> UpdateSmsCampaignAsyncWithHttpInfo (long? campaignId, UpdateSmsCampaign updateSmsCampaign); /// - /// Update the campaign status + /// Update a campaign's status /// /// /// @@ -472,7 +472,7 @@ public interface ISMSCampaignsApi : IApiAccessor System.Threading.Tasks.Task UpdateSmsCampaignStatusAsync (long? campaignId, UpdateCampaignStatus status); /// - /// Update the campaign status + /// Update a campaign's status /// /// /// @@ -752,7 +752,7 @@ public async System.Threading.Tasks.Task> CreateSmsCamp } /// - /// Delete the SMS campaign + /// Delete an SMS campaign /// /// Thrown when fails to make API call /// id of the SMS campaign @@ -763,7 +763,7 @@ public void DeleteSmsCampaign (long? campaignId) } /// - /// Delete the SMS campaign + /// Delete an SMS campaign /// /// Thrown when fails to make API call /// id of the SMS campaign @@ -828,7 +828,7 @@ public ApiResponse DeleteSmsCampaignWithHttpInfo (long? campaignId) } /// - /// Delete the SMS campaign + /// Delete an SMS campaign /// /// Thrown when fails to make API call /// id of the SMS campaign @@ -840,7 +840,7 @@ public async System.Threading.Tasks.Task DeleteSmsCampaignAsync (long? campaignI } /// - /// Delete the SMS campaign + /// Delete an SMS campaign /// /// Thrown when fails to make API call /// id of the SMS campaign @@ -1060,7 +1060,7 @@ public async System.Threading.Tasks.Task> GetSmsCamp } /// - /// Returns the informations for all your created SMS campaigns + /// Returns the information for all your created SMS campaigns /// /// Thrown when fails to make API call /// Status of campaign. (optional) @@ -1076,7 +1076,7 @@ public GetSmsCampaigns GetSmsCampaigns (string status = null, DateTime? startDat } /// - /// Returns the informations for all your created SMS campaigns + /// Returns the information for all your created SMS campaigns /// /// Thrown when fails to make API call /// Status of campaign. (optional) @@ -1146,7 +1146,7 @@ public ApiResponse< GetSmsCampaigns > GetSmsCampaignsWithHttpInfo (string status } /// - /// Returns the informations for all your created SMS campaigns + /// Returns the information for all your created SMS campaigns /// /// Thrown when fails to make API call /// Status of campaign. (optional) @@ -1163,7 +1163,7 @@ public async System.Threading.Tasks.Task GetSmsCampaignsAsync ( } /// - /// Returns the informations for all your created SMS campaigns + /// Returns the information for all your created SMS campaigns /// /// Thrown when fails to make API call /// Status of campaign. (optional) @@ -1233,7 +1233,7 @@ public async System.Threading.Tasks.Task> GetSmsCam } /// - /// Exports the recipients of the specified campaign. It returns the background process ID which on completion calls the notify URL that you have set in the input. + /// 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. /// /// Thrown when fails to make API call /// id of the campaign @@ -1246,7 +1246,7 @@ public CreatedProcessId RequestSmsRecipientExport (long? campaignId, RequestSmsR } /// - /// Exports the recipients of the specified campaign. It returns the background process ID which on completion calls the notify URL that you have set in the input. + /// 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. /// /// Thrown when fails to make API call /// id of the campaign @@ -1320,7 +1320,7 @@ public ApiResponse< CreatedProcessId > RequestSmsRecipientExportWithHttpInfo (lo } /// - /// Exports the recipients of the specified campaign. It returns the background process ID which on completion calls the notify URL that you have set in the input. + /// 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. /// /// Thrown when fails to make API call /// id of the campaign @@ -1334,7 +1334,7 @@ public async System.Threading.Tasks.Task RequestSmsRecipientEx } /// - /// Exports the recipients of the specified campaign. It returns the background process ID which on completion calls the notify URL that you have set in the input. + /// 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. /// /// Thrown when fails to make API call /// id of the campaign @@ -1561,7 +1561,7 @@ public async System.Threading.Tasks.Task> SendSmsCampaignNow } /// - /// Send report of SMS campaigns Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. + /// 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. /// /// Thrown when fails to make API call /// id of the campaign @@ -1573,7 +1573,7 @@ public void SendSmsReport (long? campaignId, SendReport sendReport) } /// - /// Send report of SMS campaigns Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. + /// 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. /// /// Thrown when fails to make API call /// id of the campaign @@ -1650,7 +1650,7 @@ public ApiResponse SendSmsReportWithHttpInfo (long? campaignId, SendRepo } /// - /// Send report of SMS campaigns Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. + /// 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. /// /// Thrown when fails to make API call /// id of the campaign @@ -1663,7 +1663,7 @@ public async System.Threading.Tasks.Task SendSmsReportAsync (long? campaignId, S } /// - /// Send report of SMS campaigns Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. + /// 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. /// /// Thrown when fails to make API call /// id of the campaign @@ -1740,7 +1740,7 @@ public async System.Threading.Tasks.Task> SendSmsReportAsync } /// - /// Send an SMS + /// Send a test SMS campaign /// /// Thrown when fails to make API call /// Id of the SMS campaign @@ -1752,7 +1752,7 @@ public void SendTestSms (long? campaignId, SendTestSms phoneNumber) } /// - /// Send an SMS + /// Send a test SMS campaign /// /// Thrown when fails to make API call /// Id of the SMS campaign @@ -1829,7 +1829,7 @@ public ApiResponse SendTestSmsWithHttpInfo (long? campaignId, SendTestSm } /// - /// Send an SMS + /// Send a test SMS campaign /// /// Thrown when fails to make API call /// Id of the SMS campaign @@ -1842,7 +1842,7 @@ public async System.Threading.Tasks.Task SendTestSmsAsync (long? campaignId, Sen } /// - /// Send an SMS + /// Send a test SMS campaign /// /// Thrown when fails to make API call /// Id of the SMS campaign @@ -1919,7 +1919,7 @@ public async System.Threading.Tasks.Task> SendTestSmsAsyncWi } /// - /// Updates an SMS campaign + /// Update an SMS campaign /// /// Thrown when fails to make API call /// id of the SMS campaign @@ -1931,7 +1931,7 @@ public void UpdateSmsCampaign (long? campaignId, UpdateSmsCampaign updateSmsCamp } /// - /// Updates an SMS campaign + /// Update an SMS campaign /// /// Thrown when fails to make API call /// id of the SMS campaign @@ -2008,7 +2008,7 @@ public ApiResponse UpdateSmsCampaignWithHttpInfo (long? campaignId, Upda } /// - /// Updates an SMS campaign + /// Update an SMS campaign /// /// Thrown when fails to make API call /// id of the SMS campaign @@ -2021,7 +2021,7 @@ public async System.Threading.Tasks.Task UpdateSmsCampaignAsync (long? campaignI } /// - /// Updates an SMS campaign + /// Update an SMS campaign /// /// Thrown when fails to make API call /// id of the SMS campaign @@ -2098,7 +2098,7 @@ public async System.Threading.Tasks.Task> UpdateSmsCampaignA } /// - /// Update the campaign status + /// Update a campaign's status /// /// Thrown when fails to make API call /// id of the campaign @@ -2110,7 +2110,7 @@ public void UpdateSmsCampaignStatus (long? campaignId, UpdateCampaignStatus stat } /// - /// Update the campaign status + /// Update a campaign's status /// /// Thrown when fails to make API call /// id of the campaign @@ -2187,7 +2187,7 @@ public ApiResponse UpdateSmsCampaignStatusWithHttpInfo (long? campaignId } /// - /// Update the campaign status + /// Update a campaign's status /// /// Thrown when fails to make API call /// id of the campaign @@ -2200,7 +2200,7 @@ public async System.Threading.Tasks.Task UpdateSmsCampaignStatusAsync (long? cam } /// - /// Update the campaign status + /// Update a campaign's status /// /// Thrown when fails to make API call /// id of the campaign diff --git a/src/sib_api_v3_sdk/Api/SMTPApi.cs b/src/sib_api_v3_sdk/Api/SMTPApi.cs index be2e70b..e4deff7 100644 --- a/src/sib_api_v3_sdk/Api/SMTPApi.cs +++ b/src/sib_api_v3_sdk/Api/SMTPApi.cs @@ -25,7 +25,7 @@ public interface ISMTPApi : IApiAccessor { #region Synchronous Operations /// - /// Create a transactional email template + /// Create an email template /// /// /// @@ -36,7 +36,7 @@ public interface ISMTPApi : IApiAccessor CreateModel CreateSmtpTemplate (CreateSmtpTemplate smtpTemplate); /// - /// Create a transactional email template + /// Create an email template /// /// /// @@ -67,7 +67,7 @@ public interface ISMTPApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse DeleteHardbouncesWithHttpInfo (DeleteHardbounces deleteHardbounces = null); /// - /// Delete an inactive transactional email template + /// Delete an inactive email template /// /// /// @@ -78,7 +78,7 @@ public interface ISMTPApi : IApiAccessor void DeleteSmtpTemplate (long? templateId); /// - /// Delete an inactive transactional email template + /// Delete an inactive email template /// /// /// @@ -185,7 +185,7 @@ public interface ISMTPApi : IApiAccessor /// ApiResponse of GetReports ApiResponse GetSmtpReportWithHttpInfo (long? limit = null, long? offset = null, string startDate = null, string endDate = null, int? days = null, string tag = null); /// - /// Returns the template informations + /// Returns the template information /// /// /// @@ -196,7 +196,7 @@ public interface ISMTPApi : IApiAccessor GetSmtpTemplateOverview GetSmtpTemplate (long? templateId); /// - /// Returns the template informations + /// Returns the template information /// /// /// @@ -206,7 +206,7 @@ public interface ISMTPApi : IApiAccessor /// ApiResponse of GetSmtpTemplateOverview ApiResponse GetSmtpTemplateWithHttpInfo (long? templateId); /// - /// Get the list of transactional email templates + /// Get the list of email templates /// /// /// @@ -219,7 +219,7 @@ public interface ISMTPApi : IApiAccessor GetSmtpTemplates GetSmtpTemplates (bool? templateStatus = null, long? limit = null, long? offset = null); /// - /// Get the list of transactional email templates + /// Get the list of email templates /// /// /// @@ -293,7 +293,7 @@ public interface ISMTPApi : IApiAccessor /// 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) /// 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) /// GetTransacEmailsList - GetTransacEmailsList GetTransacEmailsList (string email = null, long? templateId = null, string messageId = null, string startDate = null, DateTime? endDate = null); + GetTransacEmailsList GetTransacEmailsList (string email = null, long? templateId = null, string messageId = null, DateTime? startDate = null, DateTime? endDate = null); /// /// Get the list of transactional emails on the basis of allowed filters @@ -308,7 +308,7 @@ public interface ISMTPApi : IApiAccessor /// 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) /// 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) /// ApiResponse of GetTransacEmailsList - ApiResponse GetTransacEmailsListWithHttpInfo (string email = null, long? templateId = null, string messageId = null, string startDate = null, DateTime? endDate = null); + ApiResponse GetTransacEmailsListWithHttpInfo (string email = null, long? templateId = null, string messageId = null, DateTime? startDate = null, DateTime? endDate = null); /// /// Send a template /// @@ -419,7 +419,7 @@ public interface ISMTPApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse SmtpLogMessageIdDeleteWithHttpInfo (string messageId); /// - /// Updates a transactional email templates + /// Update an email template /// /// /// @@ -431,7 +431,7 @@ public interface ISMTPApi : IApiAccessor void UpdateSmtpTemplate (long? templateId, UpdateSmtpTemplate smtpTemplate); /// - /// Updates a transactional email templates + /// Update an email template /// /// /// @@ -444,7 +444,7 @@ public interface ISMTPApi : IApiAccessor #endregion Synchronous Operations #region Asynchronous Operations /// - /// Create a transactional email template + /// Create an email template /// /// /// @@ -455,7 +455,7 @@ public interface ISMTPApi : IApiAccessor System.Threading.Tasks.Task CreateSmtpTemplateAsync (CreateSmtpTemplate smtpTemplate); /// - /// Create a transactional email template + /// Create an email template /// /// /// @@ -486,7 +486,7 @@ public interface ISMTPApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> DeleteHardbouncesAsyncWithHttpInfo (DeleteHardbounces deleteHardbounces = null); /// - /// Delete an inactive transactional email template + /// Delete an inactive email template /// /// /// @@ -497,7 +497,7 @@ public interface ISMTPApi : IApiAccessor System.Threading.Tasks.Task DeleteSmtpTemplateAsync (long? templateId); /// - /// Delete an inactive transactional email template + /// Delete an inactive email template /// /// /// @@ -604,7 +604,7 @@ public interface ISMTPApi : IApiAccessor /// Task of ApiResponse (GetReports) System.Threading.Tasks.Task> GetSmtpReportAsyncWithHttpInfo (long? limit = null, long? offset = null, string startDate = null, string endDate = null, int? days = null, string tag = null); /// - /// Returns the template informations + /// Returns the template information /// /// /// @@ -615,7 +615,7 @@ public interface ISMTPApi : IApiAccessor System.Threading.Tasks.Task GetSmtpTemplateAsync (long? templateId); /// - /// Returns the template informations + /// Returns the template information /// /// /// @@ -625,7 +625,7 @@ public interface ISMTPApi : IApiAccessor /// Task of ApiResponse (GetSmtpTemplateOverview) System.Threading.Tasks.Task> GetSmtpTemplateAsyncWithHttpInfo (long? templateId); /// - /// Get the list of transactional email templates + /// Get the list of email templates /// /// /// @@ -638,7 +638,7 @@ public interface ISMTPApi : IApiAccessor System.Threading.Tasks.Task GetSmtpTemplatesAsync (bool? templateStatus = null, long? limit = null, long? offset = null); /// - /// Get the list of transactional email templates + /// Get the list of email templates /// /// /// @@ -712,7 +712,7 @@ public interface ISMTPApi : IApiAccessor /// 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) /// 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) /// Task of GetTransacEmailsList - System.Threading.Tasks.Task GetTransacEmailsListAsync (string email = null, long? templateId = null, string messageId = null, string startDate = null, DateTime? endDate = null); + System.Threading.Tasks.Task GetTransacEmailsListAsync (string email = null, long? templateId = null, string messageId = null, DateTime? startDate = null, DateTime? endDate = null); /// /// Get the list of transactional emails on the basis of allowed filters @@ -727,7 +727,7 @@ public interface ISMTPApi : IApiAccessor /// 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) /// 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) /// Task of ApiResponse (GetTransacEmailsList) - System.Threading.Tasks.Task> GetTransacEmailsListAsyncWithHttpInfo (string email = null, long? templateId = null, string messageId = null, string startDate = null, DateTime? endDate = null); + System.Threading.Tasks.Task> GetTransacEmailsListAsyncWithHttpInfo (string email = null, long? templateId = null, string messageId = null, DateTime? startDate = null, DateTime? endDate = null); /// /// Send a template /// @@ -838,7 +838,7 @@ public interface ISMTPApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> SmtpLogMessageIdDeleteAsyncWithHttpInfo (string messageId); /// - /// Updates a transactional email templates + /// Update an email template /// /// /// @@ -850,7 +850,7 @@ public interface ISMTPApi : IApiAccessor System.Threading.Tasks.Task UpdateSmtpTemplateAsync (long? templateId, UpdateSmtpTemplate smtpTemplate); /// - /// Updates a transactional email templates + /// Update an email template /// /// /// @@ -961,7 +961,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// Create a transactional email template + /// Create an email template /// /// Thrown when fails to make API call /// values to update in transactional email template @@ -973,7 +973,7 @@ public CreateModel CreateSmtpTemplate (CreateSmtpTemplate smtpTemplate) } /// - /// Create a transactional email template + /// Create an email template /// /// Thrown when fails to make API call /// values to update in transactional email template @@ -1045,7 +1045,7 @@ public ApiResponse< CreateModel > CreateSmtpTemplateWithHttpInfo (CreateSmtpTemp } /// - /// Create a transactional email template + /// Create an email template /// /// Thrown when fails to make API call /// values to update in transactional email template @@ -1058,7 +1058,7 @@ public async System.Threading.Tasks.Task CreateSmtpTemplateAsync (C } /// - /// Create a transactional email template + /// Create an email template /// /// Thrown when fails to make API call /// values to update in transactional email template @@ -1291,7 +1291,7 @@ public async System.Threading.Tasks.Task> DeleteHardbouncesA } /// - /// Delete an inactive transactional email template + /// Delete an inactive email template /// /// Thrown when fails to make API call /// id of the template @@ -1302,7 +1302,7 @@ public void DeleteSmtpTemplate (long? templateId) } /// - /// Delete an inactive transactional email template + /// Delete an inactive email template /// /// Thrown when fails to make API call /// id of the template @@ -1367,7 +1367,7 @@ public ApiResponse DeleteSmtpTemplateWithHttpInfo (long? templateId) } /// - /// Delete an inactive transactional email template + /// Delete an inactive email template /// /// Thrown when fails to make API call /// id of the template @@ -1379,7 +1379,7 @@ public async System.Threading.Tasks.Task DeleteSmtpTemplateAsync (long? template } /// - /// Delete an inactive transactional email template + /// Delete an inactive email template /// /// Thrown when fails to make API call /// id of the template @@ -1993,7 +1993,7 @@ public async System.Threading.Tasks.Task> GetSmtpReportA } /// - /// Returns the template informations + /// Returns the template information /// /// Thrown when fails to make API call /// id of the template @@ -2005,7 +2005,7 @@ public GetSmtpTemplateOverview GetSmtpTemplate (long? templateId) } /// - /// Returns the template informations + /// Returns the template information /// /// Thrown when fails to make API call /// id of the template @@ -2070,7 +2070,7 @@ public ApiResponse< GetSmtpTemplateOverview > GetSmtpTemplateWithHttpInfo (long? } /// - /// Returns the template informations + /// Returns the template information /// /// Thrown when fails to make API call /// id of the template @@ -2083,7 +2083,7 @@ public async System.Threading.Tasks.Task GetSmtpTemplat } /// - /// Returns the template informations + /// Returns the template information /// /// Thrown when fails to make API call /// id of the template @@ -2148,7 +2148,7 @@ public async System.Threading.Tasks.Task> G } /// - /// Get the list of transactional email templates + /// Get the list of email templates /// /// Thrown when fails to make API call /// Filter on the status of the template. Active = true, inactive = false (optional) @@ -2162,7 +2162,7 @@ public GetSmtpTemplates GetSmtpTemplates (bool? templateStatus = null, long? lim } /// - /// Get the list of transactional email templates + /// Get the list of email templates /// /// Thrown when fails to make API call /// Filter on the status of the template. Active = true, inactive = false (optional) @@ -2228,7 +2228,7 @@ public ApiResponse< GetSmtpTemplates > GetSmtpTemplatesWithHttpInfo (bool? templ } /// - /// Get the list of transactional email templates + /// Get the list of email templates /// /// Thrown when fails to make API call /// Filter on the status of the template. Active = true, inactive = false (optional) @@ -2243,7 +2243,7 @@ public async System.Threading.Tasks.Task GetSmtpTemplatesAsync } /// - /// Get the list of transactional email templates + /// Get the list of email templates /// /// Thrown when fails to make API call /// Filter on the status of the template. Active = true, inactive = false (optional) @@ -2646,7 +2646,7 @@ public async System.Threading.Tasks.Task> Ge /// 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) /// 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) /// GetTransacEmailsList - public GetTransacEmailsList GetTransacEmailsList (string email = null, long? templateId = null, string messageId = null, string startDate = null, DateTime? endDate = null) + public GetTransacEmailsList GetTransacEmailsList (string email = null, long? templateId = null, string messageId = null, DateTime? startDate = null, DateTime? endDate = null) { ApiResponse localVarResponse = GetTransacEmailsListWithHttpInfo(email, templateId, messageId, startDate, endDate); return localVarResponse.Data; @@ -2662,7 +2662,7 @@ public GetTransacEmailsList GetTransacEmailsList (string email = null, long? tem /// 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) /// 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) /// ApiResponse of GetTransacEmailsList - public ApiResponse< GetTransacEmailsList > GetTransacEmailsListWithHttpInfo (string email = null, long? templateId = null, string messageId = null, string startDate = null, DateTime? endDate = null) + public ApiResponse< GetTransacEmailsList > GetTransacEmailsListWithHttpInfo (string email = null, long? templateId = null, string messageId = null, DateTime? startDate = null, DateTime? endDate = null) { var localVarPath = "./smtp/emails"; @@ -2732,7 +2732,7 @@ public ApiResponse< GetTransacEmailsList > GetTransacEmailsListWithHttpInfo (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) /// 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) /// Task of GetTransacEmailsList - public async System.Threading.Tasks.Task GetTransacEmailsListAsync (string email = null, long? templateId = null, string messageId = null, string startDate = null, DateTime? endDate = null) + public async System.Threading.Tasks.Task GetTransacEmailsListAsync (string email = null, long? templateId = null, string messageId = null, DateTime? startDate = null, DateTime? endDate = null) { ApiResponse localVarResponse = await GetTransacEmailsListAsyncWithHttpInfo(email, templateId, messageId, startDate, endDate); return localVarResponse.Data; @@ -2749,7 +2749,7 @@ public async System.Threading.Tasks.Task GetTransacEmailsL /// 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) /// 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) /// Task of ApiResponse (GetTransacEmailsList) - public async System.Threading.Tasks.Task> GetTransacEmailsListAsyncWithHttpInfo (string email = null, long? templateId = null, string messageId = null, string startDate = null, DateTime? endDate = null) + public async System.Threading.Tasks.Task> GetTransacEmailsListAsyncWithHttpInfo (string email = null, long? templateId = null, string messageId = null, DateTime? startDate = null, DateTime? endDate = null) { var localVarPath = "./smtp/emails"; @@ -3645,7 +3645,7 @@ public async System.Threading.Tasks.Task> SmtpLogMessageIdDe } /// - /// Updates a transactional email templates + /// Update an email template /// /// Thrown when fails to make API call /// id of the template @@ -3657,7 +3657,7 @@ public void UpdateSmtpTemplate (long? templateId, UpdateSmtpTemplate smtpTemplat } /// - /// Updates a transactional email templates + /// Update an email template /// /// Thrown when fails to make API call /// id of the template @@ -3734,7 +3734,7 @@ public ApiResponse UpdateSmtpTemplateWithHttpInfo (long? templateId, Upd } /// - /// Updates a transactional email templates + /// Update an email template /// /// Thrown when fails to make API call /// id of the template @@ -3747,7 +3747,7 @@ public async System.Threading.Tasks.Task UpdateSmtpTemplateAsync (long? template } /// - /// Updates a transactional email templates + /// Update an email template /// /// Thrown when fails to make API call /// id of the template diff --git a/src/sib_api_v3_sdk/Api/SendersApi.cs b/src/sib_api_v3_sdk/Api/SendersApi.cs index a3ec6cb..70479e9 100644 --- a/src/sib_api_v3_sdk/Api/SendersApi.cs +++ b/src/sib_api_v3_sdk/Api/SendersApi.cs @@ -67,7 +67,7 @@ public interface ISendersApi : IApiAccessor /// ApiResponse of Object(void) ApiResponse DeleteSenderWithHttpInfo (long? senderId); /// - /// Return all the dedicated IPs for your account + /// Get all the dedicated IPs for your account /// /// /// @@ -77,7 +77,7 @@ public interface ISendersApi : IApiAccessor GetIps GetIps (); /// - /// Return all the dedicated IPs for your account + /// Get all the dedicated IPs for your account /// /// /// @@ -86,7 +86,7 @@ public interface ISendersApi : IApiAccessor /// ApiResponse of GetIps ApiResponse GetIpsWithHttpInfo (); /// - /// Return all the dedicated IPs for a sender + /// Get all the dedicated IPs for a sender /// /// /// @@ -97,7 +97,7 @@ public interface ISendersApi : IApiAccessor GetIpsFromSender GetIpsFromSender (long? senderId); /// - /// Return all the dedicated IPs for a sender + /// Get all the dedicated IPs for a sender /// /// /// @@ -197,7 +197,7 @@ public interface ISendersApi : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> DeleteSenderAsyncWithHttpInfo (long? senderId); /// - /// Return all the dedicated IPs for your account + /// Get all the dedicated IPs for your account /// /// /// @@ -207,7 +207,7 @@ public interface ISendersApi : IApiAccessor System.Threading.Tasks.Task GetIpsAsync (); /// - /// Return all the dedicated IPs for your account + /// Get all the dedicated IPs for your account /// /// /// @@ -216,7 +216,7 @@ public interface ISendersApi : IApiAccessor /// Task of ApiResponse (GetIps) System.Threading.Tasks.Task> GetIpsAsyncWithHttpInfo (); /// - /// Return all the dedicated IPs for a sender + /// Get all the dedicated IPs for a sender /// /// /// @@ -227,7 +227,7 @@ public interface ISendersApi : IApiAccessor System.Threading.Tasks.Task GetIpsFromSenderAsync (long? senderId); /// - /// Return all the dedicated IPs for a sender + /// Get all the dedicated IPs for a sender /// /// /// @@ -699,7 +699,7 @@ public async System.Threading.Tasks.Task> DeleteSenderAsyncW } /// - /// Return all the dedicated IPs for your account + /// Get all the dedicated IPs for your account /// /// Thrown when fails to make API call /// GetIps @@ -710,7 +710,7 @@ public GetIps GetIps () } /// - /// Return all the dedicated IPs for your account + /// Get all the dedicated IPs for your account /// /// Thrown when fails to make API call /// ApiResponse of GetIps @@ -770,7 +770,7 @@ public ApiResponse< GetIps > GetIpsWithHttpInfo () } /// - /// Return all the dedicated IPs for your account + /// Get all the dedicated IPs for your account /// /// Thrown when fails to make API call /// Task of GetIps @@ -782,7 +782,7 @@ public async System.Threading.Tasks.Task GetIpsAsync () } /// - /// Return all the dedicated IPs for your account + /// Get all the dedicated IPs for your account /// /// Thrown when fails to make API call /// Task of ApiResponse (GetIps) @@ -842,7 +842,7 @@ public async System.Threading.Tasks.Task> GetIpsAsyncWithHtt } /// - /// Return all the dedicated IPs for a sender + /// Get all the dedicated IPs for a sender /// /// Thrown when fails to make API call /// Id of the sender @@ -854,7 +854,7 @@ public GetIpsFromSender GetIpsFromSender (long? senderId) } /// - /// Return all the dedicated IPs for a sender + /// Get all the dedicated IPs for a sender /// /// Thrown when fails to make API call /// Id of the sender @@ -919,7 +919,7 @@ public ApiResponse< GetIpsFromSender > GetIpsFromSenderWithHttpInfo (long? sende } /// - /// Return all the dedicated IPs for a sender + /// Get all the dedicated IPs for a sender /// /// Thrown when fails to make API call /// Id of the sender @@ -932,7 +932,7 @@ public async System.Threading.Tasks.Task GetIpsFromSenderAsync } /// - /// Return all the dedicated IPs for a sender + /// Get all the dedicated IPs for a sender /// /// Thrown when fails to make API call /// Id of the sender diff --git a/src/sib_api_v3_sdk/Api/TransactionalSMSApi.cs b/src/sib_api_v3_sdk/Api/TransactionalSMSApi.cs index edca261..87251f4 100644 --- a/src/sib_api_v3_sdk/Api/TransactionalSMSApi.cs +++ b/src/sib_api_v3_sdk/Api/TransactionalSMSApi.cs @@ -25,7 +25,7 @@ public interface ITransactionalSMSApi : IApiAccessor { #region Synchronous Operations /// - /// Get all the SMS activity (unaggregated events) + /// Get all your SMS activity (unaggregated events) /// /// /// @@ -43,7 +43,7 @@ public interface ITransactionalSMSApi : IApiAccessor GetSmsEventReport GetSmsEvents (long? limit = null, string startDate = null, string endDate = null, long? offset = null, int? days = null, string phoneNumber = null, string _event = null, string tags = null); /// - /// Get all the SMS activity (unaggregated events) + /// Get all your SMS activity (unaggregated events) /// /// /// @@ -114,7 +114,7 @@ public interface ITransactionalSMSApi : IApiAccessor /// ApiResponse of GetTransacSmsReport ApiResponse GetTransacSmsReportWithHttpInfo (string startDate = null, string endDate = null, int? days = null, string tag = null); /// - /// Send the SMS campaign to the specified mobile number + /// Send the SMS campaign to a mobile number /// /// /// @@ -125,7 +125,7 @@ public interface ITransactionalSMSApi : IApiAccessor SendSms SendTransacSms (SendTransacSms sendTransacSms); /// - /// Send the SMS campaign to the specified mobile number + /// Send the SMS campaign to a mobile number /// /// /// @@ -137,7 +137,7 @@ public interface ITransactionalSMSApi : IApiAccessor #endregion Synchronous Operations #region Asynchronous Operations /// - /// Get all the SMS activity (unaggregated events) + /// Get all your SMS activity (unaggregated events) /// /// /// @@ -155,7 +155,7 @@ public interface ITransactionalSMSApi : IApiAccessor System.Threading.Tasks.Task GetSmsEventsAsync (long? limit = null, string startDate = null, string endDate = null, long? offset = null, int? days = null, string phoneNumber = null, string _event = null, string tags = null); /// - /// Get all the SMS activity (unaggregated events) + /// Get all your SMS activity (unaggregated events) /// /// /// @@ -226,7 +226,7 @@ public interface ITransactionalSMSApi : IApiAccessor /// Task of ApiResponse (GetTransacSmsReport) System.Threading.Tasks.Task> GetTransacSmsReportAsyncWithHttpInfo (string startDate = null, string endDate = null, int? days = null, string tag = null); /// - /// Send the SMS campaign to the specified mobile number + /// Send the SMS campaign to a mobile number /// /// /// @@ -237,7 +237,7 @@ public interface ITransactionalSMSApi : IApiAccessor System.Threading.Tasks.Task SendTransacSmsAsync (SendTransacSms sendTransacSms); /// - /// Send the SMS campaign to the specified mobile number + /// Send the SMS campaign to a mobile number /// /// /// @@ -347,7 +347,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// Get all the SMS activity (unaggregated events) + /// Get all your SMS activity (unaggregated events) /// /// Thrown when fails to make API call /// Number of documents per page (optional, default to 50) @@ -366,7 +366,7 @@ public GetSmsEventReport GetSmsEvents (long? limit = null, string startDate = nu } /// - /// Get all the SMS activity (unaggregated events) + /// Get all your SMS activity (unaggregated events) /// /// Thrown when fails to make API call /// Number of documents per page (optional, default to 50) @@ -442,7 +442,7 @@ public ApiResponse< GetSmsEventReport > GetSmsEventsWithHttpInfo (long? limit = } /// - /// Get all the SMS activity (unaggregated events) + /// Get all your SMS activity (unaggregated events) /// /// Thrown when fails to make API call /// Number of documents per page (optional, default to 50) @@ -462,7 +462,7 @@ public async System.Threading.Tasks.Task GetSmsEventsAsync (l } /// - /// Get all the SMS activity (unaggregated events) + /// Get all your SMS activity (unaggregated events) /// /// Thrown when fails to make API call /// Number of documents per page (optional, default to 50) @@ -872,7 +872,7 @@ public async System.Threading.Tasks.Task> GetTr } /// - /// Send the SMS campaign to the specified mobile number + /// Send the SMS campaign to a mobile number /// /// Thrown when fails to make API call /// Values to send a transactional SMS @@ -884,7 +884,7 @@ public SendSms SendTransacSms (SendTransacSms sendTransacSms) } /// - /// Send the SMS campaign to the specified mobile number + /// Send the SMS campaign to a mobile number /// /// Thrown when fails to make API call /// Values to send a transactional SMS @@ -956,7 +956,7 @@ public ApiResponse< SendSms > SendTransacSmsWithHttpInfo (SendTransacSms sendTra } /// - /// Send the SMS campaign to the specified mobile number + /// Send the SMS campaign to a mobile number /// /// Thrown when fails to make API call /// Values to send a transactional SMS @@ -969,7 +969,7 @@ public async System.Threading.Tasks.Task SendTransacSmsAsync (SendTrans } /// - /// Send the SMS campaign to the specified mobile number + /// Send the SMS campaign to a mobile number /// /// Thrown when fails to make API call /// Values to send a transactional SMS diff --git a/src/sib_api_v3_sdk/Client/ApiClient.cs b/src/sib_api_v3_sdk/Client/ApiClient.cs index fe37f1a..9278710 100644 --- a/src/sib_api_v3_sdk/Client/ApiClient.cs +++ b/src/sib_api_v3_sdk/Client/ApiClient.cs @@ -269,6 +269,8 @@ public string ParameterToString(object obj) } return flattenedString.ToString(); } + else if (obj is bool) + return ((bool)obj).ToString().ToLower(); else return Convert.ToString (obj); } diff --git a/src/sib_api_v3_sdk/Client/Configuration.cs b/src/sib_api_v3_sdk/Client/Configuration.cs index 679db84..5de47e0 100644 --- a/src/sib_api_v3_sdk/Client/Configuration.cs +++ b/src/sib_api_v3_sdk/Client/Configuration.cs @@ -29,7 +29,7 @@ public class Configuration : IReadableConfiguration /// Version of the package. /// /// Version of the package. - public const string Version = "2.1.0"; + public const string Version = "2.1.1"; /// /// Identifier for ISO 8601 DateTime Format @@ -110,7 +110,7 @@ static Configuration() /// public Configuration() { - UserAgent = "Swagger-Codegen/2.1.0/csharp"; + UserAgent = "Swagger-Codegen/2.1.1/csharp"; BasePath = "https://api.sendinblue.com/v3"; DefaultHeader = new ConcurrentDictionary(); ApiKey = new ConcurrentDictionary(); @@ -183,7 +183,7 @@ public Configuration( string tempFolderPath = null, string dateTimeFormat = null, int timeout = 100000, - string userAgent = "Swagger-Codegen/2.1.0/csharp" + string userAgent = "Swagger-Codegen/2.1.1/csharp" // ReSharper restore UnusedParameter.Local ) { @@ -416,7 +416,7 @@ public static String ToDebugReport() String report = "C# SDK (sib_api_v3_sdk) Debug Report:\n"; report += " OS: " + System.Runtime.InteropServices.RuntimeInformation.OSDescription + "\n"; report += " Version of the API: 3.0.0\n"; - report += " SDK Package Version: 2.1.0\n"; + report += " SDK Package Version: 2.1.1\n"; return report; } diff --git a/src/sib_api_v3_sdk/Model/AddContactToList.cs b/src/sib_api_v3_sdk/Model/AddContactToList.cs index ddfabac..910ede6 100644 --- a/src/sib_api_v3_sdk/Model/AddContactToList.cs +++ b/src/sib_api_v3_sdk/Model/AddContactToList.cs @@ -31,16 +31,16 @@ public partial class AddContactToList : IEquatable /// /// Initializes a new instance of the class. /// - /// Emails to add to a list. + /// 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.. public AddContactToList(List emails = default(List)) { this.Emails = emails; } /// - /// Emails to add to a list + /// 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. /// - /// Emails to add to a list + /// 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. [DataMember(Name="emails", EmitDefaultValue=false)] public List Emails { get; set; } diff --git a/src/sib_api_v3_sdk/Model/CreateAttribute.cs b/src/sib_api_v3_sdk/Model/CreateAttribute.cs index a88f836..92dd40b 100644 --- a/src/sib_api_v3_sdk/Model/CreateAttribute.cs +++ b/src/sib_api_v3_sdk/Model/CreateAttribute.cs @@ -83,7 +83,7 @@ public enum TypeEnum /// Initializes a new instance of the class. /// /// Value of the attribute. Use only if the attribute's category is 'calculated' or 'global'. - /// 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'}]. + /// 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"}]. /// 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 ). public CreateAttribute(string value = default(string), List enumeration = default(List), TypeEnum? type = default(TypeEnum?)) { @@ -100,9 +100,9 @@ public enum TypeEnum public string Value { get; set; } /// - /// 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'}] + /// 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"}] /// - /// 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'}] + /// 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"}] [DataMember(Name="enumeration", EmitDefaultValue=false)] public List Enumeration { get; set; } diff --git a/src/sib_api_v3_sdk/Model/CreateContact.cs b/src/sib_api_v3_sdk/Model/CreateContact.cs index cdd9815..994bd27 100644 --- a/src/sib_api_v3_sdk/Model/CreateContact.cs +++ b/src/sib_api_v3_sdk/Model/CreateContact.cs @@ -31,8 +31,8 @@ public partial class CreateContact : IEquatable /// /// Initializes a new instance of the class. /// - /// Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. For example {'SMS':'+91xxxxxxxxxx'}. - /// Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}. + /// 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"}. + /// Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {"FNAME":"Elly", "LNAME":"Roger"}. /// Set this field to blacklist the contact for emails (emailBlacklisted = true). /// Set this field to blacklist the contact for SMS (smsBlacklisted = true). /// Ids of the lists to add the contact to. @@ -58,16 +58,16 @@ public partial class CreateContact : IEquatable } /// - /// Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. For example {'SMS':'+91xxxxxxxxxx'} + /// 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"} /// - /// Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. For example {'SMS':'+91xxxxxxxxxx'} + /// 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"} [DataMember(Name="email", EmitDefaultValue=false)] public string Email { get; set; } /// - /// Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} + /// Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {"FNAME":"Elly", "LNAME":"Roger"} /// - /// Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} + /// Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {"FNAME":"Elly", "LNAME":"Roger"} [DataMember(Name="attributes", EmitDefaultValue=false)] public Object Attributes { get; set; } diff --git a/src/sib_api_v3_sdk/Model/CreateDoiContact.cs b/src/sib_api_v3_sdk/Model/CreateDoiContact.cs new file mode 100644 index 0000000..507b7d6 --- /dev/null +++ b/src/sib_api_v3_sdk/Model/CreateDoiContact.cs @@ -0,0 +1,227 @@ +/* + * 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 | + * + * OpenAPI spec version: 3.0.0 + * Contact: contact@sendinblue.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using SwaggerDateConverter = sib_api_v3_sdk.Client.SwaggerDateConverter; + +namespace sib_api_v3_sdk.Model +{ + /// + /// CreateDoiContact + /// + [DataContract] + public partial class CreateDoiContact : IEquatable + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected CreateDoiContact() { } + /// + /// Initializes a new instance of the class. + /// + /// Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. (required). + /// Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}. + /// Lists under user account where contact should be added (required). + /// Lists under user account where contact should not be added. + /// Id of the DOI template (required). + /// URL of the web page that user will be redirected to after clicking on the double opt in URL.. + public CreateDoiContact(string email = default(string), Object attributes = default(Object), List includeListIds = default(List), List excludeListIds = default(List), long? templateId = default(long?), string redirectionUrl = default(string)) + { + // to ensure "email" is required (not null) + if (email == null) + { + throw new InvalidDataException("email is a required property for CreateDoiContact and cannot be null"); + } + else + { + this.Email = email; + } + // to ensure "includeListIds" is required (not null) + if (includeListIds == null) + { + throw new InvalidDataException("includeListIds is a required property for CreateDoiContact and cannot be null"); + } + else + { + this.IncludeListIds = includeListIds; + } + // to ensure "templateId" is required (not null) + if (templateId == null) + { + throw new InvalidDataException("templateId is a required property for CreateDoiContact and cannot be null"); + } + else + { + this.TemplateId = templateId; + } + this.Attributes = attributes; + this.ExcludeListIds = excludeListIds; + this.RedirectionUrl = redirectionUrl; + } + + /// + /// Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. + /// + /// Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. + [DataMember(Name="email", EmitDefaultValue=false)] + public string Email { get; set; } + + /// + /// Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} + /// + /// Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} + [DataMember(Name="attributes", EmitDefaultValue=false)] + public Object Attributes { get; set; } + + /// + /// Lists under user account where contact should be added + /// + /// Lists under user account where contact should be added + [DataMember(Name="includeListIds", EmitDefaultValue=false)] + public List IncludeListIds { get; set; } + + /// + /// Lists under user account where contact should not be added + /// + /// Lists under user account where contact should not be added + [DataMember(Name="excludeListIds", EmitDefaultValue=false)] + public List ExcludeListIds { get; set; } + + /// + /// Id of the DOI template + /// + /// Id of the DOI template + [DataMember(Name="templateId", EmitDefaultValue=false)] + public long? TemplateId { get; set; } + + /// + /// URL of the web page that user will be redirected to after clicking on the double opt in URL. + /// + /// URL of the web page that user will be redirected to after clicking on the double opt in URL. + [DataMember(Name="redirectionUrl", EmitDefaultValue=false)] + public string RedirectionUrl { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CreateDoiContact {\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Attributes: ").Append(Attributes).Append("\n"); + sb.Append(" IncludeListIds: ").Append(IncludeListIds).Append("\n"); + sb.Append(" ExcludeListIds: ").Append(ExcludeListIds).Append("\n"); + sb.Append(" TemplateId: ").Append(TemplateId).Append("\n"); + sb.Append(" RedirectionUrl: ").Append(RedirectionUrl).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as CreateDoiContact); + } + + /// + /// Returns true if CreateDoiContact instances are equal + /// + /// Instance of CreateDoiContact to be compared + /// Boolean + public bool Equals(CreateDoiContact input) + { + if (input == null) + return false; + + return + ( + this.Email == input.Email || + (this.Email != null && + this.Email.Equals(input.Email)) + ) && + ( + this.Attributes == input.Attributes || + (this.Attributes != null && + this.Attributes.Equals(input.Attributes)) + ) && + ( + this.IncludeListIds == input.IncludeListIds || + this.IncludeListIds != null && + this.IncludeListIds.SequenceEqual(input.IncludeListIds) + ) && + ( + this.ExcludeListIds == input.ExcludeListIds || + this.ExcludeListIds != null && + this.ExcludeListIds.SequenceEqual(input.ExcludeListIds) + ) && + ( + this.TemplateId == input.TemplateId || + (this.TemplateId != null && + this.TemplateId.Equals(input.TemplateId)) + ) && + ( + this.RedirectionUrl == input.RedirectionUrl || + (this.RedirectionUrl != null && + this.RedirectionUrl.Equals(input.RedirectionUrl)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Email != null) + hashCode = hashCode * 59 + this.Email.GetHashCode(); + if (this.Attributes != null) + hashCode = hashCode * 59 + this.Attributes.GetHashCode(); + if (this.IncludeListIds != null) + hashCode = hashCode * 59 + this.IncludeListIds.GetHashCode(); + if (this.ExcludeListIds != null) + hashCode = hashCode * 59 + this.ExcludeListIds.GetHashCode(); + if (this.TemplateId != null) + hashCode = hashCode * 59 + this.TemplateId.GetHashCode(); + if (this.RedirectionUrl != null) + hashCode = hashCode * 59 + this.RedirectionUrl.GetHashCode(); + return hashCode; + } + } + } + +} diff --git a/src/sib_api_v3_sdk/Model/CreateEmailCampaign.cs b/src/sib_api_v3_sdk/Model/CreateEmailCampaign.cs index 5cc6d61..7959700 100644 --- a/src/sib_api_v3_sdk/Model/CreateEmailCampaign.cs +++ b/src/sib_api_v3_sdk/Model/CreateEmailCampaign.cs @@ -80,7 +80,7 @@ protected CreateEmailCampaign() { } /// Footer of the email campaign. /// Header of the email campaign. /// Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed. - /// 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'. + /// 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'. /// Set this to true if you want to send your campaign at best time. (default to false). /// 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 (default to false). /// Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value. @@ -289,9 +289,9 @@ protected CreateEmailCampaign() { } public string UtmCampaign { get; set; } /// - /// 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' + /// 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' /// - /// 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' + /// 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' [DataMember(Name="params", EmitDefaultValue=false)] public Object Params { get; set; } diff --git a/src/sib_api_v3_sdk/Model/CreateEmailCampaignSender.cs b/src/sib_api_v3_sdk/Model/CreateEmailCampaignSender.cs index fc4adfc..ea7d07f 100644 --- a/src/sib_api_v3_sdk/Model/CreateEmailCampaignSender.cs +++ b/src/sib_api_v3_sdk/Model/CreateEmailCampaignSender.cs @@ -23,7 +23,7 @@ namespace sib_api_v3_sdk.Model { /// - /// Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` + /// Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{"name":"xyz", "email":"example@abc.com"}` , `{"name":"xyz", "id":123}` /// [DataContract] public partial class CreateEmailCampaignSender : IEquatable diff --git a/src/sib_api_v3_sdk/Model/CreateSmtpTemplateSender.cs b/src/sib_api_v3_sdk/Model/CreateSmtpTemplateSender.cs index 60077f9..35def15 100644 --- a/src/sib_api_v3_sdk/Model/CreateSmtpTemplateSender.cs +++ b/src/sib_api_v3_sdk/Model/CreateSmtpTemplateSender.cs @@ -23,7 +23,7 @@ namespace sib_api_v3_sdk.Model { /// - /// Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` + /// Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{"name":"xyz", "email":"example@abc.com"}` , `{"name":"xyz", "id":123}` /// [DataContract] public partial class CreateSmtpTemplateSender : IEquatable diff --git a/src/sib_api_v3_sdk/Model/GetAccountPlan.cs b/src/sib_api_v3_sdk/Model/GetAccountPlan.cs index bfe0034..a034f0e 100644 --- a/src/sib_api_v3_sdk/Model/GetAccountPlan.cs +++ b/src/sib_api_v3_sdk/Model/GetAccountPlan.cs @@ -74,9 +74,9 @@ public enum TypeEnum [DataMember(Name="type", EmitDefaultValue=false)] public TypeEnum Type { get; set; } /// - /// This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. + /// This is the type of the credit, "Send Limit" is one of the possible types of credit of a user. "Send Limit" implies the total number of emails you can send to the subscribers in your account. /// - /// This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. + /// This is the type of the credit, "Send Limit" is one of the possible types of credit of a user. "Send Limit" implies the total number of emails you can send to the subscribers in your account. [JsonConverter(typeof(StringEnumConverter))] public enum CreditsTypeEnum { @@ -89,9 +89,9 @@ public enum CreditsTypeEnum } /// - /// This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. + /// This is the type of the credit, "Send Limit" is one of the possible types of credit of a user. "Send Limit" implies the total number of emails you can send to the subscribers in your account. /// - /// This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. + /// This is the type of the credit, "Send Limit" is one of the possible types of credit of a user. "Send Limit" implies the total number of emails you can send to the subscribers in your account. [DataMember(Name="creditsType", EmitDefaultValue=false)] public CreditsTypeEnum CreditsType { get; set; } /// @@ -103,10 +103,10 @@ protected GetAccountPlan() { } /// Initializes a new instance of the class. /// /// Displays the plan type of the user (required). - /// This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. (required). + /// This is the type of the credit, "Send Limit" is one of the possible types of credit of a user. "Send Limit" implies the total number of emails you can send to the subscribers in your account. (required). /// Remaining credits of the user (required). - /// Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type). - /// Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type). + /// Date of the period from which the plan will start (only available for "subscription" and "reseller" plan type). + /// Date of the period from which the plan will end (only available for "subscription" and "reseller" plan type). /// Only in case of reseller account. It implies the total number of child accounts you can add to your account.. public GetAccountPlan(TypeEnum type = default(TypeEnum), CreditsTypeEnum creditsType = default(CreditsTypeEnum), float? credits = default(float?), DateTime? startDate = default(DateTime?), DateTime? endDate = default(DateTime?), int? userLimit = default(int?)) { @@ -152,17 +152,17 @@ protected GetAccountPlan() { } public float? Credits { get; set; } /// - /// Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) + /// Date of the period from which the plan will start (only available for "subscription" and "reseller" plan type) /// - /// Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) + /// Date of the period from which the plan will start (only available for "subscription" and "reseller" plan type) [DataMember(Name="startDate", EmitDefaultValue=false)] [JsonConverter(typeof(SwaggerDateConverter))] public DateTime? StartDate { get; set; } /// - /// Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) + /// Date of the period from which the plan will end (only available for "subscription" and "reseller" plan type) /// - /// Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) + /// Date of the period from which the plan will end (only available for "subscription" and "reseller" plan type) [DataMember(Name="endDate", EmitDefaultValue=false)] [JsonConverter(typeof(SwaggerDateConverter))] public DateTime? EndDate { get; set; } diff --git a/src/sib_api_v3_sdk/Model/GetAttributesAttributes.cs b/src/sib_api_v3_sdk/Model/GetAttributesAttributes.cs index 520163f..9842fc8 100644 --- a/src/sib_api_v3_sdk/Model/GetAttributesAttributes.cs +++ b/src/sib_api_v3_sdk/Model/GetAttributesAttributes.cs @@ -129,7 +129,7 @@ protected GetAttributesAttributes() { } /// Name of the attribute (required). /// Category of the attribute (required). /// Type of the attribute. - /// Parameter only available for \"category\" type attributes.. + /// Parameter only available for "category" type attributes.. /// Calculated value formula. public GetAttributesAttributes(string name = default(string), CategoryEnum category = default(CategoryEnum), TypeEnum? type = default(TypeEnum?), List enumeration = default(List), string calculatedValue = default(string)) { @@ -166,9 +166,9 @@ protected GetAttributesAttributes() { } /// - /// Parameter only available for \"category\" type attributes. + /// Parameter only available for "category" type attributes. /// - /// Parameter only available for \"category\" type attributes. + /// Parameter only available for "category" type attributes. [DataMember(Name="enumeration", EmitDefaultValue=false)] public List Enumeration { get; set; } diff --git a/src/sib_api_v3_sdk/Model/GetAttributesEnumeration.cs b/src/sib_api_v3_sdk/Model/GetAttributesEnumeration.cs index 5127d23..c7442ae 100644 --- a/src/sib_api_v3_sdk/Model/GetAttributesEnumeration.cs +++ b/src/sib_api_v3_sdk/Model/GetAttributesEnumeration.cs @@ -36,8 +36,8 @@ protected GetAttributesEnumeration() { } /// /// Initializes a new instance of the class. /// - /// ID of Value of the \"category\" type attribute (required). - /// Label of the \"category\" type attribute (required). + /// ID of Value of the "category" type attribute (required). + /// Label of the "category" type attribute (required). public GetAttributesEnumeration(long? value = default(long?), string label = default(string)) { // to ensure "value" is required (not null) @@ -61,16 +61,16 @@ protected GetAttributesEnumeration() { } } /// - /// ID of Value of the \"category\" type attribute + /// ID of Value of the "category" type attribute /// - /// ID of Value of the \"category\" type attribute + /// ID of Value of the "category" type attribute [DataMember(Name="value", EmitDefaultValue=false)] public long? Value { get; set; } /// - /// Label of the \"category\" type attribute + /// Label of the "category" type attribute /// - /// Label of the \"category\" type attribute + /// Label of the "category" type attribute [DataMember(Name="label", EmitDefaultValue=false)] public string Label { get; set; } diff --git a/src/sib_api_v3_sdk/Model/GetEmailCampaign.cs b/src/sib_api_v3_sdk/Model/GetEmailCampaign.cs index c8411fe..d4cf7e8 100644 --- a/src/sib_api_v3_sdk/Model/GetEmailCampaign.cs +++ b/src/sib_api_v3_sdk/Model/GetEmailCampaign.cs @@ -131,8 +131,8 @@ protected GetEmailCampaign() { } /// Header of the campaign (required). /// Footer of the campaign (required). /// sender (required). - /// Email defined as the \"Reply to\" of the campaign (required). - /// Customisation of the \"to\" field of the campaign (required). + /// Email defined as the "Reply to" of the campaign (required). + /// Customisation of the "to" field of the campaign (required). /// HTML content of the campaign (required). /// Link to share the campaign on social medias. /// Tag of the campaign (required). @@ -413,16 +413,16 @@ protected GetEmailCampaign() { } public GetExtendedCampaignOverviewSender Sender { get; set; } /// - /// Email defined as the \"Reply to\" of the campaign + /// Email defined as the "Reply to" of the campaign /// - /// Email defined as the \"Reply to\" of the campaign + /// Email defined as the "Reply to" of the campaign [DataMember(Name="replyTo", EmitDefaultValue=false)] public string ReplyTo { get; set; } /// - /// Customisation of the \"to\" field of the campaign + /// Customisation of the "to" field of the campaign /// - /// Customisation of the \"to\" field of the campaign + /// Customisation of the "to" field of the campaign [DataMember(Name="toField", EmitDefaultValue=false)] public string ToField { get; set; } diff --git a/src/sib_api_v3_sdk/Model/GetExtendedCampaignOverview.cs b/src/sib_api_v3_sdk/Model/GetExtendedCampaignOverview.cs index b449757..d40bbf4 100644 --- a/src/sib_api_v3_sdk/Model/GetExtendedCampaignOverview.cs +++ b/src/sib_api_v3_sdk/Model/GetExtendedCampaignOverview.cs @@ -131,8 +131,8 @@ protected GetExtendedCampaignOverview() { } /// Header of the campaign (required). /// Footer of the campaign (required). /// sender (required). - /// Email defined as the \"Reply to\" of the campaign (required). - /// Customisation of the \"to\" field of the campaign (required). + /// Email defined as the "Reply to" of the campaign (required). + /// Customisation of the "to" field of the campaign (required). /// HTML content of the campaign (required). /// Link to share the campaign on social medias. /// Tag of the campaign (required). @@ -393,16 +393,16 @@ protected GetExtendedCampaignOverview() { } public GetExtendedCampaignOverviewSender Sender { get; set; } /// - /// Email defined as the \"Reply to\" of the campaign + /// Email defined as the "Reply to" of the campaign /// - /// Email defined as the \"Reply to\" of the campaign + /// Email defined as the "Reply to" of the campaign [DataMember(Name="replyTo", EmitDefaultValue=false)] public string ReplyTo { get; set; } /// - /// Customisation of the \"to\" field of the campaign + /// Customisation of the "to" field of the campaign /// - /// Customisation of the \"to\" field of the campaign + /// Customisation of the "to" field of the campaign [DataMember(Name="toField", EmitDefaultValue=false)] public string ToField { get; set; } diff --git a/src/sib_api_v3_sdk/Model/GetSmtpTemplateOverview.cs b/src/sib_api_v3_sdk/Model/GetSmtpTemplateOverview.cs index 6364748..3fb1d25 100644 --- a/src/sib_api_v3_sdk/Model/GetSmtpTemplateOverview.cs +++ b/src/sib_api_v3_sdk/Model/GetSmtpTemplateOverview.cs @@ -42,8 +42,8 @@ protected GetSmtpTemplateOverview() { } /// Status of template (true=active, false=inactive) (required). /// Status of test sending for the template (true=test email has been sent, false=test email has not been sent) (required). /// sender (required). - /// Email defined as the \"Reply to\" for the template (required). - /// Customisation of the \"to\" field for the template (required). + /// Email defined as the "Reply to" for the template (required). + /// Customisation of the "to" field for the template (required). /// Tag of the template (required). /// HTML content of the template (required). /// Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) (required). @@ -202,16 +202,16 @@ protected GetSmtpTemplateOverview() { } public GetSmtpTemplateOverviewSender Sender { get; set; } /// - /// Email defined as the \"Reply to\" for the template + /// Email defined as the "Reply to" for the template /// - /// Email defined as the \"Reply to\" for the template + /// Email defined as the "Reply to" for the template [DataMember(Name="replyTo", EmitDefaultValue=false)] public string ReplyTo { get; set; } /// - /// Customisation of the \"to\" field for the template + /// Customisation of the "to" field for the template /// - /// Customisation of the \"to\" field for the template + /// Customisation of the "to" field for the template [DataMember(Name="toField", EmitDefaultValue=false)] public string ToField { get; set; } diff --git a/src/sib_api_v3_sdk/Model/GetTransacBlockedContactsContacts.cs b/src/sib_api_v3_sdk/Model/GetTransacBlockedContactsContacts.cs index 29fabd9..635018e 100644 --- a/src/sib_api_v3_sdk/Model/GetTransacBlockedContactsContacts.cs +++ b/src/sib_api_v3_sdk/Model/GetTransacBlockedContactsContacts.cs @@ -105,7 +105,6 @@ protected GetTransacBlockedContactsContacts() { } /// /// Date when the contact was blocked or unsubscribed on [DataMember(Name="blockedAt", EmitDefaultValue=false)] - [JsonConverter(typeof(SwaggerDateConverter))] public DateTime? BlockedAt { get; set; } /// diff --git a/src/sib_api_v3_sdk/Model/GetTransacEmailsListTransactionalEmails.cs b/src/sib_api_v3_sdk/Model/GetTransacEmailsListTransactionalEmails.cs index 7785a5b..d119ce6 100644 --- a/src/sib_api_v3_sdk/Model/GetTransacEmailsListTransactionalEmails.cs +++ b/src/sib_api_v3_sdk/Model/GetTransacEmailsListTransactionalEmails.cs @@ -42,7 +42,9 @@ protected GetTransacEmailsListTransactionalEmails() { } /// Message Id of the sent email (required). /// Unique id of the email sent to a particular contact (required). /// Date on which transactional email was sent (required). - public GetTransacEmailsListTransactionalEmails(string email = default(string), string subject = default(string), long? templateId = default(long?), string messageId = default(string), string uuid = default(string), DateTime? date = default(DateTime?)) + /// Email address of the sender from which the email was sent. + /// Tags used for your email. + public GetTransacEmailsListTransactionalEmails(string email = default(string), string subject = default(string), long? templateId = default(long?), string messageId = default(string), string uuid = default(string), DateTime? date = default(DateTime?), string from = default(string), List tags = default(List)) { // to ensure "email" is required (not null) if (email == null) @@ -90,6 +92,8 @@ protected GetTransacEmailsListTransactionalEmails() { } this.Date = date; } this.TemplateId = templateId; + this.From = from; + this.Tags = tags; } /// @@ -134,6 +138,20 @@ protected GetTransacEmailsListTransactionalEmails() { } [DataMember(Name="date", EmitDefaultValue=false)] public DateTime? Date { get; set; } + /// + /// Email address of the sender from which the email was sent + /// + /// Email address of the sender from which the email was sent + [DataMember(Name="from", EmitDefaultValue=false)] + public string From { get; set; } + + /// + /// Tags used for your email + /// + /// Tags used for your email + [DataMember(Name="tags", EmitDefaultValue=false)] + public List Tags { get; set; } + /// /// Returns the string presentation of the object /// @@ -148,6 +166,8 @@ public override string ToString() sb.Append(" MessageId: ").Append(MessageId).Append("\n"); sb.Append(" Uuid: ").Append(Uuid).Append("\n"); sb.Append(" Date: ").Append(Date).Append("\n"); + sb.Append(" From: ").Append(From).Append("\n"); + sb.Append(" Tags: ").Append(Tags).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -211,6 +231,16 @@ public bool Equals(GetTransacEmailsListTransactionalEmails input) this.Date == input.Date || (this.Date != null && this.Date.Equals(input.Date)) + ) && + ( + this.From == input.From || + (this.From != null && + this.From.Equals(input.From)) + ) && + ( + this.Tags == input.Tags || + this.Tags != null && + this.Tags.SequenceEqual(input.Tags) ); } @@ -235,6 +265,10 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.Uuid.GetHashCode(); if (this.Date != null) hashCode = hashCode * 59 + this.Date.GetHashCode(); + if (this.From != null) + hashCode = hashCode * 59 + this.From.GetHashCode(); + if (this.Tags != null) + hashCode = hashCode * 59 + this.Tags.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/PostContactInfoContacts.cs b/src/sib_api_v3_sdk/Model/PostContactInfoContacts.cs index e583c1c..e849b11 100644 --- a/src/sib_api_v3_sdk/Model/PostContactInfoContacts.cs +++ b/src/sib_api_v3_sdk/Model/PostContactInfoContacts.cs @@ -33,7 +33,7 @@ public partial class PostContactInfoContacts : IEquatable /// success. /// failure. - /// Displays the count of total number of contacts removed from list when user opts for \"all\" option.. + /// Displays the count of total number of contacts removed from list when user opts for "all" option.. public PostContactInfoContacts(List success = default(List), List failure = default(List), long? total = default(long?)) { this.Success = success; @@ -54,9 +54,9 @@ public partial class PostContactInfoContacts : IEquatable Failure { get; set; } /// - /// Displays the count of total number of contacts removed from list when user opts for \"all\" option. + /// Displays the count of total number of contacts removed from list when user opts for "all" option. /// - /// Displays the count of total number of contacts removed from list when user opts for \"all\" option. + /// Displays the count of total number of contacts removed from list when user opts for "all" option. [DataMember(Name="total", EmitDefaultValue=false)] public long? Total { get; set; } diff --git a/src/sib_api_v3_sdk/Model/RemainingCreditModelChild.cs b/src/sib_api_v3_sdk/Model/RemainingCreditModelChild.cs index aa0a9d4..1a19eb1 100644 --- a/src/sib_api_v3_sdk/Model/RemainingCreditModelChild.cs +++ b/src/sib_api_v3_sdk/Model/RemainingCreditModelChild.cs @@ -38,7 +38,7 @@ protected RemainingCreditModelChild() { } /// /// SMS Credits remaining for child account (required). /// Email Credits remaining for child account (required). - public RemainingCreditModelChild(long? sms = default(long?), long? email = default(long?)) + public RemainingCreditModelChild(double? sms = default(double?), double? email = default(double?)) { // to ensure "sms" is required (not null) if (sms == null) @@ -65,14 +65,14 @@ protected RemainingCreditModelChild() { } /// /// SMS Credits remaining for child account [DataMember(Name="sms", EmitDefaultValue=false)] - public long? Sms { get; set; } + public double? Sms { get; set; } /// /// Email Credits remaining for child account /// /// Email Credits remaining for child account [DataMember(Name="email", EmitDefaultValue=false)] - public long? Email { get; set; } + public double? Email { get; set; } /// /// Returns the string presentation of the object diff --git a/src/sib_api_v3_sdk/Model/RemainingCreditModelReseller.cs b/src/sib_api_v3_sdk/Model/RemainingCreditModelReseller.cs index 4f50194..9019ed5 100644 --- a/src/sib_api_v3_sdk/Model/RemainingCreditModelReseller.cs +++ b/src/sib_api_v3_sdk/Model/RemainingCreditModelReseller.cs @@ -38,7 +38,7 @@ protected RemainingCreditModelReseller() { } /// /// SMS Credits remaining for reseller account (required). /// Email Credits remaining for reseller account (required). - public RemainingCreditModelReseller(long? sms = default(long?), long? email = default(long?)) + public RemainingCreditModelReseller(double? sms = default(double?), double? email = default(double?)) { // to ensure "sms" is required (not null) if (sms == null) @@ -65,14 +65,14 @@ protected RemainingCreditModelReseller() { } /// /// SMS Credits remaining for reseller account [DataMember(Name="sms", EmitDefaultValue=false)] - public long? Sms { get; set; } + public double? Sms { get; set; } /// /// Email Credits remaining for reseller account /// /// Email Credits remaining for reseller account [DataMember(Name="email", EmitDefaultValue=false)] - public long? Email { get; set; } + public double? Email { get; set; } /// /// Returns the string presentation of the object diff --git a/src/sib_api_v3_sdk/Model/RemoveContactFromList.cs b/src/sib_api_v3_sdk/Model/RemoveContactFromList.cs index 77aa634..4910043 100644 --- a/src/sib_api_v3_sdk/Model/RemoveContactFromList.cs +++ b/src/sib_api_v3_sdk/Model/RemoveContactFromList.cs @@ -31,7 +31,7 @@ public partial class RemoveContactFromList : IEquatable /// /// Initializes a new instance of the class. /// - /// Required if 'all' is false. Emails to remove from a list. + /// Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request.. /// Required if 'emails' is empty. Remove all existing contacts from a list. public RemoveContactFromList(List emails = default(List), bool? all = default(bool?)) { @@ -40,9 +40,9 @@ public partial class RemoveContactFromList : IEquatable } /// - /// Required if 'all' is false. Emails to remove from a list + /// Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. /// - /// Required if 'all' is false. Emails to remove from a list + /// Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. [DataMember(Name="emails", EmitDefaultValue=false)] public List Emails { get; set; } diff --git a/src/sib_api_v3_sdk/Model/RequestContactExport.cs b/src/sib_api_v3_sdk/Model/RequestContactExport.cs index a98bef0..1dde3d1 100644 --- a/src/sib_api_v3_sdk/Model/RequestContactExport.cs +++ b/src/sib_api_v3_sdk/Model/RequestContactExport.cs @@ -32,7 +32,7 @@ public partial class RequestContactExport : IEquatable /// Initializes a new instance of the class. /// /// List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email'].. - /// 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. . + /// 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. . /// customContactFilter. /// Webhook that will be called once the export process is finished. public RequestContactExport(List exportAttributes = default(List), Object contactFilter = default(Object), RequestContactExportCustomContactFilter customContactFilter = default(RequestContactExportCustomContactFilter), string notifyUrl = default(string)) @@ -51,9 +51,9 @@ public partial class RequestContactExport : IEquatable public List ExportAttributes { get; set; } /// - /// 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. + /// 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. /// - /// 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. + /// 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. [DataMember(Name="contactFilter", EmitDefaultValue=false)] public Object ContactFilter { get; set; } diff --git a/src/sib_api_v3_sdk/Model/RequestContactImport.cs b/src/sib_api_v3_sdk/Model/RequestContactImport.cs index 593e90a..f3148fc 100644 --- a/src/sib_api_v3_sdk/Model/RequestContactImport.cs +++ b/src/sib_api_v3_sdk/Model/RequestContactImport.cs @@ -32,7 +32,7 @@ public partial class RequestContactImport : IEquatable /// Initializes a new instance of the class. /// /// Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv. - /// Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. + /// 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.. /// Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7].. /// URL that will be called once the export process is finished. /// newList. @@ -93,9 +93,9 @@ public partial class RequestContactImport : IEquatable public string FileUrl { get; set; } /// - /// Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes + /// 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. /// - /// Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes + /// 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. [DataMember(Name="fileBody", EmitDefaultValue=false)] public string FileBody { get; set; } diff --git a/src/sib_api_v3_sdk/Model/SendEmail.cs b/src/sib_api_v3_sdk/Model/SendEmail.cs index ef0681c..a359c62 100644 --- a/src/sib_api_v3_sdk/Model/SendEmail.cs +++ b/src/sib_api_v3_sdk/Model/SendEmail.cs @@ -41,9 +41,9 @@ protected SendEmail() { } /// List of the email addresses of the recipients in cc. /// Email address which shall be used by campaign recipients to reply back. /// 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. - /// 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'}].. - /// 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'}. - /// Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. + /// 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"}].. + /// 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"}. + /// Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. /// Tag your emails to find them more easily. public SendEmail(List emailTo = default(List), List emailBcc = default(List), List emailCc = default(List), string replyTo = default(string), string attachmentUrl = default(string), List attachment = default(List), Object headers = default(Object), Object attributes = default(Object), List tags = default(List)) { @@ -102,23 +102,23 @@ protected SendEmail() { } public string AttachmentUrl { get; set; } /// - /// 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'}]. + /// 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"}]. /// - /// 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'}]. + /// 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"}]. [DataMember(Name="attachment", EmitDefaultValue=false)] public List Attachment { get; set; } /// - /// 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'} + /// 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"} /// - /// 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'} + /// 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"} [DataMember(Name="headers", EmitDefaultValue=false)] public Object Headers { get; set; } /// - /// Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} + /// Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"} /// - /// Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} + /// Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"} [DataMember(Name="attributes", EmitDefaultValue=false)] public Object Attributes { get; set; } diff --git a/src/sib_api_v3_sdk/Model/SendSmtpEmail.cs b/src/sib_api_v3_sdk/Model/SendSmtpEmail.cs index 2421c65..38c15fe 100644 --- a/src/sib_api_v3_sdk/Model/SendSmtpEmail.cs +++ b/src/sib_api_v3_sdk/Model/SendSmtpEmail.cs @@ -37,17 +37,17 @@ protected SendSmtpEmail() { } /// Initializes a new instance of the class. /// /// sender. - /// List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] (required). + /// List of email addresses and names (optional) of the recipients. For example, [{"name":"Jimmy", "email":"jimmy98@example.com"}, {"name":"Joe", "email":"joe@example.com"}] (required). /// List of email addresses and names (optional) of the recipients in bcc. /// List of email addresses and names (optional) of the recipients in cc. /// HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ). /// Plain Text body of the message ( Ignored if 'templateId' is passed ). /// Subject of the message. Mandatory if 'templateId' is not passed. /// replyTo. - /// 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 ). - /// 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\"}`.. + /// 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 ). + /// 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"}`.. /// Id of the template. - /// 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.. + /// 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.. /// Tag your emails to find them more easily. public SendSmtpEmail(SendSmtpEmailSender sender = default(SendSmtpEmailSender), List to = default(List), List bcc = default(List), List cc = default(List), string htmlContent = default(string), string textContent = default(string), string subject = default(string), SendSmtpEmailReplyTo replyTo = default(SendSmtpEmailReplyTo), List attachment = default(List), Object headers = default(Object), long? templateId = default(long?), Object _params = default(Object), List tags = default(List)) { @@ -81,9 +81,9 @@ protected SendSmtpEmail() { } public SendSmtpEmailSender Sender { get; set; } /// - /// List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] + /// List of email addresses and names (optional) of the recipients. For example, [{"name":"Jimmy", "email":"jimmy98@example.com"}, {"name":"Joe", "email":"joe@example.com"}] /// - /// List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] + /// List of email addresses and names (optional) of the recipients. For example, [{"name":"Jimmy", "email":"jimmy98@example.com"}, {"name":"Joe", "email":"joe@example.com"}] [DataMember(Name="to", EmitDefaultValue=false)] public List To { get; set; } @@ -129,16 +129,16 @@ protected SendSmtpEmail() { } public SendSmtpEmailReplyTo ReplyTo { get; set; } /// - /// 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 ) + /// 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 ) /// - /// 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 ) + /// 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 ) [DataMember(Name="attachment", EmitDefaultValue=false)] public List Attachment { get; set; } /// - /// 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\"}`. + /// 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"}`. /// - /// 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\"}`. + /// 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"}`. [DataMember(Name="headers", EmitDefaultValue=false)] public Object Headers { get; set; } @@ -150,9 +150,9 @@ protected SendSmtpEmail() { } public long? TemplateId { get; set; } /// - /// 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. + /// 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. /// - /// 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. + /// 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. [DataMember(Name="params", EmitDefaultValue=false)] public Object Params { get; set; } diff --git a/src/sib_api_v3_sdk/Model/SendSmtpEmailReplyTo.cs b/src/sib_api_v3_sdk/Model/SendSmtpEmailReplyTo.cs index dca8207..013a9d7 100644 --- a/src/sib_api_v3_sdk/Model/SendSmtpEmailReplyTo.cs +++ b/src/sib_api_v3_sdk/Model/SendSmtpEmailReplyTo.cs @@ -23,7 +23,7 @@ namespace sib_api_v3_sdk.Model { /// - /// Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {'email':'ann6533@example.com', 'name':'Ann'}. + /// Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {"email":"ann6533@example.com", "name":"Ann"}. /// [DataContract] public partial class SendSmtpEmailReplyTo : IEquatable diff --git a/src/sib_api_v3_sdk/Model/SendSmtpEmailSender.cs b/src/sib_api_v3_sdk/Model/SendSmtpEmailSender.cs index fe8bb3e..bd2741c 100644 --- a/src/sib_api_v3_sdk/Model/SendSmtpEmailSender.cs +++ b/src/sib_api_v3_sdk/Model/SendSmtpEmailSender.cs @@ -23,7 +23,7 @@ namespace sib_api_v3_sdk.Model { /// - /// Mandatory if 'templateId' is not passed. Pass name (optional) and email of sender from which emails will be sent. For example, {'name':'Mary from MyShop', 'email':'no-reply@myshop.com'} + /// Mandatory if 'templateId' is not passed. Pass name (optional) and email of sender from which emails will be sent. For example, {"name":"Mary from MyShop", "email":"no-reply@myshop.com"} /// [DataContract] public partial class SendSmtpEmailSender : IEquatable diff --git a/src/sib_api_v3_sdk/Model/UpdateAttribute.cs b/src/sib_api_v3_sdk/Model/UpdateAttribute.cs index 5bea8ba..1e7d23d 100644 --- a/src/sib_api_v3_sdk/Model/UpdateAttribute.cs +++ b/src/sib_api_v3_sdk/Model/UpdateAttribute.cs @@ -32,7 +32,7 @@ public partial class UpdateAttribute : IEquatable /// Initializes a new instance of the class. /// /// Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global'. - /// 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'}]. + /// 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"}]. public UpdateAttribute(string value = default(string), List enumeration = default(List)) { this.Value = value; @@ -47,9 +47,9 @@ public partial class UpdateAttribute : IEquatable public string Value { get; set; } /// - /// 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'}] + /// 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"}] /// - /// 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'}] + /// 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"}] [DataMember(Name="enumeration", EmitDefaultValue=false)] public List Enumeration { get; set; } diff --git a/src/sib_api_v3_sdk/Model/UpdateContact.cs b/src/sib_api_v3_sdk/Model/UpdateContact.cs index 522415f..1a23bfa 100644 --- a/src/sib_api_v3_sdk/Model/UpdateContact.cs +++ b/src/sib_api_v3_sdk/Model/UpdateContact.cs @@ -31,7 +31,7 @@ public partial class UpdateContact : IEquatable /// /// Initializes a new instance of the class. /// - /// 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.. + /// 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"}. /// Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true). /// Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true). /// Ids of the lists to add the contact to. @@ -48,9 +48,9 @@ public partial class UpdateContact : IEquatable } /// - /// 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. + /// 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"} /// - /// 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. + /// 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"} [DataMember(Name="attributes", EmitDefaultValue=false)] public Object Attributes { get; set; } diff --git a/src/sib_api_v3_sdk/Model/UpdateEmailCampaign.cs b/src/sib_api_v3_sdk/Model/UpdateEmailCampaign.cs index 11b10fe..a28fcd8 100644 --- a/src/sib_api_v3_sdk/Model/UpdateEmailCampaign.cs +++ b/src/sib_api_v3_sdk/Model/UpdateEmailCampaign.cs @@ -75,7 +75,7 @@ public enum WinnerCriteriaEnum /// Footer of the email campaign. /// Header of the email campaign. /// Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed. - /// 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'. + /// 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'. /// Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.. /// 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 (default to false). /// Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value. @@ -268,9 +268,9 @@ public enum WinnerCriteriaEnum public string UtmCampaign { get; set; } /// - /// 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' + /// 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' /// - /// 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' + /// 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' [DataMember(Name="params", EmitDefaultValue=false)] public Object Params { get; set; } diff --git a/src/sib_api_v3_sdk/Model/UpdateEmailCampaignSender.cs b/src/sib_api_v3_sdk/Model/UpdateEmailCampaignSender.cs index 72e65f8..c635264 100644 --- a/src/sib_api_v3_sdk/Model/UpdateEmailCampaignSender.cs +++ b/src/sib_api_v3_sdk/Model/UpdateEmailCampaignSender.cs @@ -23,7 +23,7 @@ namespace sib_api_v3_sdk.Model { /// - /// Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` + /// Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{"name":"xyz", "email":"example@abc.com"}` , `{"name":"xyz", "id":123}` /// [DataContract] public partial class UpdateEmailCampaignSender : IEquatable diff --git a/src/sib_api_v3_sdk/Model/UpdateSmtpTemplateSender.cs b/src/sib_api_v3_sdk/Model/UpdateSmtpTemplateSender.cs index a584725..5711091 100644 --- a/src/sib_api_v3_sdk/Model/UpdateSmtpTemplateSender.cs +++ b/src/sib_api_v3_sdk/Model/UpdateSmtpTemplateSender.cs @@ -23,7 +23,7 @@ namespace sib_api_v3_sdk.Model { /// - /// Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` + /// Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{"name":"xyz", "email":"example@abc.com"}` , `{"name":"xyz", "id":123}` /// [DataContract] public partial class UpdateSmtpTemplateSender : IEquatable diff --git a/src/sib_api_v3_sdk/Model/UploadImageToGallery.cs b/src/sib_api_v3_sdk/Model/UploadImageToGallery.cs new file mode 100644 index 0000000..3c31100 --- /dev/null +++ b/src/sib_api_v3_sdk/Model/UploadImageToGallery.cs @@ -0,0 +1,143 @@ +/* + * 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 | + * + * OpenAPI spec version: 3.0.0 + * Contact: contact@sendinblue.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using SwaggerDateConverter = sib_api_v3_sdk.Client.SwaggerDateConverter; + +namespace sib_api_v3_sdk.Model +{ + /// + /// UploadImageToGallery + /// + [DataContract] + public partial class UploadImageToGallery : IEquatable + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected UploadImageToGallery() { } + /// + /// Initializes a new instance of the class. + /// + /// 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. (required). + /// Name of the image.. + public UploadImageToGallery(string imageUrl = default(string), string name = default(string)) + { + // to ensure "imageUrl" is required (not null) + if (imageUrl == null) + { + throw new InvalidDataException("imageUrl is a required property for UploadImageToGallery and cannot be null"); + } + else + { + this.ImageUrl = imageUrl; + } + this.Name = name; + } + + /// + /// 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. + /// + /// 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. + [DataMember(Name="imageUrl", EmitDefaultValue=false)] + public string ImageUrl { get; set; } + + /// + /// Name of the image. + /// + /// Name of the image. + [DataMember(Name="name", EmitDefaultValue=false)] + public string Name { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class UploadImageToGallery {\n"); + sb.Append(" ImageUrl: ").Append(ImageUrl).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as UploadImageToGallery); + } + + /// + /// Returns true if UploadImageToGallery instances are equal + /// + /// Instance of UploadImageToGallery to be compared + /// Boolean + public bool Equals(UploadImageToGallery input) + { + if (input == null) + return false; + + return + ( + this.ImageUrl == input.ImageUrl || + (this.ImageUrl != null && + this.ImageUrl.Equals(input.ImageUrl)) + ) && + ( + this.Name == input.Name || + (this.Name != null && + this.Name.Equals(input.Name)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.ImageUrl != null) + hashCode = hashCode * 59 + this.ImageUrl.GetHashCode(); + if (this.Name != null) + hashCode = hashCode * 59 + this.Name.GetHashCode(); + return hashCode; + } + } + } + +} diff --git a/src/sib_api_v3_sdk/sib_api_v3_sdk.csproj b/src/sib_api_v3_sdk/sib_api_v3_sdk.csproj index e96d2fc..a0d4a1d 100644 --- a/src/sib_api_v3_sdk/sib_api_v3_sdk.csproj +++ b/src/sib_api_v3_sdk/sib_api_v3_sdk.csproj @@ -9,12 +9,12 @@ Sendinblue Swagger Library Official SendinBlue provided RESTFul API V3 C# Library - Copyright (c) 2019 SendinBlue + Copyright (c) 2020 SendinBlue true true true sib_api_v3_sdk - 2.1.0 + 2.1.1 https://github.com/sendinblue/APIv3-csharp-library/blob/master/LICENSE.txt https://github.com/sendinblue/APIv3-csharp-library https://github.com/sendinblue/APIv3-csharp-library @@ -24,8 +24,8 @@ - +