index
int64 0
731k
| package
stringlengths 2
98
⌀ | name
stringlengths 1
76
| docstring
stringlengths 0
281k
⌀ | code
stringlengths 4
1.07M
⌀ | signature
stringlengths 2
42.8k
⌀ |
|---|---|---|---|---|---|
60,346 |
sib_api_v3_sdk.models.update_contact
|
UpdateContact
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateContact(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'attributes': 'object',
'ext_id': 'str',
'email_blacklisted': 'bool',
'sms_blacklisted': 'bool',
'list_ids': 'list[int]',
'unlink_list_ids': 'list[int]',
'smtp_blacklist_sender': 'list[str]'
}
attribute_map = {
'attributes': 'attributes',
'ext_id': 'ext_id',
'email_blacklisted': 'emailBlacklisted',
'sms_blacklisted': 'smsBlacklisted',
'list_ids': 'listIds',
'unlink_list_ids': 'unlinkListIds',
'smtp_blacklist_sender': 'smtpBlacklistSender'
}
def __init__(self, attributes=None, ext_id=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, unlink_list_ids=None, smtp_blacklist_sender=None): # noqa: E501
"""UpdateContact - a model defined in Swagger""" # noqa: E501
self._attributes = None
self._ext_id = None
self._email_blacklisted = None
self._sms_blacklisted = None
self._list_ids = None
self._unlink_list_ids = None
self._smtp_blacklist_sender = None
self.discriminator = None
if attributes is not None:
self.attributes = attributes
if ext_id is not None:
self.ext_id = ext_id
if email_blacklisted is not None:
self.email_blacklisted = email_blacklisted
if sms_blacklisted is not None:
self.sms_blacklisted = sms_blacklisted
if list_ids is not None:
self.list_ids = list_ids
if unlink_list_ids is not None:
self.unlink_list_ids = unlink_list_ids
if smtp_blacklist_sender is not None:
self.smtp_blacklist_sender = smtp_blacklist_sender
@property
def attributes(self):
"""Gets the attributes of this UpdateContact. # noqa: E501
Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"[email protected]\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} # noqa: E501
:return: The attributes of this UpdateContact. # noqa: E501
:rtype: object
"""
return self._attributes
@attributes.setter
def attributes(self, attributes):
"""Sets the attributes of this UpdateContact.
Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"[email protected]\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} # noqa: E501
:param attributes: The attributes of this UpdateContact. # noqa: E501
:type: object
"""
self._attributes = attributes
@property
def ext_id(self):
"""Gets the ext_id of this UpdateContact. # noqa: E501
Pass your own Id to update ext_id of a contact. # noqa: E501
:return: The ext_id of this UpdateContact. # noqa: E501
:rtype: str
"""
return self._ext_id
@ext_id.setter
def ext_id(self, ext_id):
"""Sets the ext_id of this UpdateContact.
Pass your own Id to update ext_id of a contact. # noqa: E501
:param ext_id: The ext_id of this UpdateContact. # noqa: E501
:type: str
"""
self._ext_id = ext_id
@property
def email_blacklisted(self):
"""Gets the email_blacklisted of this UpdateContact. # noqa: E501
Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) # noqa: E501
:return: The email_blacklisted of this UpdateContact. # noqa: E501
:rtype: bool
"""
return self._email_blacklisted
@email_blacklisted.setter
def email_blacklisted(self, email_blacklisted):
"""Sets the email_blacklisted of this UpdateContact.
Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) # noqa: E501
:param email_blacklisted: The email_blacklisted of this UpdateContact. # noqa: E501
:type: bool
"""
self._email_blacklisted = email_blacklisted
@property
def sms_blacklisted(self):
"""Gets the sms_blacklisted of this UpdateContact. # noqa: E501
Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) # noqa: E501
:return: The sms_blacklisted of this UpdateContact. # noqa: E501
:rtype: bool
"""
return self._sms_blacklisted
@sms_blacklisted.setter
def sms_blacklisted(self, sms_blacklisted):
"""Sets the sms_blacklisted of this UpdateContact.
Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) # noqa: E501
:param sms_blacklisted: The sms_blacklisted of this UpdateContact. # noqa: E501
:type: bool
"""
self._sms_blacklisted = sms_blacklisted
@property
def list_ids(self):
"""Gets the list_ids of this UpdateContact. # noqa: E501
Ids of the lists to add the contact to # noqa: E501
:return: The list_ids of this UpdateContact. # noqa: E501
:rtype: list[int]
"""
return self._list_ids
@list_ids.setter
def list_ids(self, list_ids):
"""Sets the list_ids of this UpdateContact.
Ids of the lists to add the contact to # noqa: E501
:param list_ids: The list_ids of this UpdateContact. # noqa: E501
:type: list[int]
"""
self._list_ids = list_ids
@property
def unlink_list_ids(self):
"""Gets the unlink_list_ids of this UpdateContact. # noqa: E501
Ids of the lists to remove the contact from # noqa: E501
:return: The unlink_list_ids of this UpdateContact. # noqa: E501
:rtype: list[int]
"""
return self._unlink_list_ids
@unlink_list_ids.setter
def unlink_list_ids(self, unlink_list_ids):
"""Sets the unlink_list_ids of this UpdateContact.
Ids of the lists to remove the contact from # noqa: E501
:param unlink_list_ids: The unlink_list_ids of this UpdateContact. # noqa: E501
:type: list[int]
"""
self._unlink_list_ids = unlink_list_ids
@property
def smtp_blacklist_sender(self):
"""Gets the smtp_blacklist_sender of this UpdateContact. # noqa: E501
transactional email forbidden sender for contact. Use only for email Contact # noqa: E501
:return: The smtp_blacklist_sender of this UpdateContact. # noqa: E501
:rtype: list[str]
"""
return self._smtp_blacklist_sender
@smtp_blacklist_sender.setter
def smtp_blacklist_sender(self, smtp_blacklist_sender):
"""Sets the smtp_blacklist_sender of this UpdateContact.
transactional email forbidden sender for contact. Use only for email Contact # noqa: E501
:param smtp_blacklist_sender: The smtp_blacklist_sender of this UpdateContact. # noqa: E501
:type: list[str]
"""
self._smtp_blacklist_sender = smtp_blacklist_sender
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateContact, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateContact):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(attributes=None, ext_id=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, unlink_list_ids=None, smtp_blacklist_sender=None)
|
60,347 |
sib_api_v3_sdk.models.update_contact
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateContact):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,348 |
sib_api_v3_sdk.models.update_contact
|
__init__
|
UpdateContact - a model defined in Swagger
|
def __init__(self, attributes=None, ext_id=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, unlink_list_ids=None, smtp_blacklist_sender=None): # noqa: E501
"""UpdateContact - a model defined in Swagger""" # noqa: E501
self._attributes = None
self._ext_id = None
self._email_blacklisted = None
self._sms_blacklisted = None
self._list_ids = None
self._unlink_list_ids = None
self._smtp_blacklist_sender = None
self.discriminator = None
if attributes is not None:
self.attributes = attributes
if ext_id is not None:
self.ext_id = ext_id
if email_blacklisted is not None:
self.email_blacklisted = email_blacklisted
if sms_blacklisted is not None:
self.sms_blacklisted = sms_blacklisted
if list_ids is not None:
self.list_ids = list_ids
if unlink_list_ids is not None:
self.unlink_list_ids = unlink_list_ids
if smtp_blacklist_sender is not None:
self.smtp_blacklist_sender = smtp_blacklist_sender
|
(self, attributes=None, ext_id=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, unlink_list_ids=None, smtp_blacklist_sender=None)
|
60,351 |
sib_api_v3_sdk.models.update_contact
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateContact, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,353 |
sib_api_v3_sdk.models.update_email_campaign
|
UpdateEmailCampaign
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateEmailCampaign(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'tag': 'str',
'sender': 'UpdateEmailCampaignSender',
'name': 'str',
'html_content': 'str',
'html_url': 'str',
'scheduled_at': 'str',
'subject': 'str',
'reply_to': 'str',
'to_field': 'str',
'recipients': 'UpdateEmailCampaignRecipients',
'attachment_url': 'str',
'inline_image_activation': 'bool',
'mirror_active': 'bool',
'recurring': 'bool',
'footer': 'str',
'header': 'str',
'utm_campaign': 'str',
'params': 'object',
'send_at_best_time': 'bool',
'ab_testing': 'bool',
'subject_a': 'str',
'subject_b': 'str',
'split_rule': 'int',
'winner_criteria': 'str',
'winner_delay': 'int',
'ip_warmup_enable': 'bool',
'initial_quota': 'int',
'increase_rate': 'int',
'unsubscription_page_id': 'str',
'update_form_id': 'str'
}
attribute_map = {
'tag': 'tag',
'sender': 'sender',
'name': 'name',
'html_content': 'htmlContent',
'html_url': 'htmlUrl',
'scheduled_at': 'scheduledAt',
'subject': 'subject',
'reply_to': 'replyTo',
'to_field': 'toField',
'recipients': 'recipients',
'attachment_url': 'attachmentUrl',
'inline_image_activation': 'inlineImageActivation',
'mirror_active': 'mirrorActive',
'recurring': 'recurring',
'footer': 'footer',
'header': 'header',
'utm_campaign': 'utmCampaign',
'params': 'params',
'send_at_best_time': 'sendAtBestTime',
'ab_testing': 'abTesting',
'subject_a': 'subjectA',
'subject_b': 'subjectB',
'split_rule': 'splitRule',
'winner_criteria': 'winnerCriteria',
'winner_delay': 'winnerDelay',
'ip_warmup_enable': 'ipWarmupEnable',
'initial_quota': 'initialQuota',
'increase_rate': 'increaseRate',
'unsubscription_page_id': 'unsubscriptionPageId',
'update_form_id': 'updateFormId'
}
def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, recurring=False, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=None, ab_testing=False, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, ip_warmup_enable=False, initial_quota=None, increase_rate=None, unsubscription_page_id=None, update_form_id=None): # noqa: E501
"""UpdateEmailCampaign - a model defined in Swagger""" # noqa: E501
self._tag = None
self._sender = None
self._name = None
self._html_content = None
self._html_url = None
self._scheduled_at = None
self._subject = None
self._reply_to = None
self._to_field = None
self._recipients = None
self._attachment_url = None
self._inline_image_activation = None
self._mirror_active = None
self._recurring = None
self._footer = None
self._header = None
self._utm_campaign = None
self._params = None
self._send_at_best_time = None
self._ab_testing = None
self._subject_a = None
self._subject_b = None
self._split_rule = None
self._winner_criteria = None
self._winner_delay = None
self._ip_warmup_enable = None
self._initial_quota = None
self._increase_rate = None
self._unsubscription_page_id = None
self._update_form_id = None
self.discriminator = None
if tag is not None:
self.tag = tag
if sender is not None:
self.sender = sender
if name is not None:
self.name = name
if html_content is not None:
self.html_content = html_content
if html_url is not None:
self.html_url = html_url
if scheduled_at is not None:
self.scheduled_at = scheduled_at
if subject is not None:
self.subject = subject
if reply_to is not None:
self.reply_to = reply_to
if to_field is not None:
self.to_field = to_field
if recipients is not None:
self.recipients = recipients
if attachment_url is not None:
self.attachment_url = attachment_url
if inline_image_activation is not None:
self.inline_image_activation = inline_image_activation
if mirror_active is not None:
self.mirror_active = mirror_active
if recurring is not None:
self.recurring = recurring
if footer is not None:
self.footer = footer
if header is not None:
self.header = header
if utm_campaign is not None:
self.utm_campaign = utm_campaign
if params is not None:
self.params = params
if send_at_best_time is not None:
self.send_at_best_time = send_at_best_time
if ab_testing is not None:
self.ab_testing = ab_testing
if subject_a is not None:
self.subject_a = subject_a
if subject_b is not None:
self.subject_b = subject_b
if split_rule is not None:
self.split_rule = split_rule
if winner_criteria is not None:
self.winner_criteria = winner_criteria
if winner_delay is not None:
self.winner_delay = winner_delay
if ip_warmup_enable is not None:
self.ip_warmup_enable = ip_warmup_enable
if initial_quota is not None:
self.initial_quota = initial_quota
if increase_rate is not None:
self.increase_rate = increase_rate
if unsubscription_page_id is not None:
self.unsubscription_page_id = unsubscription_page_id
if update_form_id is not None:
self.update_form_id = update_form_id
@property
def tag(self):
"""Gets the tag of this UpdateEmailCampaign. # noqa: E501
Tag of the campaign # noqa: E501
:return: The tag of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._tag
@tag.setter
def tag(self, tag):
"""Sets the tag of this UpdateEmailCampaign.
Tag of the campaign # noqa: E501
:param tag: The tag of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._tag = tag
@property
def sender(self):
"""Gets the sender of this UpdateEmailCampaign. # noqa: E501
:return: The sender of this UpdateEmailCampaign. # noqa: E501
:rtype: UpdateEmailCampaignSender
"""
return self._sender
@sender.setter
def sender(self, sender):
"""Sets the sender of this UpdateEmailCampaign.
:param sender: The sender of this UpdateEmailCampaign. # noqa: E501
:type: UpdateEmailCampaignSender
"""
self._sender = sender
@property
def name(self):
"""Gets the name of this UpdateEmailCampaign. # noqa: E501
Name of the campaign # noqa: E501
:return: The name of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this UpdateEmailCampaign.
Name of the campaign # noqa: E501
:param name: The name of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._name = name
@property
def html_content(self):
"""Gets the html_content of this UpdateEmailCampaign. # noqa: E501
Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty # noqa: E501
:return: The html_content of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._html_content
@html_content.setter
def html_content(self, html_content):
"""Sets the html_content of this UpdateEmailCampaign.
Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty # noqa: E501
:param html_content: The html_content of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._html_content = html_content
@property
def html_url(self):
"""Gets the html_url of this UpdateEmailCampaign. # noqa: E501
Url which contents the body of the email message. REQUIRED if htmlContent is empty # noqa: E501
:return: The html_url of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._html_url
@html_url.setter
def html_url(self, html_url):
"""Sets the html_url of this UpdateEmailCampaign.
Url which contents the body of the email message. REQUIRED if htmlContent is empty # noqa: E501
:param html_url: The html_url of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._html_url = html_url
@property
def scheduled_at(self):
"""Gets the scheduled_at of this UpdateEmailCampaign. # noqa: E501
UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). # noqa: E501
:return: The scheduled_at of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._scheduled_at
@scheduled_at.setter
def scheduled_at(self, scheduled_at):
"""Sets the scheduled_at of this UpdateEmailCampaign.
UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). # noqa: E501
:param scheduled_at: The scheduled_at of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._scheduled_at = scheduled_at
@property
def subject(self):
"""Gets the subject of this UpdateEmailCampaign. # noqa: E501
Subject of the campaign # noqa: E501
:return: The subject of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._subject
@subject.setter
def subject(self, subject):
"""Sets the subject of this UpdateEmailCampaign.
Subject of the campaign # noqa: E501
:param subject: The subject of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._subject = subject
@property
def reply_to(self):
"""Gets the reply_to of this UpdateEmailCampaign. # noqa: E501
Email on which campaign recipients will be able to reply to # noqa: E501
:return: The reply_to of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._reply_to
@reply_to.setter
def reply_to(self, reply_to):
"""Sets the reply_to of this UpdateEmailCampaign.
Email on which campaign recipients will be able to reply to # noqa: E501
:param reply_to: The reply_to of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._reply_to = reply_to
@property
def to_field(self):
"""Gets the to_field of this UpdateEmailCampaign. # noqa: E501
To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501
:return: The to_field of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._to_field
@to_field.setter
def to_field(self, to_field):
"""Sets the to_field of this UpdateEmailCampaign.
To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501
:param to_field: The to_field of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._to_field = to_field
@property
def recipients(self):
"""Gets the recipients of this UpdateEmailCampaign. # noqa: E501
:return: The recipients of this UpdateEmailCampaign. # noqa: E501
:rtype: UpdateEmailCampaignRecipients
"""
return self._recipients
@recipients.setter
def recipients(self, recipients):
"""Sets the recipients of this UpdateEmailCampaign.
:param recipients: The recipients of this UpdateEmailCampaign. # noqa: E501
:type: UpdateEmailCampaignRecipients
"""
self._recipients = recipients
@property
def attachment_url(self):
"""Gets the attachment_url of this UpdateEmailCampaign. # noqa: E501
Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps # noqa: E501
:return: The attachment_url of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._attachment_url
@attachment_url.setter
def attachment_url(self, attachment_url):
"""Sets the attachment_url of this UpdateEmailCampaign.
Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps # noqa: E501
:param attachment_url: The attachment_url of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._attachment_url = attachment_url
@property
def inline_image_activation(self):
"""Gets the inline_image_activation of this UpdateEmailCampaign. # noqa: E501
Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. # noqa: E501
:return: The inline_image_activation of this UpdateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._inline_image_activation
@inline_image_activation.setter
def inline_image_activation(self, inline_image_activation):
"""Sets the inline_image_activation of this UpdateEmailCampaign.
Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. # noqa: E501
:param inline_image_activation: The inline_image_activation of this UpdateEmailCampaign. # noqa: E501
:type: bool
"""
self._inline_image_activation = inline_image_activation
@property
def mirror_active(self):
"""Gets the mirror_active of this UpdateEmailCampaign. # noqa: E501
Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign # noqa: E501
:return: The mirror_active of this UpdateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._mirror_active
@mirror_active.setter
def mirror_active(self, mirror_active):
"""Sets the mirror_active of this UpdateEmailCampaign.
Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign # noqa: E501
:param mirror_active: The mirror_active of this UpdateEmailCampaign. # noqa: E501
:type: bool
"""
self._mirror_active = mirror_active
@property
def recurring(self):
"""Gets the recurring of this UpdateEmailCampaign. # noqa: E501
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 # noqa: E501
:return: The recurring of this UpdateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._recurring
@recurring.setter
def recurring(self, recurring):
"""Sets the recurring of this UpdateEmailCampaign.
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 # noqa: E501
:param recurring: The recurring of this UpdateEmailCampaign. # noqa: E501
:type: bool
"""
self._recurring = recurring
@property
def footer(self):
"""Gets the footer of this UpdateEmailCampaign. # noqa: E501
Footer of the email campaign # noqa: E501
:return: The footer of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._footer
@footer.setter
def footer(self, footer):
"""Sets the footer of this UpdateEmailCampaign.
Footer of the email campaign # noqa: E501
:param footer: The footer of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._footer = footer
@property
def header(self):
"""Gets the header of this UpdateEmailCampaign. # noqa: E501
Header of the email campaign # noqa: E501
:return: The header of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._header
@header.setter
def header(self, header):
"""Sets the header of this UpdateEmailCampaign.
Header of the email campaign # noqa: E501
:param header: The header of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._header = header
@property
def utm_campaign(self):
"""Gets the utm_campaign of this UpdateEmailCampaign. # noqa: E501
Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed # noqa: E501
:return: The utm_campaign of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._utm_campaign
@utm_campaign.setter
def utm_campaign(self, utm_campaign):
"""Sets the utm_campaign of this UpdateEmailCampaign.
Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed # noqa: E501
:param utm_campaign: The utm_campaign of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._utm_campaign = utm_campaign
@property
def params(self):
"""Gets the params of this UpdateEmailCampaign. # noqa: E501
Pass the set of attributes to customize the type 'classic' campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501
:return: The params of this UpdateEmailCampaign. # noqa: E501
:rtype: object
"""
return self._params
@params.setter
def params(self, params):
"""Sets the params of this UpdateEmailCampaign.
Pass the set of attributes to customize the type 'classic' campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501
:param params: The params of this UpdateEmailCampaign. # noqa: E501
:type: object
"""
self._params = params
@property
def send_at_best_time(self):
"""Gets the send_at_best_time of this UpdateEmailCampaign. # noqa: E501
Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. # noqa: E501
:return: The send_at_best_time of this UpdateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._send_at_best_time
@send_at_best_time.setter
def send_at_best_time(self, send_at_best_time):
"""Sets the send_at_best_time of this UpdateEmailCampaign.
Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. # noqa: E501
:param send_at_best_time: The send_at_best_time of this UpdateEmailCampaign. # noqa: E501
:type: bool
"""
self._send_at_best_time = send_at_best_time
@property
def ab_testing(self):
"""Gets the ab_testing of this UpdateEmailCampaign. # noqa: E501
Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B # noqa: E501
:return: The ab_testing of this UpdateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._ab_testing
@ab_testing.setter
def ab_testing(self, ab_testing):
"""Sets the ab_testing of this UpdateEmailCampaign.
Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B # noqa: E501
:param ab_testing: The ab_testing of this UpdateEmailCampaign. # noqa: E501
:type: bool
"""
self._ab_testing = ab_testing
@property
def subject_a(self):
"""Gets the subject_a of this UpdateEmailCampaign. # noqa: E501
Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value # noqa: E501
:return: The subject_a of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._subject_a
@subject_a.setter
def subject_a(self, subject_a):
"""Sets the subject_a of this UpdateEmailCampaign.
Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value # noqa: E501
:param subject_a: The subject_a of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._subject_a = subject_a
@property
def subject_b(self):
"""Gets the subject_b of this UpdateEmailCampaign. # noqa: E501
Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value # noqa: E501
:return: The subject_b of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._subject_b
@subject_b.setter
def subject_b(self, subject_b):
"""Sets the subject_b of this UpdateEmailCampaign.
Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value # noqa: E501
:param subject_b: The subject_b of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._subject_b = subject_b
@property
def split_rule(self):
"""Gets the split_rule of this UpdateEmailCampaign. # noqa: E501
Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else # noqa: E501
:return: The split_rule of this UpdateEmailCampaign. # noqa: E501
:rtype: int
"""
return self._split_rule
@split_rule.setter
def split_rule(self, split_rule):
"""Sets the split_rule of this UpdateEmailCampaign.
Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else # noqa: E501
:param split_rule: The split_rule of this UpdateEmailCampaign. # noqa: E501
:type: int
"""
if split_rule is not None and split_rule > 50: # noqa: E501
raise ValueError("Invalid value for `split_rule`, must be a value less than or equal to `50`") # noqa: E501
if split_rule is not None and split_rule < 1: # noqa: E501
raise ValueError("Invalid value for `split_rule`, must be a value greater than or equal to `1`") # noqa: E501
self._split_rule = split_rule
@property
def winner_criteria(self):
"""Gets the winner_criteria of this UpdateEmailCampaign. # noqa: E501
Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record # noqa: E501
:return: The winner_criteria of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._winner_criteria
@winner_criteria.setter
def winner_criteria(self, winner_criteria):
"""Sets the winner_criteria of this UpdateEmailCampaign.
Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record # noqa: E501
:param winner_criteria: The winner_criteria of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
allowed_values = ["open", "click"] # noqa: E501
if winner_criteria not in allowed_values:
raise ValueError(
"Invalid value for `winner_criteria` ({0}), must be one of {1}" # noqa: E501
.format(winner_criteria, allowed_values)
)
self._winner_criteria = winner_criteria
@property
def winner_delay(self):
"""Gets the winner_delay of this UpdateEmailCampaign. # noqa: E501
Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record # noqa: E501
:return: The winner_delay of this UpdateEmailCampaign. # noqa: E501
:rtype: int
"""
return self._winner_delay
@winner_delay.setter
def winner_delay(self, winner_delay):
"""Sets the winner_delay of this UpdateEmailCampaign.
Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record # noqa: E501
:param winner_delay: The winner_delay of this UpdateEmailCampaign. # noqa: E501
:type: int
"""
if winner_delay is not None and winner_delay > 168: # noqa: E501
raise ValueError("Invalid value for `winner_delay`, must be a value less than or equal to `168`") # noqa: E501
if winner_delay is not None and winner_delay < 1: # noqa: E501
raise ValueError("Invalid value for `winner_delay`, must be a value greater than or equal to `1`") # noqa: E501
self._winner_delay = winner_delay
@property
def ip_warmup_enable(self):
"""Gets the ip_warmup_enable of this UpdateEmailCampaign. # noqa: E501
Available for dedicated ip clients. Set this to true if you wish to warm up your ip. # noqa: E501
:return: The ip_warmup_enable of this UpdateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._ip_warmup_enable
@ip_warmup_enable.setter
def ip_warmup_enable(self, ip_warmup_enable):
"""Sets the ip_warmup_enable of this UpdateEmailCampaign.
Available for dedicated ip clients. Set this to true if you wish to warm up your ip. # noqa: E501
:param ip_warmup_enable: The ip_warmup_enable of this UpdateEmailCampaign. # noqa: E501
:type: bool
"""
self._ip_warmup_enable = ip_warmup_enable
@property
def initial_quota(self):
"""Gets the initial_quota of this UpdateEmailCampaign. # noqa: E501
Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. # noqa: E501
:return: The initial_quota of this UpdateEmailCampaign. # noqa: E501
:rtype: int
"""
return self._initial_quota
@initial_quota.setter
def initial_quota(self, initial_quota):
"""Sets the initial_quota of this UpdateEmailCampaign.
Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. # noqa: E501
:param initial_quota: The initial_quota of this UpdateEmailCampaign. # noqa: E501
:type: int
"""
self._initial_quota = initial_quota
@property
def increase_rate(self):
"""Gets the increase_rate of this UpdateEmailCampaign. # noqa: E501
Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. # noqa: E501
:return: The increase_rate of this UpdateEmailCampaign. # noqa: E501
:rtype: int
"""
return self._increase_rate
@increase_rate.setter
def increase_rate(self, increase_rate):
"""Sets the increase_rate of this UpdateEmailCampaign.
Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. # noqa: E501
:param increase_rate: The increase_rate of this UpdateEmailCampaign. # noqa: E501
:type: int
"""
if increase_rate is not None and increase_rate > 100: # noqa: E501
raise ValueError("Invalid value for `increase_rate`, must be a value less than or equal to `100`") # noqa: E501
if increase_rate is not None and increase_rate < 0: # noqa: E501
raise ValueError("Invalid value for `increase_rate`, must be a value greater than or equal to `0`") # noqa: E501
self._increase_rate = increase_rate
@property
def unsubscription_page_id(self):
"""Gets the unsubscription_page_id of this UpdateEmailCampaign. # noqa: E501
Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. # noqa: E501
:return: The unsubscription_page_id of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._unsubscription_page_id
@unsubscription_page_id.setter
def unsubscription_page_id(self, unsubscription_page_id):
"""Sets the unsubscription_page_id of this UpdateEmailCampaign.
Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. # noqa: E501
:param unsubscription_page_id: The unsubscription_page_id of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._unsubscription_page_id = unsubscription_page_id
@property
def update_form_id(self):
"""Gets the update_form_id of this UpdateEmailCampaign. # noqa: E501
Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. # noqa: E501
:return: The update_form_id of this UpdateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._update_form_id
@update_form_id.setter
def update_form_id(self, update_form_id):
"""Sets the update_form_id of this UpdateEmailCampaign.
Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. # noqa: E501
:param update_form_id: The update_form_id of this UpdateEmailCampaign. # noqa: E501
:type: str
"""
self._update_form_id = update_form_id
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateEmailCampaign, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateEmailCampaign):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(tag=None, sender=None, name=None, html_content=None, html_url=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, recurring=False, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=None, ab_testing=False, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, ip_warmup_enable=False, initial_quota=None, increase_rate=None, unsubscription_page_id=None, update_form_id=None)
|
60,354 |
sib_api_v3_sdk.models.update_email_campaign
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateEmailCampaign):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,355 |
sib_api_v3_sdk.models.update_email_campaign
|
__init__
|
UpdateEmailCampaign - a model defined in Swagger
|
def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, recurring=False, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=None, ab_testing=False, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, ip_warmup_enable=False, initial_quota=None, increase_rate=None, unsubscription_page_id=None, update_form_id=None): # noqa: E501
"""UpdateEmailCampaign - a model defined in Swagger""" # noqa: E501
self._tag = None
self._sender = None
self._name = None
self._html_content = None
self._html_url = None
self._scheduled_at = None
self._subject = None
self._reply_to = None
self._to_field = None
self._recipients = None
self._attachment_url = None
self._inline_image_activation = None
self._mirror_active = None
self._recurring = None
self._footer = None
self._header = None
self._utm_campaign = None
self._params = None
self._send_at_best_time = None
self._ab_testing = None
self._subject_a = None
self._subject_b = None
self._split_rule = None
self._winner_criteria = None
self._winner_delay = None
self._ip_warmup_enable = None
self._initial_quota = None
self._increase_rate = None
self._unsubscription_page_id = None
self._update_form_id = None
self.discriminator = None
if tag is not None:
self.tag = tag
if sender is not None:
self.sender = sender
if name is not None:
self.name = name
if html_content is not None:
self.html_content = html_content
if html_url is not None:
self.html_url = html_url
if scheduled_at is not None:
self.scheduled_at = scheduled_at
if subject is not None:
self.subject = subject
if reply_to is not None:
self.reply_to = reply_to
if to_field is not None:
self.to_field = to_field
if recipients is not None:
self.recipients = recipients
if attachment_url is not None:
self.attachment_url = attachment_url
if inline_image_activation is not None:
self.inline_image_activation = inline_image_activation
if mirror_active is not None:
self.mirror_active = mirror_active
if recurring is not None:
self.recurring = recurring
if footer is not None:
self.footer = footer
if header is not None:
self.header = header
if utm_campaign is not None:
self.utm_campaign = utm_campaign
if params is not None:
self.params = params
if send_at_best_time is not None:
self.send_at_best_time = send_at_best_time
if ab_testing is not None:
self.ab_testing = ab_testing
if subject_a is not None:
self.subject_a = subject_a
if subject_b is not None:
self.subject_b = subject_b
if split_rule is not None:
self.split_rule = split_rule
if winner_criteria is not None:
self.winner_criteria = winner_criteria
if winner_delay is not None:
self.winner_delay = winner_delay
if ip_warmup_enable is not None:
self.ip_warmup_enable = ip_warmup_enable
if initial_quota is not None:
self.initial_quota = initial_quota
if increase_rate is not None:
self.increase_rate = increase_rate
if unsubscription_page_id is not None:
self.unsubscription_page_id = unsubscription_page_id
if update_form_id is not None:
self.update_form_id = update_form_id
|
(self, tag=None, sender=None, name=None, html_content=None, html_url=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, recurring=False, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=None, ab_testing=False, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, ip_warmup_enable=False, initial_quota=None, increase_rate=None, unsubscription_page_id=None, update_form_id=None)
|
60,358 |
sib_api_v3_sdk.models.update_email_campaign
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateEmailCampaign, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,360 |
sib_api_v3_sdk.models.update_email_campaign_recipients
|
UpdateEmailCampaignRecipients
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateEmailCampaignRecipients(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'exclusion_list_ids': 'list[int]',
'list_ids': 'list[int]',
'segment_ids': 'list[int]'
}
attribute_map = {
'exclusion_list_ids': 'exclusionListIds',
'list_ids': 'listIds',
'segment_ids': 'segmentIds'
}
def __init__(self, exclusion_list_ids=None, list_ids=None, segment_ids=None): # noqa: E501
"""UpdateEmailCampaignRecipients - a model defined in Swagger""" # noqa: E501
self._exclusion_list_ids = None
self._list_ids = None
self._segment_ids = None
self.discriminator = None
if exclusion_list_ids is not None:
self.exclusion_list_ids = exclusion_list_ids
if list_ids is not None:
self.list_ids = list_ids
if segment_ids is not None:
self.segment_ids = segment_ids
@property
def exclusion_list_ids(self):
"""Gets the exclusion_list_ids of this UpdateEmailCampaignRecipients. # noqa: E501
List ids which have to be excluded from a campaign # noqa: E501
:return: The exclusion_list_ids of this UpdateEmailCampaignRecipients. # noqa: E501
:rtype: list[int]
"""
return self._exclusion_list_ids
@exclusion_list_ids.setter
def exclusion_list_ids(self, exclusion_list_ids):
"""Sets the exclusion_list_ids of this UpdateEmailCampaignRecipients.
List ids which have to be excluded from a campaign # noqa: E501
:param exclusion_list_ids: The exclusion_list_ids of this UpdateEmailCampaignRecipients. # noqa: E501
:type: list[int]
"""
self._exclusion_list_ids = exclusion_list_ids
@property
def list_ids(self):
"""Gets the list_ids of this UpdateEmailCampaignRecipients. # noqa: E501
Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty # noqa: E501
:return: The list_ids of this UpdateEmailCampaignRecipients. # noqa: E501
:rtype: list[int]
"""
return self._list_ids
@list_ids.setter
def list_ids(self, list_ids):
"""Sets the list_ids of this UpdateEmailCampaignRecipients.
Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty # noqa: E501
:param list_ids: The list_ids of this UpdateEmailCampaignRecipients. # noqa: E501
:type: list[int]
"""
self._list_ids = list_ids
@property
def segment_ids(self):
"""Gets the segment_ids of this UpdateEmailCampaignRecipients. # noqa: E501
Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to. # noqa: E501
:return: The segment_ids of this UpdateEmailCampaignRecipients. # noqa: E501
:rtype: list[int]
"""
return self._segment_ids
@segment_ids.setter
def segment_ids(self, segment_ids):
"""Sets the segment_ids of this UpdateEmailCampaignRecipients.
Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to. # noqa: E501
:param segment_ids: The segment_ids of this UpdateEmailCampaignRecipients. # noqa: E501
:type: list[int]
"""
self._segment_ids = segment_ids
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateEmailCampaignRecipients, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateEmailCampaignRecipients):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(exclusion_list_ids=None, list_ids=None, segment_ids=None)
|
60,361 |
sib_api_v3_sdk.models.update_email_campaign_recipients
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateEmailCampaignRecipients):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,362 |
sib_api_v3_sdk.models.update_email_campaign_recipients
|
__init__
|
UpdateEmailCampaignRecipients - a model defined in Swagger
|
def __init__(self, exclusion_list_ids=None, list_ids=None, segment_ids=None): # noqa: E501
"""UpdateEmailCampaignRecipients - a model defined in Swagger""" # noqa: E501
self._exclusion_list_ids = None
self._list_ids = None
self._segment_ids = None
self.discriminator = None
if exclusion_list_ids is not None:
self.exclusion_list_ids = exclusion_list_ids
if list_ids is not None:
self.list_ids = list_ids
if segment_ids is not None:
self.segment_ids = segment_ids
|
(self, exclusion_list_ids=None, list_ids=None, segment_ids=None)
|
60,365 |
sib_api_v3_sdk.models.update_email_campaign_recipients
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateEmailCampaignRecipients, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,367 |
sib_api_v3_sdk.models.update_email_campaign_sender
|
UpdateEmailCampaignSender
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateEmailCampaignSender(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'name': 'str',
'email': 'str',
'id': 'int'
}
attribute_map = {
'name': 'name',
'email': 'email',
'id': 'id'
}
def __init__(self, name=None, email=None, id=None): # noqa: E501
"""UpdateEmailCampaignSender - a model defined in Swagger""" # noqa: E501
self._name = None
self._email = None
self._id = None
self.discriminator = None
if name is not None:
self.name = name
if email is not None:
self.email = email
if id is not None:
self.id = id
@property
def name(self):
"""Gets the name of this UpdateEmailCampaignSender. # noqa: E501
Sender Name from which the campaign emails are sent # noqa: E501
:return: The name of this UpdateEmailCampaignSender. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this UpdateEmailCampaignSender.
Sender Name from which the campaign emails are sent # noqa: E501
:param name: The name of this UpdateEmailCampaignSender. # noqa: E501
:type: str
"""
self._name = name
@property
def email(self):
"""Gets the email of this UpdateEmailCampaignSender. # noqa: E501
Sender email from which the campaign emails are sent # noqa: E501
:return: The email of this UpdateEmailCampaignSender. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this UpdateEmailCampaignSender.
Sender email from which the campaign emails are sent # noqa: E501
:param email: The email of this UpdateEmailCampaignSender. # noqa: E501
:type: str
"""
self._email = email
@property
def id(self):
"""Gets the id of this UpdateEmailCampaignSender. # noqa: E501
Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). # noqa: E501
:return: The id of this UpdateEmailCampaignSender. # noqa: E501
:rtype: int
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this UpdateEmailCampaignSender.
Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). # noqa: E501
:param id: The id of this UpdateEmailCampaignSender. # noqa: E501
:type: int
"""
self._id = id
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateEmailCampaignSender, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateEmailCampaignSender):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(name=None, email=None, id=None)
|
60,368 |
sib_api_v3_sdk.models.update_email_campaign_sender
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateEmailCampaignSender):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,369 |
sib_api_v3_sdk.models.update_email_campaign_sender
|
__init__
|
UpdateEmailCampaignSender - a model defined in Swagger
|
def __init__(self, name=None, email=None, id=None): # noqa: E501
"""UpdateEmailCampaignSender - a model defined in Swagger""" # noqa: E501
self._name = None
self._email = None
self._id = None
self.discriminator = None
if name is not None:
self.name = name
if email is not None:
self.email = email
if id is not None:
self.id = id
|
(self, name=None, email=None, id=None)
|
60,372 |
sib_api_v3_sdk.models.update_email_campaign_sender
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateEmailCampaignSender, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,374 |
sib_api_v3_sdk.models.update_external_feed
|
UpdateExternalFeed
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateExternalFeed(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'name': 'str',
'url': 'str',
'auth_type': 'str',
'username': 'str',
'password': 'str',
'token': 'str',
'headers': 'list[GetExternalFeedByUUIDHeaders]',
'max_retries': 'int',
'cache': 'bool'
}
attribute_map = {
'name': 'name',
'url': 'url',
'auth_type': 'authType',
'username': 'username',
'password': 'password',
'token': 'token',
'headers': 'headers',
'max_retries': 'maxRetries',
'cache': 'cache'
}
def __init__(self, name=None, url=None, auth_type=None, username=None, password=None, token=None, headers=None, max_retries=None, cache=False): # noqa: E501
"""UpdateExternalFeed - a model defined in Swagger""" # noqa: E501
self._name = None
self._url = None
self._auth_type = None
self._username = None
self._password = None
self._token = None
self._headers = None
self._max_retries = None
self._cache = None
self.discriminator = None
if name is not None:
self.name = name
if url is not None:
self.url = url
if auth_type is not None:
self.auth_type = auth_type
if username is not None:
self.username = username
if password is not None:
self.password = password
if token is not None:
self.token = token
if headers is not None:
self.headers = headers
if max_retries is not None:
self.max_retries = max_retries
if cache is not None:
self.cache = cache
@property
def name(self):
"""Gets the name of this UpdateExternalFeed. # noqa: E501
Name of the feed # noqa: E501
:return: The name of this UpdateExternalFeed. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this UpdateExternalFeed.
Name of the feed # noqa: E501
:param name: The name of this UpdateExternalFeed. # noqa: E501
:type: str
"""
self._name = name
@property
def url(self):
"""Gets the url of this UpdateExternalFeed. # noqa: E501
URL of the feed # noqa: E501
:return: The url of this UpdateExternalFeed. # noqa: E501
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""Sets the url of this UpdateExternalFeed.
URL of the feed # noqa: E501
:param url: The url of this UpdateExternalFeed. # noqa: E501
:type: str
"""
self._url = url
@property
def auth_type(self):
"""Gets the auth_type of this UpdateExternalFeed. # noqa: E501
Auth type of the feed: * `basic` * `token` * `noAuth` # noqa: E501
:return: The auth_type of this UpdateExternalFeed. # noqa: E501
:rtype: str
"""
return self._auth_type
@auth_type.setter
def auth_type(self, auth_type):
"""Sets the auth_type of this UpdateExternalFeed.
Auth type of the feed: * `basic` * `token` * `noAuth` # noqa: E501
:param auth_type: The auth_type of this UpdateExternalFeed. # noqa: E501
:type: str
"""
allowed_values = ["basic", "token", "noAuth"] # noqa: E501
if auth_type not in allowed_values:
raise ValueError(
"Invalid value for `auth_type` ({0}), must be one of {1}" # noqa: E501
.format(auth_type, allowed_values)
)
self._auth_type = auth_type
@property
def username(self):
"""Gets the username of this UpdateExternalFeed. # noqa: E501
Username for authType `basic` # noqa: E501
:return: The username of this UpdateExternalFeed. # noqa: E501
:rtype: str
"""
return self._username
@username.setter
def username(self, username):
"""Sets the username of this UpdateExternalFeed.
Username for authType `basic` # noqa: E501
:param username: The username of this UpdateExternalFeed. # noqa: E501
:type: str
"""
self._username = username
@property
def password(self):
"""Gets the password of this UpdateExternalFeed. # noqa: E501
Password for authType `basic` # noqa: E501
:return: The password of this UpdateExternalFeed. # noqa: E501
:rtype: str
"""
return self._password
@password.setter
def password(self, password):
"""Sets the password of this UpdateExternalFeed.
Password for authType `basic` # noqa: E501
:param password: The password of this UpdateExternalFeed. # noqa: E501
:type: str
"""
self._password = password
@property
def token(self):
"""Gets the token of this UpdateExternalFeed. # noqa: E501
Token for authType `token` # noqa: E501
:return: The token of this UpdateExternalFeed. # noqa: E501
:rtype: str
"""
return self._token
@token.setter
def token(self, token):
"""Sets the token of this UpdateExternalFeed.
Token for authType `token` # noqa: E501
:param token: The token of this UpdateExternalFeed. # noqa: E501
:type: str
"""
self._token = token
@property
def headers(self):
"""Gets the headers of this UpdateExternalFeed. # noqa: E501
Custom headers for the feed # noqa: E501
:return: The headers of this UpdateExternalFeed. # noqa: E501
:rtype: list[GetExternalFeedByUUIDHeaders]
"""
return self._headers
@headers.setter
def headers(self, headers):
"""Sets the headers of this UpdateExternalFeed.
Custom headers for the feed # noqa: E501
:param headers: The headers of this UpdateExternalFeed. # noqa: E501
:type: list[GetExternalFeedByUUIDHeaders]
"""
self._headers = headers
@property
def max_retries(self):
"""Gets the max_retries of this UpdateExternalFeed. # noqa: E501
Maximum number of retries on the feed url # noqa: E501
:return: The max_retries of this UpdateExternalFeed. # noqa: E501
:rtype: int
"""
return self._max_retries
@max_retries.setter
def max_retries(self, max_retries):
"""Sets the max_retries of this UpdateExternalFeed.
Maximum number of retries on the feed url # noqa: E501
:param max_retries: The max_retries of this UpdateExternalFeed. # noqa: E501
:type: int
"""
if max_retries is not None and max_retries > 5: # noqa: E501
raise ValueError("Invalid value for `max_retries`, must be a value less than or equal to `5`") # noqa: E501
if max_retries is not None and max_retries < 0: # noqa: E501
raise ValueError("Invalid value for `max_retries`, must be a value greater than or equal to `0`") # noqa: E501
self._max_retries = max_retries
@property
def cache(self):
"""Gets the cache of this UpdateExternalFeed. # noqa: E501
Toggle caching of feed url response # noqa: E501
:return: The cache of this UpdateExternalFeed. # noqa: E501
:rtype: bool
"""
return self._cache
@cache.setter
def cache(self, cache):
"""Sets the cache of this UpdateExternalFeed.
Toggle caching of feed url response # noqa: E501
:param cache: The cache of this UpdateExternalFeed. # noqa: E501
:type: bool
"""
self._cache = cache
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateExternalFeed, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateExternalFeed):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(name=None, url=None, auth_type=None, username=None, password=None, token=None, headers=None, max_retries=None, cache=False)
|
60,375 |
sib_api_v3_sdk.models.update_external_feed
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateExternalFeed):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,376 |
sib_api_v3_sdk.models.update_external_feed
|
__init__
|
UpdateExternalFeed - a model defined in Swagger
|
def __init__(self, name=None, url=None, auth_type=None, username=None, password=None, token=None, headers=None, max_retries=None, cache=False): # noqa: E501
"""UpdateExternalFeed - a model defined in Swagger""" # noqa: E501
self._name = None
self._url = None
self._auth_type = None
self._username = None
self._password = None
self._token = None
self._headers = None
self._max_retries = None
self._cache = None
self.discriminator = None
if name is not None:
self.name = name
if url is not None:
self.url = url
if auth_type is not None:
self.auth_type = auth_type
if username is not None:
self.username = username
if password is not None:
self.password = password
if token is not None:
self.token = token
if headers is not None:
self.headers = headers
if max_retries is not None:
self.max_retries = max_retries
if cache is not None:
self.cache = cache
|
(self, name=None, url=None, auth_type=None, username=None, password=None, token=None, headers=None, max_retries=None, cache=False)
|
60,379 |
sib_api_v3_sdk.models.update_external_feed
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateExternalFeed, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,381 |
sib_api_v3_sdk.models.update_list
|
UpdateList
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateList(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'name': 'str',
'folder_id': 'int'
}
attribute_map = {
'name': 'name',
'folder_id': 'folderId'
}
def __init__(self, name=None, folder_id=None): # noqa: E501
"""UpdateList - a model defined in Swagger""" # noqa: E501
self._name = None
self._folder_id = None
self.discriminator = None
if name is not None:
self.name = name
if folder_id is not None:
self.folder_id = folder_id
@property
def name(self):
"""Gets the name of this UpdateList. # noqa: E501
Name of the list. Either of the two parameters (name, folderId) can be updated at a time. # noqa: E501
:return: The name of this UpdateList. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this UpdateList.
Name of the list. Either of the two parameters (name, folderId) can be updated at a time. # noqa: E501
:param name: The name of this UpdateList. # noqa: E501
:type: str
"""
self._name = name
@property
def folder_id(self):
"""Gets the folder_id of this UpdateList. # noqa: E501
Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time. # noqa: E501
:return: The folder_id of this UpdateList. # noqa: E501
:rtype: int
"""
return self._folder_id
@folder_id.setter
def folder_id(self, folder_id):
"""Sets the folder_id of this UpdateList.
Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time. # noqa: E501
:param folder_id: The folder_id of this UpdateList. # noqa: E501
:type: int
"""
self._folder_id = folder_id
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateList, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateList):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(name=None, folder_id=None)
|
60,382 |
sib_api_v3_sdk.models.update_list
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateList):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,383 |
sib_api_v3_sdk.models.update_list
|
__init__
|
UpdateList - a model defined in Swagger
|
def __init__(self, name=None, folder_id=None): # noqa: E501
"""UpdateList - a model defined in Swagger""" # noqa: E501
self._name = None
self._folder_id = None
self.discriminator = None
if name is not None:
self.name = name
if folder_id is not None:
self.folder_id = folder_id
|
(self, name=None, folder_id=None)
|
60,386 |
sib_api_v3_sdk.models.update_list
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateList, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,388 |
sib_api_v3_sdk.models.update_sender
|
UpdateSender
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateSender(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'name': 'str',
'email': 'str',
'ips': 'list[CreateSenderIps]'
}
attribute_map = {
'name': 'name',
'email': 'email',
'ips': 'ips'
}
def __init__(self, name=None, email=None, ips=None): # noqa: E501
"""UpdateSender - a model defined in Swagger""" # noqa: E501
self._name = None
self._email = None
self._ips = None
self.discriminator = None
if name is not None:
self.name = name
if email is not None:
self.email = email
if ips is not None:
self.ips = ips
@property
def name(self):
"""Gets the name of this UpdateSender. # noqa: E501
From Name to update the sender # noqa: E501
:return: The name of this UpdateSender. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this UpdateSender.
From Name to update the sender # noqa: E501
:param name: The name of this UpdateSender. # noqa: E501
:type: str
"""
self._name = name
@property
def email(self):
"""Gets the email of this UpdateSender. # noqa: E501
From Email to update the sender # noqa: E501
:return: The email of this UpdateSender. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this UpdateSender.
From Email to update the sender # noqa: E501
:param email: The email of this UpdateSender. # noqa: E501
:type: str
"""
self._email = email
@property
def ips(self):
"""Gets the ips of this UpdateSender. # noqa: E501
Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs. # noqa: E501
:return: The ips of this UpdateSender. # noqa: E501
:rtype: list[CreateSenderIps]
"""
return self._ips
@ips.setter
def ips(self, ips):
"""Sets the ips of this UpdateSender.
Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs. # noqa: E501
:param ips: The ips of this UpdateSender. # noqa: E501
:type: list[CreateSenderIps]
"""
self._ips = ips
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateSender, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateSender):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(name=None, email=None, ips=None)
|
60,389 |
sib_api_v3_sdk.models.update_sender
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateSender):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,390 |
sib_api_v3_sdk.models.update_sender
|
__init__
|
UpdateSender - a model defined in Swagger
|
def __init__(self, name=None, email=None, ips=None): # noqa: E501
"""UpdateSender - a model defined in Swagger""" # noqa: E501
self._name = None
self._email = None
self._ips = None
self.discriminator = None
if name is not None:
self.name = name
if email is not None:
self.email = email
if ips is not None:
self.ips = ips
|
(self, name=None, email=None, ips=None)
|
60,393 |
sib_api_v3_sdk.models.update_sender
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateSender, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,395 |
sib_api_v3_sdk.models.update_sms_campaign
|
UpdateSmsCampaign
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateSmsCampaign(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'name': 'str',
'sender': 'str',
'content': 'str',
'recipients': 'CreateSmsCampaignRecipients',
'scheduled_at': 'str',
'unicode_enabled': 'bool',
'organisation_prefix': 'str',
'unsubscribe_instruction': 'str'
}
attribute_map = {
'name': 'name',
'sender': 'sender',
'content': 'content',
'recipients': 'recipients',
'scheduled_at': 'scheduledAt',
'unicode_enabled': 'unicodeEnabled',
'organisation_prefix': 'organisationPrefix',
'unsubscribe_instruction': 'unsubscribeInstruction'
}
def __init__(self, name=None, sender=None, content=None, recipients=None, scheduled_at=None, unicode_enabled=False, organisation_prefix=None, unsubscribe_instruction=None): # noqa: E501
"""UpdateSmsCampaign - a model defined in Swagger""" # noqa: E501
self._name = None
self._sender = None
self._content = None
self._recipients = None
self._scheduled_at = None
self._unicode_enabled = None
self._organisation_prefix = None
self._unsubscribe_instruction = None
self.discriminator = None
if name is not None:
self.name = name
if sender is not None:
self.sender = sender
if content is not None:
self.content = content
if recipients is not None:
self.recipients = recipients
if scheduled_at is not None:
self.scheduled_at = scheduled_at
if unicode_enabled is not None:
self.unicode_enabled = unicode_enabled
if organisation_prefix is not None:
self.organisation_prefix = organisation_prefix
if unsubscribe_instruction is not None:
self.unsubscribe_instruction = unsubscribe_instruction
@property
def name(self):
"""Gets the name of this UpdateSmsCampaign. # noqa: E501
Name of the campaign # noqa: E501
:return: The name of this UpdateSmsCampaign. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this UpdateSmsCampaign.
Name of the campaign # noqa: E501
:param name: The name of this UpdateSmsCampaign. # noqa: E501
:type: str
"""
self._name = name
@property
def sender(self):
"""Gets the sender of this UpdateSmsCampaign. # noqa: E501
Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** # noqa: E501
:return: The sender of this UpdateSmsCampaign. # noqa: E501
:rtype: str
"""
return self._sender
@sender.setter
def sender(self, sender):
"""Sets the sender of this UpdateSmsCampaign.
Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** # noqa: E501
:param sender: The sender of this UpdateSmsCampaign. # noqa: E501
:type: str
"""
if sender is not None and len(sender) > 15:
raise ValueError("Invalid value for `sender`, length must be less than or equal to `15`") # noqa: E501
self._sender = sender
@property
def content(self):
"""Gets the content of this UpdateSmsCampaign. # noqa: E501
Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS # noqa: E501
:return: The content of this UpdateSmsCampaign. # noqa: E501
:rtype: str
"""
return self._content
@content.setter
def content(self, content):
"""Sets the content of this UpdateSmsCampaign.
Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS # noqa: E501
:param content: The content of this UpdateSmsCampaign. # noqa: E501
:type: str
"""
self._content = content
@property
def recipients(self):
"""Gets the recipients of this UpdateSmsCampaign. # noqa: E501
:return: The recipients of this UpdateSmsCampaign. # noqa: E501
:rtype: CreateSmsCampaignRecipients
"""
return self._recipients
@recipients.setter
def recipients(self, recipients):
"""Sets the recipients of this UpdateSmsCampaign.
:param recipients: The recipients of this UpdateSmsCampaign. # noqa: E501
:type: CreateSmsCampaignRecipients
"""
self._recipients = recipients
@property
def scheduled_at(self):
"""Gets the scheduled_at of this UpdateSmsCampaign. # noqa: E501
UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. # noqa: E501
:return: The scheduled_at of this UpdateSmsCampaign. # noqa: E501
:rtype: str
"""
return self._scheduled_at
@scheduled_at.setter
def scheduled_at(self, scheduled_at):
"""Sets the scheduled_at of this UpdateSmsCampaign.
UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. # noqa: E501
:param scheduled_at: The scheduled_at of this UpdateSmsCampaign. # noqa: E501
:type: str
"""
self._scheduled_at = scheduled_at
@property
def unicode_enabled(self):
"""Gets the unicode_enabled of this UpdateSmsCampaign. # noqa: E501
Format of the message. It indicates whether the content should be treated as unicode or not. # noqa: E501
:return: The unicode_enabled of this UpdateSmsCampaign. # noqa: E501
:rtype: bool
"""
return self._unicode_enabled
@unicode_enabled.setter
def unicode_enabled(self, unicode_enabled):
"""Sets the unicode_enabled of this UpdateSmsCampaign.
Format of the message. It indicates whether the content should be treated as unicode or not. # noqa: E501
:param unicode_enabled: The unicode_enabled of this UpdateSmsCampaign. # noqa: E501
:type: bool
"""
self._unicode_enabled = unicode_enabled
@property
def organisation_prefix(self):
"""Gets the organisation_prefix of this UpdateSmsCampaign. # noqa: E501
A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** # noqa: E501
:return: The organisation_prefix of this UpdateSmsCampaign. # noqa: E501
:rtype: str
"""
return self._organisation_prefix
@organisation_prefix.setter
def organisation_prefix(self, organisation_prefix):
"""Sets the organisation_prefix of this UpdateSmsCampaign.
A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** # noqa: E501
:param organisation_prefix: The organisation_prefix of this UpdateSmsCampaign. # noqa: E501
:type: str
"""
self._organisation_prefix = organisation_prefix
@property
def unsubscribe_instruction(self):
"""Gets the unsubscribe_instruction of this UpdateSmsCampaign. # noqa: E501
Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** # noqa: E501
:return: The unsubscribe_instruction of this UpdateSmsCampaign. # noqa: E501
:rtype: str
"""
return self._unsubscribe_instruction
@unsubscribe_instruction.setter
def unsubscribe_instruction(self, unsubscribe_instruction):
"""Sets the unsubscribe_instruction of this UpdateSmsCampaign.
Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** # noqa: E501
:param unsubscribe_instruction: The unsubscribe_instruction of this UpdateSmsCampaign. # noqa: E501
:type: str
"""
self._unsubscribe_instruction = unsubscribe_instruction
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateSmsCampaign, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateSmsCampaign):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(name=None, sender=None, content=None, recipients=None, scheduled_at=None, unicode_enabled=False, organisation_prefix=None, unsubscribe_instruction=None)
|
60,396 |
sib_api_v3_sdk.models.update_sms_campaign
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateSmsCampaign):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,397 |
sib_api_v3_sdk.models.update_sms_campaign
|
__init__
|
UpdateSmsCampaign - a model defined in Swagger
|
def __init__(self, name=None, sender=None, content=None, recipients=None, scheduled_at=None, unicode_enabled=False, organisation_prefix=None, unsubscribe_instruction=None): # noqa: E501
"""UpdateSmsCampaign - a model defined in Swagger""" # noqa: E501
self._name = None
self._sender = None
self._content = None
self._recipients = None
self._scheduled_at = None
self._unicode_enabled = None
self._organisation_prefix = None
self._unsubscribe_instruction = None
self.discriminator = None
if name is not None:
self.name = name
if sender is not None:
self.sender = sender
if content is not None:
self.content = content
if recipients is not None:
self.recipients = recipients
if scheduled_at is not None:
self.scheduled_at = scheduled_at
if unicode_enabled is not None:
self.unicode_enabled = unicode_enabled
if organisation_prefix is not None:
self.organisation_prefix = organisation_prefix
if unsubscribe_instruction is not None:
self.unsubscribe_instruction = unsubscribe_instruction
|
(self, name=None, sender=None, content=None, recipients=None, scheduled_at=None, unicode_enabled=False, organisation_prefix=None, unsubscribe_instruction=None)
|
60,400 |
sib_api_v3_sdk.models.update_sms_campaign
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateSmsCampaign, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,402 |
sib_api_v3_sdk.models.update_smtp_template
|
UpdateSmtpTemplate
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateSmtpTemplate(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'tag': 'str',
'sender': 'UpdateSmtpTemplateSender',
'template_name': 'str',
'html_content': 'str',
'html_url': 'str',
'subject': 'str',
'reply_to': 'str',
'to_field': 'str',
'attachment_url': 'str',
'is_active': 'bool'
}
attribute_map = {
'tag': 'tag',
'sender': 'sender',
'template_name': 'templateName',
'html_content': 'htmlContent',
'html_url': 'htmlUrl',
'subject': 'subject',
'reply_to': 'replyTo',
'to_field': 'toField',
'attachment_url': 'attachmentUrl',
'is_active': 'isActive'
}
def __init__(self, tag=None, sender=None, template_name=None, html_content=None, html_url=None, subject=None, reply_to=None, to_field=None, attachment_url=None, is_active=None): # noqa: E501
"""UpdateSmtpTemplate - a model defined in Swagger""" # noqa: E501
self._tag = None
self._sender = None
self._template_name = None
self._html_content = None
self._html_url = None
self._subject = None
self._reply_to = None
self._to_field = None
self._attachment_url = None
self._is_active = None
self.discriminator = None
if tag is not None:
self.tag = tag
if sender is not None:
self.sender = sender
if template_name is not None:
self.template_name = template_name
if html_content is not None:
self.html_content = html_content
if html_url is not None:
self.html_url = html_url
if subject is not None:
self.subject = subject
if reply_to is not None:
self.reply_to = reply_to
if to_field is not None:
self.to_field = to_field
if attachment_url is not None:
self.attachment_url = attachment_url
if is_active is not None:
self.is_active = is_active
@property
def tag(self):
"""Gets the tag of this UpdateSmtpTemplate. # noqa: E501
Tag of the template # noqa: E501
:return: The tag of this UpdateSmtpTemplate. # noqa: E501
:rtype: str
"""
return self._tag
@tag.setter
def tag(self, tag):
"""Sets the tag of this UpdateSmtpTemplate.
Tag of the template # noqa: E501
:param tag: The tag of this UpdateSmtpTemplate. # noqa: E501
:type: str
"""
self._tag = tag
@property
def sender(self):
"""Gets the sender of this UpdateSmtpTemplate. # noqa: E501
:return: The sender of this UpdateSmtpTemplate. # noqa: E501
:rtype: UpdateSmtpTemplateSender
"""
return self._sender
@sender.setter
def sender(self, sender):
"""Sets the sender of this UpdateSmtpTemplate.
:param sender: The sender of this UpdateSmtpTemplate. # noqa: E501
:type: UpdateSmtpTemplateSender
"""
self._sender = sender
@property
def template_name(self):
"""Gets the template_name of this UpdateSmtpTemplate. # noqa: E501
Name of the template # noqa: E501
:return: The template_name of this UpdateSmtpTemplate. # noqa: E501
:rtype: str
"""
return self._template_name
@template_name.setter
def template_name(self, template_name):
"""Sets the template_name of this UpdateSmtpTemplate.
Name of the template # noqa: E501
:param template_name: The template_name of this UpdateSmtpTemplate. # noqa: E501
:type: str
"""
self._template_name = template_name
@property
def html_content(self):
"""Gets the html_content of this UpdateSmtpTemplate. # noqa: E501
Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) # noqa: E501
:return: The html_content of this UpdateSmtpTemplate. # noqa: E501
:rtype: str
"""
return self._html_content
@html_content.setter
def html_content(self, html_content):
"""Sets the html_content of this UpdateSmtpTemplate.
Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) # noqa: E501
:param html_content: The html_content of this UpdateSmtpTemplate. # noqa: E501
:type: str
"""
self._html_content = html_content
@property
def html_url(self):
"""Gets the html_url of this UpdateSmtpTemplate. # noqa: E501
Required if htmlContent is empty. URL to the body of the email (HTML) # noqa: E501
:return: The html_url of this UpdateSmtpTemplate. # noqa: E501
:rtype: str
"""
return self._html_url
@html_url.setter
def html_url(self, html_url):
"""Sets the html_url of this UpdateSmtpTemplate.
Required if htmlContent is empty. URL to the body of the email (HTML) # noqa: E501
:param html_url: The html_url of this UpdateSmtpTemplate. # noqa: E501
:type: str
"""
self._html_url = html_url
@property
def subject(self):
"""Gets the subject of this UpdateSmtpTemplate. # noqa: E501
Subject of the email # noqa: E501
:return: The subject of this UpdateSmtpTemplate. # noqa: E501
:rtype: str
"""
return self._subject
@subject.setter
def subject(self, subject):
"""Sets the subject of this UpdateSmtpTemplate.
Subject of the email # noqa: E501
:param subject: The subject of this UpdateSmtpTemplate. # noqa: E501
:type: str
"""
self._subject = subject
@property
def reply_to(self):
"""Gets the reply_to of this UpdateSmtpTemplate. # noqa: E501
Email on which campaign recipients will be able to reply to # noqa: E501
:return: The reply_to of this UpdateSmtpTemplate. # noqa: E501
:rtype: str
"""
return self._reply_to
@reply_to.setter
def reply_to(self, reply_to):
"""Sets the reply_to of this UpdateSmtpTemplate.
Email on which campaign recipients will be able to reply to # noqa: E501
:param reply_to: The reply_to of this UpdateSmtpTemplate. # noqa: E501
:type: str
"""
self._reply_to = reply_to
@property
def to_field(self):
"""Gets the to_field of this UpdateSmtpTemplate. # noqa: E501
To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501
:return: The to_field of this UpdateSmtpTemplate. # noqa: E501
:rtype: str
"""
return self._to_field
@to_field.setter
def to_field(self, to_field):
"""Sets the to_field of this UpdateSmtpTemplate.
To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501
:param to_field: The to_field of this UpdateSmtpTemplate. # noqa: E501
:type: str
"""
self._to_field = to_field
@property
def attachment_url(self):
"""Gets the attachment_url of this UpdateSmtpTemplate. # noqa: E501
Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps # noqa: E501
:return: The attachment_url of this UpdateSmtpTemplate. # noqa: E501
:rtype: str
"""
return self._attachment_url
@attachment_url.setter
def attachment_url(self, attachment_url):
"""Sets the attachment_url of this UpdateSmtpTemplate.
Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps # noqa: E501
:param attachment_url: The attachment_url of this UpdateSmtpTemplate. # noqa: E501
:type: str
"""
self._attachment_url = attachment_url
@property
def is_active(self):
"""Gets the is_active of this UpdateSmtpTemplate. # noqa: E501
Status of the template. isActive = false means template is inactive, isActive = true means template is active # noqa: E501
:return: The is_active of this UpdateSmtpTemplate. # noqa: E501
:rtype: bool
"""
return self._is_active
@is_active.setter
def is_active(self, is_active):
"""Sets the is_active of this UpdateSmtpTemplate.
Status of the template. isActive = false means template is inactive, isActive = true means template is active # noqa: E501
:param is_active: The is_active of this UpdateSmtpTemplate. # noqa: E501
:type: bool
"""
self._is_active = is_active
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateSmtpTemplate, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateSmtpTemplate):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(tag=None, sender=None, template_name=None, html_content=None, html_url=None, subject=None, reply_to=None, to_field=None, attachment_url=None, is_active=None)
|
60,403 |
sib_api_v3_sdk.models.update_smtp_template
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateSmtpTemplate):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,404 |
sib_api_v3_sdk.models.update_smtp_template
|
__init__
|
UpdateSmtpTemplate - a model defined in Swagger
|
def __init__(self, tag=None, sender=None, template_name=None, html_content=None, html_url=None, subject=None, reply_to=None, to_field=None, attachment_url=None, is_active=None): # noqa: E501
"""UpdateSmtpTemplate - a model defined in Swagger""" # noqa: E501
self._tag = None
self._sender = None
self._template_name = None
self._html_content = None
self._html_url = None
self._subject = None
self._reply_to = None
self._to_field = None
self._attachment_url = None
self._is_active = None
self.discriminator = None
if tag is not None:
self.tag = tag
if sender is not None:
self.sender = sender
if template_name is not None:
self.template_name = template_name
if html_content is not None:
self.html_content = html_content
if html_url is not None:
self.html_url = html_url
if subject is not None:
self.subject = subject
if reply_to is not None:
self.reply_to = reply_to
if to_field is not None:
self.to_field = to_field
if attachment_url is not None:
self.attachment_url = attachment_url
if is_active is not None:
self.is_active = is_active
|
(self, tag=None, sender=None, template_name=None, html_content=None, html_url=None, subject=None, reply_to=None, to_field=None, attachment_url=None, is_active=None)
|
60,407 |
sib_api_v3_sdk.models.update_smtp_template
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateSmtpTemplate, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,409 |
sib_api_v3_sdk.models.update_smtp_template_sender
|
UpdateSmtpTemplateSender
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateSmtpTemplateSender(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'name': 'str',
'email': 'str',
'id': 'int'
}
attribute_map = {
'name': 'name',
'email': 'email',
'id': 'id'
}
def __init__(self, name=None, email=None, id=None): # noqa: E501
"""UpdateSmtpTemplateSender - a model defined in Swagger""" # noqa: E501
self._name = None
self._email = None
self._id = None
self.discriminator = None
if name is not None:
self.name = name
if email is not None:
self.email = email
if id is not None:
self.id = id
@property
def name(self):
"""Gets the name of this UpdateSmtpTemplateSender. # noqa: E501
Name of the sender # noqa: E501
:return: The name of this UpdateSmtpTemplateSender. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this UpdateSmtpTemplateSender.
Name of the sender # noqa: E501
:param name: The name of this UpdateSmtpTemplateSender. # noqa: E501
:type: str
"""
self._name = name
@property
def email(self):
"""Gets the email of this UpdateSmtpTemplateSender. # noqa: E501
Email of the sender # noqa: E501
:return: The email of this UpdateSmtpTemplateSender. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this UpdateSmtpTemplateSender.
Email of the sender # noqa: E501
:param email: The email of this UpdateSmtpTemplateSender. # noqa: E501
:type: str
"""
self._email = email
@property
def id(self):
"""Gets the id of this UpdateSmtpTemplateSender. # noqa: E501
Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). # noqa: E501
:return: The id of this UpdateSmtpTemplateSender. # noqa: E501
:rtype: int
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this UpdateSmtpTemplateSender.
Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). # noqa: E501
:param id: The id of this UpdateSmtpTemplateSender. # noqa: E501
:type: int
"""
self._id = id
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateSmtpTemplateSender, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateSmtpTemplateSender):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(name=None, email=None, id=None)
|
60,410 |
sib_api_v3_sdk.models.update_smtp_template_sender
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateSmtpTemplateSender):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,411 |
sib_api_v3_sdk.models.update_smtp_template_sender
|
__init__
|
UpdateSmtpTemplateSender - a model defined in Swagger
|
def __init__(self, name=None, email=None, id=None): # noqa: E501
"""UpdateSmtpTemplateSender - a model defined in Swagger""" # noqa: E501
self._name = None
self._email = None
self._id = None
self.discriminator = None
if name is not None:
self.name = name
if email is not None:
self.email = email
if id is not None:
self.id = id
|
(self, name=None, email=None, id=None)
|
60,414 |
sib_api_v3_sdk.models.update_smtp_template_sender
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateSmtpTemplateSender, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,416 |
sib_api_v3_sdk.models.update_webhook
|
UpdateWebhook
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateWebhook(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'url': 'str',
'description': 'str',
'events': 'list[str]',
'domain': 'str'
}
attribute_map = {
'url': 'url',
'description': 'description',
'events': 'events',
'domain': 'domain'
}
def __init__(self, url=None, description=None, events=None, domain=None): # noqa: E501
"""UpdateWebhook - a model defined in Swagger""" # noqa: E501
self._url = None
self._description = None
self._events = None
self._domain = None
self.discriminator = None
if url is not None:
self.url = url
if description is not None:
self.description = description
if events is not None:
self.events = events
if domain is not None:
self.domain = domain
@property
def url(self):
"""Gets the url of this UpdateWebhook. # noqa: E501
URL of the webhook # noqa: E501
:return: The url of this UpdateWebhook. # noqa: E501
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""Sets the url of this UpdateWebhook.
URL of the webhook # noqa: E501
:param url: The url of this UpdateWebhook. # noqa: E501
:type: str
"""
self._url = url
@property
def description(self):
"""Gets the description of this UpdateWebhook. # noqa: E501
Description of the webhook # noqa: E501
:return: The description of this UpdateWebhook. # noqa: E501
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""Sets the description of this UpdateWebhook.
Description of the webhook # noqa: E501
:param description: The description of this UpdateWebhook. # noqa: E501
:type: str
"""
self._description = description
@property
def events(self):
"""Gets the events of this UpdateWebhook. # noqa: E501
- Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` # noqa: E501
:return: The events of this UpdateWebhook. # noqa: E501
:rtype: list[str]
"""
return self._events
@events.setter
def events(self, events):
"""Sets the events of this UpdateWebhook.
- Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` # noqa: E501
:param events: The events of this UpdateWebhook. # noqa: E501
:type: list[str]
"""
allowed_values = ["sent", "hardBounce", "softBounce", "blocked", "spam", "delivered", "request", "click", "invalid", "deferred", "opened", "uniqueOpened", "unsubscribed", "listAddition", "contactUpdated", "contactDeleted", "inboundEmailProcessed"] # 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
.format(", ".join(map(str, set(events) - set(allowed_values))), # noqa: E501
", ".join(map(str, allowed_values)))
)
self._events = events
@property
def domain(self):
"""Gets the domain of this UpdateWebhook. # noqa: E501
Inbound domain of webhook, used in case of event type `inbound` # noqa: E501
:return: The domain of this UpdateWebhook. # noqa: E501
:rtype: str
"""
return self._domain
@domain.setter
def domain(self, domain):
"""Sets the domain of this UpdateWebhook.
Inbound domain of webhook, used in case of event type `inbound` # noqa: E501
:param domain: The domain of this UpdateWebhook. # noqa: E501
:type: str
"""
self._domain = domain
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateWebhook, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateWebhook):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(url=None, description=None, events=None, domain=None)
|
60,417 |
sib_api_v3_sdk.models.update_webhook
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateWebhook):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,418 |
sib_api_v3_sdk.models.update_webhook
|
__init__
|
UpdateWebhook - a model defined in Swagger
|
def __init__(self, url=None, description=None, events=None, domain=None): # noqa: E501
"""UpdateWebhook - a model defined in Swagger""" # noqa: E501
self._url = None
self._description = None
self._events = None
self._domain = None
self.discriminator = None
if url is not None:
self.url = url
if description is not None:
self.description = description
if events is not None:
self.events = events
if domain is not None:
self.domain = domain
|
(self, url=None, description=None, events=None, domain=None)
|
60,421 |
sib_api_v3_sdk.models.update_webhook
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateWebhook, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,423 |
sib_api_v3_sdk.models.upload_image_model
|
UploadImageModel
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UploadImageModel(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'url': 'str'
}
attribute_map = {
'url': 'url'
}
def __init__(self, url=None): # noqa: E501
"""UploadImageModel - a model defined in Swagger""" # noqa: E501
self._url = None
self.discriminator = None
self.url = url
@property
def url(self):
"""Gets the url of this UploadImageModel. # noqa: E501
URL of the image uploaded # noqa: E501
:return: The url of this UploadImageModel. # noqa: E501
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""Sets the url of this UploadImageModel.
URL of the image uploaded # noqa: E501
:param url: The url of this UploadImageModel. # noqa: E501
:type: str
"""
if url is None:
raise ValueError("Invalid value for `url`, must not be `None`") # noqa: E501
self._url = url
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UploadImageModel, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UploadImageModel):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(url=None)
|
60,424 |
sib_api_v3_sdk.models.upload_image_model
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UploadImageModel):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,425 |
sib_api_v3_sdk.models.upload_image_model
|
__init__
|
UploadImageModel - a model defined in Swagger
|
def __init__(self, url=None): # noqa: E501
"""UploadImageModel - a model defined in Swagger""" # noqa: E501
self._url = None
self.discriminator = None
self.url = url
|
(self, url=None)
|
60,428 |
sib_api_v3_sdk.models.upload_image_model
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UploadImageModel, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,430 |
sib_api_v3_sdk.models.upload_image_to_gallery
|
UploadImageToGallery
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UploadImageToGallery(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'image_url': 'str',
'name': 'str'
}
attribute_map = {
'image_url': 'imageUrl',
'name': 'name'
}
def __init__(self, image_url=None, name=None): # noqa: E501
"""UploadImageToGallery - a model defined in Swagger""" # noqa: E501
self._image_url = None
self._name = None
self.discriminator = None
self.image_url = image_url
if name is not None:
self.name = name
@property
def image_url(self):
"""Gets the image_url of this UploadImageToGallery. # noqa: E501
The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. # noqa: E501
:return: The image_url of this UploadImageToGallery. # noqa: E501
:rtype: str
"""
return self._image_url
@image_url.setter
def image_url(self, image_url):
"""Sets the image_url of this UploadImageToGallery.
The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. # noqa: E501
:param image_url: The image_url of this UploadImageToGallery. # noqa: E501
:type: str
"""
if image_url is None:
raise ValueError("Invalid value for `image_url`, must not be `None`") # noqa: E501
self._image_url = image_url
@property
def name(self):
"""Gets the name of this UploadImageToGallery. # noqa: E501
Name of the image. # noqa: E501
:return: The name of this UploadImageToGallery. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this UploadImageToGallery.
Name of the image. # noqa: E501
:param name: The name of this UploadImageToGallery. # noqa: E501
:type: str
"""
self._name = name
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UploadImageToGallery, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UploadImageToGallery):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(image_url=None, name=None)
|
60,431 |
sib_api_v3_sdk.models.upload_image_to_gallery
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UploadImageToGallery):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,432 |
sib_api_v3_sdk.models.upload_image_to_gallery
|
__init__
|
UploadImageToGallery - a model defined in Swagger
|
def __init__(self, image_url=None, name=None): # noqa: E501
"""UploadImageToGallery - a model defined in Swagger""" # noqa: E501
self._image_url = None
self._name = None
self.discriminator = None
self.image_url = image_url
if name is not None:
self.name = name
|
(self, image_url=None, name=None)
|
60,435 |
sib_api_v3_sdk.models.upload_image_to_gallery
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UploadImageToGallery, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,437 |
sib_api_v3_sdk.models.variables_items
|
VariablesItems
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class VariablesItems(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'name': 'str',
'default': 'str',
'datatype': 'str'
}
attribute_map = {
'name': 'name',
'default': 'default',
'datatype': 'datatype'
}
def __init__(self, name=None, default=None, datatype=None): # noqa: E501
"""VariablesItems - a model defined in Swagger""" # noqa: E501
self._name = None
self._default = None
self._datatype = None
self.discriminator = None
if name is not None:
self.name = name
if default is not None:
self.default = default
if datatype is not None:
self.datatype = datatype
@property
def name(self):
"""Gets the name of this VariablesItems. # noqa: E501
:return: The name of this VariablesItems. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this VariablesItems.
:param name: The name of this VariablesItems. # noqa: E501
:type: str
"""
self._name = name
@property
def default(self):
"""Gets the default of this VariablesItems. # noqa: E501
:return: The default of this VariablesItems. # noqa: E501
:rtype: str
"""
return self._default
@default.setter
def default(self, default):
"""Sets the default of this VariablesItems.
:param default: The default of this VariablesItems. # noqa: E501
:type: str
"""
self._default = default
@property
def datatype(self):
"""Gets the datatype of this VariablesItems. # noqa: E501
:return: The datatype of this VariablesItems. # noqa: E501
:rtype: str
"""
return self._datatype
@datatype.setter
def datatype(self, datatype):
"""Sets the datatype of this VariablesItems.
:param datatype: The datatype of this VariablesItems. # noqa: E501
:type: str
"""
self._datatype = datatype
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(VariablesItems, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, VariablesItems):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(name=None, default=None, datatype=None)
|
60,438 |
sib_api_v3_sdk.models.variables_items
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, VariablesItems):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,439 |
sib_api_v3_sdk.models.variables_items
|
__init__
|
VariablesItems - a model defined in Swagger
|
def __init__(self, name=None, default=None, datatype=None): # noqa: E501
"""VariablesItems - a model defined in Swagger""" # noqa: E501
self._name = None
self._default = None
self._datatype = None
self.discriminator = None
if name is not None:
self.name = name
if default is not None:
self.default = default
if datatype is not None:
self.datatype = datatype
|
(self, name=None, default=None, datatype=None)
|
60,442 |
sib_api_v3_sdk.models.variables_items
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(VariablesItems, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,444 |
sib_api_v3_sdk.api.webhooks_api
|
WebhooksApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class WebhooksApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def create_webhook(self, create_webhook, **kwargs): # noqa: E501
"""Create a webhook # 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_webhook(create_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateWebhook create_webhook: Values to create a webhook (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.create_webhook_with_http_info(create_webhook, **kwargs) # noqa: E501
else:
(data) = self.create_webhook_with_http_info(create_webhook, **kwargs) # noqa: E501
return data
def create_webhook_with_http_info(self, create_webhook, **kwargs): # noqa: E501
"""Create a webhook # 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_webhook_with_http_info(create_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateWebhook create_webhook: Values to create a webhook (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['create_webhook'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_webhook" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'create_webhook' is set
if ('create_webhook' not in params or
params['create_webhook'] is None):
raise ValueError("Missing the required parameter `create_webhook` when calling `create_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_webhook' in params:
body_params = params['create_webhook']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/webhooks', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateModel', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_webhook(self, webhook_id, **kwargs): # noqa: E501
"""Delete a webhook # 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_webhook(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (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_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501
else:
(data) = self.delete_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501
return data
def delete_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""Delete a webhook # 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_webhook_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['webhook_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_webhook" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'webhook_id' is set
if ('webhook_id' not in params or
params['webhook_id'] is None):
raise ValueError("Missing the required parameter `webhook_id` when calling `delete_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in params:
path_params['webhookId'] = params['webhook_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_webhook(self, webhook_id, **kwargs): # noqa: E501
"""Get a webhook 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_webhook(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:return: GetWebhook
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501
else:
(data) = self.get_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501
return data
def get_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""Get a webhook 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_webhook_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:return: GetWebhook
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['webhook_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_webhook" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'webhook_id' is set
if ('webhook_id' not in params or
params['webhook_id'] is None):
raise ValueError("Missing the required parameter `webhook_id` when calling `get_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in params:
path_params['webhookId'] = params['webhook_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetWebhook', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_webhooks(self, **kwargs): # noqa: E501
"""Get all webhooks # 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_webhooks(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str type: Filter on webhook type
:param str sort: Sort the results in the ascending/descending order of webhook creation
:return: GetWebhooks
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_webhooks_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_webhooks_with_http_info(**kwargs) # noqa: E501
return data
def get_webhooks_with_http_info(self, **kwargs): # noqa: E501
"""Get all webhooks # 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_webhooks_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str type: Filter on webhook type
:param str sort: Sort the results in the ascending/descending order of webhook creation
:return: GetWebhooks
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['type', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_webhooks" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'type' in params:
query_params.append(('type', params['type'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', params['sort'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/webhooks', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetWebhooks', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_webhook(self, webhook_id, update_webhook, **kwargs): # noqa: E501
"""Update a webhook # 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_webhook(webhook_id, update_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:param UpdateWebhook update_webhook: Values to update a webhook (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.update_webhook_with_http_info(webhook_id, update_webhook, **kwargs) # noqa: E501
else:
(data) = self.update_webhook_with_http_info(webhook_id, update_webhook, **kwargs) # noqa: E501
return data
def update_webhook_with_http_info(self, webhook_id, update_webhook, **kwargs): # noqa: E501
"""Update a webhook # 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_webhook_with_http_info(webhook_id, update_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:param UpdateWebhook update_webhook: Values to update a webhook (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['webhook_id', 'update_webhook'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_webhook" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'webhook_id' is set
if ('webhook_id' not in params or
params['webhook_id'] is None):
raise ValueError("Missing the required parameter `webhook_id` when calling `update_webhook`") # noqa: E501
# verify the required parameter 'update_webhook' is set
if ('update_webhook' not in params or
params['update_webhook'] is None):
raise ValueError("Missing the required parameter `update_webhook` when calling `update_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in params:
path_params['webhookId'] = params['webhook_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_webhook' in params:
body_params = params['update_webhook']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client=None)
|
60,446 |
sib_api_v3_sdk.api.webhooks_api
|
create_webhook
|
Create a webhook # 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_webhook(create_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateWebhook create_webhook: Values to create a webhook (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
|
def create_webhook(self, create_webhook, **kwargs): # noqa: E501
"""Create a webhook # 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_webhook(create_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateWebhook create_webhook: Values to create a webhook (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.create_webhook_with_http_info(create_webhook, **kwargs) # noqa: E501
else:
(data) = self.create_webhook_with_http_info(create_webhook, **kwargs) # noqa: E501
return data
|
(self, create_webhook, **kwargs)
|
60,447 |
sib_api_v3_sdk.api.webhooks_api
|
create_webhook_with_http_info
|
Create a webhook # 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_webhook_with_http_info(create_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateWebhook create_webhook: Values to create a webhook (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
|
def create_webhook_with_http_info(self, create_webhook, **kwargs): # noqa: E501
"""Create a webhook # 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_webhook_with_http_info(create_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateWebhook create_webhook: Values to create a webhook (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['create_webhook'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_webhook" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'create_webhook' is set
if ('create_webhook' not in params or
params['create_webhook'] is None):
raise ValueError("Missing the required parameter `create_webhook` when calling `create_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_webhook' in params:
body_params = params['create_webhook']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/webhooks', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateModel', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, create_webhook, **kwargs)
|
60,448 |
sib_api_v3_sdk.api.webhooks_api
|
delete_webhook
|
Delete a webhook # 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_webhook(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_webhook(self, webhook_id, **kwargs): # noqa: E501
"""Delete a webhook # 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_webhook(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (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_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501
else:
(data) = self.delete_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501
return data
|
(self, webhook_id, **kwargs)
|
60,449 |
sib_api_v3_sdk.api.webhooks_api
|
delete_webhook_with_http_info
|
Delete a webhook # 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_webhook_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""Delete a webhook # 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_webhook_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['webhook_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_webhook" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'webhook_id' is set
if ('webhook_id' not in params or
params['webhook_id'] is None):
raise ValueError("Missing the required parameter `webhook_id` when calling `delete_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in params:
path_params['webhookId'] = params['webhook_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, webhook_id, **kwargs)
|
60,450 |
sib_api_v3_sdk.api.webhooks_api
|
get_webhook
|
Get a webhook 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_webhook(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:return: GetWebhook
If the method is called asynchronously,
returns the request thread.
|
def get_webhook(self, webhook_id, **kwargs): # noqa: E501
"""Get a webhook 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_webhook(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:return: GetWebhook
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501
else:
(data) = self.get_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501
return data
|
(self, webhook_id, **kwargs)
|
60,451 |
sib_api_v3_sdk.api.webhooks_api
|
get_webhook_with_http_info
|
Get a webhook 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_webhook_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:return: GetWebhook
If the method is called asynchronously,
returns the request thread.
|
def get_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""Get a webhook 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_webhook_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:return: GetWebhook
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['webhook_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_webhook" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'webhook_id' is set
if ('webhook_id' not in params or
params['webhook_id'] is None):
raise ValueError("Missing the required parameter `webhook_id` when calling `get_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in params:
path_params['webhookId'] = params['webhook_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetWebhook', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, webhook_id, **kwargs)
|
60,452 |
sib_api_v3_sdk.api.webhooks_api
|
get_webhooks
|
Get all webhooks # 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_webhooks(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str type: Filter on webhook type
:param str sort: Sort the results in the ascending/descending order of webhook creation
:return: GetWebhooks
If the method is called asynchronously,
returns the request thread.
|
def get_webhooks(self, **kwargs): # noqa: E501
"""Get all webhooks # 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_webhooks(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str type: Filter on webhook type
:param str sort: Sort the results in the ascending/descending order of webhook creation
:return: GetWebhooks
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_webhooks_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_webhooks_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,453 |
sib_api_v3_sdk.api.webhooks_api
|
get_webhooks_with_http_info
|
Get all webhooks # 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_webhooks_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str type: Filter on webhook type
:param str sort: Sort the results in the ascending/descending order of webhook creation
:return: GetWebhooks
If the method is called asynchronously,
returns the request thread.
|
def get_webhooks_with_http_info(self, **kwargs): # noqa: E501
"""Get all webhooks # 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_webhooks_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str type: Filter on webhook type
:param str sort: Sort the results in the ascending/descending order of webhook creation
:return: GetWebhooks
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['type', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_webhooks" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'type' in params:
query_params.append(('type', params['type'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', params['sort'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/webhooks', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetWebhooks', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,454 |
sib_api_v3_sdk.api.webhooks_api
|
update_webhook
|
Update a webhook # 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_webhook(webhook_id, update_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:param UpdateWebhook update_webhook: Values to update a webhook (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_webhook(self, webhook_id, update_webhook, **kwargs): # noqa: E501
"""Update a webhook # 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_webhook(webhook_id, update_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:param UpdateWebhook update_webhook: Values to update a webhook (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.update_webhook_with_http_info(webhook_id, update_webhook, **kwargs) # noqa: E501
else:
(data) = self.update_webhook_with_http_info(webhook_id, update_webhook, **kwargs) # noqa: E501
return data
|
(self, webhook_id, update_webhook, **kwargs)
|
60,455 |
sib_api_v3_sdk.api.webhooks_api
|
update_webhook_with_http_info
|
Update a webhook # 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_webhook_with_http_info(webhook_id, update_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:param UpdateWebhook update_webhook: Values to update a webhook (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_webhook_with_http_info(self, webhook_id, update_webhook, **kwargs): # noqa: E501
"""Update a webhook # 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_webhook_with_http_info(webhook_id, update_webhook, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int webhook_id: Id of the webhook (required)
:param UpdateWebhook update_webhook: Values to update a webhook (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['webhook_id', 'update_webhook'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_webhook" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'webhook_id' is set
if ('webhook_id' not in params or
params['webhook_id'] is None):
raise ValueError("Missing the required parameter `webhook_id` when calling `update_webhook`") # noqa: E501
# verify the required parameter 'update_webhook' is set
if ('update_webhook' not in params or
params['update_webhook'] is None):
raise ValueError("Missing the required parameter `update_webhook` when calling `update_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in params:
path_params['webhookId'] = params['webhook_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_webhook' in params:
body_params = params['update_webhook']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, webhook_id, update_webhook, **kwargs)
|
60,456 |
sib_api_v3_sdk.models.whatsapp_camp_stats
|
WhatsappCampStats
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class WhatsappCampStats(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'sent': 'int',
'delivered': 'int',
'read': 'int',
'unsubscribe': 'int',
'not_sent': 'int'
}
attribute_map = {
'sent': 'sent',
'delivered': 'delivered',
'read': 'read',
'unsubscribe': 'unsubscribe',
'not_sent': 'not_sent'
}
def __init__(self, sent=None, delivered=None, read=None, unsubscribe=None, not_sent=None): # noqa: E501
"""WhatsappCampStats - a model defined in Swagger""" # noqa: E501
self._sent = None
self._delivered = None
self._read = None
self._unsubscribe = None
self._not_sent = None
self.discriminator = None
self.sent = sent
self.delivered = delivered
self.read = read
self.unsubscribe = unsubscribe
self.not_sent = not_sent
@property
def sent(self):
"""Gets the sent of this WhatsappCampStats. # noqa: E501
:return: The sent of this WhatsappCampStats. # noqa: E501
:rtype: int
"""
return self._sent
@sent.setter
def sent(self, sent):
"""Sets the sent of this WhatsappCampStats.
:param sent: The sent of this WhatsappCampStats. # noqa: E501
:type: int
"""
if sent is None:
raise ValueError("Invalid value for `sent`, must not be `None`") # noqa: E501
self._sent = sent
@property
def delivered(self):
"""Gets the delivered of this WhatsappCampStats. # noqa: E501
:return: The delivered of this WhatsappCampStats. # noqa: E501
:rtype: int
"""
return self._delivered
@delivered.setter
def delivered(self, delivered):
"""Sets the delivered of this WhatsappCampStats.
:param delivered: The delivered of this WhatsappCampStats. # noqa: E501
:type: int
"""
if delivered is None:
raise ValueError("Invalid value for `delivered`, must not be `None`") # noqa: E501
self._delivered = delivered
@property
def read(self):
"""Gets the read of this WhatsappCampStats. # noqa: E501
:return: The read of this WhatsappCampStats. # noqa: E501
:rtype: int
"""
return self._read
@read.setter
def read(self, read):
"""Sets the read of this WhatsappCampStats.
:param read: The read of this WhatsappCampStats. # noqa: E501
:type: int
"""
if read is None:
raise ValueError("Invalid value for `read`, must not be `None`") # noqa: E501
self._read = read
@property
def unsubscribe(self):
"""Gets the unsubscribe of this WhatsappCampStats. # noqa: E501
:return: The unsubscribe of this WhatsappCampStats. # noqa: E501
:rtype: int
"""
return self._unsubscribe
@unsubscribe.setter
def unsubscribe(self, unsubscribe):
"""Sets the unsubscribe of this WhatsappCampStats.
:param unsubscribe: The unsubscribe of this WhatsappCampStats. # noqa: E501
:type: int
"""
if unsubscribe is None:
raise ValueError("Invalid value for `unsubscribe`, must not be `None`") # noqa: E501
self._unsubscribe = unsubscribe
@property
def not_sent(self):
"""Gets the not_sent of this WhatsappCampStats. # noqa: E501
:return: The not_sent of this WhatsappCampStats. # noqa: E501
:rtype: int
"""
return self._not_sent
@not_sent.setter
def not_sent(self, not_sent):
"""Sets the not_sent of this WhatsappCampStats.
:param not_sent: The not_sent of this WhatsappCampStats. # noqa: E501
:type: int
"""
if not_sent is None:
raise ValueError("Invalid value for `not_sent`, must not be `None`") # noqa: E501
self._not_sent = not_sent
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(WhatsappCampStats, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, WhatsappCampStats):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(sent=None, delivered=None, read=None, unsubscribe=None, not_sent=None)
|
60,457 |
sib_api_v3_sdk.models.whatsapp_camp_stats
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, WhatsappCampStats):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,458 |
sib_api_v3_sdk.models.whatsapp_camp_stats
|
__init__
|
WhatsappCampStats - a model defined in Swagger
|
def __init__(self, sent=None, delivered=None, read=None, unsubscribe=None, not_sent=None): # noqa: E501
"""WhatsappCampStats - a model defined in Swagger""" # noqa: E501
self._sent = None
self._delivered = None
self._read = None
self._unsubscribe = None
self._not_sent = None
self.discriminator = None
self.sent = sent
self.delivered = delivered
self.read = read
self.unsubscribe = unsubscribe
self.not_sent = not_sent
|
(self, sent=None, delivered=None, read=None, unsubscribe=None, not_sent=None)
|
60,461 |
sib_api_v3_sdk.models.whatsapp_camp_stats
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(WhatsappCampStats, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,463 |
sib_api_v3_sdk.models.whatsapp_camp_template
|
WhatsappCampTemplate
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class WhatsappCampTemplate(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'name': 'str',
'category': 'str',
'language': 'str',
'contains_button': 'bool',
'display_header': 'bool',
'header_type': 'str',
'components': 'list[ComponentItems]',
'header_variables': 'list[VariablesItems]',
'body_variables': 'list[VariablesItems]',
'button_type': 'str',
'hide_footer': 'bool'
}
attribute_map = {
'name': 'name',
'category': 'category',
'language': 'language',
'contains_button': 'contains_button',
'display_header': 'display_header',
'header_type': 'header_type',
'components': 'components',
'header_variables': 'header_variables',
'body_variables': 'body_variables',
'button_type': 'button_type',
'hide_footer': 'hide_footer'
}
def __init__(self, name=None, category=None, language=None, contains_button=None, display_header=None, header_type=None, components=None, header_variables=None, body_variables=None, button_type=None, hide_footer=None): # noqa: E501
"""WhatsappCampTemplate - a model defined in Swagger""" # noqa: E501
self._name = None
self._category = None
self._language = None
self._contains_button = None
self._display_header = None
self._header_type = None
self._components = None
self._header_variables = None
self._body_variables = None
self._button_type = None
self._hide_footer = None
self.discriminator = None
if name is not None:
self.name = name
if category is not None:
self.category = category
if language is not None:
self.language = language
if contains_button is not None:
self.contains_button = contains_button
if display_header is not None:
self.display_header = display_header
if header_type is not None:
self.header_type = header_type
if components is not None:
self.components = components
if header_variables is not None:
self.header_variables = header_variables
if body_variables is not None:
self.body_variables = body_variables
if button_type is not None:
self.button_type = button_type
if hide_footer is not None:
self.hide_footer = hide_footer
@property
def name(self):
"""Gets the name of this WhatsappCampTemplate. # noqa: E501
name of the template # noqa: E501
:return: The name of this WhatsappCampTemplate. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this WhatsappCampTemplate.
name of the template # noqa: E501
:param name: The name of this WhatsappCampTemplate. # noqa: E501
:type: str
"""
self._name = name
@property
def category(self):
"""Gets the category of this WhatsappCampTemplate. # noqa: E501
description of the template # noqa: E501
:return: The category of this WhatsappCampTemplate. # noqa: E501
:rtype: str
"""
return self._category
@category.setter
def category(self, category):
"""Sets the category of this WhatsappCampTemplate.
description of the template # noqa: E501
:param category: The category of this WhatsappCampTemplate. # noqa: E501
:type: str
"""
self._category = category
@property
def language(self):
"""Gets the language of this WhatsappCampTemplate. # noqa: E501
language of the template # noqa: E501
:return: The language of this WhatsappCampTemplate. # noqa: E501
:rtype: str
"""
return self._language
@language.setter
def language(self, language):
"""Sets the language of this WhatsappCampTemplate.
language of the template # noqa: E501
:param language: The language of this WhatsappCampTemplate. # noqa: E501
:type: str
"""
self._language = language
@property
def contains_button(self):
"""Gets the contains_button of this WhatsappCampTemplate. # noqa: E501
:return: The contains_button of this WhatsappCampTemplate. # noqa: E501
:rtype: bool
"""
return self._contains_button
@contains_button.setter
def contains_button(self, contains_button):
"""Sets the contains_button of this WhatsappCampTemplate.
:param contains_button: The contains_button of this WhatsappCampTemplate. # noqa: E501
:type: bool
"""
self._contains_button = contains_button
@property
def display_header(self):
"""Gets the display_header of this WhatsappCampTemplate. # noqa: E501
:return: The display_header of this WhatsappCampTemplate. # noqa: E501
:rtype: bool
"""
return self._display_header
@display_header.setter
def display_header(self, display_header):
"""Sets the display_header of this WhatsappCampTemplate.
:param display_header: The display_header of this WhatsappCampTemplate. # noqa: E501
:type: bool
"""
self._display_header = display_header
@property
def header_type(self):
"""Gets the header_type of this WhatsappCampTemplate. # noqa: E501
type of header # noqa: E501
:return: The header_type of this WhatsappCampTemplate. # noqa: E501
:rtype: str
"""
return self._header_type
@header_type.setter
def header_type(self, header_type):
"""Sets the header_type of this WhatsappCampTemplate.
type of header # noqa: E501
:param header_type: The header_type of this WhatsappCampTemplate. # noqa: E501
:type: str
"""
self._header_type = header_type
@property
def components(self):
"""Gets the components of this WhatsappCampTemplate. # noqa: E501
array of component item objects # noqa: E501
:return: The components of this WhatsappCampTemplate. # noqa: E501
:rtype: list[ComponentItems]
"""
return self._components
@components.setter
def components(self, components):
"""Sets the components of this WhatsappCampTemplate.
array of component item objects # noqa: E501
:param components: The components of this WhatsappCampTemplate. # noqa: E501
:type: list[ComponentItems]
"""
self._components = components
@property
def header_variables(self):
"""Gets the header_variables of this WhatsappCampTemplate. # noqa: E501
array of variables item object # noqa: E501
:return: The header_variables of this WhatsappCampTemplate. # noqa: E501
:rtype: list[VariablesItems]
"""
return self._header_variables
@header_variables.setter
def header_variables(self, header_variables):
"""Sets the header_variables of this WhatsappCampTemplate.
array of variables item object # noqa: E501
:param header_variables: The header_variables of this WhatsappCampTemplate. # noqa: E501
:type: list[VariablesItems]
"""
self._header_variables = header_variables
@property
def body_variables(self):
"""Gets the body_variables of this WhatsappCampTemplate. # noqa: E501
array of variables item variables # noqa: E501
:return: The body_variables of this WhatsappCampTemplate. # noqa: E501
:rtype: list[VariablesItems]
"""
return self._body_variables
@body_variables.setter
def body_variables(self, body_variables):
"""Sets the body_variables of this WhatsappCampTemplate.
array of variables item variables # noqa: E501
:param body_variables: The body_variables of this WhatsappCampTemplate. # noqa: E501
:type: list[VariablesItems]
"""
self._body_variables = body_variables
@property
def button_type(self):
"""Gets the button_type of this WhatsappCampTemplate. # noqa: E501
:return: The button_type of this WhatsappCampTemplate. # noqa: E501
:rtype: str
"""
return self._button_type
@button_type.setter
def button_type(self, button_type):
"""Sets the button_type of this WhatsappCampTemplate.
:param button_type: The button_type of this WhatsappCampTemplate. # noqa: E501
:type: str
"""
self._button_type = button_type
@property
def hide_footer(self):
"""Gets the hide_footer of this WhatsappCampTemplate. # noqa: E501
:return: The hide_footer of this WhatsappCampTemplate. # noqa: E501
:rtype: bool
"""
return self._hide_footer
@hide_footer.setter
def hide_footer(self, hide_footer):
"""Sets the hide_footer of this WhatsappCampTemplate.
:param hide_footer: The hide_footer of this WhatsappCampTemplate. # noqa: E501
:type: bool
"""
self._hide_footer = hide_footer
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(WhatsappCampTemplate, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, WhatsappCampTemplate):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(name=None, category=None, language=None, contains_button=None, display_header=None, header_type=None, components=None, header_variables=None, body_variables=None, button_type=None, hide_footer=None)
|
60,464 |
sib_api_v3_sdk.models.whatsapp_camp_template
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, WhatsappCampTemplate):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,465 |
sib_api_v3_sdk.models.whatsapp_camp_template
|
__init__
|
WhatsappCampTemplate - a model defined in Swagger
|
def __init__(self, name=None, category=None, language=None, contains_button=None, display_header=None, header_type=None, components=None, header_variables=None, body_variables=None, button_type=None, hide_footer=None): # noqa: E501
"""WhatsappCampTemplate - a model defined in Swagger""" # noqa: E501
self._name = None
self._category = None
self._language = None
self._contains_button = None
self._display_header = None
self._header_type = None
self._components = None
self._header_variables = None
self._body_variables = None
self._button_type = None
self._hide_footer = None
self.discriminator = None
if name is not None:
self.name = name
if category is not None:
self.category = category
if language is not None:
self.language = language
if contains_button is not None:
self.contains_button = contains_button
if display_header is not None:
self.display_header = display_header
if header_type is not None:
self.header_type = header_type
if components is not None:
self.components = components
if header_variables is not None:
self.header_variables = header_variables
if body_variables is not None:
self.body_variables = body_variables
if button_type is not None:
self.button_type = button_type
if hide_footer is not None:
self.hide_footer = hide_footer
|
(self, name=None, category=None, language=None, contains_button=None, display_header=None, header_type=None, components=None, header_variables=None, body_variables=None, button_type=None, hide_footer=None)
|
60,468 |
sib_api_v3_sdk.models.whatsapp_camp_template
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(WhatsappCampTemplate, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,470 |
sib_api_v3_sdk.api.whatsapp_campaigns_api
|
WhatsappCampaignsApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class WhatsappCampaignsApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def delete_whatsapp_campaign(self, campaign_id, **kwargs): # noqa: E501
"""Delete a Whatsapp campaign # 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_whatsapp_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (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_whatsapp_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.delete_whatsapp_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def delete_whatsapp_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Delete a Whatsapp campaign # 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_whatsapp_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_whatsapp_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `delete_whatsapp_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/whatsappCampaigns/{campaignId}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_whatsapp_campaign(self, campaign_id, **kwargs): # noqa: E501
"""Get a Whatsapp campaign # 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_whatsapp_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: Id of the campaign (required)
:return: GetWhatsappCampaignOverview
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_whatsapp_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_whatsapp_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_whatsapp_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Get a Whatsapp campaign # 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_whatsapp_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: Id of the campaign (required)
:return: GetWhatsappCampaignOverview
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_whatsapp_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `get_whatsapp_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/whatsappCampaigns/{campaignId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetWhatsappCampaignOverview', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_whatsapp_templates(self, **kwargs): # noqa: E501
"""Return all your created whatsapp templates # 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_whatsapp_templates(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number of documents per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWATemplates
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_whatsapp_templates_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_whatsapp_templates_with_http_info(**kwargs) # noqa: E501
return data
def get_whatsapp_templates_with_http_info(self, **kwargs): # noqa: E501
"""Return all your created whatsapp templates # 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_whatsapp_templates_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number of documents per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWATemplates
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['start_date', 'end_date', 'limit', 'offset', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_whatsapp_templates" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 100: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_whatsapp_templates`, must be a value less than or equal to `100`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_whatsapp_templates`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', params['sort'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/whatsappCampaigns/template-list', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetWATemplates', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client=None)
|
60,472 |
sib_api_v3_sdk.api.whatsapp_campaigns_api
|
delete_whatsapp_campaign
|
Delete a Whatsapp campaign # 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_whatsapp_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_whatsapp_campaign(self, campaign_id, **kwargs): # noqa: E501
"""Delete a Whatsapp campaign # 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_whatsapp_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (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_whatsapp_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.delete_whatsapp_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
60,473 |
sib_api_v3_sdk.api.whatsapp_campaigns_api
|
delete_whatsapp_campaign_with_http_info
|
Delete a Whatsapp campaign # 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_whatsapp_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_whatsapp_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Delete a Whatsapp campaign # 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_whatsapp_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_whatsapp_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `delete_whatsapp_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/whatsappCampaigns/{campaignId}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
60,474 |
sib_api_v3_sdk.api.whatsapp_campaigns_api
|
get_whatsapp_campaign
|
Get a Whatsapp campaign # 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_whatsapp_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: Id of the campaign (required)
:return: GetWhatsappCampaignOverview
If the method is called asynchronously,
returns the request thread.
|
def get_whatsapp_campaign(self, campaign_id, **kwargs): # noqa: E501
"""Get a Whatsapp campaign # 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_whatsapp_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: Id of the campaign (required)
:return: GetWhatsappCampaignOverview
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_whatsapp_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_whatsapp_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
60,475 |
sib_api_v3_sdk.api.whatsapp_campaigns_api
|
get_whatsapp_campaign_with_http_info
|
Get a Whatsapp campaign # 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_whatsapp_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: Id of the campaign (required)
:return: GetWhatsappCampaignOverview
If the method is called asynchronously,
returns the request thread.
|
def get_whatsapp_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Get a Whatsapp campaign # 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_whatsapp_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: Id of the campaign (required)
:return: GetWhatsappCampaignOverview
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_whatsapp_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `get_whatsapp_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/whatsappCampaigns/{campaignId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetWhatsappCampaignOverview', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
60,476 |
sib_api_v3_sdk.api.whatsapp_campaigns_api
|
get_whatsapp_templates
|
Return all your created whatsapp templates # 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_whatsapp_templates(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number of documents per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWATemplates
If the method is called asynchronously,
returns the request thread.
|
def get_whatsapp_templates(self, **kwargs): # noqa: E501
"""Return all your created whatsapp templates # 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_whatsapp_templates(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number of documents per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWATemplates
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_whatsapp_templates_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_whatsapp_templates_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,477 |
sib_api_v3_sdk.api.whatsapp_campaigns_api
|
get_whatsapp_templates_with_http_info
|
Return all your created whatsapp templates # 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_whatsapp_templates_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number of documents per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWATemplates
If the method is called asynchronously,
returns the request thread.
|
def get_whatsapp_templates_with_http_info(self, **kwargs): # noqa: E501
"""Return all your created whatsapp templates # 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_whatsapp_templates_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number of documents per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWATemplates
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['start_date', 'end_date', 'limit', 'offset', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_whatsapp_templates" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 100: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_whatsapp_templates`, must be a value less than or equal to `100`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_whatsapp_templates`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', params['sort'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/whatsappCampaigns/template-list', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetWATemplates', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,483 |
dash_bootstrap_components._components.Accordion
|
Accordion
|
An Accordion component.
A self contained Accordion component. Build up the children using the
AccordionItem component.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- active_item (string | list of strings; optional):
The item_id of the currently active item. If item_id has not been
specified for the active item, this will default to item-i, where
i is the index (starting from 0) of the item. If
`always_open=True`, this needs to be a list of string IDs.
- always_open (boolean; default False):
You can make accordion items stay open when another item is opened
by using the always_open prop.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- flush (boolean; optional):
Renders accordion edge-to-edge with its parent container.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- persisted_props (list of a value equal to: 'active_item's; default ['active_item']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- persistence (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- start_collapsed (boolean; default False):
Set to True for all items to be collapsed initially.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
class Accordion(Component):
"""An Accordion component.
A self contained Accordion component. Build up the children using the
AccordionItem component.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- active_item (string | list of strings; optional):
The item_id of the currently active item. If item_id has not been
specified for the active item, this will default to item-i, where
i is the index (starting from 0) of the item. If
`always_open=True`, this needs to be a list of string IDs.
- always_open (boolean; default False):
You can make accordion items stay open when another item is opened
by using the always_open prop.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- flush (boolean; optional):
Renders accordion edge-to-edge with its parent container.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- persisted_props (list of a value equal to: 'active_item's; default ['active_item']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- persistence (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- start_collapsed (boolean; default False):
Set to True for all items to be collapsed initially.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Accordion'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, flush=Component.UNDEFINED, active_item=Component.UNDEFINED, always_open=Component.UNDEFINED, start_collapsed=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'active_item', 'always_open', 'className', 'class_name', 'flush', 'key', 'loading_state', 'persisted_props', 'persistence', 'persistence_type', 'start_collapsed', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'active_item', 'always_open', 'className', 'class_name', 'flush', 'key', 'loading_state', 'persisted_props', 'persistence', 'persistence_type', 'start_collapsed', 'style']
self.available_wildcard_properties = []
_explicit_args = kwargs.pop('_explicit_args')
_locals = locals()
_locals.update(kwargs) # For wildcard attrs and excess named props
args = {k: _locals[k] for k in _explicit_args if k != 'children'}
super(Accordion, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, flush=undefined, active_item=undefined, always_open=undefined, start_collapsed=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
60,484 |
dash.development.base_component
|
__delitem__
|
Delete items by ID in the tree of children.
|
def __delitem__(self, id): # pylint: disable=redefined-builtin
"""Delete items by ID in the tree of children."""
return self._get_set_or_delete(id, "delete")
|
(self, id)
|
60,485 |
dash.development.base_component
|
__getitem__
|
Recursively find the element with the given ID through the tree of
children.
|
def __getitem__(self, id): # pylint: disable=redefined-builtin
"""Recursively find the element with the given ID through the tree of
children."""
# A component's children can be undefined, a string, another component,
# or a list of components.
return self._get_set_or_delete(id, "get")
|
(self, id)
|
60,486 |
dash.development.base_component
|
wrapper
| null |
def _explicitize_args(func):
# Python 2
if hasattr(func, "func_code"):
varnames = func.func_code.co_varnames
# Python 3
else:
varnames = func.__code__.co_varnames
def wrapper(*args, **kwargs):
if "_explicit_args" in kwargs:
raise Exception("Variable _explicit_args should not be set.")
kwargs["_explicit_args"] = list(
set(list(varnames[: len(args)]) + [k for k, _ in kwargs.items()])
)
if "self" in kwargs["_explicit_args"]:
kwargs["_explicit_args"].remove("self")
return func(*args, **kwargs)
# If Python 3, we can set the function signature to be correct
if hasattr(inspect, "signature"):
# pylint: disable=no-member
new_sig = inspect.signature(wrapper).replace(
parameters=inspect.signature(func).parameters.values()
)
wrapper.__signature__ = new_sig
return wrapper
|
(self, children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, flush=undefined, active_item=undefined, always_open=undefined, start_collapsed=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
60,487 |
dash.development.base_component
|
__iter__
|
Yield IDs in the tree of children.
|
def __iter__(self):
"""Yield IDs in the tree of children."""
for t in self._traverse_ids():
yield t.id
|
(self)
|
60,488 |
dash.development.base_component
|
__len__
|
Return the number of items in the tree.
|
def __len__(self):
"""Return the number of items in the tree."""
# TODO - Should we return the number of items that have IDs
# or just the number of items?
# The number of items is more intuitive but returning the number
# of IDs matches __iter__ better.
length = 0
if getattr(self, "children", None) is None:
length = 0
elif isinstance(self.children, Component):
length = 1
length += len(self.children)
elif isinstance(self.children, (tuple, MutableSequence)):
for c in self.children:
length += 1
if isinstance(c, Component):
length += len(c)
else:
# string or number
length = 1
return length
|
(self)
|
60,489 |
dash.development.base_component
|
__repr__
| null |
def __repr__(self):
# pylint: disable=no-member
props_with_values = [
c for c in self._prop_names if getattr(self, c, None) is not None
] + [
c
for c in self.__dict__
if any(c.startswith(wc_attr) for wc_attr in self._valid_wildcard_attributes)
]
if any(p != "children" for p in props_with_values):
props_string = ", ".join(
f"{p}={getattr(self, p)!r}" for p in props_with_values
)
else:
props_string = repr(getattr(self, "children", None))
return f"{self._type}({props_string})"
|
(self)
|
60,490 |
dash.development.base_component
|
__setitem__
|
Set an element by its ID.
|
def __setitem__(self, id, item): # pylint: disable=redefined-builtin
"""Set an element by its ID."""
return self._get_set_or_delete(id, "set", item)
|
(self, id, item)
|
60,491 |
dash.development.base_component
|
_get_set_or_delete
| null |
def _get_set_or_delete(self, id, operation, new_item=None):
_check_if_has_indexable_children(self)
# pylint: disable=access-member-before-definition,
# pylint: disable=attribute-defined-outside-init
if isinstance(self.children, Component):
if getattr(self.children, "id", None) is not None:
# Woohoo! It's the item that we're looking for
if self.children.id == id:
if operation == "get":
return self.children
if operation == "set":
self.children = new_item
return
if operation == "delete":
self.children = None
return
# Recursively dig into its subtree
try:
if operation == "get":
return self.children.__getitem__(id)
if operation == "set":
self.children.__setitem__(id, new_item)
return
if operation == "delete":
self.children.__delitem__(id)
return
except KeyError:
pass
# if children is like a list
if isinstance(self.children, (tuple, MutableSequence)):
for i, item in enumerate(self.children):
# If the item itself is the one we're looking for
if getattr(item, "id", None) == id:
if operation == "get":
return item
if operation == "set":
self.children[i] = new_item
return
if operation == "delete":
del self.children[i]
return
# Otherwise, recursively dig into that item's subtree
# Make sure it's not like a string
elif isinstance(item, Component):
try:
if operation == "get":
return item.__getitem__(id)
if operation == "set":
item.__setitem__(id, new_item)
return
if operation == "delete":
item.__delitem__(id)
return
except KeyError:
pass
# The end of our branch
# If we were in a list, then this exception will get caught
raise KeyError(id)
|
(self, id, operation, new_item=None)
|
60,492 |
dash.development.base_component
|
_id_str
| null |
@staticmethod
def _id_str(component):
id_ = stringify_id(getattr(component, "id", ""))
return id_ and f" (id={id_:s})"
|
(component)
|
60,493 |
dash.development.base_component
|
_set_random_id
| null |
def _set_random_id(self):
if hasattr(self, "id"):
return getattr(self, "id")
kind = f"`{self._namespace}.{self._type}`" # pylint: disable=no-member
if getattr(self, "persistence", False):
raise RuntimeError(
f"""
Attempting to use an auto-generated ID with the `persistence` prop.
This is prohibited because persistence is tied to component IDs and
auto-generated IDs can easily change.
Please assign an explicit ID to this {kind} component.
"""
)
if "dash_snapshots" in sys.modules:
raise RuntimeError(
f"""
Attempting to use an auto-generated ID in an app with `dash_snapshots`.
This is prohibited because snapshots saves the whole app layout,
including component IDs, and auto-generated IDs can easily change.
Callbacks referencing the new IDs will not work with old snapshots.
Please assign an explicit ID to this {kind} component.
"""
)
v = str(uuid.UUID(int=rd.randint(0, 2**128)))
setattr(self, "id", v)
return v
|
(self)
|
60,494 |
dash.development.base_component
|
_traverse
|
Yield each item in the tree.
|
def _traverse(self):
"""Yield each item in the tree."""
for t in self._traverse_with_paths():
yield t[1]
|
(self)
|
60,495 |
dash.development.base_component
|
_traverse_ids
|
Yield components with IDs in the tree of children.
|
def _traverse_ids(self):
"""Yield components with IDs in the tree of children."""
for t in self._traverse():
if isinstance(t, Component) and getattr(t, "id", None) is not None:
yield t
|
(self)
|
60,496 |
dash.development.base_component
|
_traverse_with_paths
|
Yield each item with its path in the tree.
|
def _traverse_with_paths(self):
"""Yield each item with its path in the tree."""
children = getattr(self, "children", None)
children_type = type(children).__name__
children_string = children_type + self._id_str(children)
# children is just a component
if isinstance(children, Component):
yield "[*] " + children_string, children
# pylint: disable=protected-access
for p, t in children._traverse_with_paths():
yield "\n".join(["[*] " + children_string, p]), t
# children is a list of components
elif isinstance(children, (tuple, MutableSequence)):
for idx, i in enumerate(children):
list_path = f"[{idx:d}] {type(i).__name__:s}{self._id_str(i)}"
yield list_path, i
if isinstance(i, Component):
# pylint: disable=protected-access
for p, t in i._traverse_with_paths():
yield "\n".join([list_path, p]), t
|
(self)
|
60,497 |
dash.development.base_component
|
to_plotly_json
| null |
def to_plotly_json(self):
# Add normal properties
props = {
p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)
}
# Add the wildcard properties data-* and aria-*
props.update(
{
k: getattr(self, k)
for k in self.__dict__
if any(
k.startswith(w)
# pylint:disable=no-member
for w in self._valid_wildcard_attributes
)
}
)
as_json = {
"props": props,
"type": self._type, # pylint: disable=no-member
"namespace": self._namespace, # pylint: disable=no-member
}
return as_json
|
(self)
|
60,498 |
dash_bootstrap_components._components.AccordionItem
|
AccordionItem
|
An AccordionItem component.
A component to build up the children of the accordion.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- item_id (string; optional):
Optional identifier for item used for determining which item is
visible if not specified, and AccordionItem is being used inside
Accordion component, the itemId will be set to "item-i" where i
is (zero indexed) position of item in list items pased to
Accordion component.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- title (a list of or a singular dash component, string or number; optional):
The title on display in the collapsed accordion item.
|
class AccordionItem(Component):
"""An AccordionItem component.
A component to build up the children of the accordion.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- item_id (string; optional):
Optional identifier for item used for determining which item is
visible if not specified, and AccordionItem is being used inside
Accordion component, the itemId will be set to \"item-i\" where i
is (zero indexed) position of item in list items pased to
Accordion component.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- title (a list of or a singular dash component, string or number; optional):
The title on display in the collapsed accordion item."""
_children_props = ['title']
_base_nodes = ['title', 'children']
_namespace = 'dash_bootstrap_components'
_type = 'AccordionItem'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, title=Component.UNDEFINED, item_id=Component.UNDEFINED, loading_state=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'item_id', 'loading_state', 'style', 'title']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'item_id', 'loading_state', 'style', 'title']
self.available_wildcard_properties = []
_explicit_args = kwargs.pop('_explicit_args')
_locals = locals()
_locals.update(kwargs) # For wildcard attrs and excess named props
args = {k: _locals[k] for k in _explicit_args if k != 'children'}
super(AccordionItem, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, title=undefined, item_id=undefined, loading_state=undefined, **kwargs)
|
60,513 |
dash_bootstrap_components._components.Alert
|
Alert
|
An Alert component.
Alert allows you to create contextual feedback messages on user actions.
Control the visibility using callbacks with the `is_open` prop, or set it to
auto-dismiss with the `duration` prop.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; default 'success'):
Alert color, options: primary, secondary, success, info, warning,
danger, link or any valid CSS color of your choice (e.g. a hex
code, a decimal code or a CSS color name) Default: secondary.
- dismissable (boolean; optional):
If True, add a close button that allows Alert to be dismissed.
- duration (number; optional):
Duration in milliseconds after which the Alert dismisses itself.
- fade (boolean; optional):
If True, a fade animation will be applied when `is_open` is
toggled. If False the Alert will simply appear and disappear.
- is_open (boolean; default True):
Whether alert is open. Default: True.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- persisted_props (list of a value equal to: 'is_open's; default ['is_open']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- persistence (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
|
class Alert(Component):
"""An Alert component.
Alert allows you to create contextual feedback messages on user actions.
Control the visibility using callbacks with the `is_open` prop, or set it to
auto-dismiss with the `duration` prop.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; default 'success'):
Alert color, options: primary, secondary, success, info, warning,
danger, link or any valid CSS color of your choice (e.g. a hex
code, a decimal code or a CSS color name) Default: secondary.
- dismissable (boolean; optional):
If True, add a close button that allows Alert to be dismissed.
- duration (number; optional):
Duration in milliseconds after which the Alert dismisses itself.
- fade (boolean; optional):
If True, a fade animation will be applied when `is_open` is
toggled. If False the Alert will simply appear and disappear.
- is_open (boolean; default True):
Whether alert is open. Default: True.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- persisted_props (list of a value equal to: 'is_open's; default ['is_open']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- persistence (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- style (dict; optional):
Defines CSS styles which will override styles previously set."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Alert'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, color=Component.UNDEFINED, is_open=Component.UNDEFINED, fade=Component.UNDEFINED, dismissable=Component.UNDEFINED, duration=Component.UNDEFINED, loading_state=Component.UNDEFINED, persistence=Component.UNDEFINED, persisted_props=Component.UNDEFINED, persistence_type=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'color', 'dismissable', 'duration', 'fade', 'is_open', 'key', 'loading_state', 'persisted_props', 'persistence', 'persistence_type', 'style']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'color', 'dismissable', 'duration', 'fade', 'is_open', 'key', 'loading_state', 'persisted_props', 'persistence', 'persistence_type', 'style']
self.available_wildcard_properties = []
_explicit_args = kwargs.pop('_explicit_args')
_locals = locals()
_locals.update(kwargs) # For wildcard attrs and excess named props
args = {k: _locals[k] for k in _explicit_args if k != 'children'}
super(Alert, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, color=undefined, is_open=undefined, fade=undefined, dismissable=undefined, duration=undefined, loading_state=undefined, persistence=undefined, persisted_props=undefined, persistence_type=undefined, **kwargs)
|
60,528 |
dash_bootstrap_components._components.Badge
|
Badge
|
A Badge component.
Badges can be used to add counts or labels to other components.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; default 'secondary'):
Badge color, options: primary, secondary, success, info, warning,
danger, link or any valid CSS color of your choice (e.g. a hex
code, a decimal code or a CSS color name) Default: secondary.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
Attach link to badge.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- pill (boolean; optional):
Make badge "pill" shaped (rounded ends, like a pill). Default:
False.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the Badge. Default: span.
- target (string; optional):
Target attribute to pass on to the link. Only applies to external
links.
- text_color (string; optional):
Badge color, options: primary, secondary, success, info, warning,
danger, link or any valid CSS color of your choice (e.g. a hex
code, a decimal code or a CSS color name) Default: secondary.
- title (string; optional):
Sets the title attribute of the underlying HTML button.
|
class Badge(Component):
"""A Badge component.
Badges can be used to add counts or labels to other components.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- className (string; optional):
**DEPRECATED** Use `class_name` instead. Often used with CSS to
style elements with common properties.
- class_name (string; optional):
Often used with CSS to style elements with common properties.
- color (string; default 'secondary'):
Badge color, options: primary, secondary, success, info, warning,
danger, link or any valid CSS color of your choice (e.g. a hex
code, a decimal code or a CSS color name) Default: secondary.
- external_link (boolean; optional):
If True, the browser will treat this as an external link, forcing
a page refresh at the new location. If False, this just changes
the location without triggering a page refresh. Use this if you
are observing dcc.Location, for instance. Defaults to True for
absolute URLs and False otherwise.
- href (string; optional):
Attach link to badge.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- component_name (string; optional):
Holds the name of the component that is loading.
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- pill (boolean; optional):
Make badge \"pill\" shaped (rounded ends, like a pill). Default:
False.
- style (dict; optional):
Defines CSS styles which will override styles previously set.
- tag (string; optional):
HTML tag to use for the Badge. Default: span.
- target (string; optional):
Target attribute to pass on to the link. Only applies to external
links.
- text_color (string; optional):
Badge color, options: primary, secondary, success, info, warning,
danger, link or any valid CSS color of your choice (e.g. a hex
code, a decimal code or a CSS color name) Default: secondary.
- title (string; optional):
Sets the title attribute of the underlying HTML button."""
_children_props = []
_base_nodes = ['children']
_namespace = 'dash_bootstrap_components'
_type = 'Badge'
@_explicitize_args
def __init__(self, children=None, id=Component.UNDEFINED, style=Component.UNDEFINED, class_name=Component.UNDEFINED, className=Component.UNDEFINED, key=Component.UNDEFINED, color=Component.UNDEFINED, text_color=Component.UNDEFINED, pill=Component.UNDEFINED, href=Component.UNDEFINED, tag=Component.UNDEFINED, loading_state=Component.UNDEFINED, external_link=Component.UNDEFINED, n_clicks=Component.UNDEFINED, n_clicks_timestamp=Component.UNDEFINED, target=Component.UNDEFINED, title=Component.UNDEFINED, **kwargs):
self._prop_names = ['children', 'id', 'className', 'class_name', 'color', 'external_link', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'pill', 'style', 'tag', 'target', 'text_color', 'title']
self._valid_wildcard_attributes = []
self.available_properties = ['children', 'id', 'className', 'class_name', 'color', 'external_link', 'href', 'key', 'loading_state', 'n_clicks', 'n_clicks_timestamp', 'pill', 'style', 'tag', 'target', 'text_color', 'title']
self.available_wildcard_properties = []
_explicit_args = kwargs.pop('_explicit_args')
_locals = locals()
_locals.update(kwargs) # For wildcard attrs and excess named props
args = {k: _locals[k] for k in _explicit_args if k != 'children'}
super(Badge, self).__init__(children=children, **args)
|
(children=None, id=undefined, style=undefined, class_name=undefined, className=undefined, key=undefined, color=undefined, text_color=undefined, pill=undefined, href=undefined, tag=undefined, loading_state=undefined, external_link=undefined, n_clicks=undefined, n_clicks_timestamp=undefined, target=undefined, title=undefined, **kwargs)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.