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,593 |
sib_api_v3_sdk.api.inbound_parsing_api
|
get_inbound_email_events
|
Get the list of all the events for the received emails. # noqa: E501
This endpoint will show the list of all the events for the received emails. # 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_inbound_email_events(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str sender: Email address of the sender.
:param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
:param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param str sort: Sort the results in the ascending/descending order of record creation
:return: GetInboundEmailEvents
If the method is called asynchronously,
returns the request thread.
|
def get_inbound_email_events(self, **kwargs): # noqa: E501
"""Get the list of all the events for the received emails. # noqa: E501
This endpoint will show the list of all the events for the received emails. # 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_inbound_email_events(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str sender: Email address of the sender.
:param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
:param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param str sort: Sort the results in the ascending/descending order of record creation
:return: GetInboundEmailEvents
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_inbound_email_events_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_inbound_email_events_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
59,594 |
sib_api_v3_sdk.api.inbound_parsing_api
|
get_inbound_email_events_by_uuid
|
Fetch all events history for one particular received email. # noqa: E501
This endpoint will show the list of all events history for one particular received email. # 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_inbound_email_events_by_uuid(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID to fetch events specific to recieved email (required)
:return: GetInboundEmailEventsByUuid
If the method is called asynchronously,
returns the request thread.
|
def get_inbound_email_events_by_uuid(self, uuid, **kwargs): # noqa: E501
"""Fetch all events history for one particular received email. # noqa: E501
This endpoint will show the list of all events history for one particular received email. # 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_inbound_email_events_by_uuid(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID to fetch events specific to recieved email (required)
:return: GetInboundEmailEventsByUuid
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_inbound_email_events_by_uuid_with_http_info(uuid, **kwargs) # noqa: E501
else:
(data) = self.get_inbound_email_events_by_uuid_with_http_info(uuid, **kwargs) # noqa: E501
return data
|
(self, uuid, **kwargs)
|
59,595 |
sib_api_v3_sdk.api.inbound_parsing_api
|
get_inbound_email_events_by_uuid_with_http_info
|
Fetch all events history for one particular received email. # noqa: E501
This endpoint will show the list of all events history for one particular received email. # 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_inbound_email_events_by_uuid_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID to fetch events specific to recieved email (required)
:return: GetInboundEmailEventsByUuid
If the method is called asynchronously,
returns the request thread.
|
def get_inbound_email_events_by_uuid_with_http_info(self, uuid, **kwargs): # noqa: E501
"""Fetch all events history for one particular received email. # noqa: E501
This endpoint will show the list of all events history for one particular received email. # 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_inbound_email_events_by_uuid_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID to fetch events specific to recieved email (required)
:return: GetInboundEmailEventsByUuid
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['uuid'] # 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_inbound_email_events_by_uuid" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'uuid' is set
if ('uuid' not in params or
params['uuid'] is None):
raise ValueError("Missing the required parameter `uuid` when calling `get_inbound_email_events_by_uuid`") # noqa: E501
collection_formats = {}
path_params = {}
if 'uuid' in params:
path_params['uuid'] = params['uuid'] # 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(
'/inbound/events/{uuid}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetInboundEmailEventsByUuid', # 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, uuid, **kwargs)
|
59,596 |
sib_api_v3_sdk.api.inbound_parsing_api
|
get_inbound_email_events_with_http_info
|
Get the list of all the events for the received emails. # noqa: E501
This endpoint will show the list of all the events for the received emails. # 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_inbound_email_events_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str sender: Email address of the sender.
:param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
:param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param str sort: Sort the results in the ascending/descending order of record creation
:return: GetInboundEmailEvents
If the method is called asynchronously,
returns the request thread.
|
def get_inbound_email_events_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of all the events for the received emails. # noqa: E501
This endpoint will show the list of all the events for the received emails. # 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_inbound_email_events_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str sender: Email address of the sender.
:param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
:param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param str sort: Sort the results in the ascending/descending order of record creation
:return: GetInboundEmailEvents
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['sender', 'start_date', 'end_date', 'limit', 'offset', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_inbound_email_events" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 500: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_inbound_email_events`, must be a value less than or equal to `500`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_inbound_email_events`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'sender' in params:
query_params.append(('sender', params['sender'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', params['sort'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/inbound/events', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetInboundEmailEvents', # 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,597 |
sib_api_v3_sdk.models.inline_response200
|
InlineResponse200
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class InlineResponse200(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'
}
attribute_map = {
'id': 'id'
}
def __init__(self, id=None): # noqa: E501
"""InlineResponse200 - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
self.id = id
@property
def id(self):
"""Gets the id of this InlineResponse200. # noqa: E501
Unique company id # noqa: E501
:return: The id of this InlineResponse200. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this InlineResponse200.
Unique company id # noqa: E501
:param id: The id of this InlineResponse200. # noqa: E501
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(InlineResponse200, 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, InlineResponse200):
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)
|
59,598 |
sib_api_v3_sdk.models.inline_response200
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, InlineResponse200):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,599 |
sib_api_v3_sdk.models.inline_response200
|
__init__
|
InlineResponse200 - a model defined in Swagger
|
def __init__(self, id=None): # noqa: E501
"""InlineResponse200 - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
self.id = id
|
(self, id=None)
|
59,602 |
sib_api_v3_sdk.models.inline_response200
|
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(InlineResponse200, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,604 |
sib_api_v3_sdk.models.inline_response201
|
InlineResponse201
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class InlineResponse201(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'
}
attribute_map = {
'id': 'id'
}
def __init__(self, id=None): # noqa: E501
"""InlineResponse201 - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
self.id = id
@property
def id(self):
"""Gets the id of this InlineResponse201. # noqa: E501
Unique deal id # noqa: E501
:return: The id of this InlineResponse201. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this InlineResponse201.
Unique deal id # noqa: E501
:param id: The id of this InlineResponse201. # noqa: E501
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(InlineResponse201, 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, InlineResponse201):
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)
|
59,605 |
sib_api_v3_sdk.models.inline_response201
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, InlineResponse201):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,606 |
sib_api_v3_sdk.models.inline_response201
|
__init__
|
InlineResponse201 - a model defined in Swagger
|
def __init__(self, id=None): # noqa: E501
"""InlineResponse201 - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
self.id = id
|
(self, id=None)
|
59,609 |
sib_api_v3_sdk.models.inline_response201
|
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(InlineResponse201, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,611 |
sib_api_v3_sdk.models.inline_response2011
|
InlineResponse2011
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class InlineResponse2011(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'
}
attribute_map = {
'id': 'id'
}
def __init__(self, id=None): # noqa: E501
"""InlineResponse2011 - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
self.id = id
@property
def id(self):
"""Gets the id of this InlineResponse2011. # noqa: E501
Unique task id # noqa: E501
:return: The id of this InlineResponse2011. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this InlineResponse2011.
Unique task id # noqa: E501
:param id: The id of this InlineResponse2011. # noqa: E501
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(InlineResponse2011, 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, InlineResponse2011):
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)
|
59,612 |
sib_api_v3_sdk.models.inline_response2011
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, InlineResponse2011):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,613 |
sib_api_v3_sdk.models.inline_response2011
|
__init__
|
InlineResponse2011 - a model defined in Swagger
|
def __init__(self, id=None): # noqa: E501
"""InlineResponse2011 - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
self.id = id
|
(self, id=None)
|
59,616 |
sib_api_v3_sdk.models.inline_response2011
|
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(InlineResponse2011, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,618 |
sib_api_v3_sdk.models.inline_response2012
|
InlineResponse2012
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class InlineResponse2012(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 = {
'message_id': 'str'
}
attribute_map = {
'message_id': 'messageId'
}
def __init__(self, message_id=None): # noqa: E501
"""InlineResponse2012 - a model defined in Swagger""" # noqa: E501
self._message_id = None
self.discriminator = None
self.message_id = message_id
@property
def message_id(self):
"""Gets the message_id of this InlineResponse2012. # noqa: E501
messageId of sent message # noqa: E501
:return: The message_id of this InlineResponse2012. # noqa: E501
:rtype: str
"""
return self._message_id
@message_id.setter
def message_id(self, message_id):
"""Sets the message_id of this InlineResponse2012.
messageId of sent message # noqa: E501
:param message_id: The message_id of this InlineResponse2012. # noqa: E501
:type: str
"""
if message_id is None:
raise ValueError("Invalid value for `message_id`, must not be `None`") # noqa: E501
self._message_id = message_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(InlineResponse2012, 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, InlineResponse2012):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(message_id=None)
|
59,619 |
sib_api_v3_sdk.models.inline_response2012
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, InlineResponse2012):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,620 |
sib_api_v3_sdk.models.inline_response2012
|
__init__
|
InlineResponse2012 - a model defined in Swagger
|
def __init__(self, message_id=None): # noqa: E501
"""InlineResponse2012 - a model defined in Swagger""" # noqa: E501
self._message_id = None
self.discriminator = None
self.message_id = message_id
|
(self, message_id=None)
|
59,623 |
sib_api_v3_sdk.models.inline_response2012
|
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(InlineResponse2012, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,625 |
sib_api_v3_sdk.models.inline_response2013
|
InlineResponse2013
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class InlineResponse2013(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'
}
attribute_map = {
'id': 'id'
}
def __init__(self, id=None): # noqa: E501
"""InlineResponse2013 - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
self.id = id
@property
def id(self):
"""Gets the id of this InlineResponse2013. # noqa: E501
ID of the object created # noqa: E501
:return: The id of this InlineResponse2013. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this InlineResponse2013.
ID of the object created # noqa: E501
:param id: The id of this InlineResponse2013. # noqa: E501
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(InlineResponse2013, 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, InlineResponse2013):
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)
|
59,626 |
sib_api_v3_sdk.models.inline_response2013
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, InlineResponse2013):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,627 |
sib_api_v3_sdk.models.inline_response2013
|
__init__
|
InlineResponse2013 - a model defined in Swagger
|
def __init__(self, id=None): # noqa: E501
"""InlineResponse2013 - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
self.id = id
|
(self, id=None)
|
59,630 |
sib_api_v3_sdk.models.inline_response2013
|
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(InlineResponse2013, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,632 |
sib_api_v3_sdk.models.manage_ip
|
ManageIp
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class ManageIp(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 = {
'ip': 'str'
}
attribute_map = {
'ip': 'ip'
}
def __init__(self, ip=None): # noqa: E501
"""ManageIp - a model defined in Swagger""" # noqa: E501
self._ip = None
self.discriminator = None
if ip is not None:
self.ip = ip
@property
def ip(self):
"""Gets the ip of this ManageIp. # noqa: E501
Dedicated ID # noqa: E501
:return: The ip of this ManageIp. # noqa: E501
:rtype: str
"""
return self._ip
@ip.setter
def ip(self, ip):
"""Sets the ip of this ManageIp.
Dedicated ID # noqa: E501
:param ip: The ip of this ManageIp. # noqa: E501
:type: str
"""
self._ip = ip
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(ManageIp, 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, ManageIp):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(ip=None)
|
59,633 |
sib_api_v3_sdk.models.manage_ip
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, ManageIp):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,634 |
sib_api_v3_sdk.models.manage_ip
|
__init__
|
ManageIp - a model defined in Swagger
|
def __init__(self, ip=None): # noqa: E501
"""ManageIp - a model defined in Swagger""" # noqa: E501
self._ip = None
self.discriminator = None
if ip is not None:
self.ip = ip
|
(self, ip=None)
|
59,637 |
sib_api_v3_sdk.models.manage_ip
|
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(ManageIp, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,639 |
sib_api_v3_sdk.api.master_account_api
|
MasterAccountApi
|
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 MasterAccountApi(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 corporate_master_account_get(self, **kwargs): # noqa: E501
"""Get the details of requested master account # noqa: E501
This endpoint will provide the details of the master 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.corporate_master_account_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: MasterDetailsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.corporate_master_account_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.corporate_master_account_get_with_http_info(**kwargs) # noqa: E501
return data
def corporate_master_account_get_with_http_info(self, **kwargs): # noqa: E501
"""Get the details of requested master account # noqa: E501
This endpoint will provide the details of the master 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.corporate_master_account_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: MasterDetailsResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # 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 corporate_master_account_get" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
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(
'/corporate/masterAccount', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='MasterDetailsResponse', # 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 corporate_sub_account_get(self, offset, limit, **kwargs): # noqa: E501
"""Get the list of all the sub-accounts of the master account. # noqa: E501
This endpoint will provide the list all the sub-accounts of the master 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.corporate_sub_account_get(offset, limit, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int offset: Index of the first sub-account in the page (required)
:param int limit: Number of sub-accounts to be displayed on each page (required)
:return: SubAccountsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.corporate_sub_account_get_with_http_info(offset, limit, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_get_with_http_info(offset, limit, **kwargs) # noqa: E501
return data
def corporate_sub_account_get_with_http_info(self, offset, limit, **kwargs): # noqa: E501
"""Get the list of all the sub-accounts of the master account. # noqa: E501
This endpoint will provide the list all the sub-accounts of the master 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.corporate_sub_account_get_with_http_info(offset, limit, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int offset: Index of the first sub-account in the page (required)
:param int limit: Number of sub-accounts to be displayed on each page (required)
:return: SubAccountsResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['offset', 'limit'] # 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 corporate_sub_account_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'offset' is set
if ('offset' not in params or
params['offset'] is None):
raise ValueError("Missing the required parameter `offset` when calling `corporate_sub_account_get`") # noqa: E501
# verify the required parameter 'limit' is set
if ('limit' not in params or
params['limit'] is None):
raise ValueError("Missing the required parameter `limit` when calling `corporate_sub_account_get`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # 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(
'/corporate/subAccount', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SubAccountsResponse', # 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 corporate_sub_account_id_delete(self, id, **kwargs): # noqa: E501
"""Delete a sub-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.corporate_sub_account_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization 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.corporate_sub_account_id_delete_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_id_delete_with_http_info(id, **kwargs) # noqa: E501
return data
def corporate_sub_account_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete a sub-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.corporate_sub_account_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 corporate_sub_account_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `corporate_sub_account_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['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(
'/corporate/subAccount/{id}', '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 corporate_sub_account_id_get(self, id, **kwargs): # noqa: E501
"""Get sub-account details # noqa: E501
This endpoint will provide the details for the specified sub-account company # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:return: SubAccountDetailsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.corporate_sub_account_id_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_id_get_with_http_info(id, **kwargs) # noqa: E501
return data
def corporate_sub_account_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Get sub-account details # noqa: E501
This endpoint will provide the details for the specified sub-account company # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:return: SubAccountDetailsResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 corporate_sub_account_id_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `corporate_sub_account_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['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(
'/corporate/subAccount/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SubAccountDetailsResponse', # 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 corporate_sub_account_id_plan_put(self, id, update_plan_details, **kwargs): # noqa: E501
"""Update sub-account plan # noqa: E501
This endpoint will update the sub-account plan # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_plan_put(id, update_plan_details, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:param SubAccountUpdatePlanRequest update_plan_details: Values to update a sub-account plan (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.corporate_sub_account_id_plan_put_with_http_info(id, update_plan_details, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_id_plan_put_with_http_info(id, update_plan_details, **kwargs) # noqa: E501
return data
def corporate_sub_account_id_plan_put_with_http_info(self, id, update_plan_details, **kwargs): # noqa: E501
"""Update sub-account plan # noqa: E501
This endpoint will update the sub-account plan # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_plan_put_with_http_info(id, update_plan_details, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:param SubAccountUpdatePlanRequest update_plan_details: Values to update a sub-account plan (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id', 'update_plan_details'] # 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 corporate_sub_account_id_plan_put" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `corporate_sub_account_id_plan_put`") # noqa: E501
# verify the required parameter 'update_plan_details' is set
if ('update_plan_details' not in params or
params['update_plan_details'] is None):
raise ValueError("Missing the required parameter `update_plan_details` when calling `corporate_sub_account_id_plan_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_plan_details' in params:
body_params = params['update_plan_details']
# 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(
'/corporate/subAccount/{id}/plan', '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 corporate_sub_account_key_post(self, create_api_key_request, **kwargs): # noqa: E501
"""Create an API key for a sub-account # noqa: E501
This endpoint will generate an API v3 key for a sub 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.corporate_sub_account_key_post(create_api_key_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateApiKeyRequest create_api_key_request: Values to generate API key for sub-account (required)
:return: CreateApiKeyResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.corporate_sub_account_key_post_with_http_info(create_api_key_request, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_key_post_with_http_info(create_api_key_request, **kwargs) # noqa: E501
return data
def corporate_sub_account_key_post_with_http_info(self, create_api_key_request, **kwargs): # noqa: E501
"""Create an API key for a sub-account # noqa: E501
This endpoint will generate an API v3 key for a sub 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.corporate_sub_account_key_post_with_http_info(create_api_key_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateApiKeyRequest create_api_key_request: Values to generate API key for sub-account (required)
:return: CreateApiKeyResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['create_api_key_request'] # 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 corporate_sub_account_key_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'create_api_key_request' is set
if ('create_api_key_request' not in params or
params['create_api_key_request'] is None):
raise ValueError("Missing the required parameter `create_api_key_request` when calling `corporate_sub_account_key_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_api_key_request' in params:
body_params = params['create_api_key_request']
# 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(
'/corporate/subAccount/key', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateApiKeyResponse', # 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 corporate_sub_account_post(self, sub_account_create, **kwargs): # noqa: E501
"""Create a new sub-account under a master account. # noqa: E501
This endpoint will create a new sub-account under a master 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.corporate_sub_account_post(sub_account_create, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSubAccount sub_account_create: values to create new sub-account (required)
:return: CreateSubAccountResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.corporate_sub_account_post_with_http_info(sub_account_create, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_post_with_http_info(sub_account_create, **kwargs) # noqa: E501
return data
def corporate_sub_account_post_with_http_info(self, sub_account_create, **kwargs): # noqa: E501
"""Create a new sub-account under a master account. # noqa: E501
This endpoint will create a new sub-account under a master 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.corporate_sub_account_post_with_http_info(sub_account_create, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSubAccount sub_account_create: values to create new sub-account (required)
:return: CreateSubAccountResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['sub_account_create'] # 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 corporate_sub_account_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'sub_account_create' is set
if ('sub_account_create' not in params or
params['sub_account_create'] is None):
raise ValueError("Missing the required parameter `sub_account_create` when calling `corporate_sub_account_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'sub_account_create' in params:
body_params = params['sub_account_create']
# 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(
'/corporate/subAccount', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateSubAccountResponse', # 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 corporate_sub_account_sso_token_post(self, sso_token_request, **kwargs): # noqa: E501
"""Generate SSO token to access Sendinblue # noqa: E501
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual 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.corporate_sub_account_sso_token_post(sso_token_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SsoTokenRequest sso_token_request: Values to generate SSO token for sub-account (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.corporate_sub_account_sso_token_post_with_http_info(sso_token_request, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_sso_token_post_with_http_info(sso_token_request, **kwargs) # noqa: E501
return data
def corporate_sub_account_sso_token_post_with_http_info(self, sso_token_request, **kwargs): # noqa: E501
"""Generate SSO token to access Sendinblue # noqa: E501
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual 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.corporate_sub_account_sso_token_post_with_http_info(sso_token_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SsoTokenRequest sso_token_request: Values to generate SSO token for sub-account (required)
:return: GetSsoToken
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['sso_token_request'] # 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 corporate_sub_account_sso_token_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'sso_token_request' is set
if ('sso_token_request' not in params or
params['sso_token_request'] is None):
raise ValueError("Missing the required parameter `sso_token_request` when calling `corporate_sub_account_sso_token_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'sso_token_request' in params:
body_params = params['sso_token_request']
# 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(
'/corporate/subAccount/ssoToken', 'POST',
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)
|
(api_client=None)
|
59,641 |
sib_api_v3_sdk.api.master_account_api
|
corporate_master_account_get
|
Get the details of requested master account # noqa: E501
This endpoint will provide the details of the master 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.corporate_master_account_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: MasterDetailsResponse
If the method is called asynchronously,
returns the request thread.
|
def corporate_master_account_get(self, **kwargs): # noqa: E501
"""Get the details of requested master account # noqa: E501
This endpoint will provide the details of the master 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.corporate_master_account_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: MasterDetailsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.corporate_master_account_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.corporate_master_account_get_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
59,642 |
sib_api_v3_sdk.api.master_account_api
|
corporate_master_account_get_with_http_info
|
Get the details of requested master account # noqa: E501
This endpoint will provide the details of the master 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.corporate_master_account_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: MasterDetailsResponse
If the method is called asynchronously,
returns the request thread.
|
def corporate_master_account_get_with_http_info(self, **kwargs): # noqa: E501
"""Get the details of requested master account # noqa: E501
This endpoint will provide the details of the master 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.corporate_master_account_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: MasterDetailsResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # 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 corporate_master_account_get" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
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(
'/corporate/masterAccount', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='MasterDetailsResponse', # 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,643 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_get
|
Get the list of all the sub-accounts of the master account. # noqa: E501
This endpoint will provide the list all the sub-accounts of the master 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.corporate_sub_account_get(offset, limit, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int offset: Index of the first sub-account in the page (required)
:param int limit: Number of sub-accounts to be displayed on each page (required)
:return: SubAccountsResponse
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_get(self, offset, limit, **kwargs): # noqa: E501
"""Get the list of all the sub-accounts of the master account. # noqa: E501
This endpoint will provide the list all the sub-accounts of the master 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.corporate_sub_account_get(offset, limit, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int offset: Index of the first sub-account in the page (required)
:param int limit: Number of sub-accounts to be displayed on each page (required)
:return: SubAccountsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.corporate_sub_account_get_with_http_info(offset, limit, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_get_with_http_info(offset, limit, **kwargs) # noqa: E501
return data
|
(self, offset, limit, **kwargs)
|
59,644 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_get_with_http_info
|
Get the list of all the sub-accounts of the master account. # noqa: E501
This endpoint will provide the list all the sub-accounts of the master 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.corporate_sub_account_get_with_http_info(offset, limit, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int offset: Index of the first sub-account in the page (required)
:param int limit: Number of sub-accounts to be displayed on each page (required)
:return: SubAccountsResponse
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_get_with_http_info(self, offset, limit, **kwargs): # noqa: E501
"""Get the list of all the sub-accounts of the master account. # noqa: E501
This endpoint will provide the list all the sub-accounts of the master 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.corporate_sub_account_get_with_http_info(offset, limit, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int offset: Index of the first sub-account in the page (required)
:param int limit: Number of sub-accounts to be displayed on each page (required)
:return: SubAccountsResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['offset', 'limit'] # 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 corporate_sub_account_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'offset' is set
if ('offset' not in params or
params['offset'] is None):
raise ValueError("Missing the required parameter `offset` when calling `corporate_sub_account_get`") # noqa: E501
# verify the required parameter 'limit' is set
if ('limit' not in params or
params['limit'] is None):
raise ValueError("Missing the required parameter `limit` when calling `corporate_sub_account_get`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # 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(
'/corporate/subAccount', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SubAccountsResponse', # 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, offset, limit, **kwargs)
|
59,645 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_id_delete
|
Delete a sub-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.corporate_sub_account_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_id_delete(self, id, **kwargs): # noqa: E501
"""Delete a sub-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.corporate_sub_account_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization 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.corporate_sub_account_id_delete_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_id_delete_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
59,646 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_id_delete_with_http_info
|
Delete a sub-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.corporate_sub_account_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete a sub-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.corporate_sub_account_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 corporate_sub_account_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `corporate_sub_account_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['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(
'/corporate/subAccount/{id}', '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, id, **kwargs)
|
59,647 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_id_get
|
Get sub-account details # noqa: E501
This endpoint will provide the details for the specified sub-account company # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:return: SubAccountDetailsResponse
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_id_get(self, id, **kwargs): # noqa: E501
"""Get sub-account details # noqa: E501
This endpoint will provide the details for the specified sub-account company # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:return: SubAccountDetailsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.corporate_sub_account_id_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_id_get_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
59,648 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_id_get_with_http_info
|
Get sub-account details # noqa: E501
This endpoint will provide the details for the specified sub-account company # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:return: SubAccountDetailsResponse
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Get sub-account details # noqa: E501
This endpoint will provide the details for the specified sub-account company # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:return: SubAccountDetailsResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 corporate_sub_account_id_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `corporate_sub_account_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['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(
'/corporate/subAccount/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SubAccountDetailsResponse', # 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, id, **kwargs)
|
59,649 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_id_plan_put
|
Update sub-account plan # noqa: E501
This endpoint will update the sub-account plan # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_plan_put(id, update_plan_details, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:param SubAccountUpdatePlanRequest update_plan_details: Values to update a sub-account plan (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_id_plan_put(self, id, update_plan_details, **kwargs): # noqa: E501
"""Update sub-account plan # noqa: E501
This endpoint will update the sub-account plan # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_plan_put(id, update_plan_details, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:param SubAccountUpdatePlanRequest update_plan_details: Values to update a sub-account plan (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.corporate_sub_account_id_plan_put_with_http_info(id, update_plan_details, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_id_plan_put_with_http_info(id, update_plan_details, **kwargs) # noqa: E501
return data
|
(self, id, update_plan_details, **kwargs)
|
59,650 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_id_plan_put_with_http_info
|
Update sub-account plan # noqa: E501
This endpoint will update the sub-account plan # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_plan_put_with_http_info(id, update_plan_details, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:param SubAccountUpdatePlanRequest update_plan_details: Values to update a sub-account plan (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_id_plan_put_with_http_info(self, id, update_plan_details, **kwargs): # noqa: E501
"""Update sub-account plan # noqa: E501
This endpoint will update the sub-account plan # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.corporate_sub_account_id_plan_put_with_http_info(id, update_plan_details, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int id: Id of the sub-account organization (required)
:param SubAccountUpdatePlanRequest update_plan_details: Values to update a sub-account plan (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id', 'update_plan_details'] # 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 corporate_sub_account_id_plan_put" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `corporate_sub_account_id_plan_put`") # noqa: E501
# verify the required parameter 'update_plan_details' is set
if ('update_plan_details' not in params or
params['update_plan_details'] is None):
raise ValueError("Missing the required parameter `update_plan_details` when calling `corporate_sub_account_id_plan_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_plan_details' in params:
body_params = params['update_plan_details']
# 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(
'/corporate/subAccount/{id}/plan', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, id, update_plan_details, **kwargs)
|
59,651 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_key_post
|
Create an API key for a sub-account # noqa: E501
This endpoint will generate an API v3 key for a sub 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.corporate_sub_account_key_post(create_api_key_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateApiKeyRequest create_api_key_request: Values to generate API key for sub-account (required)
:return: CreateApiKeyResponse
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_key_post(self, create_api_key_request, **kwargs): # noqa: E501
"""Create an API key for a sub-account # noqa: E501
This endpoint will generate an API v3 key for a sub 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.corporate_sub_account_key_post(create_api_key_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateApiKeyRequest create_api_key_request: Values to generate API key for sub-account (required)
:return: CreateApiKeyResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.corporate_sub_account_key_post_with_http_info(create_api_key_request, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_key_post_with_http_info(create_api_key_request, **kwargs) # noqa: E501
return data
|
(self, create_api_key_request, **kwargs)
|
59,652 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_key_post_with_http_info
|
Create an API key for a sub-account # noqa: E501
This endpoint will generate an API v3 key for a sub 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.corporate_sub_account_key_post_with_http_info(create_api_key_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateApiKeyRequest create_api_key_request: Values to generate API key for sub-account (required)
:return: CreateApiKeyResponse
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_key_post_with_http_info(self, create_api_key_request, **kwargs): # noqa: E501
"""Create an API key for a sub-account # noqa: E501
This endpoint will generate an API v3 key for a sub 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.corporate_sub_account_key_post_with_http_info(create_api_key_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateApiKeyRequest create_api_key_request: Values to generate API key for sub-account (required)
:return: CreateApiKeyResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['create_api_key_request'] # 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 corporate_sub_account_key_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'create_api_key_request' is set
if ('create_api_key_request' not in params or
params['create_api_key_request'] is None):
raise ValueError("Missing the required parameter `create_api_key_request` when calling `corporate_sub_account_key_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_api_key_request' in params:
body_params = params['create_api_key_request']
# 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(
'/corporate/subAccount/key', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateApiKeyResponse', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, create_api_key_request, **kwargs)
|
59,653 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_post
|
Create a new sub-account under a master account. # noqa: E501
This endpoint will create a new sub-account under a master 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.corporate_sub_account_post(sub_account_create, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSubAccount sub_account_create: values to create new sub-account (required)
:return: CreateSubAccountResponse
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_post(self, sub_account_create, **kwargs): # noqa: E501
"""Create a new sub-account under a master account. # noqa: E501
This endpoint will create a new sub-account under a master 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.corporate_sub_account_post(sub_account_create, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSubAccount sub_account_create: values to create new sub-account (required)
:return: CreateSubAccountResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.corporate_sub_account_post_with_http_info(sub_account_create, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_post_with_http_info(sub_account_create, **kwargs) # noqa: E501
return data
|
(self, sub_account_create, **kwargs)
|
59,654 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_post_with_http_info
|
Create a new sub-account under a master account. # noqa: E501
This endpoint will create a new sub-account under a master 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.corporate_sub_account_post_with_http_info(sub_account_create, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSubAccount sub_account_create: values to create new sub-account (required)
:return: CreateSubAccountResponse
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_post_with_http_info(self, sub_account_create, **kwargs): # noqa: E501
"""Create a new sub-account under a master account. # noqa: E501
This endpoint will create a new sub-account under a master 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.corporate_sub_account_post_with_http_info(sub_account_create, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSubAccount sub_account_create: values to create new sub-account (required)
:return: CreateSubAccountResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['sub_account_create'] # 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 corporate_sub_account_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'sub_account_create' is set
if ('sub_account_create' not in params or
params['sub_account_create'] is None):
raise ValueError("Missing the required parameter `sub_account_create` when calling `corporate_sub_account_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'sub_account_create' in params:
body_params = params['sub_account_create']
# 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(
'/corporate/subAccount', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateSubAccountResponse', # 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, sub_account_create, **kwargs)
|
59,655 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_sso_token_post
|
Generate SSO token to access Sendinblue # noqa: E501
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual 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.corporate_sub_account_sso_token_post(sso_token_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SsoTokenRequest sso_token_request: Values to generate SSO token for sub-account (required)
:return: GetSsoToken
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_sso_token_post(self, sso_token_request, **kwargs): # noqa: E501
"""Generate SSO token to access Sendinblue # noqa: E501
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual 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.corporate_sub_account_sso_token_post(sso_token_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SsoTokenRequest sso_token_request: Values to generate SSO token for sub-account (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.corporate_sub_account_sso_token_post_with_http_info(sso_token_request, **kwargs) # noqa: E501
else:
(data) = self.corporate_sub_account_sso_token_post_with_http_info(sso_token_request, **kwargs) # noqa: E501
return data
|
(self, sso_token_request, **kwargs)
|
59,656 |
sib_api_v3_sdk.api.master_account_api
|
corporate_sub_account_sso_token_post_with_http_info
|
Generate SSO token to access Sendinblue # noqa: E501
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual 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.corporate_sub_account_sso_token_post_with_http_info(sso_token_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SsoTokenRequest sso_token_request: Values to generate SSO token for sub-account (required)
:return: GetSsoToken
If the method is called asynchronously,
returns the request thread.
|
def corporate_sub_account_sso_token_post_with_http_info(self, sso_token_request, **kwargs): # noqa: E501
"""Generate SSO token to access Sendinblue # noqa: E501
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual 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.corporate_sub_account_sso_token_post_with_http_info(sso_token_request, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SsoTokenRequest sso_token_request: Values to generate SSO token for sub-account (required)
:return: GetSsoToken
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['sso_token_request'] # 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 corporate_sub_account_sso_token_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'sso_token_request' is set
if ('sso_token_request' not in params or
params['sso_token_request'] is None):
raise ValueError("Missing the required parameter `sso_token_request` when calling `corporate_sub_account_sso_token_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'sso_token_request' in params:
body_params = params['sso_token_request']
# 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(
'/corporate/subAccount/ssoToken', 'POST',
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)
|
(self, sso_token_request, **kwargs)
|
59,657 |
sib_api_v3_sdk.models.master_details_response
|
MasterDetailsResponse
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class MasterDetailsResponse(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 = {
'email': 'str',
'company_name': 'str',
'id': 'int',
'currency_code': 'str',
'timezone': 'str',
'billing_info': 'MasterDetailsResponseBillingInfo',
'plan_info': 'MasterDetailsResponsePlanInfo'
}
attribute_map = {
'email': 'email',
'company_name': 'companyName',
'id': 'id',
'currency_code': 'currencyCode',
'timezone': 'timezone',
'billing_info': 'billingInfo',
'plan_info': 'planInfo'
}
def __init__(self, email=None, company_name=None, id=None, currency_code=None, timezone=None, billing_info=None, plan_info=None): # noqa: E501
"""MasterDetailsResponse - a model defined in Swagger""" # noqa: E501
self._email = None
self._company_name = None
self._id = None
self._currency_code = None
self._timezone = None
self._billing_info = None
self._plan_info = None
self.discriminator = None
if email is not None:
self.email = email
if company_name is not None:
self.company_name = company_name
if id is not None:
self.id = id
if currency_code is not None:
self.currency_code = currency_code
if timezone is not None:
self.timezone = timezone
if billing_info is not None:
self.billing_info = billing_info
if plan_info is not None:
self.plan_info = plan_info
@property
def email(self):
"""Gets the email of this MasterDetailsResponse. # noqa: E501
Email id of master account # noqa: E501
:return: The email of this MasterDetailsResponse. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this MasterDetailsResponse.
Email id of master account # noqa: E501
:param email: The email of this MasterDetailsResponse. # noqa: E501
:type: str
"""
self._email = email
@property
def company_name(self):
"""Gets the company_name of this MasterDetailsResponse. # noqa: E501
Company name of master account organization # noqa: E501
:return: The company_name of this MasterDetailsResponse. # noqa: E501
:rtype: str
"""
return self._company_name
@company_name.setter
def company_name(self, company_name):
"""Sets the company_name of this MasterDetailsResponse.
Company name of master account organization # noqa: E501
:param company_name: The company_name of this MasterDetailsResponse. # noqa: E501
:type: str
"""
self._company_name = company_name
@property
def id(self):
"""Gets the id of this MasterDetailsResponse. # noqa: E501
Unique identifier of the master account organization # noqa: E501
:return: The id of this MasterDetailsResponse. # noqa: E501
:rtype: int
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this MasterDetailsResponse.
Unique identifier of the master account organization # noqa: E501
:param id: The id of this MasterDetailsResponse. # noqa: E501
:type: int
"""
self._id = id
@property
def currency_code(self):
"""Gets the currency_code of this MasterDetailsResponse. # noqa: E501
Currency code of the master account organization # noqa: E501
:return: The currency_code of this MasterDetailsResponse. # noqa: E501
:rtype: str
"""
return self._currency_code
@currency_code.setter
def currency_code(self, currency_code):
"""Sets the currency_code of this MasterDetailsResponse.
Currency code of the master account organization # noqa: E501
:param currency_code: The currency_code of this MasterDetailsResponse. # noqa: E501
:type: str
"""
self._currency_code = currency_code
@property
def timezone(self):
"""Gets the timezone of this MasterDetailsResponse. # noqa: E501
Timezone of the master account organization # noqa: E501
:return: The timezone of this MasterDetailsResponse. # noqa: E501
:rtype: str
"""
return self._timezone
@timezone.setter
def timezone(self, timezone):
"""Sets the timezone of this MasterDetailsResponse.
Timezone of the master account organization # noqa: E501
:param timezone: The timezone of this MasterDetailsResponse. # noqa: E501
:type: str
"""
self._timezone = timezone
@property
def billing_info(self):
"""Gets the billing_info of this MasterDetailsResponse. # noqa: E501
:return: The billing_info of this MasterDetailsResponse. # noqa: E501
:rtype: MasterDetailsResponseBillingInfo
"""
return self._billing_info
@billing_info.setter
def billing_info(self, billing_info):
"""Sets the billing_info of this MasterDetailsResponse.
:param billing_info: The billing_info of this MasterDetailsResponse. # noqa: E501
:type: MasterDetailsResponseBillingInfo
"""
self._billing_info = billing_info
@property
def plan_info(self):
"""Gets the plan_info of this MasterDetailsResponse. # noqa: E501
:return: The plan_info of this MasterDetailsResponse. # noqa: E501
:rtype: MasterDetailsResponsePlanInfo
"""
return self._plan_info
@plan_info.setter
def plan_info(self, plan_info):
"""Sets the plan_info of this MasterDetailsResponse.
:param plan_info: The plan_info of this MasterDetailsResponse. # noqa: E501
:type: MasterDetailsResponsePlanInfo
"""
self._plan_info = plan_info
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(MasterDetailsResponse, 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, MasterDetailsResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(email=None, company_name=None, id=None, currency_code=None, timezone=None, billing_info=None, plan_info=None)
|
59,658 |
sib_api_v3_sdk.models.master_details_response
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, MasterDetailsResponse):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,659 |
sib_api_v3_sdk.models.master_details_response
|
__init__
|
MasterDetailsResponse - a model defined in Swagger
|
def __init__(self, email=None, company_name=None, id=None, currency_code=None, timezone=None, billing_info=None, plan_info=None): # noqa: E501
"""MasterDetailsResponse - a model defined in Swagger""" # noqa: E501
self._email = None
self._company_name = None
self._id = None
self._currency_code = None
self._timezone = None
self._billing_info = None
self._plan_info = None
self.discriminator = None
if email is not None:
self.email = email
if company_name is not None:
self.company_name = company_name
if id is not None:
self.id = id
if currency_code is not None:
self.currency_code = currency_code
if timezone is not None:
self.timezone = timezone
if billing_info is not None:
self.billing_info = billing_info
if plan_info is not None:
self.plan_info = plan_info
|
(self, email=None, company_name=None, id=None, currency_code=None, timezone=None, billing_info=None, plan_info=None)
|
59,662 |
sib_api_v3_sdk.models.master_details_response
|
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(MasterDetailsResponse, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,664 |
sib_api_v3_sdk.models.master_details_response_billing_info
|
MasterDetailsResponseBillingInfo
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class MasterDetailsResponseBillingInfo(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 = {
'email': 'str',
'company_name': 'str',
'name': 'MasterDetailsResponseBillingInfoName',
'address': 'MasterDetailsResponseBillingInfoAddress'
}
attribute_map = {
'email': 'email',
'company_name': 'companyName',
'name': 'name',
'address': 'address'
}
def __init__(self, email=None, company_name=None, name=None, address=None): # noqa: E501
"""MasterDetailsResponseBillingInfo - a model defined in Swagger""" # noqa: E501
self._email = None
self._company_name = None
self._name = None
self._address = None
self.discriminator = None
if email is not None:
self.email = email
if company_name is not None:
self.company_name = company_name
if name is not None:
self.name = name
if address is not None:
self.address = address
@property
def email(self):
"""Gets the email of this MasterDetailsResponseBillingInfo. # noqa: E501
Billing email id of master account # noqa: E501
:return: The email of this MasterDetailsResponseBillingInfo. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this MasterDetailsResponseBillingInfo.
Billing email id of master account # noqa: E501
:param email: The email of this MasterDetailsResponseBillingInfo. # noqa: E501
:type: str
"""
self._email = email
@property
def company_name(self):
"""Gets the company_name of this MasterDetailsResponseBillingInfo. # noqa: E501
Company name of master account # noqa: E501
:return: The company_name of this MasterDetailsResponseBillingInfo. # noqa: E501
:rtype: str
"""
return self._company_name
@company_name.setter
def company_name(self, company_name):
"""Sets the company_name of this MasterDetailsResponseBillingInfo.
Company name of master account # noqa: E501
:param company_name: The company_name of this MasterDetailsResponseBillingInfo. # noqa: E501
:type: str
"""
self._company_name = company_name
@property
def name(self):
"""Gets the name of this MasterDetailsResponseBillingInfo. # noqa: E501
:return: The name of this MasterDetailsResponseBillingInfo. # noqa: E501
:rtype: MasterDetailsResponseBillingInfoName
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this MasterDetailsResponseBillingInfo.
:param name: The name of this MasterDetailsResponseBillingInfo. # noqa: E501
:type: MasterDetailsResponseBillingInfoName
"""
self._name = name
@property
def address(self):
"""Gets the address of this MasterDetailsResponseBillingInfo. # noqa: E501
:return: The address of this MasterDetailsResponseBillingInfo. # noqa: E501
:rtype: MasterDetailsResponseBillingInfoAddress
"""
return self._address
@address.setter
def address(self, address):
"""Sets the address of this MasterDetailsResponseBillingInfo.
:param address: The address of this MasterDetailsResponseBillingInfo. # noqa: E501
:type: MasterDetailsResponseBillingInfoAddress
"""
self._address = address
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(MasterDetailsResponseBillingInfo, 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, MasterDetailsResponseBillingInfo):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(email=None, company_name=None, name=None, address=None)
|
59,665 |
sib_api_v3_sdk.models.master_details_response_billing_info
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, MasterDetailsResponseBillingInfo):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,666 |
sib_api_v3_sdk.models.master_details_response_billing_info
|
__init__
|
MasterDetailsResponseBillingInfo - a model defined in Swagger
|
def __init__(self, email=None, company_name=None, name=None, address=None): # noqa: E501
"""MasterDetailsResponseBillingInfo - a model defined in Swagger""" # noqa: E501
self._email = None
self._company_name = None
self._name = None
self._address = None
self.discriminator = None
if email is not None:
self.email = email
if company_name is not None:
self.company_name = company_name
if name is not None:
self.name = name
if address is not None:
self.address = address
|
(self, email=None, company_name=None, name=None, address=None)
|
59,669 |
sib_api_v3_sdk.models.master_details_response_billing_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(MasterDetailsResponseBillingInfo, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,671 |
sib_api_v3_sdk.models.master_details_response_billing_info_address
|
MasterDetailsResponseBillingInfoAddress
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class MasterDetailsResponseBillingInfoAddress(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 = {
'street_address': 'str',
'locality': 'str',
'postal_code': 'str',
'state_code': 'str',
'country_code': 'str'
}
attribute_map = {
'street_address': 'streetAddress',
'locality': 'locality',
'postal_code': 'postalCode',
'state_code': 'stateCode',
'country_code': 'countryCode'
}
def __init__(self, street_address=None, locality=None, postal_code=None, state_code=None, country_code=None): # noqa: E501
"""MasterDetailsResponseBillingInfoAddress - a model defined in Swagger""" # noqa: E501
self._street_address = None
self._locality = None
self._postal_code = None
self._state_code = None
self._country_code = None
self.discriminator = None
if street_address is not None:
self.street_address = street_address
if locality is not None:
self.locality = locality
if postal_code is not None:
self.postal_code = postal_code
if state_code is not None:
self.state_code = state_code
if country_code is not None:
self.country_code = country_code
@property
def street_address(self):
"""Gets the street_address of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
Street address # noqa: E501
:return: The street_address of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
:rtype: str
"""
return self._street_address
@street_address.setter
def street_address(self, street_address):
"""Sets the street_address of this MasterDetailsResponseBillingInfoAddress.
Street address # noqa: E501
:param street_address: The street_address of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
:type: str
"""
self._street_address = street_address
@property
def locality(self):
"""Gets the locality of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
Locality # noqa: E501
:return: The locality of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
:rtype: str
"""
return self._locality
@locality.setter
def locality(self, locality):
"""Sets the locality of this MasterDetailsResponseBillingInfoAddress.
Locality # noqa: E501
:param locality: The locality of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
:type: str
"""
self._locality = locality
@property
def postal_code(self):
"""Gets the postal_code of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
Postal code # noqa: E501
:return: The postal_code of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
:rtype: str
"""
return self._postal_code
@postal_code.setter
def postal_code(self, postal_code):
"""Sets the postal_code of this MasterDetailsResponseBillingInfoAddress.
Postal code # noqa: E501
:param postal_code: The postal_code of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
:type: str
"""
self._postal_code = postal_code
@property
def state_code(self):
"""Gets the state_code of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
State code # noqa: E501
:return: The state_code of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
:rtype: str
"""
return self._state_code
@state_code.setter
def state_code(self, state_code):
"""Sets the state_code of this MasterDetailsResponseBillingInfoAddress.
State code # noqa: E501
:param state_code: The state_code of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
:type: str
"""
self._state_code = state_code
@property
def country_code(self):
"""Gets the country_code of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
Country code # noqa: E501
:return: The country_code of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
:rtype: str
"""
return self._country_code
@country_code.setter
def country_code(self, country_code):
"""Sets the country_code of this MasterDetailsResponseBillingInfoAddress.
Country code # noqa: E501
:param country_code: The country_code of this MasterDetailsResponseBillingInfoAddress. # noqa: E501
:type: str
"""
self._country_code = country_code
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(MasterDetailsResponseBillingInfoAddress, 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, MasterDetailsResponseBillingInfoAddress):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(street_address=None, locality=None, postal_code=None, state_code=None, country_code=None)
|
59,672 |
sib_api_v3_sdk.models.master_details_response_billing_info_address
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, MasterDetailsResponseBillingInfoAddress):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,673 |
sib_api_v3_sdk.models.master_details_response_billing_info_address
|
__init__
|
MasterDetailsResponseBillingInfoAddress - a model defined in Swagger
|
def __init__(self, street_address=None, locality=None, postal_code=None, state_code=None, country_code=None): # noqa: E501
"""MasterDetailsResponseBillingInfoAddress - a model defined in Swagger""" # noqa: E501
self._street_address = None
self._locality = None
self._postal_code = None
self._state_code = None
self._country_code = None
self.discriminator = None
if street_address is not None:
self.street_address = street_address
if locality is not None:
self.locality = locality
if postal_code is not None:
self.postal_code = postal_code
if state_code is not None:
self.state_code = state_code
if country_code is not None:
self.country_code = country_code
|
(self, street_address=None, locality=None, postal_code=None, state_code=None, country_code=None)
|
59,676 |
sib_api_v3_sdk.models.master_details_response_billing_info_address
|
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(MasterDetailsResponseBillingInfoAddress, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,678 |
sib_api_v3_sdk.models.master_details_response_billing_info_name
|
MasterDetailsResponseBillingInfoName
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class MasterDetailsResponseBillingInfoName(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 = {
'given_name': 'str',
'family_name': 'str'
}
attribute_map = {
'given_name': 'givenName',
'family_name': 'familyName'
}
def __init__(self, given_name=None, family_name=None): # noqa: E501
"""MasterDetailsResponseBillingInfoName - a model defined in Swagger""" # noqa: E501
self._given_name = None
self._family_name = None
self.discriminator = None
if given_name is not None:
self.given_name = given_name
if family_name is not None:
self.family_name = family_name
@property
def given_name(self):
"""Gets the given_name of this MasterDetailsResponseBillingInfoName. # noqa: E501
First name for billing # noqa: E501
:return: The given_name of this MasterDetailsResponseBillingInfoName. # noqa: E501
:rtype: str
"""
return self._given_name
@given_name.setter
def given_name(self, given_name):
"""Sets the given_name of this MasterDetailsResponseBillingInfoName.
First name for billing # noqa: E501
:param given_name: The given_name of this MasterDetailsResponseBillingInfoName. # noqa: E501
:type: str
"""
self._given_name = given_name
@property
def family_name(self):
"""Gets the family_name of this MasterDetailsResponseBillingInfoName. # noqa: E501
Last name for billing # noqa: E501
:return: The family_name of this MasterDetailsResponseBillingInfoName. # noqa: E501
:rtype: str
"""
return self._family_name
@family_name.setter
def family_name(self, family_name):
"""Sets the family_name of this MasterDetailsResponseBillingInfoName.
Last name for billing # noqa: E501
:param family_name: The family_name of this MasterDetailsResponseBillingInfoName. # noqa: E501
:type: str
"""
self._family_name = family_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(MasterDetailsResponseBillingInfoName, 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, MasterDetailsResponseBillingInfoName):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(given_name=None, family_name=None)
|
59,679 |
sib_api_v3_sdk.models.master_details_response_billing_info_name
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, MasterDetailsResponseBillingInfoName):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,680 |
sib_api_v3_sdk.models.master_details_response_billing_info_name
|
__init__
|
MasterDetailsResponseBillingInfoName - a model defined in Swagger
|
def __init__(self, given_name=None, family_name=None): # noqa: E501
"""MasterDetailsResponseBillingInfoName - a model defined in Swagger""" # noqa: E501
self._given_name = None
self._family_name = None
self.discriminator = None
if given_name is not None:
self.given_name = given_name
if family_name is not None:
self.family_name = family_name
|
(self, given_name=None, family_name=None)
|
59,683 |
sib_api_v3_sdk.models.master_details_response_billing_info_name
|
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(MasterDetailsResponseBillingInfoName, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,685 |
sib_api_v3_sdk.models.master_details_response_plan_info
|
MasterDetailsResponsePlanInfo
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class MasterDetailsResponsePlanInfo(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 = {
'currency_code': 'str',
'next_billing_at': 'int',
'price': 'float',
'plan_period': 'str',
'sub_accounts': 'int',
'features': 'list[MasterDetailsResponsePlanInfoFeatures]'
}
attribute_map = {
'currency_code': 'currencyCode',
'next_billing_at': 'nextBillingAt',
'price': 'price',
'plan_period': 'planPeriod',
'sub_accounts': 'subAccounts',
'features': 'features'
}
def __init__(self, currency_code=None, next_billing_at=None, price=None, plan_period=None, sub_accounts=None, features=None): # noqa: E501
"""MasterDetailsResponsePlanInfo - a model defined in Swagger""" # noqa: E501
self._currency_code = None
self._next_billing_at = None
self._price = None
self._plan_period = None
self._sub_accounts = None
self._features = None
self.discriminator = None
if currency_code is not None:
self.currency_code = currency_code
if next_billing_at is not None:
self.next_billing_at = next_billing_at
if price is not None:
self.price = price
if plan_period is not None:
self.plan_period = plan_period
if sub_accounts is not None:
self.sub_accounts = sub_accounts
if features is not None:
self.features = features
@property
def currency_code(self):
"""Gets the currency_code of this MasterDetailsResponsePlanInfo. # noqa: E501
Plan currency # noqa: E501
:return: The currency_code of this MasterDetailsResponsePlanInfo. # noqa: E501
:rtype: str
"""
return self._currency_code
@currency_code.setter
def currency_code(self, currency_code):
"""Sets the currency_code of this MasterDetailsResponsePlanInfo.
Plan currency # noqa: E501
:param currency_code: The currency_code of this MasterDetailsResponsePlanInfo. # noqa: E501
:type: str
"""
self._currency_code = currency_code
@property
def next_billing_at(self):
"""Gets the next_billing_at of this MasterDetailsResponsePlanInfo. # noqa: E501
Timestamp of next billing date # noqa: E501
:return: The next_billing_at of this MasterDetailsResponsePlanInfo. # noqa: E501
:rtype: int
"""
return self._next_billing_at
@next_billing_at.setter
def next_billing_at(self, next_billing_at):
"""Sets the next_billing_at of this MasterDetailsResponsePlanInfo.
Timestamp of next billing date # noqa: E501
:param next_billing_at: The next_billing_at of this MasterDetailsResponsePlanInfo. # noqa: E501
:type: int
"""
self._next_billing_at = next_billing_at
@property
def price(self):
"""Gets the price of this MasterDetailsResponsePlanInfo. # noqa: E501
Plan amount # noqa: E501
:return: The price of this MasterDetailsResponsePlanInfo. # noqa: E501
:rtype: float
"""
return self._price
@price.setter
def price(self, price):
"""Sets the price of this MasterDetailsResponsePlanInfo.
Plan amount # noqa: E501
:param price: The price of this MasterDetailsResponsePlanInfo. # noqa: E501
:type: float
"""
self._price = price
@property
def plan_period(self):
"""Gets the plan_period of this MasterDetailsResponsePlanInfo. # noqa: E501
Plan period type # noqa: E501
:return: The plan_period of this MasterDetailsResponsePlanInfo. # noqa: E501
:rtype: str
"""
return self._plan_period
@plan_period.setter
def plan_period(self, plan_period):
"""Sets the plan_period of this MasterDetailsResponsePlanInfo.
Plan period type # noqa: E501
:param plan_period: The plan_period of this MasterDetailsResponsePlanInfo. # noqa: E501
:type: str
"""
allowed_values = ["month", "year"] # noqa: E501
if plan_period not in allowed_values:
raise ValueError(
"Invalid value for `plan_period` ({0}), must be one of {1}" # noqa: E501
.format(plan_period, allowed_values)
)
self._plan_period = plan_period
@property
def sub_accounts(self):
"""Gets the sub_accounts of this MasterDetailsResponsePlanInfo. # noqa: E501
Number of sub-accounts # noqa: E501
:return: The sub_accounts of this MasterDetailsResponsePlanInfo. # noqa: E501
:rtype: int
"""
return self._sub_accounts
@sub_accounts.setter
def sub_accounts(self, sub_accounts):
"""Sets the sub_accounts of this MasterDetailsResponsePlanInfo.
Number of sub-accounts # noqa: E501
:param sub_accounts: The sub_accounts of this MasterDetailsResponsePlanInfo. # noqa: E501
:type: int
"""
self._sub_accounts = sub_accounts
@property
def features(self):
"""Gets the features of this MasterDetailsResponsePlanInfo. # noqa: E501
List of provided features in the plan # noqa: E501
:return: The features of this MasterDetailsResponsePlanInfo. # noqa: E501
:rtype: list[MasterDetailsResponsePlanInfoFeatures]
"""
return self._features
@features.setter
def features(self, features):
"""Sets the features of this MasterDetailsResponsePlanInfo.
List of provided features in the plan # noqa: E501
:param features: The features of this MasterDetailsResponsePlanInfo. # noqa: E501
:type: list[MasterDetailsResponsePlanInfoFeatures]
"""
self._features = features
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(MasterDetailsResponsePlanInfo, 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, MasterDetailsResponsePlanInfo):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(currency_code=None, next_billing_at=None, price=None, plan_period=None, sub_accounts=None, features=None)
|
59,686 |
sib_api_v3_sdk.models.master_details_response_plan_info
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, MasterDetailsResponsePlanInfo):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,687 |
sib_api_v3_sdk.models.master_details_response_plan_info
|
__init__
|
MasterDetailsResponsePlanInfo - a model defined in Swagger
|
def __init__(self, currency_code=None, next_billing_at=None, price=None, plan_period=None, sub_accounts=None, features=None): # noqa: E501
"""MasterDetailsResponsePlanInfo - a model defined in Swagger""" # noqa: E501
self._currency_code = None
self._next_billing_at = None
self._price = None
self._plan_period = None
self._sub_accounts = None
self._features = None
self.discriminator = None
if currency_code is not None:
self.currency_code = currency_code
if next_billing_at is not None:
self.next_billing_at = next_billing_at
if price is not None:
self.price = price
if plan_period is not None:
self.plan_period = plan_period
if sub_accounts is not None:
self.sub_accounts = sub_accounts
if features is not None:
self.features = features
|
(self, currency_code=None, next_billing_at=None, price=None, plan_period=None, sub_accounts=None, features=None)
|
59,690 |
sib_api_v3_sdk.models.master_details_response_plan_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(MasterDetailsResponsePlanInfo, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,692 |
sib_api_v3_sdk.models.master_details_response_plan_info_features
|
MasterDetailsResponsePlanInfoFeatures
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class MasterDetailsResponsePlanInfoFeatures(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'name': 'str',
'unit_value': 'str',
'quantity': 'int',
'used': 'int',
'remaining': 'int'
}
attribute_map = {
'name': 'name',
'unit_value': 'unitValue',
'quantity': 'quantity',
'used': 'used',
'remaining': 'remaining'
}
def __init__(self, name=None, unit_value=None, quantity=None, used=None, remaining=None): # noqa: E501
"""MasterDetailsResponsePlanInfoFeatures - a model defined in Swagger""" # noqa: E501
self._name = None
self._unit_value = None
self._quantity = None
self._used = None
self._remaining = None
self.discriminator = None
if name is not None:
self.name = name
if unit_value is not None:
self.unit_value = unit_value
if quantity is not None:
self.quantity = quantity
if used is not None:
self.used = used
if remaining is not None:
self.remaining = remaining
@property
def name(self):
"""Gets the name of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
Name of the feature # noqa: E501
:return: The name of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this MasterDetailsResponsePlanInfoFeatures.
Name of the feature # noqa: E501
:param name: The name of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
:type: str
"""
self._name = name
@property
def unit_value(self):
"""Gets the unit_value of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
Unit value of the feature # noqa: E501
:return: The unit_value of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
:rtype: str
"""
return self._unit_value
@unit_value.setter
def unit_value(self, unit_value):
"""Sets the unit_value of this MasterDetailsResponsePlanInfoFeatures.
Unit value of the feature # noqa: E501
:param unit_value: The unit_value of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
:type: str
"""
self._unit_value = unit_value
@property
def quantity(self):
"""Gets the quantity of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
Quantity provided in the plan # noqa: E501
:return: The quantity of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
:rtype: int
"""
return self._quantity
@quantity.setter
def quantity(self, quantity):
"""Sets the quantity of this MasterDetailsResponsePlanInfoFeatures.
Quantity provided in the plan # noqa: E501
:param quantity: The quantity of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
:type: int
"""
self._quantity = quantity
@property
def used(self):
"""Gets the used of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
Quantity consumed by master # noqa: E501
:return: The used of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
:rtype: int
"""
return self._used
@used.setter
def used(self, used):
"""Sets the used of this MasterDetailsResponsePlanInfoFeatures.
Quantity consumed by master # noqa: E501
:param used: The used of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
:type: int
"""
self._used = used
@property
def remaining(self):
"""Gets the remaining of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
Quantity remaining in the plan # noqa: E501
:return: The remaining of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
:rtype: int
"""
return self._remaining
@remaining.setter
def remaining(self, remaining):
"""Sets the remaining of this MasterDetailsResponsePlanInfoFeatures.
Quantity remaining in the plan # noqa: E501
:param remaining: The remaining of this MasterDetailsResponsePlanInfoFeatures. # noqa: E501
:type: int
"""
self._remaining = remaining
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(MasterDetailsResponsePlanInfoFeatures, 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, MasterDetailsResponsePlanInfoFeatures):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(name=None, unit_value=None, quantity=None, used=None, remaining=None)
|
59,693 |
sib_api_v3_sdk.models.master_details_response_plan_info_features
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, MasterDetailsResponsePlanInfoFeatures):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,694 |
sib_api_v3_sdk.models.master_details_response_plan_info_features
|
__init__
|
MasterDetailsResponsePlanInfoFeatures - a model defined in Swagger
|
def __init__(self, name=None, unit_value=None, quantity=None, used=None, remaining=None): # noqa: E501
"""MasterDetailsResponsePlanInfoFeatures - a model defined in Swagger""" # noqa: E501
self._name = None
self._unit_value = None
self._quantity = None
self._used = None
self._remaining = None
self.discriminator = None
if name is not None:
self.name = name
if unit_value is not None:
self.unit_value = unit_value
if quantity is not None:
self.quantity = quantity
if used is not None:
self.used = used
if remaining is not None:
self.remaining = remaining
|
(self, name=None, unit_value=None, quantity=None, used=None, remaining=None)
|
59,697 |
sib_api_v3_sdk.models.master_details_response_plan_info_features
|
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(MasterDetailsResponsePlanInfoFeatures, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,699 |
sib_api_v3_sdk.models.note
|
Note
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class Note(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',
'text': 'str',
'contact_ids': 'list[int]',
'deal_ids': 'list[str]',
'author_id': 'object',
'created_at': 'datetime',
'updated_at': 'datetime'
}
attribute_map = {
'id': 'id',
'text': 'text',
'contact_ids': 'contactIds',
'deal_ids': 'dealIds',
'author_id': 'authorId',
'created_at': 'createdAt',
'updated_at': 'updatedAt'
}
def __init__(self, id=None, text=None, contact_ids=None, deal_ids=None, author_id=None, created_at=None, updated_at=None): # noqa: E501
"""Note - a model defined in Swagger""" # noqa: E501
self._id = None
self._text = None
self._contact_ids = None
self._deal_ids = None
self._author_id = None
self._created_at = None
self._updated_at = None
self.discriminator = None
if id is not None:
self.id = id
self.text = text
if contact_ids is not None:
self.contact_ids = contact_ids
if deal_ids is not None:
self.deal_ids = deal_ids
if author_id is not None:
self.author_id = author_id
if created_at is not None:
self.created_at = created_at
if updated_at is not None:
self.updated_at = updated_at
@property
def id(self):
"""Gets the id of this Note. # noqa: E501
Unique note Id # noqa: E501
:return: The id of this Note. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this Note.
Unique note Id # noqa: E501
:param id: The id of this Note. # noqa: E501
:type: str
"""
self._id = id
@property
def text(self):
"""Gets the text of this Note. # noqa: E501
Text content of a note # noqa: E501
:return: The text of this Note. # noqa: E501
:rtype: str
"""
return self._text
@text.setter
def text(self, text):
"""Sets the text of this Note.
Text content of a note # noqa: E501
:param text: The text of this Note. # noqa: E501
:type: str
"""
if text is None:
raise ValueError("Invalid value for `text`, must not be `None`") # noqa: E501
if text is not None and len(text) > 3000:
raise ValueError("Invalid value for `text`, length must be less than or equal to `3000`") # noqa: E501
if text is not None and len(text) < 1:
raise ValueError("Invalid value for `text`, length must be greater than or equal to `1`") # noqa: E501
self._text = text
@property
def contact_ids(self):
"""Gets the contact_ids of this Note. # noqa: E501
Contact ids linked to a note # noqa: E501
:return: The contact_ids of this Note. # noqa: E501
:rtype: list[int]
"""
return self._contact_ids
@contact_ids.setter
def contact_ids(self, contact_ids):
"""Sets the contact_ids of this Note.
Contact ids linked to a note # noqa: E501
:param contact_ids: The contact_ids of this Note. # noqa: E501
:type: list[int]
"""
self._contact_ids = contact_ids
@property
def deal_ids(self):
"""Gets the deal_ids of this Note. # noqa: E501
Deal ids linked to a note # noqa: E501
:return: The deal_ids of this Note. # noqa: E501
:rtype: list[str]
"""
return self._deal_ids
@deal_ids.setter
def deal_ids(self, deal_ids):
"""Sets the deal_ids of this Note.
Deal ids linked to a note # noqa: E501
:param deal_ids: The deal_ids of this Note. # noqa: E501
:type: list[str]
"""
self._deal_ids = deal_ids
@property
def author_id(self):
"""Gets the author_id of this Note. # noqa: E501
Account details of user which created the note # noqa: E501
:return: The author_id of this Note. # noqa: E501
:rtype: object
"""
return self._author_id
@author_id.setter
def author_id(self, author_id):
"""Sets the author_id of this Note.
Account details of user which created the note # noqa: E501
:param author_id: The author_id of this Note. # noqa: E501
:type: object
"""
self._author_id = author_id
@property
def created_at(self):
"""Gets the created_at of this Note. # noqa: E501
Note created date/time # noqa: E501
:return: The created_at of this Note. # noqa: E501
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""Sets the created_at of this Note.
Note created date/time # noqa: E501
:param created_at: The created_at of this Note. # noqa: E501
:type: datetime
"""
self._created_at = created_at
@property
def updated_at(self):
"""Gets the updated_at of this Note. # noqa: E501
Note updated date/time # noqa: E501
:return: The updated_at of this Note. # noqa: E501
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""Sets the updated_at of this Note.
Note updated date/time # noqa: E501
:param updated_at: The updated_at of this Note. # noqa: E501
:type: datetime
"""
self._updated_at = updated_at
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(Note, 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, Note):
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, text=None, contact_ids=None, deal_ids=None, author_id=None, created_at=None, updated_at=None)
|
59,700 |
sib_api_v3_sdk.models.note
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, Note):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,701 |
sib_api_v3_sdk.models.note
|
__init__
|
Note - a model defined in Swagger
|
def __init__(self, id=None, text=None, contact_ids=None, deal_ids=None, author_id=None, created_at=None, updated_at=None): # noqa: E501
"""Note - a model defined in Swagger""" # noqa: E501
self._id = None
self._text = None
self._contact_ids = None
self._deal_ids = None
self._author_id = None
self._created_at = None
self._updated_at = None
self.discriminator = None
if id is not None:
self.id = id
self.text = text
if contact_ids is not None:
self.contact_ids = contact_ids
if deal_ids is not None:
self.deal_ids = deal_ids
if author_id is not None:
self.author_id = author_id
if created_at is not None:
self.created_at = created_at
if updated_at is not None:
self.updated_at = updated_at
|
(self, id=None, text=None, contact_ids=None, deal_ids=None, author_id=None, created_at=None, updated_at=None)
|
59,704 |
sib_api_v3_sdk.models.note
|
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(Note, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,706 |
sib_api_v3_sdk.models.note_data
|
NoteData
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class NoteData(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 = {
'text': 'str',
'contact_ids': 'list[int]',
'deal_ids': 'list[str]',
'company_ids': 'list[str]'
}
attribute_map = {
'text': 'text',
'contact_ids': 'contactIds',
'deal_ids': 'dealIds',
'company_ids': 'companyIds'
}
def __init__(self, text=None, contact_ids=None, deal_ids=None, company_ids=None): # noqa: E501
"""NoteData - a model defined in Swagger""" # noqa: E501
self._text = None
self._contact_ids = None
self._deal_ids = None
self._company_ids = None
self.discriminator = None
self.text = text
if contact_ids is not None:
self.contact_ids = contact_ids
if deal_ids is not None:
self.deal_ids = deal_ids
if company_ids is not None:
self.company_ids = company_ids
@property
def text(self):
"""Gets the text of this NoteData. # noqa: E501
Text content of a note # noqa: E501
:return: The text of this NoteData. # noqa: E501
:rtype: str
"""
return self._text
@text.setter
def text(self, text):
"""Sets the text of this NoteData.
Text content of a note # noqa: E501
:param text: The text of this NoteData. # noqa: E501
:type: str
"""
if text is None:
raise ValueError("Invalid value for `text`, must not be `None`") # noqa: E501
if text is not None and len(text) > 3000:
raise ValueError("Invalid value for `text`, length must be less than or equal to `3000`") # noqa: E501
if text is not None and len(text) < 1:
raise ValueError("Invalid value for `text`, length must be greater than or equal to `1`") # noqa: E501
self._text = text
@property
def contact_ids(self):
"""Gets the contact_ids of this NoteData. # noqa: E501
Contact Ids linked to a note # noqa: E501
:return: The contact_ids of this NoteData. # noqa: E501
:rtype: list[int]
"""
return self._contact_ids
@contact_ids.setter
def contact_ids(self, contact_ids):
"""Sets the contact_ids of this NoteData.
Contact Ids linked to a note # noqa: E501
:param contact_ids: The contact_ids of this NoteData. # noqa: E501
:type: list[int]
"""
self._contact_ids = contact_ids
@property
def deal_ids(self):
"""Gets the deal_ids of this NoteData. # noqa: E501
Deal Ids linked to a note # noqa: E501
:return: The deal_ids of this NoteData. # noqa: E501
:rtype: list[str]
"""
return self._deal_ids
@deal_ids.setter
def deal_ids(self, deal_ids):
"""Sets the deal_ids of this NoteData.
Deal Ids linked to a note # noqa: E501
:param deal_ids: The deal_ids of this NoteData. # noqa: E501
:type: list[str]
"""
self._deal_ids = deal_ids
@property
def company_ids(self):
"""Gets the company_ids of this NoteData. # noqa: E501
Company Ids linked to a note # noqa: E501
:return: The company_ids of this NoteData. # noqa: E501
:rtype: list[str]
"""
return self._company_ids
@company_ids.setter
def company_ids(self, company_ids):
"""Sets the company_ids of this NoteData.
Company Ids linked to a note # noqa: E501
:param company_ids: The company_ids of this NoteData. # noqa: E501
:type: list[str]
"""
self._company_ids = company_ids
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(NoteData, 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, NoteData):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(text=None, contact_ids=None, deal_ids=None, company_ids=None)
|
59,707 |
sib_api_v3_sdk.models.note_data
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, NoteData):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,708 |
sib_api_v3_sdk.models.note_data
|
__init__
|
NoteData - a model defined in Swagger
|
def __init__(self, text=None, contact_ids=None, deal_ids=None, company_ids=None): # noqa: E501
"""NoteData - a model defined in Swagger""" # noqa: E501
self._text = None
self._contact_ids = None
self._deal_ids = None
self._company_ids = None
self.discriminator = None
self.text = text
if contact_ids is not None:
self.contact_ids = contact_ids
if deal_ids is not None:
self.deal_ids = deal_ids
if company_ids is not None:
self.company_ids = company_ids
|
(self, text=None, contact_ids=None, deal_ids=None, company_ids=None)
|
59,711 |
sib_api_v3_sdk.models.note_data
|
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(NoteData, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,713 |
sib_api_v3_sdk.models.note_id
|
NoteId
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class NoteId(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'
}
attribute_map = {
'id': 'id'
}
def __init__(self, id=None): # noqa: E501
"""NoteId - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
if id is not None:
self.id = id
@property
def id(self):
"""Gets the id of this NoteId. # noqa: E501
Unique note Id # noqa: E501
:return: The id of this NoteId. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this NoteId.
Unique note Id # noqa: E501
:param id: The id of this NoteId. # noqa: E501
:type: str
"""
self._id = id
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(NoteId, 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, NoteId):
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)
|
59,714 |
sib_api_v3_sdk.models.note_id
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, NoteId):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,715 |
sib_api_v3_sdk.models.note_id
|
__init__
|
NoteId - a model defined in Swagger
|
def __init__(self, id=None): # noqa: E501
"""NoteId - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
if id is not None:
self.id = id
|
(self, id=None)
|
59,718 |
sib_api_v3_sdk.models.note_id
|
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(NoteId, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,720 |
sib_api_v3_sdk.models.note_list
|
NoteList
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class NoteList(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 = {
}
attribute_map = {
}
def __init__(self): # noqa: E501
"""NoteList - a model defined in Swagger""" # noqa: E501
self.discriminator = None
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(NoteList, 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, NoteList):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
()
|
59,721 |
sib_api_v3_sdk.models.note_list
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, NoteList):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,722 |
sib_api_v3_sdk.models.note_list
|
__init__
|
NoteList - a model defined in Swagger
|
def __init__(self): # noqa: E501
"""NoteList - a model defined in Swagger""" # noqa: E501
self.discriminator = None
|
(self)
|
59,725 |
sib_api_v3_sdk.models.note_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(NoteList, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,727 |
sib_api_v3_sdk.api.notes_api
|
NotesApi
|
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 NotesApi(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 crm_notes_get(self, **kwargs): # noqa: E501
"""Get all notes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by note entity type
:param str entity_ids: Filter by note entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: NoteList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_notes_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.crm_notes_get_with_http_info(**kwargs) # noqa: E501
return data
def crm_notes_get_with_http_info(self, **kwargs): # noqa: E501
"""Get all notes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by note entity type
:param str entity_ids: Filter by note entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: NoteList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['entity', 'entity_ids', 'date_from', 'date_to', 'offset', 'limit', '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 crm_notes_get" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'entity' in params:
query_params.append(('entity', params['entity'])) # noqa: E501
if 'entity_ids' in params:
query_params.append(('entityIds', params['entity_ids'])) # noqa: E501
if 'date_from' in params:
query_params.append(('dateFrom', params['date_from'])) # noqa: E501
if 'date_to' in params:
query_params.append(('dateTo', params['date_to'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # 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(
'/crm/notes', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='NoteList', # 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 crm_notes_id_delete(self, id, **kwargs): # noqa: E501
"""Delete a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to delete (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.crm_notes_id_delete_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.crm_notes_id_delete_with_http_info(id, **kwargs) # noqa: E501
return data
def crm_notes_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 crm_notes_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['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(
'/crm/notes/{id}', '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 crm_notes_id_get(self, id, **kwargs): # noqa: E501
"""Get a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to get (required)
:return: Note
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_notes_id_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.crm_notes_id_get_with_http_info(id, **kwargs) # noqa: E501
return data
def crm_notes_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Get a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to get (required)
:return: Note
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 crm_notes_id_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['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(
'/crm/notes/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Note', # 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 crm_notes_id_patch(self, id, body, **kwargs): # noqa: E501
"""Update a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_patch(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to update (required)
:param NoteData body: Note data to update a note (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.crm_notes_id_patch_with_http_info(id, body, **kwargs) # noqa: E501
else:
(data) = self.crm_notes_id_patch_with_http_info(id, body, **kwargs) # noqa: E501
return data
def crm_notes_id_patch_with_http_info(self, id, body, **kwargs): # noqa: E501
"""Update a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_patch_with_http_info(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to update (required)
:param NoteData body: Note data to update a note (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id', 'body'] # 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 crm_notes_id_patch" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_patch`") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `crm_notes_id_patch`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# 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(
'/crm/notes/{id}', 'PATCH',
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 crm_notes_post(self, body, **kwargs): # noqa: E501
"""Create a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param NoteData body: Note data to create a note. (required)
:return: NoteId
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_notes_post_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.crm_notes_post_with_http_info(body, **kwargs) # noqa: E501
return data
def crm_notes_post_with_http_info(self, body, **kwargs): # noqa: E501
"""Create a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param NoteData body: Note data to create a note. (required)
:return: NoteId
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # 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 crm_notes_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `crm_notes_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# 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(
'/crm/notes', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='NoteId', # 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,729 |
sib_api_v3_sdk.api.notes_api
|
crm_notes_get
|
Get all notes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by note entity type
:param str entity_ids: Filter by note entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: NoteList
If the method is called asynchronously,
returns the request thread.
|
def crm_notes_get(self, **kwargs): # noqa: E501
"""Get all notes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by note entity type
:param str entity_ids: Filter by note entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: NoteList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_notes_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.crm_notes_get_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
59,730 |
sib_api_v3_sdk.api.notes_api
|
crm_notes_get_with_http_info
|
Get all notes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by note entity type
:param str entity_ids: Filter by note entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: NoteList
If the method is called asynchronously,
returns the request thread.
|
def crm_notes_get_with_http_info(self, **kwargs): # noqa: E501
"""Get all notes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by note entity type
:param str entity_ids: Filter by note entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: NoteList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['entity', 'entity_ids', 'date_from', 'date_to', 'offset', 'limit', '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 crm_notes_get" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'entity' in params:
query_params.append(('entity', params['entity'])) # noqa: E501
if 'entity_ids' in params:
query_params.append(('entityIds', params['entity_ids'])) # noqa: E501
if 'date_from' in params:
query_params.append(('dateFrom', params['date_from'])) # noqa: E501
if 'date_to' in params:
query_params.append(('dateTo', params['date_to'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # 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(
'/crm/notes', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='NoteList', # 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,731 |
sib_api_v3_sdk.api.notes_api
|
crm_notes_id_delete
|
Delete a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def crm_notes_id_delete(self, id, **kwargs): # noqa: E501
"""Delete a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to delete (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.crm_notes_id_delete_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.crm_notes_id_delete_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
59,732 |
sib_api_v3_sdk.api.notes_api
|
crm_notes_id_delete_with_http_info
|
Delete a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def crm_notes_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 crm_notes_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['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(
'/crm/notes/{id}', '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, id, **kwargs)
|
59,733 |
sib_api_v3_sdk.api.notes_api
|
crm_notes_id_get
|
Get a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to get (required)
:return: Note
If the method is called asynchronously,
returns the request thread.
|
def crm_notes_id_get(self, id, **kwargs): # noqa: E501
"""Get a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to get (required)
:return: Note
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_notes_id_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.crm_notes_id_get_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
59,734 |
sib_api_v3_sdk.api.notes_api
|
crm_notes_id_get_with_http_info
|
Get a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to get (required)
:return: Note
If the method is called asynchronously,
returns the request thread.
|
def crm_notes_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Get a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to get (required)
:return: Note
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 crm_notes_id_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['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(
'/crm/notes/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Note', # 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, id, **kwargs)
|
59,735 |
sib_api_v3_sdk.api.notes_api
|
crm_notes_id_patch
|
Update a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_patch(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to update (required)
:param NoteData body: Note data to update a note (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def crm_notes_id_patch(self, id, body, **kwargs): # noqa: E501
"""Update a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_patch(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to update (required)
:param NoteData body: Note data to update a note (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.crm_notes_id_patch_with_http_info(id, body, **kwargs) # noqa: E501
else:
(data) = self.crm_notes_id_patch_with_http_info(id, body, **kwargs) # noqa: E501
return data
|
(self, id, body, **kwargs)
|
59,736 |
sib_api_v3_sdk.api.notes_api
|
crm_notes_id_patch_with_http_info
|
Update a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_patch_with_http_info(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to update (required)
:param NoteData body: Note data to update a note (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def crm_notes_id_patch_with_http_info(self, id, body, **kwargs): # noqa: E501
"""Update a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_id_patch_with_http_info(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: Note ID to update (required)
:param NoteData body: Note data to update a note (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id', 'body'] # 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 crm_notes_id_patch" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `crm_notes_id_patch`") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `crm_notes_id_patch`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# 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(
'/crm/notes/{id}', 'PATCH',
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, id, body, **kwargs)
|
59,737 |
sib_api_v3_sdk.api.notes_api
|
crm_notes_post
|
Create a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param NoteData body: Note data to create a note. (required)
:return: NoteId
If the method is called asynchronously,
returns the request thread.
|
def crm_notes_post(self, body, **kwargs): # noqa: E501
"""Create a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param NoteData body: Note data to create a note. (required)
:return: NoteId
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_notes_post_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.crm_notes_post_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body, **kwargs)
|
59,738 |
sib_api_v3_sdk.api.notes_api
|
crm_notes_post_with_http_info
|
Create a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param NoteData body: Note data to create a note. (required)
:return: NoteId
If the method is called asynchronously,
returns the request thread.
|
def crm_notes_post_with_http_info(self, body, **kwargs): # noqa: E501
"""Create a note # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_notes_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param NoteData body: Note data to create a note. (required)
:return: NoteId
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # 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 crm_notes_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `crm_notes_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# 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(
'/crm/notes', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='NoteId', # 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, body, **kwargs)
|
59,739 |
sib_api_v3_sdk.models.order
|
Order
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class Order(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',
'created_at': 'str',
'updated_at': 'str',
'status': 'str',
'amount': 'float',
'products': 'list[OrderProducts]',
'email': 'str',
'billing': 'OrderBilling',
'coupons': 'list[str]'
}
attribute_map = {
'id': 'id',
'created_at': 'createdAt',
'updated_at': 'updatedAt',
'status': 'status',
'amount': 'amount',
'products': 'products',
'email': 'email',
'billing': 'billing',
'coupons': 'coupons'
}
def __init__(self, id=None, created_at=None, updated_at=None, status=None, amount=None, products=None, email=None, billing=None, coupons=None): # noqa: E501
"""Order - a model defined in Swagger""" # noqa: E501
self._id = None
self._created_at = None
self._updated_at = None
self._status = None
self._amount = None
self._products = None
self._email = None
self._billing = None
self._coupons = None
self.discriminator = None
self.id = id
self.created_at = created_at
self.updated_at = updated_at
self.status = status
self.amount = amount
self.products = products
if email is not None:
self.email = email
if billing is not None:
self.billing = billing
if coupons is not None:
self.coupons = coupons
@property
def id(self):
"""Gets the id of this Order. # noqa: E501
Unique ID of the order. # noqa: E501
:return: The id of this Order. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this Order.
Unique ID of the order. # noqa: E501
:param id: The id of this Order. # noqa: E501
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
@property
def created_at(self):
"""Gets the created_at of this Order. # noqa: E501
Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created. # noqa: E501
:return: The created_at of this Order. # noqa: E501
:rtype: str
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""Sets the created_at of this Order.
Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created. # noqa: E501
:param created_at: The created_at of this Order. # noqa: E501
:type: str
"""
if created_at is None:
raise ValueError("Invalid value for `created_at`, must not be `None`") # noqa: E501
self._created_at = created_at
@property
def updated_at(self):
"""Gets the updated_at of this Order. # noqa: E501
Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated. # noqa: E501
:return: The updated_at of this Order. # noqa: E501
:rtype: str
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""Sets the updated_at of this Order.
Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated. # noqa: E501
:param updated_at: The updated_at of this Order. # noqa: E501
:type: str
"""
if updated_at is None:
raise ValueError("Invalid value for `updated_at`, must not be `None`") # noqa: E501
self._updated_at = updated_at
@property
def status(self):
"""Gets the status of this Order. # noqa: E501
State of the order. # noqa: E501
:return: The status of this Order. # noqa: E501
:rtype: str
"""
return self._status
@status.setter
def status(self, status):
"""Sets the status of this Order.
State of the order. # noqa: E501
:param status: The status of this Order. # noqa: E501
:type: str
"""
if status is None:
raise ValueError("Invalid value for `status`, must not be `None`") # noqa: E501
self._status = status
@property
def amount(self):
"""Gets the amount of this Order. # noqa: E501
Total amount of the order, including all shipping expenses, tax and the price of items. # noqa: E501
:return: The amount of this Order. # noqa: E501
:rtype: float
"""
return self._amount
@amount.setter
def amount(self, amount):
"""Sets the amount of this Order.
Total amount of the order, including all shipping expenses, tax and the price of items. # noqa: E501
:param amount: The amount of this Order. # noqa: E501
:type: float
"""
if amount is None:
raise ValueError("Invalid value for `amount`, must not be `None`") # noqa: E501
self._amount = amount
@property
def products(self):
"""Gets the products of this Order. # noqa: E501
:return: The products of this Order. # noqa: E501
:rtype: list[OrderProducts]
"""
return self._products
@products.setter
def products(self, products):
"""Sets the products of this Order.
:param products: The products of this Order. # noqa: E501
:type: list[OrderProducts]
"""
if products is None:
raise ValueError("Invalid value for `products`, must not be `None`") # noqa: E501
self._products = products
@property
def email(self):
"""Gets the email of this Order. # noqa: E501
Email of the contact, Mandatory if \"phone\" field is not passed in \"billing\" parameter. # noqa: E501
:return: The email of this Order. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this Order.
Email of the contact, Mandatory if \"phone\" field is not passed in \"billing\" parameter. # noqa: E501
:param email: The email of this Order. # noqa: E501
:type: str
"""
self._email = email
@property
def billing(self):
"""Gets the billing of this Order. # noqa: E501
:return: The billing of this Order. # noqa: E501
:rtype: OrderBilling
"""
return self._billing
@billing.setter
def billing(self, billing):
"""Sets the billing of this Order.
:param billing: The billing of this Order. # noqa: E501
:type: OrderBilling
"""
self._billing = billing
@property
def coupons(self):
"""Gets the coupons of this Order. # noqa: E501
Coupons applied to the order. Stored case insensitive. # noqa: E501
:return: The coupons of this Order. # noqa: E501
:rtype: list[str]
"""
return self._coupons
@coupons.setter
def coupons(self, coupons):
"""Sets the coupons of this Order.
Coupons applied to the order. Stored case insensitive. # noqa: E501
:param coupons: The coupons of this Order. # noqa: E501
:type: list[str]
"""
self._coupons = coupons
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(Order, 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, Order):
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, created_at=None, updated_at=None, status=None, amount=None, products=None, email=None, billing=None, coupons=None)
|
59,740 |
sib_api_v3_sdk.models.order
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, Order):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,741 |
sib_api_v3_sdk.models.order
|
__init__
|
Order - a model defined in Swagger
|
def __init__(self, id=None, created_at=None, updated_at=None, status=None, amount=None, products=None, email=None, billing=None, coupons=None): # noqa: E501
"""Order - a model defined in Swagger""" # noqa: E501
self._id = None
self._created_at = None
self._updated_at = None
self._status = None
self._amount = None
self._products = None
self._email = None
self._billing = None
self._coupons = None
self.discriminator = None
self.id = id
self.created_at = created_at
self.updated_at = updated_at
self.status = status
self.amount = amount
self.products = products
if email is not None:
self.email = email
if billing is not None:
self.billing = billing
if coupons is not None:
self.coupons = coupons
|
(self, id=None, created_at=None, updated_at=None, status=None, amount=None, products=None, email=None, billing=None, coupons=None)
|
59,744 |
sib_api_v3_sdk.models.order
|
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(Order, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.