diff --git a/README.md b/README.md index 2d3fa04..bc7b8e2 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ Class | Method | HTTP request | Description *ContactsApi* | [**add_contact_to_list**](docs/ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list *ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute *ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /contacts | Create a contact -*ContactsApi* | [**create_doi_contact**](docs/ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create a contact to trigger the DOI workflow from a Landing Page form +*ContactsApi* | [**create_doi_contact**](docs/ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow *ContactsApi* | [**create_folder**](docs/ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder *ContactsApi* | [**create_list**](docs/ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list *ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute @@ -149,22 +149,22 @@ Class | Method | HTTP request | Description *ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list *ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process *ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account -*ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account -*ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child -*ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Create a domain for a child account +*ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account +*ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child +*ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account *ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child -*ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Delete the sender domain of the reseller child based on the childAuthKey and domainName passed -*ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Delete a single reseller child based on the childAuthKey supplied -*ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child -*ResellerApi* | [**get_child_account_creation_status**](docs/ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied -*ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Get all sender domains for a specific child account -*ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Get a child account's details +*ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed +*ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied +*ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child +*ResellerApi* | [**get_child_account_creation_status**](docs/ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{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* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account +*ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childIdentifier} | Get a child account's details *ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Get the list of all children accounts -*ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO) -*ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account -*ResellerApi* | [**update_child_account_status**](docs/ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Update info of reseller's child account status based on the childAuthKey supplied -*ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Update the sender domain of reseller's child based on the childAuthKey and domainName passed -*ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Update info of reseller's child based on the childAuthKey supplied +*ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Sendinblue (SSO) +*ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account +*ResellerApi* | [**update_child_account_status**](docs/ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied +*ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed +*ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied *SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign *SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign *SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign @@ -201,7 +201,7 @@ Class | Method | HTTP request | Description *TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) *TransactionalSMSApi* | [**get_transac_aggregated_sms_report**](docs/TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time *TransactionalSMSApi* | [**get_transac_sms_report**](docs/TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day -*TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to a mobile number +*TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number *WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook *WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook *WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook details diff --git a/docs/ContactsApi.md b/docs/ContactsApi.md index 0d54d50..35a0b22 100644 --- a/docs/ContactsApi.md +++ b/docs/ContactsApi.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**add_contact_to_list**](ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list [**create_attribute**](ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute [**create_contact**](ContactsApi.md#create_contact) | **POST** /contacts | Create a contact -[**create_doi_contact**](ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create a contact to trigger the DOI workflow from a Landing Page form +[**create_doi_contact**](ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow [**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder [**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list [**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute @@ -212,7 +212,7 @@ Name | Type | Description | Notes # **create_doi_contact** > create_doi_contact(create_doi_contact) -Create a contact to trigger the DOI workflow from a Landing Page form +Create Contact via DOI (Double-Opt-In) Flow ### Example ```python @@ -235,10 +235,10 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) -create_doi_contact = sib_api_v3_sdk.CreateDoiContact() # CreateDoiContact | Values to create the DOI contact +create_doi_contact = sib_api_v3_sdk.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 api_instance.create_doi_contact(create_doi_contact) except ApiException as e: print("Exception when calling ContactsApi->create_doi_contact: %s\n" % e) @@ -248,7 +248,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **create_doi_contact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the DOI contact | + **create_doi_contact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the Double opt-in (DOI) contact | ### Return type diff --git a/docs/CreateChild.md b/docs/CreateChild.md index 693ba34..a2e1a7e 100644 --- a/docs/CreateChild.md +++ b/docs/CreateChild.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **last_name** | **str** | Last name to use to create the child account | **company_name** | **str** | Company name to use to create the child account | **password** | **str** | Password for the child account to login | +**language** | **str** | 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 new file mode 100644 index 0000000..09b36e0 --- /dev/null +++ b/docs/CreateDoiContact.md @@ -0,0 +1,15 @@ +# CreateDoiContact + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **str** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. | +**attributes** | **object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional] +**include_list_ids** | **list[int]** | Lists under user account where contact should be added | +**exclude_list_ids** | **list[int]** | Lists under user account where contact should not be added | [optional] +**template_id** | **int** | Id of the Double opt-in (DOI) template | +**redirection_url** | **str** | 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 }}. | [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/CreateReseller.md b/docs/CreateReseller.md index 49e0120..197624d 100644 --- a/docs/CreateReseller.md +++ b/docs/CreateReseller.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **auth_key** | **str** | AuthKey of Reseller child created | +**id** | **int** | 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 ffa4a73..5a59cd4 100644 --- a/docs/CreateSender.md +++ b/docs/CreateSender.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | From Name to use for the sender | -**email** | **str** | From Email to use for the sender | +**email** | **str** | 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/CreateWebhook.md b/docs/CreateWebhook.md index cd16fc2..0be2b77 100644 --- a/docs/CreateWebhook.md +++ b/docs/CreateWebhook.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **url** | **str** | URL of the webhook | **description** | **str** | Description of the webhook | [optional] -**events** | **list[str]** | 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[str]** | Events triggering the webhook. Possible values for Transactional type webhook – sent, 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** | **str** | Type of the webhook | [optional] [default to '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 e35c498..21fab70 100644 --- a/docs/EmailExportRecipients.md +++ b/docs/EmailExportRecipients.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**notify_url** | **str** | Webhook called once the export process is finished | [optional] +**notify_url** | **str** | Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] **recipients_type** | **str** | 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/GetEmailCampaign.md b/docs/GetEmailCampaign.md index 85469a6..fa1a551 100644 --- a/docs/GetEmailCampaign.md +++ b/docs/GetEmailCampaign.md @@ -31,6 +31,7 @@ Name | Type | Description | Notes **mirror_active** | **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] **sent_date** | **datetime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] +**return_bounce** | **int** | 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 87ff5ca..e731faf 100644 --- a/docs/GetExtendedCampaignOverview.md +++ b/docs/GetExtendedCampaignOverview.md @@ -31,6 +31,7 @@ Name | Type | Description | Notes **mirror_active** | **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] **sent_date** | **datetime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] +**return_bounce** | **int** | 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/GetSmtpTemplateOverview.md b/docs/GetSmtpTemplateOverview.md index 3789649..8203d65 100644 --- a/docs/GetSmtpTemplateOverview.md +++ b/docs/GetSmtpTemplateOverview.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **html_content** | **str** | HTML content of the template | **created_at** | **datetime** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modified_at** | **datetime** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | +**doi_template** | **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/PostContactInfoContacts.md b/docs/PostContactInfoContacts.md index 12f27a2..7075335 100644 --- a/docs/PostContactInfoContacts.md +++ b/docs/PostContactInfoContacts.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **success** | **list[str]** | | [optional] **failure** | **list[str]** | | [optional] **total** | **int** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional] +**process_id** | **int** | 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 8f0cd97..efcd79e 100644 --- a/docs/RemoveContactFromList.md +++ b/docs/RemoveContactFromList.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **emails** | **list[str]** | Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional] -**all** | **bool** | Required if 'emails' is empty. Remove all existing contacts from a list | [optional] +**all** | **bool** | Required if 'emails' is empty. 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 44b1f93..50a122f 100644 --- a/docs/RequestContactExport.md +++ b/docs/RequestContactExport.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **export_attributes** | **list[str]** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional] **contact_filter** | **object** | This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {\"blacklisted\":true} will export all the blacklisted contacts. | [optional] **custom_contact_filter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | [optional] -**notify_url** | **str** | Webhook that will be called once the export process is finished | [optional] +**notify_url** | **str** | 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 b26545a..dfd88ce 100644 --- a/docs/RequestContactImport.md +++ b/docs/RequestContactImport.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **file_url** | **str** | Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv | [optional] **file_body** | **str** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional] **list_ids** | **list[int]** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional] -**notify_url** | **str** | URL that will be called once the export process is finished | [optional] +**notify_url** | **str** | URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] **new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional] **email_blacklist** | **bool** | To blacklist all the contacts for email | [optional] [default to False] **sms_blacklist** | **bool** | To blacklist all the contacts for sms | [optional] [default to False] diff --git a/docs/RequestSMSRecipientExport.md b/docs/RequestSMSRecipientExport.md index 0b81b89..98a75dc 100644 --- a/docs/RequestSMSRecipientExport.md +++ b/docs/RequestSMSRecipientExport.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**notify_url** | **str** | URL that will be called once the export process is finished | [optional] +**notify_url** | **str** | URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] **recipients_type** | **str** | 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 ea5a33a..f54b0a2 100644 --- a/docs/ResellerApi.md +++ b/docs/ResellerApi.md @@ -4,26 +4,26 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add_credits**](ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account -[**associate_ip_to_child**](ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child -[**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Create a domain for a child account +[**add_credits**](ResellerApi.md#add_credits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account +[**associate_ip_to_child**](ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child +[**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account [**create_reseller_child**](ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child -[**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Delete the sender domain of the reseller child based on the childAuthKey and domainName passed -[**delete_reseller_child**](ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Delete a single reseller child based on the childAuthKey supplied -[**dissociate_ip_from_child**](ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child -[**get_child_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied -[**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Get all sender domains for a specific child account -[**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Get a child account's details +[**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed +[**delete_reseller_child**](ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied +[**dissociate_ip_from_child**](ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child +[**get_child_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied +[**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account +[**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childIdentifier} | Get a child account's details [**get_reseller_childs**](ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Get the list of all children accounts -[**get_sso_token**](ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO) -[**remove_credits**](ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account -[**update_child_account_status**](ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Update info of reseller's child account status based on the childAuthKey supplied -[**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Update the sender domain of reseller's child based on the childAuthKey and domainName passed -[**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Update info of reseller's child based on the childAuthKey supplied +[**get_sso_token**](ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Sendinblue (SSO) +[**remove_credits**](ResellerApi.md#remove_credits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account +[**update_child_account_status**](ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied +[**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed +[**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied # **add_credits** -> RemainingCreditModel add_credits(child_auth_key, add_credits) +> RemainingCreditModel add_credits(child_identifier, add_credits) Add Email and/or SMS credits to a specific child account @@ -48,12 +48,12 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child add_credits = sib_api_v3_sdk.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 - api_response = api_instance.add_credits(child_auth_key, add_credits) + api_response = api_instance.add_credits(child_identifier, add_credits) pprint(api_response) except ApiException as e: print("Exception when calling ResellerApi->add_credits: %s\n" % e) @@ -63,7 +63,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | **add_credits** | [**AddCredits**](AddCredits.md)| Values to post to add credit to a specific child account | ### Return type @@ -82,7 +82,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **associate_ip_to_child** -> associate_ip_to_child(child_auth_key, ip) +> associate_ip_to_child(child_identifier, ip) Associate a dedicated IP to the child @@ -107,12 +107,12 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child ip = sib_api_v3_sdk.ManageIp() # ManageIp | IP to associate try: # Associate a dedicated IP to the child - api_instance.associate_ip_to_child(child_auth_key, ip) + api_instance.associate_ip_to_child(child_identifier, ip) except ApiException as e: print("Exception when calling ResellerApi->associate_ip_to_child: %s\n" % e) ``` @@ -121,7 +121,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | **ip** | [**ManageIp**](ManageIp.md)| IP to associate | ### Return type @@ -140,7 +140,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_child_domain** -> create_child_domain(child_auth_key, add_child_domain) +> create_child_domain(child_identifier, add_child_domain) Create a domain for a child account @@ -165,12 +165,12 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child add_child_domain = sib_api_v3_sdk.AddChildDomain() # AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account. try: # Create a domain for a child account - api_instance.create_child_domain(child_auth_key, add_child_domain) + api_instance.create_child_domain(child_identifier, add_child_domain) except ApiException as e: print("Exception when calling ResellerApi->create_child_domain: %s\n" % e) ``` @@ -179,7 +179,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | **add_child_domain** | [**AddChildDomain**](AddChildDomain.md)| Sender domain to add for a specific child account. This will not be displayed to the parent account. | ### Return type @@ -255,9 +255,9 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_child_domain** -> delete_child_domain(child_auth_key, domain_name) +> delete_child_domain(child_identifier, domain_name) -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 ```python @@ -280,12 +280,12 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child domain_name = 'domain_name_example' # str | 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 - api_instance.delete_child_domain(child_auth_key, domain_name) + # Delete the sender domain of the reseller child based on the childIdentifier and domainName passed + api_instance.delete_child_domain(child_identifier, domain_name) except ApiException as e: print("Exception when calling ResellerApi->delete_child_domain: %s\n" % e) ``` @@ -294,7 +294,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | **domain_name** | **str**| Pass the existing domain that needs to be deleted | ### Return type @@ -313,9 +313,9 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_reseller_child** -> delete_reseller_child(child_auth_key) +> delete_reseller_child(child_identifier) -Delete a single reseller child based on the childAuthKey supplied +Delete a single reseller child based on the child identifier supplied ### Example ```python @@ -338,11 +338,11 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or child id of reseller's child try: - # Delete a single reseller child based on the childAuthKey supplied - api_instance.delete_reseller_child(child_auth_key) + # Delete a single reseller child based on the child identifier supplied + api_instance.delete_reseller_child(child_identifier) except ApiException as e: print("Exception when calling ResellerApi->delete_reseller_child: %s\n" % e) ``` @@ -351,7 +351,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or child id of reseller's child | ### Return type @@ -369,7 +369,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **dissociate_ip_from_child** -> dissociate_ip_from_child(child_auth_key, ip) +> dissociate_ip_from_child(child_identifier, ip) Dissociate a dedicated IP to the child @@ -394,12 +394,12 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child ip = sib_api_v3_sdk.ManageIp() # ManageIp | IP to dissociate try: # Dissociate a dedicated IP to the child - api_instance.dissociate_ip_from_child(child_auth_key, ip) + api_instance.dissociate_ip_from_child(child_identifier, ip) except ApiException as e: print("Exception when calling ResellerApi->dissociate_ip_from_child: %s\n" % e) ``` @@ -408,7 +408,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | **ip** | [**ManageIp**](ManageIp.md)| IP to dissociate | ### Return type @@ -427,9 +427,9 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_child_account_creation_status** -> GetChildAccountCreationStatus get_child_account_creation_status(child_auth_key) +> GetChildAccountCreationStatus get_child_account_creation_status(child_identifier) -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 ```python @@ -452,11 +452,11 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | 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 - api_response = api_instance.get_child_account_creation_status(child_auth_key) + # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied + api_response = api_instance.get_child_account_creation_status(child_identifier) pprint(api_response) except ApiException as e: print("Exception when calling ResellerApi->get_child_account_creation_status: %s\n" % e) @@ -466,7 +466,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | ### Return type @@ -484,7 +484,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_child_domains** -> GetChildDomains get_child_domains(child_auth_key) +> GetChildDomains get_child_domains(child_identifier) Get all sender domains for a specific child account @@ -509,11 +509,11 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child try: # Get all sender domains for a specific child account - api_response = api_instance.get_child_domains(child_auth_key) + api_response = api_instance.get_child_domains(child_identifier) pprint(api_response) except ApiException as e: print("Exception when calling ResellerApi->get_child_domains: %s\n" % e) @@ -523,7 +523,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | ### Return type @@ -541,7 +541,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_child_info** -> GetChildInfo get_child_info(child_auth_key) +> GetChildInfo get_child_info(child_identifier) Get a child account's details @@ -566,11 +566,11 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child try: # Get a child account's details - api_response = api_instance.get_child_info(child_auth_key) + api_response = api_instance.get_child_info(child_identifier) pprint(api_response) except ApiException as e: print("Exception when calling ResellerApi->get_child_info: %s\n" % e) @@ -580,7 +580,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | ### Return type @@ -657,7 +657,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_sso_token** -> GetSsoToken get_sso_token(child_auth_key) +> GetSsoToken get_sso_token(child_identifier) Get session token to access Sendinblue (SSO) @@ -684,11 +684,11 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child try: # Get session token to access Sendinblue (SSO) - api_response = api_instance.get_sso_token(child_auth_key) + api_response = api_instance.get_sso_token(child_identifier) pprint(api_response) except ApiException as e: print("Exception when calling ResellerApi->get_sso_token: %s\n" % e) @@ -698,7 +698,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | ### Return type @@ -716,7 +716,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **remove_credits** -> RemainingCreditModel remove_credits(child_auth_key, remove_credits) +> RemainingCreditModel remove_credits(child_identifier, remove_credits) Remove Email and/or SMS credits from a specific child account @@ -741,12 +741,12 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child remove_credits = sib_api_v3_sdk.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 - api_response = api_instance.remove_credits(child_auth_key, remove_credits) + api_response = api_instance.remove_credits(child_identifier, remove_credits) pprint(api_response) except ApiException as e: print("Exception when calling ResellerApi->remove_credits: %s\n" % e) @@ -756,7 +756,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | **remove_credits** | [**RemoveCredits**](RemoveCredits.md)| Values to post to remove email or SMS credits from a specific child account | ### Return type @@ -775,9 +775,9 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_child_account_status** -> update_child_account_status(child_auth_key, update_child_account_status) +> update_child_account_status(child_identifier, update_child_account_status) -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 ```python @@ -800,12 +800,12 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child update_child_account_status = sib_api_v3_sdk.UpdateChildAccountStatus() # UpdateChildAccountStatus | values to update in child account status try: - # Update info of reseller's child account status based on the childAuthKey supplied - api_instance.update_child_account_status(child_auth_key, update_child_account_status) + # Update info of reseller's child account status based on the childIdentifier supplied + api_instance.update_child_account_status(child_identifier, update_child_account_status) except ApiException as e: print("Exception when calling ResellerApi->update_child_account_status: %s\n" % e) ``` @@ -814,7 +814,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | **update_child_account_status** | [**UpdateChildAccountStatus**](UpdateChildAccountStatus.md)| values to update in child account status | ### Return type @@ -833,9 +833,9 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_child_domain** -> update_child_domain(child_auth_key, domain_name, update_child_domain) +> update_child_domain(child_identifier, domain_name, update_child_domain) -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 ```python @@ -858,13 +858,13 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child domain_name = 'domain_name_example' # str | Pass the existing domain that needs to be updated update_child_domain = sib_api_v3_sdk.UpdateChildDomain() # UpdateChildDomain | value to update for sender domain try: - # Update the sender domain of reseller's child based on the childAuthKey and domainName passed - api_instance.update_child_domain(child_auth_key, domain_name, update_child_domain) + # Update the sender domain of reseller's child based on the childIdentifier and domainName passed + api_instance.update_child_domain(child_identifier, domain_name, update_child_domain) except ApiException as e: print("Exception when calling ResellerApi->update_child_domain: %s\n" % e) ``` @@ -873,7 +873,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | **domain_name** | **str**| Pass the existing domain that needs to be updated | **update_child_domain** | [**UpdateChildDomain**](UpdateChildDomain.md)| value to update for sender domain | @@ -893,9 +893,9 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_reseller_child** -> update_reseller_child(child_auth_key, reseller_child) +> update_reseller_child(child_identifier, reseller_child) -Update info of reseller's child based on the childAuthKey supplied +Update info of reseller's child based on the child identifier supplied ### Example ```python @@ -918,12 +918,12 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) -child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child +child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child reseller_child = sib_api_v3_sdk.UpdateChild() # UpdateChild | values to update in child profile try: - # Update info of reseller's child based on the childAuthKey supplied - api_instance.update_reseller_child(child_auth_key, reseller_child) + # Update info of reseller's child based on the child identifier supplied + api_instance.update_reseller_child(child_identifier, reseller_child) except ApiException as e: print("Exception when calling ResellerApi->update_reseller_child: %s\n" % e) ``` @@ -932,7 +932,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **child_auth_key** | **str**| auth key of reseller's child | + **child_identifier** | **str**| Either auth key or id of reseller's child | **reseller_child** | [**UpdateChild**](UpdateChild.md)| values to update in child profile | ### Return type diff --git a/docs/SendSmtpEmail.md b/docs/SendSmtpEmail.md index 7d32329..06802a0 100644 --- a/docs/SendSmtpEmail.md +++ b/docs/SendSmtpEmail.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **text_content** | **str** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional] **subject** | **str** | Subject of the message. Mandatory if 'templateId' is not passed | [optional] **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional] -**attachment** | [**list[SendSmtpEmailAttachment]**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] +**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] **template_id** | **int** | Id of the template | [optional] **params** | **object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional] diff --git a/docs/TransactionalSMSApi.md b/docs/TransactionalSMSApi.md index cb073c7..bb2e998 100644 --- a/docs/TransactionalSMSApi.md +++ b/docs/TransactionalSMSApi.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**get_sms_events**](TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) [**get_transac_aggregated_sms_report**](TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time [**get_transac_sms_report**](TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day -[**send_transac_sms**](TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to a mobile number +[**send_transac_sms**](TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number # **get_sms_events** @@ -210,7 +210,7 @@ Name | Type | Description | Notes # **send_transac_sms** > SendSms send_transac_sms(send_transac_sms) -Send the SMS campaign to a mobile number +Send SMS message to a mobile number ### Example ```python @@ -236,7 +236,7 @@ api_instance = sib_api_v3_sdk.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(confi send_transac_sms = sib_api_v3_sdk.SendTransacSms() # SendTransacSms | Values to send a transactional SMS try: - # Send the SMS campaign to a mobile number + # Send SMS message to a mobile number api_response = api_instance.send_transac_sms(send_transac_sms) pprint(api_response) except ApiException as e: diff --git a/docs/UpdateChildAccountStatus.md b/docs/UpdateChildAccountStatus.md index 92674a3..b0f3999 100644 --- a/docs/UpdateChildAccountStatus.md +++ b/docs/UpdateChildAccountStatus.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **transactional_email** | **bool** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional] **transactional_sms** | **bool** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional] **marketing_automation** | **bool** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional] +**sms_campaign** | **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/setup.py b/setup.py index 55e1a4b..9e07d9f 100644 --- a/setup.py +++ b/setup.py @@ -14,7 +14,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "sib-api-v3-sdk" -VERSION = "6.2.0" +VERSION = "6.3.0" # To install the library, run the following # # python setup.py install diff --git a/sib_api_v3_sdk/api/contacts_api.py b/sib_api_v3_sdk/api/contacts_api.py index 1cc87bf..0026af1 100644 --- a/sib_api_v3_sdk/api/contacts_api.py +++ b/sib_api_v3_sdk/api/contacts_api.py @@ -349,7 +349,7 @@ def create_contact_with_http_info(self, create_contact, **kwargs): # noqa: E501 collection_formats=collection_formats) def create_doi_contact(self, create_doi_contact, **kwargs): # noqa: E501 - """Create a contact to trigger the DOI workflow from a Landing Page form # noqa: E501 + """Create Contact via DOI (Double-Opt-In) Flow # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -357,7 +357,7 @@ def create_doi_contact(self, create_doi_contact, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :param CreateDoiContact create_doi_contact: Values to create the DOI contact (required) + :param CreateDoiContact create_doi_contact: Values to create the Double opt-in (DOI) contact (required) :return: None If the method is called asynchronously, returns the request thread. @@ -370,7 +370,7 @@ def create_doi_contact(self, create_doi_contact, **kwargs): # noqa: E501 return data def create_doi_contact_with_http_info(self, create_doi_contact, **kwargs): # noqa: E501 - """Create a contact to trigger the DOI workflow from a Landing Page form # noqa: E501 + """Create Contact via DOI (Double-Opt-In) Flow # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -378,7 +378,7 @@ def create_doi_contact_with_http_info(self, create_doi_contact, **kwargs): # no >>> result = thread.get() :param async_req bool - :param CreateDoiContact create_doi_contact: Values to create the DOI contact (required) + :param CreateDoiContact create_doi_contact: Values to create the Double opt-in (DOI) contact (required) :return: None If the method is called asynchronously, returns the request thread. diff --git a/sib_api_v3_sdk/api/reseller_api.py b/sib_api_v3_sdk/api/reseller_api.py index 643c065..c49ebe9 100644 --- a/sib_api_v3_sdk/api/reseller_api.py +++ b/sib_api_v3_sdk/api/reseller_api.py @@ -33,16 +33,16 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def add_credits(self, child_auth_key, add_credits, **kwargs): # noqa: E501 + def add_credits(self, child_identifier, add_credits, **kwargs): # noqa: E501 """Add Email and/or SMS credits to a specific child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.add_credits(child_auth_key, add_credits, async_req=True) + >>> thread = api.add_credits(child_identifier, add_credits, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param AddCredits add_credits: Values to post to add credit to a specific child account (required) :return: RemainingCreditModel If the method is called asynchronously, @@ -50,28 +50,28 @@ def add_credits(self, child_auth_key, add_credits, **kwargs): # noqa: E501 """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.add_credits_with_http_info(child_auth_key, add_credits, **kwargs) # noqa: E501 + return self.add_credits_with_http_info(child_identifier, add_credits, **kwargs) # noqa: E501 else: - (data) = self.add_credits_with_http_info(child_auth_key, add_credits, **kwargs) # noqa: E501 + (data) = self.add_credits_with_http_info(child_identifier, add_credits, **kwargs) # noqa: E501 return data - def add_credits_with_http_info(self, child_auth_key, add_credits, **kwargs): # noqa: E501 + def add_credits_with_http_info(self, child_identifier, add_credits, **kwargs): # noqa: E501 """Add Email and/or SMS credits to a specific child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.add_credits_with_http_info(child_auth_key, add_credits, async_req=True) + >>> thread = api.add_credits_with_http_info(child_identifier, add_credits, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param AddCredits add_credits: Values to post to add credit to a specific child account (required) :return: RemainingCreditModel If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key', 'add_credits'] # noqa: E501 + all_params = ['child_identifier', 'add_credits'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -86,10 +86,10 @@ def add_credits_with_http_info(self, child_auth_key, add_credits, **kwargs): # ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `add_credits`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `add_credits`") # noqa: E501 # verify the required parameter 'add_credits' is set if ('add_credits' not in params or params['add_credits'] is None): @@ -98,8 +98,8 @@ def add_credits_with_http_info(self, child_auth_key, add_credits, **kwargs): # collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -123,7 +123,7 @@ def add_credits_with_http_info(self, child_auth_key, add_credits, **kwargs): # auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/credits/add', 'POST', + '/reseller/children/{childIdentifier}/credits/add', 'POST', path_params, query_params, header_params, @@ -138,16 +138,16 @@ def add_credits_with_http_info(self, child_auth_key, add_credits, **kwargs): # _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def associate_ip_to_child(self, child_auth_key, ip, **kwargs): # noqa: E501 + def associate_ip_to_child(self, child_identifier, ip, **kwargs): # noqa: E501 """Associate a dedicated IP to the child # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.associate_ip_to_child(child_auth_key, ip, async_req=True) + >>> thread = api.associate_ip_to_child(child_identifier, ip, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param ManageIp ip: IP to associate (required) :return: None If the method is called asynchronously, @@ -155,28 +155,28 @@ def associate_ip_to_child(self, child_auth_key, ip, **kwargs): # noqa: E501 """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.associate_ip_to_child_with_http_info(child_auth_key, ip, **kwargs) # noqa: E501 + return self.associate_ip_to_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501 else: - (data) = self.associate_ip_to_child_with_http_info(child_auth_key, ip, **kwargs) # noqa: E501 + (data) = self.associate_ip_to_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501 return data - def associate_ip_to_child_with_http_info(self, child_auth_key, ip, **kwargs): # noqa: E501 + def associate_ip_to_child_with_http_info(self, child_identifier, ip, **kwargs): # noqa: E501 """Associate a dedicated IP to the child # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.associate_ip_to_child_with_http_info(child_auth_key, ip, async_req=True) + >>> thread = api.associate_ip_to_child_with_http_info(child_identifier, ip, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param ManageIp ip: IP to associate (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key', 'ip'] # noqa: E501 + all_params = ['child_identifier', 'ip'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -191,10 +191,10 @@ def associate_ip_to_child_with_http_info(self, child_auth_key, ip, **kwargs): # ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `associate_ip_to_child`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `associate_ip_to_child`") # noqa: E501 # verify the required parameter 'ip' is set if ('ip' not in params or params['ip'] is None): @@ -203,8 +203,8 @@ def associate_ip_to_child_with_http_info(self, child_auth_key, ip, **kwargs): # collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -228,7 +228,7 @@ def associate_ip_to_child_with_http_info(self, child_auth_key, ip, **kwargs): # auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/ips/associate', 'POST', + '/reseller/children/{childIdentifier}/ips/associate', 'POST', path_params, query_params, header_params, @@ -243,16 +243,16 @@ def associate_ip_to_child_with_http_info(self, child_auth_key, ip, **kwargs): # _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_child_domain(self, child_auth_key, add_child_domain, **kwargs): # noqa: E501 + def create_child_domain(self, child_identifier, add_child_domain, **kwargs): # noqa: E501 """Create a domain for a child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_child_domain(child_auth_key, add_child_domain, async_req=True) + >>> thread = api.create_child_domain(child_identifier, add_child_domain, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param AddChildDomain add_child_domain: Sender domain to add for a specific child account. This will not be displayed to the parent account. (required) :return: None If the method is called asynchronously, @@ -260,28 +260,28 @@ def create_child_domain(self, child_auth_key, add_child_domain, **kwargs): # no """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.create_child_domain_with_http_info(child_auth_key, add_child_domain, **kwargs) # noqa: E501 + return self.create_child_domain_with_http_info(child_identifier, add_child_domain, **kwargs) # noqa: E501 else: - (data) = self.create_child_domain_with_http_info(child_auth_key, add_child_domain, **kwargs) # noqa: E501 + (data) = self.create_child_domain_with_http_info(child_identifier, add_child_domain, **kwargs) # noqa: E501 return data - def create_child_domain_with_http_info(self, child_auth_key, add_child_domain, **kwargs): # noqa: E501 + def create_child_domain_with_http_info(self, child_identifier, add_child_domain, **kwargs): # noqa: E501 """Create a domain for a child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_child_domain_with_http_info(child_auth_key, add_child_domain, async_req=True) + >>> thread = api.create_child_domain_with_http_info(child_identifier, add_child_domain, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param AddChildDomain add_child_domain: Sender domain to add for a specific child account. This will not be displayed to the parent account. (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key', 'add_child_domain'] # noqa: E501 + all_params = ['child_identifier', 'add_child_domain'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -296,10 +296,10 @@ def create_child_domain_with_http_info(self, child_auth_key, add_child_domain, * ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `create_child_domain`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `create_child_domain`") # noqa: E501 # verify the required parameter 'add_child_domain' is set if ('add_child_domain' not in params or params['add_child_domain'] is None): @@ -308,8 +308,8 @@ def create_child_domain_with_http_info(self, child_auth_key, add_child_domain, * collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -333,7 +333,7 @@ def create_child_domain_with_http_info(self, child_auth_key, add_child_domain, * auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/domains', 'POST', + '/reseller/children/{childIdentifier}/domains', 'POST', path_params, query_params, header_params, @@ -441,16 +441,16 @@ def create_reseller_child_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_child_domain(self, child_auth_key, domain_name, **kwargs): # noqa: E501 - """Delete the sender domain of the reseller child based on the childAuthKey and domainName passed # noqa: E501 + def delete_child_domain(self, child_identifier, domain_name, **kwargs): # noqa: E501 + """Delete the sender domain of the reseller child based on the childIdentifier and domainName passed # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_child_domain(child_auth_key, domain_name, async_req=True) + >>> thread = api.delete_child_domain(child_identifier, domain_name, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param str domain_name: Pass the existing domain that needs to be deleted (required) :return: None If the method is called asynchronously, @@ -458,28 +458,28 @@ def delete_child_domain(self, child_auth_key, domain_name, **kwargs): # noqa: E """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.delete_child_domain_with_http_info(child_auth_key, domain_name, **kwargs) # noqa: E501 + return self.delete_child_domain_with_http_info(child_identifier, domain_name, **kwargs) # noqa: E501 else: - (data) = self.delete_child_domain_with_http_info(child_auth_key, domain_name, **kwargs) # noqa: E501 + (data) = self.delete_child_domain_with_http_info(child_identifier, domain_name, **kwargs) # noqa: E501 return data - def delete_child_domain_with_http_info(self, child_auth_key, domain_name, **kwargs): # noqa: E501 - """Delete the sender domain of the reseller child based on the childAuthKey and domainName passed # noqa: E501 + def delete_child_domain_with_http_info(self, child_identifier, domain_name, **kwargs): # noqa: E501 + """Delete the sender domain of the reseller child based on the childIdentifier and domainName passed # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_child_domain_with_http_info(child_auth_key, domain_name, async_req=True) + >>> thread = api.delete_child_domain_with_http_info(child_identifier, domain_name, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param str domain_name: Pass the existing domain that needs to be deleted (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key', 'domain_name'] # noqa: E501 + all_params = ['child_identifier', 'domain_name'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -494,10 +494,10 @@ def delete_child_domain_with_http_info(self, child_auth_key, domain_name, **kwar ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `delete_child_domain`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `delete_child_domain`") # noqa: E501 # verify the required parameter 'domain_name' is set if ('domain_name' not in params or params['domain_name'] is None): @@ -506,8 +506,8 @@ def delete_child_domain_with_http_info(self, child_auth_key, domain_name, **kwar collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 if 'domain_name' in params: path_params['domainName'] = params['domain_name'] # noqa: E501 @@ -531,7 +531,7 @@ def delete_child_domain_with_http_info(self, child_auth_key, domain_name, **kwar auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/domains/{domainName}', 'DELETE', + '/reseller/children/{childIdentifier}/domains/{domainName}', 'DELETE', path_params, query_params, header_params, @@ -546,43 +546,43 @@ def delete_child_domain_with_http_info(self, child_auth_key, domain_name, **kwar _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_reseller_child(self, child_auth_key, **kwargs): # noqa: E501 - """Delete a single reseller child based on the childAuthKey supplied # noqa: E501 + def delete_reseller_child(self, child_identifier, **kwargs): # noqa: E501 + """Delete a single reseller child based on the child identifier supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_reseller_child(child_auth_key, async_req=True) + >>> thread = api.delete_reseller_child(child_identifier, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or child id of reseller's child (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.delete_reseller_child_with_http_info(child_auth_key, **kwargs) # noqa: E501 + return self.delete_reseller_child_with_http_info(child_identifier, **kwargs) # noqa: E501 else: - (data) = self.delete_reseller_child_with_http_info(child_auth_key, **kwargs) # noqa: E501 + (data) = self.delete_reseller_child_with_http_info(child_identifier, **kwargs) # noqa: E501 return data - def delete_reseller_child_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 - """Delete a single reseller child based on the childAuthKey supplied # noqa: E501 + def delete_reseller_child_with_http_info(self, child_identifier, **kwargs): # noqa: E501 + """Delete a single reseller child based on the child identifier supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_reseller_child_with_http_info(child_auth_key, async_req=True) + >>> thread = api.delete_reseller_child_with_http_info(child_identifier, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or child id of reseller's child (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key'] # noqa: E501 + all_params = ['child_identifier'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -597,16 +597,16 @@ def delete_reseller_child_with_http_info(self, child_auth_key, **kwargs): # noq ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `delete_reseller_child`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `delete_reseller_child`") # noqa: E501 collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -628,7 +628,7 @@ def delete_reseller_child_with_http_info(self, child_auth_key, **kwargs): # noq auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}', 'DELETE', + '/reseller/children/{childIdentifier}', 'DELETE', path_params, query_params, header_params, @@ -643,16 +643,16 @@ def delete_reseller_child_with_http_info(self, child_auth_key, **kwargs): # noq _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def dissociate_ip_from_child(self, child_auth_key, ip, **kwargs): # noqa: E501 + def dissociate_ip_from_child(self, child_identifier, ip, **kwargs): # noqa: E501 """Dissociate a dedicated IP to the child # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.dissociate_ip_from_child(child_auth_key, ip, async_req=True) + >>> thread = api.dissociate_ip_from_child(child_identifier, ip, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param ManageIp ip: IP to dissociate (required) :return: None If the method is called asynchronously, @@ -660,28 +660,28 @@ def dissociate_ip_from_child(self, child_auth_key, ip, **kwargs): # noqa: E501 """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.dissociate_ip_from_child_with_http_info(child_auth_key, ip, **kwargs) # noqa: E501 + return self.dissociate_ip_from_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501 else: - (data) = self.dissociate_ip_from_child_with_http_info(child_auth_key, ip, **kwargs) # noqa: E501 + (data) = self.dissociate_ip_from_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501 return data - def dissociate_ip_from_child_with_http_info(self, child_auth_key, ip, **kwargs): # noqa: E501 + def dissociate_ip_from_child_with_http_info(self, child_identifier, ip, **kwargs): # noqa: E501 """Dissociate a dedicated IP to the child # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.dissociate_ip_from_child_with_http_info(child_auth_key, ip, async_req=True) + >>> thread = api.dissociate_ip_from_child_with_http_info(child_identifier, ip, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param ManageIp ip: IP to dissociate (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key', 'ip'] # noqa: E501 + all_params = ['child_identifier', 'ip'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -696,10 +696,10 @@ def dissociate_ip_from_child_with_http_info(self, child_auth_key, ip, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `dissociate_ip_from_child`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `dissociate_ip_from_child`") # noqa: E501 # verify the required parameter 'ip' is set if ('ip' not in params or params['ip'] is None): @@ -708,8 +708,8 @@ def dissociate_ip_from_child_with_http_info(self, child_auth_key, ip, **kwargs): collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -733,7 +733,7 @@ def dissociate_ip_from_child_with_http_info(self, child_auth_key, ip, **kwargs): auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/ips/dissociate', 'POST', + '/reseller/children/{childIdentifier}/ips/dissociate', 'POST', path_params, query_params, header_params, @@ -748,43 +748,43 @@ def dissociate_ip_from_child_with_http_info(self, child_auth_key, ip, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_child_account_creation_status(self, child_auth_key, **kwargs): # noqa: E501 - """Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied # noqa: E501 + def get_child_account_creation_status(self, child_identifier, **kwargs): # noqa: E501 + """Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_child_account_creation_status(child_auth_key, async_req=True) + >>> thread = api.get_child_account_creation_status(child_identifier, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :return: GetChildAccountCreationStatus If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.get_child_account_creation_status_with_http_info(child_auth_key, **kwargs) # noqa: E501 + return self.get_child_account_creation_status_with_http_info(child_identifier, **kwargs) # noqa: E501 else: - (data) = self.get_child_account_creation_status_with_http_info(child_auth_key, **kwargs) # noqa: E501 + (data) = self.get_child_account_creation_status_with_http_info(child_identifier, **kwargs) # noqa: E501 return data - def get_child_account_creation_status_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 - """Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied # noqa: E501 + def get_child_account_creation_status_with_http_info(self, child_identifier, **kwargs): # noqa: E501 + """Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_child_account_creation_status_with_http_info(child_auth_key, async_req=True) + >>> thread = api.get_child_account_creation_status_with_http_info(child_identifier, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :return: GetChildAccountCreationStatus If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key'] # noqa: E501 + all_params = ['child_identifier'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -799,16 +799,16 @@ def get_child_account_creation_status_with_http_info(self, child_auth_key, **kwa ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `get_child_account_creation_status`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `get_child_account_creation_status`") # noqa: E501 collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -830,7 +830,7 @@ def get_child_account_creation_status_with_http_info(self, child_auth_key, **kwa auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/accountCreationStatus', 'GET', + '/reseller/children/{childIdentifier}/accountCreationStatus', 'GET', path_params, query_params, header_params, @@ -845,43 +845,43 @@ def get_child_account_creation_status_with_http_info(self, child_auth_key, **kwa _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_child_domains(self, child_auth_key, **kwargs): # noqa: E501 + def get_child_domains(self, child_identifier, **kwargs): # noqa: E501 """Get all sender domains for a specific child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_child_domains(child_auth_key, async_req=True) + >>> thread = api.get_child_domains(child_identifier, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :return: GetChildDomains If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.get_child_domains_with_http_info(child_auth_key, **kwargs) # noqa: E501 + return self.get_child_domains_with_http_info(child_identifier, **kwargs) # noqa: E501 else: - (data) = self.get_child_domains_with_http_info(child_auth_key, **kwargs) # noqa: E501 + (data) = self.get_child_domains_with_http_info(child_identifier, **kwargs) # noqa: E501 return data - def get_child_domains_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 + def get_child_domains_with_http_info(self, child_identifier, **kwargs): # noqa: E501 """Get all sender domains for a specific child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_child_domains_with_http_info(child_auth_key, async_req=True) + >>> thread = api.get_child_domains_with_http_info(child_identifier, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :return: GetChildDomains If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key'] # noqa: E501 + all_params = ['child_identifier'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -896,16 +896,16 @@ def get_child_domains_with_http_info(self, child_auth_key, **kwargs): # noqa: E ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `get_child_domains`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `get_child_domains`") # noqa: E501 collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -927,7 +927,7 @@ def get_child_domains_with_http_info(self, child_auth_key, **kwargs): # noqa: E auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/domains', 'GET', + '/reseller/children/{childIdentifier}/domains', 'GET', path_params, query_params, header_params, @@ -942,43 +942,43 @@ def get_child_domains_with_http_info(self, child_auth_key, **kwargs): # noqa: E _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_child_info(self, child_auth_key, **kwargs): # noqa: E501 + def get_child_info(self, child_identifier, **kwargs): # noqa: E501 """Get a child account's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_child_info(child_auth_key, async_req=True) + >>> thread = api.get_child_info(child_identifier, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :return: GetChildInfo If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.get_child_info_with_http_info(child_auth_key, **kwargs) # noqa: E501 + return self.get_child_info_with_http_info(child_identifier, **kwargs) # noqa: E501 else: - (data) = self.get_child_info_with_http_info(child_auth_key, **kwargs) # noqa: E501 + (data) = self.get_child_info_with_http_info(child_identifier, **kwargs) # noqa: E501 return data - def get_child_info_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 + def get_child_info_with_http_info(self, child_identifier, **kwargs): # noqa: E501 """Get a child account's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_child_info_with_http_info(child_auth_key, async_req=True) + >>> thread = api.get_child_info_with_http_info(child_identifier, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :return: GetChildInfo If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key'] # noqa: E501 + all_params = ['child_identifier'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -993,16 +993,16 @@ def get_child_info_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `get_child_info`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `get_child_info`") # noqa: E501 collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -1024,7 +1024,7 @@ def get_child_info_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}', 'GET', + '/reseller/children/{childIdentifier}', 'GET', path_params, query_params, header_params, @@ -1138,45 +1138,45 @@ def get_reseller_childs_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_sso_token(self, child_auth_key, **kwargs): # noqa: E501 + def get_sso_token(self, child_identifier, **kwargs): # noqa: E501 """Get session token to access Sendinblue (SSO) # noqa: E501 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] # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_sso_token(child_auth_key, async_req=True) + >>> thread = api.get_sso_token(child_identifier, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :return: GetSsoToken If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.get_sso_token_with_http_info(child_auth_key, **kwargs) # noqa: E501 + return self.get_sso_token_with_http_info(child_identifier, **kwargs) # noqa: E501 else: - (data) = self.get_sso_token_with_http_info(child_auth_key, **kwargs) # noqa: E501 + (data) = self.get_sso_token_with_http_info(child_identifier, **kwargs) # noqa: E501 return data - def get_sso_token_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 + def get_sso_token_with_http_info(self, child_identifier, **kwargs): # noqa: E501 """Get session token to access Sendinblue (SSO) # noqa: E501 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] # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_sso_token_with_http_info(child_auth_key, async_req=True) + >>> thread = api.get_sso_token_with_http_info(child_identifier, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :return: GetSsoToken If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key'] # noqa: E501 + all_params = ['child_identifier'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1191,16 +1191,16 @@ def get_sso_token_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `get_sso_token`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `get_sso_token`") # noqa: E501 collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -1222,7 +1222,7 @@ def get_sso_token_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/auth', 'GET', + '/reseller/children/{childIdentifier}/auth', 'GET', path_params, query_params, header_params, @@ -1237,16 +1237,16 @@ def get_sso_token_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def remove_credits(self, child_auth_key, remove_credits, **kwargs): # noqa: E501 + def remove_credits(self, child_identifier, remove_credits, **kwargs): # noqa: E501 """Remove Email and/or SMS credits from a specific child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.remove_credits(child_auth_key, remove_credits, async_req=True) + >>> thread = api.remove_credits(child_identifier, remove_credits, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param RemoveCredits remove_credits: Values to post to remove email or SMS credits from a specific child account (required) :return: RemainingCreditModel If the method is called asynchronously, @@ -1254,28 +1254,28 @@ def remove_credits(self, child_auth_key, remove_credits, **kwargs): # noqa: E50 """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.remove_credits_with_http_info(child_auth_key, remove_credits, **kwargs) # noqa: E501 + return self.remove_credits_with_http_info(child_identifier, remove_credits, **kwargs) # noqa: E501 else: - (data) = self.remove_credits_with_http_info(child_auth_key, remove_credits, **kwargs) # noqa: E501 + (data) = self.remove_credits_with_http_info(child_identifier, remove_credits, **kwargs) # noqa: E501 return data - def remove_credits_with_http_info(self, child_auth_key, remove_credits, **kwargs): # noqa: E501 + def remove_credits_with_http_info(self, child_identifier, remove_credits, **kwargs): # noqa: E501 """Remove Email and/or SMS credits from a specific child account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.remove_credits_with_http_info(child_auth_key, remove_credits, async_req=True) + >>> thread = api.remove_credits_with_http_info(child_identifier, remove_credits, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param RemoveCredits remove_credits: Values to post to remove email or SMS credits from a specific child account (required) :return: RemainingCreditModel If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key', 'remove_credits'] # noqa: E501 + all_params = ['child_identifier', 'remove_credits'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1290,10 +1290,10 @@ def remove_credits_with_http_info(self, child_auth_key, remove_credits, **kwargs ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `remove_credits`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `remove_credits`") # noqa: E501 # verify the required parameter 'remove_credits' is set if ('remove_credits' not in params or params['remove_credits'] is None): @@ -1302,8 +1302,8 @@ def remove_credits_with_http_info(self, child_auth_key, remove_credits, **kwargs collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -1327,7 +1327,7 @@ def remove_credits_with_http_info(self, child_auth_key, remove_credits, **kwargs auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/credits/remove', 'POST', + '/reseller/children/{childIdentifier}/credits/remove', 'POST', path_params, query_params, header_params, @@ -1342,16 +1342,16 @@ def remove_credits_with_http_info(self, child_auth_key, remove_credits, **kwargs _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_child_account_status(self, child_auth_key, update_child_account_status, **kwargs): # noqa: E501 - """Update info of reseller's child account status based on the childAuthKey supplied # noqa: E501 + def update_child_account_status(self, child_identifier, update_child_account_status, **kwargs): # noqa: E501 + """Update info of reseller's child account status based on the childIdentifier supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_child_account_status(child_auth_key, update_child_account_status, async_req=True) + >>> thread = api.update_child_account_status(child_identifier, update_child_account_status, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param UpdateChildAccountStatus update_child_account_status: values to update in child account status (required) :return: None If the method is called asynchronously, @@ -1359,28 +1359,28 @@ def update_child_account_status(self, child_auth_key, update_child_account_statu """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.update_child_account_status_with_http_info(child_auth_key, update_child_account_status, **kwargs) # noqa: E501 + return self.update_child_account_status_with_http_info(child_identifier, update_child_account_status, **kwargs) # noqa: E501 else: - (data) = self.update_child_account_status_with_http_info(child_auth_key, update_child_account_status, **kwargs) # noqa: E501 + (data) = self.update_child_account_status_with_http_info(child_identifier, update_child_account_status, **kwargs) # noqa: E501 return data - def update_child_account_status_with_http_info(self, child_auth_key, update_child_account_status, **kwargs): # noqa: E501 - """Update info of reseller's child account status based on the childAuthKey supplied # noqa: E501 + def update_child_account_status_with_http_info(self, child_identifier, update_child_account_status, **kwargs): # noqa: E501 + """Update info of reseller's child account status based on the childIdentifier supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_child_account_status_with_http_info(child_auth_key, update_child_account_status, async_req=True) + >>> thread = api.update_child_account_status_with_http_info(child_identifier, update_child_account_status, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param UpdateChildAccountStatus update_child_account_status: values to update in child account status (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key', 'update_child_account_status'] # noqa: E501 + all_params = ['child_identifier', 'update_child_account_status'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1395,10 +1395,10 @@ def update_child_account_status_with_http_info(self, child_auth_key, update_chil ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `update_child_account_status`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `update_child_account_status`") # noqa: E501 # verify the required parameter 'update_child_account_status' is set if ('update_child_account_status' not in params or params['update_child_account_status'] is None): @@ -1407,8 +1407,8 @@ def update_child_account_status_with_http_info(self, child_auth_key, update_chil collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -1432,7 +1432,7 @@ def update_child_account_status_with_http_info(self, child_auth_key, update_chil auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/accountStatus', 'PUT', + '/reseller/children/{childIdentifier}/accountStatus', 'PUT', path_params, query_params, header_params, @@ -1447,16 +1447,16 @@ def update_child_account_status_with_http_info(self, child_auth_key, update_chil _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_child_domain(self, child_auth_key, domain_name, update_child_domain, **kwargs): # noqa: E501 - """Update the sender domain of reseller's child based on the childAuthKey and domainName passed # noqa: E501 + def update_child_domain(self, child_identifier, domain_name, update_child_domain, **kwargs): # noqa: E501 + """Update the sender domain of reseller's child based on the childIdentifier and domainName passed # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_child_domain(child_auth_key, domain_name, update_child_domain, async_req=True) + >>> thread = api.update_child_domain(child_identifier, domain_name, update_child_domain, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param str domain_name: Pass the existing domain that needs to be updated (required) :param UpdateChildDomain update_child_domain: value to update for sender domain (required) :return: None @@ -1465,21 +1465,21 @@ def update_child_domain(self, child_auth_key, domain_name, update_child_domain, """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, **kwargs) # noqa: E501 + return self.update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, **kwargs) # noqa: E501 else: - (data) = self.update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, **kwargs) # noqa: E501 + (data) = self.update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, **kwargs) # noqa: E501 return data - def update_child_domain_with_http_info(self, child_auth_key, domain_name, update_child_domain, **kwargs): # noqa: E501 - """Update the sender domain of reseller's child based on the childAuthKey and domainName passed # noqa: E501 + def update_child_domain_with_http_info(self, child_identifier, domain_name, update_child_domain, **kwargs): # noqa: E501 + """Update the sender domain of reseller's child based on the childIdentifier and domainName passed # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, async_req=True) + >>> thread = api.update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param str domain_name: Pass the existing domain that needs to be updated (required) :param UpdateChildDomain update_child_domain: value to update for sender domain (required) :return: None @@ -1487,7 +1487,7 @@ def update_child_domain_with_http_info(self, child_auth_key, domain_name, update returns the request thread. """ - all_params = ['child_auth_key', 'domain_name', 'update_child_domain'] # noqa: E501 + all_params = ['child_identifier', 'domain_name', 'update_child_domain'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1502,10 +1502,10 @@ def update_child_domain_with_http_info(self, child_auth_key, domain_name, update ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `update_child_domain`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `update_child_domain`") # noqa: E501 # verify the required parameter 'domain_name' is set if ('domain_name' not in params or params['domain_name'] is None): @@ -1518,8 +1518,8 @@ def update_child_domain_with_http_info(self, child_auth_key, domain_name, update collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 if 'domain_name' in params: path_params['domainName'] = params['domain_name'] # noqa: E501 @@ -1545,7 +1545,7 @@ def update_child_domain_with_http_info(self, child_auth_key, domain_name, update auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}/domains/{domainName}', 'PUT', + '/reseller/children/{childIdentifier}/domains/{domainName}', 'PUT', path_params, query_params, header_params, @@ -1560,16 +1560,16 @@ def update_child_domain_with_http_info(self, child_auth_key, domain_name, update _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_reseller_child(self, child_auth_key, reseller_child, **kwargs): # noqa: E501 - """Update info of reseller's child based on the childAuthKey supplied # noqa: E501 + def update_reseller_child(self, child_identifier, reseller_child, **kwargs): # noqa: E501 + """Update info of reseller's child based on the child identifier supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_reseller_child(child_auth_key, reseller_child, async_req=True) + >>> thread = api.update_reseller_child(child_identifier, reseller_child, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param UpdateChild reseller_child: values to update in child profile (required) :return: None If the method is called asynchronously, @@ -1577,28 +1577,28 @@ def update_reseller_child(self, child_auth_key, reseller_child, **kwargs): # no """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.update_reseller_child_with_http_info(child_auth_key, reseller_child, **kwargs) # noqa: E501 + return self.update_reseller_child_with_http_info(child_identifier, reseller_child, **kwargs) # noqa: E501 else: - (data) = self.update_reseller_child_with_http_info(child_auth_key, reseller_child, **kwargs) # noqa: E501 + (data) = self.update_reseller_child_with_http_info(child_identifier, reseller_child, **kwargs) # noqa: E501 return data - def update_reseller_child_with_http_info(self, child_auth_key, reseller_child, **kwargs): # noqa: E501 - """Update info of reseller's child based on the childAuthKey supplied # noqa: E501 + def update_reseller_child_with_http_info(self, child_identifier, reseller_child, **kwargs): # noqa: E501 + """Update info of reseller's child based on the child identifier supplied # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_reseller_child_with_http_info(child_auth_key, reseller_child, async_req=True) + >>> thread = api.update_reseller_child_with_http_info(child_identifier, reseller_child, async_req=True) >>> result = thread.get() :param async_req bool - :param str child_auth_key: auth key of reseller's child (required) + :param str child_identifier: Either auth key or id of reseller's child (required) :param UpdateChild reseller_child: values to update in child profile (required) :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['child_auth_key', 'reseller_child'] # noqa: E501 + all_params = ['child_identifier', 'reseller_child'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1613,10 +1613,10 @@ def update_reseller_child_with_http_info(self, child_auth_key, reseller_child, * ) params[key] = val del params['kwargs'] - # verify the required parameter 'child_auth_key' is set - if ('child_auth_key' not in params or - params['child_auth_key'] is None): - raise ValueError("Missing the required parameter `child_auth_key` when calling `update_reseller_child`") # noqa: E501 + # verify the required parameter 'child_identifier' is set + if ('child_identifier' not in params or + params['child_identifier'] is None): + raise ValueError("Missing the required parameter `child_identifier` when calling `update_reseller_child`") # noqa: E501 # verify the required parameter 'reseller_child' is set if ('reseller_child' not in params or params['reseller_child'] is None): @@ -1625,8 +1625,8 @@ def update_reseller_child_with_http_info(self, child_auth_key, reseller_child, * collection_formats = {} path_params = {} - if 'child_auth_key' in params: - path_params['childAuthKey'] = params['child_auth_key'] # noqa: E501 + if 'child_identifier' in params: + path_params['childIdentifier'] = params['child_identifier'] # noqa: E501 query_params = [] @@ -1650,7 +1650,7 @@ def update_reseller_child_with_http_info(self, child_auth_key, reseller_child, * auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( - '/reseller/children/{childAuthKey}', 'PUT', + '/reseller/children/{childIdentifier}', 'PUT', path_params, query_params, header_params, diff --git a/sib_api_v3_sdk/api/transactional_sms_api.py b/sib_api_v3_sdk/api/transactional_sms_api.py index 86a0f9d..8f0f5e0 100644 --- a/sib_api_v3_sdk/api/transactional_sms_api.py +++ b/sib_api_v3_sdk/api/transactional_sms_api.py @@ -367,7 +367,7 @@ def get_transac_sms_report_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def send_transac_sms(self, send_transac_sms, **kwargs): # noqa: E501 - """Send the SMS campaign to a mobile number # noqa: E501 + """Send SMS message to a mobile number # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -388,7 +388,7 @@ def send_transac_sms(self, send_transac_sms, **kwargs): # noqa: E501 return data def send_transac_sms_with_http_info(self, send_transac_sms, **kwargs): # noqa: E501 - """Send the SMS campaign to a mobile number # noqa: E501 + """Send SMS message to a mobile number # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/sib_api_v3_sdk/models/create_child.py b/sib_api_v3_sdk/models/create_child.py index 7248dca..2b85aa1 100644 --- a/sib_api_v3_sdk/models/create_child.py +++ b/sib_api_v3_sdk/models/create_child.py @@ -35,7 +35,8 @@ class CreateChild(object): 'first_name': 'str', 'last_name': 'str', 'company_name': 'str', - 'password': 'str' + 'password': 'str', + 'language': 'str' } attribute_map = { @@ -43,10 +44,11 @@ class CreateChild(object): 'first_name': 'firstName', 'last_name': 'lastName', 'company_name': 'companyName', - 'password': 'password' + 'password': 'password', + 'language': 'language' } - def __init__(self, email=None, first_name=None, last_name=None, company_name=None, password=None): # noqa: E501 + def __init__(self, email=None, first_name=None, last_name=None, company_name=None, password=None, language=None): # noqa: E501 """CreateChild - a model defined in Swagger""" # noqa: E501 self._email = None @@ -54,6 +56,7 @@ def __init__(self, email=None, first_name=None, last_name=None, company_name=Non self._last_name = None self._company_name = None self._password = None + self._language = None self.discriminator = None self.email = email @@ -61,6 +64,8 @@ def __init__(self, email=None, first_name=None, last_name=None, company_name=Non self.last_name = last_name self.company_name = company_name self.password = password + if language is not None: + self.language = language @property def email(self): @@ -187,6 +192,35 @@ def password(self, password): self._password = password + @property + def language(self): + """Gets the language of this CreateChild. # noqa: E501 + + Language of the child account # noqa: E501 + + :return: The language of this CreateChild. # noqa: E501 + :rtype: str + """ + return self._language + + @language.setter + def language(self, language): + """Sets the language of this CreateChild. + + Language of the child account # noqa: E501 + + :param language: The language of this CreateChild. # noqa: E501 + :type: str + """ + allowed_values = ["fr", "es", "pt", "it", "de", "en"] # noqa: E501 + if language not in allowed_values: + raise ValueError( + "Invalid value for `language` ({0}), must be one of {1}" # noqa: E501 + .format(language, allowed_values) + ) + + self._language = language + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/create_doi_contact.py b/sib_api_v3_sdk/models/create_doi_contact.py index 36666e1..4136b8b 100644 --- a/sib_api_v3_sdk/models/create_doi_contact.py +++ b/sib_api_v3_sdk/models/create_doi_contact.py @@ -169,7 +169,7 @@ def exclude_list_ids(self, exclude_list_ids): def template_id(self): """Gets the template_id of this CreateDoiContact. # noqa: E501 - Id of the DOI template # noqa: E501 + Id of the Double opt-in (DOI) template # noqa: E501 :return: The template_id of this CreateDoiContact. # noqa: E501 :rtype: int @@ -180,7 +180,7 @@ def template_id(self): def template_id(self, template_id): """Sets the template_id of this CreateDoiContact. - Id of the DOI template # noqa: E501 + Id of the Double opt-in (DOI) template # noqa: E501 :param template_id: The template_id of this CreateDoiContact. # noqa: E501 :type: int @@ -194,7 +194,7 @@ def template_id(self, template_id): def redirection_url(self): """Gets the redirection_url of this CreateDoiContact. # noqa: E501 - URL of the web page that user will be redirected to after clicking on the double opt in URL. # noqa: E501 + 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 }}. # noqa: E501 :return: The redirection_url of this CreateDoiContact. # noqa: E501 :rtype: str @@ -205,7 +205,7 @@ def redirection_url(self): def redirection_url(self, redirection_url): """Sets the redirection_url of this CreateDoiContact. - URL of the web page that user will be redirected to after clicking on the double opt in URL. # noqa: E501 + 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 }}. # noqa: E501 :param redirection_url: The redirection_url of this CreateDoiContact. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/create_reseller.py b/sib_api_v3_sdk/models/create_reseller.py index 3569cf4..d06b1ef 100644 --- a/sib_api_v3_sdk/models/create_reseller.py +++ b/sib_api_v3_sdk/models/create_reseller.py @@ -31,20 +31,25 @@ class CreateReseller(object): and the value is json key in definition. """ swagger_types = { - 'auth_key': 'str' + 'auth_key': 'str', + 'id': 'int' } attribute_map = { - 'auth_key': 'authKey' + 'auth_key': 'authKey', + 'id': 'id' } - def __init__(self, auth_key=None): # noqa: E501 + def __init__(self, auth_key=None, id=None): # noqa: E501 """CreateReseller - a model defined in Swagger""" # noqa: E501 self._auth_key = None + self._id = None self.discriminator = None self.auth_key = auth_key + if id is not None: + self.id = id @property def auth_key(self): @@ -71,6 +76,29 @@ def auth_key(self, auth_key): self._auth_key = auth_key + @property + def id(self): + """Gets the id of this CreateReseller. # noqa: E501 + + Id of Reseller child created # noqa: E501 + + :return: The id of this CreateReseller. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this CreateReseller. + + Id of Reseller child created # noqa: E501 + + :param id: The id of this CreateReseller. # noqa: E501 + :type: int + """ + + self._id = id + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/create_sender.py b/sib_api_v3_sdk/models/create_sender.py index 269e136..74d5fb9 100644 --- a/sib_api_v3_sdk/models/create_sender.py +++ b/sib_api_v3_sdk/models/create_sender.py @@ -84,7 +84,7 @@ def name(self, name): def email(self): """Gets the email of this CreateSender. # noqa: E501 - From Email to use for the sender # noqa: E501 + From email to use for the sender. A verification email will be sent to this address. # noqa: E501 :return: The email of this CreateSender. # noqa: E501 :rtype: str @@ -95,7 +95,7 @@ def email(self): def email(self, email): """Sets the email of this CreateSender. - From Email to use for the sender # noqa: E501 + From email to use for the sender. A verification email will be sent to this address. # noqa: E501 :param email: The email of this CreateSender. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/create_webhook.py b/sib_api_v3_sdk/models/create_webhook.py index 65339d8..f5359b0 100644 --- a/sib_api_v3_sdk/models/create_webhook.py +++ b/sib_api_v3_sdk/models/create_webhook.py @@ -112,7 +112,7 @@ def description(self, description): def events(self): """Gets the events of this CreateWebhook. # noqa: E501 - 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 # noqa: E501 + Events triggering the webhook. Possible values for Transactional type webhook – sent, 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 # noqa: E501 :return: The events of this CreateWebhook. # noqa: E501 :rtype: list[str] @@ -123,14 +123,14 @@ def events(self): def events(self, events): """Sets the events of this CreateWebhook. - 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 # noqa: E501 + Events triggering the webhook. Possible values for Transactional type webhook – sent, 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 # noqa: E501 :param events: The events of this CreateWebhook. # noqa: E501 :type: list[str] """ if events is None: raise ValueError("Invalid value for `events`, must not be `None`") # noqa: E501 - allowed_values = ["hardBounce", "softBounce", "blocked", "spam", "delivered", "request", "click", "invalid", "deferred", "opened", "uniqueOpened", "unsubscribed", "listAddition", "contactUpdated", "contactDeleted"] # noqa: E501 + allowed_values = ["sent", "hardBounce", "softBounce", "blocked", "spam", "delivered", "request", "click", "invalid", "deferred", "opened", "uniqueOpened", "unsubscribed", "listAddition", "contactUpdated", "contactDeleted"] # noqa: E501 if not set(events).issubset(set(allowed_values)): raise ValueError( "Invalid values for `events` [{0}], must be a subset of [{1}]" # noqa: E501 diff --git a/sib_api_v3_sdk/models/email_export_recipients.py b/sib_api_v3_sdk/models/email_export_recipients.py index 35d1e37..d927987 100644 --- a/sib_api_v3_sdk/models/email_export_recipients.py +++ b/sib_api_v3_sdk/models/email_export_recipients.py @@ -55,7 +55,7 @@ def __init__(self, notify_url=None, recipients_type=None): # noqa: E501 def notify_url(self): """Gets the notify_url of this EmailExportRecipients. # noqa: E501 - Webhook called once the export process is finished # noqa: E501 + Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501 :return: The notify_url of this EmailExportRecipients. # noqa: E501 :rtype: str @@ -66,7 +66,7 @@ def notify_url(self): def notify_url(self, notify_url): """Sets the notify_url of this EmailExportRecipients. - Webhook called once the export process is finished # noqa: E501 + Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501 :param notify_url: The notify_url of this EmailExportRecipients. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/get_email_campaign.py b/sib_api_v3_sdk/models/get_email_campaign.py index 1d386b5..cd0e33f 100644 --- a/sib_api_v3_sdk/models/get_email_campaign.py +++ b/sib_api_v3_sdk/models/get_email_campaign.py @@ -59,6 +59,7 @@ class GetEmailCampaign(object): 'mirror_active': 'bool', 'recurring': 'bool', 'sent_date': 'datetime', + 'return_bounce': 'int', 'recipients': 'object', 'statistics': 'object' } @@ -92,11 +93,12 @@ class GetEmailCampaign(object): 'mirror_active': 'mirrorActive', 'recurring': 'recurring', 'sent_date': 'sentDate', + 'return_bounce': 'returnBounce', 'recipients': 'recipients', 'statistics': 'statistics' } - def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, sent_date=None, recipients=None, statistics=None): # noqa: E501 + def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, sent_date=None, return_bounce=None, recipients=None, statistics=None): # noqa: E501 """GetEmailCampaign - a model defined in Swagger""" # noqa: E501 self._id = None @@ -127,6 +129,7 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch self._mirror_active = None self._recurring = None self._sent_date = None + self._return_bounce = None self._recipients = None self._statistics = None self.discriminator = None @@ -173,6 +176,8 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch self.recurring = recurring if sent_date is not None: self.sent_date = sent_date + if return_bounce is not None: + self.return_bounce = return_bounce self.recipients = recipients self.statistics = statistics @@ -858,6 +863,29 @@ def sent_date(self, sent_date): self._sent_date = sent_date + @property + def return_bounce(self): + """Gets the return_bounce of this GetEmailCampaign. # noqa: E501 + + Total number of non-delivered campaigns for a particular campaign id. # noqa: E501 + + :return: The return_bounce of this GetEmailCampaign. # noqa: E501 + :rtype: int + """ + return self._return_bounce + + @return_bounce.setter + def return_bounce(self, return_bounce): + """Sets the return_bounce of this GetEmailCampaign. + + Total number of non-delivered campaigns for a particular campaign id. # noqa: E501 + + :param return_bounce: The return_bounce of this GetEmailCampaign. # noqa: E501 + :type: int + """ + + self._return_bounce = return_bounce + @property def recipients(self): """Gets the recipients of this GetEmailCampaign. # noqa: E501 diff --git a/sib_api_v3_sdk/models/get_extended_campaign_overview.py b/sib_api_v3_sdk/models/get_extended_campaign_overview.py index dab5012..da5051b 100644 --- a/sib_api_v3_sdk/models/get_extended_campaign_overview.py +++ b/sib_api_v3_sdk/models/get_extended_campaign_overview.py @@ -58,7 +58,8 @@ class GetExtendedCampaignOverview(object): 'inline_image_activation': 'bool', 'mirror_active': 'bool', 'recurring': 'bool', - 'sent_date': 'datetime' + 'sent_date': 'datetime', + 'return_bounce': 'int' } attribute_map = { @@ -89,10 +90,11 @@ class GetExtendedCampaignOverview(object): 'inline_image_activation': 'inlineImageActivation', 'mirror_active': 'mirrorActive', 'recurring': 'recurring', - 'sent_date': 'sentDate' + 'sent_date': 'sentDate', + 'return_bounce': 'returnBounce' } - def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, sent_date=None): # noqa: E501 + def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, sent_date=None, return_bounce=None): # noqa: E501 """GetExtendedCampaignOverview - a model defined in Swagger""" # noqa: E501 self._id = None @@ -123,6 +125,7 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch self._mirror_active = None self._recurring = None self._sent_date = None + self._return_bounce = None self.discriminator = None self.id = id @@ -167,6 +170,8 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch self.recurring = recurring if sent_date is not None: self.sent_date = sent_date + if return_bounce is not None: + self.return_bounce = return_bounce @property def id(self): @@ -850,6 +855,29 @@ def sent_date(self, sent_date): self._sent_date = sent_date + @property + def return_bounce(self): + """Gets the return_bounce of this GetExtendedCampaignOverview. # noqa: E501 + + Total number of non-delivered campaigns for a particular campaign id. # noqa: E501 + + :return: The return_bounce of this GetExtendedCampaignOverview. # noqa: E501 + :rtype: int + """ + return self._return_bounce + + @return_bounce.setter + def return_bounce(self, return_bounce): + """Sets the return_bounce of this GetExtendedCampaignOverview. + + Total number of non-delivered campaigns for a particular campaign id. # noqa: E501 + + :param return_bounce: The return_bounce of this GetExtendedCampaignOverview. # noqa: E501 + :type: int + """ + + self._return_bounce = return_bounce + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/get_smtp_template_overview.py b/sib_api_v3_sdk/models/get_smtp_template_overview.py index c3594b8..999ad03 100644 --- a/sib_api_v3_sdk/models/get_smtp_template_overview.py +++ b/sib_api_v3_sdk/models/get_smtp_template_overview.py @@ -42,7 +42,8 @@ class GetSmtpTemplateOverview(object): 'tag': 'str', 'html_content': 'str', 'created_at': 'datetime', - 'modified_at': 'datetime' + 'modified_at': 'datetime', + 'doi_template': 'bool' } attribute_map = { @@ -57,10 +58,11 @@ class GetSmtpTemplateOverview(object): 'tag': 'tag', 'html_content': 'htmlContent', 'created_at': 'createdAt', - 'modified_at': 'modifiedAt' + 'modified_at': 'modifiedAt', + 'doi_template': 'doiTemplate' } - def __init__(self, id=None, name=None, subject=None, is_active=None, test_sent=None, sender=None, reply_to=None, to_field=None, tag=None, html_content=None, created_at=None, modified_at=None): # noqa: E501 + def __init__(self, id=None, name=None, subject=None, is_active=None, test_sent=None, sender=None, reply_to=None, to_field=None, tag=None, html_content=None, created_at=None, modified_at=None, doi_template=None): # noqa: E501 """GetSmtpTemplateOverview - a model defined in Swagger""" # noqa: E501 self._id = None @@ -75,6 +77,7 @@ def __init__(self, id=None, name=None, subject=None, is_active=None, test_sent=N self._html_content = None self._created_at = None self._modified_at = None + self._doi_template = None self.discriminator = None self.id = id @@ -89,6 +92,8 @@ def __init__(self, id=None, name=None, subject=None, is_active=None, test_sent=N self.html_content = html_content self.created_at = created_at self.modified_at = modified_at + if doi_template is not None: + self.doi_template = doi_template @property def id(self): @@ -388,6 +393,29 @@ def modified_at(self, modified_at): self._modified_at = modified_at + @property + def doi_template(self): + """Gets the doi_template of this GetSmtpTemplateOverview. # noqa: E501 + + 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. # noqa: E501 + + :return: The doi_template of this GetSmtpTemplateOverview. # noqa: E501 + :rtype: bool + """ + return self._doi_template + + @doi_template.setter + def doi_template(self, doi_template): + """Sets the doi_template of this GetSmtpTemplateOverview. + + 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. # noqa: E501 + + :param doi_template: The doi_template of this GetSmtpTemplateOverview. # noqa: E501 + :type: bool + """ + + self._doi_template = doi_template + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/post_contact_info_contacts.py b/sib_api_v3_sdk/models/post_contact_info_contacts.py index 1549b4a..8fedaed 100644 --- a/sib_api_v3_sdk/models/post_contact_info_contacts.py +++ b/sib_api_v3_sdk/models/post_contact_info_contacts.py @@ -33,21 +33,24 @@ class PostContactInfoContacts(object): swagger_types = { 'success': 'list[str]', 'failure': 'list[str]', - 'total': 'int' + 'total': 'int', + 'process_id': 'int' } attribute_map = { 'success': 'success', 'failure': 'failure', - 'total': 'total' + 'total': 'total', + 'process_id': 'processId' } - def __init__(self, success=None, failure=None, total=None): # noqa: E501 + def __init__(self, success=None, failure=None, total=None, process_id=None): # noqa: E501 """PostContactInfoContacts - a model defined in Swagger""" # noqa: E501 self._success = None self._failure = None self._total = None + self._process_id = None self.discriminator = None if success is not None: @@ -56,6 +59,8 @@ def __init__(self, success=None, failure=None, total=None): # noqa: E501 self.failure = failure if total is not None: self.total = total + if process_id is not None: + self.process_id = process_id @property def success(self): @@ -122,6 +127,29 @@ def total(self, total): self._total = total + @property + def process_id(self): + """Gets the process_id of this PostContactInfoContacts. # noqa: E501 + + Id of the process created to remove contacts from list when user opts for \"all\" option. # noqa: E501 + + :return: The process_id of this PostContactInfoContacts. # noqa: E501 + :rtype: int + """ + return self._process_id + + @process_id.setter + def process_id(self, process_id): + """Sets the process_id of this PostContactInfoContacts. + + Id of the process created to remove contacts from list when user opts for \"all\" option. # noqa: E501 + + :param process_id: The process_id of this PostContactInfoContacts. # noqa: E501 + :type: int + """ + + self._process_id = process_id + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/remove_contact_from_list.py b/sib_api_v3_sdk/models/remove_contact_from_list.py index f249fc4..83f34de 100644 --- a/sib_api_v3_sdk/models/remove_contact_from_list.py +++ b/sib_api_v3_sdk/models/remove_contact_from_list.py @@ -79,7 +79,7 @@ def emails(self, emails): def all(self): """Gets the all of this RemoveContactFromList. # noqa: E501 - Required if 'emails' is empty. Remove all existing contacts from a list # noqa: E501 + Required if 'emails' is empty. 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 # noqa: E501 :return: The all of this RemoveContactFromList. # noqa: E501 :rtype: bool @@ -90,7 +90,7 @@ def all(self): def all(self, all): """Sets the all of this RemoveContactFromList. - Required if 'emails' is empty. Remove all existing contacts from a list # noqa: E501 + Required if 'emails' is empty. 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 # noqa: E501 :param all: The all of this RemoveContactFromList. # noqa: E501 :type: bool diff --git a/sib_api_v3_sdk/models/request_contact_export.py b/sib_api_v3_sdk/models/request_contact_export.py index 8ab8940..f5c4764 100644 --- a/sib_api_v3_sdk/models/request_contact_export.py +++ b/sib_api_v3_sdk/models/request_contact_export.py @@ -133,7 +133,7 @@ def custom_contact_filter(self, custom_contact_filter): def notify_url(self): """Gets the notify_url of this RequestContactExport. # noqa: E501 - Webhook that will be called once the export process is finished # noqa: E501 + Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501 :return: The notify_url of this RequestContactExport. # noqa: E501 :rtype: str @@ -144,7 +144,7 @@ def notify_url(self): def notify_url(self, notify_url): """Sets the notify_url of this RequestContactExport. - Webhook that will be called once the export process is finished # noqa: E501 + Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501 :param notify_url: The notify_url of this RequestContactExport. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/request_contact_import.py b/sib_api_v3_sdk/models/request_contact_import.py index a5eac64..56bd991 100644 --- a/sib_api_v3_sdk/models/request_contact_import.py +++ b/sib_api_v3_sdk/models/request_contact_import.py @@ -160,7 +160,7 @@ def list_ids(self, list_ids): def notify_url(self): """Gets the notify_url of this RequestContactImport. # noqa: E501 - URL that will be called once the export process is finished # noqa: E501 + URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501 :return: The notify_url of this RequestContactImport. # noqa: E501 :rtype: str @@ -171,7 +171,7 @@ def notify_url(self): def notify_url(self, notify_url): """Sets the notify_url of this RequestContactImport. - URL that will be called once the export process is finished # noqa: E501 + URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501 :param notify_url: The notify_url of this RequestContactImport. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/request_sms_recipient_export.py b/sib_api_v3_sdk/models/request_sms_recipient_export.py index 9d95571..83f8fcf 100644 --- a/sib_api_v3_sdk/models/request_sms_recipient_export.py +++ b/sib_api_v3_sdk/models/request_sms_recipient_export.py @@ -55,7 +55,7 @@ def __init__(self, notify_url=None, recipients_type=None): # noqa: E501 def notify_url(self): """Gets the notify_url of this RequestSmsRecipientExport. # noqa: E501 - URL that will be called once the export process is finished # noqa: E501 + URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501 :return: The notify_url of this RequestSmsRecipientExport. # noqa: E501 :rtype: str @@ -66,7 +66,7 @@ def notify_url(self): def notify_url(self, notify_url): """Sets the notify_url of this RequestSmsRecipientExport. - URL that will be called once the export process is finished # noqa: E501 + URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501 :param notify_url: The notify_url of this RequestSmsRecipientExport. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/send_smtp_email.py b/sib_api_v3_sdk/models/send_smtp_email.py index 03a3c73..3f0bcef 100644 --- a/sib_api_v3_sdk/models/send_smtp_email.py +++ b/sib_api_v3_sdk/models/send_smtp_email.py @@ -292,7 +292,7 @@ def reply_to(self, reply_to): def attachment(self): """Gets the attachment of this SendSmtpEmail. # noqa: E501 - 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 ) # noqa: E501 + 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 ) # noqa: E501 :return: The attachment of this SendSmtpEmail. # noqa: E501 :rtype: list[SendSmtpEmailAttachment] @@ -303,7 +303,7 @@ def attachment(self): def attachment(self, attachment): """Sets the attachment of this SendSmtpEmail. - 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 ) # noqa: E501 + 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 ) # noqa: E501 :param attachment: The attachment of this SendSmtpEmail. # noqa: E501 :type: list[SendSmtpEmailAttachment] diff --git a/sib_api_v3_sdk/models/update_child_account_status.py b/sib_api_v3_sdk/models/update_child_account_status.py index 5e59bc6..64bb949 100644 --- a/sib_api_v3_sdk/models/update_child_account_status.py +++ b/sib_api_v3_sdk/models/update_child_account_status.py @@ -33,21 +33,24 @@ class UpdateChildAccountStatus(object): swagger_types = { 'transactional_email': 'bool', 'transactional_sms': 'bool', - 'marketing_automation': 'bool' + 'marketing_automation': 'bool', + 'sms_campaign': 'bool' } attribute_map = { 'transactional_email': 'transactionalEmail', 'transactional_sms': 'transactionalSms', - 'marketing_automation': 'marketingAutomation' + 'marketing_automation': 'marketingAutomation', + 'sms_campaign': 'smsCampaign' } - def __init__(self, transactional_email=None, transactional_sms=None, marketing_automation=None): # noqa: E501 + def __init__(self, transactional_email=None, transactional_sms=None, marketing_automation=None, sms_campaign=None): # noqa: E501 """UpdateChildAccountStatus - a model defined in Swagger""" # noqa: E501 self._transactional_email = None self._transactional_sms = None self._marketing_automation = None + self._sms_campaign = None self.discriminator = None if transactional_email is not None: @@ -56,6 +59,8 @@ def __init__(self, transactional_email=None, transactional_sms=None, marketing_a self.transactional_sms = transactional_sms if marketing_automation is not None: self.marketing_automation = marketing_automation + if sms_campaign is not None: + self.sms_campaign = sms_campaign @property def transactional_email(self): @@ -126,6 +131,29 @@ def marketing_automation(self, marketing_automation): self._marketing_automation = marketing_automation + @property + def sms_campaign(self): + """Gets the sms_campaign of this UpdateChildAccountStatus. # noqa: E501 + + Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) # noqa: E501 + + :return: The sms_campaign of this UpdateChildAccountStatus. # noqa: E501 + :rtype: bool + """ + return self._sms_campaign + + @sms_campaign.setter + def sms_campaign(self, sms_campaign): + """Sets the sms_campaign of this UpdateChildAccountStatus. + + Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) # noqa: E501 + + :param sms_campaign: The sms_campaign of this UpdateChildAccountStatus. # noqa: E501 + :type: bool + """ + + self._sms_campaign = sms_campaign + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/test/test_contacts_api.py b/test/test_contacts_api.py index 42e2be4..098f3da 100644 --- a/test/test_contacts_api.py +++ b/test/test_contacts_api.py @@ -53,7 +53,7 @@ def test_create_contact(self): def test_create_doi_contact(self): """Test case for create_doi_contact - Create a contact to trigger the DOI workflow from a Landing Page form # noqa: E501 + Create Contact via DOI (Double-Opt-In) Flow # noqa: E501 """ pass diff --git a/test/test_reseller_api.py b/test/test_reseller_api.py index c9eb99a..17de480 100644 --- a/test/test_reseller_api.py +++ b/test/test_reseller_api.py @@ -60,14 +60,14 @@ def test_create_reseller_child(self): def test_delete_child_domain(self): """Test case for delete_child_domain - Delete the sender domain of the reseller child based on the childAuthKey and domainName passed # noqa: E501 + Delete the sender domain of the reseller child based on the childIdentifier and domainName passed # noqa: E501 """ pass def test_delete_reseller_child(self): """Test case for delete_reseller_child - Delete a single reseller child based on the childAuthKey supplied # noqa: E501 + Delete a single reseller child based on the child identifier supplied # noqa: E501 """ pass @@ -81,7 +81,7 @@ def test_dissociate_ip_from_child(self): def test_get_child_account_creation_status(self): """Test case for get_child_account_creation_status - Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied # noqa: E501 + Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied # noqa: E501 """ pass @@ -123,21 +123,21 @@ def test_remove_credits(self): def test_update_child_account_status(self): """Test case for update_child_account_status - Update info of reseller's child account status based on the childAuthKey supplied # noqa: E501 + Update info of reseller's child account status based on the childIdentifier supplied # noqa: E501 """ pass def test_update_child_domain(self): """Test case for update_child_domain - Update the sender domain of reseller's child based on the childAuthKey and domainName passed # noqa: E501 + Update the sender domain of reseller's child based on the childIdentifier and domainName passed # noqa: E501 """ pass def test_update_reseller_child(self): """Test case for update_reseller_child - Update info of reseller's child based on the childAuthKey supplied # noqa: E501 + Update info of reseller's child based on the child identifier supplied # noqa: E501 """ pass diff --git a/test/test_transactional_sms_api.py b/test/test_transactional_sms_api.py index fe138d2..7278c72 100644 --- a/test/test_transactional_sms_api.py +++ b/test/test_transactional_sms_api.py @@ -53,7 +53,7 @@ def test_get_transac_sms_report(self): def test_send_transac_sms(self): """Test case for send_transac_sms - Send the SMS campaign to a mobile number # noqa: E501 + Send SMS message to a mobile number # noqa: E501 """ pass