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
⌀ |
|---|---|---|---|---|---|
59,746 |
sib_api_v3_sdk.models.order_batch
|
OrderBatch
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class OrderBatch(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 = {
'orders': 'list[Order]',
'notify_url': 'str'
}
attribute_map = {
'orders': 'orders',
'notify_url': 'notifyUrl'
}
def __init__(self, orders=None, notify_url=None): # noqa: E501
"""OrderBatch - a model defined in Swagger""" # noqa: E501
self._orders = None
self._notify_url = None
self.discriminator = None
self.orders = orders
if notify_url is not None:
self.notify_url = notify_url
@property
def orders(self):
"""Gets the orders of this OrderBatch. # noqa: E501
array of order objects # noqa: E501
:return: The orders of this OrderBatch. # noqa: E501
:rtype: list[Order]
"""
return self._orders
@orders.setter
def orders(self, orders):
"""Sets the orders of this OrderBatch.
array of order objects # noqa: E501
:param orders: The orders of this OrderBatch. # noqa: E501
:type: list[Order]
"""
if orders is None:
raise ValueError("Invalid value for `orders`, must not be `None`") # noqa: E501
self._orders = orders
@property
def notify_url(self):
"""Gets the notify_url of this OrderBatch. # noqa: E501
Notify Url provided by client to get the status of batch request # noqa: E501
:return: The notify_url of this OrderBatch. # noqa: E501
:rtype: str
"""
return self._notify_url
@notify_url.setter
def notify_url(self, notify_url):
"""Sets the notify_url of this OrderBatch.
Notify Url provided by client to get the status of batch request # noqa: E501
:param notify_url: The notify_url of this OrderBatch. # noqa: E501
:type: str
"""
self._notify_url = notify_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(OrderBatch, 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, OrderBatch):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(orders=None, notify_url=None)
|
59,747 |
sib_api_v3_sdk.models.order_batch
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, OrderBatch):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,748 |
sib_api_v3_sdk.models.order_batch
|
__init__
|
OrderBatch - a model defined in Swagger
|
def __init__(self, orders=None, notify_url=None): # noqa: E501
"""OrderBatch - a model defined in Swagger""" # noqa: E501
self._orders = None
self._notify_url = None
self.discriminator = None
self.orders = orders
if notify_url is not None:
self.notify_url = notify_url
|
(self, orders=None, notify_url=None)
|
59,751 |
sib_api_v3_sdk.models.order_batch
|
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(OrderBatch, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,753 |
sib_api_v3_sdk.models.order_billing
|
OrderBilling
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class OrderBilling(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 = {
'address': 'str',
'city': 'str',
'country_code': 'str',
'phone': 'str',
'post_code': 'str',
'payment_method': 'str',
'region': 'str'
}
attribute_map = {
'address': 'address',
'city': 'city',
'country_code': 'countryCode',
'phone': 'phone',
'post_code': 'postCode',
'payment_method': 'paymentMethod',
'region': 'region'
}
def __init__(self, address=None, city=None, country_code=None, phone=None, post_code=None, payment_method=None, region=None): # noqa: E501
"""OrderBilling - a model defined in Swagger""" # noqa: E501
self._address = None
self._city = None
self._country_code = None
self._phone = None
self._post_code = None
self._payment_method = None
self._region = None
self.discriminator = None
if address is not None:
self.address = address
if city is not None:
self.city = city
if country_code is not None:
self.country_code = country_code
if phone is not None:
self.phone = phone
if post_code is not None:
self.post_code = post_code
if payment_method is not None:
self.payment_method = payment_method
if region is not None:
self.region = region
@property
def address(self):
"""Gets the address of this OrderBilling. # noqa: E501
Full billing address. # noqa: E501
:return: The address of this OrderBilling. # noqa: E501
:rtype: str
"""
return self._address
@address.setter
def address(self, address):
"""Sets the address of this OrderBilling.
Full billing address. # noqa: E501
:param address: The address of this OrderBilling. # noqa: E501
:type: str
"""
self._address = address
@property
def city(self):
"""Gets the city of this OrderBilling. # noqa: E501
Exact city of the address. # noqa: E501
:return: The city of this OrderBilling. # noqa: E501
:rtype: str
"""
return self._city
@city.setter
def city(self, city):
"""Sets the city of this OrderBilling.
Exact city of the address. # noqa: E501
:param city: The city of this OrderBilling. # noqa: E501
:type: str
"""
self._city = city
@property
def country_code(self):
"""Gets the country_code of this OrderBilling. # noqa: E501
Billing country 2-letter ISO code. # noqa: E501
:return: The country_code of this OrderBilling. # noqa: E501
:rtype: str
"""
return self._country_code
@country_code.setter
def country_code(self, country_code):
"""Sets the country_code of this OrderBilling.
Billing country 2-letter ISO code. # noqa: E501
:param country_code: The country_code of this OrderBilling. # noqa: E501
:type: str
"""
self._country_code = country_code
@property
def phone(self):
"""Gets the phone of this OrderBilling. # noqa: E501
Phone number to contact for further details about the order, Mandatory if \"email\" field is not passed. # noqa: E501
:return: The phone of this OrderBilling. # noqa: E501
:rtype: str
"""
return self._phone
@phone.setter
def phone(self, phone):
"""Sets the phone of this OrderBilling.
Phone number to contact for further details about the order, Mandatory if \"email\" field is not passed. # noqa: E501
:param phone: The phone of this OrderBilling. # noqa: E501
:type: str
"""
self._phone = phone
@property
def post_code(self):
"""Gets the post_code of this OrderBilling. # noqa: E501
Postcode for delivery and billing. # noqa: E501
:return: The post_code of this OrderBilling. # noqa: E501
:rtype: str
"""
return self._post_code
@post_code.setter
def post_code(self, post_code):
"""Sets the post_code of this OrderBilling.
Postcode for delivery and billing. # noqa: E501
:param post_code: The post_code of this OrderBilling. # noqa: E501
:type: str
"""
self._post_code = post_code
@property
def payment_method(self):
"""Gets the payment_method of this OrderBilling. # noqa: E501
How the visitor will pay for the item(s), e.g. paypal, check, etc. # noqa: E501
:return: The payment_method of this OrderBilling. # noqa: E501
:rtype: str
"""
return self._payment_method
@payment_method.setter
def payment_method(self, payment_method):
"""Sets the payment_method of this OrderBilling.
How the visitor will pay for the item(s), e.g. paypal, check, etc. # noqa: E501
:param payment_method: The payment_method of this OrderBilling. # noqa: E501
:type: str
"""
self._payment_method = payment_method
@property
def region(self):
"""Gets the region of this OrderBilling. # noqa: E501
Exact region (state/province) for delivery and billing. # noqa: E501
:return: The region of this OrderBilling. # noqa: E501
:rtype: str
"""
return self._region
@region.setter
def region(self, region):
"""Sets the region of this OrderBilling.
Exact region (state/province) for delivery and billing. # noqa: E501
:param region: The region of this OrderBilling. # noqa: E501
:type: str
"""
self._region = region
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(OrderBilling, 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, OrderBilling):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(address=None, city=None, country_code=None, phone=None, post_code=None, payment_method=None, region=None)
|
59,754 |
sib_api_v3_sdk.models.order_billing
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, OrderBilling):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,755 |
sib_api_v3_sdk.models.order_billing
|
__init__
|
OrderBilling - a model defined in Swagger
|
def __init__(self, address=None, city=None, country_code=None, phone=None, post_code=None, payment_method=None, region=None): # noqa: E501
"""OrderBilling - a model defined in Swagger""" # noqa: E501
self._address = None
self._city = None
self._country_code = None
self._phone = None
self._post_code = None
self._payment_method = None
self._region = None
self.discriminator = None
if address is not None:
self.address = address
if city is not None:
self.city = city
if country_code is not None:
self.country_code = country_code
if phone is not None:
self.phone = phone
if post_code is not None:
self.post_code = post_code
if payment_method is not None:
self.payment_method = payment_method
if region is not None:
self.region = region
|
(self, address=None, city=None, country_code=None, phone=None, post_code=None, payment_method=None, region=None)
|
59,758 |
sib_api_v3_sdk.models.order_billing
|
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(OrderBilling, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,760 |
sib_api_v3_sdk.models.order_products
|
OrderProducts
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class OrderProducts(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 = {
'product_id': 'str',
'quantity': 'float',
'variant_id': 'str',
'price': 'float'
}
attribute_map = {
'product_id': 'productId',
'quantity': 'quantity',
'variant_id': 'variantId',
'price': 'price'
}
def __init__(self, product_id=None, quantity=None, variant_id=None, price=None): # noqa: E501
"""OrderProducts - a model defined in Swagger""" # noqa: E501
self._product_id = None
self._quantity = None
self._variant_id = None
self._price = None
self.discriminator = None
self.product_id = product_id
self.quantity = quantity
if variant_id is not None:
self.variant_id = variant_id
self.price = price
@property
def product_id(self):
"""Gets the product_id of this OrderProducts. # noqa: E501
ID of the product. # noqa: E501
:return: The product_id of this OrderProducts. # noqa: E501
:rtype: str
"""
return self._product_id
@product_id.setter
def product_id(self, product_id):
"""Sets the product_id of this OrderProducts.
ID of the product. # noqa: E501
:param product_id: The product_id of this OrderProducts. # noqa: E501
:type: str
"""
if product_id is None:
raise ValueError("Invalid value for `product_id`, must not be `None`") # noqa: E501
self._product_id = product_id
@property
def quantity(self):
"""Gets the quantity of this OrderProducts. # noqa: E501
How many pieces of the product the visitor has added to the cart. # noqa: E501
:return: The quantity of this OrderProducts. # noqa: E501
:rtype: float
"""
return self._quantity
@quantity.setter
def quantity(self, quantity):
"""Sets the quantity of this OrderProducts.
How many pieces of the product the visitor has added to the cart. # noqa: E501
:param quantity: The quantity of this OrderProducts. # noqa: E501
:type: float
"""
if quantity is None:
raise ValueError("Invalid value for `quantity`, must not be `None`") # noqa: E501
self._quantity = quantity
@property
def variant_id(self):
"""Gets the variant_id of this OrderProducts. # noqa: E501
Product ID of the red color shirts. # noqa: E501
:return: The variant_id of this OrderProducts. # noqa: E501
:rtype: str
"""
return self._variant_id
@variant_id.setter
def variant_id(self, variant_id):
"""Sets the variant_id of this OrderProducts.
Product ID of the red color shirts. # noqa: E501
:param variant_id: The variant_id of this OrderProducts. # noqa: E501
:type: str
"""
self._variant_id = variant_id
@property
def price(self):
"""Gets the price of this OrderProducts. # noqa: E501
The price of a unit of product # noqa: E501
:return: The price of this OrderProducts. # noqa: E501
:rtype: float
"""
return self._price
@price.setter
def price(self, price):
"""Sets the price of this OrderProducts.
The price of a unit of product # noqa: E501
:param price: The price of this OrderProducts. # noqa: E501
:type: float
"""
if price is None:
raise ValueError("Invalid value for `price`, must not be `None`") # noqa: E501
self._price = price
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(OrderProducts, 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, OrderProducts):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(product_id=None, quantity=None, variant_id=None, price=None)
|
59,761 |
sib_api_v3_sdk.models.order_products
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, OrderProducts):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,762 |
sib_api_v3_sdk.models.order_products
|
__init__
|
OrderProducts - a model defined in Swagger
|
def __init__(self, product_id=None, quantity=None, variant_id=None, price=None): # noqa: E501
"""OrderProducts - a model defined in Swagger""" # noqa: E501
self._product_id = None
self._quantity = None
self._variant_id = None
self._price = None
self.discriminator = None
self.product_id = product_id
self.quantity = quantity
if variant_id is not None:
self.variant_id = variant_id
self.price = price
|
(self, product_id=None, quantity=None, variant_id=None, price=None)
|
59,765 |
sib_api_v3_sdk.models.order_products
|
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(OrderProducts, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,767 |
sib_api_v3_sdk.models.pipeline
|
Pipeline
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class Pipeline(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 = {
'stages': 'list[PipelineStage]'
}
attribute_map = {
'stages': 'stages'
}
def __init__(self, stages=None): # noqa: E501
"""Pipeline - a model defined in Swagger""" # noqa: E501
self._stages = None
self.discriminator = None
if stages is not None:
self.stages = stages
@property
def stages(self):
"""Gets the stages of this Pipeline. # noqa: E501
List of stages # noqa: E501
:return: The stages of this Pipeline. # noqa: E501
:rtype: list[PipelineStage]
"""
return self._stages
@stages.setter
def stages(self, stages):
"""Sets the stages of this Pipeline.
List of stages # noqa: E501
:param stages: The stages of this Pipeline. # noqa: E501
:type: list[PipelineStage]
"""
self._stages = stages
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(Pipeline, 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, Pipeline):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(stages=None)
|
59,768 |
sib_api_v3_sdk.models.pipeline
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, Pipeline):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,769 |
sib_api_v3_sdk.models.pipeline
|
__init__
|
Pipeline - a model defined in Swagger
|
def __init__(self, stages=None): # noqa: E501
"""Pipeline - a model defined in Swagger""" # noqa: E501
self._stages = None
self.discriminator = None
if stages is not None:
self.stages = stages
|
(self, stages=None)
|
59,772 |
sib_api_v3_sdk.models.pipeline
|
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(Pipeline, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,774 |
sib_api_v3_sdk.models.pipeline_stage
|
PipelineStage
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class PipelineStage(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 = {
'id': 'str',
'name': 'str'
}
attribute_map = {
'id': 'id',
'name': 'name'
}
def __init__(self, id=None, name=None): # noqa: E501
"""PipelineStage - a model defined in Swagger""" # noqa: E501
self._id = None
self._name = None
self.discriminator = None
if id is not None:
self.id = id
if name is not None:
self.name = name
@property
def id(self):
"""Gets the id of this PipelineStage. # noqa: E501
Stage id # noqa: E501
:return: The id of this PipelineStage. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this PipelineStage.
Stage id # noqa: E501
:param id: The id of this PipelineStage. # noqa: E501
:type: str
"""
self._id = id
@property
def name(self):
"""Gets the name of this PipelineStage. # noqa: E501
Stage name # noqa: E501
:return: The name of this PipelineStage. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this PipelineStage.
Stage name # noqa: E501
:param name: The name of this PipelineStage. # 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(PipelineStage, 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, PipelineStage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(id=None, name=None)
|
59,775 |
sib_api_v3_sdk.models.pipeline_stage
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, PipelineStage):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,776 |
sib_api_v3_sdk.models.pipeline_stage
|
__init__
|
PipelineStage - a model defined in Swagger
|
def __init__(self, id=None, name=None): # noqa: E501
"""PipelineStage - a model defined in Swagger""" # noqa: E501
self._id = None
self._name = None
self.discriminator = None
if id is not None:
self.id = id
if name is not None:
self.name = name
|
(self, id=None, name=None)
|
59,779 |
sib_api_v3_sdk.models.pipeline_stage
|
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(PipelineStage, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,781 |
sib_api_v3_sdk.models.post_contact_info
|
PostContactInfo
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class PostContactInfo(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 = {
'contacts': 'PostContactInfoContacts'
}
attribute_map = {
'contacts': 'contacts'
}
def __init__(self, contacts=None): # noqa: E501
"""PostContactInfo - a model defined in Swagger""" # noqa: E501
self._contacts = None
self.discriminator = None
self.contacts = contacts
@property
def contacts(self):
"""Gets the contacts of this PostContactInfo. # noqa: E501
:return: The contacts of this PostContactInfo. # noqa: E501
:rtype: PostContactInfoContacts
"""
return self._contacts
@contacts.setter
def contacts(self, contacts):
"""Sets the contacts of this PostContactInfo.
:param contacts: The contacts of this PostContactInfo. # noqa: E501
:type: PostContactInfoContacts
"""
if contacts is None:
raise ValueError("Invalid value for `contacts`, must not be `None`") # noqa: E501
self._contacts = contacts
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(PostContactInfo, 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, PostContactInfo):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(contacts=None)
|
59,782 |
sib_api_v3_sdk.models.post_contact_info
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, PostContactInfo):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,783 |
sib_api_v3_sdk.models.post_contact_info
|
__init__
|
PostContactInfo - a model defined in Swagger
|
def __init__(self, contacts=None): # noqa: E501
"""PostContactInfo - a model defined in Swagger""" # noqa: E501
self._contacts = None
self.discriminator = None
self.contacts = contacts
|
(self, contacts=None)
|
59,786 |
sib_api_v3_sdk.models.post_contact_info
|
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(PostContactInfo, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,788 |
sib_api_v3_sdk.models.post_contact_info_contacts
|
PostContactInfoContacts
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class PostContactInfoContacts(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 = {
'success': 'list[str]',
'failure': 'list[str]',
'total': 'int',
'process_id': 'int'
}
attribute_map = {
'success': 'success',
'failure': 'failure',
'total': 'total',
'process_id': 'processId'
}
def __init__(self, success=None, failure=None, total=None, process_id=None): # noqa: E501
"""PostContactInfoContacts - a model defined in Swagger""" # noqa: E501
self._success = None
self._failure = None
self._total = None
self._process_id = None
self.discriminator = None
if success is not None:
self.success = success
if failure is not None:
self.failure = failure
if total is not None:
self.total = total
if process_id is not None:
self.process_id = process_id
@property
def success(self):
"""Gets the success of this PostContactInfoContacts. # noqa: E501
:return: The success of this PostContactInfoContacts. # noqa: E501
:rtype: list[str]
"""
return self._success
@success.setter
def success(self, success):
"""Sets the success of this PostContactInfoContacts.
:param success: The success of this PostContactInfoContacts. # noqa: E501
:type: list[str]
"""
self._success = success
@property
def failure(self):
"""Gets the failure of this PostContactInfoContacts. # noqa: E501
:return: The failure of this PostContactInfoContacts. # noqa: E501
:rtype: list[str]
"""
return self._failure
@failure.setter
def failure(self, failure):
"""Sets the failure of this PostContactInfoContacts.
:param failure: The failure of this PostContactInfoContacts. # noqa: E501
:type: list[str]
"""
self._failure = failure
@property
def total(self):
"""Gets the total of this PostContactInfoContacts. # noqa: E501
Displays the count of total number of contacts removed from list when user opts for \"all\" option. # noqa: E501
:return: The total of this PostContactInfoContacts. # noqa: E501
:rtype: int
"""
return self._total
@total.setter
def total(self, total):
"""Sets the total of this PostContactInfoContacts.
Displays the count of total number of contacts removed from list when user opts for \"all\" option. # noqa: E501
:param total: The total of this PostContactInfoContacts. # noqa: E501
:type: int
"""
self._total = total
@property
def process_id(self):
"""Gets the process_id of this PostContactInfoContacts. # noqa: E501
Id of the process created to remove contacts from list when user opts for \"all\" option. # noqa: E501
:return: The process_id of this PostContactInfoContacts. # noqa: E501
:rtype: int
"""
return self._process_id
@process_id.setter
def process_id(self, process_id):
"""Sets the process_id of this PostContactInfoContacts.
Id of the process created to remove contacts from list when user opts for \"all\" option. # noqa: E501
:param process_id: The process_id of this PostContactInfoContacts. # noqa: E501
:type: int
"""
self._process_id = process_id
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
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(PostContactInfoContacts, 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, PostContactInfoContacts):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(success=None, failure=None, total=None, process_id=None)
|
59,789 |
sib_api_v3_sdk.models.post_contact_info_contacts
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, PostContactInfoContacts):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,790 |
sib_api_v3_sdk.models.post_contact_info_contacts
|
__init__
|
PostContactInfoContacts - a model defined in Swagger
|
def __init__(self, success=None, failure=None, total=None, process_id=None): # noqa: E501
"""PostContactInfoContacts - a model defined in Swagger""" # noqa: E501
self._success = None
self._failure = None
self._total = None
self._process_id = None
self.discriminator = None
if success is not None:
self.success = success
if failure is not None:
self.failure = failure
if total is not None:
self.total = total
if process_id is not None:
self.process_id = process_id
|
(self, success=None, failure=None, total=None, process_id=None)
|
59,793 |
sib_api_v3_sdk.models.post_contact_info_contacts
|
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(PostContactInfoContacts, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,795 |
sib_api_v3_sdk.models.post_send_failed
|
PostSendFailed
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class PostSendFailed(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 = {
'code': 'int',
'message': 'str',
'unexisting_emails': 'list[str]',
'without_list_emails': 'list[str]',
'black_listed_emails': 'list[str]'
}
attribute_map = {
'code': 'code',
'message': 'message',
'unexisting_emails': 'unexistingEmails',
'without_list_emails': 'withoutListEmails',
'black_listed_emails': 'blackListedEmails'
}
def __init__(self, code=None, message=None, unexisting_emails=None, without_list_emails=None, black_listed_emails=None): # noqa: E501
"""PostSendFailed - a model defined in Swagger""" # noqa: E501
self._code = None
self._message = None
self._unexisting_emails = None
self._without_list_emails = None
self._black_listed_emails = None
self.discriminator = None
self.code = code
self.message = message
if unexisting_emails is not None:
self.unexisting_emails = unexisting_emails
if without_list_emails is not None:
self.without_list_emails = without_list_emails
if black_listed_emails is not None:
self.black_listed_emails = black_listed_emails
@property
def code(self):
"""Gets the code of this PostSendFailed. # noqa: E501
Response code # noqa: E501
:return: The code of this PostSendFailed. # noqa: E501
:rtype: int
"""
return self._code
@code.setter
def code(self, code):
"""Sets the code of this PostSendFailed.
Response code # noqa: E501
:param code: The code of this PostSendFailed. # noqa: E501
:type: int
"""
if code is None:
raise ValueError("Invalid value for `code`, must not be `None`") # noqa: E501
self._code = code
@property
def message(self):
"""Gets the message of this PostSendFailed. # noqa: E501
Response message # noqa: E501
:return: The message of this PostSendFailed. # noqa: E501
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""Sets the message of this PostSendFailed.
Response message # noqa: E501
:param message: The message of this PostSendFailed. # noqa: E501
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`") # noqa: E501
self._message = message
@property
def unexisting_emails(self):
"""Gets the unexisting_emails of this PostSendFailed. # noqa: E501
:return: The unexisting_emails of this PostSendFailed. # noqa: E501
:rtype: list[str]
"""
return self._unexisting_emails
@unexisting_emails.setter
def unexisting_emails(self, unexisting_emails):
"""Sets the unexisting_emails of this PostSendFailed.
:param unexisting_emails: The unexisting_emails of this PostSendFailed. # noqa: E501
:type: list[str]
"""
self._unexisting_emails = unexisting_emails
@property
def without_list_emails(self):
"""Gets the without_list_emails of this PostSendFailed. # noqa: E501
:return: The without_list_emails of this PostSendFailed. # noqa: E501
:rtype: list[str]
"""
return self._without_list_emails
@without_list_emails.setter
def without_list_emails(self, without_list_emails):
"""Sets the without_list_emails of this PostSendFailed.
:param without_list_emails: The without_list_emails of this PostSendFailed. # noqa: E501
:type: list[str]
"""
self._without_list_emails = without_list_emails
@property
def black_listed_emails(self):
"""Gets the black_listed_emails of this PostSendFailed. # noqa: E501
:return: The black_listed_emails of this PostSendFailed. # noqa: E501
:rtype: list[str]
"""
return self._black_listed_emails
@black_listed_emails.setter
def black_listed_emails(self, black_listed_emails):
"""Sets the black_listed_emails of this PostSendFailed.
:param black_listed_emails: The black_listed_emails of this PostSendFailed. # noqa: E501
:type: list[str]
"""
self._black_listed_emails = black_listed_emails
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(PostSendFailed, 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, PostSendFailed):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(code=None, message=None, unexisting_emails=None, without_list_emails=None, black_listed_emails=None)
|
59,796 |
sib_api_v3_sdk.models.post_send_failed
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, PostSendFailed):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,797 |
sib_api_v3_sdk.models.post_send_failed
|
__init__
|
PostSendFailed - a model defined in Swagger
|
def __init__(self, code=None, message=None, unexisting_emails=None, without_list_emails=None, black_listed_emails=None): # noqa: E501
"""PostSendFailed - a model defined in Swagger""" # noqa: E501
self._code = None
self._message = None
self._unexisting_emails = None
self._without_list_emails = None
self._black_listed_emails = None
self.discriminator = None
self.code = code
self.message = message
if unexisting_emails is not None:
self.unexisting_emails = unexisting_emails
if without_list_emails is not None:
self.without_list_emails = without_list_emails
if black_listed_emails is not None:
self.black_listed_emails = black_listed_emails
|
(self, code=None, message=None, unexisting_emails=None, without_list_emails=None, black_listed_emails=None)
|
59,800 |
sib_api_v3_sdk.models.post_send_failed
|
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(PostSendFailed, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,802 |
sib_api_v3_sdk.models.post_send_sms_test_failed
|
PostSendSmsTestFailed
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class PostSendSmsTestFailed(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 = {
'code': 'int',
'message': 'str',
'unexisting_sms': 'list[str]',
'without_list_sms': 'list[str]'
}
attribute_map = {
'code': 'code',
'message': 'message',
'unexisting_sms': 'unexistingSms',
'without_list_sms': 'withoutListSms'
}
def __init__(self, code=None, message=None, unexisting_sms=None, without_list_sms=None): # noqa: E501
"""PostSendSmsTestFailed - a model defined in Swagger""" # noqa: E501
self._code = None
self._message = None
self._unexisting_sms = None
self._without_list_sms = None
self.discriminator = None
self.code = code
self.message = message
if unexisting_sms is not None:
self.unexisting_sms = unexisting_sms
if without_list_sms is not None:
self.without_list_sms = without_list_sms
@property
def code(self):
"""Gets the code of this PostSendSmsTestFailed. # noqa: E501
Response code # noqa: E501
:return: The code of this PostSendSmsTestFailed. # noqa: E501
:rtype: int
"""
return self._code
@code.setter
def code(self, code):
"""Sets the code of this PostSendSmsTestFailed.
Response code # noqa: E501
:param code: The code of this PostSendSmsTestFailed. # noqa: E501
:type: int
"""
if code is None:
raise ValueError("Invalid value for `code`, must not be `None`") # noqa: E501
self._code = code
@property
def message(self):
"""Gets the message of this PostSendSmsTestFailed. # noqa: E501
Response message # noqa: E501
:return: The message of this PostSendSmsTestFailed. # noqa: E501
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""Sets the message of this PostSendSmsTestFailed.
Response message # noqa: E501
:param message: The message of this PostSendSmsTestFailed. # noqa: E501
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`") # noqa: E501
self._message = message
@property
def unexisting_sms(self):
"""Gets the unexisting_sms of this PostSendSmsTestFailed. # noqa: E501
:return: The unexisting_sms of this PostSendSmsTestFailed. # noqa: E501
:rtype: list[str]
"""
return self._unexisting_sms
@unexisting_sms.setter
def unexisting_sms(self, unexisting_sms):
"""Sets the unexisting_sms of this PostSendSmsTestFailed.
:param unexisting_sms: The unexisting_sms of this PostSendSmsTestFailed. # noqa: E501
:type: list[str]
"""
self._unexisting_sms = unexisting_sms
@property
def without_list_sms(self):
"""Gets the without_list_sms of this PostSendSmsTestFailed. # noqa: E501
:return: The without_list_sms of this PostSendSmsTestFailed. # noqa: E501
:rtype: list[str]
"""
return self._without_list_sms
@without_list_sms.setter
def without_list_sms(self, without_list_sms):
"""Sets the without_list_sms of this PostSendSmsTestFailed.
:param without_list_sms: The without_list_sms of this PostSendSmsTestFailed. # noqa: E501
:type: list[str]
"""
self._without_list_sms = without_list_sms
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(PostSendSmsTestFailed, 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, PostSendSmsTestFailed):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(code=None, message=None, unexisting_sms=None, without_list_sms=None)
|
59,803 |
sib_api_v3_sdk.models.post_send_sms_test_failed
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, PostSendSmsTestFailed):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,804 |
sib_api_v3_sdk.models.post_send_sms_test_failed
|
__init__
|
PostSendSmsTestFailed - a model defined in Swagger
|
def __init__(self, code=None, message=None, unexisting_sms=None, without_list_sms=None): # noqa: E501
"""PostSendSmsTestFailed - a model defined in Swagger""" # noqa: E501
self._code = None
self._message = None
self._unexisting_sms = None
self._without_list_sms = None
self.discriminator = None
self.code = code
self.message = message
if unexisting_sms is not None:
self.unexisting_sms = unexisting_sms
if without_list_sms is not None:
self.without_list_sms = without_list_sms
|
(self, code=None, message=None, unexisting_sms=None, without_list_sms=None)
|
59,807 |
sib_api_v3_sdk.models.post_send_sms_test_failed
|
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(PostSendSmsTestFailed, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,809 |
sib_api_v3_sdk.api.process_api
|
ProcessApi
|
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 ProcessApi(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 get_process(self, process_id, **kwargs): # noqa: E501
"""Return the informations for a process # 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_process(process_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int process_id: Id of the process (required)
:return: GetProcess
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_process_with_http_info(process_id, **kwargs) # noqa: E501
else:
(data) = self.get_process_with_http_info(process_id, **kwargs) # noqa: E501
return data
def get_process_with_http_info(self, process_id, **kwargs): # noqa: E501
"""Return the informations for a process # 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_process_with_http_info(process_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int process_id: Id of the process (required)
:return: GetProcess
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['process_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_process" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'process_id' is set
if ('process_id' not in params or
params['process_id'] is None):
raise ValueError("Missing the required parameter `process_id` when calling `get_process`") # noqa: E501
collection_formats = {}
path_params = {}
if 'process_id' in params:
path_params['processId'] = params['process_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(
'/processes/{processId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetProcess', # 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_processes(self, **kwargs): # noqa: E501
"""Return all the processes for your account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_processes(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetProcesses
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_processes_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_processes_with_http_info(**kwargs) # noqa: E501
return data
def get_processes_with_http_info(self, **kwargs): # noqa: E501
"""Return all the processes for your account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_processes_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetProcesses
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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_processes" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 50: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_processes`, must be a value less than or equal to `50`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_processes`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
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(
'/processes', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetProcesses', # 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)
|
59,811 |
sib_api_v3_sdk.api.process_api
|
get_process
|
Return the informations for a process # 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_process(process_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int process_id: Id of the process (required)
:return: GetProcess
If the method is called asynchronously,
returns the request thread.
|
def get_process(self, process_id, **kwargs): # noqa: E501
"""Return the informations for a process # 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_process(process_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int process_id: Id of the process (required)
:return: GetProcess
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_process_with_http_info(process_id, **kwargs) # noqa: E501
else:
(data) = self.get_process_with_http_info(process_id, **kwargs) # noqa: E501
return data
|
(self, process_id, **kwargs)
|
59,812 |
sib_api_v3_sdk.api.process_api
|
get_process_with_http_info
|
Return the informations for a process # 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_process_with_http_info(process_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int process_id: Id of the process (required)
:return: GetProcess
If the method is called asynchronously,
returns the request thread.
|
def get_process_with_http_info(self, process_id, **kwargs): # noqa: E501
"""Return the informations for a process # 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_process_with_http_info(process_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int process_id: Id of the process (required)
:return: GetProcess
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['process_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_process" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'process_id' is set
if ('process_id' not in params or
params['process_id'] is None):
raise ValueError("Missing the required parameter `process_id` when calling `get_process`") # noqa: E501
collection_formats = {}
path_params = {}
if 'process_id' in params:
path_params['processId'] = params['process_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(
'/processes/{processId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetProcess', # 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, process_id, **kwargs)
|
59,813 |
sib_api_v3_sdk.api.process_api
|
get_processes
|
Return all the processes for your account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_processes(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetProcesses
If the method is called asynchronously,
returns the request thread.
|
def get_processes(self, **kwargs): # noqa: E501
"""Return all the processes for your account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_processes(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetProcesses
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_processes_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_processes_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
59,814 |
sib_api_v3_sdk.api.process_api
|
get_processes_with_http_info
|
Return all the processes for your account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_processes_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetProcesses
If the method is called asynchronously,
returns the request thread.
|
def get_processes_with_http_info(self, **kwargs): # noqa: E501
"""Return all the processes for your account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_processes_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetProcesses
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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_processes" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 50: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_processes`, must be a value less than or equal to `50`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_processes`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
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(
'/processes', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetProcesses', # 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)
|
59,815 |
sib_api_v3_sdk.models.remaining_credit_model
|
RemainingCreditModel
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class RemainingCreditModel(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 = {
'child': 'RemainingCreditModelChild',
'reseller': 'RemainingCreditModelReseller'
}
attribute_map = {
'child': 'child',
'reseller': 'reseller'
}
def __init__(self, child=None, reseller=None): # noqa: E501
"""RemainingCreditModel - a model defined in Swagger""" # noqa: E501
self._child = None
self._reseller = None
self.discriminator = None
self.child = child
self.reseller = reseller
@property
def child(self):
"""Gets the child of this RemainingCreditModel. # noqa: E501
:return: The child of this RemainingCreditModel. # noqa: E501
:rtype: RemainingCreditModelChild
"""
return self._child
@child.setter
def child(self, child):
"""Sets the child of this RemainingCreditModel.
:param child: The child of this RemainingCreditModel. # noqa: E501
:type: RemainingCreditModelChild
"""
if child is None:
raise ValueError("Invalid value for `child`, must not be `None`") # noqa: E501
self._child = child
@property
def reseller(self):
"""Gets the reseller of this RemainingCreditModel. # noqa: E501
:return: The reseller of this RemainingCreditModel. # noqa: E501
:rtype: RemainingCreditModelReseller
"""
return self._reseller
@reseller.setter
def reseller(self, reseller):
"""Sets the reseller of this RemainingCreditModel.
:param reseller: The reseller of this RemainingCreditModel. # noqa: E501
:type: RemainingCreditModelReseller
"""
if reseller is None:
raise ValueError("Invalid value for `reseller`, must not be `None`") # noqa: E501
self._reseller = reseller
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(RemainingCreditModel, 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, RemainingCreditModel):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(child=None, reseller=None)
|
59,816 |
sib_api_v3_sdk.models.remaining_credit_model
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, RemainingCreditModel):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,817 |
sib_api_v3_sdk.models.remaining_credit_model
|
__init__
|
RemainingCreditModel - a model defined in Swagger
|
def __init__(self, child=None, reseller=None): # noqa: E501
"""RemainingCreditModel - a model defined in Swagger""" # noqa: E501
self._child = None
self._reseller = None
self.discriminator = None
self.child = child
self.reseller = reseller
|
(self, child=None, reseller=None)
|
59,820 |
sib_api_v3_sdk.models.remaining_credit_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(RemainingCreditModel, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,822 |
sib_api_v3_sdk.models.remaining_credit_model_child
|
RemainingCreditModelChild
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class RemainingCreditModelChild(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 = {
'sms': 'float',
'email': 'float'
}
attribute_map = {
'sms': 'sms',
'email': 'email'
}
def __init__(self, sms=None, email=None): # noqa: E501
"""RemainingCreditModelChild - a model defined in Swagger""" # noqa: E501
self._sms = None
self._email = None
self.discriminator = None
self.sms = sms
self.email = email
@property
def sms(self):
"""Gets the sms of this RemainingCreditModelChild. # noqa: E501
SMS Credits remaining for child account # noqa: E501
:return: The sms of this RemainingCreditModelChild. # noqa: E501
:rtype: float
"""
return self._sms
@sms.setter
def sms(self, sms):
"""Sets the sms of this RemainingCreditModelChild.
SMS Credits remaining for child account # noqa: E501
:param sms: The sms of this RemainingCreditModelChild. # noqa: E501
:type: float
"""
if sms is None:
raise ValueError("Invalid value for `sms`, must not be `None`") # noqa: E501
self._sms = sms
@property
def email(self):
"""Gets the email of this RemainingCreditModelChild. # noqa: E501
Email Credits remaining for child account # noqa: E501
:return: The email of this RemainingCreditModelChild. # noqa: E501
:rtype: float
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this RemainingCreditModelChild.
Email Credits remaining for child account # noqa: E501
:param email: The email of this RemainingCreditModelChild. # noqa: E501
:type: float
"""
if email is None:
raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501
self._email = email
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(RemainingCreditModelChild, 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, RemainingCreditModelChild):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(sms=None, email=None)
|
59,823 |
sib_api_v3_sdk.models.remaining_credit_model_child
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, RemainingCreditModelChild):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,824 |
sib_api_v3_sdk.models.remaining_credit_model_child
|
__init__
|
RemainingCreditModelChild - a model defined in Swagger
|
def __init__(self, sms=None, email=None): # noqa: E501
"""RemainingCreditModelChild - a model defined in Swagger""" # noqa: E501
self._sms = None
self._email = None
self.discriminator = None
self.sms = sms
self.email = email
|
(self, sms=None, email=None)
|
59,827 |
sib_api_v3_sdk.models.remaining_credit_model_child
|
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(RemainingCreditModelChild, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,829 |
sib_api_v3_sdk.models.remaining_credit_model_reseller
|
RemainingCreditModelReseller
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class RemainingCreditModelReseller(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 = {
'sms': 'float',
'email': 'float'
}
attribute_map = {
'sms': 'sms',
'email': 'email'
}
def __init__(self, sms=None, email=None): # noqa: E501
"""RemainingCreditModelReseller - a model defined in Swagger""" # noqa: E501
self._sms = None
self._email = None
self.discriminator = None
self.sms = sms
self.email = email
@property
def sms(self):
"""Gets the sms of this RemainingCreditModelReseller. # noqa: E501
SMS Credits remaining for reseller account # noqa: E501
:return: The sms of this RemainingCreditModelReseller. # noqa: E501
:rtype: float
"""
return self._sms
@sms.setter
def sms(self, sms):
"""Sets the sms of this RemainingCreditModelReseller.
SMS Credits remaining for reseller account # noqa: E501
:param sms: The sms of this RemainingCreditModelReseller. # noqa: E501
:type: float
"""
if sms is None:
raise ValueError("Invalid value for `sms`, must not be `None`") # noqa: E501
self._sms = sms
@property
def email(self):
"""Gets the email of this RemainingCreditModelReseller. # noqa: E501
Email Credits remaining for reseller account # noqa: E501
:return: The email of this RemainingCreditModelReseller. # noqa: E501
:rtype: float
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this RemainingCreditModelReseller.
Email Credits remaining for reseller account # noqa: E501
:param email: The email of this RemainingCreditModelReseller. # noqa: E501
:type: float
"""
if email is None:
raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501
self._email = email
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(RemainingCreditModelReseller, 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, RemainingCreditModelReseller):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(sms=None, email=None)
|
59,830 |
sib_api_v3_sdk.models.remaining_credit_model_reseller
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, RemainingCreditModelReseller):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,831 |
sib_api_v3_sdk.models.remaining_credit_model_reseller
|
__init__
|
RemainingCreditModelReseller - a model defined in Swagger
|
def __init__(self, sms=None, email=None): # noqa: E501
"""RemainingCreditModelReseller - a model defined in Swagger""" # noqa: E501
self._sms = None
self._email = None
self.discriminator = None
self.sms = sms
self.email = email
|
(self, sms=None, email=None)
|
59,834 |
sib_api_v3_sdk.models.remaining_credit_model_reseller
|
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(RemainingCreditModelReseller, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,836 |
sib_api_v3_sdk.models.remove_contact_from_list
|
RemoveContactFromList
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class RemoveContactFromList(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 = {
'emails': 'list[str]',
'ids': 'list[int]',
'all': 'bool'
}
attribute_map = {
'emails': 'emails',
'ids': 'ids',
'all': 'all'
}
def __init__(self, emails=None, ids=None, all=None): # noqa: E501
"""RemoveContactFromList - a model defined in Swagger""" # noqa: E501
self._emails = None
self._ids = None
self._all = None
self.discriminator = None
if emails is not None:
self.emails = emails
if ids is not None:
self.ids = ids
if all is not None:
self.all = all
@property
def emails(self):
"""Gets the emails of this RemoveContactFromList. # noqa: E501
Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. # noqa: E501
:return: The emails of this RemoveContactFromList. # noqa: E501
:rtype: list[str]
"""
return self._emails
@emails.setter
def emails(self, emails):
"""Sets the emails of this RemoveContactFromList.
Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. # noqa: E501
:param emails: The emails of this RemoveContactFromList. # noqa: E501
:type: list[str]
"""
self._emails = emails
@property
def ids(self):
"""Gets the ids of this RemoveContactFromList. # noqa: E501
Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. # noqa: E501
:return: The ids of this RemoveContactFromList. # noqa: E501
:rtype: list[int]
"""
return self._ids
@ids.setter
def ids(self, ids):
"""Sets the ids of this RemoveContactFromList.
Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. # noqa: E501
:param ids: The ids of this RemoveContactFromList. # noqa: E501
:type: list[int]
"""
self._ids = ids
@property
def all(self):
"""Gets the all of this RemoveContactFromList. # noqa: E501
Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress # noqa: E501
:return: The all of this RemoveContactFromList. # noqa: E501
:rtype: bool
"""
return self._all
@all.setter
def all(self, all):
"""Sets the all of this RemoveContactFromList.
Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress # noqa: E501
:param all: The all of this RemoveContactFromList. # noqa: E501
:type: bool
"""
self._all = all
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(RemoveContactFromList, 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, RemoveContactFromList):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(emails=None, ids=None, all=None)
|
59,837 |
sib_api_v3_sdk.models.remove_contact_from_list
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, RemoveContactFromList):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,838 |
sib_api_v3_sdk.models.remove_contact_from_list
|
__init__
|
RemoveContactFromList - a model defined in Swagger
|
def __init__(self, emails=None, ids=None, all=None): # noqa: E501
"""RemoveContactFromList - a model defined in Swagger""" # noqa: E501
self._emails = None
self._ids = None
self._all = None
self.discriminator = None
if emails is not None:
self.emails = emails
if ids is not None:
self.ids = ids
if all is not None:
self.all = all
|
(self, emails=None, ids=None, all=None)
|
59,841 |
sib_api_v3_sdk.models.remove_contact_from_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(RemoveContactFromList, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,843 |
sib_api_v3_sdk.models.remove_credits
|
RemoveCredits
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class RemoveCredits(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 = {
'sms': 'int',
'email': 'int'
}
attribute_map = {
'sms': 'sms',
'email': 'email'
}
def __init__(self, sms=None, email=None): # noqa: E501
"""RemoveCredits - a model defined in Swagger""" # noqa: E501
self._sms = None
self._email = None
self.discriminator = None
if sms is not None:
self.sms = sms
if email is not None:
self.email = email
@property
def sms(self):
"""Gets the sms of this RemoveCredits. # noqa: E501
Required if email credits are empty. SMS credits to be removed from the child account # noqa: E501
:return: The sms of this RemoveCredits. # noqa: E501
:rtype: int
"""
return self._sms
@sms.setter
def sms(self, sms):
"""Sets the sms of this RemoveCredits.
Required if email credits are empty. SMS credits to be removed from the child account # noqa: E501
:param sms: The sms of this RemoveCredits. # noqa: E501
:type: int
"""
self._sms = sms
@property
def email(self):
"""Gets the email of this RemoveCredits. # noqa: E501
Required if sms credits are empty. Email credits to be removed from the child account # noqa: E501
:return: The email of this RemoveCredits. # noqa: E501
:rtype: int
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this RemoveCredits.
Required if sms credits are empty. Email credits to be removed from the child account # noqa: E501
:param email: The email of this RemoveCredits. # noqa: E501
:type: int
"""
self._email = email
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(RemoveCredits, 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, RemoveCredits):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(sms=None, email=None)
|
59,844 |
sib_api_v3_sdk.models.remove_credits
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, RemoveCredits):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,845 |
sib_api_v3_sdk.models.remove_credits
|
__init__
|
RemoveCredits - a model defined in Swagger
|
def __init__(self, sms=None, email=None): # noqa: E501
"""RemoveCredits - a model defined in Swagger""" # noqa: E501
self._sms = None
self._email = None
self.discriminator = None
if sms is not None:
self.sms = sms
if email is not None:
self.email = email
|
(self, sms=None, email=None)
|
59,848 |
sib_api_v3_sdk.models.remove_credits
|
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(RemoveCredits, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,850 |
sib_api_v3_sdk.models.request_contact_export
|
RequestContactExport
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class RequestContactExport(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 = {
'export_attributes': 'list[str]',
'custom_contact_filter': 'RequestContactExportCustomContactFilter',
'notify_url': 'str'
}
attribute_map = {
'export_attributes': 'exportAttributes',
'custom_contact_filter': 'customContactFilter',
'notify_url': 'notifyUrl'
}
def __init__(self, export_attributes=None, custom_contact_filter=None, notify_url=None): # noqa: E501
"""RequestContactExport - a model defined in Swagger""" # noqa: E501
self._export_attributes = None
self._custom_contact_filter = None
self._notify_url = None
self.discriminator = None
if export_attributes is not None:
self.export_attributes = export_attributes
self.custom_contact_filter = custom_contact_filter
if notify_url is not None:
self.notify_url = notify_url
@property
def export_attributes(self):
"""Gets the export_attributes of this RequestContactExport. # noqa: E501
List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. # noqa: E501
:return: The export_attributes of this RequestContactExport. # noqa: E501
:rtype: list[str]
"""
return self._export_attributes
@export_attributes.setter
def export_attributes(self, export_attributes):
"""Sets the export_attributes of this RequestContactExport.
List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. # noqa: E501
:param export_attributes: The export_attributes of this RequestContactExport. # noqa: E501
:type: list[str]
"""
self._export_attributes = export_attributes
@property
def custom_contact_filter(self):
"""Gets the custom_contact_filter of this RequestContactExport. # noqa: E501
:return: The custom_contact_filter of this RequestContactExport. # noqa: E501
:rtype: RequestContactExportCustomContactFilter
"""
return self._custom_contact_filter
@custom_contact_filter.setter
def custom_contact_filter(self, custom_contact_filter):
"""Sets the custom_contact_filter of this RequestContactExport.
:param custom_contact_filter: The custom_contact_filter of this RequestContactExport. # noqa: E501
:type: RequestContactExportCustomContactFilter
"""
if custom_contact_filter is None:
raise ValueError("Invalid value for `custom_contact_filter`, must not be `None`") # noqa: E501
self._custom_contact_filter = custom_contact_filter
@property
def notify_url(self):
"""Gets the notify_url of this RequestContactExport. # noqa: E501
Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501
:return: The notify_url of this RequestContactExport. # noqa: E501
:rtype: str
"""
return self._notify_url
@notify_url.setter
def notify_url(self, notify_url):
"""Sets the notify_url of this RequestContactExport.
Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501
:param notify_url: The notify_url of this RequestContactExport. # noqa: E501
:type: str
"""
self._notify_url = notify_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(RequestContactExport, 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, RequestContactExport):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(export_attributes=None, custom_contact_filter=None, notify_url=None)
|
59,851 |
sib_api_v3_sdk.models.request_contact_export
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, RequestContactExport):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,852 |
sib_api_v3_sdk.models.request_contact_export
|
__init__
|
RequestContactExport - a model defined in Swagger
|
def __init__(self, export_attributes=None, custom_contact_filter=None, notify_url=None): # noqa: E501
"""RequestContactExport - a model defined in Swagger""" # noqa: E501
self._export_attributes = None
self._custom_contact_filter = None
self._notify_url = None
self.discriminator = None
if export_attributes is not None:
self.export_attributes = export_attributes
self.custom_contact_filter = custom_contact_filter
if notify_url is not None:
self.notify_url = notify_url
|
(self, export_attributes=None, custom_contact_filter=None, notify_url=None)
|
59,855 |
sib_api_v3_sdk.models.request_contact_export
|
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(RequestContactExport, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,857 |
sib_api_v3_sdk.models.request_contact_export_custom_contact_filter
|
RequestContactExportCustomContactFilter
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class RequestContactExportCustomContactFilter(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 = {
'action_for_contacts': 'str',
'action_for_email_campaigns': 'str',
'action_for_sms_campaigns': 'str',
'list_id': 'int',
'email_campaign_id': 'int',
'sms_campaign_id': 'int'
}
attribute_map = {
'action_for_contacts': 'actionForContacts',
'action_for_email_campaigns': 'actionForEmailCampaigns',
'action_for_sms_campaigns': 'actionForSmsCampaigns',
'list_id': 'listId',
'email_campaign_id': 'emailCampaignId',
'sms_campaign_id': 'smsCampaignId'
}
def __init__(self, action_for_contacts=None, action_for_email_campaigns=None, action_for_sms_campaigns=None, list_id=None, email_campaign_id=None, sms_campaign_id=None): # noqa: E501
"""RequestContactExportCustomContactFilter - a model defined in Swagger""" # noqa: E501
self._action_for_contacts = None
self._action_for_email_campaigns = None
self._action_for_sms_campaigns = None
self._list_id = None
self._email_campaign_id = None
self._sms_campaign_id = None
self.discriminator = None
if action_for_contacts is not None:
self.action_for_contacts = action_for_contacts
if action_for_email_campaigns is not None:
self.action_for_email_campaigns = action_for_email_campaigns
if action_for_sms_campaigns is not None:
self.action_for_sms_campaigns = action_for_sms_campaigns
if list_id is not None:
self.list_id = list_id
if email_campaign_id is not None:
self.email_campaign_id = email_campaign_id
if sms_campaign_id is not None:
self.sms_campaign_id = sms_campaign_id
@property
def action_for_contacts(self):
"""Gets the action_for_contacts of this RequestContactExportCustomContactFilter. # noqa: E501
Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only. # noqa: E501
:return: The action_for_contacts of this RequestContactExportCustomContactFilter. # noqa: E501
:rtype: str
"""
return self._action_for_contacts
@action_for_contacts.setter
def action_for_contacts(self, action_for_contacts):
"""Sets the action_for_contacts of this RequestContactExportCustomContactFilter.
Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only. # noqa: E501
:param action_for_contacts: The action_for_contacts of this RequestContactExportCustomContactFilter. # noqa: E501
:type: str
"""
allowed_values = ["allContacts", "subscribed", "unsubscribed", "unsubscribedPerList"] # noqa: E501
if action_for_contacts not in allowed_values:
raise ValueError(
"Invalid value for `action_for_contacts` ({0}), must be one of {1}" # noqa: E501
.format(action_for_contacts, allowed_values)
)
self._action_for_contacts = action_for_contacts
@property
def action_for_email_campaigns(self):
"""Gets the action_for_email_campaigns of this RequestContactExportCustomContactFilter. # noqa: E501
Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). # noqa: E501
:return: The action_for_email_campaigns of this RequestContactExportCustomContactFilter. # noqa: E501
:rtype: str
"""
return self._action_for_email_campaigns
@action_for_email_campaigns.setter
def action_for_email_campaigns(self, action_for_email_campaigns):
"""Sets the action_for_email_campaigns of this RequestContactExportCustomContactFilter.
Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). # noqa: E501
:param action_for_email_campaigns: The action_for_email_campaigns of this RequestContactExportCustomContactFilter. # noqa: E501
:type: str
"""
allowed_values = ["openers", "nonOpeners", "clickers", "nonClickers", "unsubscribed", "hardBounces", "softBounces"] # noqa: E501
if action_for_email_campaigns not in allowed_values:
raise ValueError(
"Invalid value for `action_for_email_campaigns` ({0}), must be one of {1}" # noqa: E501
.format(action_for_email_campaigns, allowed_values)
)
self._action_for_email_campaigns = action_for_email_campaigns
@property
def action_for_sms_campaigns(self):
"""Gets the action_for_sms_campaigns of this RequestContactExportCustomContactFilter. # noqa: E501
Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. # noqa: E501
:return: The action_for_sms_campaigns of this RequestContactExportCustomContactFilter. # noqa: E501
:rtype: str
"""
return self._action_for_sms_campaigns
@action_for_sms_campaigns.setter
def action_for_sms_campaigns(self, action_for_sms_campaigns):
"""Sets the action_for_sms_campaigns of this RequestContactExportCustomContactFilter.
Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. # noqa: E501
:param action_for_sms_campaigns: The action_for_sms_campaigns of this RequestContactExportCustomContactFilter. # noqa: E501
:type: str
"""
allowed_values = ["hardBounces", "softBounces", "unsubscribed"] # noqa: E501
if action_for_sms_campaigns not in allowed_values:
raise ValueError(
"Invalid value for `action_for_sms_campaigns` ({0}), must be one of {1}" # noqa: E501
.format(action_for_sms_campaigns, allowed_values)
)
self._action_for_sms_campaigns = action_for_sms_campaigns
@property
def list_id(self):
"""Gets the list_id of this RequestContactExportCustomContactFilter. # noqa: E501
Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter. # noqa: E501
:return: The list_id of this RequestContactExportCustomContactFilter. # noqa: E501
:rtype: int
"""
return self._list_id
@list_id.setter
def list_id(self, list_id):
"""Sets the list_id of this RequestContactExportCustomContactFilter.
Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter. # noqa: E501
:param list_id: The list_id of this RequestContactExportCustomContactFilter. # noqa: E501
:type: int
"""
self._list_id = list_id
@property
def email_campaign_id(self):
"""Gets the email_campaign_id of this RequestContactExportCustomContactFilter. # noqa: E501
Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter. # noqa: E501
:return: The email_campaign_id of this RequestContactExportCustomContactFilter. # noqa: E501
:rtype: int
"""
return self._email_campaign_id
@email_campaign_id.setter
def email_campaign_id(self, email_campaign_id):
"""Sets the email_campaign_id of this RequestContactExportCustomContactFilter.
Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter. # noqa: E501
:param email_campaign_id: The email_campaign_id of this RequestContactExportCustomContactFilter. # noqa: E501
:type: int
"""
self._email_campaign_id = email_campaign_id
@property
def sms_campaign_id(self):
"""Gets the sms_campaign_id of this RequestContactExportCustomContactFilter. # noqa: E501
Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. # noqa: E501
:return: The sms_campaign_id of this RequestContactExportCustomContactFilter. # noqa: E501
:rtype: int
"""
return self._sms_campaign_id
@sms_campaign_id.setter
def sms_campaign_id(self, sms_campaign_id):
"""Sets the sms_campaign_id of this RequestContactExportCustomContactFilter.
Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. # noqa: E501
:param sms_campaign_id: The sms_campaign_id of this RequestContactExportCustomContactFilter. # noqa: E501
:type: int
"""
self._sms_campaign_id = sms_campaign_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(RequestContactExportCustomContactFilter, 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, RequestContactExportCustomContactFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(action_for_contacts=None, action_for_email_campaigns=None, action_for_sms_campaigns=None, list_id=None, email_campaign_id=None, sms_campaign_id=None)
|
59,858 |
sib_api_v3_sdk.models.request_contact_export_custom_contact_filter
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, RequestContactExportCustomContactFilter):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,859 |
sib_api_v3_sdk.models.request_contact_export_custom_contact_filter
|
__init__
|
RequestContactExportCustomContactFilter - a model defined in Swagger
|
def __init__(self, action_for_contacts=None, action_for_email_campaigns=None, action_for_sms_campaigns=None, list_id=None, email_campaign_id=None, sms_campaign_id=None): # noqa: E501
"""RequestContactExportCustomContactFilter - a model defined in Swagger""" # noqa: E501
self._action_for_contacts = None
self._action_for_email_campaigns = None
self._action_for_sms_campaigns = None
self._list_id = None
self._email_campaign_id = None
self._sms_campaign_id = None
self.discriminator = None
if action_for_contacts is not None:
self.action_for_contacts = action_for_contacts
if action_for_email_campaigns is not None:
self.action_for_email_campaigns = action_for_email_campaigns
if action_for_sms_campaigns is not None:
self.action_for_sms_campaigns = action_for_sms_campaigns
if list_id is not None:
self.list_id = list_id
if email_campaign_id is not None:
self.email_campaign_id = email_campaign_id
if sms_campaign_id is not None:
self.sms_campaign_id = sms_campaign_id
|
(self, action_for_contacts=None, action_for_email_campaigns=None, action_for_sms_campaigns=None, list_id=None, email_campaign_id=None, sms_campaign_id=None)
|
59,862 |
sib_api_v3_sdk.models.request_contact_export_custom_contact_filter
|
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(RequestContactExportCustomContactFilter, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,864 |
sib_api_v3_sdk.models.request_contact_import
|
RequestContactImport
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class RequestContactImport(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 = {
'file_url': 'str',
'file_body': 'str',
'json_body': 'list[dict(str, object)]',
'list_ids': 'list[int]',
'notify_url': 'str',
'new_list': 'RequestContactImportNewList',
'email_blacklist': 'bool',
'sms_blacklist': 'bool',
'update_existing_contacts': 'bool',
'empty_contacts_attributes': 'bool'
}
attribute_map = {
'file_url': 'fileUrl',
'file_body': 'fileBody',
'json_body': 'jsonBody',
'list_ids': 'listIds',
'notify_url': 'notifyUrl',
'new_list': 'newList',
'email_blacklist': 'emailBlacklist',
'sms_blacklist': 'smsBlacklist',
'update_existing_contacts': 'updateExistingContacts',
'empty_contacts_attributes': 'emptyContactsAttributes'
}
def __init__(self, file_url=None, file_body=None, json_body=None, list_ids=None, notify_url=None, new_list=None, email_blacklist=False, sms_blacklist=False, update_existing_contacts=True, empty_contacts_attributes=False): # noqa: E501
"""RequestContactImport - a model defined in Swagger""" # noqa: E501
self._file_url = None
self._file_body = None
self._json_body = None
self._list_ids = None
self._notify_url = None
self._new_list = None
self._email_blacklist = None
self._sms_blacklist = None
self._update_existing_contacts = None
self._empty_contacts_attributes = None
self.discriminator = None
if file_url is not None:
self.file_url = file_url
if file_body is not None:
self.file_body = file_body
if json_body is not None:
self.json_body = json_body
if list_ids is not None:
self.list_ids = list_ids
if notify_url is not None:
self.notify_url = notify_url
if new_list is not None:
self.new_list = new_list
if email_blacklist is not None:
self.email_blacklist = email_blacklist
if sms_blacklist is not None:
self.sms_blacklist = sms_blacklist
if update_existing_contacts is not None:
self.update_existing_contacts = update_existing_contacts
if empty_contacts_attributes is not None:
self.empty_contacts_attributes = empty_contacts_attributes
@property
def file_url(self):
"""Gets the file_url of this RequestContactImport. # noqa: E501
Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json # noqa: E501
:return: The file_url of this RequestContactImport. # noqa: E501
:rtype: str
"""
return self._file_url
@file_url.setter
def file_url(self, file_url):
"""Sets the file_url of this RequestContactImport.
Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json # noqa: E501
:param file_url: The file_url of this RequestContactImport. # noqa: E501
:type: str
"""
self._file_url = file_url
@property
def file_body(self):
"""Gets the file_body of this RequestContactImport. # noqa: E501
Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. # noqa: E501
:return: The file_body of this RequestContactImport. # noqa: E501
:rtype: str
"""
return self._file_body
@file_body.setter
def file_body(self, file_body):
"""Sets the file_body of this RequestContactImport.
Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. # noqa: E501
:param file_body: The file_body of this RequestContactImport. # noqa: E501
:type: str
"""
self._file_body = file_body
@property
def json_body(self):
"""Gets the json_body of this RequestContactImport. # noqa: E501
**Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. # noqa: E501
:return: The json_body of this RequestContactImport. # noqa: E501
:rtype: list[dict(str, object)]
"""
return self._json_body
@json_body.setter
def json_body(self, json_body):
"""Sets the json_body of this RequestContactImport.
**Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. # noqa: E501
:param json_body: The json_body of this RequestContactImport. # noqa: E501
:type: list[dict(str, object)]
"""
self._json_body = json_body
@property
def list_ids(self):
"""Gets the list_ids of this RequestContactImport. # noqa: E501
Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. # noqa: E501
:return: The list_ids of this RequestContactImport. # noqa: E501
:rtype: list[int]
"""
return self._list_ids
@list_ids.setter
def list_ids(self, list_ids):
"""Sets the list_ids of this RequestContactImport.
Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. # noqa: E501
:param list_ids: The list_ids of this RequestContactImport. # noqa: E501
:type: list[int]
"""
self._list_ids = list_ids
@property
def notify_url(self):
"""Gets the notify_url of this RequestContactImport. # noqa: E501
URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501
:return: The notify_url of this RequestContactImport. # noqa: E501
:rtype: str
"""
return self._notify_url
@notify_url.setter
def notify_url(self, notify_url):
"""Sets the notify_url of this RequestContactImport.
URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501
:param notify_url: The notify_url of this RequestContactImport. # noqa: E501
:type: str
"""
self._notify_url = notify_url
@property
def new_list(self):
"""Gets the new_list of this RequestContactImport. # noqa: E501
:return: The new_list of this RequestContactImport. # noqa: E501
:rtype: RequestContactImportNewList
"""
return self._new_list
@new_list.setter
def new_list(self, new_list):
"""Sets the new_list of this RequestContactImport.
:param new_list: The new_list of this RequestContactImport. # noqa: E501
:type: RequestContactImportNewList
"""
self._new_list = new_list
@property
def email_blacklist(self):
"""Gets the email_blacklist of this RequestContactImport. # noqa: E501
To blacklist all the contacts for email # noqa: E501
:return: The email_blacklist of this RequestContactImport. # noqa: E501
:rtype: bool
"""
return self._email_blacklist
@email_blacklist.setter
def email_blacklist(self, email_blacklist):
"""Sets the email_blacklist of this RequestContactImport.
To blacklist all the contacts for email # noqa: E501
:param email_blacklist: The email_blacklist of this RequestContactImport. # noqa: E501
:type: bool
"""
self._email_blacklist = email_blacklist
@property
def sms_blacklist(self):
"""Gets the sms_blacklist of this RequestContactImport. # noqa: E501
To blacklist all the contacts for sms # noqa: E501
:return: The sms_blacklist of this RequestContactImport. # noqa: E501
:rtype: bool
"""
return self._sms_blacklist
@sms_blacklist.setter
def sms_blacklist(self, sms_blacklist):
"""Sets the sms_blacklist of this RequestContactImport.
To blacklist all the contacts for sms # noqa: E501
:param sms_blacklist: The sms_blacklist of this RequestContactImport. # noqa: E501
:type: bool
"""
self._sms_blacklist = sms_blacklist
@property
def update_existing_contacts(self):
"""Gets the update_existing_contacts of this RequestContactImport. # noqa: E501
To facilitate the choice to update the existing contacts # noqa: E501
:return: The update_existing_contacts of this RequestContactImport. # noqa: E501
:rtype: bool
"""
return self._update_existing_contacts
@update_existing_contacts.setter
def update_existing_contacts(self, update_existing_contacts):
"""Sets the update_existing_contacts of this RequestContactImport.
To facilitate the choice to update the existing contacts # noqa: E501
:param update_existing_contacts: The update_existing_contacts of this RequestContactImport. # noqa: E501
:type: bool
"""
self._update_existing_contacts = update_existing_contacts
@property
def empty_contacts_attributes(self):
"""Gets the empty_contacts_attributes of this RequestContactImport. # noqa: E501
To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in SendinBlue, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true ) # noqa: E501
:return: The empty_contacts_attributes of this RequestContactImport. # noqa: E501
:rtype: bool
"""
return self._empty_contacts_attributes
@empty_contacts_attributes.setter
def empty_contacts_attributes(self, empty_contacts_attributes):
"""Sets the empty_contacts_attributes of this RequestContactImport.
To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in SendinBlue, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true ) # noqa: E501
:param empty_contacts_attributes: The empty_contacts_attributes of this RequestContactImport. # noqa: E501
:type: bool
"""
self._empty_contacts_attributes = empty_contacts_attributes
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(RequestContactImport, 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, RequestContactImport):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(file_url=None, file_body=None, json_body=None, list_ids=None, notify_url=None, new_list=None, email_blacklist=False, sms_blacklist=False, update_existing_contacts=True, empty_contacts_attributes=False)
|
59,865 |
sib_api_v3_sdk.models.request_contact_import
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, RequestContactImport):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,866 |
sib_api_v3_sdk.models.request_contact_import
|
__init__
|
RequestContactImport - a model defined in Swagger
|
def __init__(self, file_url=None, file_body=None, json_body=None, list_ids=None, notify_url=None, new_list=None, email_blacklist=False, sms_blacklist=False, update_existing_contacts=True, empty_contacts_attributes=False): # noqa: E501
"""RequestContactImport - a model defined in Swagger""" # noqa: E501
self._file_url = None
self._file_body = None
self._json_body = None
self._list_ids = None
self._notify_url = None
self._new_list = None
self._email_blacklist = None
self._sms_blacklist = None
self._update_existing_contacts = None
self._empty_contacts_attributes = None
self.discriminator = None
if file_url is not None:
self.file_url = file_url
if file_body is not None:
self.file_body = file_body
if json_body is not None:
self.json_body = json_body
if list_ids is not None:
self.list_ids = list_ids
if notify_url is not None:
self.notify_url = notify_url
if new_list is not None:
self.new_list = new_list
if email_blacklist is not None:
self.email_blacklist = email_blacklist
if sms_blacklist is not None:
self.sms_blacklist = sms_blacklist
if update_existing_contacts is not None:
self.update_existing_contacts = update_existing_contacts
if empty_contacts_attributes is not None:
self.empty_contacts_attributes = empty_contacts_attributes
|
(self, file_url=None, file_body=None, json_body=None, list_ids=None, notify_url=None, new_list=None, email_blacklist=False, sms_blacklist=False, update_existing_contacts=True, empty_contacts_attributes=False)
|
59,869 |
sib_api_v3_sdk.models.request_contact_import
|
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(RequestContactImport, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,871 |
sib_api_v3_sdk.models.request_contact_import_new_list
|
RequestContactImportNewList
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class RequestContactImportNewList(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 = {
'list_name': 'str',
'folder_id': 'int'
}
attribute_map = {
'list_name': 'listName',
'folder_id': 'folderId'
}
def __init__(self, list_name=None, folder_id=None): # noqa: E501
"""RequestContactImportNewList - a model defined in Swagger""" # noqa: E501
self._list_name = None
self._folder_id = None
self.discriminator = None
if list_name is not None:
self.list_name = list_name
if folder_id is not None:
self.folder_id = folder_id
@property
def list_name(self):
"""Gets the list_name of this RequestContactImportNewList. # noqa: E501
List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). # noqa: E501
:return: The list_name of this RequestContactImportNewList. # noqa: E501
:rtype: str
"""
return self._list_name
@list_name.setter
def list_name(self, list_name):
"""Sets the list_name of this RequestContactImportNewList.
List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). # noqa: E501
:param list_name: The list_name of this RequestContactImportNewList. # noqa: E501
:type: str
"""
self._list_name = list_name
@property
def folder_id(self):
"""Gets the folder_id of this RequestContactImportNewList. # noqa: E501
Id of the folder where this new list shall be created (Mandatory if listName is not empty). # noqa: E501
:return: The folder_id of this RequestContactImportNewList. # noqa: E501
:rtype: int
"""
return self._folder_id
@folder_id.setter
def folder_id(self, folder_id):
"""Sets the folder_id of this RequestContactImportNewList.
Id of the folder where this new list shall be created (Mandatory if listName is not empty). # noqa: E501
:param folder_id: The folder_id of this RequestContactImportNewList. # 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(RequestContactImportNewList, 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, RequestContactImportNewList):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(list_name=None, folder_id=None)
|
59,872 |
sib_api_v3_sdk.models.request_contact_import_new_list
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, RequestContactImportNewList):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,873 |
sib_api_v3_sdk.models.request_contact_import_new_list
|
__init__
|
RequestContactImportNewList - a model defined in Swagger
|
def __init__(self, list_name=None, folder_id=None): # noqa: E501
"""RequestContactImportNewList - a model defined in Swagger""" # noqa: E501
self._list_name = None
self._folder_id = None
self.discriminator = None
if list_name is not None:
self.list_name = list_name
if folder_id is not None:
self.folder_id = folder_id
|
(self, list_name=None, folder_id=None)
|
59,876 |
sib_api_v3_sdk.models.request_contact_import_new_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(RequestContactImportNewList, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,878 |
sib_api_v3_sdk.models.request_sms_recipient_export
|
RequestSmsRecipientExport
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class RequestSmsRecipientExport(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 = {
'notify_url': 'str',
'recipients_type': 'str'
}
attribute_map = {
'notify_url': 'notifyURL',
'recipients_type': 'recipientsType'
}
def __init__(self, notify_url=None, recipients_type=None): # noqa: E501
"""RequestSmsRecipientExport - a model defined in Swagger""" # noqa: E501
self._notify_url = None
self._recipients_type = None
self.discriminator = None
if notify_url is not None:
self.notify_url = notify_url
self.recipients_type = recipients_type
@property
def notify_url(self):
"""Gets the notify_url of this RequestSmsRecipientExport. # noqa: E501
URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501
:return: The notify_url of this RequestSmsRecipientExport. # noqa: E501
:rtype: str
"""
return self._notify_url
@notify_url.setter
def notify_url(self, notify_url):
"""Sets the notify_url of this RequestSmsRecipientExport.
URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 # noqa: E501
:param notify_url: The notify_url of this RequestSmsRecipientExport. # noqa: E501
:type: str
"""
self._notify_url = notify_url
@property
def recipients_type(self):
"""Gets the recipients_type of this RequestSmsRecipientExport. # noqa: E501
Filter the recipients based on how they interacted with the campaign # noqa: E501
:return: The recipients_type of this RequestSmsRecipientExport. # noqa: E501
:rtype: str
"""
return self._recipients_type
@recipients_type.setter
def recipients_type(self, recipients_type):
"""Sets the recipients_type of this RequestSmsRecipientExport.
Filter the recipients based on how they interacted with the campaign # noqa: E501
:param recipients_type: The recipients_type of this RequestSmsRecipientExport. # noqa: E501
:type: str
"""
if recipients_type is None:
raise ValueError("Invalid value for `recipients_type`, must not be `None`") # noqa: E501
allowed_values = ["all", "delivered", "answered", "softBounces", "hardBounces", "unsubscribed"] # noqa: E501
if recipients_type not in allowed_values:
raise ValueError(
"Invalid value for `recipients_type` ({0}), must be one of {1}" # noqa: E501
.format(recipients_type, allowed_values)
)
self._recipients_type = recipients_type
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(RequestSmsRecipientExport, 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, RequestSmsRecipientExport):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(notify_url=None, recipients_type=None)
|
59,879 |
sib_api_v3_sdk.models.request_sms_recipient_export
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, RequestSmsRecipientExport):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,880 |
sib_api_v3_sdk.models.request_sms_recipient_export
|
__init__
|
RequestSmsRecipientExport - a model defined in Swagger
|
def __init__(self, notify_url=None, recipients_type=None): # noqa: E501
"""RequestSmsRecipientExport - a model defined in Swagger""" # noqa: E501
self._notify_url = None
self._recipients_type = None
self.discriminator = None
if notify_url is not None:
self.notify_url = notify_url
self.recipients_type = recipients_type
|
(self, notify_url=None, recipients_type=None)
|
59,883 |
sib_api_v3_sdk.models.request_sms_recipient_export
|
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(RequestSmsRecipientExport, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,885 |
sib_api_v3_sdk.api.reseller_api
|
ResellerApi
|
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 ResellerApi(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 add_credits(self, child_identifier, add_credits, **kwargs): # noqa: E501
"""Add Email and/or SMS credits to a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_credits(child_identifier, add_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddCredits add_credits: Values to post to add credit to a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.add_credits_with_http_info(child_identifier, add_credits, **kwargs) # noqa: E501
else:
(data) = self.add_credits_with_http_info(child_identifier, add_credits, **kwargs) # noqa: E501
return data
def add_credits_with_http_info(self, child_identifier, add_credits, **kwargs): # noqa: E501
"""Add Email and/or SMS credits to a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_credits_with_http_info(child_identifier, add_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddCredits add_credits: Values to post to add credit to a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'add_credits'] # 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 add_credits" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `add_credits`") # noqa: E501
# verify the required parameter 'add_credits' is set
if ('add_credits' not in params or
params['add_credits'] is None):
raise ValueError("Missing the required parameter `add_credits` when calling `add_credits`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'add_credits' in params:
body_params = params['add_credits']
# 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(
'/reseller/children/{childIdentifier}/credits/add', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='RemainingCreditModel', # 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 associate_ip_to_child(self, child_identifier, ip, **kwargs): # noqa: E501
"""Associate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.associate_ip_to_child(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to associate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.associate_ip_to_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501
else:
(data) = self.associate_ip_to_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501
return data
def associate_ip_to_child_with_http_info(self, child_identifier, ip, **kwargs): # noqa: E501
"""Associate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.associate_ip_to_child_with_http_info(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to associate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'ip'] # 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 associate_ip_to_child" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `associate_ip_to_child`") # noqa: E501
# verify the required parameter 'ip' is set
if ('ip' not in params or
params['ip'] is None):
raise ValueError("Missing the required parameter `ip` when calling `associate_ip_to_child`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'ip' in params:
body_params = params['ip']
# 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(
'/reseller/children/{childIdentifier}/ips/associate', 'POST',
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 create_child_domain(self, child_identifier, add_child_domain, **kwargs): # noqa: E501
"""Create a domain for a child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_child_domain(child_identifier, add_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddChildDomain add_child_domain: Sender domain to add for a specific child account. This will not be displayed to the parent account. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.create_child_domain_with_http_info(child_identifier, add_child_domain, **kwargs) # noqa: E501
else:
(data) = self.create_child_domain_with_http_info(child_identifier, add_child_domain, **kwargs) # noqa: E501
return data
def create_child_domain_with_http_info(self, child_identifier, add_child_domain, **kwargs): # noqa: E501
"""Create a domain for a child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_child_domain_with_http_info(child_identifier, add_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddChildDomain add_child_domain: Sender domain to add for a specific child account. This will not be displayed to the parent account. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'add_child_domain'] # 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_child_domain" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `create_child_domain`") # noqa: E501
# verify the required parameter 'add_child_domain' is set
if ('add_child_domain' not in params or
params['add_child_domain'] is None):
raise ValueError("Missing the required parameter `add_child_domain` when calling `create_child_domain`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'add_child_domain' in params:
body_params = params['add_child_domain']
# 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(
'/reseller/children/{childIdentifier}/domains', 'POST',
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 create_reseller_child(self, **kwargs): # noqa: E501
"""Creates a reseller child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_reseller_child(async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateChild reseller_child: reseller child to add
:return: CreateReseller
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.create_reseller_child_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.create_reseller_child_with_http_info(**kwargs) # noqa: E501
return data
def create_reseller_child_with_http_info(self, **kwargs): # noqa: E501
"""Creates a reseller child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_reseller_child_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateChild reseller_child: reseller child to add
:return: CreateReseller
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['reseller_child'] # 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_reseller_child" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'reseller_child' in params:
body_params = params['reseller_child']
# 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(
'/reseller/children', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateReseller', # 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_child_domain(self, child_identifier, domain_name, **kwargs): # noqa: E501
"""Delete the sender domain of the reseller child based on the childIdentifier and domainName passed # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_child_domain(child_identifier, domain_name, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_child_domain_with_http_info(child_identifier, domain_name, **kwargs) # noqa: E501
else:
(data) = self.delete_child_domain_with_http_info(child_identifier, domain_name, **kwargs) # noqa: E501
return data
def delete_child_domain_with_http_info(self, child_identifier, domain_name, **kwargs): # noqa: E501
"""Delete the sender domain of the reseller child based on the childIdentifier and domainName passed # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_child_domain_with_http_info(child_identifier, domain_name, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'domain_name'] # 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_child_domain" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `delete_child_domain`") # noqa: E501
# verify the required parameter 'domain_name' is set
if ('domain_name' not in params or
params['domain_name'] is None):
raise ValueError("Missing the required parameter `domain_name` when calling `delete_child_domain`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
if 'domain_name' in params:
path_params['domainName'] = params['domain_name'] # noqa: E501
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(
'/reseller/children/{childIdentifier}/domains/{domainName}', '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 delete_reseller_child(self, child_identifier, **kwargs): # noqa: E501
"""Delete a single reseller child based on the child identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_reseller_child(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or child id of reseller's child (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_reseller_child_with_http_info(child_identifier, **kwargs) # noqa: E501
else:
(data) = self.delete_reseller_child_with_http_info(child_identifier, **kwargs) # noqa: E501
return data
def delete_reseller_child_with_http_info(self, child_identifier, **kwargs): # noqa: E501
"""Delete a single reseller child based on the child identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_reseller_child_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or child id of reseller's child (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier'] # 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_reseller_child" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `delete_reseller_child`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # 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(
'/reseller/children/{childIdentifier}', '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 dissociate_ip_from_child(self, child_identifier, ip, **kwargs): # noqa: E501
"""Dissociate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.dissociate_ip_from_child(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to dissociate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.dissociate_ip_from_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501
else:
(data) = self.dissociate_ip_from_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501
return data
def dissociate_ip_from_child_with_http_info(self, child_identifier, ip, **kwargs): # noqa: E501
"""Dissociate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.dissociate_ip_from_child_with_http_info(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to dissociate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'ip'] # 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 dissociate_ip_from_child" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `dissociate_ip_from_child`") # noqa: E501
# verify the required parameter 'ip' is set
if ('ip' not in params or
params['ip'] is None):
raise ValueError("Missing the required parameter `ip` when calling `dissociate_ip_from_child`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'ip' in params:
body_params = params['ip']
# 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(
'/reseller/children/{childIdentifier}/ips/dissociate', 'POST',
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_child_account_creation_status(self, child_identifier, **kwargs): # noqa: E501
"""Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_account_creation_status(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildAccountCreationStatus
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_child_account_creation_status_with_http_info(child_identifier, **kwargs) # noqa: E501
else:
(data) = self.get_child_account_creation_status_with_http_info(child_identifier, **kwargs) # noqa: E501
return data
def get_child_account_creation_status_with_http_info(self, child_identifier, **kwargs): # noqa: E501
"""Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_account_creation_status_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildAccountCreationStatus
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier'] # 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_child_account_creation_status" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `get_child_account_creation_status`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # 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(
'/reseller/children/{childIdentifier}/accountCreationStatus', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetChildAccountCreationStatus', # 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_child_domains(self, child_identifier, **kwargs): # noqa: E501
"""Get all sender domains for a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_domains(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildDomains
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_child_domains_with_http_info(child_identifier, **kwargs) # noqa: E501
else:
(data) = self.get_child_domains_with_http_info(child_identifier, **kwargs) # noqa: E501
return data
def get_child_domains_with_http_info(self, child_identifier, **kwargs): # noqa: E501
"""Get all sender domains for a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_domains_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildDomains
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier'] # 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_child_domains" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `get_child_domains`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # 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(
'/reseller/children/{childIdentifier}/domains', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetChildDomains', # 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_child_info(self, child_identifier, **kwargs): # noqa: E501
"""Get a child account's details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildInfo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_child_info_with_http_info(child_identifier, **kwargs) # noqa: E501
else:
(data) = self.get_child_info_with_http_info(child_identifier, **kwargs) # noqa: E501
return data
def get_child_info_with_http_info(self, child_identifier, **kwargs): # noqa: E501
"""Get a child account's details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_info_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildInfo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier'] # 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_child_info" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `get_child_info`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # 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(
'/reseller/children/{childIdentifier}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetChildInfo', # 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_reseller_childs(self, **kwargs): # noqa: E501
"""Get the list of all children accounts # 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_reseller_childs(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents for child accounts information per page
:param int offset: Index of the first document in the page
:return: GetChildrenList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_reseller_childs_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_reseller_childs_with_http_info(**kwargs) # noqa: E501
return data
def get_reseller_childs_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of all children accounts # 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_reseller_childs_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents for child accounts information per page
:param int offset: Index of the first document in the page
:return: GetChildrenList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'offset'] # 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_reseller_childs" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 20: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_reseller_childs`, must be a value less than or equal to `20`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_reseller_childs`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # 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(
'/reseller/children', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetChildrenList', # 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_sso_token(self, child_identifier, **kwargs): # noqa: E501
"""Get session token to access Sendinblue (SSO) # noqa: E501
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sso_token(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetSsoToken
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_sso_token_with_http_info(child_identifier, **kwargs) # noqa: E501
else:
(data) = self.get_sso_token_with_http_info(child_identifier, **kwargs) # noqa: E501
return data
def get_sso_token_with_http_info(self, child_identifier, **kwargs): # noqa: E501
"""Get session token to access Sendinblue (SSO) # noqa: E501
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sso_token_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetSsoToken
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier'] # 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_sso_token" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `get_sso_token`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # 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(
'/reseller/children/{childIdentifier}/auth', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSsoToken', # 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 remove_credits(self, child_identifier, remove_credits, **kwargs): # noqa: E501
"""Remove Email and/or SMS credits from a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_credits(child_identifier, remove_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param RemoveCredits remove_credits: Values to post to remove email or SMS credits from a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.remove_credits_with_http_info(child_identifier, remove_credits, **kwargs) # noqa: E501
else:
(data) = self.remove_credits_with_http_info(child_identifier, remove_credits, **kwargs) # noqa: E501
return data
def remove_credits_with_http_info(self, child_identifier, remove_credits, **kwargs): # noqa: E501
"""Remove Email and/or SMS credits from a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_credits_with_http_info(child_identifier, remove_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param RemoveCredits remove_credits: Values to post to remove email or SMS credits from a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'remove_credits'] # 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 remove_credits" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `remove_credits`") # noqa: E501
# verify the required parameter 'remove_credits' is set
if ('remove_credits' not in params or
params['remove_credits'] is None):
raise ValueError("Missing the required parameter `remove_credits` when calling `remove_credits`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'remove_credits' in params:
body_params = params['remove_credits']
# 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(
'/reseller/children/{childIdentifier}/credits/remove', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='RemainingCreditModel', # 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_child_account_status(self, child_identifier, update_child_account_status, **kwargs): # noqa: E501
"""Update info of reseller's child account status based on the childIdentifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_child_account_status(child_identifier, update_child_account_status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChildAccountStatus update_child_account_status: values to update in child account status (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_child_account_status_with_http_info(child_identifier, update_child_account_status, **kwargs) # noqa: E501
else:
(data) = self.update_child_account_status_with_http_info(child_identifier, update_child_account_status, **kwargs) # noqa: E501
return data
def update_child_account_status_with_http_info(self, child_identifier, update_child_account_status, **kwargs): # noqa: E501
"""Update info of reseller's child account status based on the childIdentifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_child_account_status_with_http_info(child_identifier, update_child_account_status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChildAccountStatus update_child_account_status: values to update in child account status (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'update_child_account_status'] # 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_child_account_status" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `update_child_account_status`") # noqa: E501
# verify the required parameter 'update_child_account_status' is set
if ('update_child_account_status' not in params or
params['update_child_account_status'] is None):
raise ValueError("Missing the required parameter `update_child_account_status` when calling `update_child_account_status`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_child_account_status' in params:
body_params = params['update_child_account_status']
# 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(
'/reseller/children/{childIdentifier}/accountStatus', '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)
def update_child_domain(self, child_identifier, domain_name, update_child_domain, **kwargs): # noqa: E501
"""Update the sender domain of reseller's child based on the childIdentifier and domainName passed # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_child_domain(child_identifier, domain_name, update_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be updated (required)
:param UpdateChildDomain update_child_domain: value to update for sender domain (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, **kwargs) # noqa: E501
else:
(data) = self.update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, **kwargs) # noqa: E501
return data
def update_child_domain_with_http_info(self, child_identifier, domain_name, update_child_domain, **kwargs): # noqa: E501
"""Update the sender domain of reseller's child based on the childIdentifier and domainName passed # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be updated (required)
:param UpdateChildDomain update_child_domain: value to update for sender domain (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'domain_name', 'update_child_domain'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
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_child_domain" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `update_child_domain`") # noqa: E501
# verify the required parameter 'domain_name' is set
if ('domain_name' not in params or
params['domain_name'] is None):
raise ValueError("Missing the required parameter `domain_name` when calling `update_child_domain`") # noqa: E501
# verify the required parameter 'update_child_domain' is set
if ('update_child_domain' not in params or
params['update_child_domain'] is None):
raise ValueError("Missing the required parameter `update_child_domain` when calling `update_child_domain`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
if 'domain_name' in params:
path_params['domainName'] = params['domain_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_child_domain' in params:
body_params = params['update_child_domain']
# 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(
'/reseller/children/{childIdentifier}/domains/{domainName}', '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)
def update_reseller_child(self, child_identifier, reseller_child, **kwargs): # noqa: E501
"""Update info of reseller's child based on the child identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_reseller_child(child_identifier, reseller_child, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChild reseller_child: values to update in child profile (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_reseller_child_with_http_info(child_identifier, reseller_child, **kwargs) # noqa: E501
else:
(data) = self.update_reseller_child_with_http_info(child_identifier, reseller_child, **kwargs) # noqa: E501
return data
def update_reseller_child_with_http_info(self, child_identifier, reseller_child, **kwargs): # noqa: E501
"""Update info of reseller's child based on the child identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_reseller_child_with_http_info(child_identifier, reseller_child, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChild reseller_child: values to update in child profile (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'reseller_child'] # 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_reseller_child" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `update_reseller_child`") # noqa: E501
# verify the required parameter 'reseller_child' is set
if ('reseller_child' not in params or
params['reseller_child'] is None):
raise ValueError("Missing the required parameter `reseller_child` when calling `update_reseller_child`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'reseller_child' in params:
body_params = params['reseller_child']
# 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(
'/reseller/children/{childIdentifier}', '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)
|
59,887 |
sib_api_v3_sdk.api.reseller_api
|
add_credits
|
Add Email and/or SMS credits to a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_credits(child_identifier, add_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddCredits add_credits: Values to post to add credit to a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
|
def add_credits(self, child_identifier, add_credits, **kwargs): # noqa: E501
"""Add Email and/or SMS credits to a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_credits(child_identifier, add_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddCredits add_credits: Values to post to add credit to a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.add_credits_with_http_info(child_identifier, add_credits, **kwargs) # noqa: E501
else:
(data) = self.add_credits_with_http_info(child_identifier, add_credits, **kwargs) # noqa: E501
return data
|
(self, child_identifier, add_credits, **kwargs)
|
59,888 |
sib_api_v3_sdk.api.reseller_api
|
add_credits_with_http_info
|
Add Email and/or SMS credits to a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_credits_with_http_info(child_identifier, add_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddCredits add_credits: Values to post to add credit to a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
|
def add_credits_with_http_info(self, child_identifier, add_credits, **kwargs): # noqa: E501
"""Add Email and/or SMS credits to a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_credits_with_http_info(child_identifier, add_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddCredits add_credits: Values to post to add credit to a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'add_credits'] # 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 add_credits" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `add_credits`") # noqa: E501
# verify the required parameter 'add_credits' is set
if ('add_credits' not in params or
params['add_credits'] is None):
raise ValueError("Missing the required parameter `add_credits` when calling `add_credits`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'add_credits' in params:
body_params = params['add_credits']
# 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(
'/reseller/children/{childIdentifier}/credits/add', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='RemainingCreditModel', # 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, child_identifier, add_credits, **kwargs)
|
59,889 |
sib_api_v3_sdk.api.reseller_api
|
associate_ip_to_child
|
Associate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.associate_ip_to_child(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to associate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def associate_ip_to_child(self, child_identifier, ip, **kwargs): # noqa: E501
"""Associate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.associate_ip_to_child(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to associate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.associate_ip_to_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501
else:
(data) = self.associate_ip_to_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501
return data
|
(self, child_identifier, ip, **kwargs)
|
59,890 |
sib_api_v3_sdk.api.reseller_api
|
associate_ip_to_child_with_http_info
|
Associate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.associate_ip_to_child_with_http_info(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to associate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def associate_ip_to_child_with_http_info(self, child_identifier, ip, **kwargs): # noqa: E501
"""Associate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.associate_ip_to_child_with_http_info(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to associate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'ip'] # 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 associate_ip_to_child" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `associate_ip_to_child`") # noqa: E501
# verify the required parameter 'ip' is set
if ('ip' not in params or
params['ip'] is None):
raise ValueError("Missing the required parameter `ip` when calling `associate_ip_to_child`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'ip' in params:
body_params = params['ip']
# 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(
'/reseller/children/{childIdentifier}/ips/associate', 'POST',
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, child_identifier, ip, **kwargs)
|
59,891 |
sib_api_v3_sdk.api.reseller_api
|
create_child_domain
|
Create a domain for a child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_child_domain(child_identifier, add_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddChildDomain add_child_domain: Sender domain to add for a specific child account. This will not be displayed to the parent account. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def create_child_domain(self, child_identifier, add_child_domain, **kwargs): # noqa: E501
"""Create a domain for a child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_child_domain(child_identifier, add_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddChildDomain add_child_domain: Sender domain to add for a specific child account. This will not be displayed to the parent account. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.create_child_domain_with_http_info(child_identifier, add_child_domain, **kwargs) # noqa: E501
else:
(data) = self.create_child_domain_with_http_info(child_identifier, add_child_domain, **kwargs) # noqa: E501
return data
|
(self, child_identifier, add_child_domain, **kwargs)
|
59,892 |
sib_api_v3_sdk.api.reseller_api
|
create_child_domain_with_http_info
|
Create a domain for a child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_child_domain_with_http_info(child_identifier, add_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddChildDomain add_child_domain: Sender domain to add for a specific child account. This will not be displayed to the parent account. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def create_child_domain_with_http_info(self, child_identifier, add_child_domain, **kwargs): # noqa: E501
"""Create a domain for a child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_child_domain_with_http_info(child_identifier, add_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param AddChildDomain add_child_domain: Sender domain to add for a specific child account. This will not be displayed to the parent account. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'add_child_domain'] # 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_child_domain" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `create_child_domain`") # noqa: E501
# verify the required parameter 'add_child_domain' is set
if ('add_child_domain' not in params or
params['add_child_domain'] is None):
raise ValueError("Missing the required parameter `add_child_domain` when calling `create_child_domain`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'add_child_domain' in params:
body_params = params['add_child_domain']
# 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(
'/reseller/children/{childIdentifier}/domains', 'POST',
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, child_identifier, add_child_domain, **kwargs)
|
59,893 |
sib_api_v3_sdk.api.reseller_api
|
create_reseller_child
|
Creates a reseller child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_reseller_child(async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateChild reseller_child: reseller child to add
:return: CreateReseller
If the method is called asynchronously,
returns the request thread.
|
def create_reseller_child(self, **kwargs): # noqa: E501
"""Creates a reseller child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_reseller_child(async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateChild reseller_child: reseller child to add
:return: CreateReseller
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.create_reseller_child_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.create_reseller_child_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
59,894 |
sib_api_v3_sdk.api.reseller_api
|
create_reseller_child_with_http_info
|
Creates a reseller child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_reseller_child_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateChild reseller_child: reseller child to add
:return: CreateReseller
If the method is called asynchronously,
returns the request thread.
|
def create_reseller_child_with_http_info(self, **kwargs): # noqa: E501
"""Creates a reseller child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_reseller_child_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateChild reseller_child: reseller child to add
:return: CreateReseller
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['reseller_child'] # 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_reseller_child" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'reseller_child' in params:
body_params = params['reseller_child']
# 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(
'/reseller/children', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateReseller', # 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)
|
59,895 |
sib_api_v3_sdk.api.reseller_api
|
delete_child_domain
|
Delete the sender domain of the reseller child based on the childIdentifier and domainName passed # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_child_domain(child_identifier, domain_name, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_child_domain(self, child_identifier, domain_name, **kwargs): # noqa: E501
"""Delete the sender domain of the reseller child based on the childIdentifier and domainName passed # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_child_domain(child_identifier, domain_name, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_child_domain_with_http_info(child_identifier, domain_name, **kwargs) # noqa: E501
else:
(data) = self.delete_child_domain_with_http_info(child_identifier, domain_name, **kwargs) # noqa: E501
return data
|
(self, child_identifier, domain_name, **kwargs)
|
59,896 |
sib_api_v3_sdk.api.reseller_api
|
delete_child_domain_with_http_info
|
Delete the sender domain of the reseller child based on the childIdentifier and domainName passed # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_child_domain_with_http_info(child_identifier, domain_name, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_child_domain_with_http_info(self, child_identifier, domain_name, **kwargs): # noqa: E501
"""Delete the sender domain of the reseller child based on the childIdentifier and domainName passed # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_child_domain_with_http_info(child_identifier, domain_name, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'domain_name'] # 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_child_domain" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `delete_child_domain`") # noqa: E501
# verify the required parameter 'domain_name' is set
if ('domain_name' not in params or
params['domain_name'] is None):
raise ValueError("Missing the required parameter `domain_name` when calling `delete_child_domain`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
if 'domain_name' in params:
path_params['domainName'] = params['domain_name'] # noqa: E501
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(
'/reseller/children/{childIdentifier}/domains/{domainName}', '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, child_identifier, domain_name, **kwargs)
|
59,897 |
sib_api_v3_sdk.api.reseller_api
|
delete_reseller_child
|
Delete a single reseller child based on the child identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_reseller_child(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or child id of reseller's child (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_reseller_child(self, child_identifier, **kwargs): # noqa: E501
"""Delete a single reseller child based on the child identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_reseller_child(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or child id of reseller's child (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_reseller_child_with_http_info(child_identifier, **kwargs) # noqa: E501
else:
(data) = self.delete_reseller_child_with_http_info(child_identifier, **kwargs) # noqa: E501
return data
|
(self, child_identifier, **kwargs)
|
59,898 |
sib_api_v3_sdk.api.reseller_api
|
delete_reseller_child_with_http_info
|
Delete a single reseller child based on the child identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_reseller_child_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or child id of reseller's child (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_reseller_child_with_http_info(self, child_identifier, **kwargs): # noqa: E501
"""Delete a single reseller child based on the child identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_reseller_child_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or child id of reseller's child (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier'] # 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_reseller_child" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `delete_reseller_child`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # 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(
'/reseller/children/{childIdentifier}', '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, child_identifier, **kwargs)
|
59,899 |
sib_api_v3_sdk.api.reseller_api
|
dissociate_ip_from_child
|
Dissociate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.dissociate_ip_from_child(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to dissociate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def dissociate_ip_from_child(self, child_identifier, ip, **kwargs): # noqa: E501
"""Dissociate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.dissociate_ip_from_child(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to dissociate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.dissociate_ip_from_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501
else:
(data) = self.dissociate_ip_from_child_with_http_info(child_identifier, ip, **kwargs) # noqa: E501
return data
|
(self, child_identifier, ip, **kwargs)
|
59,900 |
sib_api_v3_sdk.api.reseller_api
|
dissociate_ip_from_child_with_http_info
|
Dissociate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.dissociate_ip_from_child_with_http_info(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to dissociate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def dissociate_ip_from_child_with_http_info(self, child_identifier, ip, **kwargs): # noqa: E501
"""Dissociate a dedicated IP to the child # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.dissociate_ip_from_child_with_http_info(child_identifier, ip, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param ManageIp ip: IP to dissociate (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'ip'] # 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 dissociate_ip_from_child" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `dissociate_ip_from_child`") # noqa: E501
# verify the required parameter 'ip' is set
if ('ip' not in params or
params['ip'] is None):
raise ValueError("Missing the required parameter `ip` when calling `dissociate_ip_from_child`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'ip' in params:
body_params = params['ip']
# 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(
'/reseller/children/{childIdentifier}/ips/dissociate', 'POST',
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, child_identifier, ip, **kwargs)
|
59,901 |
sib_api_v3_sdk.api.reseller_api
|
get_child_account_creation_status
|
Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_account_creation_status(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildAccountCreationStatus
If the method is called asynchronously,
returns the request thread.
|
def get_child_account_creation_status(self, child_identifier, **kwargs): # noqa: E501
"""Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_account_creation_status(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildAccountCreationStatus
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_child_account_creation_status_with_http_info(child_identifier, **kwargs) # noqa: E501
else:
(data) = self.get_child_account_creation_status_with_http_info(child_identifier, **kwargs) # noqa: E501
return data
|
(self, child_identifier, **kwargs)
|
59,902 |
sib_api_v3_sdk.api.reseller_api
|
get_child_account_creation_status_with_http_info
|
Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_account_creation_status_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildAccountCreationStatus
If the method is called asynchronously,
returns the request thread.
|
def get_child_account_creation_status_with_http_info(self, child_identifier, **kwargs): # noqa: E501
"""Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_account_creation_status_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildAccountCreationStatus
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier'] # 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_child_account_creation_status" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `get_child_account_creation_status`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # 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(
'/reseller/children/{childIdentifier}/accountCreationStatus', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetChildAccountCreationStatus', # 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, child_identifier, **kwargs)
|
59,903 |
sib_api_v3_sdk.api.reseller_api
|
get_child_domains
|
Get all sender domains for a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_domains(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildDomains
If the method is called asynchronously,
returns the request thread.
|
def get_child_domains(self, child_identifier, **kwargs): # noqa: E501
"""Get all sender domains for a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_domains(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildDomains
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_child_domains_with_http_info(child_identifier, **kwargs) # noqa: E501
else:
(data) = self.get_child_domains_with_http_info(child_identifier, **kwargs) # noqa: E501
return data
|
(self, child_identifier, **kwargs)
|
59,904 |
sib_api_v3_sdk.api.reseller_api
|
get_child_domains_with_http_info
|
Get all sender domains for a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_domains_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildDomains
If the method is called asynchronously,
returns the request thread.
|
def get_child_domains_with_http_info(self, child_identifier, **kwargs): # noqa: E501
"""Get all sender domains for a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_domains_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildDomains
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier'] # 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_child_domains" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `get_child_domains`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # 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(
'/reseller/children/{childIdentifier}/domains', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetChildDomains', # 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, child_identifier, **kwargs)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.