From 42fe7a5d9621f5eda6695e04bf3c9e3dcb84102e Mon Sep 17 00:00:00 2001 From: amitsendinblue Date: Tue, 3 Nov 2020 15:50:39 +0530 Subject: [PATCH] Updated version to v3.0.0 --- README.md | 81 +- docs/AbTestCampaignResult.md | 2 + docs/AbTestCampaignResultClickedLinks.md | 10 + docs/AbTestCampaignResultStatistics.md | 14 + docs/AbTestVersionClicks.md | 8 + docs/AbTestVersionClicksInner.md | 11 + docs/AbTestVersionStats.md | 10 + docs/AddContactToList.md | 3 +- docs/ContactsApi.md | 58 +- docs/CreateChild.md | 1 + docs/CreateDoiContact.md | 4 +- docs/CreateReseller.md | 1 + docs/CreateSender.md | 2 +- docs/CreateSmsCampaign.md | 2 +- docs/CreateWebhook.md | 2 +- docs/EmailExportRecipients.md | 2 +- docs/GetAggregatedReport.md | 26 +- docs/GetCampaignStats.md | 1 + docs/GetEmailCampaign.md | 1 + docs/GetExtendedCampaignOverview.md | 1 + ...sticsUnsubscriptionsAdminUnsubscription.md | 2 +- ...isticsUnsubscriptionsUserUnsubscription.md | 2 +- docs/GetSmtpTemplateOverview.md | 1 + docs/ListsApi.md | 8 +- docs/PostContactInfoContacts.md | 1 + docs/RemoveContactFromList.md | 3 +- docs/RequestContactExport.md | 2 +- docs/RequestContactImport.md | 2 +- docs/RequestSmsRecipientExport.md | 2 +- docs/ResellerApi.md | 164 ++-- docs/SendReportEmail.md | 6 +- docs/SendSmtpEmail.md | 2 +- docs/SendSmtpEmailSender.md | 1 + docs/SendTransacSms.md | 2 +- .../{SMTPApi.md => TransactionalEmailsApi.md} | 104 +-- docs/TransactionalSMSApi.md | 6 +- docs/UpdateChildAccountStatus.md | 1 + docs/UpdateSmsCampaign.md | 2 +- docs/UpdateWebhook.md | 2 +- sib_api_v3_sdk.sln | 12 +- src/sib_api_v3_sdk/Api/ContactsApi.cs | 288 +++--- src/sib_api_v3_sdk/Api/ListsApi.cs | 32 +- src/sib_api_v3_sdk/Api/ResellerApi.cs | 880 +++++++++--------- .../{SMTPApi.cs => TransactionalEmailsApi.cs} | 64 +- src/sib_api_v3_sdk/Api/TransactionalSMSApi.cs | 16 +- src/sib_api_v3_sdk/Client/Configuration.cs | 8 +- .../Model/AbTestCampaignResult.cs | 34 +- .../Model/AbTestCampaignResultClickedLinks.cs | 149 +++ .../Model/AbTestCampaignResultStatistics.cs | 245 +++++ .../Model/AbTestVersionClicks.cs | 98 ++ .../Model/AbTestVersionClicksInner.cs | 176 ++++ .../Model/AbTestVersionStats.cs | 151 +++ src/sib_api_v3_sdk/Model/AddContactToList.cs | 25 +- src/sib_api_v3_sdk/Model/CreateChild.cs | 64 +- src/sib_api_v3_sdk/Model/CreateDoiContact.cs | 22 +- src/sib_api_v3_sdk/Model/CreateReseller.cs | 19 +- src/sib_api_v3_sdk/Model/CreateSender.cs | 6 +- src/sib_api_v3_sdk/Model/CreateSmsCampaign.cs | 6 +- src/sib_api_v3_sdk/Model/CreateWebhook.cs | 42 +- .../Model/EmailExportRecipients.cs | 6 +- .../Model/GetAggregatedReport.cs | 161 +--- src/sib_api_v3_sdk/Model/GetCampaignStats.cs | 19 +- src/sib_api_v3_sdk/Model/GetEmailCampaign.cs | 19 +- .../Model/GetExtendedCampaignOverview.cs | 19 +- ...sticsUnsubscriptionsAdminUnsubscription.cs | 12 +- ...isticsUnsubscriptionsUserUnsubscription.cs | 12 +- .../Model/GetSmtpTemplateOverview.cs | 19 +- .../Model/PostContactInfoContacts.cs | 19 +- .../Model/RemoveContactFromList.cs | 25 +- .../Model/RequestContactExport.cs | 6 +- .../Model/RequestContactImport.cs | 6 +- .../Model/RequestSmsRecipientExport.cs | 6 +- src/sib_api_v3_sdk/Model/SendReportEmail.cs | 115 +-- src/sib_api_v3_sdk/Model/SendSmtpEmail.cs | 6 +- .../Model/SendSmtpEmailSender.cs | 21 +- src/sib_api_v3_sdk/Model/SendTransacSms.cs | 6 +- .../Model/UpdateChildAccountStatus.cs | 19 +- src/sib_api_v3_sdk/Model/UpdateSmsCampaign.cs | 6 +- src/sib_api_v3_sdk/Model/UpdateWebhook.cs | 6 +- src/sib_api_v3_sdk/sib_api_v3_sdk.csproj | 2 +- 80 files changed, 2167 insertions(+), 1233 deletions(-) create mode 100644 docs/AbTestCampaignResultClickedLinks.md create mode 100644 docs/AbTestCampaignResultStatistics.md create mode 100644 docs/AbTestVersionClicks.md create mode 100644 docs/AbTestVersionClicksInner.md create mode 100644 docs/AbTestVersionStats.md rename docs/{SMTPApi.md => TransactionalEmailsApi.md} (88%) rename src/sib_api_v3_sdk/Api/{SMTPApi.cs => TransactionalEmailsApi.cs} (98%) create mode 100644 src/sib_api_v3_sdk/Model/AbTestCampaignResultClickedLinks.cs create mode 100644 src/sib_api_v3_sdk/Model/AbTestCampaignResultStatistics.cs create mode 100644 src/sib_api_v3_sdk/Model/AbTestVersionClicks.cs create mode 100644 src/sib_api_v3_sdk/Model/AbTestVersionClicksInner.cs create mode 100644 src/sib_api_v3_sdk/Model/AbTestVersionStats.cs diff --git a/README.md b/README.md index 3b64f2d..38d961e 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.1 +- SDK version: 3.0.0 - Build package: io.swagger.codegen.languages.CSharpClientCodegen For more information, please visit [https://account.sendinblue.com/support](https://account.sendinblue.com/support) @@ -96,16 +96,16 @@ Class | Method | HTTP request | Description *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} | 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* | [**CreateDoiContact**](docs/ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow *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} | Delete an attribute -*ContactsApi* | [**DeleteContact**](docs/ContactsApi.md#deletecontact) | **DELETE** /contacts/{email} | Delete a contact +*ContactsApi* | [**DeleteContact**](docs/ContactsApi.md#deletecontact) | **DELETE** /contacts/{identifier} | 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 | 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* | [**GetContactInfo**](docs/ContactsApi.md#getcontactinfo) | **GET** /contacts/{identifier} | Get a contact's details +*ContactsApi* | [**GetContactStats**](docs/ContactsApi.md#getcontactstats) | **GET** /contacts/{identifier}/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 contacts in a list *ContactsApi* | [**GetFolder**](docs/ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details @@ -117,7 +117,7 @@ Class | Method | HTTP request | Description *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} | Update contact attribute -*ContactsApi* | [**UpdateContact**](docs/ContactsApi.md#updatecontact) | **PUT** /contacts/{email} | Update a contact +*ContactsApi* | [**UpdateContact**](docs/ContactsApi.md#updatecontact) | **PUT** /contacts/{identifier} | 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 @@ -150,22 +150,22 @@ Class | Method | HTTP request | Description *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 | Create a domain for a child account +*ResellerApi* | [**AddCredits**](docs/ResellerApi.md#addcredits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account +*ResellerApi* | [**AssociateIpToChild**](docs/ResellerApi.md#associateiptochild) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child +*ResellerApi* | [**CreateChildDomain**](docs/ResellerApi.md#createchilddomain) | **POST** /reseller/children/{childIdentifier}/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} | 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 | 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* | [**DeleteChildDomain**](docs/ResellerApi.md#deletechilddomain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed +*ResellerApi* | [**DeleteResellerChild**](docs/ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied +*ResellerApi* | [**DissociateIpFromChild**](docs/ResellerApi.md#dissociateipfromchild) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child +*ResellerApi* | [**GetChildAccountCreationStatus**](docs/ResellerApi.md#getchildaccountcreationstatus) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied +*ResellerApi* | [**GetChildDomains**](docs/ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account +*ResellerApi* | [**GetChildInfo**](docs/ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childIdentifier} | 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 | 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 +*ResellerApi* | [**GetSsoToken**](docs/ResellerApi.md#getssotoken) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Sendinblue (SSO) +*ResellerApi* | [**RemoveCredits**](docs/ResellerApi.md#removecredits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account +*ResellerApi* | [**UpdateChildAccountStatus**](docs/ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied +*ResellerApi* | [**UpdateChildDomain**](docs/ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed +*ResellerApi* | [**UpdateResellerChild**](docs/ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied *SMSCampaignsApi* | [**CreateSmsCampaign**](docs/SMSCampaignsApi.md#createsmscampaign) | **POST** /smsCampaigns | Creates an 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 @@ -176,33 +176,33 @@ Class | Method | HTTP request | Description *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 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 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 -*SMTPApi* | [**SendTemplate**](docs/SMTPApi.md#sendtemplate) | **POST** /smtp/templates/{templateId}/send | Send a template -*SMTPApi* | [**SendTestTemplate**](docs/SMTPApi.md#sendtesttemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list -*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} | 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 | 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 +*TransactionalEmailsApi* | [**CreateSmtpTemplate**](docs/TransactionalEmailsApi.md#createsmtptemplate) | **POST** /smtp/templates | Create an email template +*TransactionalEmailsApi* | [**DeleteHardbounces**](docs/TransactionalEmailsApi.md#deletehardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces +*TransactionalEmailsApi* | [**DeleteSmtpTemplate**](docs/TransactionalEmailsApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template +*TransactionalEmailsApi* | [**GetAggregatedSmtpReport**](docs/TransactionalEmailsApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time +*TransactionalEmailsApi* | [**GetEmailEventReport**](docs/TransactionalEmailsApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) +*TransactionalEmailsApi* | [**GetSmtpReport**](docs/TransactionalEmailsApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day +*TransactionalEmailsApi* | [**GetSmtpTemplate**](docs/TransactionalEmailsApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template information +*TransactionalEmailsApi* | [**GetSmtpTemplates**](docs/TransactionalEmailsApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of email templates +*TransactionalEmailsApi* | [**GetTransacBlockedContacts**](docs/TransactionalEmailsApi.md#gettransacblockedcontacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts +*TransactionalEmailsApi* | [**GetTransacEmailContent**](docs/TransactionalEmailsApi.md#gettransacemailcontent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email +*TransactionalEmailsApi* | [**GetTransacEmailsList**](docs/TransactionalEmailsApi.md#gettransacemailslist) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters +*TransactionalEmailsApi* | [**SendTemplate**](docs/TransactionalEmailsApi.md#sendtemplate) | **POST** /smtp/templates/{templateId}/send | Send a template +*TransactionalEmailsApi* | [**SendTestTemplate**](docs/TransactionalEmailsApi.md#sendtesttemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list +*TransactionalEmailsApi* | [**SendTransacEmail**](docs/TransactionalEmailsApi.md#sendtransacemail) | **POST** /smtp/email | Send a transactional email +*TransactionalEmailsApi* | [**SmtpBlockedContactsEmailDelete**](docs/TransactionalEmailsApi.md#smtpblockedcontactsemaildelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact +*TransactionalEmailsApi* | [**SmtpLogMessageIdDelete**](docs/TransactionalEmailsApi.md#smtplogmessageiddelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log +*TransactionalEmailsApi* | [**UpdateSmtpTemplate**](docs/TransactionalEmailsApi.md#updatesmtptemplate) | **PUT** /smtp/templates/{templateId} | Update an email template *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 a mobile number +*TransactionalSMSApi* | [**SendTransacSms**](docs/TransactionalSMSApi.md#sendtransacsms) | **POST** /transactionalSMS/sms | Send SMS message 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 @@ -214,6 +214,11 @@ Class | Method | HTTP request | Description ## Documentation for Models - [Model.AbTestCampaignResult](docs/AbTestCampaignResult.md) + - [Model.AbTestCampaignResultClickedLinks](docs/AbTestCampaignResultClickedLinks.md) + - [Model.AbTestCampaignResultStatistics](docs/AbTestCampaignResultStatistics.md) + - [Model.AbTestVersionClicks](docs/AbTestVersionClicks.md) + - [Model.AbTestVersionClicksInner](docs/AbTestVersionClicksInner.md) + - [Model.AbTestVersionStats](docs/AbTestVersionStats.md) - [Model.AddChildDomain](docs/AddChildDomain.md) - [Model.AddContactToList](docs/AddContactToList.md) - [Model.AddCredits](docs/AddCredits.md) diff --git a/docs/AbTestCampaignResult.md b/docs/AbTestCampaignResult.md index 50120b3..7f1c772 100644 --- a/docs/AbTestCampaignResult.md +++ b/docs/AbTestCampaignResult.md @@ -9,6 +9,8 @@ Name | Type | Description | Notes **OpenRate** | **string** | Open rate for current winning version | [optional] **ClickRate** | **string** | Click rate for current winning version | [optional] **WinningVersionRate** | **string** | Open/Click rate for the winner version | [optional] +**Statistics** | [**AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional] +**ClickedLinks** | [**AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AbTestCampaignResultClickedLinks.md b/docs/AbTestCampaignResultClickedLinks.md new file mode 100644 index 0000000..5fec9cf --- /dev/null +++ b/docs/AbTestCampaignResultClickedLinks.md @@ -0,0 +1,10 @@ +# sib_api_v3_sdk.Model.AbTestCampaignResultClickedLinks +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VersionA** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | | +**VersionB** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | | + +[[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/AbTestCampaignResultStatistics.md b/docs/AbTestCampaignResultStatistics.md new file mode 100644 index 0000000..0430454 --- /dev/null +++ b/docs/AbTestCampaignResultStatistics.md @@ -0,0 +1,14 @@ +# sib_api_v3_sdk.Model.AbTestCampaignResultStatistics +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Openers** | [**AbTestVersionStats**](AbTestVersionStats.md) | | +**Clicks** | [**AbTestVersionStats**](AbTestVersionStats.md) | | +**Unsubscribed** | [**AbTestVersionStats**](AbTestVersionStats.md) | | +**HardBounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | | +**SoftBounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | | +**Complaints** | [**AbTestVersionStats**](AbTestVersionStats.md) | | + +[[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/AbTestVersionClicks.md b/docs/AbTestVersionClicks.md new file mode 100644 index 0000000..641255a --- /dev/null +++ b/docs/AbTestVersionClicks.md @@ -0,0 +1,8 @@ +# sib_api_v3_sdk.Model.AbTestVersionClicks +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AbTestVersionClicksInner.md b/docs/AbTestVersionClicksInner.md new file mode 100644 index 0000000..1c9f435 --- /dev/null +++ b/docs/AbTestVersionClicksInner.md @@ -0,0 +1,11 @@ +# sib_api_v3_sdk.Model.AbTestVersionClicksInner +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Link** | **string** | URL of the link | +**ClicksCount** | **decimal?** | Number of times a link is clicked | +**ClickRate** | **string** | Percentage of clicks of link with respect to total clicks | + +[[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/AbTestVersionStats.md b/docs/AbTestVersionStats.md new file mode 100644 index 0000000..164f391 --- /dev/null +++ b/docs/AbTestVersionStats.md @@ -0,0 +1,10 @@ +# sib_api_v3_sdk.Model.AbTestVersionStats +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VersionA** | **string** | percentage of an event for version A | +**VersionB** | **string** | percentage of an event for version B | + +[[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/AddContactToList.md b/docs/AddContactToList.md index 2b949bc..b1447a8 100644 --- a/docs/AddContactToList.md +++ b/docs/AddContactToList.md @@ -3,7 +3,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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] +**Emails** | **List<string>** | Mandatory if IDs are not passed, ignored otherwise. 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] +**Ids** | **List<long?>** | Mandatory if Emails are not passed, ignored otherwise. 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/ContactsApi.md b/docs/ContactsApi.md index be61176..5d8e45f 100644 --- a/docs/ContactsApi.md +++ b/docs/ContactsApi.md @@ -7,16 +7,16 @@ 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} | 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 +[**CreateDoiContact**](ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow [**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} | Delete an attribute -[**DeleteContact**](ContactsApi.md#deletecontact) | **DELETE** /contacts/{email} | Delete a contact +[**DeleteContact**](ContactsApi.md#deletecontact) | **DELETE** /contacts/{identifier} | 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 | 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 +[**GetContactInfo**](ContactsApi.md#getcontactinfo) | **GET** /contacts/{identifier} | Get a contact's details +[**GetContactStats**](ContactsApi.md#getcontactstats) | **GET** /contacts/{identifier}/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 contacts in a list [**GetFolder**](ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details @@ -28,7 +28,7 @@ Method | HTTP request | Description [**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} | Update contact attribute -[**UpdateContact**](ContactsApi.md#updatecontact) | **PUT** /contacts/{email} | Update a contact +[**UpdateContact**](ContactsApi.md#updatecontact) | **PUT** /contacts/{identifier} | 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 @@ -64,7 +64,7 @@ namespace Example var apiInstance = new ContactsApi(); var listId = 789; // long? | Id of the list - var contactEmails = new AddContactToList(); // AddContactToList | Emails addresses of the contacts + var contactEmails = new AddContactToList(); // AddContactToList | Emails addresses OR IDs of the contacts try { @@ -86,7 +86,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **long?**| Id of the list | - **contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts | + **contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts | ### Return type @@ -246,7 +246,7 @@ Name | Type | Description | Notes # **CreateDoiContact** > void CreateDoiContact (CreateDoiContact createDoiContact) -Create a contact to trigger the DOI workflow from a Landing Page form +Create Contact via DOI (Double-Opt-In) Flow ### Example ```csharp @@ -272,11 +272,11 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ContactsApi(); - var createDoiContact = new CreateDoiContact(); // CreateDoiContact | Values to create the DOI contact + var createDoiContact = new CreateDoiContact(); // CreateDoiContact | Values to create the Double opt-in (DOI) contact try { - // Create a contact to trigger the DOI workflow from a Landing Page form + // Create Contact via DOI (Double-Opt-In) Flow apiInstance.CreateDoiContact(createDoiContact); } catch (Exception e) @@ -292,7 +292,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **createDoiContact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the DOI contact | + **createDoiContact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the Double opt-in (DOI) contact | ### Return type @@ -516,7 +516,7 @@ void (empty response body) # **DeleteContact** -> void DeleteContact (string email) +> void DeleteContact (string identifier) Delete a contact @@ -544,12 +544,12 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ContactsApi(); - var email = email_example; // string | Email (urlencoded) of the contact + var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact try { // Delete a contact - apiInstance.DeleteContact(email); + apiInstance.DeleteContact(identifier); } catch (Exception e) { @@ -564,7 +564,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **email** | **string**| Email (urlencoded) of the contact | + **identifier** | **string**| Email (urlencoded) OR ID of the contact | ### Return type @@ -781,7 +781,7 @@ This endpoint does not need any parameter. # **GetContactInfo** -> GetExtendedContactDetails GetContactInfo (string email) +> GetExtendedContactDetails GetContactInfo (string identifier) Get a contact's details @@ -809,12 +809,12 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ContactsApi(); - var email = email_example; // string | Email (urlencoded) of the contact OR its SMS attribute value + var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact OR its SMS attribute value try { // Get a contact's details - GetExtendedContactDetails result = apiInstance.GetContactInfo(email); + GetExtendedContactDetails result = apiInstance.GetContactInfo(identifier); Debug.WriteLine(result); } catch (Exception e) @@ -830,7 +830,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **email** | **string**| Email (urlencoded) of the contact OR its SMS attribute value | + **identifier** | **string**| Email (urlencoded) OR ID of the contact OR its SMS attribute value | ### Return type @@ -849,7 +849,7 @@ Name | Type | Description | Notes # **GetContactStats** -> GetContactCampaignStats GetContactStats (string email, DateTime? startDate = null, DateTime? endDate = null) +> GetContactCampaignStats GetContactStats (string identifier, DateTime? startDate = null, DateTime? endDate = null) Get email campaigns' statistics for a contact @@ -877,14 +877,14 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ContactsApi(); - var email = email_example; // string | Email address (urlencoded) of the contact + var identifier = identifier_example; // string | Email (urlencoded) OR ID 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 email campaigns' statistics for a contact - GetContactCampaignStats result = apiInstance.GetContactStats(email, startDate, endDate); + GetContactCampaignStats result = apiInstance.GetContactStats(identifier, startDate, endDate); Debug.WriteLine(result); } catch (Exception e) @@ -900,7 +900,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **email** | **string**| Email address (urlencoded) of the contact | + **identifier** | **string**| Email (urlencoded) OR ID 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] @@ -1514,7 +1514,7 @@ namespace Example var apiInstance = new ContactsApi(); var listId = 789; // long? | Id of the list - var contactEmails = new RemoveContactFromList(); // RemoveContactFromList | Emails adresses of the contact + var contactEmails = new RemoveContactFromList(); // RemoveContactFromList | Emails addresses OR IDs of the contacts try { @@ -1536,7 +1536,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **long?**| Id of the list | - **contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact | + **contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts | ### Return type @@ -1696,7 +1696,7 @@ void (empty response body) # **UpdateContact** -> void UpdateContact (string email, UpdateContact updateContact) +> void UpdateContact (string identifier, UpdateContact updateContact) Update a contact @@ -1724,13 +1724,13 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ContactsApi(); - var email = email_example; // string | Email (urlencoded) of the contact + var identifier = identifier_example; // string | Email (urlencoded) OR ID of the contact var updateContact = new UpdateContact(); // UpdateContact | Values to update a contact try { // Update a contact - apiInstance.UpdateContact(email, updateContact); + apiInstance.UpdateContact(identifier, updateContact); } catch (Exception e) { @@ -1745,7 +1745,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **email** | **string**| Email (urlencoded) of the contact | + **identifier** | **string**| Email (urlencoded) OR ID of the contact | **updateContact** | [**UpdateContact**](UpdateContact.md)| Values to update a contact | ### Return type diff --git a/docs/CreateChild.md b/docs/CreateChild.md index e55dfe7..1348ea9 100644 --- a/docs/CreateChild.md +++ b/docs/CreateChild.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **LastName** | **string** | Last name to use to create the child account | **CompanyName** | **string** | Company name to use to create the child account | **Password** | **string** | Password for the child account to login | +**Language** | **string** | Language of the child 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/CreateDoiContact.md b/docs/CreateDoiContact.md index 1a9e934..1db6e37 100644 --- a/docs/CreateDoiContact.md +++ b/docs/CreateDoiContact.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **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] +**TemplateId** | **long?** | Id of the Double opt-in (DOI) template | +**RedirectionUrl** | **string** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. | [[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/CreateReseller.md b/docs/CreateReseller.md index f2bfea1..c8f378a 100644 --- a/docs/CreateReseller.md +++ b/docs/CreateReseller.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **AuthKey** | **string** | AuthKey of Reseller child created | +**Id** | **long?** | Id of Reseller child created | [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/CreateSender.md b/docs/CreateSender.md index 8aee417..b430867 100644 --- a/docs/CreateSender.md +++ b/docs/CreateSender.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | From Name to use for the sender | -**Email** | **string** | From Email to use for the sender | +**Email** | **string** | From email to use for the sender. A verification email will be sent to this address. | **Ips** | [**List<CreateSenderIps>**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [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/CreateSmsCampaign.md b/docs/CreateSmsCampaign.md index 18c1a0f..dd2c4da 100644 --- a/docs/CreateSmsCampaign.md +++ b/docs/CreateSmsCampaign.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | Name of the campaign | -**Sender** | **string** | Name of the sender. The number of characters is limited to 11 | +**Sender** | **string** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | **Content** | **string** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | **Recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional] **ScheduledAt** | **DateTime?** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] diff --git a/docs/CreateWebhook.md b/docs/CreateWebhook.md index c5884b4..8829332 100644 --- a/docs/CreateWebhook.md +++ b/docs/CreateWebhook.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Url** | **string** | URL of the webhook | **Description** | **string** | Description of the webhook | [optional] -**Events** | **List<string>** | Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered | +**Events** | **List<string>** | Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` | **Type** | **string** | Type of the webhook | [optional] [default to TypeEnum.Transactional] [[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/EmailExportRecipients.md b/docs/EmailExportRecipients.md index dbeadd6..52c000b 100644 --- a/docs/EmailExportRecipients.md +++ b/docs/EmailExportRecipients.md @@ -3,7 +3,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**NotifyURL** | **string** | Webhook called once the export process is finished | [optional] +**NotifyURL** | **string** | Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] **RecipientsType** | **string** | Type of recipients to export for a campaign | [[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/GetAggregatedReport.md b/docs/GetAggregatedReport.md index 257c582..b76b95c 100644 --- a/docs/GetAggregatedReport.md +++ b/docs/GetAggregatedReport.md @@ -3,19 +3,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Range** | **string** | Time frame of the report | -**Requests** | **long?** | Number of requests for the timeframe | -**Delivered** | **long?** | Number of delivered emails for the timeframe | -**HardBounces** | **long?** | Number of hardbounces for the timeframe | -**SoftBounces** | **long?** | Number of softbounces for the timeframe | -**Clicks** | **long?** | Number of clicks for the timeframe | -**UniqueClicks** | **long?** | Number of unique clicks for the timeframe | -**Opens** | **long?** | Number of openings for the timeframe | -**UniqueOpens** | **long?** | Number of unique openings for the timeframe | -**SpamReports** | **long?** | Number of complaint (spam report) for the timeframe | -**Blocked** | **long?** | Number of blocked contact emails for the timeframe | -**Invalid** | **long?** | Number of invalid emails for the timeframe | -**Unsubscribed** | **long?** | Number of unsubscribed emails for the timeframe | +**Range** | **string** | Time frame of the report | [optional] +**Requests** | **long?** | Number of requests for the timeframe | [optional] +**Delivered** | **long?** | Number of delivered emails for the timeframe | [optional] +**HardBounces** | **long?** | Number of hardbounces for the timeframe | [optional] +**SoftBounces** | **long?** | Number of softbounces for the timeframe | [optional] +**Clicks** | **long?** | Number of clicks for the timeframe | [optional] +**UniqueClicks** | **long?** | Number of unique clicks for the timeframe | [optional] +**Opens** | **long?** | Number of openings for the timeframe | [optional] +**UniqueOpens** | **long?** | Number of unique openings for the timeframe | [optional] +**SpamReports** | **long?** | Number of complaint (spam report) for the timeframe | [optional] +**Blocked** | **long?** | Number of blocked contact emails for the timeframe | [optional] +**Invalid** | **long?** | Number of invalid emails for the timeframe | [optional] +**Unsubscribed** | **long?** | Number of unsubscribed emails for the timeframe | [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/GetCampaignStats.md b/docs/GetCampaignStats.md index 7fede07..ee47c62 100644 --- a/docs/GetCampaignStats.md +++ b/docs/GetCampaignStats.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **Unsubscriptions** | **long?** | Number of unsubscription for the campaign | **Viewed** | **long?** | Number of openings for the campaign | **Deferred** | **long?** | Number of deferred emails for the campaign | [optional] +**ReturnBounce** | **long?** | Total number of non-delivered campaigns for a particular campaign id. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetEmailCampaign.md b/docs/GetEmailCampaign.md index 4c0fc93..2eaa5af 100644 --- a/docs/GetEmailCampaign.md +++ b/docs/GetEmailCampaign.md @@ -31,6 +31,7 @@ Name | Type | Description | Notes **MirrorActive** | **bool?** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] **Recurring** | **bool?** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] **SentDate** | **DateTime?** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] +**ReturnBounce** | **long?** | Total number of non-delivered campaigns for a particular campaign id. | [optional] **Recipients** | **Object** | | **Statistics** | **Object** | | diff --git a/docs/GetExtendedCampaignOverview.md b/docs/GetExtendedCampaignOverview.md index c8b3ee1..e62ef1b 100644 --- a/docs/GetExtendedCampaignOverview.md +++ b/docs/GetExtendedCampaignOverview.md @@ -31,6 +31,7 @@ Name | Type | Description | Notes **MirrorActive** | **bool?** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] **Recurring** | **bool?** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] **SentDate** | **DateTime?** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] +**ReturnBounce** | **long?** | Total number of non-delivered campaigns for a particular campaign id. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md b/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md index 0c9d219..24f1024 100644 --- a/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +++ b/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **EventTime** | **DateTime?** | UTC date-time of the event | -**Ip** | **string** | IP from which the user has been unsubscribed | +**Ip** | **string** | IP from which the user has been unsubscribed | [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/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md b/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md index 99a074c..6ddffef 100644 --- a/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +++ b/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CampaignId** | **long?** | ID of the campaign which generated the event | **EventTime** | **DateTime?** | UTC date-time of the event | -**Ip** | **string** | IP from which the user has unsubscribed | +**Ip** | **string** | IP from which the user has unsubscribed | [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/GetSmtpTemplateOverview.md b/docs/GetSmtpTemplateOverview.md index c98d7f4..fbf67ef 100644 --- a/docs/GetSmtpTemplateOverview.md +++ b/docs/GetSmtpTemplateOverview.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **HtmlContent** | **string** | HTML content of the template | **CreatedAt** | **DateTime?** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | **ModifiedAt** | **DateTime?** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | +**DoiTemplate** | **bool?** | It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. | [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 7ee4ced..d1ef9ff 100644 --- a/docs/ListsApi.md +++ b/docs/ListsApi.md @@ -46,7 +46,7 @@ namespace Example var apiInstance = new ListsApi(); var listId = 789; // long? | Id of the list - var contactEmails = new AddContactToList(); // AddContactToList | Emails addresses of the contacts + var contactEmails = new AddContactToList(); // AddContactToList | Emails addresses OR IDs of the contacts try { @@ -68,7 +68,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **long?**| Id of the list | - **contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts | + **contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts | ### Return type @@ -535,7 +535,7 @@ namespace Example var apiInstance = new ListsApi(); var listId = 789; // long? | Id of the list - var contactEmails = new RemoveContactFromList(); // RemoveContactFromList | Emails adresses of the contact + var contactEmails = new RemoveContactFromList(); // RemoveContactFromList | Emails addresses OR IDs of the contacts try { @@ -557,7 +557,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **long?**| Id of the list | - **contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact | + **contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts | ### Return type diff --git a/docs/PostContactInfoContacts.md b/docs/PostContactInfoContacts.md index 846b72c..5c485ee 100644 --- a/docs/PostContactInfoContacts.md +++ b/docs/PostContactInfoContacts.md @@ -6,6 +6,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] +**ProcessId** | **long?** | Id of the process created to remove contacts 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/RemoveContactFromList.md b/docs/RemoveContactFromList.md index 51f4ba8..1c70634 100644 --- a/docs/RemoveContactFromList.md +++ b/docs/RemoveContactFromList.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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] +**Ids** | **List<long?>** | Mandatory if Emails are not passed, ignored otherwise. 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] +**All** | **bool?** | Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress | [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 c0fb14a..6948f0e 100644 --- a/docs/RequestContactExport.md +++ b/docs/RequestContactExport.md @@ -6,7 +6,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] **CustomContactFilter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | [optional] -**NotifyUrl** | **string** | Webhook that will be called once the export process is finished | [optional] +**NotifyUrl** | **string** | Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [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/RequestContactImport.md b/docs/RequestContactImport.md index b0fea14..a7f632a 100644 --- a/docs/RequestContactImport.md +++ b/docs/RequestContactImport.md @@ -6,7 +6,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. 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] +**NotifyUrl** | **string** | URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] **NewList** | [**RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional] **EmailBlacklist** | **bool?** | To blacklist all the contacts for email | [optional] [default to false] **SmsBlacklist** | **bool?** | To blacklist all the contacts for sms | [optional] [default to false] diff --git a/docs/RequestSmsRecipientExport.md b/docs/RequestSmsRecipientExport.md index bffafa8..c70f132 100644 --- a/docs/RequestSmsRecipientExport.md +++ b/docs/RequestSmsRecipientExport.md @@ -3,7 +3,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**NotifyURL** | **string** | URL that will be called once the export process is finished | [optional] +**NotifyURL** | **string** | URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] **RecipientsType** | **string** | Filter the recipients based on how they interacted with the campaign | [[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/ResellerApi.md b/docs/ResellerApi.md index a13de9c..905af0a 100644 --- a/docs/ResellerApi.md +++ b/docs/ResellerApi.md @@ -4,27 +4,27 @@ All URIs are relative to *https://api.sendinblue.com/v3* 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 | Create a domain for a child account +[**AddCredits**](ResellerApi.md#addcredits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account +[**AssociateIpToChild**](ResellerApi.md#associateiptochild) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child +[**CreateChildDomain**](ResellerApi.md#createchilddomain) | **POST** /reseller/children/{childIdentifier}/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} | 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 | 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 +[**DeleteChildDomain**](ResellerApi.md#deletechilddomain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed +[**DeleteResellerChild**](ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied +[**DissociateIpFromChild**](ResellerApi.md#dissociateipfromchild) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child +[**GetChildAccountCreationStatus**](ResellerApi.md#getchildaccountcreationstatus) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied +[**GetChildDomains**](ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account +[**GetChildInfo**](ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childIdentifier} | 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 | 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 +[**GetSsoToken**](ResellerApi.md#getssotoken) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Sendinblue (SSO) +[**RemoveCredits**](ResellerApi.md#removecredits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account +[**UpdateChildAccountStatus**](ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied +[**UpdateChildDomain**](ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed +[**UpdateResellerChild**](ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied # **AddCredits** -> RemainingCreditModel AddCredits (string childAuthKey, AddCredits addCredits) +> RemainingCreditModel AddCredits (string childIdentifier, AddCredits addCredits) Add Email and/or SMS credits to a specific child account @@ -52,13 +52,13 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child var addCredits = new AddCredits(); // AddCredits | Values to post to add credit to a specific child account try { // Add Email and/or SMS credits to a specific child account - RemainingCreditModel result = apiInstance.AddCredits(childAuthKey, addCredits); + RemainingCreditModel result = apiInstance.AddCredits(childIdentifier, addCredits); Debug.WriteLine(result); } catch (Exception e) @@ -74,7 +74,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | **addCredits** | [**AddCredits**](AddCredits.md)| Values to post to add credit to a specific child account | ### Return type @@ -94,7 +94,7 @@ Name | Type | Description | Notes # **AssociateIpToChild** -> void AssociateIpToChild (string childAuthKey, ManageIp ip) +> void AssociateIpToChild (string childIdentifier, ManageIp ip) Associate a dedicated IP to the child @@ -122,13 +122,13 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child var ip = new ManageIp(); // ManageIp | IP to associate try { // Associate a dedicated IP to the child - apiInstance.AssociateIpToChild(childAuthKey, ip); + apiInstance.AssociateIpToChild(childIdentifier, ip); } catch (Exception e) { @@ -143,7 +143,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | **ip** | [**ManageIp**](ManageIp.md)| IP to associate | ### Return type @@ -163,7 +163,7 @@ void (empty response body) # **CreateChildDomain** -> void CreateChildDomain (string childAuthKey, AddChildDomain addChildDomain) +> void CreateChildDomain (string childIdentifier, AddChildDomain addChildDomain) Create a domain for a child account @@ -191,13 +191,13 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child var addChildDomain = new AddChildDomain(); // AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account. try { // Create a domain for a child account - apiInstance.CreateChildDomain(childAuthKey, addChildDomain); + apiInstance.CreateChildDomain(childIdentifier, addChildDomain); } catch (Exception e) { @@ -212,7 +212,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | **addChildDomain** | [**AddChildDomain**](AddChildDomain.md)| Sender domain to add for a specific child account. This will not be displayed to the parent account. | ### Return type @@ -300,9 +300,9 @@ Name | Type | Description | Notes # **DeleteChildDomain** -> void DeleteChildDomain (string childAuthKey, string domainName) +> void DeleteChildDomain (string childIdentifier, string domainName) -Delete 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 childIdentifier and domainName passed ### Example ```csharp @@ -328,13 +328,13 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child var domainName = domainName_example; // string | Pass the existing domain that needs to be deleted try { - // Delete the sender domain of the reseller child based on the childAuthKey and domainName passed - apiInstance.DeleteChildDomain(childAuthKey, domainName); + // Delete the sender domain of the reseller child based on the childIdentifier and domainName passed + apiInstance.DeleteChildDomain(childIdentifier, domainName); } catch (Exception e) { @@ -349,7 +349,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | **domainName** | **string**| Pass the existing domain that needs to be deleted | ### Return type @@ -369,9 +369,9 @@ void (empty response body) # **DeleteResellerChild** -> void DeleteResellerChild (string childAuthKey) +> void DeleteResellerChild (string childIdentifier) -Delete a single reseller child based on the childAuthKey supplied +Delete a single reseller child based on the child identifier supplied ### Example ```csharp @@ -397,12 +397,12 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or child id of reseller's child try { - // Delete a single reseller child based on the childAuthKey supplied - apiInstance.DeleteResellerChild(childAuthKey); + // Delete a single reseller child based on the child identifier supplied + apiInstance.DeleteResellerChild(childIdentifier); } catch (Exception e) { @@ -417,7 +417,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or child id of reseller's child | ### Return type @@ -436,7 +436,7 @@ void (empty response body) # **DissociateIpFromChild** -> void DissociateIpFromChild (string childAuthKey, ManageIp ip) +> void DissociateIpFromChild (string childIdentifier, ManageIp ip) Dissociate a dedicated IP to the child @@ -464,13 +464,13 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child var ip = new ManageIp(); // ManageIp | IP to dissociate try { // Dissociate a dedicated IP to the child - apiInstance.DissociateIpFromChild(childAuthKey, ip); + apiInstance.DissociateIpFromChild(childIdentifier, ip); } catch (Exception e) { @@ -485,7 +485,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | **ip** | [**ManageIp**](ManageIp.md)| IP to dissociate | ### Return type @@ -505,9 +505,9 @@ void (empty response body) # **GetChildAccountCreationStatus** -> GetChildAccountCreationStatus GetChildAccountCreationStatus (string childAuthKey) +> GetChildAccountCreationStatus GetChildAccountCreationStatus (string childIdentifier) -Get the status of a 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 identifier supplied ### Example ```csharp @@ -533,12 +533,12 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child try { - // 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); + // Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied + GetChildAccountCreationStatus result = apiInstance.GetChildAccountCreationStatus(childIdentifier); Debug.WriteLine(result); } catch (Exception e) @@ -554,7 +554,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | ### Return type @@ -573,7 +573,7 @@ Name | Type | Description | Notes # **GetChildDomains** -> GetChildDomains GetChildDomains (string childAuthKey) +> GetChildDomains GetChildDomains (string childIdentifier) Get all sender domains for a specific child account @@ -601,12 +601,12 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child try { // Get all sender domains for a specific child account - GetChildDomains result = apiInstance.GetChildDomains(childAuthKey); + GetChildDomains result = apiInstance.GetChildDomains(childIdentifier); Debug.WriteLine(result); } catch (Exception e) @@ -622,7 +622,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | ### Return type @@ -641,7 +641,7 @@ Name | Type | Description | Notes # **GetChildInfo** -> GetChildInfo GetChildInfo (string childAuthKey) +> GetChildInfo GetChildInfo (string childIdentifier) Get a child account's details @@ -669,12 +669,12 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child try { // Get a child account's details - GetChildInfo result = apiInstance.GetChildInfo(childAuthKey); + GetChildInfo result = apiInstance.GetChildInfo(childIdentifier); Debug.WriteLine(result); } catch (Exception e) @@ -690,7 +690,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | ### Return type @@ -779,7 +779,7 @@ Name | Type | Description | Notes # **GetSsoToken** -> GetSsoToken GetSsoToken (string childAuthKey) +> GetSsoToken GetSsoToken (string childIdentifier) Get session token to access Sendinblue (SSO) @@ -809,12 +809,12 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child try { // Get session token to access Sendinblue (SSO) - GetSsoToken result = apiInstance.GetSsoToken(childAuthKey); + GetSsoToken result = apiInstance.GetSsoToken(childIdentifier); Debug.WriteLine(result); } catch (Exception e) @@ -830,7 +830,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | ### Return type @@ -849,7 +849,7 @@ Name | Type | Description | Notes # **RemoveCredits** -> RemainingCreditModel RemoveCredits (string childAuthKey, RemoveCredits removeCredits) +> RemainingCreditModel RemoveCredits (string childIdentifier, RemoveCredits removeCredits) Remove Email and/or SMS credits from a specific child account @@ -877,13 +877,13 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child var removeCredits = new RemoveCredits(); // RemoveCredits | Values to post to remove email or SMS credits from a specific child account try { // Remove Email and/or SMS credits from a specific child account - RemainingCreditModel result = apiInstance.RemoveCredits(childAuthKey, removeCredits); + RemainingCreditModel result = apiInstance.RemoveCredits(childIdentifier, removeCredits); Debug.WriteLine(result); } catch (Exception e) @@ -899,7 +899,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | **removeCredits** | [**RemoveCredits**](RemoveCredits.md)| Values to post to remove email or SMS credits from a specific child account | ### Return type @@ -919,9 +919,9 @@ Name | Type | Description | Notes # **UpdateChildAccountStatus** -> void UpdateChildAccountStatus (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus) +> void UpdateChildAccountStatus (string childIdentifier, UpdateChildAccountStatus updateChildAccountStatus) -Update info of reseller's child account status based on the childAuthKey supplied +Update info of reseller's child account status based on the childIdentifier supplied ### Example ```csharp @@ -947,13 +947,13 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child var updateChildAccountStatus = new UpdateChildAccountStatus(); // UpdateChildAccountStatus | values to update in child account status try { - // Update info of reseller's child account status based on the childAuthKey supplied - apiInstance.UpdateChildAccountStatus(childAuthKey, updateChildAccountStatus); + // Update info of reseller's child account status based on the childIdentifier supplied + apiInstance.UpdateChildAccountStatus(childIdentifier, updateChildAccountStatus); } catch (Exception e) { @@ -968,7 +968,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | **updateChildAccountStatus** | [**UpdateChildAccountStatus**](UpdateChildAccountStatus.md)| values to update in child account status | ### Return type @@ -988,9 +988,9 @@ void (empty response body) # **UpdateChildDomain** -> void UpdateChildDomain (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain) +> void UpdateChildDomain (string childIdentifier, string domainName, UpdateChildDomain updateChildDomain) -Update 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 childIdentifier and domainName passed ### Example ```csharp @@ -1016,14 +1016,14 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child var domainName = domainName_example; // string | Pass the existing domain that needs to be updated var updateChildDomain = new UpdateChildDomain(); // UpdateChildDomain | value to update for sender domain try { - // Update the sender domain of reseller's child based on the childAuthKey and domainName passed - apiInstance.UpdateChildDomain(childAuthKey, domainName, updateChildDomain); + // Update the sender domain of reseller's child based on the childIdentifier and domainName passed + apiInstance.UpdateChildDomain(childIdentifier, domainName, updateChildDomain); } catch (Exception e) { @@ -1038,7 +1038,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | **domainName** | **string**| Pass the existing domain that needs to be updated | **updateChildDomain** | [**UpdateChildDomain**](UpdateChildDomain.md)| value to update for sender domain | @@ -1059,9 +1059,9 @@ void (empty response body) # **UpdateResellerChild** -> void UpdateResellerChild (string childAuthKey, UpdateChild resellerChild) +> void UpdateResellerChild (string childIdentifier, UpdateChild resellerChild) -Update info of reseller's child based on the childAuthKey supplied +Update info of reseller's child based on the child identifier supplied ### Example ```csharp @@ -1087,13 +1087,13 @@ namespace Example // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); var apiInstance = new ResellerApi(); - var childAuthKey = childAuthKey_example; // string | auth key of reseller's child + var childIdentifier = childIdentifier_example; // string | Either auth key or id of reseller's child var resellerChild = new UpdateChild(); // UpdateChild | values to update in child profile try { - // Update info of reseller's child based on the childAuthKey supplied - apiInstance.UpdateResellerChild(childAuthKey, resellerChild); + // Update info of reseller's child based on the child identifier supplied + apiInstance.UpdateResellerChild(childIdentifier, resellerChild); } catch (Exception e) { @@ -1108,7 +1108,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **childAuthKey** | **string**| auth key of reseller's child | + **childIdentifier** | **string**| Either auth key or id of reseller's child | **resellerChild** | [**UpdateChild**](UpdateChild.md)| values to update in child profile | ### Return type diff --git a/docs/SendReportEmail.md b/docs/SendReportEmail.md index 5e811d8..1a5f744 100644 --- a/docs/SendReportEmail.md +++ b/docs/SendReportEmail.md @@ -3,12 +3,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Subject** | **string** | Subject of the email message | **To** | **List<string>** | Email addresses of the recipients | -**ContentType** | **string** | Type of the message body | [optional] [default to ContentTypeEnum.Html] -**Bcc** | **List<string>** | Email addresses of the recipients in bcc | [optional] -**Cc** | **List<string>** | Email addresses of the recipients in cc | [optional] -**Body** | **string** | Body of the email message | +**Body** | **string** | Custom text message to be presented in the report email. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SendSmtpEmail.md b/docs/SendSmtpEmail.md index 6326e15..f6d08dd 100644 --- a/docs/SendSmtpEmail.md +++ b/docs/SendSmtpEmail.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **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] +**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":"myAttachmentFromUrl.jpg"}, {"content":"base64 example content", "name":"myAttachmentFromBase64.jpg"}]`. 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] diff --git a/docs/SendSmtpEmailSender.md b/docs/SendSmtpEmailSender.md index 2c5da4f..eafc974 100644 --- a/docs/SendSmtpEmailSender.md +++ b/docs/SendSmtpEmailSender.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. | [optional] **Email** | **string** | Email of the sender from which the emails will be sent | +**Id** | **long?** | Id of the sender from which the emails will be sent | [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/SendTransacSms.md b/docs/SendTransacSms.md index e5ef150..19300c3 100644 --- a/docs/SendTransacSms.md +++ b/docs/SendTransacSms.md @@ -3,7 +3,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Sender** | **string** | Name of the sender. Only alphanumeric characters. No more than 11 characters | +**Sender** | **string** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | **Recipient** | **string** | Mobile number to send SMS with the country code | **Content** | **string** | Content of the message. If more than 160 characters long, will be sent as multiple text messages | **Type** | **string** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to TypeEnum.Transactional] diff --git a/docs/SMTPApi.md b/docs/TransactionalEmailsApi.md similarity index 88% rename from docs/SMTPApi.md rename to docs/TransactionalEmailsApi.md index f32896b..7b7b1a9 100644 --- a/docs/SMTPApi.md +++ b/docs/TransactionalEmailsApi.md @@ -1,26 +1,26 @@ -# sib_api_v3_sdk.Api.SMTPApi +# sib_api_v3_sdk.Api.TransactionalEmailsApi All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**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 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 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 -[**SendTemplate**](SMTPApi.md#sendtemplate) | **POST** /smtp/templates/{templateId}/send | Send a template -[**SendTestTemplate**](SMTPApi.md#sendtesttemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list -[**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} | Update an email template +[**CreateSmtpTemplate**](TransactionalEmailsApi.md#createsmtptemplate) | **POST** /smtp/templates | Create an email template +[**DeleteHardbounces**](TransactionalEmailsApi.md#deletehardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces +[**DeleteSmtpTemplate**](TransactionalEmailsApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template +[**GetAggregatedSmtpReport**](TransactionalEmailsApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time +[**GetEmailEventReport**](TransactionalEmailsApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) +[**GetSmtpReport**](TransactionalEmailsApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day +[**GetSmtpTemplate**](TransactionalEmailsApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template information +[**GetSmtpTemplates**](TransactionalEmailsApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of email templates +[**GetTransacBlockedContacts**](TransactionalEmailsApi.md#gettransacblockedcontacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts +[**GetTransacEmailContent**](TransactionalEmailsApi.md#gettransacemailcontent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email +[**GetTransacEmailsList**](TransactionalEmailsApi.md#gettransacemailslist) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters +[**SendTemplate**](TransactionalEmailsApi.md#sendtemplate) | **POST** /smtp/templates/{templateId}/send | Send a template +[**SendTestTemplate**](TransactionalEmailsApi.md#sendtesttemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list +[**SendTransacEmail**](TransactionalEmailsApi.md#sendtransacemail) | **POST** /smtp/email | Send a transactional email +[**SmtpBlockedContactsEmailDelete**](TransactionalEmailsApi.md#smtpblockedcontactsemaildelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact +[**SmtpLogMessageIdDelete**](TransactionalEmailsApi.md#smtplogmessageiddelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log +[**UpdateSmtpTemplate**](TransactionalEmailsApi.md#updatesmtptemplate) | **PUT** /smtp/templates/{templateId} | Update an email template @@ -52,7 +52,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var smtpTemplate = new CreateSmtpTemplate(); // CreateSmtpTemplate | values to update in transactional email template try @@ -63,7 +63,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.CreateSmtpTemplate: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.CreateSmtpTemplate: " + e.Message ); } } } @@ -122,7 +122,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var deleteHardbounces = new DeleteHardbounces(); // DeleteHardbounces | values to delete hardbounces (optional) try @@ -132,7 +132,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.DeleteHardbounces: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.DeleteHardbounces: " + e.Message ); } } } @@ -189,7 +189,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var templateId = 789; // long? | id of the template try @@ -199,7 +199,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.DeleteSmtpTemplate: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.DeleteSmtpTemplate: " + e.Message ); } } } @@ -256,7 +256,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var startDate = startDate_example; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) var endDate = endDate_example; // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) var days = 56; // int? | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) @@ -270,7 +270,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.GetAggregatedSmtpReport: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.GetAggregatedSmtpReport: " + e.Message ); } } } @@ -330,7 +330,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var limit = 789; // long? | Number limitation for the result returned (optional) (default to 50) var offset = 789; // long? | Beginning point in the list to retrieve from. (optional) (default to 0) var startDate = startDate_example; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) @@ -350,7 +350,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.GetEmailEventReport: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.GetEmailEventReport: " + e.Message ); } } } @@ -416,7 +416,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var limit = 789; // long? | Number of documents returned per page (optional) (default to 10) var offset = 789; // long? | Index of the first document on the page (optional) (default to 0) var startDate = startDate_example; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional) @@ -432,7 +432,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.GetSmtpReport: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.GetSmtpReport: " + e.Message ); } } } @@ -494,7 +494,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var templateId = 789; // long? | id of the template try @@ -505,7 +505,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.GetSmtpTemplate: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.GetSmtpTemplate: " + e.Message ); } } } @@ -562,7 +562,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var templateStatus = true; // bool? | Filter on the status of the template. Active = true, inactive = false (optional) var limit = 789; // long? | Number of documents returned per page (optional) (default to 50) var offset = 789; // long? | Index of the first document in the page (optional) (default to 0) @@ -575,7 +575,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.GetSmtpTemplates: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.GetSmtpTemplates: " + e.Message ); } } } @@ -634,7 +634,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var startDate = startDate_example; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional) var endDate = endDate_example; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional) var limit = 789; // long? | Number of documents returned per page (optional) (default to 50) @@ -649,7 +649,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.GetTransacBlockedContacts: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.GetTransacBlockedContacts: " + e.Message ); } } } @@ -710,7 +710,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var uuid = uuid_example; // string | Unique id of the transactional email that has been sent to a particular contact try @@ -721,7 +721,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.GetTransacEmailContent: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.GetTransacEmailContent: " + e.Message ); } } } @@ -780,7 +780,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); 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) @@ -795,7 +795,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.GetTransacEmailsList: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.GetTransacEmailsList: " + e.Message ); } } } @@ -858,7 +858,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var templateId = 789; // long? | Id of the template var sendEmail = new SendEmail(); // SendEmail | @@ -870,7 +870,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.SendTemplate: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.SendTemplate: " + e.Message ); } } } @@ -928,7 +928,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var templateId = 789; // long? | Id of the template var sendTestEmail = new SendTestEmail(); // SendTestEmail | @@ -939,7 +939,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.SendTestTemplate: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.SendTestTemplate: " + e.Message ); } } } @@ -997,7 +997,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var sendSmtpEmail = new SendSmtpEmail(); // SendSmtpEmail | Values to send a transactional email try @@ -1008,7 +1008,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.SendTransacEmail: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.SendTransacEmail: " + e.Message ); } } } @@ -1065,7 +1065,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var email = email_example; // string | contact email (urlencoded) to unblock. try @@ -1075,7 +1075,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.SmtpBlockedContactsEmailDelete: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.SmtpBlockedContactsEmailDelete: " + e.Message ); } } } @@ -1132,7 +1132,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var messageId = messageId_example; // string | MessageId of the transactional log to delete try @@ -1142,7 +1142,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.SmtpLogMessageIdDelete: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.SmtpLogMessageIdDelete: " + e.Message ); } } } @@ -1199,7 +1199,7 @@ namespace Example // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer"); - var apiInstance = new SMTPApi(); + var apiInstance = new TransactionalEmailsApi(); var templateId = 789; // long? | id of the template var smtpTemplate = new UpdateSmtpTemplate(); // UpdateSmtpTemplate | values to update in transactional email template @@ -1210,7 +1210,7 @@ namespace Example } catch (Exception e) { - Debug.Print("Exception when calling SMTPApi.UpdateSmtpTemplate: " + e.Message ); + Debug.Print("Exception when calling TransactionalEmailsApi.UpdateSmtpTemplate: " + e.Message ); } } } diff --git a/docs/TransactionalSMSApi.md b/docs/TransactionalSMSApi.md index b003bd9..3760ea3 100644 --- a/docs/TransactionalSMSApi.md +++ b/docs/TransactionalSMSApi.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**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 a mobile number +[**SendTransacSms**](TransactionalSMSApi.md#sendtransacsms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number @@ -244,7 +244,7 @@ Name | Type | Description | Notes # **SendTransacSms** > SendSms SendTransacSms (SendTransacSms sendTransacSms) -Send the SMS campaign to a mobile number +Send SMS message to a mobile number ### Example ```csharp @@ -274,7 +274,7 @@ namespace Example try { - // Send the SMS campaign to a mobile number + // Send SMS message to a mobile number SendSms result = apiInstance.SendTransacSms(sendTransacSms); Debug.WriteLine(result); } diff --git a/docs/UpdateChildAccountStatus.md b/docs/UpdateChildAccountStatus.md index ae762ea..df181f6 100644 --- a/docs/UpdateChildAccountStatus.md +++ b/docs/UpdateChildAccountStatus.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **TransactionalEmail** | **bool?** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional] **TransactionalSms** | **bool?** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional] **MarketingAutomation** | **bool?** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional] +**SmsCampaign** | **bool?** | Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) | [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/UpdateSmsCampaign.md b/docs/UpdateSmsCampaign.md index 81b2ca9..6c9698a 100644 --- a/docs/UpdateSmsCampaign.md +++ b/docs/UpdateSmsCampaign.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | Name of the campaign | [optional] -**Sender** | **string** | Name of the sender. The number of characters is limited to 11 | [optional] +**Sender** | **string** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | [optional] **Content** | **string** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional] **Recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional] **ScheduledAt** | **DateTime?** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] diff --git a/docs/UpdateWebhook.md b/docs/UpdateWebhook.md index 2568722..b97caec 100644 --- a/docs/UpdateWebhook.md +++ b/docs/UpdateWebhook.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Url** | **string** | URL of the webhook | [optional] **Description** | **string** | Description of the webhook | [optional] -**Events** | **List<string>** | Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition and delivered | [optional] +**Events** | **List<string>** | Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` and `delivered` | [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 1ff9ad3..8344a14 100644 --- a/sib_api_v3_sdk.sln +++ b/sib_api_v3_sdk.sln @@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 15 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", "{75EF6C98-7CE6-4CC2-9A41-3A2FDB95DA3E}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "sib_api_v3_sdk", "src\sib_api_v3_sdk\sib_api_v3_sdk.csproj", "{8CA3796E-9F23-4355-B29D-E31EFCEBB8DA}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -10,15 +10,15 @@ Global Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {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 + {8CA3796E-9F23-4355-B29D-E31EFCEBB8DA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8CA3796E-9F23-4355-B29D-E31EFCEBB8DA}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8CA3796E-9F23-4355-B29D-E31EFCEBB8DA}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8CA3796E-9F23-4355-B29D-E31EFCEBB8DA}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution - SolutionGuid = {770ACEF6-7AF8-4718-BB40-6C28EEEA0058} + SolutionGuid = {F281C608-0470-48D9-9408-8068726D225B} EndGlobalSection EndGlobal diff --git a/src/sib_api_v3_sdk/Api/ContactsApi.cs b/src/sib_api_v3_sdk/Api/ContactsApi.cs index cc3aa28..0df6849 100644 --- a/src/sib_api_v3_sdk/Api/ContactsApi.cs +++ b/src/sib_api_v3_sdk/Api/ContactsApi.cs @@ -32,7 +32,7 @@ public interface IContactsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// PostContactInfo PostContactInfo AddContactToList (long? listId, AddContactToList contactEmails); @@ -44,7 +44,7 @@ public interface IContactsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// ApiResponse of PostContactInfo ApiResponse AddContactToListWithHttpInfo (long? listId, AddContactToList contactEmails); /// @@ -94,24 +94,24 @@ public interface IContactsApi : IApiAccessor /// ApiResponse of CreateUpdateContactModel ApiResponse CreateContactWithHttpInfo (CreateContact createContact); /// - /// Create a contact to trigger the DOI workflow from a Landing Page form + /// Create Contact via DOI (Double-Opt-In) Flow /// /// /// /// /// Thrown when fails to make API call - /// Values to create the DOI contact + /// Values to create the Double opt-in (DOI) contact /// void CreateDoiContact (CreateDoiContact createDoiContact); /// - /// Create a contact to trigger the DOI workflow from a Landing Page form + /// Create Contact via DOI (Double-Opt-In) Flow /// /// /// /// /// Thrown when fails to make API call - /// Values to create the DOI contact + /// Values to create the Double opt-in (DOI) contact /// ApiResponse of Object(void) ApiResponse CreateDoiContactWithHttpInfo (CreateDoiContact createDoiContact); /// @@ -186,9 +186,9 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// - void DeleteContact (string email); + void DeleteContact (string identifier); /// /// Delete a contact @@ -197,9 +197,9 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// ApiResponse of Object(void) - ApiResponse DeleteContactWithHttpInfo (string email); + ApiResponse DeleteContactWithHttpInfo (string identifier); /// /// Delete a folder (and all its lists) /// @@ -268,9 +268,9 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact OR its SMS attribute value + /// Email (urlencoded) OR ID of the contact OR its SMS attribute value /// GetExtendedContactDetails - GetExtendedContactDetails GetContactInfo (string email); + GetExtendedContactDetails GetContactInfo (string identifier); /// /// Get a contact's details @@ -279,9 +279,9 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact OR its SMS attribute value + /// Email (urlencoded) OR ID of the contact OR its SMS attribute value /// ApiResponse of GetExtendedContactDetails - ApiResponse GetContactInfoWithHttpInfo (string email); + ApiResponse GetContactInfoWithHttpInfo (string identifier); /// /// Get email campaigns' statistics for a contact /// @@ -289,11 +289,11 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email address (urlencoded) of the contact + /// Email (urlencoded) OR ID 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, DateTime? startDate = null, DateTime? endDate = null); + GetContactCampaignStats GetContactStats (string identifier, DateTime? startDate = null, DateTime? endDate = null); /// /// Get email campaigns' statistics for a contact @@ -302,11 +302,11 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email address (urlencoded) of the contact + /// Email (urlencoded) OR ID 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, DateTime? startDate = null, DateTime? endDate = null); + ApiResponse GetContactStatsWithHttpInfo (string identifier, DateTime? startDate = null, DateTime? endDate = null); /// /// Get all the contacts /// @@ -501,7 +501,7 @@ public interface IContactsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// PostContactInfo PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromList contactEmails); @@ -513,7 +513,7 @@ public interface IContactsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// ApiResponse of PostContactInfo ApiResponse RemoveContactFromListWithHttpInfo (long? listId, RemoveContactFromList contactEmails); /// @@ -569,10 +569,10 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Values to update a contact /// - void UpdateContact (string email, UpdateContact updateContact); + void UpdateContact (string identifier, UpdateContact updateContact); /// /// Update a contact @@ -581,10 +581,10 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Values to update a contact /// ApiResponse of Object(void) - ApiResponse UpdateContactWithHttpInfo (string email, UpdateContact updateContact); + ApiResponse UpdateContactWithHttpInfo (string identifier, UpdateContact updateContact); /// /// Update a folder /// @@ -641,7 +641,7 @@ public interface IContactsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// Task of PostContactInfo System.Threading.Tasks.Task AddContactToListAsync (long? listId, AddContactToList contactEmails); @@ -653,7 +653,7 @@ public interface IContactsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// Task of ApiResponse (PostContactInfo) System.Threading.Tasks.Task> AddContactToListAsyncWithHttpInfo (long? listId, AddContactToList contactEmails); /// @@ -703,24 +703,24 @@ 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 + /// Create Contact via DOI (Double-Opt-In) Flow /// /// /// /// /// Thrown when fails to make API call - /// Values to create the DOI contact + /// Values to create the Double opt-in (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 + /// Create Contact via DOI (Double-Opt-In) Flow /// /// /// /// /// Thrown when fails to make API call - /// Values to create the DOI contact + /// Values to create the Double opt-in (DOI) contact /// Task of ApiResponse System.Threading.Tasks.Task> CreateDoiContactAsyncWithHttpInfo (CreateDoiContact createDoiContact); /// @@ -795,9 +795,9 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Task of void - System.Threading.Tasks.Task DeleteContactAsync (string email); + System.Threading.Tasks.Task DeleteContactAsync (string identifier); /// /// Delete a contact @@ -806,9 +806,9 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Task of ApiResponse - System.Threading.Tasks.Task> DeleteContactAsyncWithHttpInfo (string email); + System.Threading.Tasks.Task> DeleteContactAsyncWithHttpInfo (string identifier); /// /// Delete a folder (and all its lists) /// @@ -877,9 +877,9 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact OR its SMS attribute value + /// Email (urlencoded) OR ID of the contact OR its SMS attribute value /// Task of GetExtendedContactDetails - System.Threading.Tasks.Task GetContactInfoAsync (string email); + System.Threading.Tasks.Task GetContactInfoAsync (string identifier); /// /// Get a contact's details @@ -888,9 +888,9 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact OR its SMS attribute value + /// Email (urlencoded) OR ID of the contact OR its SMS attribute value /// Task of ApiResponse (GetExtendedContactDetails) - System.Threading.Tasks.Task> GetContactInfoAsyncWithHttpInfo (string email); + System.Threading.Tasks.Task> GetContactInfoAsyncWithHttpInfo (string identifier); /// /// Get email campaigns' statistics for a contact /// @@ -898,11 +898,11 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email address (urlencoded) of the contact + /// Email (urlencoded) OR ID 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, DateTime? startDate = null, DateTime? endDate = null); + System.Threading.Tasks.Task GetContactStatsAsync (string identifier, DateTime? startDate = null, DateTime? endDate = null); /// /// Get email campaigns' statistics for a contact @@ -911,11 +911,11 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email address (urlencoded) of the contact + /// Email (urlencoded) OR ID 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, DateTime? startDate = null, DateTime? endDate = null); + System.Threading.Tasks.Task> GetContactStatsAsyncWithHttpInfo (string identifier, DateTime? startDate = null, DateTime? endDate = null); /// /// Get all the contacts /// @@ -1110,7 +1110,7 @@ public interface IContactsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// Task of PostContactInfo System.Threading.Tasks.Task RemoveContactFromListAsync (long? listId, RemoveContactFromList contactEmails); @@ -1122,7 +1122,7 @@ public interface IContactsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// Task of ApiResponse (PostContactInfo) System.Threading.Tasks.Task> RemoveContactFromListAsyncWithHttpInfo (long? listId, RemoveContactFromList contactEmails); /// @@ -1178,10 +1178,10 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Values to update a contact /// Task of void - System.Threading.Tasks.Task UpdateContactAsync (string email, UpdateContact updateContact); + System.Threading.Tasks.Task UpdateContactAsync (string identifier, UpdateContact updateContact); /// /// Update a contact @@ -1190,10 +1190,10 @@ public interface IContactsApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Values to update a contact /// Task of ApiResponse - System.Threading.Tasks.Task> UpdateContactAsyncWithHttpInfo (string email, UpdateContact updateContact); + System.Threading.Tasks.Task> UpdateContactAsyncWithHttpInfo (string identifier, UpdateContact updateContact); /// /// Update a folder /// @@ -1345,7 +1345,7 @@ public void AddDefaultHeader(string key, string value) /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// PostContactInfo public PostContactInfo AddContactToList (long? listId, AddContactToList contactEmails) { @@ -1358,7 +1358,7 @@ public PostContactInfo AddContactToList (long? listId, AddContactToList contactE /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// ApiResponse of PostContactInfo public ApiResponse< PostContactInfo > AddContactToListWithHttpInfo (long? listId, AddContactToList contactEmails) { @@ -1435,7 +1435,7 @@ public ApiResponse< PostContactInfo > AddContactToListWithHttpInfo (long? listId /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// Task of PostContactInfo public async System.Threading.Tasks.Task AddContactToListAsync (long? listId, AddContactToList contactEmails) { @@ -1449,7 +1449,7 @@ public async System.Threading.Tasks.Task AddContactToListAsync /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// Task of ApiResponse (PostContactInfo) public async System.Threading.Tasks.Task> AddContactToListAsyncWithHttpInfo (long? listId, AddContactToList contactEmails) { @@ -1882,10 +1882,10 @@ public async System.Threading.Tasks.Task> } /// - /// Create a contact to trigger the DOI workflow from a Landing Page form + /// Create Contact via DOI (Double-Opt-In) Flow /// /// Thrown when fails to make API call - /// Values to create the DOI contact + /// Values to create the Double opt-in (DOI) contact /// public void CreateDoiContact (CreateDoiContact createDoiContact) { @@ -1893,10 +1893,10 @@ public void CreateDoiContact (CreateDoiContact createDoiContact) } /// - /// Create a contact to trigger the DOI workflow from a Landing Page form + /// Create Contact via DOI (Double-Opt-In) Flow /// /// Thrown when fails to make API call - /// Values to create the DOI contact + /// Values to create the Double opt-in (DOI) contact /// ApiResponse of Object(void) public ApiResponse CreateDoiContactWithHttpInfo (CreateDoiContact createDoiContact) { @@ -1965,10 +1965,10 @@ public ApiResponse CreateDoiContactWithHttpInfo (CreateDoiContact create } /// - /// Create a contact to trigger the DOI workflow from a Landing Page form + /// Create Contact via DOI (Double-Opt-In) Flow /// /// Thrown when fails to make API call - /// Values to create the DOI contact + /// Values to create the Double opt-in (DOI) contact /// Task of void public async System.Threading.Tasks.Task CreateDoiContactAsync (CreateDoiContact createDoiContact) { @@ -1977,10 +1977,10 @@ public async System.Threading.Tasks.Task CreateDoiContactAsync (CreateDoiContact } /// - /// Create a contact to trigger the DOI workflow from a Landing Page form + /// Create Contact via DOI (Double-Opt-In) Flow /// /// Thrown when fails to make API call - /// Values to create the DOI contact + /// Values to create the Double opt-in (DOI) contact /// Task of ApiResponse public async System.Threading.Tasks.Task> CreateDoiContactAsyncWithHttpInfo (CreateDoiContact createDoiContact) { @@ -2555,26 +2555,26 @@ public async System.Threading.Tasks.Task> DeleteAttributeAsy /// Delete a contact /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// - public void DeleteContact (string email) + public void DeleteContact (string identifier) { - DeleteContactWithHttpInfo(email); + DeleteContactWithHttpInfo(identifier); } /// /// Delete a contact /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// ApiResponse of Object(void) - public ApiResponse DeleteContactWithHttpInfo (string email) + public ApiResponse DeleteContactWithHttpInfo (string identifier) { - // verify the required parameter 'email' is set - if (email == null) - throw new ApiException(400, "Missing required parameter 'email' when calling ContactsApi->DeleteContact"); + // verify the required parameter 'identifier' is set + if (identifier == null) + throw new ApiException(400, "Missing required parameter 'identifier' when calling ContactsApi->DeleteContact"); - var localVarPath = "./contacts/{email}"; + var localVarPath = "./contacts/{identifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2596,7 +2596,7 @@ public ApiResponse DeleteContactWithHttpInfo (string email) if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (email != null) localVarPathParams.Add("email", this.Configuration.ApiClient.ParameterToString(email)); // path parameter + if (identifier != null) localVarPathParams.Add("identifier", this.Configuration.ApiClient.ParameterToString(identifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -2631,11 +2631,11 @@ public ApiResponse DeleteContactWithHttpInfo (string email) /// Delete a contact /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Task of void - public async System.Threading.Tasks.Task DeleteContactAsync (string email) + public async System.Threading.Tasks.Task DeleteContactAsync (string identifier) { - await DeleteContactAsyncWithHttpInfo(email); + await DeleteContactAsyncWithHttpInfo(identifier); } @@ -2643,15 +2643,15 @@ public async System.Threading.Tasks.Task DeleteContactAsync (string email) /// Delete a contact /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Task of ApiResponse - public async System.Threading.Tasks.Task> DeleteContactAsyncWithHttpInfo (string email) + public async System.Threading.Tasks.Task> DeleteContactAsyncWithHttpInfo (string identifier) { - // verify the required parameter 'email' is set - if (email == null) - throw new ApiException(400, "Missing required parameter 'email' when calling ContactsApi->DeleteContact"); + // verify the required parameter 'identifier' is set + if (identifier == null) + throw new ApiException(400, "Missing required parameter 'identifier' when calling ContactsApi->DeleteContact"); - var localVarPath = "./contacts/{email}"; + var localVarPath = "./contacts/{identifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2673,7 +2673,7 @@ public async System.Threading.Tasks.Task> DeleteContactAsync if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (email != null) localVarPathParams.Add("email", this.Configuration.ApiClient.ParameterToString(email)); // path parameter + if (identifier != null) localVarPathParams.Add("identifier", this.Configuration.ApiClient.ParameterToString(identifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -3157,11 +3157,11 @@ public async System.Threading.Tasks.Task> GetAttribut /// Get a contact's details /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact OR its SMS attribute value + /// Email (urlencoded) OR ID of the contact OR its SMS attribute value /// GetExtendedContactDetails - public GetExtendedContactDetails GetContactInfo (string email) + public GetExtendedContactDetails GetContactInfo (string identifier) { - ApiResponse localVarResponse = GetContactInfoWithHttpInfo(email); + ApiResponse localVarResponse = GetContactInfoWithHttpInfo(identifier); return localVarResponse.Data; } @@ -3169,15 +3169,15 @@ public GetExtendedContactDetails GetContactInfo (string email) /// Get a contact's details /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact OR its SMS attribute value + /// Email (urlencoded) OR ID of the contact OR its SMS attribute value /// ApiResponse of GetExtendedContactDetails - public ApiResponse< GetExtendedContactDetails > GetContactInfoWithHttpInfo (string email) + public ApiResponse< GetExtendedContactDetails > GetContactInfoWithHttpInfo (string identifier) { - // verify the required parameter 'email' is set - if (email == null) - throw new ApiException(400, "Missing required parameter 'email' when calling ContactsApi->GetContactInfo"); + // verify the required parameter 'identifier' is set + if (identifier == null) + throw new ApiException(400, "Missing required parameter 'identifier' when calling ContactsApi->GetContactInfo"); - var localVarPath = "./contacts/{email}"; + var localVarPath = "./contacts/{identifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -3199,7 +3199,7 @@ public ApiResponse< GetExtendedContactDetails > GetContactInfoWithHttpInfo (stri if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (email != null) localVarPathParams.Add("email", this.Configuration.ApiClient.ParameterToString(email)); // path parameter + if (identifier != null) localVarPathParams.Add("identifier", this.Configuration.ApiClient.ParameterToString(identifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -3234,11 +3234,11 @@ public ApiResponse< GetExtendedContactDetails > GetContactInfoWithHttpInfo (stri /// Get a contact's details /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact OR its SMS attribute value + /// Email (urlencoded) OR ID of the contact OR its SMS attribute value /// Task of GetExtendedContactDetails - public async System.Threading.Tasks.Task GetContactInfoAsync (string email) + public async System.Threading.Tasks.Task GetContactInfoAsync (string identifier) { - ApiResponse localVarResponse = await GetContactInfoAsyncWithHttpInfo(email); + ApiResponse localVarResponse = await GetContactInfoAsyncWithHttpInfo(identifier); return localVarResponse.Data; } @@ -3247,15 +3247,15 @@ public async System.Threading.Tasks.Task GetContactIn /// Get a contact's details /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact OR its SMS attribute value + /// Email (urlencoded) OR ID of the contact OR its SMS attribute value /// Task of ApiResponse (GetExtendedContactDetails) - public async System.Threading.Tasks.Task> GetContactInfoAsyncWithHttpInfo (string email) + public async System.Threading.Tasks.Task> GetContactInfoAsyncWithHttpInfo (string identifier) { - // verify the required parameter 'email' is set - if (email == null) - throw new ApiException(400, "Missing required parameter 'email' when calling ContactsApi->GetContactInfo"); + // verify the required parameter 'identifier' is set + if (identifier == null) + throw new ApiException(400, "Missing required parameter 'identifier' when calling ContactsApi->GetContactInfo"); - var localVarPath = "./contacts/{email}"; + var localVarPath = "./contacts/{identifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -3277,7 +3277,7 @@ public async System.Threading.Tasks.Task> if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (email != null) localVarPathParams.Add("email", this.Configuration.ApiClient.ParameterToString(email)); // path parameter + if (identifier != null) localVarPathParams.Add("identifier", this.Configuration.ApiClient.ParameterToString(identifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -3312,13 +3312,13 @@ public async System.Threading.Tasks.Task> /// Get email campaigns' statistics for a contact /// /// Thrown when fails to make API call - /// Email address (urlencoded) of the contact + /// Email (urlencoded) OR ID 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, DateTime? startDate = null, DateTime? endDate = null) + public GetContactCampaignStats GetContactStats (string identifier, DateTime? startDate = null, DateTime? endDate = null) { - ApiResponse localVarResponse = GetContactStatsWithHttpInfo(email, startDate, endDate); + ApiResponse localVarResponse = GetContactStatsWithHttpInfo(identifier, startDate, endDate); return localVarResponse.Data; } @@ -3326,17 +3326,17 @@ public GetContactCampaignStats GetContactStats (string email, DateTime? startDat /// Get email campaigns' statistics for a contact /// /// Thrown when fails to make API call - /// Email address (urlencoded) of the contact + /// Email (urlencoded) OR ID 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, DateTime? startDate = null, DateTime? endDate = null) + public ApiResponse< GetContactCampaignStats > GetContactStatsWithHttpInfo (string identifier, DateTime? startDate = null, DateTime? endDate = null) { - // verify the required parameter 'email' is set - if (email == null) - throw new ApiException(400, "Missing required parameter 'email' when calling ContactsApi->GetContactStats"); + // verify the required parameter 'identifier' is set + if (identifier == null) + throw new ApiException(400, "Missing required parameter 'identifier' when calling ContactsApi->GetContactStats"); - var localVarPath = "./contacts/{email}/campaignStats"; + var localVarPath = "./contacts/{identifier}/campaignStats"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -3358,7 +3358,7 @@ public ApiResponse< GetContactCampaignStats > GetContactStatsWithHttpInfo (strin if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (email != null) localVarPathParams.Add("email", this.Configuration.ApiClient.ParameterToString(email)); // path parameter + if (identifier != null) localVarPathParams.Add("identifier", this.Configuration.ApiClient.ParameterToString(identifier)); // 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 @@ -3395,13 +3395,13 @@ public ApiResponse< GetContactCampaignStats > GetContactStatsWithHttpInfo (strin /// Get email campaigns' statistics for a contact /// /// Thrown when fails to make API call - /// Email address (urlencoded) of the contact + /// Email (urlencoded) OR ID 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, DateTime? startDate = null, DateTime? endDate = null) + public async System.Threading.Tasks.Task GetContactStatsAsync (string identifier, DateTime? startDate = null, DateTime? endDate = null) { - ApiResponse localVarResponse = await GetContactStatsAsyncWithHttpInfo(email, startDate, endDate); + ApiResponse localVarResponse = await GetContactStatsAsyncWithHttpInfo(identifier, startDate, endDate); return localVarResponse.Data; } @@ -3410,17 +3410,17 @@ public async System.Threading.Tasks.Task GetContactStat /// Get email campaigns' statistics for a contact /// /// Thrown when fails to make API call - /// Email address (urlencoded) of the contact + /// Email (urlencoded) OR ID 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, DateTime? startDate = null, DateTime? endDate = null) + public async System.Threading.Tasks.Task> GetContactStatsAsyncWithHttpInfo (string identifier, DateTime? startDate = null, DateTime? endDate = null) { - // verify the required parameter 'email' is set - if (email == null) - throw new ApiException(400, "Missing required parameter 'email' when calling ContactsApi->GetContactStats"); + // verify the required parameter 'identifier' is set + if (identifier == null) + throw new ApiException(400, "Missing required parameter 'identifier' when calling ContactsApi->GetContactStats"); - var localVarPath = "./contacts/{email}/campaignStats"; + var localVarPath = "./contacts/{identifier}/campaignStats"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -3442,7 +3442,7 @@ public async System.Threading.Tasks.Task> G if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (email != null) localVarPathParams.Add("email", this.Configuration.ApiClient.ParameterToString(email)); // path parameter + if (identifier != null) localVarPathParams.Add("identifier", this.Configuration.ApiClient.ParameterToString(identifier)); // 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 @@ -4782,7 +4782,7 @@ public async System.Threading.Tasks.Task> ImportCo /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// PostContactInfo public PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromList contactEmails) { @@ -4795,7 +4795,7 @@ public PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromLis /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// ApiResponse of PostContactInfo public ApiResponse< PostContactInfo > RemoveContactFromListWithHttpInfo (long? listId, RemoveContactFromList contactEmails) { @@ -4872,7 +4872,7 @@ public ApiResponse< PostContactInfo > RemoveContactFromListWithHttpInfo (long? l /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// Task of PostContactInfo public async System.Threading.Tasks.Task RemoveContactFromListAsync (long? listId, RemoveContactFromList contactEmails) { @@ -4886,7 +4886,7 @@ public async System.Threading.Tasks.Task RemoveContactFromListA /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// Task of ApiResponse (PostContactInfo) public async System.Threading.Tasks.Task> RemoveContactFromListAsyncWithHttpInfo (long? listId, RemoveContactFromList contactEmails) { @@ -5322,31 +5322,31 @@ public async System.Threading.Tasks.Task> UpdateAttributeAsy /// Update a contact /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Values to update a contact /// - public void UpdateContact (string email, UpdateContact updateContact) + public void UpdateContact (string identifier, UpdateContact updateContact) { - UpdateContactWithHttpInfo(email, updateContact); + UpdateContactWithHttpInfo(identifier, updateContact); } /// /// Update a contact /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Values to update a contact /// ApiResponse of Object(void) - public ApiResponse UpdateContactWithHttpInfo (string email, UpdateContact updateContact) + public ApiResponse UpdateContactWithHttpInfo (string identifier, UpdateContact updateContact) { - // verify the required parameter 'email' is set - if (email == null) - throw new ApiException(400, "Missing required parameter 'email' when calling ContactsApi->UpdateContact"); + // verify the required parameter 'identifier' is set + if (identifier == null) + throw new ApiException(400, "Missing required parameter 'identifier' when calling ContactsApi->UpdateContact"); // verify the required parameter 'updateContact' is set if (updateContact == null) throw new ApiException(400, "Missing required parameter 'updateContact' when calling ContactsApi->UpdateContact"); - var localVarPath = "./contacts/{email}"; + var localVarPath = "./contacts/{identifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -5368,7 +5368,7 @@ public ApiResponse UpdateContactWithHttpInfo (string email, UpdateContac if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (email != null) localVarPathParams.Add("email", this.Configuration.ApiClient.ParameterToString(email)); // path parameter + if (identifier != null) localVarPathParams.Add("identifier", this.Configuration.ApiClient.ParameterToString(identifier)); // path parameter if (updateContact != null && updateContact.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(updateContact); // http body (model) parameter @@ -5411,12 +5411,12 @@ public ApiResponse UpdateContactWithHttpInfo (string email, UpdateContac /// Update a contact /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Values to update a contact /// Task of void - public async System.Threading.Tasks.Task UpdateContactAsync (string email, UpdateContact updateContact) + public async System.Threading.Tasks.Task UpdateContactAsync (string identifier, UpdateContact updateContact) { - await UpdateContactAsyncWithHttpInfo(email, updateContact); + await UpdateContactAsyncWithHttpInfo(identifier, updateContact); } @@ -5424,19 +5424,19 @@ public async System.Threading.Tasks.Task UpdateContactAsync (string email, Updat /// Update a contact /// /// Thrown when fails to make API call - /// Email (urlencoded) of the contact + /// Email (urlencoded) OR ID of the contact /// Values to update a contact /// Task of ApiResponse - public async System.Threading.Tasks.Task> UpdateContactAsyncWithHttpInfo (string email, UpdateContact updateContact) + public async System.Threading.Tasks.Task> UpdateContactAsyncWithHttpInfo (string identifier, UpdateContact updateContact) { - // verify the required parameter 'email' is set - if (email == null) - throw new ApiException(400, "Missing required parameter 'email' when calling ContactsApi->UpdateContact"); + // verify the required parameter 'identifier' is set + if (identifier == null) + throw new ApiException(400, "Missing required parameter 'identifier' when calling ContactsApi->UpdateContact"); // verify the required parameter 'updateContact' is set if (updateContact == null) throw new ApiException(400, "Missing required parameter 'updateContact' when calling ContactsApi->UpdateContact"); - var localVarPath = "./contacts/{email}"; + var localVarPath = "./contacts/{identifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -5458,7 +5458,7 @@ public async System.Threading.Tasks.Task> UpdateContactAsync if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (email != null) localVarPathParams.Add("email", this.Configuration.ApiClient.ParameterToString(email)); // path parameter + if (identifier != null) localVarPathParams.Add("identifier", this.Configuration.ApiClient.ParameterToString(identifier)); // path parameter if (updateContact != null && updateContact.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(updateContact); // http body (model) parameter diff --git a/src/sib_api_v3_sdk/Api/ListsApi.cs b/src/sib_api_v3_sdk/Api/ListsApi.cs index 61baaac..6672719 100644 --- a/src/sib_api_v3_sdk/Api/ListsApi.cs +++ b/src/sib_api_v3_sdk/Api/ListsApi.cs @@ -32,7 +32,7 @@ public interface IListsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// PostContactInfo PostContactInfo AddContactToList (long? listId, AddContactToList contactEmails); @@ -44,7 +44,7 @@ public interface IListsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// ApiResponse of PostContactInfo ApiResponse AddContactToListWithHttpInfo (long? listId, AddContactToList contactEmails); /// @@ -193,7 +193,7 @@ public interface IListsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// PostContactInfo PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromList contactEmails); @@ -205,7 +205,7 @@ public interface IListsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// ApiResponse of PostContactInfo ApiResponse RemoveContactFromListWithHttpInfo (long? listId, RemoveContactFromList contactEmails); /// @@ -241,7 +241,7 @@ public interface IListsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// Task of PostContactInfo System.Threading.Tasks.Task AddContactToListAsync (long? listId, AddContactToList contactEmails); @@ -253,7 +253,7 @@ public interface IListsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// Task of ApiResponse (PostContactInfo) System.Threading.Tasks.Task> AddContactToListAsyncWithHttpInfo (long? listId, AddContactToList contactEmails); /// @@ -402,7 +402,7 @@ public interface IListsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// Task of PostContactInfo System.Threading.Tasks.Task RemoveContactFromListAsync (long? listId, RemoveContactFromList contactEmails); @@ -414,7 +414,7 @@ public interface IListsApi : IApiAccessor /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// Task of ApiResponse (PostContactInfo) System.Threading.Tasks.Task> RemoveContactFromListAsyncWithHttpInfo (long? listId, RemoveContactFromList contactEmails); /// @@ -545,7 +545,7 @@ public void AddDefaultHeader(string key, string value) /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// PostContactInfo public PostContactInfo AddContactToList (long? listId, AddContactToList contactEmails) { @@ -558,7 +558,7 @@ public PostContactInfo AddContactToList (long? listId, AddContactToList contactE /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// ApiResponse of PostContactInfo public ApiResponse< PostContactInfo > AddContactToListWithHttpInfo (long? listId, AddContactToList contactEmails) { @@ -635,7 +635,7 @@ public ApiResponse< PostContactInfo > AddContactToListWithHttpInfo (long? listId /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// Task of PostContactInfo public async System.Threading.Tasks.Task AddContactToListAsync (long? listId, AddContactToList contactEmails) { @@ -649,7 +649,7 @@ public async System.Threading.Tasks.Task AddContactToListAsync /// /// Thrown when fails to make API call /// Id of the list - /// Emails addresses of the contacts + /// Emails addresses OR IDs of the contacts /// Task of ApiResponse (PostContactInfo) public async System.Threading.Tasks.Task> AddContactToListAsyncWithHttpInfo (long? listId, AddContactToList contactEmails) { @@ -1698,7 +1698,7 @@ public async System.Threading.Tasks.Task> GetListsAsyncWit /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// PostContactInfo public PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromList contactEmails) { @@ -1711,7 +1711,7 @@ public PostContactInfo RemoveContactFromList (long? listId, RemoveContactFromLis /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// ApiResponse of PostContactInfo public ApiResponse< PostContactInfo > RemoveContactFromListWithHttpInfo (long? listId, RemoveContactFromList contactEmails) { @@ -1788,7 +1788,7 @@ public ApiResponse< PostContactInfo > RemoveContactFromListWithHttpInfo (long? l /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// Task of PostContactInfo public async System.Threading.Tasks.Task RemoveContactFromListAsync (long? listId, RemoveContactFromList contactEmails) { @@ -1802,7 +1802,7 @@ public async System.Threading.Tasks.Task RemoveContactFromListA /// /// Thrown when fails to make API call /// Id of the list - /// Emails adresses of the contact + /// Emails addresses OR IDs of the contacts /// Task of ApiResponse (PostContactInfo) public async System.Threading.Tasks.Task> RemoveContactFromListAsyncWithHttpInfo (long? listId, RemoveContactFromList contactEmails) { diff --git a/src/sib_api_v3_sdk/Api/ResellerApi.cs b/src/sib_api_v3_sdk/Api/ResellerApi.cs index af49778..9d26338 100644 --- a/src/sib_api_v3_sdk/Api/ResellerApi.cs +++ b/src/sib_api_v3_sdk/Api/ResellerApi.cs @@ -31,10 +31,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to add credit to a specific child account /// RemainingCreditModel - RemainingCreditModel AddCredits (string childAuthKey, AddCredits addCredits); + RemainingCreditModel AddCredits (string childIdentifier, AddCredits addCredits); /// /// Add Email and/or SMS credits to a specific child account @@ -43,10 +43,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to add credit to a specific child account /// ApiResponse of RemainingCreditModel - ApiResponse AddCreditsWithHttpInfo (string childAuthKey, AddCredits addCredits); + ApiResponse AddCreditsWithHttpInfo (string childIdentifier, AddCredits addCredits); /// /// Associate a dedicated IP to the child /// @@ -54,10 +54,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to associate /// - void AssociateIpToChild (string childAuthKey, ManageIp ip); + void AssociateIpToChild (string childIdentifier, ManageIp ip); /// /// Associate a dedicated IP to the child @@ -66,10 +66,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to associate /// ApiResponse of Object(void) - ApiResponse AssociateIpToChildWithHttpInfo (string childAuthKey, ManageIp ip); + ApiResponse AssociateIpToChildWithHttpInfo (string childIdentifier, ManageIp ip); /// /// Create a domain for a child account /// @@ -77,10 +77,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Sender domain to add for a specific child account. This will not be displayed to the parent account. /// - void CreateChildDomain (string childAuthKey, AddChildDomain addChildDomain); + void CreateChildDomain (string childIdentifier, AddChildDomain addChildDomain); /// /// Create a domain for a child account @@ -89,10 +89,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Sender domain to add for a specific child account. This will not be displayed to the parent account. /// ApiResponse of Object(void) - ApiResponse CreateChildDomainWithHttpInfo (string childAuthKey, AddChildDomain addChildDomain); + ApiResponse CreateChildDomainWithHttpInfo (string childIdentifier, AddChildDomain addChildDomain); /// /// Creates a reseller child /// @@ -115,49 +115,49 @@ public interface IResellerApi : IApiAccessor /// ApiResponse of CreateReseller ApiResponse CreateResellerChildWithHttpInfo (CreateChild resellerChild = null); /// - /// Delete 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 childIdentifier and domainName passed /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be deleted /// - void DeleteChildDomain (string childAuthKey, string domainName); + void DeleteChildDomain (string childIdentifier, string domainName); /// - /// Delete 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 childIdentifier and domainName passed /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be deleted /// ApiResponse of Object(void) - ApiResponse DeleteChildDomainWithHttpInfo (string childAuthKey, string domainName); + ApiResponse DeleteChildDomainWithHttpInfo (string childIdentifier, string domainName); /// - /// Delete a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the child identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or child id of reseller's child /// - void DeleteResellerChild (string childAuthKey); + void DeleteResellerChild (string childIdentifier); /// - /// Delete a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the child identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or child id of reseller's child /// ApiResponse of Object(void) - ApiResponse DeleteResellerChildWithHttpInfo (string childAuthKey); + ApiResponse DeleteResellerChildWithHttpInfo (string childIdentifier); /// /// Dissociate a dedicated IP to the child /// @@ -165,10 +165,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to dissociate /// - void DissociateIpFromChild (string childAuthKey, ManageIp ip); + void DissociateIpFromChild (string childIdentifier, ManageIp ip); /// /// Dissociate a dedicated IP to the child @@ -177,31 +177,31 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to dissociate /// ApiResponse of Object(void) - ApiResponse DissociateIpFromChildWithHttpInfo (string childAuthKey, ManageIp ip); + ApiResponse DissociateIpFromChildWithHttpInfo (string childIdentifier, ManageIp ip); /// - /// Get the status of a 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 identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// GetChildAccountCreationStatus - GetChildAccountCreationStatus GetChildAccountCreationStatus (string childAuthKey); + GetChildAccountCreationStatus GetChildAccountCreationStatus (string childIdentifier); /// - /// Get the status of a 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 identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// ApiResponse of GetChildAccountCreationStatus - ApiResponse GetChildAccountCreationStatusWithHttpInfo (string childAuthKey); + ApiResponse GetChildAccountCreationStatusWithHttpInfo (string childIdentifier); /// /// Get all sender domains for a specific child account /// @@ -209,9 +209,9 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// GetChildDomains - GetChildDomains GetChildDomains (string childAuthKey); + GetChildDomains GetChildDomains (string childIdentifier); /// /// Get all sender domains for a specific child account @@ -220,9 +220,9 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// ApiResponse of GetChildDomains - ApiResponse GetChildDomainsWithHttpInfo (string childAuthKey); + ApiResponse GetChildDomainsWithHttpInfo (string childIdentifier); /// /// Get a child account's details /// @@ -230,9 +230,9 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// GetChildInfo - GetChildInfo GetChildInfo (string childAuthKey); + GetChildInfo GetChildInfo (string childIdentifier); /// /// Get a child account's details @@ -241,9 +241,9 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// ApiResponse of GetChildInfo - ApiResponse GetChildInfoWithHttpInfo (string childAuthKey); + ApiResponse GetChildInfoWithHttpInfo (string childIdentifier); /// /// Get the list of all children accounts /// @@ -274,9 +274,9 @@ public interface IResellerApi : IApiAccessor /// It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// GetSsoToken - GetSsoToken GetSsoToken (string childAuthKey); + GetSsoToken GetSsoToken (string childIdentifier); /// /// Get session token to access Sendinblue (SSO) @@ -285,9 +285,9 @@ public interface IResellerApi : IApiAccessor /// It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// ApiResponse of GetSsoToken - ApiResponse GetSsoTokenWithHttpInfo (string childAuthKey); + ApiResponse GetSsoTokenWithHttpInfo (string childIdentifier); /// /// Remove Email and/or SMS credits from a specific child account /// @@ -295,10 +295,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to remove email or SMS credits from a specific child account /// RemainingCreditModel - RemainingCreditModel RemoveCredits (string childAuthKey, RemoveCredits removeCredits); + RemainingCreditModel RemoveCredits (string childIdentifier, RemoveCredits removeCredits); /// /// Remove Email and/or SMS credits from a specific child account @@ -307,81 +307,81 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to remove email or SMS credits from a specific child account /// ApiResponse of RemainingCreditModel - ApiResponse RemoveCreditsWithHttpInfo (string childAuthKey, RemoveCredits removeCredits); + ApiResponse RemoveCreditsWithHttpInfo (string childIdentifier, RemoveCredits removeCredits); /// - /// Update info of reseller's child account status based on the childAuthKey supplied + /// Update info of reseller's child account status based on the childIdentifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child account status /// - void UpdateChildAccountStatus (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus); + void UpdateChildAccountStatus (string childIdentifier, UpdateChildAccountStatus updateChildAccountStatus); /// - /// Update info of reseller's child account status based on the childAuthKey supplied + /// Update info of reseller's child account status based on the childIdentifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child account status /// ApiResponse of Object(void) - ApiResponse UpdateChildAccountStatusWithHttpInfo (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus); + ApiResponse UpdateChildAccountStatusWithHttpInfo (string childIdentifier, UpdateChildAccountStatus updateChildAccountStatus); /// - /// Update 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 childIdentifier and domainName passed /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be updated /// value to update for sender domain /// - void UpdateChildDomain (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain); + void UpdateChildDomain (string childIdentifier, string domainName, UpdateChildDomain updateChildDomain); /// - /// Update 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 childIdentifier and domainName passed /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be updated /// value to update for sender domain /// ApiResponse of Object(void) - ApiResponse UpdateChildDomainWithHttpInfo (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain); + ApiResponse UpdateChildDomainWithHttpInfo (string childIdentifier, string domainName, UpdateChildDomain updateChildDomain); /// - /// Update info of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the child identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child profile /// - void UpdateResellerChild (string childAuthKey, UpdateChild resellerChild); + void UpdateResellerChild (string childIdentifier, UpdateChild resellerChild); /// - /// Update info of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the child identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child profile /// ApiResponse of Object(void) - ApiResponse UpdateResellerChildWithHttpInfo (string childAuthKey, UpdateChild resellerChild); + ApiResponse UpdateResellerChildWithHttpInfo (string childIdentifier, UpdateChild resellerChild); #endregion Synchronous Operations #region Asynchronous Operations /// @@ -391,10 +391,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to add credit to a specific child account /// Task of RemainingCreditModel - System.Threading.Tasks.Task AddCreditsAsync (string childAuthKey, AddCredits addCredits); + System.Threading.Tasks.Task AddCreditsAsync (string childIdentifier, AddCredits addCredits); /// /// Add Email and/or SMS credits to a specific child account @@ -403,10 +403,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to add credit to a specific child account /// Task of ApiResponse (RemainingCreditModel) - System.Threading.Tasks.Task> AddCreditsAsyncWithHttpInfo (string childAuthKey, AddCredits addCredits); + System.Threading.Tasks.Task> AddCreditsAsyncWithHttpInfo (string childIdentifier, AddCredits addCredits); /// /// Associate a dedicated IP to the child /// @@ -414,10 +414,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to associate /// Task of void - System.Threading.Tasks.Task AssociateIpToChildAsync (string childAuthKey, ManageIp ip); + System.Threading.Tasks.Task AssociateIpToChildAsync (string childIdentifier, ManageIp ip); /// /// Associate a dedicated IP to the child @@ -426,10 +426,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to associate /// Task of ApiResponse - System.Threading.Tasks.Task> AssociateIpToChildAsyncWithHttpInfo (string childAuthKey, ManageIp ip); + System.Threading.Tasks.Task> AssociateIpToChildAsyncWithHttpInfo (string childIdentifier, ManageIp ip); /// /// Create a domain for a child account /// @@ -437,10 +437,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Sender domain to add for a specific child account. This will not be displayed to the parent account. /// Task of void - System.Threading.Tasks.Task CreateChildDomainAsync (string childAuthKey, AddChildDomain addChildDomain); + System.Threading.Tasks.Task CreateChildDomainAsync (string childIdentifier, AddChildDomain addChildDomain); /// /// Create a domain for a child account @@ -449,10 +449,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Sender domain to add for a specific child account. This will not be displayed to the parent account. /// Task of ApiResponse - System.Threading.Tasks.Task> CreateChildDomainAsyncWithHttpInfo (string childAuthKey, AddChildDomain addChildDomain); + System.Threading.Tasks.Task> CreateChildDomainAsyncWithHttpInfo (string childIdentifier, AddChildDomain addChildDomain); /// /// Creates a reseller child /// @@ -475,49 +475,49 @@ public interface IResellerApi : IApiAccessor /// Task of ApiResponse (CreateReseller) System.Threading.Tasks.Task> CreateResellerChildAsyncWithHttpInfo (CreateChild resellerChild = null); /// - /// Delete 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 childIdentifier and domainName passed /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be deleted /// Task of void - System.Threading.Tasks.Task DeleteChildDomainAsync (string childAuthKey, string domainName); + System.Threading.Tasks.Task DeleteChildDomainAsync (string childIdentifier, string domainName); /// - /// Delete 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 childIdentifier and domainName passed /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be deleted /// Task of ApiResponse - System.Threading.Tasks.Task> DeleteChildDomainAsyncWithHttpInfo (string childAuthKey, string domainName); + System.Threading.Tasks.Task> DeleteChildDomainAsyncWithHttpInfo (string childIdentifier, string domainName); /// - /// Delete a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the child identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or child id of reseller's child /// Task of void - System.Threading.Tasks.Task DeleteResellerChildAsync (string childAuthKey); + System.Threading.Tasks.Task DeleteResellerChildAsync (string childIdentifier); /// - /// Delete a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the child identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or child id of reseller's child /// Task of ApiResponse - System.Threading.Tasks.Task> DeleteResellerChildAsyncWithHttpInfo (string childAuthKey); + System.Threading.Tasks.Task> DeleteResellerChildAsyncWithHttpInfo (string childIdentifier); /// /// Dissociate a dedicated IP to the child /// @@ -525,10 +525,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to dissociate /// Task of void - System.Threading.Tasks.Task DissociateIpFromChildAsync (string childAuthKey, ManageIp ip); + System.Threading.Tasks.Task DissociateIpFromChildAsync (string childIdentifier, ManageIp ip); /// /// Dissociate a dedicated IP to the child @@ -537,31 +537,31 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to dissociate /// Task of ApiResponse - System.Threading.Tasks.Task> DissociateIpFromChildAsyncWithHttpInfo (string childAuthKey, ManageIp ip); + System.Threading.Tasks.Task> DissociateIpFromChildAsyncWithHttpInfo (string childIdentifier, ManageIp ip); /// - /// Get the status of a 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 identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of GetChildAccountCreationStatus - System.Threading.Tasks.Task GetChildAccountCreationStatusAsync (string childAuthKey); + System.Threading.Tasks.Task GetChildAccountCreationStatusAsync (string childIdentifier); /// - /// Get the status of a 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 identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of ApiResponse (GetChildAccountCreationStatus) - System.Threading.Tasks.Task> GetChildAccountCreationStatusAsyncWithHttpInfo (string childAuthKey); + System.Threading.Tasks.Task> GetChildAccountCreationStatusAsyncWithHttpInfo (string childIdentifier); /// /// Get all sender domains for a specific child account /// @@ -569,9 +569,9 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of GetChildDomains - System.Threading.Tasks.Task GetChildDomainsAsync (string childAuthKey); + System.Threading.Tasks.Task GetChildDomainsAsync (string childIdentifier); /// /// Get all sender domains for a specific child account @@ -580,9 +580,9 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of ApiResponse (GetChildDomains) - System.Threading.Tasks.Task> GetChildDomainsAsyncWithHttpInfo (string childAuthKey); + System.Threading.Tasks.Task> GetChildDomainsAsyncWithHttpInfo (string childIdentifier); /// /// Get a child account's details /// @@ -590,9 +590,9 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of GetChildInfo - System.Threading.Tasks.Task GetChildInfoAsync (string childAuthKey); + System.Threading.Tasks.Task GetChildInfoAsync (string childIdentifier); /// /// Get a child account's details @@ -601,9 +601,9 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of ApiResponse (GetChildInfo) - System.Threading.Tasks.Task> GetChildInfoAsyncWithHttpInfo (string childAuthKey); + System.Threading.Tasks.Task> GetChildInfoAsyncWithHttpInfo (string childIdentifier); /// /// Get the list of all children accounts /// @@ -634,9 +634,9 @@ public interface IResellerApi : IApiAccessor /// It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of GetSsoToken - System.Threading.Tasks.Task GetSsoTokenAsync (string childAuthKey); + System.Threading.Tasks.Task GetSsoTokenAsync (string childIdentifier); /// /// Get session token to access Sendinblue (SSO) @@ -645,9 +645,9 @@ public interface IResellerApi : IApiAccessor /// It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of ApiResponse (GetSsoToken) - System.Threading.Tasks.Task> GetSsoTokenAsyncWithHttpInfo (string childAuthKey); + System.Threading.Tasks.Task> GetSsoTokenAsyncWithHttpInfo (string childIdentifier); /// /// Remove Email and/or SMS credits from a specific child account /// @@ -655,10 +655,10 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to remove email or SMS credits from a specific child account /// Task of RemainingCreditModel - System.Threading.Tasks.Task RemoveCreditsAsync (string childAuthKey, RemoveCredits removeCredits); + System.Threading.Tasks.Task RemoveCreditsAsync (string childIdentifier, RemoveCredits removeCredits); /// /// Remove Email and/or SMS credits from a specific child account @@ -667,81 +667,81 @@ public interface IResellerApi : IApiAccessor /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to remove email or SMS credits from a specific child account /// Task of ApiResponse (RemainingCreditModel) - System.Threading.Tasks.Task> RemoveCreditsAsyncWithHttpInfo (string childAuthKey, RemoveCredits removeCredits); + System.Threading.Tasks.Task> RemoveCreditsAsyncWithHttpInfo (string childIdentifier, RemoveCredits removeCredits); /// - /// Update info of reseller's child account status based on the childAuthKey supplied + /// Update info of reseller's child account status based on the childIdentifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child account status /// Task of void - System.Threading.Tasks.Task UpdateChildAccountStatusAsync (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus); + System.Threading.Tasks.Task UpdateChildAccountStatusAsync (string childIdentifier, UpdateChildAccountStatus updateChildAccountStatus); /// - /// Update info of reseller's child account status based on the childAuthKey supplied + /// Update info of reseller's child account status based on the childIdentifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child account status /// Task of ApiResponse - System.Threading.Tasks.Task> UpdateChildAccountStatusAsyncWithHttpInfo (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus); + System.Threading.Tasks.Task> UpdateChildAccountStatusAsyncWithHttpInfo (string childIdentifier, UpdateChildAccountStatus updateChildAccountStatus); /// - /// Update 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 childIdentifier and domainName passed /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be updated /// value to update for sender domain /// Task of void - System.Threading.Tasks.Task UpdateChildDomainAsync (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain); + System.Threading.Tasks.Task UpdateChildDomainAsync (string childIdentifier, string domainName, UpdateChildDomain updateChildDomain); /// - /// Update 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 childIdentifier and domainName passed /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be updated /// value to update for sender domain /// Task of ApiResponse - System.Threading.Tasks.Task> UpdateChildDomainAsyncWithHttpInfo (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain); + System.Threading.Tasks.Task> UpdateChildDomainAsyncWithHttpInfo (string childIdentifier, string domainName, UpdateChildDomain updateChildDomain); /// - /// Update info of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the child identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child profile /// Task of void - System.Threading.Tasks.Task UpdateResellerChildAsync (string childAuthKey, UpdateChild resellerChild); + System.Threading.Tasks.Task UpdateResellerChildAsync (string childIdentifier, UpdateChild resellerChild); /// - /// Update info of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the child identifier supplied /// /// /// /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child profile /// Task of ApiResponse - System.Threading.Tasks.Task> UpdateResellerChildAsyncWithHttpInfo (string childAuthKey, UpdateChild resellerChild); + System.Threading.Tasks.Task> UpdateResellerChildAsyncWithHttpInfo (string childIdentifier, UpdateChild resellerChild); #endregion Asynchronous Operations } @@ -846,12 +846,12 @@ public void AddDefaultHeader(string key, string value) /// Add Email and/or SMS credits to a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to add credit to a specific child account /// RemainingCreditModel - public RemainingCreditModel AddCredits (string childAuthKey, AddCredits addCredits) + public RemainingCreditModel AddCredits (string childIdentifier, AddCredits addCredits) { - ApiResponse localVarResponse = AddCreditsWithHttpInfo(childAuthKey, addCredits); + ApiResponse localVarResponse = AddCreditsWithHttpInfo(childIdentifier, addCredits); return localVarResponse.Data; } @@ -859,19 +859,19 @@ public RemainingCreditModel AddCredits (string childAuthKey, AddCredits addCredi /// Add Email and/or SMS credits to a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to add credit to a specific child account /// ApiResponse of RemainingCreditModel - public ApiResponse< RemainingCreditModel > AddCreditsWithHttpInfo (string childAuthKey, AddCredits addCredits) + public ApiResponse< RemainingCreditModel > AddCreditsWithHttpInfo (string childIdentifier, AddCredits addCredits) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->AddCredits"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->AddCredits"); // verify the required parameter 'addCredits' is set if (addCredits == null) throw new ApiException(400, "Missing required parameter 'addCredits' when calling ResellerApi->AddCredits"); - var localVarPath = "./reseller/children/{childAuthKey}/credits/add"; + var localVarPath = "./reseller/children/{childIdentifier}/credits/add"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -893,7 +893,7 @@ public ApiResponse< RemainingCreditModel > AddCreditsWithHttpInfo (string childA if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (addCredits != null && addCredits.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(addCredits); // http body (model) parameter @@ -936,12 +936,12 @@ public ApiResponse< RemainingCreditModel > AddCreditsWithHttpInfo (string childA /// Add Email and/or SMS credits to a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to add credit to a specific child account /// Task of RemainingCreditModel - public async System.Threading.Tasks.Task AddCreditsAsync (string childAuthKey, AddCredits addCredits) + public async System.Threading.Tasks.Task AddCreditsAsync (string childIdentifier, AddCredits addCredits) { - ApiResponse localVarResponse = await AddCreditsAsyncWithHttpInfo(childAuthKey, addCredits); + ApiResponse localVarResponse = await AddCreditsAsyncWithHttpInfo(childIdentifier, addCredits); return localVarResponse.Data; } @@ -950,19 +950,19 @@ public async System.Threading.Tasks.Task AddCreditsAsync ( /// Add Email and/or SMS credits to a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to add credit to a specific child account /// Task of ApiResponse (RemainingCreditModel) - public async System.Threading.Tasks.Task> AddCreditsAsyncWithHttpInfo (string childAuthKey, AddCredits addCredits) + public async System.Threading.Tasks.Task> AddCreditsAsyncWithHttpInfo (string childIdentifier, AddCredits addCredits) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->AddCredits"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->AddCredits"); // verify the required parameter 'addCredits' is set if (addCredits == null) throw new ApiException(400, "Missing required parameter 'addCredits' when calling ResellerApi->AddCredits"); - var localVarPath = "./reseller/children/{childAuthKey}/credits/add"; + var localVarPath = "./reseller/children/{childIdentifier}/credits/add"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -984,7 +984,7 @@ public async System.Threading.Tasks.Task> AddC if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (addCredits != null && addCredits.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(addCredits); // http body (model) parameter @@ -1027,31 +1027,31 @@ public async System.Threading.Tasks.Task> AddC /// Associate a dedicated IP to the child /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to associate /// - public void AssociateIpToChild (string childAuthKey, ManageIp ip) + public void AssociateIpToChild (string childIdentifier, ManageIp ip) { - AssociateIpToChildWithHttpInfo(childAuthKey, ip); + AssociateIpToChildWithHttpInfo(childIdentifier, ip); } /// /// Associate a dedicated IP to the child /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to associate /// ApiResponse of Object(void) - public ApiResponse AssociateIpToChildWithHttpInfo (string childAuthKey, ManageIp ip) + public ApiResponse AssociateIpToChildWithHttpInfo (string childIdentifier, ManageIp ip) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->AssociateIpToChild"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->AssociateIpToChild"); // verify the required parameter 'ip' is set if (ip == null) throw new ApiException(400, "Missing required parameter 'ip' when calling ResellerApi->AssociateIpToChild"); - var localVarPath = "./reseller/children/{childAuthKey}/ips/associate"; + var localVarPath = "./reseller/children/{childIdentifier}/ips/associate"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -1073,7 +1073,7 @@ public ApiResponse AssociateIpToChildWithHttpInfo (string childAuthKey, if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (ip != null && ip.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(ip); // http body (model) parameter @@ -1116,12 +1116,12 @@ public ApiResponse AssociateIpToChildWithHttpInfo (string childAuthKey, /// Associate a dedicated IP to the child /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to associate /// Task of void - public async System.Threading.Tasks.Task AssociateIpToChildAsync (string childAuthKey, ManageIp ip) + public async System.Threading.Tasks.Task AssociateIpToChildAsync (string childIdentifier, ManageIp ip) { - await AssociateIpToChildAsyncWithHttpInfo(childAuthKey, ip); + await AssociateIpToChildAsyncWithHttpInfo(childIdentifier, ip); } @@ -1129,19 +1129,19 @@ public async System.Threading.Tasks.Task AssociateIpToChildAsync (string childAu /// Associate a dedicated IP to the child /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to associate /// Task of ApiResponse - public async System.Threading.Tasks.Task> AssociateIpToChildAsyncWithHttpInfo (string childAuthKey, ManageIp ip) + public async System.Threading.Tasks.Task> AssociateIpToChildAsyncWithHttpInfo (string childIdentifier, ManageIp ip) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->AssociateIpToChild"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->AssociateIpToChild"); // verify the required parameter 'ip' is set if (ip == null) throw new ApiException(400, "Missing required parameter 'ip' when calling ResellerApi->AssociateIpToChild"); - var localVarPath = "./reseller/children/{childAuthKey}/ips/associate"; + var localVarPath = "./reseller/children/{childIdentifier}/ips/associate"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -1163,7 +1163,7 @@ public async System.Threading.Tasks.Task> AssociateIpToChild if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (ip != null && ip.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(ip); // http body (model) parameter @@ -1206,31 +1206,31 @@ public async System.Threading.Tasks.Task> AssociateIpToChild /// Create a domain for a child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Sender domain to add for a specific child account. This will not be displayed to the parent account. /// - public void CreateChildDomain (string childAuthKey, AddChildDomain addChildDomain) + public void CreateChildDomain (string childIdentifier, AddChildDomain addChildDomain) { - CreateChildDomainWithHttpInfo(childAuthKey, addChildDomain); + CreateChildDomainWithHttpInfo(childIdentifier, addChildDomain); } /// /// Create a domain for a child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Sender domain to add for a specific child account. This will not be displayed to the parent account. /// ApiResponse of Object(void) - public ApiResponse CreateChildDomainWithHttpInfo (string childAuthKey, AddChildDomain addChildDomain) + public ApiResponse CreateChildDomainWithHttpInfo (string childIdentifier, AddChildDomain addChildDomain) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->CreateChildDomain"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->CreateChildDomain"); // verify the required parameter 'addChildDomain' is set if (addChildDomain == null) throw new ApiException(400, "Missing required parameter 'addChildDomain' when calling ResellerApi->CreateChildDomain"); - var localVarPath = "./reseller/children/{childAuthKey}/domains"; + var localVarPath = "./reseller/children/{childIdentifier}/domains"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -1252,7 +1252,7 @@ public ApiResponse CreateChildDomainWithHttpInfo (string childAuthKey, A if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (addChildDomain != null && addChildDomain.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(addChildDomain); // http body (model) parameter @@ -1295,12 +1295,12 @@ public ApiResponse CreateChildDomainWithHttpInfo (string childAuthKey, A /// Create a domain for a child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Sender domain to add for a specific child account. This will not be displayed to the parent account. /// Task of void - public async System.Threading.Tasks.Task CreateChildDomainAsync (string childAuthKey, AddChildDomain addChildDomain) + public async System.Threading.Tasks.Task CreateChildDomainAsync (string childIdentifier, AddChildDomain addChildDomain) { - await CreateChildDomainAsyncWithHttpInfo(childAuthKey, addChildDomain); + await CreateChildDomainAsyncWithHttpInfo(childIdentifier, addChildDomain); } @@ -1308,19 +1308,19 @@ public async System.Threading.Tasks.Task CreateChildDomainAsync (string childAut /// Create a domain for a child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Sender domain to add for a specific child account. This will not be displayed to the parent account. /// Task of ApiResponse - public async System.Threading.Tasks.Task> CreateChildDomainAsyncWithHttpInfo (string childAuthKey, AddChildDomain addChildDomain) + public async System.Threading.Tasks.Task> CreateChildDomainAsyncWithHttpInfo (string childIdentifier, AddChildDomain addChildDomain) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->CreateChildDomain"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->CreateChildDomain"); // verify the required parameter 'addChildDomain' is set if (addChildDomain == null) throw new ApiException(400, "Missing required parameter 'addChildDomain' when calling ResellerApi->CreateChildDomain"); - var localVarPath = "./reseller/children/{childAuthKey}/domains"; + var localVarPath = "./reseller/children/{childIdentifier}/domains"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -1342,7 +1342,7 @@ public async System.Threading.Tasks.Task> CreateChildDomainA if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (addChildDomain != null && addChildDomain.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(addChildDomain); // http body (model) parameter @@ -1545,34 +1545,34 @@ public async System.Threading.Tasks.Task> CreateRese } /// - /// Delete 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 childIdentifier and domainName passed /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be deleted /// - public void DeleteChildDomain (string childAuthKey, string domainName) + public void DeleteChildDomain (string childIdentifier, string domainName) { - DeleteChildDomainWithHttpInfo(childAuthKey, domainName); + DeleteChildDomainWithHttpInfo(childIdentifier, domainName); } /// - /// Delete 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 childIdentifier and domainName passed /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be deleted /// ApiResponse of Object(void) - public ApiResponse DeleteChildDomainWithHttpInfo (string childAuthKey, string domainName) + public ApiResponse DeleteChildDomainWithHttpInfo (string childIdentifier, string domainName) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->DeleteChildDomain"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->DeleteChildDomain"); // verify the required parameter 'domainName' is set if (domainName == null) throw new ApiException(400, "Missing required parameter 'domainName' when calling ResellerApi->DeleteChildDomain"); - var localVarPath = "./reseller/children/{childAuthKey}/domains/{domainName}"; + var localVarPath = "./reseller/children/{childIdentifier}/domains/{domainName}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -1594,7 +1594,7 @@ public ApiResponse DeleteChildDomainWithHttpInfo (string childAuthKey, s if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (domainName != null) localVarPathParams.Add("domainName", this.Configuration.ApiClient.ParameterToString(domainName)); // path parameter // authentication (api-key) required @@ -1627,35 +1627,35 @@ public ApiResponse DeleteChildDomainWithHttpInfo (string childAuthKey, s } /// - /// Delete 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 childIdentifier and domainName passed /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be deleted /// Task of void - public async System.Threading.Tasks.Task DeleteChildDomainAsync (string childAuthKey, string domainName) + public async System.Threading.Tasks.Task DeleteChildDomainAsync (string childIdentifier, string domainName) { - await DeleteChildDomainAsyncWithHttpInfo(childAuthKey, domainName); + await DeleteChildDomainAsyncWithHttpInfo(childIdentifier, domainName); } /// - /// Delete 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 childIdentifier and domainName passed /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be deleted /// Task of ApiResponse - public async System.Threading.Tasks.Task> DeleteChildDomainAsyncWithHttpInfo (string childAuthKey, string domainName) + public async System.Threading.Tasks.Task> DeleteChildDomainAsyncWithHttpInfo (string childIdentifier, string domainName) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->DeleteChildDomain"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->DeleteChildDomain"); // verify the required parameter 'domainName' is set if (domainName == null) throw new ApiException(400, "Missing required parameter 'domainName' when calling ResellerApi->DeleteChildDomain"); - var localVarPath = "./reseller/children/{childAuthKey}/domains/{domainName}"; + var localVarPath = "./reseller/children/{childIdentifier}/domains/{domainName}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -1677,7 +1677,7 @@ public async System.Threading.Tasks.Task> DeleteChildDomainA if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (domainName != null) localVarPathParams.Add("domainName", this.Configuration.ApiClient.ParameterToString(domainName)); // path parameter // authentication (api-key) required @@ -1710,29 +1710,29 @@ public async System.Threading.Tasks.Task> DeleteChildDomainA } /// - /// Delete a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the child identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or child id of reseller's child /// - public void DeleteResellerChild (string childAuthKey) + public void DeleteResellerChild (string childIdentifier) { - DeleteResellerChildWithHttpInfo(childAuthKey); + DeleteResellerChildWithHttpInfo(childIdentifier); } /// - /// Delete a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the child identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or child id of reseller's child /// ApiResponse of Object(void) - public ApiResponse DeleteResellerChildWithHttpInfo (string childAuthKey) + public ApiResponse DeleteResellerChildWithHttpInfo (string childIdentifier) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->DeleteResellerChild"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->DeleteResellerChild"); - var localVarPath = "./reseller/children/{childAuthKey}"; + var localVarPath = "./reseller/children/{childIdentifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -1754,7 +1754,7 @@ public ApiResponse DeleteResellerChildWithHttpInfo (string childAuthKey) if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -1786,30 +1786,30 @@ public ApiResponse DeleteResellerChildWithHttpInfo (string childAuthKey) } /// - /// Delete a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the child identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or child id of reseller's child /// Task of void - public async System.Threading.Tasks.Task DeleteResellerChildAsync (string childAuthKey) + public async System.Threading.Tasks.Task DeleteResellerChildAsync (string childIdentifier) { - await DeleteResellerChildAsyncWithHttpInfo(childAuthKey); + await DeleteResellerChildAsyncWithHttpInfo(childIdentifier); } /// - /// Delete a single reseller child based on the childAuthKey supplied + /// Delete a single reseller child based on the child identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or child id of reseller's child /// Task of ApiResponse - public async System.Threading.Tasks.Task> DeleteResellerChildAsyncWithHttpInfo (string childAuthKey) + public async System.Threading.Tasks.Task> DeleteResellerChildAsyncWithHttpInfo (string childIdentifier) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->DeleteResellerChild"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->DeleteResellerChild"); - var localVarPath = "./reseller/children/{childAuthKey}"; + var localVarPath = "./reseller/children/{childIdentifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -1831,7 +1831,7 @@ public async System.Threading.Tasks.Task> DeleteResellerChil if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -1866,31 +1866,31 @@ public async System.Threading.Tasks.Task> DeleteResellerChil /// Dissociate a dedicated IP to the child /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to dissociate /// - public void DissociateIpFromChild (string childAuthKey, ManageIp ip) + public void DissociateIpFromChild (string childIdentifier, ManageIp ip) { - DissociateIpFromChildWithHttpInfo(childAuthKey, ip); + DissociateIpFromChildWithHttpInfo(childIdentifier, ip); } /// /// Dissociate a dedicated IP to the child /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to dissociate /// ApiResponse of Object(void) - public ApiResponse DissociateIpFromChildWithHttpInfo (string childAuthKey, ManageIp ip) + public ApiResponse DissociateIpFromChildWithHttpInfo (string childIdentifier, ManageIp ip) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->DissociateIpFromChild"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->DissociateIpFromChild"); // verify the required parameter 'ip' is set if (ip == null) throw new ApiException(400, "Missing required parameter 'ip' when calling ResellerApi->DissociateIpFromChild"); - var localVarPath = "./reseller/children/{childAuthKey}/ips/dissociate"; + var localVarPath = "./reseller/children/{childIdentifier}/ips/dissociate"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -1912,7 +1912,7 @@ public ApiResponse DissociateIpFromChildWithHttpInfo (string childAuthKe if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (ip != null && ip.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(ip); // http body (model) parameter @@ -1955,12 +1955,12 @@ public ApiResponse DissociateIpFromChildWithHttpInfo (string childAuthKe /// Dissociate a dedicated IP to the child /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to dissociate /// Task of void - public async System.Threading.Tasks.Task DissociateIpFromChildAsync (string childAuthKey, ManageIp ip) + public async System.Threading.Tasks.Task DissociateIpFromChildAsync (string childIdentifier, ManageIp ip) { - await DissociateIpFromChildAsyncWithHttpInfo(childAuthKey, ip); + await DissociateIpFromChildAsyncWithHttpInfo(childIdentifier, ip); } @@ -1968,19 +1968,19 @@ public async System.Threading.Tasks.Task DissociateIpFromChildAsync (string chil /// Dissociate a dedicated IP to the child /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// IP to dissociate /// Task of ApiResponse - public async System.Threading.Tasks.Task> DissociateIpFromChildAsyncWithHttpInfo (string childAuthKey, ManageIp ip) + public async System.Threading.Tasks.Task> DissociateIpFromChildAsyncWithHttpInfo (string childIdentifier, ManageIp ip) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->DissociateIpFromChild"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->DissociateIpFromChild"); // verify the required parameter 'ip' is set if (ip == null) throw new ApiException(400, "Missing required parameter 'ip' when calling ResellerApi->DissociateIpFromChild"); - var localVarPath = "./reseller/children/{childAuthKey}/ips/dissociate"; + var localVarPath = "./reseller/children/{childIdentifier}/ips/dissociate"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2002,7 +2002,7 @@ public async System.Threading.Tasks.Task> DissociateIpFromCh if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (ip != null && ip.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(ip); // http body (model) parameter @@ -2042,30 +2042,30 @@ public async System.Threading.Tasks.Task> DissociateIpFromCh } /// - /// Get the status of a 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 identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// GetChildAccountCreationStatus - public GetChildAccountCreationStatus GetChildAccountCreationStatus (string childAuthKey) + public GetChildAccountCreationStatus GetChildAccountCreationStatus (string childIdentifier) { - ApiResponse localVarResponse = GetChildAccountCreationStatusWithHttpInfo(childAuthKey); + ApiResponse localVarResponse = GetChildAccountCreationStatusWithHttpInfo(childIdentifier); return localVarResponse.Data; } /// - /// Get the status of a 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 identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// ApiResponse of GetChildAccountCreationStatus - public ApiResponse< GetChildAccountCreationStatus > GetChildAccountCreationStatusWithHttpInfo (string childAuthKey) + public ApiResponse< GetChildAccountCreationStatus > GetChildAccountCreationStatusWithHttpInfo (string childIdentifier) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->GetChildAccountCreationStatus"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->GetChildAccountCreationStatus"); - var localVarPath = "./reseller/children/{childAuthKey}/accountCreationStatus"; + var localVarPath = "./reseller/children/{childIdentifier}/accountCreationStatus"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2087,7 +2087,7 @@ public ApiResponse< GetChildAccountCreationStatus > GetChildAccountCreationStatu if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -2119,31 +2119,31 @@ public ApiResponse< GetChildAccountCreationStatus > GetChildAccountCreationStatu } /// - /// Get the status of a 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 identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of GetChildAccountCreationStatus - public async System.Threading.Tasks.Task GetChildAccountCreationStatusAsync (string childAuthKey) + public async System.Threading.Tasks.Task GetChildAccountCreationStatusAsync (string childIdentifier) { - ApiResponse localVarResponse = await GetChildAccountCreationStatusAsyncWithHttpInfo(childAuthKey); + ApiResponse localVarResponse = await GetChildAccountCreationStatusAsyncWithHttpInfo(childIdentifier); return localVarResponse.Data; } /// - /// Get the status of a 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 identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of ApiResponse (GetChildAccountCreationStatus) - public async System.Threading.Tasks.Task> GetChildAccountCreationStatusAsyncWithHttpInfo (string childAuthKey) + public async System.Threading.Tasks.Task> GetChildAccountCreationStatusAsyncWithHttpInfo (string childIdentifier) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->GetChildAccountCreationStatus"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->GetChildAccountCreationStatus"); - var localVarPath = "./reseller/children/{childAuthKey}/accountCreationStatus"; + var localVarPath = "./reseller/children/{childIdentifier}/accountCreationStatus"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2165,7 +2165,7 @@ public async System.Threading.Tasks.Task /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// GetChildDomains - public GetChildDomains GetChildDomains (string childAuthKey) + public GetChildDomains GetChildDomains (string childIdentifier) { - ApiResponse localVarResponse = GetChildDomainsWithHttpInfo(childAuthKey); + ApiResponse localVarResponse = GetChildDomainsWithHttpInfo(childIdentifier); return localVarResponse.Data; } @@ -2212,15 +2212,15 @@ public GetChildDomains GetChildDomains (string childAuthKey) /// Get all sender domains for a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// ApiResponse of GetChildDomains - public ApiResponse< GetChildDomains > GetChildDomainsWithHttpInfo (string childAuthKey) + public ApiResponse< GetChildDomains > GetChildDomainsWithHttpInfo (string childIdentifier) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->GetChildDomains"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->GetChildDomains"); - var localVarPath = "./reseller/children/{childAuthKey}/domains"; + var localVarPath = "./reseller/children/{childIdentifier}/domains"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2242,7 +2242,7 @@ public ApiResponse< GetChildDomains > GetChildDomainsWithHttpInfo (string childA if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -2277,11 +2277,11 @@ public ApiResponse< GetChildDomains > GetChildDomainsWithHttpInfo (string childA /// Get all sender domains for a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of GetChildDomains - public async System.Threading.Tasks.Task GetChildDomainsAsync (string childAuthKey) + public async System.Threading.Tasks.Task GetChildDomainsAsync (string childIdentifier) { - ApiResponse localVarResponse = await GetChildDomainsAsyncWithHttpInfo(childAuthKey); + ApiResponse localVarResponse = await GetChildDomainsAsyncWithHttpInfo(childIdentifier); return localVarResponse.Data; } @@ -2290,15 +2290,15 @@ public async System.Threading.Tasks.Task GetChildDomainsAsync ( /// Get all sender domains for a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of ApiResponse (GetChildDomains) - public async System.Threading.Tasks.Task> GetChildDomainsAsyncWithHttpInfo (string childAuthKey) + public async System.Threading.Tasks.Task> GetChildDomainsAsyncWithHttpInfo (string childIdentifier) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->GetChildDomains"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->GetChildDomains"); - var localVarPath = "./reseller/children/{childAuthKey}/domains"; + var localVarPath = "./reseller/children/{childIdentifier}/domains"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2320,7 +2320,7 @@ public async System.Threading.Tasks.Task> GetChildD if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -2355,11 +2355,11 @@ public async System.Threading.Tasks.Task> GetChildD /// Get a child account's details /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// GetChildInfo - public GetChildInfo GetChildInfo (string childAuthKey) + public GetChildInfo GetChildInfo (string childIdentifier) { - ApiResponse localVarResponse = GetChildInfoWithHttpInfo(childAuthKey); + ApiResponse localVarResponse = GetChildInfoWithHttpInfo(childIdentifier); return localVarResponse.Data; } @@ -2367,15 +2367,15 @@ public GetChildInfo GetChildInfo (string childAuthKey) /// Get a child account's details /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// ApiResponse of GetChildInfo - public ApiResponse< GetChildInfo > GetChildInfoWithHttpInfo (string childAuthKey) + public ApiResponse< GetChildInfo > GetChildInfoWithHttpInfo (string childIdentifier) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->GetChildInfo"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->GetChildInfo"); - var localVarPath = "./reseller/children/{childAuthKey}"; + var localVarPath = "./reseller/children/{childIdentifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2397,7 +2397,7 @@ public ApiResponse< GetChildInfo > GetChildInfoWithHttpInfo (string childAuthKey if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -2432,11 +2432,11 @@ public ApiResponse< GetChildInfo > GetChildInfoWithHttpInfo (string childAuthKey /// Get a child account's details /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of GetChildInfo - public async System.Threading.Tasks.Task GetChildInfoAsync (string childAuthKey) + public async System.Threading.Tasks.Task GetChildInfoAsync (string childIdentifier) { - ApiResponse localVarResponse = await GetChildInfoAsyncWithHttpInfo(childAuthKey); + ApiResponse localVarResponse = await GetChildInfoAsyncWithHttpInfo(childIdentifier); return localVarResponse.Data; } @@ -2445,15 +2445,15 @@ public async System.Threading.Tasks.Task GetChildInfoAsync (string /// Get a child account's details /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of ApiResponse (GetChildInfo) - public async System.Threading.Tasks.Task> GetChildInfoAsyncWithHttpInfo (string childAuthKey) + public async System.Threading.Tasks.Task> GetChildInfoAsyncWithHttpInfo (string childIdentifier) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->GetChildInfo"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->GetChildInfo"); - var localVarPath = "./reseller/children/{childAuthKey}"; + var localVarPath = "./reseller/children/{childIdentifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2475,7 +2475,7 @@ public async System.Threading.Tasks.Task> GetChildInfo if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -2665,11 +2665,11 @@ public async System.Threading.Tasks.Task> GetResell /// Get session token to access Sendinblue (SSO) It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// GetSsoToken - public GetSsoToken GetSsoToken (string childAuthKey) + public GetSsoToken GetSsoToken (string childIdentifier) { - ApiResponse localVarResponse = GetSsoTokenWithHttpInfo(childAuthKey); + ApiResponse localVarResponse = GetSsoTokenWithHttpInfo(childIdentifier); return localVarResponse.Data; } @@ -2677,15 +2677,15 @@ public GetSsoToken GetSsoToken (string childAuthKey) /// Get session token to access Sendinblue (SSO) It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// ApiResponse of GetSsoToken - public ApiResponse< GetSsoToken > GetSsoTokenWithHttpInfo (string childAuthKey) + public ApiResponse< GetSsoToken > GetSsoTokenWithHttpInfo (string childIdentifier) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->GetSsoToken"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->GetSsoToken"); - var localVarPath = "./reseller/children/{childAuthKey}/auth"; + var localVarPath = "./reseller/children/{childIdentifier}/auth"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2707,7 +2707,7 @@ public ApiResponse< GetSsoToken > GetSsoTokenWithHttpInfo (string childAuthKey) if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -2742,11 +2742,11 @@ public ApiResponse< GetSsoToken > GetSsoTokenWithHttpInfo (string childAuthKey) /// Get session token to access Sendinblue (SSO) It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of GetSsoToken - public async System.Threading.Tasks.Task GetSsoTokenAsync (string childAuthKey) + public async System.Threading.Tasks.Task GetSsoTokenAsync (string childIdentifier) { - ApiResponse localVarResponse = await GetSsoTokenAsyncWithHttpInfo(childAuthKey); + ApiResponse localVarResponse = await GetSsoTokenAsyncWithHttpInfo(childIdentifier); return localVarResponse.Data; } @@ -2755,15 +2755,15 @@ public async System.Threading.Tasks.Task GetSsoTokenAsync (string c /// Get session token to access Sendinblue (SSO) It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Task of ApiResponse (GetSsoToken) - public async System.Threading.Tasks.Task> GetSsoTokenAsyncWithHttpInfo (string childAuthKey) + public async System.Threading.Tasks.Task> GetSsoTokenAsyncWithHttpInfo (string childIdentifier) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->GetSsoToken"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->GetSsoToken"); - var localVarPath = "./reseller/children/{childAuthKey}/auth"; + var localVarPath = "./reseller/children/{childIdentifier}/auth"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2785,7 +2785,7 @@ public async System.Threading.Tasks.Task> GetSsoTokenAs if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter // authentication (api-key) required if (!String.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("api-key"))) @@ -2820,12 +2820,12 @@ public async System.Threading.Tasks.Task> GetSsoTokenAs /// Remove Email and/or SMS credits from a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to remove email or SMS credits from a specific child account /// RemainingCreditModel - public RemainingCreditModel RemoveCredits (string childAuthKey, RemoveCredits removeCredits) + public RemainingCreditModel RemoveCredits (string childIdentifier, RemoveCredits removeCredits) { - ApiResponse localVarResponse = RemoveCreditsWithHttpInfo(childAuthKey, removeCredits); + ApiResponse localVarResponse = RemoveCreditsWithHttpInfo(childIdentifier, removeCredits); return localVarResponse.Data; } @@ -2833,19 +2833,19 @@ public RemainingCreditModel RemoveCredits (string childAuthKey, RemoveCredits re /// Remove Email and/or SMS credits from a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to remove email or SMS credits from a specific child account /// ApiResponse of RemainingCreditModel - public ApiResponse< RemainingCreditModel > RemoveCreditsWithHttpInfo (string childAuthKey, RemoveCredits removeCredits) + public ApiResponse< RemainingCreditModel > RemoveCreditsWithHttpInfo (string childIdentifier, RemoveCredits removeCredits) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->RemoveCredits"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->RemoveCredits"); // verify the required parameter 'removeCredits' is set if (removeCredits == null) throw new ApiException(400, "Missing required parameter 'removeCredits' when calling ResellerApi->RemoveCredits"); - var localVarPath = "./reseller/children/{childAuthKey}/credits/remove"; + var localVarPath = "./reseller/children/{childIdentifier}/credits/remove"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2867,7 +2867,7 @@ public ApiResponse< RemainingCreditModel > RemoveCreditsWithHttpInfo (string chi if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (removeCredits != null && removeCredits.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(removeCredits); // http body (model) parameter @@ -2910,12 +2910,12 @@ public ApiResponse< RemainingCreditModel > RemoveCreditsWithHttpInfo (string chi /// Remove Email and/or SMS credits from a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to remove email or SMS credits from a specific child account /// Task of RemainingCreditModel - public async System.Threading.Tasks.Task RemoveCreditsAsync (string childAuthKey, RemoveCredits removeCredits) + public async System.Threading.Tasks.Task RemoveCreditsAsync (string childIdentifier, RemoveCredits removeCredits) { - ApiResponse localVarResponse = await RemoveCreditsAsyncWithHttpInfo(childAuthKey, removeCredits); + ApiResponse localVarResponse = await RemoveCreditsAsyncWithHttpInfo(childIdentifier, removeCredits); return localVarResponse.Data; } @@ -2924,19 +2924,19 @@ public async System.Threading.Tasks.Task RemoveCreditsAsyn /// Remove Email and/or SMS credits from a specific child account /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Values to post to remove email or SMS credits from a specific child account /// Task of ApiResponse (RemainingCreditModel) - public async System.Threading.Tasks.Task> RemoveCreditsAsyncWithHttpInfo (string childAuthKey, RemoveCredits removeCredits) + public async System.Threading.Tasks.Task> RemoveCreditsAsyncWithHttpInfo (string childIdentifier, RemoveCredits removeCredits) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->RemoveCredits"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->RemoveCredits"); // verify the required parameter 'removeCredits' is set if (removeCredits == null) throw new ApiException(400, "Missing required parameter 'removeCredits' when calling ResellerApi->RemoveCredits"); - var localVarPath = "./reseller/children/{childAuthKey}/credits/remove"; + var localVarPath = "./reseller/children/{childIdentifier}/credits/remove"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -2958,7 +2958,7 @@ public async System.Threading.Tasks.Task> Remo if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (removeCredits != null && removeCredits.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(removeCredits); // http body (model) parameter @@ -2998,34 +2998,34 @@ public async System.Threading.Tasks.Task> Remo } /// - /// Update info of reseller's child account status based on the childAuthKey supplied + /// Update info of reseller's child account status based on the childIdentifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child account status /// - public void UpdateChildAccountStatus (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus) + public void UpdateChildAccountStatus (string childIdentifier, UpdateChildAccountStatus updateChildAccountStatus) { - UpdateChildAccountStatusWithHttpInfo(childAuthKey, updateChildAccountStatus); + UpdateChildAccountStatusWithHttpInfo(childIdentifier, updateChildAccountStatus); } /// - /// Update info of reseller's child account status based on the childAuthKey supplied + /// Update info of reseller's child account status based on the childIdentifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child account status /// ApiResponse of Object(void) - public ApiResponse UpdateChildAccountStatusWithHttpInfo (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus) + public ApiResponse UpdateChildAccountStatusWithHttpInfo (string childIdentifier, UpdateChildAccountStatus updateChildAccountStatus) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->UpdateChildAccountStatus"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->UpdateChildAccountStatus"); // verify the required parameter 'updateChildAccountStatus' is set if (updateChildAccountStatus == null) throw new ApiException(400, "Missing required parameter 'updateChildAccountStatus' when calling ResellerApi->UpdateChildAccountStatus"); - var localVarPath = "./reseller/children/{childAuthKey}/accountStatus"; + var localVarPath = "./reseller/children/{childIdentifier}/accountStatus"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -3047,7 +3047,7 @@ public ApiResponse UpdateChildAccountStatusWithHttpInfo (string childAut if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (updateChildAccountStatus != null && updateChildAccountStatus.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(updateChildAccountStatus); // http body (model) parameter @@ -3087,35 +3087,35 @@ public ApiResponse UpdateChildAccountStatusWithHttpInfo (string childAut } /// - /// Update info of reseller's child account status based on the childAuthKey supplied + /// Update info of reseller's child account status based on the childIdentifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child account status /// Task of void - public async System.Threading.Tasks.Task UpdateChildAccountStatusAsync (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus) + public async System.Threading.Tasks.Task UpdateChildAccountStatusAsync (string childIdentifier, UpdateChildAccountStatus updateChildAccountStatus) { - await UpdateChildAccountStatusAsyncWithHttpInfo(childAuthKey, updateChildAccountStatus); + await UpdateChildAccountStatusAsyncWithHttpInfo(childIdentifier, updateChildAccountStatus); } /// - /// Update info of reseller's child account status based on the childAuthKey supplied + /// Update info of reseller's child account status based on the childIdentifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child account status /// Task of ApiResponse - public async System.Threading.Tasks.Task> UpdateChildAccountStatusAsyncWithHttpInfo (string childAuthKey, UpdateChildAccountStatus updateChildAccountStatus) + public async System.Threading.Tasks.Task> UpdateChildAccountStatusAsyncWithHttpInfo (string childIdentifier, UpdateChildAccountStatus updateChildAccountStatus) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->UpdateChildAccountStatus"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->UpdateChildAccountStatus"); // verify the required parameter 'updateChildAccountStatus' is set if (updateChildAccountStatus == null) throw new ApiException(400, "Missing required parameter 'updateChildAccountStatus' when calling ResellerApi->UpdateChildAccountStatus"); - var localVarPath = "./reseller/children/{childAuthKey}/accountStatus"; + var localVarPath = "./reseller/children/{childIdentifier}/accountStatus"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -3137,7 +3137,7 @@ public async System.Threading.Tasks.Task> UpdateChildAccount if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (updateChildAccountStatus != null && updateChildAccountStatus.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(updateChildAccountStatus); // http body (model) parameter @@ -3177,31 +3177,31 @@ public async System.Threading.Tasks.Task> UpdateChildAccount } /// - /// Update 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 childIdentifier and domainName passed /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be updated /// value to update for sender domain /// - public void UpdateChildDomain (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain) + public void UpdateChildDomain (string childIdentifier, string domainName, UpdateChildDomain updateChildDomain) { - UpdateChildDomainWithHttpInfo(childAuthKey, domainName, updateChildDomain); + UpdateChildDomainWithHttpInfo(childIdentifier, domainName, updateChildDomain); } /// - /// Update 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 childIdentifier and domainName passed /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be updated /// value to update for sender domain /// ApiResponse of Object(void) - public ApiResponse UpdateChildDomainWithHttpInfo (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain) + public ApiResponse UpdateChildDomainWithHttpInfo (string childIdentifier, string domainName, UpdateChildDomain updateChildDomain) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->UpdateChildDomain"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->UpdateChildDomain"); // verify the required parameter 'domainName' is set if (domainName == null) throw new ApiException(400, "Missing required parameter 'domainName' when calling ResellerApi->UpdateChildDomain"); @@ -3209,7 +3209,7 @@ public ApiResponse UpdateChildDomainWithHttpInfo (string childAuthKey, s if (updateChildDomain == null) throw new ApiException(400, "Missing required parameter 'updateChildDomain' when calling ResellerApi->UpdateChildDomain"); - var localVarPath = "./reseller/children/{childAuthKey}/domains/{domainName}"; + var localVarPath = "./reseller/children/{childIdentifier}/domains/{domainName}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -3231,7 +3231,7 @@ public ApiResponse UpdateChildDomainWithHttpInfo (string childAuthKey, s if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (domainName != null) localVarPathParams.Add("domainName", this.Configuration.ApiClient.ParameterToString(domainName)); // path parameter if (updateChildDomain != null && updateChildDomain.GetType() != typeof(byte[])) { @@ -3272,32 +3272,32 @@ public ApiResponse UpdateChildDomainWithHttpInfo (string childAuthKey, s } /// - /// Update 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 childIdentifier and domainName passed /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be updated /// value to update for sender domain /// Task of void - public async System.Threading.Tasks.Task UpdateChildDomainAsync (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain) + public async System.Threading.Tasks.Task UpdateChildDomainAsync (string childIdentifier, string domainName, UpdateChildDomain updateChildDomain) { - await UpdateChildDomainAsyncWithHttpInfo(childAuthKey, domainName, updateChildDomain); + await UpdateChildDomainAsyncWithHttpInfo(childIdentifier, domainName, updateChildDomain); } /// - /// Update 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 childIdentifier and domainName passed /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// Pass the existing domain that needs to be updated /// value to update for sender domain /// Task of ApiResponse - public async System.Threading.Tasks.Task> UpdateChildDomainAsyncWithHttpInfo (string childAuthKey, string domainName, UpdateChildDomain updateChildDomain) + public async System.Threading.Tasks.Task> UpdateChildDomainAsyncWithHttpInfo (string childIdentifier, string domainName, UpdateChildDomain updateChildDomain) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->UpdateChildDomain"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->UpdateChildDomain"); // verify the required parameter 'domainName' is set if (domainName == null) throw new ApiException(400, "Missing required parameter 'domainName' when calling ResellerApi->UpdateChildDomain"); @@ -3305,7 +3305,7 @@ public async System.Threading.Tasks.Task> UpdateChildDomainA if (updateChildDomain == null) throw new ApiException(400, "Missing required parameter 'updateChildDomain' when calling ResellerApi->UpdateChildDomain"); - var localVarPath = "./reseller/children/{childAuthKey}/domains/{domainName}"; + var localVarPath = "./reseller/children/{childIdentifier}/domains/{domainName}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -3327,7 +3327,7 @@ public async System.Threading.Tasks.Task> UpdateChildDomainA if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (domainName != null) localVarPathParams.Add("domainName", this.Configuration.ApiClient.ParameterToString(domainName)); // path parameter if (updateChildDomain != null && updateChildDomain.GetType() != typeof(byte[])) { @@ -3368,34 +3368,34 @@ public async System.Threading.Tasks.Task> UpdateChildDomainA } /// - /// Update info of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the child identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child profile /// - public void UpdateResellerChild (string childAuthKey, UpdateChild resellerChild) + public void UpdateResellerChild (string childIdentifier, UpdateChild resellerChild) { - UpdateResellerChildWithHttpInfo(childAuthKey, resellerChild); + UpdateResellerChildWithHttpInfo(childIdentifier, resellerChild); } /// - /// Update info of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the child identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child profile /// ApiResponse of Object(void) - public ApiResponse UpdateResellerChildWithHttpInfo (string childAuthKey, UpdateChild resellerChild) + public ApiResponse UpdateResellerChildWithHttpInfo (string childIdentifier, UpdateChild resellerChild) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->UpdateResellerChild"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->UpdateResellerChild"); // verify the required parameter 'resellerChild' is set if (resellerChild == null) throw new ApiException(400, "Missing required parameter 'resellerChild' when calling ResellerApi->UpdateResellerChild"); - var localVarPath = "./reseller/children/{childAuthKey}"; + var localVarPath = "./reseller/children/{childIdentifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -3417,7 +3417,7 @@ public ApiResponse UpdateResellerChildWithHttpInfo (string childAuthKey, if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (resellerChild != null && resellerChild.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(resellerChild); // http body (model) parameter @@ -3457,35 +3457,35 @@ public ApiResponse UpdateResellerChildWithHttpInfo (string childAuthKey, } /// - /// Update info of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the child identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child profile /// Task of void - public async System.Threading.Tasks.Task UpdateResellerChildAsync (string childAuthKey, UpdateChild resellerChild) + public async System.Threading.Tasks.Task UpdateResellerChildAsync (string childIdentifier, UpdateChild resellerChild) { - await UpdateResellerChildAsyncWithHttpInfo(childAuthKey, resellerChild); + await UpdateResellerChildAsyncWithHttpInfo(childIdentifier, resellerChild); } /// - /// Update info of reseller's child based on the childAuthKey supplied + /// Update info of reseller's child based on the child identifier supplied /// /// Thrown when fails to make API call - /// auth key of reseller's child + /// Either auth key or id of reseller's child /// values to update in child profile /// Task of ApiResponse - public async System.Threading.Tasks.Task> UpdateResellerChildAsyncWithHttpInfo (string childAuthKey, UpdateChild resellerChild) + public async System.Threading.Tasks.Task> UpdateResellerChildAsyncWithHttpInfo (string childIdentifier, UpdateChild resellerChild) { - // verify the required parameter 'childAuthKey' is set - if (childAuthKey == null) - throw new ApiException(400, "Missing required parameter 'childAuthKey' when calling ResellerApi->UpdateResellerChild"); + // verify the required parameter 'childIdentifier' is set + if (childIdentifier == null) + throw new ApiException(400, "Missing required parameter 'childIdentifier' when calling ResellerApi->UpdateResellerChild"); // verify the required parameter 'resellerChild' is set if (resellerChild == null) throw new ApiException(400, "Missing required parameter 'resellerChild' when calling ResellerApi->UpdateResellerChild"); - var localVarPath = "./reseller/children/{childAuthKey}"; + var localVarPath = "./reseller/children/{childIdentifier}"; var localVarPathParams = new Dictionary(); var localVarQueryParams = new List>(); var localVarHeaderParams = new Dictionary(this.Configuration.DefaultHeader); @@ -3507,7 +3507,7 @@ public async System.Threading.Tasks.Task> UpdateResellerChil if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - if (childAuthKey != null) localVarPathParams.Add("childAuthKey", this.Configuration.ApiClient.ParameterToString(childAuthKey)); // path parameter + if (childIdentifier != null) localVarPathParams.Add("childIdentifier", this.Configuration.ApiClient.ParameterToString(childIdentifier)); // path parameter if (resellerChild != null && resellerChild.GetType() != typeof(byte[])) { localVarPostBody = this.Configuration.ApiClient.Serialize(resellerChild); // http body (model) parameter diff --git a/src/sib_api_v3_sdk/Api/SMTPApi.cs b/src/sib_api_v3_sdk/Api/TransactionalEmailsApi.cs similarity index 98% rename from src/sib_api_v3_sdk/Api/SMTPApi.cs rename to src/sib_api_v3_sdk/Api/TransactionalEmailsApi.cs index e4deff7..f5ad81c 100644 --- a/src/sib_api_v3_sdk/Api/SMTPApi.cs +++ b/src/sib_api_v3_sdk/Api/TransactionalEmailsApi.cs @@ -21,7 +21,7 @@ namespace sib_api_v3_sdk.Api /// /// Represents a collection of functions to interact with the API endpoints /// - public interface ISMTPApi : IApiAccessor + public interface ITransactionalEmailsApi : IApiAccessor { #region Synchronous Operations /// @@ -866,15 +866,15 @@ public interface ISMTPApi : IApiAccessor /// /// Represents a collection of functions to interact with the API endpoints /// - public partial class SMTPApi : ISMTPApi + public partial class TransactionalEmailsApi : ITransactionalEmailsApi { private sib_api_v3_sdk.Client.ExceptionFactory _exceptionFactory = (name, response) => null; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// - public SMTPApi(String basePath) + public TransactionalEmailsApi(String basePath) { this.Configuration = new sib_api_v3_sdk.Client.Configuration { BasePath = basePath }; @@ -882,12 +882,12 @@ public SMTPApi(String basePath) } /// - /// Initializes a new instance of the class + /// Initializes a new instance of the class /// using Configuration object /// /// An instance of Configuration /// - public SMTPApi(sib_api_v3_sdk.Client.Configuration configuration = null) + public TransactionalEmailsApi(sib_api_v3_sdk.Client.Configuration configuration = null) { if (configuration == null) // use the default one in Configuration this.Configuration = sib_api_v3_sdk.Client.Configuration.Default; @@ -982,7 +982,7 @@ public ApiResponse< CreateModel > CreateSmtpTemplateWithHttpInfo (CreateSmtpTemp { // verify the required parameter 'smtpTemplate' is set if (smtpTemplate == null) - throw new ApiException(400, "Missing required parameter 'smtpTemplate' when calling SMTPApi->CreateSmtpTemplate"); + throw new ApiException(400, "Missing required parameter 'smtpTemplate' when calling TransactionalEmailsApi->CreateSmtpTemplate"); var localVarPath = "./smtp/templates"; var localVarPathParams = new Dictionary(); @@ -1067,7 +1067,7 @@ public async System.Threading.Tasks.Task> CreateSmtpTem { // verify the required parameter 'smtpTemplate' is set if (smtpTemplate == null) - throw new ApiException(400, "Missing required parameter 'smtpTemplate' when calling SMTPApi->CreateSmtpTemplate"); + throw new ApiException(400, "Missing required parameter 'smtpTemplate' when calling TransactionalEmailsApi->CreateSmtpTemplate"); var localVarPath = "./smtp/templates"; var localVarPathParams = new Dictionary(); @@ -1311,7 +1311,7 @@ public ApiResponse DeleteSmtpTemplateWithHttpInfo (long? templateId) { // verify the required parameter 'templateId' is set if (templateId == null) - throw new ApiException(400, "Missing required parameter 'templateId' when calling SMTPApi->DeleteSmtpTemplate"); + throw new ApiException(400, "Missing required parameter 'templateId' when calling TransactionalEmailsApi->DeleteSmtpTemplate"); var localVarPath = "./smtp/templates/{templateId}"; var localVarPathParams = new Dictionary(); @@ -1388,7 +1388,7 @@ public async System.Threading.Tasks.Task> DeleteSmtpTemplate { // verify the required parameter 'templateId' is set if (templateId == null) - throw new ApiException(400, "Missing required parameter 'templateId' when calling SMTPApi->DeleteSmtpTemplate"); + throw new ApiException(400, "Missing required parameter 'templateId' when calling TransactionalEmailsApi->DeleteSmtpTemplate"); var localVarPath = "./smtp/templates/{templateId}"; var localVarPathParams = new Dictionary(); @@ -2014,7 +2014,7 @@ public ApiResponse< GetSmtpTemplateOverview > GetSmtpTemplateWithHttpInfo (long? { // verify the required parameter 'templateId' is set if (templateId == null) - throw new ApiException(400, "Missing required parameter 'templateId' when calling SMTPApi->GetSmtpTemplate"); + throw new ApiException(400, "Missing required parameter 'templateId' when calling TransactionalEmailsApi->GetSmtpTemplate"); var localVarPath = "./smtp/templates/{templateId}"; var localVarPathParams = new Dictionary(); @@ -2092,7 +2092,7 @@ public async System.Threading.Tasks.Task> G { // verify the required parameter 'templateId' is set if (templateId == null) - throw new ApiException(400, "Missing required parameter 'templateId' when calling SMTPApi->GetSmtpTemplate"); + throw new ApiException(400, "Missing required parameter 'templateId' when calling TransactionalEmailsApi->GetSmtpTemplate"); var localVarPath = "./smtp/templates/{templateId}"; var localVarPathParams = new Dictionary(); @@ -2503,7 +2503,7 @@ public ApiResponse< GetTransacEmailContent > GetTransacEmailContentWithHttpInfo { // verify the required parameter 'uuid' is set if (uuid == null) - throw new ApiException(400, "Missing required parameter 'uuid' when calling SMTPApi->GetTransacEmailContent"); + throw new ApiException(400, "Missing required parameter 'uuid' when calling TransactionalEmailsApi->GetTransacEmailContent"); var localVarPath = "./smtp/emails/{uuid}"; var localVarPathParams = new Dictionary(); @@ -2581,7 +2581,7 @@ public async System.Threading.Tasks.Task> Ge { // verify the required parameter 'uuid' is set if (uuid == null) - throw new ApiException(400, "Missing required parameter 'uuid' when calling SMTPApi->GetTransacEmailContent"); + throw new ApiException(400, "Missing required parameter 'uuid' when calling TransactionalEmailsApi->GetTransacEmailContent"); var localVarPath = "./smtp/emails/{uuid}"; var localVarPathParams = new Dictionary(); @@ -2833,10 +2833,10 @@ public ApiResponse< SendTemplateEmail > SendTemplateWithHttpInfo (long? template { // verify the required parameter 'templateId' is set if (templateId == null) - throw new ApiException(400, "Missing required parameter 'templateId' when calling SMTPApi->SendTemplate"); + throw new ApiException(400, "Missing required parameter 'templateId' when calling TransactionalEmailsApi->SendTemplate"); // verify the required parameter 'sendEmail' is set if (sendEmail == null) - throw new ApiException(400, "Missing required parameter 'sendEmail' when calling SMTPApi->SendTemplate"); + throw new ApiException(400, "Missing required parameter 'sendEmail' when calling TransactionalEmailsApi->SendTemplate"); var localVarPath = "./smtp/templates/{templateId}/send"; var localVarPathParams = new Dictionary(); @@ -2924,10 +2924,10 @@ public async System.Threading.Tasks.Task> SendTem { // verify the required parameter 'templateId' is set if (templateId == null) - throw new ApiException(400, "Missing required parameter 'templateId' when calling SMTPApi->SendTemplate"); + throw new ApiException(400, "Missing required parameter 'templateId' when calling TransactionalEmailsApi->SendTemplate"); // verify the required parameter 'sendEmail' is set if (sendEmail == null) - throw new ApiException(400, "Missing required parameter 'sendEmail' when calling SMTPApi->SendTemplate"); + throw new ApiException(400, "Missing required parameter 'sendEmail' when calling TransactionalEmailsApi->SendTemplate"); var localVarPath = "./smtp/templates/{templateId}/send"; var localVarPathParams = new Dictionary(); @@ -3013,10 +3013,10 @@ public ApiResponse SendTestTemplateWithHttpInfo (long? templateId, SendT { // verify the required parameter 'templateId' is set if (templateId == null) - throw new ApiException(400, "Missing required parameter 'templateId' when calling SMTPApi->SendTestTemplate"); + throw new ApiException(400, "Missing required parameter 'templateId' when calling TransactionalEmailsApi->SendTestTemplate"); // verify the required parameter 'sendTestEmail' is set if (sendTestEmail == null) - throw new ApiException(400, "Missing required parameter 'sendTestEmail' when calling SMTPApi->SendTestTemplate"); + throw new ApiException(400, "Missing required parameter 'sendTestEmail' when calling TransactionalEmailsApi->SendTestTemplate"); var localVarPath = "./smtp/templates/{templateId}/sendTest"; var localVarPathParams = new Dictionary(); @@ -3103,10 +3103,10 @@ public async System.Threading.Tasks.Task> SendTestTemplateAs { // verify the required parameter 'templateId' is set if (templateId == null) - throw new ApiException(400, "Missing required parameter 'templateId' when calling SMTPApi->SendTestTemplate"); + throw new ApiException(400, "Missing required parameter 'templateId' when calling TransactionalEmailsApi->SendTestTemplate"); // verify the required parameter 'sendTestEmail' is set if (sendTestEmail == null) - throw new ApiException(400, "Missing required parameter 'sendTestEmail' when calling SMTPApi->SendTestTemplate"); + throw new ApiException(400, "Missing required parameter 'sendTestEmail' when calling TransactionalEmailsApi->SendTestTemplate"); var localVarPath = "./smtp/templates/{templateId}/sendTest"; var localVarPathParams = new Dictionary(); @@ -3191,7 +3191,7 @@ public ApiResponse< CreateSmtpEmail > SendTransacEmailWithHttpInfo (SendSmtpEmai { // verify the required parameter 'sendSmtpEmail' is set if (sendSmtpEmail == null) - throw new ApiException(400, "Missing required parameter 'sendSmtpEmail' when calling SMTPApi->SendTransacEmail"); + throw new ApiException(400, "Missing required parameter 'sendSmtpEmail' when calling TransactionalEmailsApi->SendTransacEmail"); var localVarPath = "./smtp/email"; var localVarPathParams = new Dictionary(); @@ -3276,7 +3276,7 @@ public async System.Threading.Tasks.Task> SendTrans { // verify the required parameter 'sendSmtpEmail' is set if (sendSmtpEmail == null) - throw new ApiException(400, "Missing required parameter 'sendSmtpEmail' when calling SMTPApi->SendTransacEmail"); + throw new ApiException(400, "Missing required parameter 'sendSmtpEmail' when calling TransactionalEmailsApi->SendTransacEmail"); var localVarPath = "./smtp/email"; var localVarPathParams = new Dictionary(); @@ -3359,7 +3359,7 @@ public ApiResponse SmtpBlockedContactsEmailDeleteWithHttpInfo (string em { // verify the required parameter 'email' is set if (email == null) - throw new ApiException(400, "Missing required parameter 'email' when calling SMTPApi->SmtpBlockedContactsEmailDelete"); + throw new ApiException(400, "Missing required parameter 'email' when calling TransactionalEmailsApi->SmtpBlockedContactsEmailDelete"); var localVarPath = "./smtp/blockedContacts/{email}"; var localVarPathParams = new Dictionary(); @@ -3436,7 +3436,7 @@ public async System.Threading.Tasks.Task> SmtpBlockedContact { // verify the required parameter 'email' is set if (email == null) - throw new ApiException(400, "Missing required parameter 'email' when calling SMTPApi->SmtpBlockedContactsEmailDelete"); + throw new ApiException(400, "Missing required parameter 'email' when calling TransactionalEmailsApi->SmtpBlockedContactsEmailDelete"); var localVarPath = "./smtp/blockedContacts/{email}"; var localVarPathParams = new Dictionary(); @@ -3512,7 +3512,7 @@ public ApiResponse SmtpLogMessageIdDeleteWithHttpInfo (string messageId) { // verify the required parameter 'messageId' is set if (messageId == null) - throw new ApiException(400, "Missing required parameter 'messageId' when calling SMTPApi->SmtpLogMessageIdDelete"); + throw new ApiException(400, "Missing required parameter 'messageId' when calling TransactionalEmailsApi->SmtpLogMessageIdDelete"); var localVarPath = "./smtp/log/{messageId}"; var localVarPathParams = new Dictionary(); @@ -3589,7 +3589,7 @@ public async System.Threading.Tasks.Task> SmtpLogMessageIdDe { // verify the required parameter 'messageId' is set if (messageId == null) - throw new ApiException(400, "Missing required parameter 'messageId' when calling SMTPApi->SmtpLogMessageIdDelete"); + throw new ApiException(400, "Missing required parameter 'messageId' when calling TransactionalEmailsApi->SmtpLogMessageIdDelete"); var localVarPath = "./smtp/log/{messageId}"; var localVarPathParams = new Dictionary(); @@ -3667,10 +3667,10 @@ public ApiResponse UpdateSmtpTemplateWithHttpInfo (long? templateId, Upd { // verify the required parameter 'templateId' is set if (templateId == null) - throw new ApiException(400, "Missing required parameter 'templateId' when calling SMTPApi->UpdateSmtpTemplate"); + throw new ApiException(400, "Missing required parameter 'templateId' when calling TransactionalEmailsApi->UpdateSmtpTemplate"); // verify the required parameter 'smtpTemplate' is set if (smtpTemplate == null) - throw new ApiException(400, "Missing required parameter 'smtpTemplate' when calling SMTPApi->UpdateSmtpTemplate"); + throw new ApiException(400, "Missing required parameter 'smtpTemplate' when calling TransactionalEmailsApi->UpdateSmtpTemplate"); var localVarPath = "./smtp/templates/{templateId}"; var localVarPathParams = new Dictionary(); @@ -3757,10 +3757,10 @@ public async System.Threading.Tasks.Task> UpdateSmtpTemplate { // verify the required parameter 'templateId' is set if (templateId == null) - throw new ApiException(400, "Missing required parameter 'templateId' when calling SMTPApi->UpdateSmtpTemplate"); + throw new ApiException(400, "Missing required parameter 'templateId' when calling TransactionalEmailsApi->UpdateSmtpTemplate"); // verify the required parameter 'smtpTemplate' is set if (smtpTemplate == null) - throw new ApiException(400, "Missing required parameter 'smtpTemplate' when calling SMTPApi->UpdateSmtpTemplate"); + throw new ApiException(400, "Missing required parameter 'smtpTemplate' when calling TransactionalEmailsApi->UpdateSmtpTemplate"); var localVarPath = "./smtp/templates/{templateId}"; var localVarPathParams = new Dictionary(); diff --git a/src/sib_api_v3_sdk/Api/TransactionalSMSApi.cs b/src/sib_api_v3_sdk/Api/TransactionalSMSApi.cs index 87251f4..4b128bd 100644 --- a/src/sib_api_v3_sdk/Api/TransactionalSMSApi.cs +++ b/src/sib_api_v3_sdk/Api/TransactionalSMSApi.cs @@ -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 a mobile number + /// Send SMS message to a mobile number /// /// /// @@ -125,7 +125,7 @@ public interface ITransactionalSMSApi : IApiAccessor SendSms SendTransacSms (SendTransacSms sendTransacSms); /// - /// Send the SMS campaign to a mobile number + /// Send SMS message to a mobile number /// /// /// @@ -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 a mobile number + /// Send SMS message to a mobile number /// /// /// @@ -237,7 +237,7 @@ public interface ITransactionalSMSApi : IApiAccessor System.Threading.Tasks.Task SendTransacSmsAsync (SendTransacSms sendTransacSms); /// - /// Send the SMS campaign to a mobile number + /// Send SMS message to a mobile number /// /// /// @@ -872,7 +872,7 @@ public async System.Threading.Tasks.Task> GetTr } /// - /// Send the SMS campaign to a mobile number + /// Send SMS message 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 a mobile number + /// Send SMS message 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 a mobile number + /// Send SMS message 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 a mobile number + /// Send SMS message 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/Configuration.cs b/src/sib_api_v3_sdk/Client/Configuration.cs index 5de47e0..0bbb298 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.1"; + public const string Version = "3.0.0"; /// /// Identifier for ISO 8601 DateTime Format @@ -110,7 +110,7 @@ static Configuration() /// public Configuration() { - UserAgent = "Swagger-Codegen/2.1.1/csharp"; + UserAgent = "sendinblue_clientAPI/v3.0.0/c#"; 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.1/csharp" + string userAgent = "sendinblue_clientAPI/v3.0.0/c#" // 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.1\n"; + report += " SDK Package Version: 3.0.0\n"; return report; } diff --git a/src/sib_api_v3_sdk/Model/AbTestCampaignResult.cs b/src/sib_api_v3_sdk/Model/AbTestCampaignResult.cs index f86fbec..edd4b9f 100644 --- a/src/sib_api_v3_sdk/Model/AbTestCampaignResult.cs +++ b/src/sib_api_v3_sdk/Model/AbTestCampaignResult.cs @@ -109,7 +109,9 @@ public enum WinningCriteriaEnum /// Open rate for current winning version. /// Click rate for current winning version. /// Open/Click rate for the winner version. - public AbTestCampaignResult(WinningVersionEnum? winningVersion = default(WinningVersionEnum?), WinningCriteriaEnum? winningCriteria = default(WinningCriteriaEnum?), string winningSubjectLine = default(string), string openRate = default(string), string clickRate = default(string), string winningVersionRate = default(string)) + /// statistics. + /// clickedLinks. + public AbTestCampaignResult(WinningVersionEnum? winningVersion = default(WinningVersionEnum?), WinningCriteriaEnum? winningCriteria = default(WinningCriteriaEnum?), string winningSubjectLine = default(string), string openRate = default(string), string clickRate = default(string), string winningVersionRate = default(string), AbTestCampaignResultStatistics statistics = default(AbTestCampaignResultStatistics), AbTestCampaignResultClickedLinks clickedLinks = default(AbTestCampaignResultClickedLinks)) { this.WinningVersion = winningVersion; this.WinningCriteria = winningCriteria; @@ -117,6 +119,8 @@ public enum WinningCriteriaEnum this.OpenRate = openRate; this.ClickRate = clickRate; this.WinningVersionRate = winningVersionRate; + this.Statistics = statistics; + this.ClickedLinks = clickedLinks; } @@ -149,6 +153,18 @@ public enum WinningCriteriaEnum [DataMember(Name="winningVersionRate", EmitDefaultValue=false)] public string WinningVersionRate { get; set; } + /// + /// Gets or Sets Statistics + /// + [DataMember(Name="statistics", EmitDefaultValue=false)] + public AbTestCampaignResultStatistics Statistics { get; set; } + + /// + /// Gets or Sets ClickedLinks + /// + [DataMember(Name="clickedLinks", EmitDefaultValue=false)] + public AbTestCampaignResultClickedLinks ClickedLinks { get; set; } + /// /// Returns the string presentation of the object /// @@ -163,6 +179,8 @@ public override string ToString() sb.Append(" OpenRate: ").Append(OpenRate).Append("\n"); sb.Append(" ClickRate: ").Append(ClickRate).Append("\n"); sb.Append(" WinningVersionRate: ").Append(WinningVersionRate).Append("\n"); + sb.Append(" Statistics: ").Append(Statistics).Append("\n"); + sb.Append(" ClickedLinks: ").Append(ClickedLinks).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -226,6 +244,16 @@ public bool Equals(AbTestCampaignResult input) this.WinningVersionRate == input.WinningVersionRate || (this.WinningVersionRate != null && this.WinningVersionRate.Equals(input.WinningVersionRate)) + ) && + ( + this.Statistics == input.Statistics || + (this.Statistics != null && + this.Statistics.Equals(input.Statistics)) + ) && + ( + this.ClickedLinks == input.ClickedLinks || + (this.ClickedLinks != null && + this.ClickedLinks.Equals(input.ClickedLinks)) ); } @@ -250,6 +278,10 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.ClickRate.GetHashCode(); if (this.WinningVersionRate != null) hashCode = hashCode * 59 + this.WinningVersionRate.GetHashCode(); + if (this.Statistics != null) + hashCode = hashCode * 59 + this.Statistics.GetHashCode(); + if (this.ClickedLinks != null) + hashCode = hashCode * 59 + this.ClickedLinks.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/AbTestCampaignResultClickedLinks.cs b/src/sib_api_v3_sdk/Model/AbTestCampaignResultClickedLinks.cs new file mode 100644 index 0000000..728e9ed --- /dev/null +++ b/src/sib_api_v3_sdk/Model/AbTestCampaignResultClickedLinks.cs @@ -0,0 +1,149 @@ +/* + * 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 +{ + /// + /// AbTestCampaignResultClickedLinks + /// + [DataContract] + public partial class AbTestCampaignResultClickedLinks : IEquatable + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected AbTestCampaignResultClickedLinks() { } + /// + /// Initializes a new instance of the class. + /// + /// versionA (required). + /// versionB (required). + public AbTestCampaignResultClickedLinks(AbTestVersionClicks versionA = default(AbTestVersionClicks), AbTestVersionClicks versionB = default(AbTestVersionClicks)) + { + // to ensure "versionA" is required (not null) + if (versionA == null) + { + throw new InvalidDataException("versionA is a required property for AbTestCampaignResultClickedLinks and cannot be null"); + } + else + { + this.VersionA = versionA; + } + // to ensure "versionB" is required (not null) + if (versionB == null) + { + throw new InvalidDataException("versionB is a required property for AbTestCampaignResultClickedLinks and cannot be null"); + } + else + { + this.VersionB = versionB; + } + } + + /// + /// Gets or Sets VersionA + /// + [DataMember(Name="Version A", EmitDefaultValue=false)] + public AbTestVersionClicks VersionA { get; set; } + + /// + /// Gets or Sets VersionB + /// + [DataMember(Name="Version B", EmitDefaultValue=false)] + public AbTestVersionClicks VersionB { 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 AbTestCampaignResultClickedLinks {\n"); + sb.Append(" VersionA: ").Append(VersionA).Append("\n"); + sb.Append(" VersionB: ").Append(VersionB).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 AbTestCampaignResultClickedLinks); + } + + /// + /// Returns true if AbTestCampaignResultClickedLinks instances are equal + /// + /// Instance of AbTestCampaignResultClickedLinks to be compared + /// Boolean + public bool Equals(AbTestCampaignResultClickedLinks input) + { + if (input == null) + return false; + + return + ( + this.VersionA == input.VersionA || + (this.VersionA != null && + this.VersionA.Equals(input.VersionA)) + ) && + ( + this.VersionB == input.VersionB || + (this.VersionB != null && + this.VersionB.Equals(input.VersionB)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.VersionA != null) + hashCode = hashCode * 59 + this.VersionA.GetHashCode(); + if (this.VersionB != null) + hashCode = hashCode * 59 + this.VersionB.GetHashCode(); + return hashCode; + } + } + } + +} diff --git a/src/sib_api_v3_sdk/Model/AbTestCampaignResultStatistics.cs b/src/sib_api_v3_sdk/Model/AbTestCampaignResultStatistics.cs new file mode 100644 index 0000000..8b98e50 --- /dev/null +++ b/src/sib_api_v3_sdk/Model/AbTestCampaignResultStatistics.cs @@ -0,0 +1,245 @@ +/* + * 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 +{ + /// + /// AbTestCampaignResultStatistics + /// + [DataContract] + public partial class AbTestCampaignResultStatistics : IEquatable + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected AbTestCampaignResultStatistics() { } + /// + /// Initializes a new instance of the class. + /// + /// openers (required). + /// clicks (required). + /// unsubscribed (required). + /// hardBounces (required). + /// softBounces (required). + /// complaints (required). + public AbTestCampaignResultStatistics(AbTestVersionStats openers = default(AbTestVersionStats), AbTestVersionStats clicks = default(AbTestVersionStats), AbTestVersionStats unsubscribed = default(AbTestVersionStats), AbTestVersionStats hardBounces = default(AbTestVersionStats), AbTestVersionStats softBounces = default(AbTestVersionStats), AbTestVersionStats complaints = default(AbTestVersionStats)) + { + // to ensure "openers" is required (not null) + if (openers == null) + { + throw new InvalidDataException("openers is a required property for AbTestCampaignResultStatistics and cannot be null"); + } + else + { + this.Openers = openers; + } + // to ensure "clicks" is required (not null) + if (clicks == null) + { + throw new InvalidDataException("clicks is a required property for AbTestCampaignResultStatistics and cannot be null"); + } + else + { + this.Clicks = clicks; + } + // to ensure "unsubscribed" is required (not null) + if (unsubscribed == null) + { + throw new InvalidDataException("unsubscribed is a required property for AbTestCampaignResultStatistics and cannot be null"); + } + else + { + this.Unsubscribed = unsubscribed; + } + // to ensure "hardBounces" is required (not null) + if (hardBounces == null) + { + throw new InvalidDataException("hardBounces is a required property for AbTestCampaignResultStatistics and cannot be null"); + } + else + { + this.HardBounces = hardBounces; + } + // to ensure "softBounces" is required (not null) + if (softBounces == null) + { + throw new InvalidDataException("softBounces is a required property for AbTestCampaignResultStatistics and cannot be null"); + } + else + { + this.SoftBounces = softBounces; + } + // to ensure "complaints" is required (not null) + if (complaints == null) + { + throw new InvalidDataException("complaints is a required property for AbTestCampaignResultStatistics and cannot be null"); + } + else + { + this.Complaints = complaints; + } + } + + /// + /// Gets or Sets Openers + /// + [DataMember(Name="openers", EmitDefaultValue=false)] + public AbTestVersionStats Openers { get; set; } + + /// + /// Gets or Sets Clicks + /// + [DataMember(Name="clicks", EmitDefaultValue=false)] + public AbTestVersionStats Clicks { get; set; } + + /// + /// Gets or Sets Unsubscribed + /// + [DataMember(Name="unsubscribed", EmitDefaultValue=false)] + public AbTestVersionStats Unsubscribed { get; set; } + + /// + /// Gets or Sets HardBounces + /// + [DataMember(Name="hardBounces", EmitDefaultValue=false)] + public AbTestVersionStats HardBounces { get; set; } + + /// + /// Gets or Sets SoftBounces + /// + [DataMember(Name="softBounces", EmitDefaultValue=false)] + public AbTestVersionStats SoftBounces { get; set; } + + /// + /// Gets or Sets Complaints + /// + [DataMember(Name="complaints", EmitDefaultValue=false)] + public AbTestVersionStats Complaints { 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 AbTestCampaignResultStatistics {\n"); + sb.Append(" Openers: ").Append(Openers).Append("\n"); + sb.Append(" Clicks: ").Append(Clicks).Append("\n"); + sb.Append(" Unsubscribed: ").Append(Unsubscribed).Append("\n"); + sb.Append(" HardBounces: ").Append(HardBounces).Append("\n"); + sb.Append(" SoftBounces: ").Append(SoftBounces).Append("\n"); + sb.Append(" Complaints: ").Append(Complaints).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 AbTestCampaignResultStatistics); + } + + /// + /// Returns true if AbTestCampaignResultStatistics instances are equal + /// + /// Instance of AbTestCampaignResultStatistics to be compared + /// Boolean + public bool Equals(AbTestCampaignResultStatistics input) + { + if (input == null) + return false; + + return + ( + this.Openers == input.Openers || + (this.Openers != null && + this.Openers.Equals(input.Openers)) + ) && + ( + this.Clicks == input.Clicks || + (this.Clicks != null && + this.Clicks.Equals(input.Clicks)) + ) && + ( + this.Unsubscribed == input.Unsubscribed || + (this.Unsubscribed != null && + this.Unsubscribed.Equals(input.Unsubscribed)) + ) && + ( + this.HardBounces == input.HardBounces || + (this.HardBounces != null && + this.HardBounces.Equals(input.HardBounces)) + ) && + ( + this.SoftBounces == input.SoftBounces || + (this.SoftBounces != null && + this.SoftBounces.Equals(input.SoftBounces)) + ) && + ( + this.Complaints == input.Complaints || + (this.Complaints != null && + this.Complaints.Equals(input.Complaints)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Openers != null) + hashCode = hashCode * 59 + this.Openers.GetHashCode(); + if (this.Clicks != null) + hashCode = hashCode * 59 + this.Clicks.GetHashCode(); + if (this.Unsubscribed != null) + hashCode = hashCode * 59 + this.Unsubscribed.GetHashCode(); + if (this.HardBounces != null) + hashCode = hashCode * 59 + this.HardBounces.GetHashCode(); + if (this.SoftBounces != null) + hashCode = hashCode * 59 + this.SoftBounces.GetHashCode(); + if (this.Complaints != null) + hashCode = hashCode * 59 + this.Complaints.GetHashCode(); + return hashCode; + } + } + } + +} diff --git a/src/sib_api_v3_sdk/Model/AbTestVersionClicks.cs b/src/sib_api_v3_sdk/Model/AbTestVersionClicks.cs new file mode 100644 index 0000000..d4dfbd7 --- /dev/null +++ b/src/sib_api_v3_sdk/Model/AbTestVersionClicks.cs @@ -0,0 +1,98 @@ +/* + * 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 +{ + /// + /// Information on clicked links for a particular version + /// + [DataContract] + public partial class AbTestVersionClicks : List, IEquatable + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + public AbTestVersionClicks() : base() + { + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class AbTestVersionClicks {\n"); + sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public 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 AbTestVersionClicks); + } + + /// + /// Returns true if AbTestVersionClicks instances are equal + /// + /// Instance of AbTestVersionClicks to be compared + /// Boolean + public bool Equals(AbTestVersionClicks input) + { + if (input == null) + return false; + + return base.Equals(input); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = base.GetHashCode(); + return hashCode; + } + } + } + +} diff --git a/src/sib_api_v3_sdk/Model/AbTestVersionClicksInner.cs b/src/sib_api_v3_sdk/Model/AbTestVersionClicksInner.cs new file mode 100644 index 0000000..a5df090 --- /dev/null +++ b/src/sib_api_v3_sdk/Model/AbTestVersionClicksInner.cs @@ -0,0 +1,176 @@ +/* + * 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 +{ + /// + /// AbTestVersionClicksInner + /// + [DataContract] + public partial class AbTestVersionClicksInner : IEquatable + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected AbTestVersionClicksInner() { } + /// + /// Initializes a new instance of the class. + /// + /// URL of the link (required). + /// Number of times a link is clicked (required). + /// Percentage of clicks of link with respect to total clicks (required). + public AbTestVersionClicksInner(string link = default(string), decimal? clicksCount = default(decimal?), string clickRate = default(string)) + { + // to ensure "link" is required (not null) + if (link == null) + { + throw new InvalidDataException("link is a required property for AbTestVersionClicksInner and cannot be null"); + } + else + { + this.Link = link; + } + // to ensure "clicksCount" is required (not null) + if (clicksCount == null) + { + throw new InvalidDataException("clicksCount is a required property for AbTestVersionClicksInner and cannot be null"); + } + else + { + this.ClicksCount = clicksCount; + } + // to ensure "clickRate" is required (not null) + if (clickRate == null) + { + throw new InvalidDataException("clickRate is a required property for AbTestVersionClicksInner and cannot be null"); + } + else + { + this.ClickRate = clickRate; + } + } + + /// + /// URL of the link + /// + /// URL of the link + [DataMember(Name="link", EmitDefaultValue=false)] + public string Link { get; set; } + + /// + /// Number of times a link is clicked + /// + /// Number of times a link is clicked + [DataMember(Name="clicksCount", EmitDefaultValue=false)] + public decimal? ClicksCount { get; set; } + + /// + /// Percentage of clicks of link with respect to total clicks + /// + /// Percentage of clicks of link with respect to total clicks + [DataMember(Name="clickRate", EmitDefaultValue=false)] + public string ClickRate { 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 AbTestVersionClicksInner {\n"); + sb.Append(" Link: ").Append(Link).Append("\n"); + sb.Append(" ClicksCount: ").Append(ClicksCount).Append("\n"); + sb.Append(" ClickRate: ").Append(ClickRate).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 AbTestVersionClicksInner); + } + + /// + /// Returns true if AbTestVersionClicksInner instances are equal + /// + /// Instance of AbTestVersionClicksInner to be compared + /// Boolean + public bool Equals(AbTestVersionClicksInner input) + { + if (input == null) + return false; + + return + ( + this.Link == input.Link || + (this.Link != null && + this.Link.Equals(input.Link)) + ) && + ( + this.ClicksCount == input.ClicksCount || + (this.ClicksCount != null && + this.ClicksCount.Equals(input.ClicksCount)) + ) && + ( + this.ClickRate == input.ClickRate || + (this.ClickRate != null && + this.ClickRate.Equals(input.ClickRate)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Link != null) + hashCode = hashCode * 59 + this.Link.GetHashCode(); + if (this.ClicksCount != null) + hashCode = hashCode * 59 + this.ClicksCount.GetHashCode(); + if (this.ClickRate != null) + hashCode = hashCode * 59 + this.ClickRate.GetHashCode(); + return hashCode; + } + } + } + +} diff --git a/src/sib_api_v3_sdk/Model/AbTestVersionStats.cs b/src/sib_api_v3_sdk/Model/AbTestVersionStats.cs new file mode 100644 index 0000000..1877aad --- /dev/null +++ b/src/sib_api_v3_sdk/Model/AbTestVersionStats.cs @@ -0,0 +1,151 @@ +/* + * 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 +{ + /// + /// Percentage of a particular event for both versions + /// + [DataContract] + public partial class AbTestVersionStats : IEquatable + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected AbTestVersionStats() { } + /// + /// Initializes a new instance of the class. + /// + /// percentage of an event for version A (required). + /// percentage of an event for version B (required). + public AbTestVersionStats(string versionA = default(string), string versionB = default(string)) + { + // to ensure "versionA" is required (not null) + if (versionA == null) + { + throw new InvalidDataException("versionA is a required property for AbTestVersionStats and cannot be null"); + } + else + { + this.VersionA = versionA; + } + // to ensure "versionB" is required (not null) + if (versionB == null) + { + throw new InvalidDataException("versionB is a required property for AbTestVersionStats and cannot be null"); + } + else + { + this.VersionB = versionB; + } + } + + /// + /// percentage of an event for version A + /// + /// percentage of an event for version A + [DataMember(Name="Version A", EmitDefaultValue=false)] + public string VersionA { get; set; } + + /// + /// percentage of an event for version B + /// + /// percentage of an event for version B + [DataMember(Name="Version B", EmitDefaultValue=false)] + public string VersionB { 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 AbTestVersionStats {\n"); + sb.Append(" VersionA: ").Append(VersionA).Append("\n"); + sb.Append(" VersionB: ").Append(VersionB).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 AbTestVersionStats); + } + + /// + /// Returns true if AbTestVersionStats instances are equal + /// + /// Instance of AbTestVersionStats to be compared + /// Boolean + public bool Equals(AbTestVersionStats input) + { + if (input == null) + return false; + + return + ( + this.VersionA == input.VersionA || + (this.VersionA != null && + this.VersionA.Equals(input.VersionA)) + ) && + ( + this.VersionB == input.VersionB || + (this.VersionB != null && + this.VersionB.Equals(input.VersionB)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.VersionA != null) + hashCode = hashCode * 59 + this.VersionA.GetHashCode(); + if (this.VersionB != null) + hashCode = hashCode * 59 + this.VersionB.GetHashCode(); + return hashCode; + } + } + } + +} diff --git a/src/sib_api_v3_sdk/Model/AddContactToList.cs b/src/sib_api_v3_sdk/Model/AddContactToList.cs index 910ede6..e8d6e8e 100644 --- a/src/sib_api_v3_sdk/Model/AddContactToList.cs +++ b/src/sib_api_v3_sdk/Model/AddContactToList.cs @@ -31,19 +31,28 @@ public partial class AddContactToList : IEquatable /// /// Initializes a new instance of the class. /// - /// 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)) + /// Mandatory if IDs are not passed, ignored otherwise. 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.. + /// Mandatory if Emails are not passed, ignored otherwise. 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), List ids = default(List)) { this.Emails = emails; + this.Ids = ids; } /// - /// 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. + /// Mandatory if IDs are not passed, ignored otherwise. 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. 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. + /// Mandatory if IDs are not passed, ignored otherwise. 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; } + /// + /// Mandatory if Emails are not passed, ignored otherwise. 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. + /// + /// Mandatory if Emails are not passed, ignored otherwise. 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="ids", EmitDefaultValue=false)] + public List Ids { get; set; } + /// /// Returns the string presentation of the object /// @@ -53,6 +62,7 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class AddContactToList {\n"); sb.Append(" Emails: ").Append(Emails).Append("\n"); + sb.Append(" Ids: ").Append(Ids).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -91,6 +101,11 @@ public bool Equals(AddContactToList input) this.Emails == input.Emails || this.Emails != null && this.Emails.SequenceEqual(input.Emails) + ) && + ( + this.Ids == input.Ids || + this.Ids != null && + this.Ids.SequenceEqual(input.Ids) ); } @@ -105,6 +120,8 @@ public override int GetHashCode() int hashCode = 41; if (this.Emails != null) hashCode = hashCode * 59 + this.Emails.GetHashCode(); + if (this.Ids != null) + hashCode = hashCode * 59 + this.Ids.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/CreateChild.cs b/src/sib_api_v3_sdk/Model/CreateChild.cs index 7140eb8..78afe0a 100644 --- a/src/sib_api_v3_sdk/Model/CreateChild.cs +++ b/src/sib_api_v3_sdk/Model/CreateChild.cs @@ -28,6 +28,57 @@ namespace sib_api_v3_sdk.Model [DataContract] public partial class CreateChild : IEquatable { + /// + /// Language of the child account + /// + /// Language of the child account + [JsonConverter(typeof(StringEnumConverter))] + public enum LanguageEnum + { + + /// + /// Enum Fr for value: fr + /// + [EnumMember(Value = "fr")] + Fr = 1, + + /// + /// Enum Es for value: es + /// + [EnumMember(Value = "es")] + Es = 2, + + /// + /// Enum Pt for value: pt + /// + [EnumMember(Value = "pt")] + Pt = 3, + + /// + /// Enum It for value: it + /// + [EnumMember(Value = "it")] + It = 4, + + /// + /// Enum De for value: de + /// + [EnumMember(Value = "de")] + De = 5, + + /// + /// Enum En for value: en + /// + [EnumMember(Value = "en")] + En = 6 + } + + /// + /// Language of the child account + /// + /// Language of the child account + [DataMember(Name="language", EmitDefaultValue=false)] + public LanguageEnum? Language { get; set; } /// /// Initializes a new instance of the class. /// @@ -41,7 +92,8 @@ protected CreateChild() { } /// Last name to use to create the child account (required). /// Company name to use to create the child account (required). /// Password for the child account to login (required). - public CreateChild(string email = default(string), string firstName = default(string), string lastName = default(string), string companyName = default(string), string password = default(string)) + /// Language of the child account. + public CreateChild(string email = default(string), string firstName = default(string), string lastName = default(string), string companyName = default(string), string password = default(string), LanguageEnum? language = default(LanguageEnum?)) { // to ensure "email" is required (not null) if (email == null) @@ -88,6 +140,7 @@ protected CreateChild() { } { this.Password = password; } + this.Language = language; } /// @@ -125,6 +178,7 @@ protected CreateChild() { } [DataMember(Name="password", EmitDefaultValue=false)] public string Password { get; set; } + /// /// Returns the string presentation of the object /// @@ -138,6 +192,7 @@ public override string ToString() sb.Append(" LastName: ").Append(LastName).Append("\n"); sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" Language: ").Append(Language).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -196,6 +251,11 @@ public bool Equals(CreateChild input) this.Password == input.Password || (this.Password != null && this.Password.Equals(input.Password)) + ) && + ( + this.Language == input.Language || + (this.Language != null && + this.Language.Equals(input.Language)) ); } @@ -218,6 +278,8 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.CompanyName.GetHashCode(); if (this.Password != null) hashCode = hashCode * 59 + this.Password.GetHashCode(); + if (this.Language != null) + hashCode = hashCode * 59 + this.Language.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/CreateDoiContact.cs b/src/sib_api_v3_sdk/Model/CreateDoiContact.cs index 507b7d6..8719c15 100644 --- a/src/sib_api_v3_sdk/Model/CreateDoiContact.cs +++ b/src/sib_api_v3_sdk/Model/CreateDoiContact.cs @@ -40,8 +40,8 @@ protected CreateDoiContact() { } /// 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.. + /// Id of the Double opt-in (DOI) template (required). + /// URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. (required). 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) @@ -71,9 +71,17 @@ protected CreateDoiContact() { } { this.TemplateId = templateId; } + // to ensure "redirectionUrl" is required (not null) + if (redirectionUrl == null) + { + throw new InvalidDataException("redirectionUrl is a required property for CreateDoiContact and cannot be null"); + } + else + { + this.RedirectionUrl = redirectionUrl; + } this.Attributes = attributes; this.ExcludeListIds = excludeListIds; - this.RedirectionUrl = redirectionUrl; } /// @@ -105,16 +113,16 @@ protected CreateDoiContact() { } public List ExcludeListIds { get; set; } /// - /// Id of the DOI template + /// Id of the Double opt-in (DOI) template /// - /// Id of the DOI template + /// Id of the Double opt-in (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. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. /// - /// 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. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. [DataMember(Name="redirectionUrl", EmitDefaultValue=false)] public string RedirectionUrl { get; set; } diff --git a/src/sib_api_v3_sdk/Model/CreateReseller.cs b/src/sib_api_v3_sdk/Model/CreateReseller.cs index 9741cba..9f3521a 100644 --- a/src/sib_api_v3_sdk/Model/CreateReseller.cs +++ b/src/sib_api_v3_sdk/Model/CreateReseller.cs @@ -37,7 +37,8 @@ protected CreateReseller() { } /// Initializes a new instance of the class. /// /// AuthKey of Reseller child created (required). - public CreateReseller(string authKey = default(string)) + /// Id of Reseller child created. + public CreateReseller(string authKey = default(string), long? id = default(long?)) { // to ensure "authKey" is required (not null) if (authKey == null) @@ -48,6 +49,7 @@ protected CreateReseller() { } { this.AuthKey = authKey; } + this.Id = id; } /// @@ -57,6 +59,13 @@ protected CreateReseller() { } [DataMember(Name="authKey", EmitDefaultValue=false)] public string AuthKey { get; set; } + /// + /// Id of Reseller child created + /// + /// Id of Reseller child created + [DataMember(Name="id", EmitDefaultValue=false)] + public long? Id { get; set; } + /// /// Returns the string presentation of the object /// @@ -66,6 +75,7 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class CreateReseller {\n"); sb.Append(" AuthKey: ").Append(AuthKey).Append("\n"); + sb.Append(" Id: ").Append(Id).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -104,6 +114,11 @@ public bool Equals(CreateReseller input) this.AuthKey == input.AuthKey || (this.AuthKey != null && this.AuthKey.Equals(input.AuthKey)) + ) && + ( + this.Id == input.Id || + (this.Id != null && + this.Id.Equals(input.Id)) ); } @@ -118,6 +133,8 @@ public override int GetHashCode() int hashCode = 41; if (this.AuthKey != null) hashCode = hashCode * 59 + this.AuthKey.GetHashCode(); + if (this.Id != null) + hashCode = hashCode * 59 + this.Id.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/CreateSender.cs b/src/sib_api_v3_sdk/Model/CreateSender.cs index 0477d44..8f1cca6 100644 --- a/src/sib_api_v3_sdk/Model/CreateSender.cs +++ b/src/sib_api_v3_sdk/Model/CreateSender.cs @@ -37,7 +37,7 @@ protected CreateSender() { } /// Initializes a new instance of the class. /// /// From Name to use for the sender (required). - /// From Email to use for the sender (required). + /// From email to use for the sender. A verification email will be sent to this address. (required). /// Mandatory in case of dedicated IP, IPs to associate to the sender. public CreateSender(string name = default(string), string email = default(string), List ips = default(List)) { @@ -70,9 +70,9 @@ protected CreateSender() { } public string Name { get; set; } /// - /// From Email to use for the sender + /// From email to use for the sender. A verification email will be sent to this address. /// - /// From Email to use for the sender + /// From email to use for the sender. A verification email will be sent to this address. [DataMember(Name="email", EmitDefaultValue=false)] public string Email { get; set; } diff --git a/src/sib_api_v3_sdk/Model/CreateSmsCampaign.cs b/src/sib_api_v3_sdk/Model/CreateSmsCampaign.cs index e0b0d44..10698cc 100644 --- a/src/sib_api_v3_sdk/Model/CreateSmsCampaign.cs +++ b/src/sib_api_v3_sdk/Model/CreateSmsCampaign.cs @@ -37,7 +37,7 @@ protected CreateSmsCampaign() { } /// Initializes a new instance of the class. /// /// Name of the campaign (required). - /// Name of the sender. The number of characters is limited to 11 (required). + /// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** (required). /// Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS (required). /// recipients. /// UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.. @@ -82,9 +82,9 @@ protected CreateSmsCampaign() { } public string Name { get; set; } /// - /// Name of the sender. The number of characters is limited to 11 + /// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** /// - /// Name of the sender. The number of characters is limited to 11 + /// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** [DataMember(Name="sender", EmitDefaultValue=false)] public string Sender { get; set; } diff --git a/src/sib_api_v3_sdk/Model/CreateWebhook.cs b/src/sib_api_v3_sdk/Model/CreateWebhook.cs index 7e8b54d..88b73e1 100644 --- a/src/sib_api_v3_sdk/Model/CreateWebhook.cs +++ b/src/sib_api_v3_sdk/Model/CreateWebhook.cs @@ -35,102 +35,108 @@ public partial class CreateWebhook : IEquatable public enum EventsEnum { + /// + /// Enum Sent for value: sent + /// + [EnumMember(Value = "sent")] + Sent = 1, + /// /// Enum HardBounce for value: hardBounce /// [EnumMember(Value = "hardBounce")] - HardBounce = 1, + HardBounce = 2, /// /// Enum SoftBounce for value: softBounce /// [EnumMember(Value = "softBounce")] - SoftBounce = 2, + SoftBounce = 3, /// /// Enum Blocked for value: blocked /// [EnumMember(Value = "blocked")] - Blocked = 3, + Blocked = 4, /// /// Enum Spam for value: spam /// [EnumMember(Value = "spam")] - Spam = 4, + Spam = 5, /// /// Enum Delivered for value: delivered /// [EnumMember(Value = "delivered")] - Delivered = 5, + Delivered = 6, /// /// Enum Request for value: request /// [EnumMember(Value = "request")] - Request = 6, + Request = 7, /// /// Enum Click for value: click /// [EnumMember(Value = "click")] - Click = 7, + Click = 8, /// /// Enum Invalid for value: invalid /// [EnumMember(Value = "invalid")] - Invalid = 8, + Invalid = 9, /// /// Enum Deferred for value: deferred /// [EnumMember(Value = "deferred")] - Deferred = 9, + Deferred = 10, /// /// Enum Opened for value: opened /// [EnumMember(Value = "opened")] - Opened = 10, + Opened = 11, /// /// Enum UniqueOpened for value: uniqueOpened /// [EnumMember(Value = "uniqueOpened")] - UniqueOpened = 11, + UniqueOpened = 12, /// /// Enum Unsubscribed for value: unsubscribed /// [EnumMember(Value = "unsubscribed")] - Unsubscribed = 12, + Unsubscribed = 13, /// /// Enum ListAddition for value: listAddition /// [EnumMember(Value = "listAddition")] - ListAddition = 13, + ListAddition = 14, /// /// Enum ContactUpdated for value: contactUpdated /// [EnumMember(Value = "contactUpdated")] - ContactUpdated = 14, + ContactUpdated = 15, /// /// Enum ContactDeleted for value: contactDeleted /// [EnumMember(Value = "contactDeleted")] - ContactDeleted = 15 + ContactDeleted = 16 } /// - /// Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered + /// Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` /// - /// Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered + /// Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` [DataMember(Name="events", EmitDefaultValue=false)] public List Events { get; set; } /// @@ -170,7 +176,7 @@ protected CreateWebhook() { } /// /// URL of the webhook (required). /// Description of the webhook. - /// Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered (required). + /// Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` (required). /// Type of the webhook (default to TypeEnum.Transactional). public CreateWebhook(string url = default(string), string description = default(string), List events = default(List), TypeEnum? type = TypeEnum.Transactional) { diff --git a/src/sib_api_v3_sdk/Model/EmailExportRecipients.cs b/src/sib_api_v3_sdk/Model/EmailExportRecipients.cs index c619671..4415d56 100644 --- a/src/sib_api_v3_sdk/Model/EmailExportRecipients.cs +++ b/src/sib_api_v3_sdk/Model/EmailExportRecipients.cs @@ -99,7 +99,7 @@ protected EmailExportRecipients() { } /// /// Initializes a new instance of the class. /// - /// Webhook called once the export process is finished. + /// Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479. /// Type of recipients to export for a campaign (required). public EmailExportRecipients(string notifyURL = default(string), RecipientsTypeEnum recipientsType = default(RecipientsTypeEnum)) { @@ -116,9 +116,9 @@ protected EmailExportRecipients() { } } /// - /// Webhook called once the export process is finished + /// Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 /// - /// Webhook called once the export process is finished + /// Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 [DataMember(Name="notifyURL", EmitDefaultValue=false)] public string NotifyURL { get; set; } diff --git a/src/sib_api_v3_sdk/Model/GetAggregatedReport.cs b/src/sib_api_v3_sdk/Model/GetAggregatedReport.cs index 7ee5f0b..ac5777f 100644 --- a/src/sib_api_v3_sdk/Model/GetAggregatedReport.cs +++ b/src/sib_api_v3_sdk/Model/GetAggregatedReport.cs @@ -31,143 +31,34 @@ public partial class GetAggregatedReport : IEquatable /// /// Initializes a new instance of the class. /// - [JsonConstructorAttribute] - protected GetAggregatedReport() { } - /// - /// Initializes a new instance of the class. - /// - /// Time frame of the report (required). - /// Number of requests for the timeframe (required). - /// Number of delivered emails for the timeframe (required). - /// Number of hardbounces for the timeframe (required). - /// Number of softbounces for the timeframe (required). - /// Number of clicks for the timeframe (required). - /// Number of unique clicks for the timeframe (required). - /// Number of openings for the timeframe (required). - /// Number of unique openings for the timeframe (required). - /// Number of complaint (spam report) for the timeframe (required). - /// Number of blocked contact emails for the timeframe (required). - /// Number of invalid emails for the timeframe (required). - /// Number of unsubscribed emails for the timeframe (required). + /// Time frame of the report. + /// Number of requests for the timeframe. + /// Number of delivered emails for the timeframe. + /// Number of hardbounces for the timeframe. + /// Number of softbounces for the timeframe. + /// Number of clicks for the timeframe. + /// Number of unique clicks for the timeframe. + /// Number of openings for the timeframe. + /// Number of unique openings for the timeframe. + /// Number of complaint (spam report) for the timeframe. + /// Number of blocked contact emails for the timeframe. + /// Number of invalid emails for the timeframe. + /// Number of unsubscribed emails for the timeframe. public GetAggregatedReport(string range = default(string), long? requests = default(long?), long? delivered = default(long?), long? hardBounces = default(long?), long? softBounces = default(long?), long? clicks = default(long?), long? uniqueClicks = default(long?), long? opens = default(long?), long? uniqueOpens = default(long?), long? spamReports = default(long?), long? blocked = default(long?), long? invalid = default(long?), long? unsubscribed = default(long?)) { - // to ensure "range" is required (not null) - if (range == null) - { - throw new InvalidDataException("range is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.Range = range; - } - // to ensure "requests" is required (not null) - if (requests == null) - { - throw new InvalidDataException("requests is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.Requests = requests; - } - // to ensure "delivered" is required (not null) - if (delivered == null) - { - throw new InvalidDataException("delivered is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.Delivered = delivered; - } - // to ensure "hardBounces" is required (not null) - if (hardBounces == null) - { - throw new InvalidDataException("hardBounces is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.HardBounces = hardBounces; - } - // to ensure "softBounces" is required (not null) - if (softBounces == null) - { - throw new InvalidDataException("softBounces is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.SoftBounces = softBounces; - } - // to ensure "clicks" is required (not null) - if (clicks == null) - { - throw new InvalidDataException("clicks is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.Clicks = clicks; - } - // to ensure "uniqueClicks" is required (not null) - if (uniqueClicks == null) - { - throw new InvalidDataException("uniqueClicks is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.UniqueClicks = uniqueClicks; - } - // to ensure "opens" is required (not null) - if (opens == null) - { - throw new InvalidDataException("opens is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.Opens = opens; - } - // to ensure "uniqueOpens" is required (not null) - if (uniqueOpens == null) - { - throw new InvalidDataException("uniqueOpens is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.UniqueOpens = uniqueOpens; - } - // to ensure "spamReports" is required (not null) - if (spamReports == null) - { - throw new InvalidDataException("spamReports is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.SpamReports = spamReports; - } - // to ensure "blocked" is required (not null) - if (blocked == null) - { - throw new InvalidDataException("blocked is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.Blocked = blocked; - } - // to ensure "invalid" is required (not null) - if (invalid == null) - { - throw new InvalidDataException("invalid is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.Invalid = invalid; - } - // to ensure "unsubscribed" is required (not null) - if (unsubscribed == null) - { - throw new InvalidDataException("unsubscribed is a required property for GetAggregatedReport and cannot be null"); - } - else - { - this.Unsubscribed = unsubscribed; - } + this.Range = range; + this.Requests = requests; + this.Delivered = delivered; + this.HardBounces = hardBounces; + this.SoftBounces = softBounces; + this.Clicks = clicks; + this.UniqueClicks = uniqueClicks; + this.Opens = opens; + this.UniqueOpens = uniqueOpens; + this.SpamReports = spamReports; + this.Blocked = blocked; + this.Invalid = invalid; + this.Unsubscribed = unsubscribed; } /// diff --git a/src/sib_api_v3_sdk/Model/GetCampaignStats.cs b/src/sib_api_v3_sdk/Model/GetCampaignStats.cs index 642803c..52d149d 100644 --- a/src/sib_api_v3_sdk/Model/GetCampaignStats.cs +++ b/src/sib_api_v3_sdk/Model/GetCampaignStats.cs @@ -48,7 +48,8 @@ protected GetCampaignStats() { } /// Number of unsubscription for the campaign (required). /// Number of openings for the campaign (required). /// Number of deferred emails for the campaign. - public GetCampaignStats(long? listId = default(long?), long? uniqueClicks = default(long?), long? clickers = default(long?), long? complaints = default(long?), long? delivered = default(long?), long? sent = default(long?), long? softBounces = default(long?), long? hardBounces = default(long?), long? uniqueViews = default(long?), long? unsubscriptions = default(long?), long? viewed = default(long?), long? deferred = default(long?)) + /// Total number of non-delivered campaigns for a particular campaign id.. + public GetCampaignStats(long? listId = default(long?), long? uniqueClicks = default(long?), long? clickers = default(long?), long? complaints = default(long?), long? delivered = default(long?), long? sent = default(long?), long? softBounces = default(long?), long? hardBounces = default(long?), long? uniqueViews = default(long?), long? unsubscriptions = default(long?), long? viewed = default(long?), long? deferred = default(long?), long? returnBounce = default(long?)) { // to ensure "uniqueClicks" is required (not null) if (uniqueClicks == null) @@ -142,6 +143,7 @@ protected GetCampaignStats() { } } this.ListId = listId; this.Deferred = deferred; + this.ReturnBounce = returnBounce; } /// @@ -228,6 +230,13 @@ protected GetCampaignStats() { } [DataMember(Name="deferred", EmitDefaultValue=false)] public long? Deferred { get; set; } + /// + /// Total number of non-delivered campaigns for a particular campaign id. + /// + /// Total number of non-delivered campaigns for a particular campaign id. + [DataMember(Name="returnBounce", EmitDefaultValue=false)] + public long? ReturnBounce { get; set; } + /// /// Returns the string presentation of the object /// @@ -248,6 +257,7 @@ public override string ToString() sb.Append(" Unsubscriptions: ").Append(Unsubscriptions).Append("\n"); sb.Append(" Viewed: ").Append(Viewed).Append("\n"); sb.Append(" Deferred: ").Append(Deferred).Append("\n"); + sb.Append(" ReturnBounce: ").Append(ReturnBounce).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -341,6 +351,11 @@ public bool Equals(GetCampaignStats input) this.Deferred == input.Deferred || (this.Deferred != null && this.Deferred.Equals(input.Deferred)) + ) && + ( + this.ReturnBounce == input.ReturnBounce || + (this.ReturnBounce != null && + this.ReturnBounce.Equals(input.ReturnBounce)) ); } @@ -377,6 +392,8 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.Viewed.GetHashCode(); if (this.Deferred != null) hashCode = hashCode * 59 + this.Deferred.GetHashCode(); + if (this.ReturnBounce != null) + hashCode = hashCode * 59 + this.ReturnBounce.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/GetEmailCampaign.cs b/src/sib_api_v3_sdk/Model/GetEmailCampaign.cs index d4cf7e8..d2637f7 100644 --- a/src/sib_api_v3_sdk/Model/GetEmailCampaign.cs +++ b/src/sib_api_v3_sdk/Model/GetEmailCampaign.cs @@ -142,9 +142,10 @@ protected GetEmailCampaign() { } /// Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign. /// FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times. /// Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'. + /// Total number of non-delivered campaigns for a particular campaign id.. /// recipients (required). /// statistics (required). - public GetEmailCampaign(long? id = default(long?), string name = default(string), string subject = default(string), TypeEnum type = default(TypeEnum), StatusEnum status = default(StatusEnum), DateTime? scheduledAt = default(DateTime?), bool? abTesting = default(bool?), string subjectA = default(string), string subjectB = default(string), int? splitRule = default(int?), string winnerCriteria = default(string), int? winnerDelay = default(int?), bool? sendAtBestTime = default(bool?), bool? testSent = default(bool?), string header = default(string), string footer = default(string), GetExtendedCampaignOverviewSender sender = default(GetExtendedCampaignOverviewSender), string replyTo = default(string), string toField = default(string), string htmlContent = default(string), string shareLink = default(string), string tag = default(string), DateTime? createdAt = default(DateTime?), DateTime? modifiedAt = default(DateTime?), bool? inlineImageActivation = default(bool?), bool? mirrorActive = default(bool?), bool? recurring = default(bool?), DateTime? sentDate = default(DateTime?), Object recipients = default(Object), Object statistics = default(Object)) + public GetEmailCampaign(long? id = default(long?), string name = default(string), string subject = default(string), TypeEnum type = default(TypeEnum), StatusEnum status = default(StatusEnum), DateTime? scheduledAt = default(DateTime?), bool? abTesting = default(bool?), string subjectA = default(string), string subjectB = default(string), int? splitRule = default(int?), string winnerCriteria = default(string), int? winnerDelay = default(int?), bool? sendAtBestTime = default(bool?), bool? testSent = default(bool?), string header = default(string), string footer = default(string), GetExtendedCampaignOverviewSender sender = default(GetExtendedCampaignOverviewSender), string replyTo = default(string), string toField = default(string), string htmlContent = default(string), string shareLink = default(string), string tag = default(string), DateTime? createdAt = default(DateTime?), DateTime? modifiedAt = default(DateTime?), bool? inlineImageActivation = default(bool?), bool? mirrorActive = default(bool?), bool? recurring = default(bool?), DateTime? sentDate = default(DateTime?), long? returnBounce = default(long?), Object recipients = default(Object), Object statistics = default(Object)) { // to ensure "id" is required (not null) if (id == null) @@ -304,6 +305,7 @@ protected GetEmailCampaign() { } this.MirrorActive = mirrorActive; this.Recurring = recurring; this.SentDate = sentDate; + this.ReturnBounce = returnBounce; } /// @@ -489,6 +491,13 @@ protected GetEmailCampaign() { } [DataMember(Name="sentDate", EmitDefaultValue=false)] public DateTime? SentDate { get; set; } + /// + /// Total number of non-delivered campaigns for a particular campaign id. + /// + /// Total number of non-delivered campaigns for a particular campaign id. + [DataMember(Name="returnBounce", EmitDefaultValue=false)] + public long? ReturnBounce { get; set; } + /// /// Gets or Sets Recipients /// @@ -537,6 +546,7 @@ public override string ToString() sb.Append(" MirrorActive: ").Append(MirrorActive).Append("\n"); sb.Append(" Recurring: ").Append(Recurring).Append("\n"); sb.Append(" SentDate: ").Append(SentDate).Append("\n"); + sb.Append(" ReturnBounce: ").Append(ReturnBounce).Append("\n"); sb.Append(" Recipients: ").Append(Recipients).Append("\n"); sb.Append(" Statistics: ").Append(Statistics).Append("\n"); sb.Append("}\n"); @@ -713,6 +723,11 @@ public bool Equals(GetEmailCampaign input) (this.SentDate != null && this.SentDate.Equals(input.SentDate)) ) && + ( + this.ReturnBounce == input.ReturnBounce || + (this.ReturnBounce != null && + this.ReturnBounce.Equals(input.ReturnBounce)) + ) && ( this.Recipients == input.Recipients || (this.Recipients != null && @@ -790,6 +805,8 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.Recurring.GetHashCode(); if (this.SentDate != null) hashCode = hashCode * 59 + this.SentDate.GetHashCode(); + if (this.ReturnBounce != null) + hashCode = hashCode * 59 + this.ReturnBounce.GetHashCode(); if (this.Recipients != null) hashCode = hashCode * 59 + this.Recipients.GetHashCode(); if (this.Statistics != null) diff --git a/src/sib_api_v3_sdk/Model/GetExtendedCampaignOverview.cs b/src/sib_api_v3_sdk/Model/GetExtendedCampaignOverview.cs index d40bbf4..e599e93 100644 --- a/src/sib_api_v3_sdk/Model/GetExtendedCampaignOverview.cs +++ b/src/sib_api_v3_sdk/Model/GetExtendedCampaignOverview.cs @@ -142,7 +142,8 @@ protected GetExtendedCampaignOverview() { } /// Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign. /// FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times. /// Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'. - public GetExtendedCampaignOverview(long? id = default(long?), string name = default(string), string subject = default(string), TypeEnum type = default(TypeEnum), StatusEnum status = default(StatusEnum), DateTime? scheduledAt = default(DateTime?), bool? abTesting = default(bool?), string subjectA = default(string), string subjectB = default(string), int? splitRule = default(int?), string winnerCriteria = default(string), int? winnerDelay = default(int?), bool? sendAtBestTime = default(bool?), bool? testSent = default(bool?), string header = default(string), string footer = default(string), GetExtendedCampaignOverviewSender sender = default(GetExtendedCampaignOverviewSender), string replyTo = default(string), string toField = default(string), string htmlContent = default(string), string shareLink = default(string), string tag = default(string), DateTime? createdAt = default(DateTime?), DateTime? modifiedAt = default(DateTime?), bool? inlineImageActivation = default(bool?), bool? mirrorActive = default(bool?), bool? recurring = default(bool?), DateTime? sentDate = default(DateTime?)) + /// Total number of non-delivered campaigns for a particular campaign id.. + public GetExtendedCampaignOverview(long? id = default(long?), string name = default(string), string subject = default(string), TypeEnum type = default(TypeEnum), StatusEnum status = default(StatusEnum), DateTime? scheduledAt = default(DateTime?), bool? abTesting = default(bool?), string subjectA = default(string), string subjectB = default(string), int? splitRule = default(int?), string winnerCriteria = default(string), int? winnerDelay = default(int?), bool? sendAtBestTime = default(bool?), bool? testSent = default(bool?), string header = default(string), string footer = default(string), GetExtendedCampaignOverviewSender sender = default(GetExtendedCampaignOverviewSender), string replyTo = default(string), string toField = default(string), string htmlContent = default(string), string shareLink = default(string), string tag = default(string), DateTime? createdAt = default(DateTime?), DateTime? modifiedAt = default(DateTime?), bool? inlineImageActivation = default(bool?), bool? mirrorActive = default(bool?), bool? recurring = default(bool?), DateTime? sentDate = default(DateTime?), long? returnBounce = default(long?)) { // to ensure "id" is required (not null) if (id == null) @@ -284,6 +285,7 @@ protected GetExtendedCampaignOverview() { } this.MirrorActive = mirrorActive; this.Recurring = recurring; this.SentDate = sentDate; + this.ReturnBounce = returnBounce; } /// @@ -469,6 +471,13 @@ protected GetExtendedCampaignOverview() { } [DataMember(Name="sentDate", EmitDefaultValue=false)] public DateTime? SentDate { get; set; } + /// + /// Total number of non-delivered campaigns for a particular campaign id. + /// + /// Total number of non-delivered campaigns for a particular campaign id. + [DataMember(Name="returnBounce", EmitDefaultValue=false)] + public long? ReturnBounce { get; set; } + /// /// Returns the string presentation of the object /// @@ -505,6 +514,7 @@ public override string ToString() sb.Append(" MirrorActive: ").Append(MirrorActive).Append("\n"); sb.Append(" Recurring: ").Append(Recurring).Append("\n"); sb.Append(" SentDate: ").Append(SentDate).Append("\n"); + sb.Append(" ReturnBounce: ").Append(ReturnBounce).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -678,6 +688,11 @@ public bool Equals(GetExtendedCampaignOverview input) this.SentDate == input.SentDate || (this.SentDate != null && this.SentDate.Equals(input.SentDate)) + ) && + ( + this.ReturnBounce == input.ReturnBounce || + (this.ReturnBounce != null && + this.ReturnBounce.Equals(input.ReturnBounce)) ); } @@ -746,6 +761,8 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.Recurring.GetHashCode(); if (this.SentDate != null) hashCode = hashCode * 59 + this.SentDate.GetHashCode(); + if (this.ReturnBounce != null) + hashCode = hashCode * 59 + this.ReturnBounce.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.cs b/src/sib_api_v3_sdk/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.cs index 5fbca57..b85feb8 100644 --- a/src/sib_api_v3_sdk/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.cs +++ b/src/sib_api_v3_sdk/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.cs @@ -37,7 +37,7 @@ protected GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription( /// Initializes a new instance of the class. /// /// UTC date-time of the event (required). - /// IP from which the user has been unsubscribed (required). + /// IP from which the user has been unsubscribed. public GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription(DateTime? eventTime = default(DateTime?), string ip = default(string)) { // to ensure "eventTime" is required (not null) @@ -49,15 +49,7 @@ protected GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription( { this.EventTime = eventTime; } - // to ensure "ip" is required (not null) - if (ip == null) - { - throw new InvalidDataException("ip is a required property for GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription and cannot be null"); - } - else - { - this.Ip = ip; - } + this.Ip = ip; } /// diff --git a/src/sib_api_v3_sdk/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.cs b/src/sib_api_v3_sdk/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.cs index b604dd5..d17d605 100644 --- a/src/sib_api_v3_sdk/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.cs +++ b/src/sib_api_v3_sdk/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.cs @@ -38,7 +38,7 @@ protected GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription() /// /// ID of the campaign which generated the event (required). /// UTC date-time of the event (required). - /// IP from which the user has unsubscribed (required). + /// IP from which the user has unsubscribed. public GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription(long? campaignId = default(long?), DateTime? eventTime = default(DateTime?), string ip = default(string)) { // to ensure "campaignId" is required (not null) @@ -59,15 +59,7 @@ protected GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription() { this.EventTime = eventTime; } - // to ensure "ip" is required (not null) - if (ip == null) - { - throw new InvalidDataException("ip is a required property for GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription and cannot be null"); - } - else - { - this.Ip = ip; - } + this.Ip = ip; } /// diff --git a/src/sib_api_v3_sdk/Model/GetSmtpTemplateOverview.cs b/src/sib_api_v3_sdk/Model/GetSmtpTemplateOverview.cs index 3fb1d25..dfdf42a 100644 --- a/src/sib_api_v3_sdk/Model/GetSmtpTemplateOverview.cs +++ b/src/sib_api_v3_sdk/Model/GetSmtpTemplateOverview.cs @@ -48,7 +48,8 @@ protected GetSmtpTemplateOverview() { } /// HTML content of the template (required). /// Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) (required). /// Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) (required). - public GetSmtpTemplateOverview(long? id = default(long?), string name = default(string), string subject = default(string), bool? isActive = default(bool?), bool? testSent = default(bool?), GetSmtpTemplateOverviewSender sender = default(GetSmtpTemplateOverviewSender), string replyTo = default(string), string toField = default(string), string tag = default(string), string htmlContent = default(string), DateTime? createdAt = default(DateTime?), DateTime? modifiedAt = default(DateTime?)) + /// It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call.. + public GetSmtpTemplateOverview(long? id = default(long?), string name = default(string), string subject = default(string), bool? isActive = default(bool?), bool? testSent = default(bool?), GetSmtpTemplateOverviewSender sender = default(GetSmtpTemplateOverviewSender), string replyTo = default(string), string toField = default(string), string tag = default(string), string htmlContent = default(string), DateTime? createdAt = default(DateTime?), DateTime? modifiedAt = default(DateTime?), bool? doiTemplate = default(bool?)) { // to ensure "id" is required (not null) if (id == null) @@ -158,6 +159,7 @@ protected GetSmtpTemplateOverview() { } { this.ModifiedAt = modifiedAt; } + this.DoiTemplate = doiTemplate; } /// @@ -243,6 +245,13 @@ protected GetSmtpTemplateOverview() { } [DataMember(Name="modifiedAt", EmitDefaultValue=false)] public DateTime? ModifiedAt { get; set; } + /// + /// It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. + /// + /// It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. + [DataMember(Name="doiTemplate", EmitDefaultValue=false)] + public bool? DoiTemplate { get; set; } + /// /// Returns the string presentation of the object /// @@ -263,6 +272,7 @@ public override string ToString() sb.Append(" HtmlContent: ").Append(HtmlContent).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); + sb.Append(" DoiTemplate: ").Append(DoiTemplate).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -356,6 +366,11 @@ public bool Equals(GetSmtpTemplateOverview input) this.ModifiedAt == input.ModifiedAt || (this.ModifiedAt != null && this.ModifiedAt.Equals(input.ModifiedAt)) + ) && + ( + this.DoiTemplate == input.DoiTemplate || + (this.DoiTemplate != null && + this.DoiTemplate.Equals(input.DoiTemplate)) ); } @@ -392,6 +407,8 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.CreatedAt.GetHashCode(); if (this.ModifiedAt != null) hashCode = hashCode * 59 + this.ModifiedAt.GetHashCode(); + if (this.DoiTemplate != null) + hashCode = hashCode * 59 + this.DoiTemplate.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/PostContactInfoContacts.cs b/src/sib_api_v3_sdk/Model/PostContactInfoContacts.cs index e849b11..92419ae 100644 --- a/src/sib_api_v3_sdk/Model/PostContactInfoContacts.cs +++ b/src/sib_api_v3_sdk/Model/PostContactInfoContacts.cs @@ -34,11 +34,13 @@ public partial class PostContactInfoContacts : IEquatablesuccess. /// failure. /// 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?)) + /// Id of the process created to remove contacts from list when user opts for "all" option.. + public PostContactInfoContacts(List success = default(List), List failure = default(List), long? total = default(long?), long? processId = default(long?)) { this.Success = success; this.Failure = failure; this.Total = total; + this.ProcessId = processId; } /// @@ -60,6 +62,13 @@ public partial class PostContactInfoContacts : IEquatable + /// Id of the process created to remove contacts from list when user opts for "all" option. + /// + /// Id of the process created to remove contacts from list when user opts for "all" option. + [DataMember(Name="processId", EmitDefaultValue=false)] + public long? ProcessId { get; set; } + /// /// Returns the string presentation of the object /// @@ -71,6 +80,7 @@ public override string ToString() sb.Append(" Success: ").Append(Success).Append("\n"); sb.Append(" Failure: ").Append(Failure).Append("\n"); sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" ProcessId: ").Append(ProcessId).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -119,6 +129,11 @@ public bool Equals(PostContactInfoContacts input) this.Total == input.Total || (this.Total != null && this.Total.Equals(input.Total)) + ) && + ( + this.ProcessId == input.ProcessId || + (this.ProcessId != null && + this.ProcessId.Equals(input.ProcessId)) ); } @@ -137,6 +152,8 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.Failure.GetHashCode(); if (this.Total != null) hashCode = hashCode * 59 + this.Total.GetHashCode(); + if (this.ProcessId != null) + hashCode = hashCode * 59 + this.ProcessId.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/RemoveContactFromList.cs b/src/sib_api_v3_sdk/Model/RemoveContactFromList.cs index 4910043..96f606c 100644 --- a/src/sib_api_v3_sdk/Model/RemoveContactFromList.cs +++ b/src/sib_api_v3_sdk/Model/RemoveContactFromList.cs @@ -32,10 +32,12 @@ public partial class RemoveContactFromList : IEquatable /// Initializes a new instance of the class. /// /// 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?)) + /// Mandatory if Emails are not passed, ignored otherwise. 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.. + /// Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress. + public RemoveContactFromList(List emails = default(List), List ids = default(List), bool? all = default(bool?)) { this.Emails = emails; + this.Ids = ids; this.All = all; } @@ -47,9 +49,16 @@ public partial class RemoveContactFromList : IEquatable public List Emails { get; set; } /// - /// Required if 'emails' is empty. Remove all existing contacts from a list + /// Mandatory if Emails are not passed, ignored otherwise. 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. /// - /// Required if 'emails' is empty. Remove all existing contacts from a list + /// Mandatory if Emails are not passed, ignored otherwise. 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="ids", EmitDefaultValue=false)] + public List Ids { get; set; } + + /// + /// Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress + /// + /// Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress [DataMember(Name="all", EmitDefaultValue=false)] public bool? All { get; set; } @@ -62,6 +71,7 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class RemoveContactFromList {\n"); sb.Append(" Emails: ").Append(Emails).Append("\n"); + sb.Append(" Ids: ").Append(Ids).Append("\n"); sb.Append(" All: ").Append(All).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -102,6 +112,11 @@ public bool Equals(RemoveContactFromList input) this.Emails != null && this.Emails.SequenceEqual(input.Emails) ) && + ( + this.Ids == input.Ids || + this.Ids != null && + this.Ids.SequenceEqual(input.Ids) + ) && ( this.All == input.All || (this.All != null && @@ -120,6 +135,8 @@ public override int GetHashCode() int hashCode = 41; if (this.Emails != null) hashCode = hashCode * 59 + this.Emails.GetHashCode(); + if (this.Ids != null) + hashCode = hashCode * 59 + this.Ids.GetHashCode(); if (this.All != null) hashCode = hashCode * 59 + this.All.GetHashCode(); return hashCode; diff --git a/src/sib_api_v3_sdk/Model/RequestContactExport.cs b/src/sib_api_v3_sdk/Model/RequestContactExport.cs index 1dde3d1..a158ac9 100644 --- a/src/sib_api_v3_sdk/Model/RequestContactExport.cs +++ b/src/sib_api_v3_sdk/Model/RequestContactExport.cs @@ -34,7 +34,7 @@ public partial class RequestContactExport : IEquatable /// 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. . /// customContactFilter. - /// Webhook that will be called once the export process is finished. + /// Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479. public RequestContactExport(List exportAttributes = default(List), Object contactFilter = default(Object), RequestContactExportCustomContactFilter customContactFilter = default(RequestContactExportCustomContactFilter), string notifyUrl = default(string)) { this.ExportAttributes = exportAttributes; @@ -64,9 +64,9 @@ public partial class RequestContactExport : IEquatable public RequestContactExportCustomContactFilter CustomContactFilter { get; set; } /// - /// Webhook that will be called once the export process is finished + /// Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 /// - /// Webhook that will be called once the export process is finished + /// Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 [DataMember(Name="notifyUrl", EmitDefaultValue=false)] public string NotifyUrl { get; set; } diff --git a/src/sib_api_v3_sdk/Model/RequestContactImport.cs b/src/sib_api_v3_sdk/Model/RequestContactImport.cs index f3148fc..2d2ed5f 100644 --- a/src/sib_api_v3_sdk/Model/RequestContactImport.cs +++ b/src/sib_api_v3_sdk/Model/RequestContactImport.cs @@ -34,7 +34,7 @@ public partial class RequestContactImport : IEquatable /// 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. 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. + /// URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479. /// newList. /// To blacklist all the contacts for email (default to false). /// To blacklist all the contacts for sms (default to false). @@ -107,9 +107,9 @@ public partial class RequestContactImport : IEquatable public List ListIds { get; set; } /// - /// URL that will be called once the export process is finished + /// URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 /// - /// URL that will be called once the export process is finished + /// URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 [DataMember(Name="notifyUrl", EmitDefaultValue=false)] public string NotifyUrl { get; set; } diff --git a/src/sib_api_v3_sdk/Model/RequestSmsRecipientExport.cs b/src/sib_api_v3_sdk/Model/RequestSmsRecipientExport.cs index dffc4ab..adbd941 100644 --- a/src/sib_api_v3_sdk/Model/RequestSmsRecipientExport.cs +++ b/src/sib_api_v3_sdk/Model/RequestSmsRecipientExport.cs @@ -87,7 +87,7 @@ protected RequestSmsRecipientExport() { } /// /// Initializes a new instance of the class. /// - /// URL that will be called once the export process is finished. + /// URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479. /// Filter the recipients based on how they interacted with the campaign (required). public RequestSmsRecipientExport(string notifyURL = default(string), RecipientsTypeEnum recipientsType = default(RecipientsTypeEnum)) { @@ -104,9 +104,9 @@ protected RequestSmsRecipientExport() { } } /// - /// URL that will be called once the export process is finished + /// URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 /// - /// URL that will be called once the export process is finished + /// URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 [DataMember(Name="notifyURL", EmitDefaultValue=false)] public string NotifyURL { get; set; } diff --git a/src/sib_api_v3_sdk/Model/SendReportEmail.cs b/src/sib_api_v3_sdk/Model/SendReportEmail.cs index 60fbf4c..1a719b1 100644 --- a/src/sib_api_v3_sdk/Model/SendReportEmail.cs +++ b/src/sib_api_v3_sdk/Model/SendReportEmail.cs @@ -23,38 +23,11 @@ namespace sib_api_v3_sdk.Model { /// - /// Email sending credentials including subject, body, to, cc etc. + /// Custom attributes for the report email. /// [DataContract] public partial class SendReportEmail : IEquatable { - /// - /// Type of the message body - /// - /// Type of the message body - [JsonConverter(typeof(StringEnumConverter))] - public enum ContentTypeEnum - { - - /// - /// Enum Text for value: text - /// - [EnumMember(Value = "text")] - Text = 1, - - /// - /// Enum Html for value: html - /// - [EnumMember(Value = "html")] - Html = 2 - } - - /// - /// Type of the message body - /// - /// Type of the message body - [DataMember(Name="contentType", EmitDefaultValue=false)] - public ContentTypeEnum? ContentType { get; set; } /// /// Initializes a new instance of the class. /// @@ -63,23 +36,10 @@ protected SendReportEmail() { } /// /// Initializes a new instance of the class. /// - /// Subject of the email message (required). /// Email addresses of the recipients (required). - /// Type of the message body (default to ContentTypeEnum.Html). - /// Email addresses of the recipients in bcc. - /// Email addresses of the recipients in cc. - /// Body of the email message (required). - public SendReportEmail(string subject = default(string), List to = default(List), ContentTypeEnum? contentType = ContentTypeEnum.Html, List bcc = default(List), List cc = default(List), string body = default(string)) + /// Custom text message to be presented in the report email. (required). + public SendReportEmail(List to = default(List), string body = default(string)) { - // to ensure "subject" is required (not null) - if (subject == null) - { - throw new InvalidDataException("subject is a required property for SendReportEmail and cannot be null"); - } - else - { - this.Subject = subject; - } // to ensure "to" is required (not null) if (to == null) { @@ -98,26 +58,8 @@ protected SendReportEmail() { } { this.Body = body; } - // use default value if no "contentType" provided - if (contentType == null) - { - this.ContentType = ContentTypeEnum.Html; - } - else - { - this.ContentType = contentType; - } - this.Bcc = bcc; - this.Cc = cc; } - /// - /// Subject of the email message - /// - /// Subject of the email message - [DataMember(Name="subject", EmitDefaultValue=false)] - public string Subject { get; set; } - /// /// Email addresses of the recipients /// @@ -125,25 +67,10 @@ protected SendReportEmail() { } [DataMember(Name="to", EmitDefaultValue=false)] public List To { get; set; } - - /// - /// Email addresses of the recipients in bcc - /// - /// Email addresses of the recipients in bcc - [DataMember(Name="bcc", EmitDefaultValue=false)] - public List Bcc { get; set; } - - /// - /// Email addresses of the recipients in cc - /// - /// Email addresses of the recipients in cc - [DataMember(Name="cc", EmitDefaultValue=false)] - public List Cc { get; set; } - /// - /// Body of the email message + /// Custom text message to be presented in the report email. /// - /// Body of the email message + /// Custom text message to be presented in the report email. [DataMember(Name="body", EmitDefaultValue=false)] public string Body { get; set; } @@ -155,11 +82,7 @@ public override string ToString() { var sb = new StringBuilder(); sb.Append("class SendReportEmail {\n"); - sb.Append(" Subject: ").Append(Subject).Append("\n"); sb.Append(" To: ").Append(To).Append("\n"); - sb.Append(" ContentType: ").Append(ContentType).Append("\n"); - sb.Append(" Bcc: ").Append(Bcc).Append("\n"); - sb.Append(" Cc: ").Append(Cc).Append("\n"); sb.Append(" Body: ").Append(Body).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -195,31 +118,11 @@ public bool Equals(SendReportEmail input) return false; return - ( - this.Subject == input.Subject || - (this.Subject != null && - this.Subject.Equals(input.Subject)) - ) && ( this.To == input.To || this.To != null && this.To.SequenceEqual(input.To) ) && - ( - this.ContentType == input.ContentType || - (this.ContentType != null && - this.ContentType.Equals(input.ContentType)) - ) && - ( - this.Bcc == input.Bcc || - this.Bcc != null && - this.Bcc.SequenceEqual(input.Bcc) - ) && - ( - this.Cc == input.Cc || - this.Cc != null && - this.Cc.SequenceEqual(input.Cc) - ) && ( this.Body == input.Body || (this.Body != null && @@ -236,16 +139,8 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.Subject != null) - hashCode = hashCode * 59 + this.Subject.GetHashCode(); if (this.To != null) hashCode = hashCode * 59 + this.To.GetHashCode(); - if (this.ContentType != null) - hashCode = hashCode * 59 + this.ContentType.GetHashCode(); - if (this.Bcc != null) - hashCode = hashCode * 59 + this.Bcc.GetHashCode(); - if (this.Cc != null) - hashCode = hashCode * 59 + this.Cc.GetHashCode(); if (this.Body != null) hashCode = hashCode * 59 + this.Body.GetHashCode(); return hashCode; diff --git a/src/sib_api_v3_sdk/Model/SendSmtpEmail.cs b/src/sib_api_v3_sdk/Model/SendSmtpEmail.cs index 38c15fe..3da898f 100644 --- a/src/sib_api_v3_sdk/Model/SendSmtpEmail.cs +++ b/src/sib_api_v3_sdk/Model/SendSmtpEmail.cs @@ -44,7 +44,7 @@ protected SendSmtpEmail() { } /// 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 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":"myAttachmentFromUrl.jpg"}, {"content":"base64 example content", "name":"myAttachmentFromBase64.jpg"}]`. 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.. @@ -129,9 +129,9 @@ 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":"myAttachmentFromUrl.jpg"}, {"content":"base64 example content", "name":"myAttachmentFromBase64.jpg"}]`. 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":"myAttachmentFromUrl.jpg"}, {"content":"base64 example content", "name":"myAttachmentFromBase64.jpg"}]`. 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; } diff --git a/src/sib_api_v3_sdk/Model/SendSmtpEmailSender.cs b/src/sib_api_v3_sdk/Model/SendSmtpEmailSender.cs index bd2741c..8e91f06 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 or id of sender from which emails will be sent. `name` will be ignored if passed along with sender `id`. For example, {"name":"Mary from MyShop", "email":"no-reply@myshop.com"} or {"id":2} /// [DataContract] public partial class SendSmtpEmailSender : IEquatable @@ -38,7 +38,8 @@ protected SendSmtpEmailSender() { } /// /// Name of the sender from which the emails will be sent. Maximum allowed characters are 70.. /// Email of the sender from which the emails will be sent (required). - public SendSmtpEmailSender(string name = default(string), string email = default(string)) + /// Id of the sender from which the emails will be sent. + public SendSmtpEmailSender(string name = default(string), string email = default(string), long? id = default(long?)) { // to ensure "email" is required (not null) if (email == null) @@ -50,6 +51,7 @@ protected SendSmtpEmailSender() { } this.Email = email; } this.Name = name; + this.Id = id; } /// @@ -66,6 +68,13 @@ protected SendSmtpEmailSender() { } [DataMember(Name="email", EmitDefaultValue=false)] public string Email { get; set; } + /// + /// Id of the sender from which the emails will be sent + /// + /// Id of the sender from which the emails will be sent + [DataMember(Name="id", EmitDefaultValue=false)] + public long? Id { get; set; } + /// /// Returns the string presentation of the object /// @@ -76,6 +85,7 @@ public override string ToString() sb.Append("class SendSmtpEmailSender {\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Id: ").Append(Id).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -119,6 +129,11 @@ public bool Equals(SendSmtpEmailSender input) this.Email == input.Email || (this.Email != null && this.Email.Equals(input.Email)) + ) && + ( + this.Id == input.Id || + (this.Id != null && + this.Id.Equals(input.Id)) ); } @@ -135,6 +150,8 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.Name.GetHashCode(); if (this.Email != null) hashCode = hashCode * 59 + this.Email.GetHashCode(); + if (this.Id != null) + hashCode = hashCode * 59 + this.Id.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/SendTransacSms.cs b/src/sib_api_v3_sdk/Model/SendTransacSms.cs index 3f4ad77..91e8218 100644 --- a/src/sib_api_v3_sdk/Model/SendTransacSms.cs +++ b/src/sib_api_v3_sdk/Model/SendTransacSms.cs @@ -63,7 +63,7 @@ protected SendTransacSms() { } /// /// Initializes a new instance of the class. /// - /// Name of the sender. Only alphanumeric characters. No more than 11 characters (required). + /// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** (required). /// Mobile number to send SMS with the country code (required). /// Content of the message. If more than 160 characters long, will be sent as multiple text messages (required). /// Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. (default to TypeEnum.Transactional). @@ -112,9 +112,9 @@ protected SendTransacSms() { } } /// - /// Name of the sender. Only alphanumeric characters. No more than 11 characters + /// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** /// - /// Name of the sender. Only alphanumeric characters. No more than 11 characters + /// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** [DataMember(Name="sender", EmitDefaultValue=false)] public string Sender { get; set; } diff --git a/src/sib_api_v3_sdk/Model/UpdateChildAccountStatus.cs b/src/sib_api_v3_sdk/Model/UpdateChildAccountStatus.cs index 3f4d601..537694f 100644 --- a/src/sib_api_v3_sdk/Model/UpdateChildAccountStatus.cs +++ b/src/sib_api_v3_sdk/Model/UpdateChildAccountStatus.cs @@ -34,11 +34,13 @@ public partial class UpdateChildAccountStatus : IEquatableStatus of Transactional Email Platform activation for your account (true=enabled, false=disabled). /// Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled). /// Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled). - public UpdateChildAccountStatus(bool? transactionalEmail = default(bool?), bool? transactionalSms = default(bool?), bool? marketingAutomation = default(bool?)) + /// Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled). + public UpdateChildAccountStatus(bool? transactionalEmail = default(bool?), bool? transactionalSms = default(bool?), bool? marketingAutomation = default(bool?), bool? smsCampaign = default(bool?)) { this.TransactionalEmail = transactionalEmail; this.TransactionalSms = transactionalSms; this.MarketingAutomation = marketingAutomation; + this.SmsCampaign = smsCampaign; } /// @@ -62,6 +64,13 @@ public partial class UpdateChildAccountStatus : IEquatable + /// Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) + /// + /// Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) + [DataMember(Name="smsCampaign", EmitDefaultValue=false)] + public bool? SmsCampaign { get; set; } + /// /// Returns the string presentation of the object /// @@ -73,6 +82,7 @@ public override string ToString() sb.Append(" TransactionalEmail: ").Append(TransactionalEmail).Append("\n"); sb.Append(" TransactionalSms: ").Append(TransactionalSms).Append("\n"); sb.Append(" MarketingAutomation: ").Append(MarketingAutomation).Append("\n"); + sb.Append(" SmsCampaign: ").Append(SmsCampaign).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -121,6 +131,11 @@ public bool Equals(UpdateChildAccountStatus input) this.MarketingAutomation == input.MarketingAutomation || (this.MarketingAutomation != null && this.MarketingAutomation.Equals(input.MarketingAutomation)) + ) && + ( + this.SmsCampaign == input.SmsCampaign || + (this.SmsCampaign != null && + this.SmsCampaign.Equals(input.SmsCampaign)) ); } @@ -139,6 +154,8 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.TransactionalSms.GetHashCode(); if (this.MarketingAutomation != null) hashCode = hashCode * 59 + this.MarketingAutomation.GetHashCode(); + if (this.SmsCampaign != null) + hashCode = hashCode * 59 + this.SmsCampaign.GetHashCode(); return hashCode; } } diff --git a/src/sib_api_v3_sdk/Model/UpdateSmsCampaign.cs b/src/sib_api_v3_sdk/Model/UpdateSmsCampaign.cs index 4a71c4f..6f3f6bd 100644 --- a/src/sib_api_v3_sdk/Model/UpdateSmsCampaign.cs +++ b/src/sib_api_v3_sdk/Model/UpdateSmsCampaign.cs @@ -32,7 +32,7 @@ public partial class UpdateSmsCampaign : IEquatable /// Initializes a new instance of the class. /// /// Name of the campaign. - /// Name of the sender. The number of characters is limited to 11. + /// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**. /// Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS. /// recipients. /// UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.. @@ -53,9 +53,9 @@ public partial class UpdateSmsCampaign : IEquatable public string Name { get; set; } /// - /// Name of the sender. The number of characters is limited to 11 + /// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** /// - /// Name of the sender. The number of characters is limited to 11 + /// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** [DataMember(Name="sender", EmitDefaultValue=false)] public string Sender { get; set; } diff --git a/src/sib_api_v3_sdk/Model/UpdateWebhook.cs b/src/sib_api_v3_sdk/Model/UpdateWebhook.cs index 07e79a1..7085601 100644 --- a/src/sib_api_v3_sdk/Model/UpdateWebhook.cs +++ b/src/sib_api_v3_sdk/Model/UpdateWebhook.cs @@ -128,9 +128,9 @@ public enum EventsEnum /// - /// Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition and delivered + /// Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` and `delivered` /// - /// Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition and delivered + /// Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` and `delivered` [DataMember(Name="events", EmitDefaultValue=false)] public List Events { get; set; } /// @@ -138,7 +138,7 @@ public enum EventsEnum /// /// URL of the webhook. /// Description of the webhook. - /// Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition and delivered. + /// Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` and `delivered`. public UpdateWebhook(string url = default(string), string description = default(string), List events = default(List)) { this.Url = url; 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 a0d4a1d..5a45600 100644 --- a/src/sib_api_v3_sdk/sib_api_v3_sdk.csproj +++ b/src/sib_api_v3_sdk/sib_api_v3_sdk.csproj @@ -14,7 +14,7 @@ true true sib_api_v3_sdk - 2.1.1 + 3.0.0 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