id
int64 0
843k
| repository_name
stringlengths 7
55
| file_path
stringlengths 9
332
| class_name
stringlengths 3
290
| human_written_code
stringlengths 12
4.36M
| class_skeleton
stringlengths 19
2.2M
| total_program_units
int64 1
9.57k
| total_doc_str
int64 0
4.2k
| AvgCountLine
float64 0
7.89k
| AvgCountLineBlank
float64 0
300
| AvgCountLineCode
float64 0
7.89k
| AvgCountLineComment
float64 0
7.89k
| AvgCyclomatic
float64 0
130
| CommentToCodeRatio
float64 0
176
| CountClassBase
float64 0
48
| CountClassCoupled
float64 0
589
| CountClassCoupledModified
float64 0
581
| CountClassDerived
float64 0
5.37k
| CountDeclInstanceMethod
float64 0
4.2k
| CountDeclInstanceVariable
float64 0
299
| CountDeclMethod
float64 0
4.2k
| CountDeclMethodAll
float64 0
4.2k
| CountLine
float64 1
115k
| CountLineBlank
float64 0
9.01k
| CountLineCode
float64 0
94.4k
| CountLineCodeDecl
float64 0
46.1k
| CountLineCodeExe
float64 0
91.3k
| CountLineComment
float64 0
27k
| CountStmt
float64 1
93.2k
| CountStmtDecl
float64 0
46.1k
| CountStmtExe
float64 0
90.2k
| MaxCyclomatic
float64 0
759
| MaxInheritanceTree
float64 0
16
| MaxNesting
float64 0
34
| SumCyclomatic
float64 0
6k
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2,400 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_query_post_put_request.py
|
mbed_cloud._backends.device_directory.models.device_query_post_put_request.DeviceQueryPostPutRequest
|
class DeviceQueryPostPutRequest(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',
'query': 'str'
}
attribute_map = {
'name': 'name',
'query': 'query'
}
def __init__(self, name=None, query=None):
"""
DeviceQueryPostPutRequest - a model defined in Swagger
"""
self._name = name
self._query = query
self.discriminator = None
@property
def name(self):
"""
Gets the name of this DeviceQueryPostPutRequest.
The name of the query.
:return: The name of this DeviceQueryPostPutRequest.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceQueryPostPutRequest.
The name of the query.
:param name: The name of this DeviceQueryPostPutRequest.
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`")
if name is not None and len(name) > 200:
raise ValueError("Invalid value for `name`, length must be less than or equal to `200`")
self._name = name
@property
def query(self):
"""
Gets the query of this DeviceQueryPostPutRequest.
The device query.
:return: The query of this DeviceQueryPostPutRequest.
:rtype: str
"""
return self._query
@query.setter
def query(self, query):
"""
Sets the query of this DeviceQueryPostPutRequest.
The device query.
:param query: The query of this DeviceQueryPostPutRequest.
:type: str
"""
if query is None:
raise ValueError("Invalid value for `query`, must not be `None`")
if query is not None and len(query) > 1000:
raise ValueError("Invalid value for `query`, length must be less than or equal to `1000`")
self._query = query
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceQueryPostPutRequest):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceQueryPostPutRequest(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, name=None, query=None):
'''
DeviceQueryPostPutRequest - a model defined in Swagger
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceQueryPostPutRequest.
The name of the query.
:return: The name of this DeviceQueryPostPutRequest.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceQueryPostPutRequest.
The name of the query.
:param name: The name of this DeviceQueryPostPutRequest.
:type: str
'''
pass
@property
def query(self):
'''
Gets the query of this DeviceQueryPostPutRequest.
The device query.
:return: The query of this DeviceQueryPostPutRequest.
:rtype: str
'''
pass
@query.setter
def query(self):
'''
Sets the query of this DeviceQueryPostPutRequest.
The device query.
:param query: The query of this DeviceQueryPostPutRequest.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 10 | 1 | 5 | 4 | 2 | 0.84 | 1 | 4 | 0 | 0 | 10 | 3 | 10 | 10 | 139 | 23 | 63 | 23 | 48 | 53 | 43 | 19 | 32 | 5 | 1 | 2 | 19 |
2,401 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_query_patch_request.py
|
mbed_cloud._backends.device_directory.models.device_query_patch_request.DeviceQueryPatchRequest
|
class DeviceQueryPatchRequest(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',
'query': 'str'
}
attribute_map = {
'name': 'name',
'query': 'query'
}
def __init__(self, name=None, query=None):
"""
DeviceQueryPatchRequest - a model defined in Swagger
"""
self._name = name
self._query = query
self.discriminator = None
@property
def name(self):
"""
Gets the name of this DeviceQueryPatchRequest.
The name of the query.
:return: The name of this DeviceQueryPatchRequest.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceQueryPatchRequest.
The name of the query.
:param name: The name of this DeviceQueryPatchRequest.
:type: str
"""
if name is not None and len(name) > 200:
raise ValueError("Invalid value for `name`, length must be less than or equal to `200`")
self._name = name
@property
def query(self):
"""
Gets the query of this DeviceQueryPatchRequest.
The device query.
:return: The query of this DeviceQueryPatchRequest.
:rtype: str
"""
return self._query
@query.setter
def query(self, query):
"""
Sets the query of this DeviceQueryPatchRequest.
The device query.
:param query: The query of this DeviceQueryPatchRequest.
:type: str
"""
if query is not None and len(query) > 1000:
raise ValueError("Invalid value for `query`, length must be less than or equal to `1000`")
self._query = query
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceQueryPatchRequest):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceQueryPatchRequest(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, name=None, query=None):
'''
DeviceQueryPatchRequest - a model defined in Swagger
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceQueryPatchRequest.
The name of the query.
:return: The name of this DeviceQueryPatchRequest.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceQueryPatchRequest.
The name of the query.
:param name: The name of this DeviceQueryPatchRequest.
:type: str
'''
pass
@property
def query(self):
'''
Gets the query of this DeviceQueryPatchRequest.
The device query.
:return: The query of this DeviceQueryPatchRequest.
:rtype: str
'''
pass
@query.setter
def query(self):
'''
Sets the query of this DeviceQueryPatchRequest.
The device query.
:param query: The query of this DeviceQueryPatchRequest.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 10 | 1 | 5 | 4 | 2 | 0.9 | 1 | 4 | 0 | 0 | 10 | 3 | 10 | 10 | 135 | 23 | 59 | 23 | 44 | 53 | 39 | 19 | 28 | 5 | 1 | 2 | 17 |
2,402 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_query_page.py
|
mbed_cloud._backends.device_directory.models.device_query_page.DeviceQueryPage
|
class DeviceQueryPage(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 = {
'after': 'str',
'data': 'list[DeviceQuery]',
'has_more': 'bool',
'limit': 'int',
'object': 'str',
'order': 'str',
'total_count': 'int'
}
attribute_map = {
'after': 'after',
'data': 'data',
'has_more': 'has_more',
'limit': 'limit',
'object': 'object',
'order': 'order',
'total_count': 'total_count'
}
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
"""
DeviceQueryPage - a model defined in Swagger
"""
self._after = after
self._data = data
self._has_more = has_more
self._limit = limit
self._object = object
self._order = order
self._total_count = total_count
self.discriminator = None
@property
def after(self):
"""
Gets the after of this DeviceQueryPage.
:return: The after of this DeviceQueryPage.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this DeviceQueryPage.
:param after: The after of this DeviceQueryPage.
:type: str
"""
self._after = after
@property
def data(self):
"""
Gets the data of this DeviceQueryPage.
:return: The data of this DeviceQueryPage.
:rtype: list[DeviceQuery]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this DeviceQueryPage.
:param data: The data of this DeviceQueryPage.
:type: list[DeviceQuery]
"""
if data is None:
raise ValueError("Invalid value for `data`, must not be `None`")
self._data = data
@property
def has_more(self):
"""
Gets the has_more of this DeviceQueryPage.
:return: The has_more of this DeviceQueryPage.
:rtype: bool
"""
return self._has_more
@has_more.setter
def has_more(self, has_more):
"""
Sets the has_more of this DeviceQueryPage.
:param has_more: The has_more of this DeviceQueryPage.
:type: bool
"""
if has_more is None:
raise ValueError("Invalid value for `has_more`, must not be `None`")
self._has_more = has_more
@property
def limit(self):
"""
Gets the limit of this DeviceQueryPage.
:return: The limit of this DeviceQueryPage.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this DeviceQueryPage.
:param limit: The limit of this DeviceQueryPage.
:type: int
"""
if limit is None:
raise ValueError("Invalid value for `limit`, must not be `None`")
self._limit = limit
@property
def object(self):
"""
Gets the object of this DeviceQueryPage.
:return: The object of this DeviceQueryPage.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DeviceQueryPage.
:param object: The object of this DeviceQueryPage.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
self._object = object
@property
def order(self):
"""
Gets the order of this DeviceQueryPage.
:return: The order of this DeviceQueryPage.
:rtype: str
"""
return self._order
@order.setter
def order(self, order):
"""
Sets the order of this DeviceQueryPage.
:param order: The order of this DeviceQueryPage.
:type: str
"""
if order is None:
raise ValueError("Invalid value for `order`, must not be `None`")
self._order = order
@property
def total_count(self):
"""
Gets the total_count of this DeviceQueryPage.
:return: The total_count of this DeviceQueryPage.
:rtype: int
"""
return self._total_count
@total_count.setter
def total_count(self, total_count):
"""
Sets the total_count of this DeviceQueryPage.
:param total_count: The total_count of this DeviceQueryPage.
:type: int
"""
if total_count is None:
raise ValueError("Invalid value for `total_count`, must not be `None`")
self._total_count = total_count
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceQueryPage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceQueryPage(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
'''
DeviceQueryPage - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this DeviceQueryPage.
:return: The after of this DeviceQueryPage.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this DeviceQueryPage.
:param after: The after of this DeviceQueryPage.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this DeviceQueryPage.
:return: The data of this DeviceQueryPage.
:rtype: list[DeviceQuery]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this DeviceQueryPage.
:param data: The data of this DeviceQueryPage.
:type: list[DeviceQuery]
'''
pass
@property
def has_more(self):
'''
Gets the has_more of this DeviceQueryPage.
:return: The has_more of this DeviceQueryPage.
:rtype: bool
'''
pass
@has_more.setter
def has_more(self):
'''
Sets the has_more of this DeviceQueryPage.
:param has_more: The has_more of this DeviceQueryPage.
:type: bool
'''
pass
@property
def limit(self):
'''
Gets the limit of this DeviceQueryPage.
:return: The limit of this DeviceQueryPage.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this DeviceQueryPage.
:param limit: The limit of this DeviceQueryPage.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this DeviceQueryPage.
:return: The object of this DeviceQueryPage.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DeviceQueryPage.
:param object: The object of this DeviceQueryPage.
:type: str
'''
pass
@property
def order(self):
'''
Gets the order of this DeviceQueryPage.
:return: The order of this DeviceQueryPage.
:rtype: str
'''
pass
@order.setter
def order(self):
'''
Sets the order of this DeviceQueryPage.
:param order: The order of this DeviceQueryPage.
:type: str
'''
pass
@property
def total_count(self):
'''
Gets the total_count of this DeviceQueryPage.
:return: The total_count of this DeviceQueryPage.
:rtype: int
'''
pass
@total_count.setter
def total_count(self):
'''
Sets the total_count of this DeviceQueryPage.
:param total_count: The total_count of this DeviceQueryPage.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 35 | 21 | 10 | 1 | 4 | 4 | 2 | 0.88 | 1 | 4 | 0 | 0 | 20 | 8 | 20 | 20 | 259 | 48 | 112 | 48 | 77 | 99 | 72 | 34 | 51 | 5 | 1 | 2 | 31 |
2,403 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_query_in_nin_filter.py
|
mbed_cloud._backends.device_directory.models.device_query_in_nin_filter.DeviceQueryInNinFilter
|
class DeviceQueryInNinFilter(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 = {
'created_at': 'datetime',
'etag': 'datetime',
'id': 'str',
'name': 'str',
'query': 'str',
'updated_at': 'datetime'
}
attribute_map = {
'created_at': 'created_at',
'etag': 'etag',
'id': 'id',
'name': 'name',
'query': 'query',
'updated_at': 'updated_at'
}
def __init__(self, created_at=None, etag=None, id=None, name=None, query=None, updated_at=None):
"""
DeviceQueryInNinFilter - a model defined in Swagger
"""
self._created_at = created_at
self._etag = etag
self._id = id
self._name = name
self._query = query
self._updated_at = updated_at
self.discriminator = None
@property
def created_at(self):
"""
Gets the created_at of this DeviceQueryInNinFilter.
:return: The created_at of this DeviceQueryInNinFilter.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeviceQueryInNinFilter.
:param created_at: The created_at of this DeviceQueryInNinFilter.
:type: datetime
"""
self._created_at = created_at
@property
def etag(self):
"""
Gets the etag of this DeviceQueryInNinFilter.
:return: The etag of this DeviceQueryInNinFilter.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeviceQueryInNinFilter.
:param etag: The etag of this DeviceQueryInNinFilter.
:type: datetime
"""
self._etag = etag
@property
def id(self):
"""
Gets the id of this DeviceQueryInNinFilter.
:return: The id of this DeviceQueryInNinFilter.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeviceQueryInNinFilter.
:param id: The id of this DeviceQueryInNinFilter.
:type: str
"""
self._id = id
@property
def name(self):
"""
Gets the name of this DeviceQueryInNinFilter.
:return: The name of this DeviceQueryInNinFilter.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceQueryInNinFilter.
:param name: The name of this DeviceQueryInNinFilter.
:type: str
"""
self._name = name
@property
def query(self):
"""
Gets the query of this DeviceQueryInNinFilter.
:return: The query of this DeviceQueryInNinFilter.
:rtype: str
"""
return self._query
@query.setter
def query(self, query):
"""
Sets the query of this DeviceQueryInNinFilter.
:param query: The query of this DeviceQueryInNinFilter.
:type: str
"""
self._query = query
@property
def updated_at(self):
"""
Gets the updated_at of this DeviceQueryInNinFilter.
:return: The updated_at of this DeviceQueryInNinFilter.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this DeviceQueryInNinFilter.
:param updated_at: The updated_at of this DeviceQueryInNinFilter.
:type: datetime
"""
self._updated_at = updated_at
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceQueryInNinFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceQueryInNinFilter(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created_at=None, etag=None, id=None, name=None, query=None, updated_at=None):
'''
DeviceQueryInNinFilter - a model defined in Swagger
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeviceQueryInNinFilter.
:return: The created_at of this DeviceQueryInNinFilter.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeviceQueryInNinFilter.
:param created_at: The created_at of this DeviceQueryInNinFilter.
:type: datetime
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeviceQueryInNinFilter.
:return: The etag of this DeviceQueryInNinFilter.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeviceQueryInNinFilter.
:param etag: The etag of this DeviceQueryInNinFilter.
:type: datetime
'''
pass
@property
def id(self):
'''
Gets the id of this DeviceQueryInNinFilter.
:return: The id of this DeviceQueryInNinFilter.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeviceQueryInNinFilter.
:param id: The id of this DeviceQueryInNinFilter.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceQueryInNinFilter.
:return: The name of this DeviceQueryInNinFilter.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceQueryInNinFilter.
:param name: The name of this DeviceQueryInNinFilter.
:type: str
'''
pass
@property
def query(self):
'''
Gets the query of this DeviceQueryInNinFilter.
:return: The query of this DeviceQueryInNinFilter.
:rtype: str
'''
pass
@query.setter
def query(self):
'''
Sets the query of this DeviceQueryInNinFilter.
:param query: The query of this DeviceQueryInNinFilter.
:type: str
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this DeviceQueryInNinFilter.
:return: The updated_at of this DeviceQueryInNinFilter.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this DeviceQueryInNinFilter.
:param updated_at: The updated_at of this DeviceQueryInNinFilter.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 9 | 1 | 3 | 4 | 1 | 0.98 | 1 | 3 | 0 | 0 | 18 | 7 | 18 | 18 | 223 | 43 | 91 | 43 | 60 | 89 | 55 | 31 | 36 | 5 | 1 | 2 | 23 |
2,404 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_query_gte_lte_filter.py
|
mbed_cloud._backends.device_directory.models.device_query_gte_lte_filter.DeviceQueryGteLteFilter
|
class DeviceQueryGteLteFilter(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 = {
'created_at': 'datetime',
'etag': 'datetime',
'updated_at': 'datetime'
}
attribute_map = {
'created_at': 'created_at',
'etag': 'etag',
'updated_at': 'updated_at'
}
def __init__(self, created_at=None, etag=None, updated_at=None):
"""
DeviceQueryGteLteFilter - a model defined in Swagger
"""
self._created_at = created_at
self._etag = etag
self._updated_at = updated_at
self.discriminator = None
@property
def created_at(self):
"""
Gets the created_at of this DeviceQueryGteLteFilter.
:return: The created_at of this DeviceQueryGteLteFilter.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeviceQueryGteLteFilter.
:param created_at: The created_at of this DeviceQueryGteLteFilter.
:type: datetime
"""
self._created_at = created_at
@property
def etag(self):
"""
Gets the etag of this DeviceQueryGteLteFilter.
:return: The etag of this DeviceQueryGteLteFilter.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeviceQueryGteLteFilter.
:param etag: The etag of this DeviceQueryGteLteFilter.
:type: datetime
"""
self._etag = etag
@property
def updated_at(self):
"""
Gets the updated_at of this DeviceQueryGteLteFilter.
:return: The updated_at of this DeviceQueryGteLteFilter.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this DeviceQueryGteLteFilter.
:param updated_at: The updated_at of this DeviceQueryGteLteFilter.
:type: datetime
"""
self._updated_at = updated_at
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceQueryGteLteFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceQueryGteLteFilter(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created_at=None, etag=None, updated_at=None):
'''
DeviceQueryGteLteFilter - a model defined in Swagger
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeviceQueryGteLteFilter.
:return: The created_at of this DeviceQueryGteLteFilter.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeviceQueryGteLteFilter.
:param created_at: The created_at of this DeviceQueryGteLteFilter.
:type: datetime
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeviceQueryGteLteFilter.
:return: The etag of this DeviceQueryGteLteFilter.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeviceQueryGteLteFilter.
:param etag: The etag of this DeviceQueryGteLteFilter.
:type: datetime
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this DeviceQueryGteLteFilter.
:return: The updated_at of this DeviceQueryGteLteFilter.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this DeviceQueryGteLteFilter.
:param updated_at: The updated_at of this DeviceQueryGteLteFilter.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 19 | 13 | 9 | 1 | 4 | 4 | 1 | 0.92 | 1 | 3 | 0 | 0 | 12 | 4 | 12 | 12 | 151 | 28 | 64 | 28 | 45 | 59 | 40 | 22 | 27 | 5 | 1 | 2 | 17 |
2,405 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_query_eq_neq_filter.py
|
mbed_cloud._backends.device_directory.models.device_query_eq_neq_filter.DeviceQueryEqNeqFilter
|
class DeviceQueryEqNeqFilter(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 = {
'created_at': 'datetime',
'etag': 'datetime',
'id': 'str',
'name': 'str',
'query': 'str',
'updated_at': 'datetime'
}
attribute_map = {
'created_at': 'created_at',
'etag': 'etag',
'id': 'id',
'name': 'name',
'query': 'query',
'updated_at': 'updated_at'
}
def __init__(self, created_at=None, etag=None, id=None, name=None, query=None, updated_at=None):
"""
DeviceQueryEqNeqFilter - a model defined in Swagger
"""
self._created_at = created_at
self._etag = etag
self._id = id
self._name = name
self._query = query
self._updated_at = updated_at
self.discriminator = None
@property
def created_at(self):
"""
Gets the created_at of this DeviceQueryEqNeqFilter.
:return: The created_at of this DeviceQueryEqNeqFilter.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeviceQueryEqNeqFilter.
:param created_at: The created_at of this DeviceQueryEqNeqFilter.
:type: datetime
"""
self._created_at = created_at
@property
def etag(self):
"""
Gets the etag of this DeviceQueryEqNeqFilter.
:return: The etag of this DeviceQueryEqNeqFilter.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeviceQueryEqNeqFilter.
:param etag: The etag of this DeviceQueryEqNeqFilter.
:type: datetime
"""
self._etag = etag
@property
def id(self):
"""
Gets the id of this DeviceQueryEqNeqFilter.
:return: The id of this DeviceQueryEqNeqFilter.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeviceQueryEqNeqFilter.
:param id: The id of this DeviceQueryEqNeqFilter.
:type: str
"""
self._id = id
@property
def name(self):
"""
Gets the name of this DeviceQueryEqNeqFilter.
:return: The name of this DeviceQueryEqNeqFilter.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceQueryEqNeqFilter.
:param name: The name of this DeviceQueryEqNeqFilter.
:type: str
"""
self._name = name
@property
def query(self):
"""
Gets the query of this DeviceQueryEqNeqFilter.
:return: The query of this DeviceQueryEqNeqFilter.
:rtype: str
"""
return self._query
@query.setter
def query(self, query):
"""
Sets the query of this DeviceQueryEqNeqFilter.
:param query: The query of this DeviceQueryEqNeqFilter.
:type: str
"""
self._query = query
@property
def updated_at(self):
"""
Gets the updated_at of this DeviceQueryEqNeqFilter.
:return: The updated_at of this DeviceQueryEqNeqFilter.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this DeviceQueryEqNeqFilter.
:param updated_at: The updated_at of this DeviceQueryEqNeqFilter.
:type: datetime
"""
self._updated_at = updated_at
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceQueryEqNeqFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceQueryEqNeqFilter(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created_at=None, etag=None, id=None, name=None, query=None, updated_at=None):
'''
DeviceQueryEqNeqFilter - a model defined in Swagger
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeviceQueryEqNeqFilter.
:return: The created_at of this DeviceQueryEqNeqFilter.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeviceQueryEqNeqFilter.
:param created_at: The created_at of this DeviceQueryEqNeqFilter.
:type: datetime
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeviceQueryEqNeqFilter.
:return: The etag of this DeviceQueryEqNeqFilter.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeviceQueryEqNeqFilter.
:param etag: The etag of this DeviceQueryEqNeqFilter.
:type: datetime
'''
pass
@property
def id(self):
'''
Gets the id of this DeviceQueryEqNeqFilter.
:return: The id of this DeviceQueryEqNeqFilter.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeviceQueryEqNeqFilter.
:param id: The id of this DeviceQueryEqNeqFilter.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceQueryEqNeqFilter.
:return: The name of this DeviceQueryEqNeqFilter.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceQueryEqNeqFilter.
:param name: The name of this DeviceQueryEqNeqFilter.
:type: str
'''
pass
@property
def query(self):
'''
Gets the query of this DeviceQueryEqNeqFilter.
:return: The query of this DeviceQueryEqNeqFilter.
:rtype: str
'''
pass
@query.setter
def query(self):
'''
Sets the query of this DeviceQueryEqNeqFilter.
:param query: The query of this DeviceQueryEqNeqFilter.
:type: str
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this DeviceQueryEqNeqFilter.
:return: The updated_at of this DeviceQueryEqNeqFilter.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this DeviceQueryEqNeqFilter.
:param updated_at: The updated_at of this DeviceQueryEqNeqFilter.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 9 | 1 | 3 | 4 | 1 | 0.98 | 1 | 3 | 0 | 0 | 18 | 7 | 18 | 18 | 223 | 43 | 91 | 43 | 60 | 89 | 55 | 31 | 36 | 5 | 1 | 2 | 23 |
2,406 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_query.py
|
mbed_cloud._backends.device_directory.models.device_query.DeviceQuery
|
class DeviceQuery(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 = {
'created_at': 'datetime',
'etag': 'datetime',
'id': 'str',
'name': 'str',
'object': 'str',
'query': 'str',
'updated_at': 'datetime'
}
attribute_map = {
'created_at': 'created_at',
'etag': 'etag',
'id': 'id',
'name': 'name',
'object': 'object',
'query': 'query',
'updated_at': 'updated_at'
}
def __init__(self, created_at=None, etag=None, id=None, name=None, object=None, query=None, updated_at=None):
"""
DeviceQuery - a model defined in Swagger
"""
self._created_at = created_at
self._etag = etag
self._id = id
self._name = name
self._object = object
self._query = query
self._updated_at = updated_at
self.discriminator = None
@property
def created_at(self):
"""
Gets the created_at of this DeviceQuery.
The timestamp of when the device was created in the device directory.
:return: The created_at of this DeviceQuery.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeviceQuery.
The timestamp of when the device was created in the device directory.
:param created_at: The created_at of this DeviceQuery.
:type: datetime
"""
if created_at is None:
raise ValueError("Invalid value for `created_at`, must not be `None`")
self._created_at = created_at
@property
def etag(self):
"""
Gets the etag of this DeviceQuery.
The entity instance signature.
:return: The etag of this DeviceQuery.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeviceQuery.
The entity instance signature.
:param etag: The etag of this DeviceQuery.
:type: datetime
"""
if etag is None:
raise ValueError("Invalid value for `etag`, must not be `None`")
self._etag = etag
@property
def id(self):
"""
Gets the id of this DeviceQuery.
The ID of the query.
:return: The id of this DeviceQuery.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeviceQuery.
The ID of the query.
:param id: The id of this DeviceQuery.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def name(self):
"""
Gets the name of this DeviceQuery.
The name of the query.
:return: The name of this DeviceQuery.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceQuery.
The name of the query.
:param name: The name of this DeviceQuery.
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`")
self._name = name
@property
def object(self):
"""
Gets the object of this DeviceQuery.
The API resource entity.
:return: The object of this DeviceQuery.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DeviceQuery.
The API resource entity.
:param object: The object of this DeviceQuery.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
self._object = object
@property
def query(self):
"""
Gets the query of this DeviceQuery.
The device query.
:return: The query of this DeviceQuery.
:rtype: str
"""
return self._query
@query.setter
def query(self, query):
"""
Sets the query of this DeviceQuery.
The device query.
:param query: The query of this DeviceQuery.
:type: str
"""
if query is None:
raise ValueError("Invalid value for `query`, must not be `None`")
self._query = query
@property
def updated_at(self):
"""
Gets the updated_at of this DeviceQuery.
The time the object was updated.
:return: The updated_at of this DeviceQuery.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this DeviceQuery.
The time the object was updated.
:param updated_at: The updated_at of this DeviceQuery.
:type: datetime
"""
if updated_at is None:
raise ValueError("Invalid value for `updated_at`, must not be `None`")
self._updated_at = updated_at
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceQuery):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceQuery(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created_at=None, etag=None, id=None, name=None, object=None, query=None, updated_at=None):
'''
DeviceQuery - a model defined in Swagger
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeviceQuery.
The timestamp of when the device was created in the device directory.
:return: The created_at of this DeviceQuery.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeviceQuery.
The timestamp of when the device was created in the device directory.
:param created_at: The created_at of this DeviceQuery.
:type: datetime
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeviceQuery.
The entity instance signature.
:return: The etag of this DeviceQuery.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeviceQuery.
The entity instance signature.
:param etag: The etag of this DeviceQuery.
:type: datetime
'''
pass
@property
def id(self):
'''
Gets the id of this DeviceQuery.
The ID of the query.
:return: The id of this DeviceQuery.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeviceQuery.
The ID of the query.
:param id: The id of this DeviceQuery.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceQuery.
The name of the query.
:return: The name of this DeviceQuery.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceQuery.
The name of the query.
:param name: The name of this DeviceQuery.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this DeviceQuery.
The API resource entity.
:return: The object of this DeviceQuery.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DeviceQuery.
The API resource entity.
:param object: The object of this DeviceQuery.
:type: str
'''
pass
@property
def query(self):
'''
Gets the query of this DeviceQuery.
The device query.
:return: The query of this DeviceQuery.
:rtype: str
'''
pass
@query.setter
def query(self):
'''
Sets the query of this DeviceQuery.
The device query.
:param query: The query of this DeviceQuery.
:type: str
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this DeviceQuery.
The time the object was updated.
:return: The updated_at of this DeviceQuery.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this DeviceQuery.
The time the object was updated.
:param updated_at: The updated_at of this DeviceQuery.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 35 | 21 | 10 | 1 | 4 | 5 | 2 | 0.99 | 1 | 4 | 0 | 0 | 20 | 8 | 20 | 20 | 275 | 48 | 114 | 48 | 79 | 113 | 74 | 34 | 53 | 5 | 1 | 2 | 32 |
2,407 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_page.py
|
mbed_cloud._backends.device_directory.models.device_page.DevicePage
|
class DevicePage(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 = {
'after': 'str',
'data': 'list[DeviceData]',
'has_more': 'bool',
'limit': 'int',
'object': 'str',
'order': 'str',
'total_count': 'int'
}
attribute_map = {
'after': 'after',
'data': 'data',
'has_more': 'has_more',
'limit': 'limit',
'object': 'object',
'order': 'order',
'total_count': 'total_count'
}
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
"""
DevicePage - a model defined in Swagger
"""
self._after = after
self._data = data
self._has_more = has_more
self._limit = limit
self._object = object
self._order = order
self._total_count = total_count
self.discriminator = None
@property
def after(self):
"""
Gets the after of this DevicePage.
:return: The after of this DevicePage.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this DevicePage.
:param after: The after of this DevicePage.
:type: str
"""
self._after = after
@property
def data(self):
"""
Gets the data of this DevicePage.
:return: The data of this DevicePage.
:rtype: list[DeviceData]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this DevicePage.
:param data: The data of this DevicePage.
:type: list[DeviceData]
"""
self._data = data
@property
def has_more(self):
"""
Gets the has_more of this DevicePage.
:return: The has_more of this DevicePage.
:rtype: bool
"""
return self._has_more
@has_more.setter
def has_more(self, has_more):
"""
Sets the has_more of this DevicePage.
:param has_more: The has_more of this DevicePage.
:type: bool
"""
self._has_more = has_more
@property
def limit(self):
"""
Gets the limit of this DevicePage.
:return: The limit of this DevicePage.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this DevicePage.
:param limit: The limit of this DevicePage.
:type: int
"""
self._limit = limit
@property
def object(self):
"""
Gets the object of this DevicePage.
:return: The object of this DevicePage.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DevicePage.
:param object: The object of this DevicePage.
:type: str
"""
self._object = object
@property
def order(self):
"""
Gets the order of this DevicePage.
:return: The order of this DevicePage.
:rtype: str
"""
return self._order
@order.setter
def order(self, order):
"""
Sets the order of this DevicePage.
:param order: The order of this DevicePage.
:type: str
"""
self._order = order
@property
def total_count(self):
"""
Gets the total_count of this DevicePage.
:return: The total_count of this DevicePage.
:rtype: int
"""
return self._total_count
@total_count.setter
def total_count(self, total_count):
"""
Sets the total_count of this DevicePage.
:param total_count: The total_count of this DevicePage.
:type: int
"""
self._total_count = total_count
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DevicePage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DevicePage(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
'''
DevicePage - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this DevicePage.
:return: The after of this DevicePage.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this DevicePage.
:param after: The after of this DevicePage.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this DevicePage.
:return: The data of this DevicePage.
:rtype: list[DeviceData]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this DevicePage.
:param data: The data of this DevicePage.
:type: list[DeviceData]
'''
pass
@property
def has_more(self):
'''
Gets the has_more of this DevicePage.
:return: The has_more of this DevicePage.
:rtype: bool
'''
pass
@has_more.setter
def has_more(self):
'''
Sets the has_more of this DevicePage.
:param has_more: The has_more of this DevicePage.
:type: bool
'''
pass
@property
def limit(self):
'''
Gets the limit of this DevicePage.
:return: The limit of this DevicePage.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this DevicePage.
:param limit: The limit of this DevicePage.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this DevicePage.
:return: The object of this DevicePage.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DevicePage.
:param object: The object of this DevicePage.
:type: str
'''
pass
@property
def order(self):
'''
Gets the order of this DevicePage.
:return: The order of this DevicePage.
:rtype: str
'''
pass
@order.setter
def order(self):
'''
Sets the order of this DevicePage.
:param order: The order of this DevicePage.
:type: str
'''
pass
@property
def total_count(self):
'''
Gets the total_count of this DevicePage.
:return: The total_count of this DevicePage.
:rtype: int
'''
pass
@total_count.setter
def total_count(self):
'''
Sets the total_count of this DevicePage.
:param total_count: The total_count of this DevicePage.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 35 | 21 | 9 | 1 | 3 | 4 | 1 | 0.99 | 1 | 3 | 0 | 0 | 20 | 8 | 20 | 20 | 247 | 48 | 100 | 48 | 65 | 99 | 60 | 34 | 39 | 5 | 1 | 2 | 25 |
2,408 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_in_nin_filter.py
|
mbed_cloud._backends.device_directory.models.device_in_nin_filter.DeviceInNinFilter
|
class DeviceInNinFilter(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 = {
'account_id': 'str',
'auto_update': 'bool',
'bootstrap_expiration_date': 'datetime',
'bootstrapped_timestamp': 'datetime',
'ca_id': 'str',
'connector_expiration_date': 'datetime',
'created_at': 'datetime',
'custom_attributes': 'dict(str, str)',
'deployed_state': 'str',
'deployment': 'str',
'description': 'str',
'device_class': 'str',
'device_execution_mode': 'int',
'device_key': 'str',
'endpoint_name': 'str',
'endpoint_type': 'str',
'enrolment_list_timestamp': 'datetime',
'etag': 'datetime',
'firmware_checksum': 'str',
'host_gateway': 'str',
'id': 'str',
'manifest': 'str',
'manifest_timestamp': 'datetime',
'mechanism': 'str',
'mechanism_url': 'str',
'name': 'str',
'serial_number': 'str',
'state': 'str',
'updated_at': 'datetime',
'vendor_id': 'str'
}
attribute_map = {
'account_id': 'account_id',
'auto_update': 'auto_update',
'bootstrap_expiration_date': 'bootstrap_expiration_date',
'bootstrapped_timestamp': 'bootstrapped_timestamp',
'ca_id': 'ca_id',
'connector_expiration_date': 'connector_expiration_date',
'created_at': 'created_at',
'custom_attributes': 'custom_attributes',
'deployed_state': 'deployed_state',
'deployment': 'deployment',
'description': 'description',
'device_class': 'device_class',
'device_execution_mode': 'device_execution_mode',
'device_key': 'device_key',
'endpoint_name': 'endpoint_name',
'endpoint_type': 'endpoint_type',
'enrolment_list_timestamp': 'enrolment_list_timestamp',
'etag': 'etag',
'firmware_checksum': 'firmware_checksum',
'host_gateway': 'host_gateway',
'id': 'id',
'manifest': 'manifest',
'manifest_timestamp': 'manifest_timestamp',
'mechanism': 'mechanism',
'mechanism_url': 'mechanism_url',
'name': 'name',
'serial_number': 'serial_number',
'state': 'state',
'updated_at': 'updated_at',
'vendor_id': 'vendor_id'
}
def __init__(self, account_id=None, auto_update=None, bootstrap_expiration_date=None, bootstrapped_timestamp=None, ca_id=None, connector_expiration_date=None, created_at=None, custom_attributes=None, deployed_state=None, deployment=None, description=None, device_class=None, device_execution_mode=None, device_key=None, endpoint_name=None, endpoint_type=None, enrolment_list_timestamp=None, etag=None, firmware_checksum=None, host_gateway=None, id=None, manifest=None, manifest_timestamp=None, mechanism=None, mechanism_url=None, name=None, serial_number=None, state=None, updated_at=None, vendor_id=None):
"""
DeviceInNinFilter - a model defined in Swagger
"""
self._account_id = account_id
self._auto_update = auto_update
self._bootstrap_expiration_date = bootstrap_expiration_date
self._bootstrapped_timestamp = bootstrapped_timestamp
self._ca_id = ca_id
self._connector_expiration_date = connector_expiration_date
self._created_at = created_at
self._custom_attributes = custom_attributes
self._deployed_state = deployed_state
self._deployment = deployment
self._description = description
self._device_class = device_class
self._device_execution_mode = device_execution_mode
self._device_key = device_key
self._endpoint_name = endpoint_name
self._endpoint_type = endpoint_type
self._enrolment_list_timestamp = enrolment_list_timestamp
self._etag = etag
self._firmware_checksum = firmware_checksum
self._host_gateway = host_gateway
self._id = id
self._manifest = manifest
self._manifest_timestamp = manifest_timestamp
self._mechanism = mechanism
self._mechanism_url = mechanism_url
self._name = name
self._serial_number = serial_number
self._state = state
self._updated_at = updated_at
self._vendor_id = vendor_id
self.discriminator = None
@property
def account_id(self):
"""
Gets the account_id of this DeviceInNinFilter.
:return: The account_id of this DeviceInNinFilter.
:rtype: str
"""
return self._account_id
@account_id.setter
def account_id(self, account_id):
"""
Sets the account_id of this DeviceInNinFilter.
:param account_id: The account_id of this DeviceInNinFilter.
:type: str
"""
self._account_id = account_id
@property
def auto_update(self):
"""
Gets the auto_update of this DeviceInNinFilter.
:return: The auto_update of this DeviceInNinFilter.
:rtype: bool
"""
return self._auto_update
@auto_update.setter
def auto_update(self, auto_update):
"""
Sets the auto_update of this DeviceInNinFilter.
:param auto_update: The auto_update of this DeviceInNinFilter.
:type: bool
"""
self._auto_update = auto_update
@property
def bootstrap_expiration_date(self):
"""
Gets the bootstrap_expiration_date of this DeviceInNinFilter.
:return: The bootstrap_expiration_date of this DeviceInNinFilter.
:rtype: datetime
"""
return self._bootstrap_expiration_date
@bootstrap_expiration_date.setter
def bootstrap_expiration_date(self, bootstrap_expiration_date):
"""
Sets the bootstrap_expiration_date of this DeviceInNinFilter.
:param bootstrap_expiration_date: The bootstrap_expiration_date of this DeviceInNinFilter.
:type: datetime
"""
self._bootstrap_expiration_date = bootstrap_expiration_date
@property
def bootstrapped_timestamp(self):
"""
Gets the bootstrapped_timestamp of this DeviceInNinFilter.
:return: The bootstrapped_timestamp of this DeviceInNinFilter.
:rtype: datetime
"""
return self._bootstrapped_timestamp
@bootstrapped_timestamp.setter
def bootstrapped_timestamp(self, bootstrapped_timestamp):
"""
Sets the bootstrapped_timestamp of this DeviceInNinFilter.
:param bootstrapped_timestamp: The bootstrapped_timestamp of this DeviceInNinFilter.
:type: datetime
"""
self._bootstrapped_timestamp = bootstrapped_timestamp
@property
def ca_id(self):
"""
Gets the ca_id of this DeviceInNinFilter.
:return: The ca_id of this DeviceInNinFilter.
:rtype: str
"""
return self._ca_id
@ca_id.setter
def ca_id(self, ca_id):
"""
Sets the ca_id of this DeviceInNinFilter.
:param ca_id: The ca_id of this DeviceInNinFilter.
:type: str
"""
self._ca_id = ca_id
@property
def connector_expiration_date(self):
"""
Gets the connector_expiration_date of this DeviceInNinFilter.
:return: The connector_expiration_date of this DeviceInNinFilter.
:rtype: datetime
"""
return self._connector_expiration_date
@connector_expiration_date.setter
def connector_expiration_date(self, connector_expiration_date):
"""
Sets the connector_expiration_date of this DeviceInNinFilter.
:param connector_expiration_date: The connector_expiration_date of this DeviceInNinFilter.
:type: datetime
"""
self._connector_expiration_date = connector_expiration_date
@property
def created_at(self):
"""
Gets the created_at of this DeviceInNinFilter.
:return: The created_at of this DeviceInNinFilter.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeviceInNinFilter.
:param created_at: The created_at of this DeviceInNinFilter.
:type: datetime
"""
self._created_at = created_at
@property
def custom_attributes(self):
"""
Gets the custom_attributes of this DeviceInNinFilter.
:return: The custom_attributes of this DeviceInNinFilter.
:rtype: dict(str, str)
"""
return self._custom_attributes
@custom_attributes.setter
def custom_attributes(self, custom_attributes):
"""
Sets the custom_attributes of this DeviceInNinFilter.
:param custom_attributes: The custom_attributes of this DeviceInNinFilter.
:type: dict(str, str)
"""
self._custom_attributes = custom_attributes
@property
def deployed_state(self):
"""
Gets the deployed_state of this DeviceInNinFilter.
:return: The deployed_state of this DeviceInNinFilter.
:rtype: str
"""
return self._deployed_state
@deployed_state.setter
def deployed_state(self, deployed_state):
"""
Sets the deployed_state of this DeviceInNinFilter.
:param deployed_state: The deployed_state of this DeviceInNinFilter.
:type: str
"""
self._deployed_state = deployed_state
@property
def deployment(self):
"""
Gets the deployment of this DeviceInNinFilter.
:return: The deployment of this DeviceInNinFilter.
:rtype: str
"""
return self._deployment
@deployment.setter
def deployment(self, deployment):
"""
Sets the deployment of this DeviceInNinFilter.
:param deployment: The deployment of this DeviceInNinFilter.
:type: str
"""
self._deployment = deployment
@property
def description(self):
"""
Gets the description of this DeviceInNinFilter.
:return: The description of this DeviceInNinFilter.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeviceInNinFilter.
:param description: The description of this DeviceInNinFilter.
:type: str
"""
self._description = description
@property
def device_class(self):
"""
Gets the device_class of this DeviceInNinFilter.
:return: The device_class of this DeviceInNinFilter.
:rtype: str
"""
return self._device_class
@device_class.setter
def device_class(self, device_class):
"""
Sets the device_class of this DeviceInNinFilter.
:param device_class: The device_class of this DeviceInNinFilter.
:type: str
"""
self._device_class = device_class
@property
def device_execution_mode(self):
"""
Gets the device_execution_mode of this DeviceInNinFilter.
:return: The device_execution_mode of this DeviceInNinFilter.
:rtype: int
"""
return self._device_execution_mode
@device_execution_mode.setter
def device_execution_mode(self, device_execution_mode):
"""
Sets the device_execution_mode of this DeviceInNinFilter.
:param device_execution_mode: The device_execution_mode of this DeviceInNinFilter.
:type: int
"""
self._device_execution_mode = device_execution_mode
@property
def device_key(self):
"""
Gets the device_key of this DeviceInNinFilter.
:return: The device_key of this DeviceInNinFilter.
:rtype: str
"""
return self._device_key
@device_key.setter
def device_key(self, device_key):
"""
Sets the device_key of this DeviceInNinFilter.
:param device_key: The device_key of this DeviceInNinFilter.
:type: str
"""
self._device_key = device_key
@property
def endpoint_name(self):
"""
Gets the endpoint_name of this DeviceInNinFilter.
:return: The endpoint_name of this DeviceInNinFilter.
:rtype: str
"""
return self._endpoint_name
@endpoint_name.setter
def endpoint_name(self, endpoint_name):
"""
Sets the endpoint_name of this DeviceInNinFilter.
:param endpoint_name: The endpoint_name of this DeviceInNinFilter.
:type: str
"""
self._endpoint_name = endpoint_name
@property
def endpoint_type(self):
"""
Gets the endpoint_type of this DeviceInNinFilter.
:return: The endpoint_type of this DeviceInNinFilter.
:rtype: str
"""
return self._endpoint_type
@endpoint_type.setter
def endpoint_type(self, endpoint_type):
"""
Sets the endpoint_type of this DeviceInNinFilter.
:param endpoint_type: The endpoint_type of this DeviceInNinFilter.
:type: str
"""
self._endpoint_type = endpoint_type
@property
def enrolment_list_timestamp(self):
"""
Gets the enrolment_list_timestamp of this DeviceInNinFilter.
:return: The enrolment_list_timestamp of this DeviceInNinFilter.
:rtype: datetime
"""
return self._enrolment_list_timestamp
@enrolment_list_timestamp.setter
def enrolment_list_timestamp(self, enrolment_list_timestamp):
"""
Sets the enrolment_list_timestamp of this DeviceInNinFilter.
:param enrolment_list_timestamp: The enrolment_list_timestamp of this DeviceInNinFilter.
:type: datetime
"""
self._enrolment_list_timestamp = enrolment_list_timestamp
@property
def etag(self):
"""
Gets the etag of this DeviceInNinFilter.
:return: The etag of this DeviceInNinFilter.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeviceInNinFilter.
:param etag: The etag of this DeviceInNinFilter.
:type: datetime
"""
self._etag = etag
@property
def firmware_checksum(self):
"""
Gets the firmware_checksum of this DeviceInNinFilter.
:return: The firmware_checksum of this DeviceInNinFilter.
:rtype: str
"""
return self._firmware_checksum
@firmware_checksum.setter
def firmware_checksum(self, firmware_checksum):
"""
Sets the firmware_checksum of this DeviceInNinFilter.
:param firmware_checksum: The firmware_checksum of this DeviceInNinFilter.
:type: str
"""
self._firmware_checksum = firmware_checksum
@property
def host_gateway(self):
"""
Gets the host_gateway of this DeviceInNinFilter.
:return: The host_gateway of this DeviceInNinFilter.
:rtype: str
"""
return self._host_gateway
@host_gateway.setter
def host_gateway(self, host_gateway):
"""
Sets the host_gateway of this DeviceInNinFilter.
:param host_gateway: The host_gateway of this DeviceInNinFilter.
:type: str
"""
self._host_gateway = host_gateway
@property
def id(self):
"""
Gets the id of this DeviceInNinFilter.
:return: The id of this DeviceInNinFilter.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeviceInNinFilter.
:param id: The id of this DeviceInNinFilter.
:type: str
"""
self._id = id
@property
def manifest(self):
"""
Gets the manifest of this DeviceInNinFilter.
:return: The manifest of this DeviceInNinFilter.
:rtype: str
"""
return self._manifest
@manifest.setter
def manifest(self, manifest):
"""
Sets the manifest of this DeviceInNinFilter.
:param manifest: The manifest of this DeviceInNinFilter.
:type: str
"""
self._manifest = manifest
@property
def manifest_timestamp(self):
"""
Gets the manifest_timestamp of this DeviceInNinFilter.
:return: The manifest_timestamp of this DeviceInNinFilter.
:rtype: datetime
"""
return self._manifest_timestamp
@manifest_timestamp.setter
def manifest_timestamp(self, manifest_timestamp):
"""
Sets the manifest_timestamp of this DeviceInNinFilter.
:param manifest_timestamp: The manifest_timestamp of this DeviceInNinFilter.
:type: datetime
"""
self._manifest_timestamp = manifest_timestamp
@property
def mechanism(self):
"""
Gets the mechanism of this DeviceInNinFilter.
:return: The mechanism of this DeviceInNinFilter.
:rtype: str
"""
return self._mechanism
@mechanism.setter
def mechanism(self, mechanism):
"""
Sets the mechanism of this DeviceInNinFilter.
:param mechanism: The mechanism of this DeviceInNinFilter.
:type: str
"""
self._mechanism = mechanism
@property
def mechanism_url(self):
"""
Gets the mechanism_url of this DeviceInNinFilter.
:return: The mechanism_url of this DeviceInNinFilter.
:rtype: str
"""
return self._mechanism_url
@mechanism_url.setter
def mechanism_url(self, mechanism_url):
"""
Sets the mechanism_url of this DeviceInNinFilter.
:param mechanism_url: The mechanism_url of this DeviceInNinFilter.
:type: str
"""
self._mechanism_url = mechanism_url
@property
def name(self):
"""
Gets the name of this DeviceInNinFilter.
:return: The name of this DeviceInNinFilter.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceInNinFilter.
:param name: The name of this DeviceInNinFilter.
:type: str
"""
self._name = name
@property
def serial_number(self):
"""
Gets the serial_number of this DeviceInNinFilter.
:return: The serial_number of this DeviceInNinFilter.
:rtype: str
"""
return self._serial_number
@serial_number.setter
def serial_number(self, serial_number):
"""
Sets the serial_number of this DeviceInNinFilter.
:param serial_number: The serial_number of this DeviceInNinFilter.
:type: str
"""
self._serial_number = serial_number
@property
def state(self):
"""
Gets the state of this DeviceInNinFilter.
:return: The state of this DeviceInNinFilter.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this DeviceInNinFilter.
:param state: The state of this DeviceInNinFilter.
:type: str
"""
self._state = state
@property
def updated_at(self):
"""
Gets the updated_at of this DeviceInNinFilter.
:return: The updated_at of this DeviceInNinFilter.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this DeviceInNinFilter.
:param updated_at: The updated_at of this DeviceInNinFilter.
:type: datetime
"""
self._updated_at = updated_at
@property
def vendor_id(self):
"""
Gets the vendor_id of this DeviceInNinFilter.
:return: The vendor_id of this DeviceInNinFilter.
:rtype: str
"""
return self._vendor_id
@vendor_id.setter
def vendor_id(self, vendor_id):
"""
Sets the vendor_id of this DeviceInNinFilter.
:param vendor_id: The vendor_id of this DeviceInNinFilter.
:type: str
"""
self._vendor_id = vendor_id
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceInNinFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceInNinFilter(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, account_id=None, auto_update=None, bootstrap_expiration_date=None, bootstrapped_timestamp=None, ca_id=None, connector_expiration_date=None, created_at=None, custom_attributes=None, deployed_state=None, deployment=None, description=None, device_class=None, device_execution_mode=None, device_key=None, endpoint_name=None, endpoint_type=None, enrolment_list_timestamp=None, etag=None, firmware_checksum=None, host_gateway=None, id=None, manifest=None, manifest_timestamp=None, mechanism=None, mechanism_url=None, name=None, serial_number=None, state=None, updated_at=None, vendor_id=None):
'''
DeviceInNinFilter - a model defined in Swagger
'''
pass
@property
def account_id(self):
'''
Gets the account_id of this DeviceInNinFilter.
:return: The account_id of this DeviceInNinFilter.
:rtype: str
'''
pass
@account_id.setter
def account_id(self):
'''
Sets the account_id of this DeviceInNinFilter.
:param account_id: The account_id of this DeviceInNinFilter.
:type: str
'''
pass
@property
def auto_update(self):
'''
Gets the auto_update of this DeviceInNinFilter.
:return: The auto_update of this DeviceInNinFilter.
:rtype: bool
'''
pass
@auto_update.setter
def auto_update(self):
'''
Sets the auto_update of this DeviceInNinFilter.
:param auto_update: The auto_update of this DeviceInNinFilter.
:type: bool
'''
pass
@property
def bootstrap_expiration_date(self):
'''
Gets the bootstrap_expiration_date of this DeviceInNinFilter.
:return: The bootstrap_expiration_date of this DeviceInNinFilter.
:rtype: datetime
'''
pass
@bootstrap_expiration_date.setter
def bootstrap_expiration_date(self):
'''
Sets the bootstrap_expiration_date of this DeviceInNinFilter.
:param bootstrap_expiration_date: The bootstrap_expiration_date of this DeviceInNinFilter.
:type: datetime
'''
pass
@property
def bootstrapped_timestamp(self):
'''
Gets the bootstrapped_timestamp of this DeviceInNinFilter.
:return: The bootstrapped_timestamp of this DeviceInNinFilter.
:rtype: datetime
'''
pass
@bootstrapped_timestamp.setter
def bootstrapped_timestamp(self):
'''
Sets the bootstrapped_timestamp of this DeviceInNinFilter.
:param bootstrapped_timestamp: The bootstrapped_timestamp of this DeviceInNinFilter.
:type: datetime
'''
pass
@property
def ca_id(self):
'''
Gets the ca_id of this DeviceInNinFilter.
:return: The ca_id of this DeviceInNinFilter.
:rtype: str
'''
pass
@ca_id.setter
def ca_id(self):
'''
Sets the ca_id of this DeviceInNinFilter.
:param ca_id: The ca_id of this DeviceInNinFilter.
:type: str
'''
pass
@property
def connector_expiration_date(self):
'''
Gets the connector_expiration_date of this DeviceInNinFilter.
:return: The connector_expiration_date of this DeviceInNinFilter.
:rtype: datetime
'''
pass
@connector_expiration_date.setter
def connector_expiration_date(self):
'''
Sets the connector_expiration_date of this DeviceInNinFilter.
:param connector_expiration_date: The connector_expiration_date of this DeviceInNinFilter.
:type: datetime
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeviceInNinFilter.
:return: The created_at of this DeviceInNinFilter.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeviceInNinFilter.
:param created_at: The created_at of this DeviceInNinFilter.
:type: datetime
'''
pass
@property
def custom_attributes(self):
'''
Gets the custom_attributes of this DeviceInNinFilter.
:return: The custom_attributes of this DeviceInNinFilter.
:rtype: dict(str, str)
'''
pass
@custom_attributes.setter
def custom_attributes(self):
'''
Sets the custom_attributes of this DeviceInNinFilter.
:param custom_attributes: The custom_attributes of this DeviceInNinFilter.
:type: dict(str, str)
'''
pass
@property
def deployed_state(self):
'''
Gets the deployed_state of this DeviceInNinFilter.
:return: The deployed_state of this DeviceInNinFilter.
:rtype: str
'''
pass
@deployed_state.setter
def deployed_state(self):
'''
Sets the deployed_state of this DeviceInNinFilter.
:param deployed_state: The deployed_state of this DeviceInNinFilter.
:type: str
'''
pass
@property
def deployment(self):
'''
Gets the deployment of this DeviceInNinFilter.
:return: The deployment of this DeviceInNinFilter.
:rtype: str
'''
pass
@deployment.setter
def deployment(self):
'''
Sets the deployment of this DeviceInNinFilter.
:param deployment: The deployment of this DeviceInNinFilter.
:type: str
'''
pass
@property
def description(self):
'''
Gets the description of this DeviceInNinFilter.
:return: The description of this DeviceInNinFilter.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeviceInNinFilter.
:param description: The description of this DeviceInNinFilter.
:type: str
'''
pass
@property
def device_class(self):
'''
Gets the device_class of this DeviceInNinFilter.
:return: The device_class of this DeviceInNinFilter.
:rtype: str
'''
pass
@device_class.setter
def device_class(self):
'''
Sets the device_class of this DeviceInNinFilter.
:param device_class: The device_class of this DeviceInNinFilter.
:type: str
'''
pass
@property
def device_execution_mode(self):
'''
Gets the device_execution_mode of this DeviceInNinFilter.
:return: The device_execution_mode of this DeviceInNinFilter.
:rtype: int
'''
pass
@device_execution_mode.setter
def device_execution_mode(self):
'''
Sets the device_execution_mode of this DeviceInNinFilter.
:param device_execution_mode: The device_execution_mode of this DeviceInNinFilter.
:type: int
'''
pass
@property
def device_key(self):
'''
Gets the device_key of this DeviceInNinFilter.
:return: The device_key of this DeviceInNinFilter.
:rtype: str
'''
pass
@device_key.setter
def device_key(self):
'''
Sets the device_key of this DeviceInNinFilter.
:param device_key: The device_key of this DeviceInNinFilter.
:type: str
'''
pass
@property
def endpoint_name(self):
'''
Gets the endpoint_name of this DeviceInNinFilter.
:return: The endpoint_name of this DeviceInNinFilter.
:rtype: str
'''
pass
@endpoint_name.setter
def endpoint_name(self):
'''
Sets the endpoint_name of this DeviceInNinFilter.
:param endpoint_name: The endpoint_name of this DeviceInNinFilter.
:type: str
'''
pass
@property
def endpoint_type(self):
'''
Gets the endpoint_type of this DeviceInNinFilter.
:return: The endpoint_type of this DeviceInNinFilter.
:rtype: str
'''
pass
@endpoint_type.setter
def endpoint_type(self):
'''
Sets the endpoint_type of this DeviceInNinFilter.
:param endpoint_type: The endpoint_type of this DeviceInNinFilter.
:type: str
'''
pass
@property
def enrolment_list_timestamp(self):
'''
Gets the enrolment_list_timestamp of this DeviceInNinFilter.
:return: The enrolment_list_timestamp of this DeviceInNinFilter.
:rtype: datetime
'''
pass
@enrolment_list_timestamp.setter
def enrolment_list_timestamp(self):
'''
Sets the enrolment_list_timestamp of this DeviceInNinFilter.
:param enrolment_list_timestamp: The enrolment_list_timestamp of this DeviceInNinFilter.
:type: datetime
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeviceInNinFilter.
:return: The etag of this DeviceInNinFilter.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeviceInNinFilter.
:param etag: The etag of this DeviceInNinFilter.
:type: datetime
'''
pass
@property
def firmware_checksum(self):
'''
Gets the firmware_checksum of this DeviceInNinFilter.
:return: The firmware_checksum of this DeviceInNinFilter.
:rtype: str
'''
pass
@firmware_checksum.setter
def firmware_checksum(self):
'''
Sets the firmware_checksum of this DeviceInNinFilter.
:param firmware_checksum: The firmware_checksum of this DeviceInNinFilter.
:type: str
'''
pass
@property
def host_gateway(self):
'''
Gets the host_gateway of this DeviceInNinFilter.
:return: The host_gateway of this DeviceInNinFilter.
:rtype: str
'''
pass
@host_gateway.setter
def host_gateway(self):
'''
Sets the host_gateway of this DeviceInNinFilter.
:param host_gateway: The host_gateway of this DeviceInNinFilter.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this DeviceInNinFilter.
:return: The id of this DeviceInNinFilter.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeviceInNinFilter.
:param id: The id of this DeviceInNinFilter.
:type: str
'''
pass
@property
def manifest(self):
'''
Gets the manifest of this DeviceInNinFilter.
:return: The manifest of this DeviceInNinFilter.
:rtype: str
'''
pass
@manifest.setter
def manifest(self):
'''
Sets the manifest of this DeviceInNinFilter.
:param manifest: The manifest of this DeviceInNinFilter.
:type: str
'''
pass
@property
def manifest_timestamp(self):
'''
Gets the manifest_timestamp of this DeviceInNinFilter.
:return: The manifest_timestamp of this DeviceInNinFilter.
:rtype: datetime
'''
pass
@manifest_timestamp.setter
def manifest_timestamp(self):
'''
Sets the manifest_timestamp of this DeviceInNinFilter.
:param manifest_timestamp: The manifest_timestamp of this DeviceInNinFilter.
:type: datetime
'''
pass
@property
def mechanism(self):
'''
Gets the mechanism of this DeviceInNinFilter.
:return: The mechanism of this DeviceInNinFilter.
:rtype: str
'''
pass
@mechanism.setter
def mechanism(self):
'''
Sets the mechanism of this DeviceInNinFilter.
:param mechanism: The mechanism of this DeviceInNinFilter.
:type: str
'''
pass
@property
def mechanism_url(self):
'''
Gets the mechanism_url of this DeviceInNinFilter.
:return: The mechanism_url of this DeviceInNinFilter.
:rtype: str
'''
pass
@mechanism_url.setter
def mechanism_url(self):
'''
Sets the mechanism_url of this DeviceInNinFilter.
:param mechanism_url: The mechanism_url of this DeviceInNinFilter.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceInNinFilter.
:return: The name of this DeviceInNinFilter.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceInNinFilter.
:param name: The name of this DeviceInNinFilter.
:type: str
'''
pass
@property
def serial_number(self):
'''
Gets the serial_number of this DeviceInNinFilter.
:return: The serial_number of this DeviceInNinFilter.
:rtype: str
'''
pass
@serial_number.setter
def serial_number(self):
'''
Sets the serial_number of this DeviceInNinFilter.
:param serial_number: The serial_number of this DeviceInNinFilter.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this DeviceInNinFilter.
:return: The state of this DeviceInNinFilter.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this DeviceInNinFilter.
:param state: The state of this DeviceInNinFilter.
:type: str
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this DeviceInNinFilter.
:return: The updated_at of this DeviceInNinFilter.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this DeviceInNinFilter.
:param updated_at: The updated_at of this DeviceInNinFilter.
:type: datetime
'''
pass
@property
def vendor_id(self):
'''
Gets the vendor_id of this DeviceInNinFilter.
:return: The vendor_id of this DeviceInNinFilter.
:rtype: str
'''
pass
@vendor_id.setter
def vendor_id(self):
'''
Sets the vendor_id of this DeviceInNinFilter.
:param vendor_id: The vendor_id of this DeviceInNinFilter.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 127 | 67 | 9 | 1 | 3 | 5 | 1 | 1.07 | 1 | 3 | 0 | 0 | 66 | 31 | 66 | 66 | 799 | 163 | 307 | 163 | 180 | 329 | 175 | 103 | 108 | 5 | 1 | 2 | 71 |
2,409 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_gte_lte_filter.py
|
mbed_cloud._backends.device_directory.models.device_gte_lte_filter.DeviceGteLteFilter
|
class DeviceGteLteFilter(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 = {
'bootstrap_expiration_date': 'datetime',
'bootstrapped_timestamp': 'datetime',
'connector_expiration_date': 'datetime',
'created_at': 'datetime',
'enrolment_list_timestamp': 'datetime',
'etag': 'datetime',
'manifest_timestamp': 'datetime',
'updated_at': 'datetime'
}
attribute_map = {
'bootstrap_expiration_date': 'bootstrap_expiration_date',
'bootstrapped_timestamp': 'bootstrapped_timestamp',
'connector_expiration_date': 'connector_expiration_date',
'created_at': 'created_at',
'enrolment_list_timestamp': 'enrolment_list_timestamp',
'etag': 'etag',
'manifest_timestamp': 'manifest_timestamp',
'updated_at': 'updated_at'
}
def __init__(self, bootstrap_expiration_date=None, bootstrapped_timestamp=None, connector_expiration_date=None, created_at=None, enrolment_list_timestamp=None, etag=None, manifest_timestamp=None, updated_at=None):
"""
DeviceGteLteFilter - a model defined in Swagger
"""
self._bootstrap_expiration_date = bootstrap_expiration_date
self._bootstrapped_timestamp = bootstrapped_timestamp
self._connector_expiration_date = connector_expiration_date
self._created_at = created_at
self._enrolment_list_timestamp = enrolment_list_timestamp
self._etag = etag
self._manifest_timestamp = manifest_timestamp
self._updated_at = updated_at
self.discriminator = None
@property
def bootstrap_expiration_date(self):
"""
Gets the bootstrap_expiration_date of this DeviceGteLteFilter.
:return: The bootstrap_expiration_date of this DeviceGteLteFilter.
:rtype: datetime
"""
return self._bootstrap_expiration_date
@bootstrap_expiration_date.setter
def bootstrap_expiration_date(self, bootstrap_expiration_date):
"""
Sets the bootstrap_expiration_date of this DeviceGteLteFilter.
:param bootstrap_expiration_date: The bootstrap_expiration_date of this DeviceGteLteFilter.
:type: datetime
"""
self._bootstrap_expiration_date = bootstrap_expiration_date
@property
def bootstrapped_timestamp(self):
"""
Gets the bootstrapped_timestamp of this DeviceGteLteFilter.
:return: The bootstrapped_timestamp of this DeviceGteLteFilter.
:rtype: datetime
"""
return self._bootstrapped_timestamp
@bootstrapped_timestamp.setter
def bootstrapped_timestamp(self, bootstrapped_timestamp):
"""
Sets the bootstrapped_timestamp of this DeviceGteLteFilter.
:param bootstrapped_timestamp: The bootstrapped_timestamp of this DeviceGteLteFilter.
:type: datetime
"""
self._bootstrapped_timestamp = bootstrapped_timestamp
@property
def connector_expiration_date(self):
"""
Gets the connector_expiration_date of this DeviceGteLteFilter.
:return: The connector_expiration_date of this DeviceGteLteFilter.
:rtype: datetime
"""
return self._connector_expiration_date
@connector_expiration_date.setter
def connector_expiration_date(self, connector_expiration_date):
"""
Sets the connector_expiration_date of this DeviceGteLteFilter.
:param connector_expiration_date: The connector_expiration_date of this DeviceGteLteFilter.
:type: datetime
"""
self._connector_expiration_date = connector_expiration_date
@property
def created_at(self):
"""
Gets the created_at of this DeviceGteLteFilter.
:return: The created_at of this DeviceGteLteFilter.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeviceGteLteFilter.
:param created_at: The created_at of this DeviceGteLteFilter.
:type: datetime
"""
self._created_at = created_at
@property
def enrolment_list_timestamp(self):
"""
Gets the enrolment_list_timestamp of this DeviceGteLteFilter.
:return: The enrolment_list_timestamp of this DeviceGteLteFilter.
:rtype: datetime
"""
return self._enrolment_list_timestamp
@enrolment_list_timestamp.setter
def enrolment_list_timestamp(self, enrolment_list_timestamp):
"""
Sets the enrolment_list_timestamp of this DeviceGteLteFilter.
:param enrolment_list_timestamp: The enrolment_list_timestamp of this DeviceGteLteFilter.
:type: datetime
"""
self._enrolment_list_timestamp = enrolment_list_timestamp
@property
def etag(self):
"""
Gets the etag of this DeviceGteLteFilter.
:return: The etag of this DeviceGteLteFilter.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeviceGteLteFilter.
:param etag: The etag of this DeviceGteLteFilter.
:type: datetime
"""
self._etag = etag
@property
def manifest_timestamp(self):
"""
Gets the manifest_timestamp of this DeviceGteLteFilter.
:return: The manifest_timestamp of this DeviceGteLteFilter.
:rtype: datetime
"""
return self._manifest_timestamp
@manifest_timestamp.setter
def manifest_timestamp(self, manifest_timestamp):
"""
Sets the manifest_timestamp of this DeviceGteLteFilter.
:param manifest_timestamp: The manifest_timestamp of this DeviceGteLteFilter.
:type: datetime
"""
self._manifest_timestamp = manifest_timestamp
@property
def updated_at(self):
"""
Gets the updated_at of this DeviceGteLteFilter.
:return: The updated_at of this DeviceGteLteFilter.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this DeviceGteLteFilter.
:param updated_at: The updated_at of this DeviceGteLteFilter.
:type: datetime
"""
self._updated_at = updated_at
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceGteLteFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceGteLteFilter(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, bootstrap_expiration_date=None, bootstrapped_timestamp=None, connector_expiration_date=None, created_at=None, enrolment_list_timestamp=None, etag=None, manifest_timestamp=None, updated_at=None):
'''
DeviceGteLteFilter - a model defined in Swagger
'''
pass
@property
def bootstrap_expiration_date(self):
'''
Gets the bootstrap_expiration_date of this DeviceGteLteFilter.
:return: The bootstrap_expiration_date of this DeviceGteLteFilter.
:rtype: datetime
'''
pass
@bootstrap_expiration_date.setter
def bootstrap_expiration_date(self):
'''
Sets the bootstrap_expiration_date of this DeviceGteLteFilter.
:param bootstrap_expiration_date: The bootstrap_expiration_date of this DeviceGteLteFilter.
:type: datetime
'''
pass
@property
def bootstrapped_timestamp(self):
'''
Gets the bootstrapped_timestamp of this DeviceGteLteFilter.
:return: The bootstrapped_timestamp of this DeviceGteLteFilter.
:rtype: datetime
'''
pass
@bootstrapped_timestamp.setter
def bootstrapped_timestamp(self):
'''
Sets the bootstrapped_timestamp of this DeviceGteLteFilter.
:param bootstrapped_timestamp: The bootstrapped_timestamp of this DeviceGteLteFilter.
:type: datetime
'''
pass
@property
def connector_expiration_date(self):
'''
Gets the connector_expiration_date of this DeviceGteLteFilter.
:return: The connector_expiration_date of this DeviceGteLteFilter.
:rtype: datetime
'''
pass
@connector_expiration_date.setter
def connector_expiration_date(self):
'''
Sets the connector_expiration_date of this DeviceGteLteFilter.
:param connector_expiration_date: The connector_expiration_date of this DeviceGteLteFilter.
:type: datetime
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeviceGteLteFilter.
:return: The created_at of this DeviceGteLteFilter.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeviceGteLteFilter.
:param created_at: The created_at of this DeviceGteLteFilter.
:type: datetime
'''
pass
@property
def enrolment_list_timestamp(self):
'''
Gets the enrolment_list_timestamp of this DeviceGteLteFilter.
:return: The enrolment_list_timestamp of this DeviceGteLteFilter.
:rtype: datetime
'''
pass
@enrolment_list_timestamp.setter
def enrolment_list_timestamp(self):
'''
Sets the enrolment_list_timestamp of this DeviceGteLteFilter.
:param enrolment_list_timestamp: The enrolment_list_timestamp of this DeviceGteLteFilter.
:type: datetime
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeviceGteLteFilter.
:return: The etag of this DeviceGteLteFilter.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeviceGteLteFilter.
:param etag: The etag of this DeviceGteLteFilter.
:type: datetime
'''
pass
@property
def manifest_timestamp(self):
'''
Gets the manifest_timestamp of this DeviceGteLteFilter.
:return: The manifest_timestamp of this DeviceGteLteFilter.
:rtype: datetime
'''
pass
@manifest_timestamp.setter
def manifest_timestamp(self):
'''
Sets the manifest_timestamp of this DeviceGteLteFilter.
:param manifest_timestamp: The manifest_timestamp of this DeviceGteLteFilter.
:type: datetime
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this DeviceGteLteFilter.
:return: The updated_at of this DeviceGteLteFilter.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this DeviceGteLteFilter.
:param updated_at: The updated_at of this DeviceGteLteFilter.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 39 | 23 | 9 | 1 | 3 | 4 | 1 | 1 | 1 | 3 | 0 | 0 | 22 | 9 | 22 | 22 | 271 | 53 | 109 | 53 | 70 | 109 | 65 | 37 | 42 | 5 | 1 | 2 | 27 |
2,410 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/configuration.py
|
mbed_cloud._backends.external_ca.configuration.Configuration
|
class Configuration(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
"""
def __init__(self):
"""Constructor"""
# Default Base url
self.host = "https://api.us-east-1.mbedcloud.com"
# Temp file folder for downloading files
self.temp_folder_path = None
# Authentication Settings
# dict to store API key(s)
self.api_key = {}
# dict to store API prefix (e.g. Bearer)
self.api_key_prefix = {}
# Username for HTTP basic authentication
self.username = ""
# Password for HTTP basic authentication
self.password = ""
# Logging Settings
self.logger = {}
self.logger["package_logger"] = logging.getLogger("external_ca")
self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler
self.logger_stream_handler = None
# Log file handler
self.logger_file_handler = None
# Debug file location
self.logger_file = None
# Debug switch
self.debug = False
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True
# Set this to customize the certificate file to verify the peer.
self.ssl_ca_cert = None
# client certificate file
self.cert_file = None
# client key file
self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification.
self.assert_hostname = None
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
# Proxy URL
self.proxy = None
# Safe chars for path_param
self.safe_chars_for_path_param = ''
@property
def logger_file(self):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
return self.__logger_file
@logger_file.setter
def logger_file(self, value):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
self.__logger_file = value
if self.__logger_file:
# If set logging file,
# then add file handler and remove stream handler.
self.logger_file_handler = logging.FileHandler(self.__logger_file)
self.logger_file_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_file_handler)
if self.logger_stream_handler:
logger.removeHandler(self.logger_stream_handler)
else:
# If not set logging file,
# then add stream handler and remove file handler.
self.logger_stream_handler = logging.StreamHandler()
self.logger_stream_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_stream_handler)
if self.logger_file_handler:
logger.removeHandler(self.logger_file_handler)
@property
def debug(self):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
return self.__debug
@debug.setter
def debug(self, value):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
self.__debug = value
if self.__debug:
# if debug status is True, turn on debug logging
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.DEBUG)
# turn on httplib debug
httplib.HTTPConnection.debuglevel = 1
else:
# if debug status is False, turn off debug logging,
# setting log level to default `logging.WARNING`
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.WARNING)
# turn off httplib debug
httplib.HTTPConnection.debuglevel = 0
@property
def logger_format(self):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
return self.__logger_format
@logger_format.setter
def logger_format(self, value):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)
def get_api_key_with_prefix(self, identifier):
"""Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
"""
if (self.api_key.get(identifier) and
self.api_key_prefix.get(identifier)):
return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] # noqa: E501
elif self.api_key.get(identifier):
return self.api_key[identifier]
def get_basic_auth_token(self):
"""Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
"""
return urllib3.util.make_headers(
basic_auth=self.username + ':' + self.password
).get('authorization')
def auth_settings(self):
"""Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
"""
return {
'Bearer':
{
'type': 'api_key',
'in': 'header',
'key': 'Authorization',
'value': self.get_api_key_with_prefix('Authorization')
},
}
def to_debug_report(self):
"""Gets the essential information for debugging.
:return: The report for debugging.
"""
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: v3\n"\
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)
|
class Configuration(object):
'''NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
'''
def __init__(self):
'''Constructor'''
pass
@property
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@logger_file.setter
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@property
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@debug.setter
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@property
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
@logger_format.setter
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
def get_api_key_with_prefix(self, identifier):
'''Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
'''
pass
def get_basic_auth_token(self):
'''Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
'''
pass
def auth_settings(self):
'''Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
'''
pass
def to_debug_report(self):
'''Gets the essential information for debugging.
:return: The report for debugging.
'''
pass
| 18 | 12 | 17 | 2 | 8 | 7 | 2 | 0.92 | 1 | 3 | 0 | 0 | 11 | 21 | 11 | 11 | 208 | 32 | 92 | 41 | 74 | 85 | 67 | 35 | 55 | 6 | 1 | 3 | 21 |
2,411 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/certificate_issuer_config_list_response.py
|
mbed_cloud._backends.external_ca.models.certificate_issuer_config_list_response.CertificateIssuerConfigListResponse
|
class CertificateIssuerConfigListResponse(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 = {
'after': 'str',
'data': 'list[CertificateIssuerConfigResponse]',
'limit': 'int',
'object': 'str',
'order': 'str',
'total_count': 'int'
}
attribute_map = {
'after': 'after',
'data': 'data',
'limit': 'limit',
'object': 'object',
'order': 'order',
'total_count': 'total_count'
}
def __init__(self, after=None, data=None, limit=None, object=None, order=None, total_count=None):
"""
CertificateIssuerConfigListResponse - a model defined in Swagger
"""
self._after = after
self._data = data
self._limit = limit
self._object = object
self._order = order
self._total_count = total_count
self.discriminator = None
@property
def after(self):
"""
Gets the after of this CertificateIssuerConfigListResponse.
The entity ID to fetch after current result set.
:return: The after of this CertificateIssuerConfigListResponse.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this CertificateIssuerConfigListResponse.
The entity ID to fetch after current result set.
:param after: The after of this CertificateIssuerConfigListResponse.
:type: str
"""
self._after = after
@property
def data(self):
"""
Gets the data of this CertificateIssuerConfigListResponse.
List of certificate issuers.
:return: The data of this CertificateIssuerConfigListResponse.
:rtype: list[CertificateIssuerConfigResponse]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this CertificateIssuerConfigListResponse.
List of certificate issuers.
:param data: The data of this CertificateIssuerConfigListResponse.
:type: list[CertificateIssuerConfigResponse]
"""
self._data = data
@property
def limit(self):
"""
Gets the limit of this CertificateIssuerConfigListResponse.
The number of results returned.
:return: The limit of this CertificateIssuerConfigListResponse.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this CertificateIssuerConfigListResponse.
The number of results returned.
:param limit: The limit of this CertificateIssuerConfigListResponse.
:type: int
"""
self._limit = limit
@property
def object(self):
"""
Gets the object of this CertificateIssuerConfigListResponse.
Describes the type of objects in the list.
:return: The object of this CertificateIssuerConfigListResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this CertificateIssuerConfigListResponse.
Describes the type of objects in the list.
:param object: The object of this CertificateIssuerConfigListResponse.
:type: str
"""
allowed_values = ["list"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def order(self):
"""
Gets the order of this CertificateIssuerConfigListResponse.
The order of results.
:return: The order of this CertificateIssuerConfigListResponse.
:rtype: str
"""
return self._order
@order.setter
def order(self, order):
"""
Sets the order of this CertificateIssuerConfigListResponse.
The order of results.
:param order: The order of this CertificateIssuerConfigListResponse.
:type: str
"""
allowed_values = ["ASC", "DESC"]
if order not in allowed_values:
raise ValueError(
"Invalid value for `order` ({0}), must be one of {1}"
.format(order, allowed_values)
)
self._order = order
@property
def total_count(self):
"""
Gets the total_count of this CertificateIssuerConfigListResponse.
The total number or records.
:return: The total_count of this CertificateIssuerConfigListResponse.
:rtype: int
"""
return self._total_count
@total_count.setter
def total_count(self, total_count):
"""
Sets the total_count of this CertificateIssuerConfigListResponse.
The total number or records.
:param total_count: The total_count of this CertificateIssuerConfigListResponse.
:type: int
"""
self._total_count = total_count
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CertificateIssuerConfigListResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CertificateIssuerConfigListResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, data=None, limit=None, object=None, order=None, total_count=None):
'''
CertificateIssuerConfigListResponse - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this CertificateIssuerConfigListResponse.
The entity ID to fetch after current result set.
:return: The after of this CertificateIssuerConfigListResponse.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this CertificateIssuerConfigListResponse.
The entity ID to fetch after current result set.
:param after: The after of this CertificateIssuerConfigListResponse.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this CertificateIssuerConfigListResponse.
List of certificate issuers.
:return: The data of this CertificateIssuerConfigListResponse.
:rtype: list[CertificateIssuerConfigResponse]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this CertificateIssuerConfigListResponse.
List of certificate issuers.
:param data: The data of this CertificateIssuerConfigListResponse.
:type: list[CertificateIssuerConfigResponse]
'''
pass
@property
def limit(self):
'''
Gets the limit of this CertificateIssuerConfigListResponse.
The number of results returned.
:return: The limit of this CertificateIssuerConfigListResponse.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this CertificateIssuerConfigListResponse.
The number of results returned.
:param limit: The limit of this CertificateIssuerConfigListResponse.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this CertificateIssuerConfigListResponse.
Describes the type of objects in the list.
:return: The object of this CertificateIssuerConfigListResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this CertificateIssuerConfigListResponse.
Describes the type of objects in the list.
:param object: The object of this CertificateIssuerConfigListResponse.
:type: str
'''
pass
@property
def order(self):
'''
Gets the order of this CertificateIssuerConfigListResponse.
The order of results.
:return: The order of this CertificateIssuerConfigListResponse.
:rtype: str
'''
pass
@order.setter
def order(self):
'''
Sets the order of this CertificateIssuerConfigListResponse.
The order of results.
:param order: The order of this CertificateIssuerConfigListResponse.
:type: str
'''
pass
@property
def total_count(self):
'''
Gets the total_count of this CertificateIssuerConfigListResponse.
The total number or records.
:return: The total_count of this CertificateIssuerConfigListResponse.
:rtype: int
'''
pass
@total_count.setter
def total_count(self):
'''
Sets the total_count of this CertificateIssuerConfigListResponse.
The total number or records.
:param total_count: The total_count of this CertificateIssuerConfigListResponse.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 10 | 1 | 4 | 5 | 1 | 0.98 | 1 | 4 | 0 | 0 | 18 | 7 | 18 | 18 | 247 | 43 | 103 | 45 | 72 | 101 | 61 | 33 | 42 | 5 | 1 | 2 | 25 |
2,412 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/certificate_issuer_config_request.py
|
mbed_cloud._backends.external_ca.models.certificate_issuer_config_request.CertificateIssuerConfigRequest
|
class CertificateIssuerConfigRequest(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 = {
'certificate_issuer_id': 'str'
}
attribute_map = {
'certificate_issuer_id': 'certificate_issuer_id'
}
def __init__(self, certificate_issuer_id=None):
"""
CertificateIssuerConfigRequest - a model defined in Swagger
"""
self._certificate_issuer_id = certificate_issuer_id
self.discriminator = None
@property
def certificate_issuer_id(self):
"""
Gets the certificate_issuer_id of this CertificateIssuerConfigRequest.
The ID of the certificate issuer. For LwM2M, it may be null if Device Management internal certificate issuer is used.
:return: The certificate_issuer_id of this CertificateIssuerConfigRequest.
:rtype: str
"""
return self._certificate_issuer_id
@certificate_issuer_id.setter
def certificate_issuer_id(self, certificate_issuer_id):
"""
Sets the certificate_issuer_id of this CertificateIssuerConfigRequest.
The ID of the certificate issuer. For LwM2M, it may be null if Device Management internal certificate issuer is used.
:param certificate_issuer_id: The certificate_issuer_id of this CertificateIssuerConfigRequest.
:type: str
"""
self._certificate_issuer_id = certificate_issuer_id
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CertificateIssuerConfigRequest):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CertificateIssuerConfigRequest(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, certificate_issuer_id=None):
'''
CertificateIssuerConfigRequest - a model defined in Swagger
'''
pass
@property
def certificate_issuer_id(self):
'''
Gets the certificate_issuer_id of this CertificateIssuerConfigRequest.
The ID of the certificate issuer. For LwM2M, it may be null if Device Management internal certificate issuer is used.
:return: The certificate_issuer_id of this CertificateIssuerConfigRequest.
:rtype: str
'''
pass
@certificate_issuer_id.setter
def certificate_issuer_id(self):
'''
Sets the certificate_issuer_id of this CertificateIssuerConfigRequest.
The ID of the certificate issuer. For LwM2M, it may be null if Device Management internal certificate issuer is used.
:param certificate_issuer_id: The certificate_issuer_id of this CertificateIssuerConfigRequest.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 11 | 9 | 9 | 1 | 5 | 4 | 2 | 0.89 | 1 | 3 | 0 | 0 | 8 | 2 | 8 | 8 | 105 | 18 | 46 | 18 | 35 | 41 | 30 | 16 | 21 | 5 | 1 | 2 | 13 |
2,413 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/certificate_issuer_config_response.py
|
mbed_cloud._backends.external_ca.models.certificate_issuer_config_response.CertificateIssuerConfigResponse
|
class CertificateIssuerConfigResponse(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 = {
'certificate_issuer_id': 'str',
'created_at': 'datetime',
'etag': 'str',
'id': 'str',
'is_custom': 'bool',
'object': 'str',
'reference': 'str',
'updated_at': 'datetime'
}
attribute_map = {
'certificate_issuer_id': 'certificate_issuer_id',
'created_at': 'created_at',
'etag': 'etag',
'id': 'id',
'is_custom': 'is_custom',
'object': 'object',
'reference': 'reference',
'updated_at': 'updated_at'
}
def __init__(self, certificate_issuer_id=None, created_at=None, etag=None, id=None, is_custom=None, object=None, reference=None, updated_at=None):
"""
CertificateIssuerConfigResponse - a model defined in Swagger
"""
self._certificate_issuer_id = certificate_issuer_id
self._created_at = created_at
self._etag = etag
self._id = id
self._is_custom = is_custom
self._object = object
self._reference = reference
self._updated_at = updated_at
self.discriminator = None
@property
def certificate_issuer_id(self):
"""
Gets the certificate_issuer_id of this CertificateIssuerConfigResponse.
The ID of the certificate issuer. Null if Device Management internal HSM is used.
:return: The certificate_issuer_id of this CertificateIssuerConfigResponse.
:rtype: str
"""
return self._certificate_issuer_id
@certificate_issuer_id.setter
def certificate_issuer_id(self, certificate_issuer_id):
"""
Sets the certificate_issuer_id of this CertificateIssuerConfigResponse.
The ID of the certificate issuer. Null if Device Management internal HSM is used.
:param certificate_issuer_id: The certificate_issuer_id of this CertificateIssuerConfigResponse.
:type: str
"""
self._certificate_issuer_id = certificate_issuer_id
@property
def created_at(self):
"""
Gets the created_at of this CertificateIssuerConfigResponse.
Created UTC time RFC3339.
:return: The created_at of this CertificateIssuerConfigResponse.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this CertificateIssuerConfigResponse.
Created UTC time RFC3339.
:param created_at: The created_at of this CertificateIssuerConfigResponse.
:type: datetime
"""
self._created_at = created_at
@property
def etag(self):
"""
Gets the etag of this CertificateIssuerConfigResponse.
Entity instance signature.
:return: The etag of this CertificateIssuerConfigResponse.
:rtype: str
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this CertificateIssuerConfigResponse.
Entity instance signature.
:param etag: The etag of this CertificateIssuerConfigResponse.
:type: str
"""
self._etag = etag
@property
def id(self):
"""
Gets the id of this CertificateIssuerConfigResponse.
The ID of the certificate issuer configuration.
:return: The id of this CertificateIssuerConfigResponse.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this CertificateIssuerConfigResponse.
The ID of the certificate issuer configuration.
:param id: The id of this CertificateIssuerConfigResponse.
:type: str
"""
self._id = id
@property
def is_custom(self):
"""
Gets the is_custom of this CertificateIssuerConfigResponse.
:return: The is_custom of this CertificateIssuerConfigResponse.
:rtype: bool
"""
return self._is_custom
@is_custom.setter
def is_custom(self, is_custom):
"""
Sets the is_custom of this CertificateIssuerConfigResponse.
:param is_custom: The is_custom of this CertificateIssuerConfigResponse.
:type: bool
"""
self._is_custom = is_custom
@property
def object(self):
"""
Gets the object of this CertificateIssuerConfigResponse.
:return: The object of this CertificateIssuerConfigResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this CertificateIssuerConfigResponse.
:param object: The object of this CertificateIssuerConfigResponse.
:type: str
"""
allowed_values = ["certificate-issuer-configuration"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def reference(self):
"""
Gets the reference of this CertificateIssuerConfigResponse.
The certificate name to which the certificate issuer configuration applies.
:return: The reference of this CertificateIssuerConfigResponse.
:rtype: str
"""
return self._reference
@reference.setter
def reference(self, reference):
"""
Sets the reference of this CertificateIssuerConfigResponse.
The certificate name to which the certificate issuer configuration applies.
:param reference: The reference of this CertificateIssuerConfigResponse.
:type: str
"""
self._reference = reference
@property
def updated_at(self):
"""
Gets the updated_at of this CertificateIssuerConfigResponse.
Updated UTC time RFC3339.
:return: The updated_at of this CertificateIssuerConfigResponse.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this CertificateIssuerConfigResponse.
Updated UTC time RFC3339.
:param updated_at: The updated_at of this CertificateIssuerConfigResponse.
:type: datetime
"""
self._updated_at = updated_at
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CertificateIssuerConfigResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CertificateIssuerConfigResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, certificate_issuer_id=None, created_at=None, etag=None, id=None, is_custom=None, object=None, reference=None, updated_at=None):
'''
CertificateIssuerConfigResponse - a model defined in Swagger
'''
pass
@property
def certificate_issuer_id(self):
'''
Gets the certificate_issuer_id of this CertificateIssuerConfigResponse.
The ID of the certificate issuer. Null if Device Management internal HSM is used.
:return: The certificate_issuer_id of this CertificateIssuerConfigResponse.
:rtype: str
'''
pass
@certificate_issuer_id.setter
def certificate_issuer_id(self):
'''
Sets the certificate_issuer_id of this CertificateIssuerConfigResponse.
The ID of the certificate issuer. Null if Device Management internal HSM is used.
:param certificate_issuer_id: The certificate_issuer_id of this CertificateIssuerConfigResponse.
:type: str
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this CertificateIssuerConfigResponse.
Created UTC time RFC3339.
:return: The created_at of this CertificateIssuerConfigResponse.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this CertificateIssuerConfigResponse.
Created UTC time RFC3339.
:param created_at: The created_at of this CertificateIssuerConfigResponse.
:type: datetime
'''
pass
@property
def etag(self):
'''
Gets the etag of this CertificateIssuerConfigResponse.
Entity instance signature.
:return: The etag of this CertificateIssuerConfigResponse.
:rtype: str
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this CertificateIssuerConfigResponse.
Entity instance signature.
:param etag: The etag of this CertificateIssuerConfigResponse.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this CertificateIssuerConfigResponse.
The ID of the certificate issuer configuration.
:return: The id of this CertificateIssuerConfigResponse.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this CertificateIssuerConfigResponse.
The ID of the certificate issuer configuration.
:param id: The id of this CertificateIssuerConfigResponse.
:type: str
'''
pass
@property
def is_custom(self):
'''
Gets the is_custom of this CertificateIssuerConfigResponse.
:return: The is_custom of this CertificateIssuerConfigResponse.
:rtype: bool
'''
pass
@is_custom.setter
def is_custom(self):
'''
Sets the is_custom of this CertificateIssuerConfigResponse.
:param is_custom: The is_custom of this CertificateIssuerConfigResponse.
:type: bool
'''
pass
@property
def object(self):
'''
Gets the object of this CertificateIssuerConfigResponse.
:return: The object of this CertificateIssuerConfigResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this CertificateIssuerConfigResponse.
:param object: The object of this CertificateIssuerConfigResponse.
:type: str
'''
pass
@property
def reference(self):
'''
Gets the reference of this CertificateIssuerConfigResponse.
The certificate name to which the certificate issuer configuration applies.
:return: The reference of this CertificateIssuerConfigResponse.
:rtype: str
'''
pass
@reference.setter
def reference(self):
'''
Sets the reference of this CertificateIssuerConfigResponse.
The certificate name to which the certificate issuer configuration applies.
:param reference: The reference of this CertificateIssuerConfigResponse.
:type: str
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this CertificateIssuerConfigResponse.
Updated UTC time RFC3339.
:return: The updated_at of this CertificateIssuerConfigResponse.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this CertificateIssuerConfigResponse.
Updated UTC time RFC3339.
:param updated_at: The updated_at of this CertificateIssuerConfigResponse.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 39 | 23 | 10 | 1 | 4 | 5 | 1 | 1.05 | 1 | 4 | 0 | 0 | 22 | 9 | 22 | 22 | 289 | 53 | 115 | 54 | 76 | 121 | 68 | 38 | 45 | 5 | 1 | 2 | 28 |
2,414 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/api_key_info_resp_list.py
|
mbed_cloud._backends.iam.models.api_key_info_resp_list.ApiKeyInfoRespList
|
class ApiKeyInfoRespList(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 = {
'after': 'str',
'data': 'list[ApiKeyInfoResp]',
'has_more': 'bool',
'limit': 'int',
'object': 'str',
'order': 'str',
'total_count': 'int'
}
attribute_map = {
'after': 'after',
'data': 'data',
'has_more': 'has_more',
'limit': 'limit',
'object': 'object',
'order': 'order',
'total_count': 'total_count'
}
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
"""
ApiKeyInfoRespList - a model defined in Swagger
"""
self._after = after
self._data = data
self._has_more = has_more
self._limit = limit
self._object = object
self._order = order
self._total_count = total_count
self.discriminator = None
@property
def after(self):
"""
Gets the after of this ApiKeyInfoRespList.
The entity ID to fetch after the given one.
:return: The after of this ApiKeyInfoRespList.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this ApiKeyInfoRespList.
The entity ID to fetch after the given one.
:param after: The after of this ApiKeyInfoRespList.
:type: str
"""
self._after = after
@property
def data(self):
"""
Gets the data of this ApiKeyInfoRespList.
A list of entities.
:return: The data of this ApiKeyInfoRespList.
:rtype: list[ApiKeyInfoResp]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this ApiKeyInfoRespList.
A list of entities.
:param data: The data of this ApiKeyInfoRespList.
:type: list[ApiKeyInfoResp]
"""
if data is None:
raise ValueError("Invalid value for `data`, must not be `None`")
self._data = data
@property
def has_more(self):
"""
Gets the has_more of this ApiKeyInfoRespList.
Flag indicating whether there is more results.
:return: The has_more of this ApiKeyInfoRespList.
:rtype: bool
"""
return self._has_more
@has_more.setter
def has_more(self, has_more):
"""
Sets the has_more of this ApiKeyInfoRespList.
Flag indicating whether there is more results.
:param has_more: The has_more of this ApiKeyInfoRespList.
:type: bool
"""
if has_more is None:
raise ValueError("Invalid value for `has_more`, must not be `None`")
self._has_more = has_more
@property
def limit(self):
"""
Gets the limit of this ApiKeyInfoRespList.
The number of results to return, (range: 2-1000), or equals to `total_count`
:return: The limit of this ApiKeyInfoRespList.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this ApiKeyInfoRespList.
The number of results to return, (range: 2-1000), or equals to `total_count`
:param limit: The limit of this ApiKeyInfoRespList.
:type: int
"""
if limit is None:
raise ValueError("Invalid value for `limit`, must not be `None`")
self._limit = limit
@property
def object(self):
"""
Gets the object of this ApiKeyInfoRespList.
Entity name: always 'list'
:return: The object of this ApiKeyInfoRespList.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ApiKeyInfoRespList.
Entity name: always 'list'
:param object: The object of this ApiKeyInfoRespList.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["list"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def order(self):
"""
Gets the order of this ApiKeyInfoRespList.
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
:return: The order of this ApiKeyInfoRespList.
:rtype: str
"""
return self._order
@order.setter
def order(self, order):
"""
Sets the order of this ApiKeyInfoRespList.
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
:param order: The order of this ApiKeyInfoRespList.
:type: str
"""
allowed_values = ["ASC", "DESC"]
if order not in allowed_values:
raise ValueError(
"Invalid value for `order` ({0}), must be one of {1}"
.format(order, allowed_values)
)
self._order = order
@property
def total_count(self):
"""
Gets the total_count of this ApiKeyInfoRespList.
The total number or records, if requested. It might be returned also for small lists.
:return: The total_count of this ApiKeyInfoRespList.
:rtype: int
"""
return self._total_count
@total_count.setter
def total_count(self, total_count):
"""
Sets the total_count of this ApiKeyInfoRespList.
The total number or records, if requested. It might be returned also for small lists.
:param total_count: The total_count of this ApiKeyInfoRespList.
:type: int
"""
if total_count is None:
raise ValueError("Invalid value for `total_count`, must not be `None`")
self._total_count = total_count
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ApiKeyInfoRespList):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ApiKeyInfoRespList(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
'''
ApiKeyInfoRespList - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this ApiKeyInfoRespList.
The entity ID to fetch after the given one.
:return: The after of this ApiKeyInfoRespList.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this ApiKeyInfoRespList.
The entity ID to fetch after the given one.
:param after: The after of this ApiKeyInfoRespList.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this ApiKeyInfoRespList.
A list of entities.
:return: The data of this ApiKeyInfoRespList.
:rtype: list[ApiKeyInfoResp]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this ApiKeyInfoRespList.
A list of entities.
:param data: The data of this ApiKeyInfoRespList.
:type: list[ApiKeyInfoResp]
'''
pass
@property
def has_more(self):
'''
Gets the has_more of this ApiKeyInfoRespList.
Flag indicating whether there is more results.
:return: The has_more of this ApiKeyInfoRespList.
:rtype: bool
'''
pass
@has_more.setter
def has_more(self):
'''
Sets the has_more of this ApiKeyInfoRespList.
Flag indicating whether there is more results.
:param has_more: The has_more of this ApiKeyInfoRespList.
:type: bool
'''
pass
@property
def limit(self):
'''
Gets the limit of this ApiKeyInfoRespList.
The number of results to return, (range: 2-1000), or equals to `total_count`
:return: The limit of this ApiKeyInfoRespList.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this ApiKeyInfoRespList.
The number of results to return, (range: 2-1000), or equals to `total_count`
:param limit: The limit of this ApiKeyInfoRespList.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this ApiKeyInfoRespList.
Entity name: always 'list'
:return: The object of this ApiKeyInfoRespList.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ApiKeyInfoRespList.
Entity name: always 'list'
:param object: The object of this ApiKeyInfoRespList.
:type: str
'''
pass
@property
def order(self):
'''
Gets the order of this ApiKeyInfoRespList.
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
:return: The order of this ApiKeyInfoRespList.
:rtype: str
'''
pass
@order.setter
def order(self):
'''
Sets the order of this ApiKeyInfoRespList.
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
:param order: The order of this ApiKeyInfoRespList.
:type: str
'''
pass
@property
def total_count(self):
'''
Gets the total_count of this ApiKeyInfoRespList.
The total number or records, if requested. It might be returned also for small lists.
:return: The total_count of this ApiKeyInfoRespList.
:rtype: int
'''
pass
@total_count.setter
def total_count(self):
'''
Sets the total_count of this ApiKeyInfoRespList.
The total number or records, if requested. It might be returned also for small lists.
:param total_count: The total_count of this ApiKeyInfoRespList.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 35 | 21 | 11 | 1 | 4 | 5 | 2 | 0.93 | 1 | 4 | 0 | 0 | 20 | 8 | 20 | 20 | 283 | 48 | 122 | 50 | 87 | 113 | 76 | 36 | 55 | 5 | 1 | 2 | 32 |
2,415 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/api_key_info_resp.py
|
mbed_cloud._backends.iam.models.api_key_info_resp.ApiKeyInfoResp
|
class ApiKeyInfoResp(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 = {
'created_at': 'datetime',
'creation_time': 'int',
'etag': 'str',
'groups': 'list[str]',
'id': 'str',
'key': 'str',
'last_login_time': 'int',
'name': 'str',
'object': 'str',
'owner': 'str',
'status': 'str',
'updated_at': 'datetime'
}
attribute_map = {
'created_at': 'created_at',
'creation_time': 'creation_time',
'etag': 'etag',
'groups': 'groups',
'id': 'id',
'key': 'key',
'last_login_time': 'last_login_time',
'name': 'name',
'object': 'object',
'owner': 'owner',
'status': 'status',
'updated_at': 'updated_at'
}
def __init__(self, created_at=None, creation_time=None, etag=None, groups=None, id=None, key=None, last_login_time=None, name=None, object=None, owner=None, status=None, updated_at=None):
"""
ApiKeyInfoResp - a model defined in Swagger
"""
self._created_at = created_at
self._creation_time = creation_time
self._etag = etag
self._groups = groups
self._id = id
self._key = key
self._last_login_time = last_login_time
self._name = name
self._object = object
self._owner = owner
self._status = status
self._updated_at = updated_at
self.discriminator = None
@property
def created_at(self):
"""
Gets the created_at of this ApiKeyInfoResp.
Creation UTC time RFC3339.
:return: The created_at of this ApiKeyInfoResp.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this ApiKeyInfoResp.
Creation UTC time RFC3339.
:param created_at: The created_at of this ApiKeyInfoResp.
:type: datetime
"""
self._created_at = created_at
@property
def creation_time(self):
"""
Gets the creation_time of this ApiKeyInfoResp.
The timestamp of the API key creation in the storage, in milliseconds.
:return: The creation_time of this ApiKeyInfoResp.
:rtype: int
"""
return self._creation_time
@creation_time.setter
def creation_time(self, creation_time):
"""
Sets the creation_time of this ApiKeyInfoResp.
The timestamp of the API key creation in the storage, in milliseconds.
:param creation_time: The creation_time of this ApiKeyInfoResp.
:type: int
"""
self._creation_time = creation_time
@property
def etag(self):
"""
Gets the etag of this ApiKeyInfoResp.
API resource entity version.
:return: The etag of this ApiKeyInfoResp.
:rtype: str
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this ApiKeyInfoResp.
API resource entity version.
:param etag: The etag of this ApiKeyInfoResp.
:type: str
"""
if etag is None:
raise ValueError("Invalid value for `etag`, must not be `None`")
self._etag = etag
@property
def groups(self):
"""
Gets the groups of this ApiKeyInfoResp.
A list of group IDs this API key belongs to.
:return: The groups of this ApiKeyInfoResp.
:rtype: list[str]
"""
return self._groups
@groups.setter
def groups(self, groups):
"""
Sets the groups of this ApiKeyInfoResp.
A list of group IDs this API key belongs to.
:param groups: The groups of this ApiKeyInfoResp.
:type: list[str]
"""
self._groups = groups
@property
def id(self):
"""
Gets the id of this ApiKeyInfoResp.
The UUID of the API key.
:return: The id of this ApiKeyInfoResp.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this ApiKeyInfoResp.
The UUID of the API key.
:param id: The id of this ApiKeyInfoResp.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def key(self):
"""
Gets the key of this ApiKeyInfoResp.
The API key.
:return: The key of this ApiKeyInfoResp.
:rtype: str
"""
return self._key
@key.setter
def key(self, key):
"""
Sets the key of this ApiKeyInfoResp.
The API key.
:param key: The key of this ApiKeyInfoResp.
:type: str
"""
if key is None:
raise ValueError("Invalid value for `key`, must not be `None`")
self._key = key
@property
def last_login_time(self):
"""
Gets the last_login_time of this ApiKeyInfoResp.
The timestamp of the latest API key usage, in milliseconds.
:return: The last_login_time of this ApiKeyInfoResp.
:rtype: int
"""
return self._last_login_time
@last_login_time.setter
def last_login_time(self, last_login_time):
"""
Sets the last_login_time of this ApiKeyInfoResp.
The timestamp of the latest API key usage, in milliseconds.
:param last_login_time: The last_login_time of this ApiKeyInfoResp.
:type: int
"""
self._last_login_time = last_login_time
@property
def name(self):
"""
Gets the name of this ApiKeyInfoResp.
The display name for the API key.
:return: The name of this ApiKeyInfoResp.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this ApiKeyInfoResp.
The display name for the API key.
:param name: The name of this ApiKeyInfoResp.
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`")
self._name = name
@property
def object(self):
"""
Gets the object of this ApiKeyInfoResp.
Entity name: always 'api-key'
:return: The object of this ApiKeyInfoResp.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ApiKeyInfoResp.
Entity name: always 'api-key'
:param object: The object of this ApiKeyInfoResp.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["api-key"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def owner(self):
"""
Gets the owner of this ApiKeyInfoResp.
The owner of this API key, who is the creator by default.
:return: The owner of this ApiKeyInfoResp.
:rtype: str
"""
return self._owner
@owner.setter
def owner(self, owner):
"""
Sets the owner of this ApiKeyInfoResp.
The owner of this API key, who is the creator by default.
:param owner: The owner of this ApiKeyInfoResp.
:type: str
"""
self._owner = owner
@property
def status(self):
"""
Gets the status of this ApiKeyInfoResp.
The status of the API key.
:return: The status of this ApiKeyInfoResp.
:rtype: str
"""
return self._status
@status.setter
def status(self, status):
"""
Sets the status of this ApiKeyInfoResp.
The status of the API key.
:param status: The status of this ApiKeyInfoResp.
:type: str
"""
allowed_values = ["ACTIVE", "INACTIVE"]
if status not in allowed_values:
raise ValueError(
"Invalid value for `status` ({0}), must be one of {1}"
.format(status, allowed_values)
)
self._status = status
@property
def updated_at(self):
"""
Gets the updated_at of this ApiKeyInfoResp.
Last update UTC time RFC3339.
:return: The updated_at of this ApiKeyInfoResp.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this ApiKeyInfoResp.
Last update UTC time RFC3339.
:param updated_at: The updated_at of this ApiKeyInfoResp.
:type: datetime
"""
self._updated_at = updated_at
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ApiKeyInfoResp):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ApiKeyInfoResp(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created_at=None, creation_time=None, etag=None, groups=None, id=None, key=None, last_login_time=None, name=None, object=None, owner=None, status=None, updated_at=None):
'''
ApiKeyInfoResp - a model defined in Swagger
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this ApiKeyInfoResp.
Creation UTC time RFC3339.
:return: The created_at of this ApiKeyInfoResp.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this ApiKeyInfoResp.
Creation UTC time RFC3339.
:param created_at: The created_at of this ApiKeyInfoResp.
:type: datetime
'''
pass
@property
def creation_time(self):
'''
Gets the creation_time of this ApiKeyInfoResp.
The timestamp of the API key creation in the storage, in milliseconds.
:return: The creation_time of this ApiKeyInfoResp.
:rtype: int
'''
pass
@creation_time.setter
def creation_time(self):
'''
Sets the creation_time of this ApiKeyInfoResp.
The timestamp of the API key creation in the storage, in milliseconds.
:param creation_time: The creation_time of this ApiKeyInfoResp.
:type: int
'''
pass
@property
def etag(self):
'''
Gets the etag of this ApiKeyInfoResp.
API resource entity version.
:return: The etag of this ApiKeyInfoResp.
:rtype: str
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this ApiKeyInfoResp.
API resource entity version.
:param etag: The etag of this ApiKeyInfoResp.
:type: str
'''
pass
@property
def groups(self):
'''
Gets the groups of this ApiKeyInfoResp.
A list of group IDs this API key belongs to.
:return: The groups of this ApiKeyInfoResp.
:rtype: list[str]
'''
pass
@groups.setter
def groups(self):
'''
Sets the groups of this ApiKeyInfoResp.
A list of group IDs this API key belongs to.
:param groups: The groups of this ApiKeyInfoResp.
:type: list[str]
'''
pass
@property
def id(self):
'''
Gets the id of this ApiKeyInfoResp.
The UUID of the API key.
:return: The id of this ApiKeyInfoResp.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this ApiKeyInfoResp.
The UUID of the API key.
:param id: The id of this ApiKeyInfoResp.
:type: str
'''
pass
@property
def key(self):
'''
Gets the key of this ApiKeyInfoResp.
The API key.
:return: The key of this ApiKeyInfoResp.
:rtype: str
'''
pass
@key.setter
def key(self):
'''
Sets the key of this ApiKeyInfoResp.
The API key.
:param key: The key of this ApiKeyInfoResp.
:type: str
'''
pass
@property
def last_login_time(self):
'''
Gets the last_login_time of this ApiKeyInfoResp.
The timestamp of the latest API key usage, in milliseconds.
:return: The last_login_time of this ApiKeyInfoResp.
:rtype: int
'''
pass
@last_login_time.setter
def last_login_time(self):
'''
Sets the last_login_time of this ApiKeyInfoResp.
The timestamp of the latest API key usage, in milliseconds.
:param last_login_time: The last_login_time of this ApiKeyInfoResp.
:type: int
'''
pass
@property
def name(self):
'''
Gets the name of this ApiKeyInfoResp.
The display name for the API key.
:return: The name of this ApiKeyInfoResp.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this ApiKeyInfoResp.
The display name for the API key.
:param name: The name of this ApiKeyInfoResp.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this ApiKeyInfoResp.
Entity name: always 'api-key'
:return: The object of this ApiKeyInfoResp.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ApiKeyInfoResp.
Entity name: always 'api-key'
:param object: The object of this ApiKeyInfoResp.
:type: str
'''
pass
@property
def owner(self):
'''
Gets the owner of this ApiKeyInfoResp.
The owner of this API key, who is the creator by default.
:return: The owner of this ApiKeyInfoResp.
:rtype: str
'''
pass
@owner.setter
def owner(self):
'''
Sets the owner of this ApiKeyInfoResp.
The owner of this API key, who is the creator by default.
:param owner: The owner of this ApiKeyInfoResp.
:type: str
'''
pass
@property
def status(self):
'''
Gets the status of this ApiKeyInfoResp.
The status of the API key.
:return: The status of this ApiKeyInfoResp.
:rtype: str
'''
pass
@status.setter
def status(self):
'''
Sets the status of this ApiKeyInfoResp.
The status of the API key.
:param status: The status of this ApiKeyInfoResp.
:type: str
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this ApiKeyInfoResp.
Last update UTC time RFC3339.
:return: The updated_at of this ApiKeyInfoResp.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this ApiKeyInfoResp.
Last update UTC time RFC3339.
:param updated_at: The updated_at of this ApiKeyInfoResp.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 55 | 31 | 11 | 1 | 4 | 5 | 1 | 1.04 | 1 | 4 | 0 | 0 | 30 | 13 | 30 | 30 | 413 | 73 | 167 | 75 | 112 | 173 | 101 | 51 | 70 | 5 | 1 | 2 | 42 |
2,416 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/api_key_info_req.py
|
mbed_cloud._backends.iam.models.api_key_info_req.ApiKeyInfoReq
|
class ApiKeyInfoReq(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 = {
'groups': 'list[str]',
'name': 'str',
'owner': 'str',
'status': 'str'
}
attribute_map = {
'groups': 'groups',
'name': 'name',
'owner': 'owner',
'status': 'status'
}
def __init__(self, groups=None, name=None, owner=None, status=None):
"""
ApiKeyInfoReq - a model defined in Swagger
"""
self._groups = groups
self._name = name
self._owner = owner
self._status = status
self.discriminator = None
@property
def groups(self):
"""
Gets the groups of this ApiKeyInfoReq.
A list of group IDs this API key belongs to.
:return: The groups of this ApiKeyInfoReq.
:rtype: list[str]
"""
return self._groups
@groups.setter
def groups(self, groups):
"""
Sets the groups of this ApiKeyInfoReq.
A list of group IDs this API key belongs to.
:param groups: The groups of this ApiKeyInfoReq.
:type: list[str]
"""
self._groups = groups
@property
def name(self):
"""
Gets the name of this ApiKeyInfoReq.
The display name for the API key, not longer than 100 characters.
:return: The name of this ApiKeyInfoReq.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this ApiKeyInfoReq.
The display name for the API key, not longer than 100 characters.
:param name: The name of this ApiKeyInfoReq.
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`")
self._name = name
@property
def owner(self):
"""
Gets the owner of this ApiKeyInfoReq.
The owner of this API key.
:return: The owner of this ApiKeyInfoReq.
:rtype: str
"""
return self._owner
@owner.setter
def owner(self, owner):
"""
Sets the owner of this ApiKeyInfoReq.
The owner of this API key.
:param owner: The owner of this ApiKeyInfoReq.
:type: str
"""
self._owner = owner
@property
def status(self):
"""
Gets the status of this ApiKeyInfoReq.
The status of the API key.
:return: The status of this ApiKeyInfoReq.
:rtype: str
"""
return self._status
@status.setter
def status(self, status):
"""
Sets the status of this ApiKeyInfoReq.
The status of the API key.
:param status: The status of this ApiKeyInfoReq.
:type: str
"""
allowed_values = ["ACTIVE", "INACTIVE"]
if status not in allowed_values:
raise ValueError(
"Invalid value for `status` ({0}), must be one of {1}"
.format(status, allowed_values)
)
self._status = status
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ApiKeyInfoReq):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ApiKeyInfoReq(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, groups=None, name=None, owner=None, status=None):
'''
ApiKeyInfoReq - a model defined in Swagger
'''
pass
@property
def groups(self):
'''
Gets the groups of this ApiKeyInfoReq.
A list of group IDs this API key belongs to.
:return: The groups of this ApiKeyInfoReq.
:rtype: list[str]
'''
pass
@groups.setter
def groups(self):
'''
Sets the groups of this ApiKeyInfoReq.
A list of group IDs this API key belongs to.
:param groups: The groups of this ApiKeyInfoReq.
:type: list[str]
'''
pass
@property
def name(self):
'''
Gets the name of this ApiKeyInfoReq.
The display name for the API key, not longer than 100 characters.
:return: The name of this ApiKeyInfoReq.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this ApiKeyInfoReq.
The display name for the API key, not longer than 100 characters.
:param name: The name of this ApiKeyInfoReq.
:type: str
'''
pass
@property
def owner(self):
'''
Gets the owner of this ApiKeyInfoReq.
The owner of this API key.
:return: The owner of this ApiKeyInfoReq.
:rtype: str
'''
pass
@owner.setter
def owner(self):
'''
Sets the owner of this ApiKeyInfoReq.
The owner of this API key.
:param owner: The owner of this ApiKeyInfoReq.
:type: str
'''
pass
@property
def status(self):
'''
Gets the status of this ApiKeyInfoReq.
The status of the API key.
:return: The status of this ApiKeyInfoReq.
:rtype: str
'''
pass
@status.setter
def status(self):
'''
Sets the status of this ApiKeyInfoReq.
The status of the API key.
:param status: The status of this ApiKeyInfoReq.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 23 | 15 | 10 | 1 | 4 | 5 | 2 | 0.95 | 1 | 4 | 0 | 0 | 14 | 5 | 14 | 14 | 191 | 33 | 81 | 34 | 58 | 77 | 50 | 26 | 35 | 5 | 1 | 2 | 21 |
2,417 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/account_update_root_req.py
|
mbed_cloud._backends.iam.models.account_update_root_req.AccountUpdateRootReq
|
class AccountUpdateRootReq(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'address_line1': 'str',
'address_line2': 'str',
'aliases': 'list[str]',
'city': 'str',
'company': 'str',
'contact': 'str',
'contract_number': 'str',
'country': 'str',
'custom_fields': 'dict(str, str)',
'customer_number': 'str',
'display_name': 'str',
'email': 'str',
'end_market': 'str',
'expiration_warning_threshold': 'str',
'idle_timeout': 'str',
'mfa_status': 'str',
'notification_emails': 'list[str]',
'password_policy': 'PasswordPolicy',
'phone_number': 'str',
'postal_code': 'str',
'sales_contact': 'str',
'state': 'str'
}
attribute_map = {
'address_line1': 'address_line1',
'address_line2': 'address_line2',
'aliases': 'aliases',
'city': 'city',
'company': 'company',
'contact': 'contact',
'contract_number': 'contract_number',
'country': 'country',
'custom_fields': 'custom_fields',
'customer_number': 'customer_number',
'display_name': 'display_name',
'email': 'email',
'end_market': 'end_market',
'expiration_warning_threshold': 'expiration_warning_threshold',
'idle_timeout': 'idle_timeout',
'mfa_status': 'mfa_status',
'notification_emails': 'notification_emails',
'password_policy': 'password_policy',
'phone_number': 'phone_number',
'postal_code': 'postal_code',
'sales_contact': 'sales_contact',
'state': 'state'
}
def __init__(self, address_line1=None, address_line2=None, aliases=None, city=None, company=None, contact=None, contract_number=None, country=None, custom_fields=None, customer_number=None, display_name=None, email=None, end_market=None, expiration_warning_threshold=None, idle_timeout=None, mfa_status=None, notification_emails=None, password_policy=None, phone_number=None, postal_code=None, sales_contact=None, state=None):
"""
AccountUpdateRootReq - a model defined in Swagger
"""
self._address_line1 = address_line1
self._address_line2 = address_line2
self._aliases = aliases
self._city = city
self._company = company
self._contact = contact
self._contract_number = contract_number
self._country = country
self._custom_fields = custom_fields
self._customer_number = customer_number
self._display_name = display_name
self._email = email
self._end_market = end_market
self._expiration_warning_threshold = expiration_warning_threshold
self._idle_timeout = idle_timeout
self._mfa_status = mfa_status
self._notification_emails = notification_emails
self._password_policy = password_policy
self._phone_number = phone_number
self._postal_code = postal_code
self._sales_contact = sales_contact
self._state = state
self.discriminator = None
@property
def address_line1(self):
"""
Gets the address_line1 of this AccountUpdateRootReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:return: The address_line1 of this AccountUpdateRootReq.
:rtype: str
"""
return self._address_line1
@address_line1.setter
def address_line1(self, address_line1):
"""
Sets the address_line1 of this AccountUpdateRootReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:param address_line1: The address_line1 of this AccountUpdateRootReq.
:type: str
"""
self._address_line1 = address_line1
@property
def address_line2(self):
"""
Gets the address_line2 of this AccountUpdateRootReq.
Postal address line 2, not longer than 100 characters.
:return: The address_line2 of this AccountUpdateRootReq.
:rtype: str
"""
return self._address_line2
@address_line2.setter
def address_line2(self, address_line2):
"""
Sets the address_line2 of this AccountUpdateRootReq.
Postal address line 2, not longer than 100 characters.
:param address_line2: The address_line2 of this AccountUpdateRootReq.
:type: str
"""
self._address_line2 = address_line2
@property
def aliases(self):
"""
Gets the aliases of this AccountUpdateRootReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:return: The aliases of this AccountUpdateRootReq.
:rtype: list[str]
"""
return self._aliases
@aliases.setter
def aliases(self, aliases):
"""
Sets the aliases of this AccountUpdateRootReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:param aliases: The aliases of this AccountUpdateRootReq.
:type: list[str]
"""
self._aliases = aliases
@property
def city(self):
"""
Gets the city of this AccountUpdateRootReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The city of this AccountUpdateRootReq.
:rtype: str
"""
return self._city
@city.setter
def city(self, city):
"""
Sets the city of this AccountUpdateRootReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param city: The city of this AccountUpdateRootReq.
:type: str
"""
self._city = city
@property
def company(self):
"""
Gets the company of this AccountUpdateRootReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:return: The company of this AccountUpdateRootReq.
:rtype: str
"""
return self._company
@company.setter
def company(self, company):
"""
Sets the company of this AccountUpdateRootReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:param company: The company of this AccountUpdateRootReq.
:type: str
"""
self._company = company
@property
def contact(self):
"""
Gets the contact of this AccountUpdateRootReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:return: The contact of this AccountUpdateRootReq.
:rtype: str
"""
return self._contact
@contact.setter
def contact(self, contact):
"""
Sets the contact of this AccountUpdateRootReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:param contact: The contact of this AccountUpdateRootReq.
:type: str
"""
self._contact = contact
@property
def contract_number(self):
"""
Gets the contract_number of this AccountUpdateRootReq.
Contract number of the customer.
:return: The contract_number of this AccountUpdateRootReq.
:rtype: str
"""
return self._contract_number
@contract_number.setter
def contract_number(self, contract_number):
"""
Sets the contract_number of this AccountUpdateRootReq.
Contract number of the customer.
:param contract_number: The contract_number of this AccountUpdateRootReq.
:type: str
"""
self._contract_number = contract_number
@property
def country(self):
"""
Gets the country of this AccountUpdateRootReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The country of this AccountUpdateRootReq.
:rtype: str
"""
return self._country
@country.setter
def country(self, country):
"""
Sets the country of this AccountUpdateRootReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param country: The country of this AccountUpdateRootReq.
:type: str
"""
self._country = country
@property
def custom_fields(self):
"""
Gets the custom_fields of this AccountUpdateRootReq.
Account's custom properties as key-value pairs, with a maximum of 10 keys. The maximum length of a key is 100 characters. The values are handled as strings and the maximum length for a value is 1000 characters.
:return: The custom_fields of this AccountUpdateRootReq.
:rtype: dict(str, str)
"""
return self._custom_fields
@custom_fields.setter
def custom_fields(self, custom_fields):
"""
Sets the custom_fields of this AccountUpdateRootReq.
Account's custom properties as key-value pairs, with a maximum of 10 keys. The maximum length of a key is 100 characters. The values are handled as strings and the maximum length for a value is 1000 characters.
:param custom_fields: The custom_fields of this AccountUpdateRootReq.
:type: dict(str, str)
"""
self._custom_fields = custom_fields
@property
def customer_number(self):
"""
Gets the customer_number of this AccountUpdateRootReq.
Customer number of the customer.
:return: The customer_number of this AccountUpdateRootReq.
:rtype: str
"""
return self._customer_number
@customer_number.setter
def customer_number(self, customer_number):
"""
Sets the customer_number of this AccountUpdateRootReq.
Customer number of the customer.
:param customer_number: The customer_number of this AccountUpdateRootReq.
:type: str
"""
self._customer_number = customer_number
@property
def display_name(self):
"""
Gets the display_name of this AccountUpdateRootReq.
The display name for the account, not longer than 100 characters.
:return: The display_name of this AccountUpdateRootReq.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this AccountUpdateRootReq.
The display name for the account, not longer than 100 characters.
:param display_name: The display_name of this AccountUpdateRootReq.
:type: str
"""
self._display_name = display_name
@property
def email(self):
"""
Gets the email of this AccountUpdateRootReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:return: The email of this AccountUpdateRootReq.
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""
Sets the email of this AccountUpdateRootReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:param email: The email of this AccountUpdateRootReq.
:type: str
"""
self._email = email
@property
def end_market(self):
"""
Gets the end_market of this AccountUpdateRootReq.
The end market for this account, not longer than 100 characters.
:return: The end_market of this AccountUpdateRootReq.
:rtype: str
"""
return self._end_market
@end_market.setter
def end_market(self, end_market):
"""
Sets the end_market of this AccountUpdateRootReq.
The end market for this account, not longer than 100 characters.
:param end_market: The end_market of this AccountUpdateRootReq.
:type: str
"""
self._end_market = end_market
@property
def expiration_warning_threshold(self):
"""
Gets the expiration_warning_threshold of this AccountUpdateRootReq.
Indicates how many days before account expiration a notification email should be sent. Valid values are: 1-180.
:return: The expiration_warning_threshold of this AccountUpdateRootReq.
:rtype: str
"""
return self._expiration_warning_threshold
@expiration_warning_threshold.setter
def expiration_warning_threshold(self, expiration_warning_threshold):
"""
Sets the expiration_warning_threshold of this AccountUpdateRootReq.
Indicates how many days before account expiration a notification email should be sent. Valid values are: 1-180.
:param expiration_warning_threshold: The expiration_warning_threshold of this AccountUpdateRootReq.
:type: str
"""
self._expiration_warning_threshold = expiration_warning_threshold
@property
def idle_timeout(self):
"""
Gets the idle_timeout of this AccountUpdateRootReq.
The reference token expiration time in minutes for this account. Between 1 and 120 minutes.
:return: The idle_timeout of this AccountUpdateRootReq.
:rtype: str
"""
return self._idle_timeout
@idle_timeout.setter
def idle_timeout(self, idle_timeout):
"""
Sets the idle_timeout of this AccountUpdateRootReq.
The reference token expiration time in minutes for this account. Between 1 and 120 minutes.
:param idle_timeout: The idle_timeout of this AccountUpdateRootReq.
:type: str
"""
self._idle_timeout = idle_timeout
@property
def mfa_status(self):
"""
Gets the mfa_status of this AccountUpdateRootReq.
The enforcement status of setting up the multi-factor authentication. 'Enforced' means that setting up the MFA is required after login. 'Optional' means that the MFA is not required.
:return: The mfa_status of this AccountUpdateRootReq.
:rtype: str
"""
return self._mfa_status
@mfa_status.setter
def mfa_status(self, mfa_status):
"""
Sets the mfa_status of this AccountUpdateRootReq.
The enforcement status of setting up the multi-factor authentication. 'Enforced' means that setting up the MFA is required after login. 'Optional' means that the MFA is not required.
:param mfa_status: The mfa_status of this AccountUpdateRootReq.
:type: str
"""
allowed_values = ["enforced", "optional"]
if mfa_status not in allowed_values:
raise ValueError(
"Invalid value for `mfa_status` ({0}), must be one of {1}"
.format(mfa_status, allowed_values)
)
self._mfa_status = mfa_status
@property
def notification_emails(self):
"""
Gets the notification_emails of this AccountUpdateRootReq.
A list of notification email addresses.
:return: The notification_emails of this AccountUpdateRootReq.
:rtype: list[str]
"""
return self._notification_emails
@notification_emails.setter
def notification_emails(self, notification_emails):
"""
Sets the notification_emails of this AccountUpdateRootReq.
A list of notification email addresses.
:param notification_emails: The notification_emails of this AccountUpdateRootReq.
:type: list[str]
"""
self._notification_emails = notification_emails
@property
def password_policy(self):
"""
Gets the password_policy of this AccountUpdateRootReq.
Password policy for this account.
:return: The password_policy of this AccountUpdateRootReq.
:rtype: PasswordPolicy
"""
return self._password_policy
@password_policy.setter
def password_policy(self, password_policy):
"""
Sets the password_policy of this AccountUpdateRootReq.
Password policy for this account.
:param password_policy: The password_policy of this AccountUpdateRootReq.
:type: PasswordPolicy
"""
self._password_policy = password_policy
@property
def phone_number(self):
"""
Gets the phone_number of this AccountUpdateRootReq.
The phone number of a representative of the company, not longer than 100 characters.
:return: The phone_number of this AccountUpdateRootReq.
:rtype: str
"""
return self._phone_number
@phone_number.setter
def phone_number(self, phone_number):
"""
Sets the phone_number of this AccountUpdateRootReq.
The phone number of a representative of the company, not longer than 100 characters.
:param phone_number: The phone_number of this AccountUpdateRootReq.
:type: str
"""
self._phone_number = phone_number
@property
def postal_code(self):
"""
Gets the postal_code of this AccountUpdateRootReq.
The postal code part of the postal address, not longer than 100 characters.
:return: The postal_code of this AccountUpdateRootReq.
:rtype: str
"""
return self._postal_code
@postal_code.setter
def postal_code(self, postal_code):
"""
Sets the postal_code of this AccountUpdateRootReq.
The postal code part of the postal address, not longer than 100 characters.
:param postal_code: The postal_code of this AccountUpdateRootReq.
:type: str
"""
self._postal_code = postal_code
@property
def sales_contact(self):
"""
Gets the sales_contact of this AccountUpdateRootReq.
Email address of the sales contact.
:return: The sales_contact of this AccountUpdateRootReq.
:rtype: str
"""
return self._sales_contact
@sales_contact.setter
def sales_contact(self, sales_contact):
"""
Sets the sales_contact of this AccountUpdateRootReq.
Email address of the sales contact.
:param sales_contact: The sales_contact of this AccountUpdateRootReq.
:type: str
"""
self._sales_contact = sales_contact
@property
def state(self):
"""
Gets the state of this AccountUpdateRootReq.
The state part of the postal address, not longer than 100 characters.
:return: The state of this AccountUpdateRootReq.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this AccountUpdateRootReq.
The state part of the postal address, not longer than 100 characters.
:param state: The state of this AccountUpdateRootReq.
:type: str
"""
self._state = state
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, AccountUpdateRootReq):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class AccountUpdateRootReq(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, address_line1=None, address_line2=None, aliases=None, city=None, company=None, contact=None, contract_number=None, country=None, custom_fields=None, customer_number=None, display_name=None, email=None, end_market=None, expiration_warning_threshold=None, idle_timeout=None, mfa_status=None, notification_emails=None, password_policy=None, phone_number=None, postal_code=None, sales_contact=None, state=None):
'''
AccountUpdateRootReq - a model defined in Swagger
'''
pass
@property
def address_line1(self):
'''
Gets the address_line1 of this AccountUpdateRootReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:return: The address_line1 of this AccountUpdateRootReq.
:rtype: str
'''
pass
@address_line1.setter
def address_line1(self):
'''
Sets the address_line1 of this AccountUpdateRootReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:param address_line1: The address_line1 of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def address_line2(self):
'''
Gets the address_line2 of this AccountUpdateRootReq.
Postal address line 2, not longer than 100 characters.
:return: The address_line2 of this AccountUpdateRootReq.
:rtype: str
'''
pass
@address_line2.setter
def address_line2(self):
'''
Sets the address_line2 of this AccountUpdateRootReq.
Postal address line 2, not longer than 100 characters.
:param address_line2: The address_line2 of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def aliases(self):
'''
Gets the aliases of this AccountUpdateRootReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:return: The aliases of this AccountUpdateRootReq.
:rtype: list[str]
'''
pass
@aliases.setter
def aliases(self):
'''
Sets the aliases of this AccountUpdateRootReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:param aliases: The aliases of this AccountUpdateRootReq.
:type: list[str]
'''
pass
@property
def city(self):
'''
Gets the city of this AccountUpdateRootReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The city of this AccountUpdateRootReq.
:rtype: str
'''
pass
@city.setter
def city(self):
'''
Sets the city of this AccountUpdateRootReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param city: The city of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def company(self):
'''
Gets the company of this AccountUpdateRootReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:return: The company of this AccountUpdateRootReq.
:rtype: str
'''
pass
@company.setter
def company(self):
'''
Sets the company of this AccountUpdateRootReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:param company: The company of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def contact(self):
'''
Gets the contact of this AccountUpdateRootReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:return: The contact of this AccountUpdateRootReq.
:rtype: str
'''
pass
@contact.setter
def contact(self):
'''
Sets the contact of this AccountUpdateRootReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:param contact: The contact of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def contract_number(self):
'''
Gets the contract_number of this AccountUpdateRootReq.
Contract number of the customer.
:return: The contract_number of this AccountUpdateRootReq.
:rtype: str
'''
pass
@contract_number.setter
def contract_number(self):
'''
Sets the contract_number of this AccountUpdateRootReq.
Contract number of the customer.
:param contract_number: The contract_number of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def country(self):
'''
Gets the country of this AccountUpdateRootReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The country of this AccountUpdateRootReq.
:rtype: str
'''
pass
@country.setter
def country(self):
'''
Sets the country of this AccountUpdateRootReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param country: The country of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def custom_fields(self):
'''
Gets the custom_fields of this AccountUpdateRootReq.
Account's custom properties as key-value pairs, with a maximum of 10 keys. The maximum length of a key is 100 characters. The values are handled as strings and the maximum length for a value is 1000 characters.
:return: The custom_fields of this AccountUpdateRootReq.
:rtype: dict(str, str)
'''
pass
@custom_fields.setter
def custom_fields(self):
'''
Sets the custom_fields of this AccountUpdateRootReq.
Account's custom properties as key-value pairs, with a maximum of 10 keys. The maximum length of a key is 100 characters. The values are handled as strings and the maximum length for a value is 1000 characters.
:param custom_fields: The custom_fields of this AccountUpdateRootReq.
:type: dict(str, str)
'''
pass
@property
def customer_number(self):
'''
Gets the customer_number of this AccountUpdateRootReq.
Customer number of the customer.
:return: The customer_number of this AccountUpdateRootReq.
:rtype: str
'''
pass
@customer_number.setter
def customer_number(self):
'''
Sets the customer_number of this AccountUpdateRootReq.
Customer number of the customer.
:param customer_number: The customer_number of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def display_name(self):
'''
Gets the display_name of this AccountUpdateRootReq.
The display name for the account, not longer than 100 characters.
:return: The display_name of this AccountUpdateRootReq.
:rtype: str
'''
pass
@display_name.setter
def display_name(self):
'''
Sets the display_name of this AccountUpdateRootReq.
The display name for the account, not longer than 100 characters.
:param display_name: The display_name of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def email(self):
'''
Gets the email of this AccountUpdateRootReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:return: The email of this AccountUpdateRootReq.
:rtype: str
'''
pass
@email.setter
def email(self):
'''
Sets the email of this AccountUpdateRootReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:param email: The email of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def end_market(self):
'''
Gets the end_market of this AccountUpdateRootReq.
The end market for this account, not longer than 100 characters.
:return: The end_market of this AccountUpdateRootReq.
:rtype: str
'''
pass
@end_market.setter
def end_market(self):
'''
Sets the end_market of this AccountUpdateRootReq.
The end market for this account, not longer than 100 characters.
:param end_market: The end_market of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def expiration_warning_threshold(self):
'''
Gets the expiration_warning_threshold of this AccountUpdateRootReq.
Indicates how many days before account expiration a notification email should be sent. Valid values are: 1-180.
:return: The expiration_warning_threshold of this AccountUpdateRootReq.
:rtype: str
'''
pass
@expiration_warning_threshold.setter
def expiration_warning_threshold(self):
'''
Sets the expiration_warning_threshold of this AccountUpdateRootReq.
Indicates how many days before account expiration a notification email should be sent. Valid values are: 1-180.
:param expiration_warning_threshold: The expiration_warning_threshold of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def idle_timeout(self):
'''
Gets the idle_timeout of this AccountUpdateRootReq.
The reference token expiration time in minutes for this account. Between 1 and 120 minutes.
:return: The idle_timeout of this AccountUpdateRootReq.
:rtype: str
'''
pass
@idle_timeout.setter
def idle_timeout(self):
'''
Sets the idle_timeout of this AccountUpdateRootReq.
The reference token expiration time in minutes for this account. Between 1 and 120 minutes.
:param idle_timeout: The idle_timeout of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def mfa_status(self):
'''
Gets the mfa_status of this AccountUpdateRootReq.
The enforcement status of setting up the multi-factor authentication. 'Enforced' means that setting up the MFA is required after login. 'Optional' means that the MFA is not required.
:return: The mfa_status of this AccountUpdateRootReq.
:rtype: str
'''
pass
@mfa_status.setter
def mfa_status(self):
'''
Sets the mfa_status of this AccountUpdateRootReq.
The enforcement status of setting up the multi-factor authentication. 'Enforced' means that setting up the MFA is required after login. 'Optional' means that the MFA is not required.
:param mfa_status: The mfa_status of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def notification_emails(self):
'''
Gets the notification_emails of this AccountUpdateRootReq.
A list of notification email addresses.
:return: The notification_emails of this AccountUpdateRootReq.
:rtype: list[str]
'''
pass
@notification_emails.setter
def notification_emails(self):
'''
Sets the notification_emails of this AccountUpdateRootReq.
A list of notification email addresses.
:param notification_emails: The notification_emails of this AccountUpdateRootReq.
:type: list[str]
'''
pass
@property
def password_policy(self):
'''
Gets the password_policy of this AccountUpdateRootReq.
Password policy for this account.
:return: The password_policy of this AccountUpdateRootReq.
:rtype: PasswordPolicy
'''
pass
@password_policy.setter
def password_policy(self):
'''
Sets the password_policy of this AccountUpdateRootReq.
Password policy for this account.
:param password_policy: The password_policy of this AccountUpdateRootReq.
:type: PasswordPolicy
'''
pass
@property
def phone_number(self):
'''
Gets the phone_number of this AccountUpdateRootReq.
The phone number of a representative of the company, not longer than 100 characters.
:return: The phone_number of this AccountUpdateRootReq.
:rtype: str
'''
pass
@phone_number.setter
def phone_number(self):
'''
Sets the phone_number of this AccountUpdateRootReq.
The phone number of a representative of the company, not longer than 100 characters.
:param phone_number: The phone_number of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def postal_code(self):
'''
Gets the postal_code of this AccountUpdateRootReq.
The postal code part of the postal address, not longer than 100 characters.
:return: The postal_code of this AccountUpdateRootReq.
:rtype: str
'''
pass
@postal_code.setter
def postal_code(self):
'''
Sets the postal_code of this AccountUpdateRootReq.
The postal code part of the postal address, not longer than 100 characters.
:param postal_code: The postal_code of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def sales_contact(self):
'''
Gets the sales_contact of this AccountUpdateRootReq.
Email address of the sales contact.
:return: The sales_contact of this AccountUpdateRootReq.
:rtype: str
'''
pass
@sales_contact.setter
def sales_contact(self):
'''
Sets the sales_contact of this AccountUpdateRootReq.
Email address of the sales contact.
:param sales_contact: The sales_contact of this AccountUpdateRootReq.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this AccountUpdateRootReq.
The state part of the postal address, not longer than 100 characters.
:return: The state of this AccountUpdateRootReq.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this AccountUpdateRootReq.
The state part of the postal address, not longer than 100 characters.
:param state: The state of this AccountUpdateRootReq.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 95 | 51 | 10 | 1 | 3 | 6 | 1 | 1.22 | 1 | 4 | 0 | 0 | 50 | 23 | 50 | 50 | 657 | 123 | 241 | 124 | 146 | 293 | 138 | 80 | 87 | 5 | 1 | 2 | 56 |
2,418 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/account_update_req.py
|
mbed_cloud._backends.iam.models.account_update_req.AccountUpdateReq
|
class AccountUpdateReq(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'address_line1': 'str',
'address_line2': 'str',
'aliases': 'list[str]',
'city': 'str',
'company': 'str',
'contact': 'str',
'country': 'str',
'custom_fields': 'dict(str, str)',
'display_name': 'str',
'email': 'str',
'end_market': 'str',
'expiration_warning_threshold': 'str',
'idle_timeout': 'str',
'mfa_status': 'str',
'notification_emails': 'list[str]',
'password_policy': 'PasswordPolicy',
'phone_number': 'str',
'postal_code': 'str',
'state': 'str'
}
attribute_map = {
'address_line1': 'address_line1',
'address_line2': 'address_line2',
'aliases': 'aliases',
'city': 'city',
'company': 'company',
'contact': 'contact',
'country': 'country',
'custom_fields': 'custom_fields',
'display_name': 'display_name',
'email': 'email',
'end_market': 'end_market',
'expiration_warning_threshold': 'expiration_warning_threshold',
'idle_timeout': 'idle_timeout',
'mfa_status': 'mfa_status',
'notification_emails': 'notification_emails',
'password_policy': 'password_policy',
'phone_number': 'phone_number',
'postal_code': 'postal_code',
'state': 'state'
}
def __init__(self, address_line1=None, address_line2=None, aliases=None, city=None, company=None, contact=None, country=None, custom_fields=None, display_name=None, email=None, end_market=None, expiration_warning_threshold=None, idle_timeout=None, mfa_status=None, notification_emails=None, password_policy=None, phone_number=None, postal_code=None, state=None):
"""
AccountUpdateReq - a model defined in Swagger
"""
self._address_line1 = address_line1
self._address_line2 = address_line2
self._aliases = aliases
self._city = city
self._company = company
self._contact = contact
self._country = country
self._custom_fields = custom_fields
self._display_name = display_name
self._email = email
self._end_market = end_market
self._expiration_warning_threshold = expiration_warning_threshold
self._idle_timeout = idle_timeout
self._mfa_status = mfa_status
self._notification_emails = notification_emails
self._password_policy = password_policy
self._phone_number = phone_number
self._postal_code = postal_code
self._state = state
self.discriminator = None
@property
def address_line1(self):
"""
Gets the address_line1 of this AccountUpdateReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:return: The address_line1 of this AccountUpdateReq.
:rtype: str
"""
return self._address_line1
@address_line1.setter
def address_line1(self, address_line1):
"""
Sets the address_line1 of this AccountUpdateReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:param address_line1: The address_line1 of this AccountUpdateReq.
:type: str
"""
self._address_line1 = address_line1
@property
def address_line2(self):
"""
Gets the address_line2 of this AccountUpdateReq.
Postal address line 2, not longer than 100 characters.
:return: The address_line2 of this AccountUpdateReq.
:rtype: str
"""
return self._address_line2
@address_line2.setter
def address_line2(self, address_line2):
"""
Sets the address_line2 of this AccountUpdateReq.
Postal address line 2, not longer than 100 characters.
:param address_line2: The address_line2 of this AccountUpdateReq.
:type: str
"""
self._address_line2 = address_line2
@property
def aliases(self):
"""
Gets the aliases of this AccountUpdateReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:return: The aliases of this AccountUpdateReq.
:rtype: list[str]
"""
return self._aliases
@aliases.setter
def aliases(self, aliases):
"""
Sets the aliases of this AccountUpdateReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:param aliases: The aliases of this AccountUpdateReq.
:type: list[str]
"""
self._aliases = aliases
@property
def city(self):
"""
Gets the city of this AccountUpdateReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The city of this AccountUpdateReq.
:rtype: str
"""
return self._city
@city.setter
def city(self, city):
"""
Sets the city of this AccountUpdateReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param city: The city of this AccountUpdateReq.
:type: str
"""
self._city = city
@property
def company(self):
"""
Gets the company of this AccountUpdateReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:return: The company of this AccountUpdateReq.
:rtype: str
"""
return self._company
@company.setter
def company(self, company):
"""
Sets the company of this AccountUpdateReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:param company: The company of this AccountUpdateReq.
:type: str
"""
self._company = company
@property
def contact(self):
"""
Gets the contact of this AccountUpdateReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:return: The contact of this AccountUpdateReq.
:rtype: str
"""
return self._contact
@contact.setter
def contact(self, contact):
"""
Sets the contact of this AccountUpdateReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:param contact: The contact of this AccountUpdateReq.
:type: str
"""
self._contact = contact
@property
def country(self):
"""
Gets the country of this AccountUpdateReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The country of this AccountUpdateReq.
:rtype: str
"""
return self._country
@country.setter
def country(self, country):
"""
Sets the country of this AccountUpdateReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param country: The country of this AccountUpdateReq.
:type: str
"""
self._country = country
@property
def custom_fields(self):
"""
Gets the custom_fields of this AccountUpdateReq.
Account's custom properties as key-value pairs, with a maximum of 10 keys. The maximum length of a key is 100 characters. The values are handled as strings and the maximum length for a value is 1000 characters.
:return: The custom_fields of this AccountUpdateReq.
:rtype: dict(str, str)
"""
return self._custom_fields
@custom_fields.setter
def custom_fields(self, custom_fields):
"""
Sets the custom_fields of this AccountUpdateReq.
Account's custom properties as key-value pairs, with a maximum of 10 keys. The maximum length of a key is 100 characters. The values are handled as strings and the maximum length for a value is 1000 characters.
:param custom_fields: The custom_fields of this AccountUpdateReq.
:type: dict(str, str)
"""
self._custom_fields = custom_fields
@property
def display_name(self):
"""
Gets the display_name of this AccountUpdateReq.
The display name for the account, not longer than 100 characters.
:return: The display_name of this AccountUpdateReq.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this AccountUpdateReq.
The display name for the account, not longer than 100 characters.
:param display_name: The display_name of this AccountUpdateReq.
:type: str
"""
self._display_name = display_name
@property
def email(self):
"""
Gets the email of this AccountUpdateReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:return: The email of this AccountUpdateReq.
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""
Sets the email of this AccountUpdateReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:param email: The email of this AccountUpdateReq.
:type: str
"""
self._email = email
@property
def end_market(self):
"""
Gets the end_market of this AccountUpdateReq.
The end market for this account, not longer than 100 characters.
:return: The end_market of this AccountUpdateReq.
:rtype: str
"""
return self._end_market
@end_market.setter
def end_market(self, end_market):
"""
Sets the end_market of this AccountUpdateReq.
The end market for this account, not longer than 100 characters.
:param end_market: The end_market of this AccountUpdateReq.
:type: str
"""
self._end_market = end_market
@property
def expiration_warning_threshold(self):
"""
Gets the expiration_warning_threshold of this AccountUpdateReq.
Indicates how many days before account expiration a notification email should be sent. Valid values are: 1-180.
:return: The expiration_warning_threshold of this AccountUpdateReq.
:rtype: str
"""
return self._expiration_warning_threshold
@expiration_warning_threshold.setter
def expiration_warning_threshold(self, expiration_warning_threshold):
"""
Sets the expiration_warning_threshold of this AccountUpdateReq.
Indicates how many days before account expiration a notification email should be sent. Valid values are: 1-180.
:param expiration_warning_threshold: The expiration_warning_threshold of this AccountUpdateReq.
:type: str
"""
self._expiration_warning_threshold = expiration_warning_threshold
@property
def idle_timeout(self):
"""
Gets the idle_timeout of this AccountUpdateReq.
The reference token expiration time in minutes for this account. Between 1 and 120 minutes.
:return: The idle_timeout of this AccountUpdateReq.
:rtype: str
"""
return self._idle_timeout
@idle_timeout.setter
def idle_timeout(self, idle_timeout):
"""
Sets the idle_timeout of this AccountUpdateReq.
The reference token expiration time in minutes for this account. Between 1 and 120 minutes.
:param idle_timeout: The idle_timeout of this AccountUpdateReq.
:type: str
"""
self._idle_timeout = idle_timeout
@property
def mfa_status(self):
"""
Gets the mfa_status of this AccountUpdateReq.
The enforcement status of setting up the multi-factor authentication. 'Enforced' means that setting up the MFA is required after login. 'Optional' means that the MFA is not required.
:return: The mfa_status of this AccountUpdateReq.
:rtype: str
"""
return self._mfa_status
@mfa_status.setter
def mfa_status(self, mfa_status):
"""
Sets the mfa_status of this AccountUpdateReq.
The enforcement status of setting up the multi-factor authentication. 'Enforced' means that setting up the MFA is required after login. 'Optional' means that the MFA is not required.
:param mfa_status: The mfa_status of this AccountUpdateReq.
:type: str
"""
allowed_values = ["enforced", "optional"]
if mfa_status not in allowed_values:
raise ValueError(
"Invalid value for `mfa_status` ({0}), must be one of {1}"
.format(mfa_status, allowed_values)
)
self._mfa_status = mfa_status
@property
def notification_emails(self):
"""
Gets the notification_emails of this AccountUpdateReq.
A list of notification email addresses.
:return: The notification_emails of this AccountUpdateReq.
:rtype: list[str]
"""
return self._notification_emails
@notification_emails.setter
def notification_emails(self, notification_emails):
"""
Sets the notification_emails of this AccountUpdateReq.
A list of notification email addresses.
:param notification_emails: The notification_emails of this AccountUpdateReq.
:type: list[str]
"""
self._notification_emails = notification_emails
@property
def password_policy(self):
"""
Gets the password_policy of this AccountUpdateReq.
Password policy for this account.
:return: The password_policy of this AccountUpdateReq.
:rtype: PasswordPolicy
"""
return self._password_policy
@password_policy.setter
def password_policy(self, password_policy):
"""
Sets the password_policy of this AccountUpdateReq.
Password policy for this account.
:param password_policy: The password_policy of this AccountUpdateReq.
:type: PasswordPolicy
"""
self._password_policy = password_policy
@property
def phone_number(self):
"""
Gets the phone_number of this AccountUpdateReq.
The phone number of a representative of the company, not longer than 100 characters.
:return: The phone_number of this AccountUpdateReq.
:rtype: str
"""
return self._phone_number
@phone_number.setter
def phone_number(self, phone_number):
"""
Sets the phone_number of this AccountUpdateReq.
The phone number of a representative of the company, not longer than 100 characters.
:param phone_number: The phone_number of this AccountUpdateReq.
:type: str
"""
self._phone_number = phone_number
@property
def postal_code(self):
"""
Gets the postal_code of this AccountUpdateReq.
The postal code part of the postal address, not longer than 100 characters.
:return: The postal_code of this AccountUpdateReq.
:rtype: str
"""
return self._postal_code
@postal_code.setter
def postal_code(self, postal_code):
"""
Sets the postal_code of this AccountUpdateReq.
The postal code part of the postal address, not longer than 100 characters.
:param postal_code: The postal_code of this AccountUpdateReq.
:type: str
"""
self._postal_code = postal_code
@property
def state(self):
"""
Gets the state of this AccountUpdateReq.
The state part of the postal address, not longer than 100 characters.
:return: The state of this AccountUpdateReq.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this AccountUpdateReq.
The state part of the postal address, not longer than 100 characters.
:param state: The state of this AccountUpdateReq.
:type: str
"""
self._state = state
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, AccountUpdateReq):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class AccountUpdateReq(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, address_line1=None, address_line2=None, aliases=None, city=None, company=None, contact=None, country=None, custom_fields=None, display_name=None, email=None, end_market=None, expiration_warning_threshold=None, idle_timeout=None, mfa_status=None, notification_emails=None, password_policy=None, phone_number=None, postal_code=None, state=None):
'''
AccountUpdateReq - a model defined in Swagger
'''
pass
@property
def address_line1(self):
'''
Gets the address_line1 of this AccountUpdateReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:return: The address_line1 of this AccountUpdateReq.
:rtype: str
'''
pass
@address_line1.setter
def address_line1(self):
'''
Sets the address_line1 of this AccountUpdateReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:param address_line1: The address_line1 of this AccountUpdateReq.
:type: str
'''
pass
@property
def address_line2(self):
'''
Gets the address_line2 of this AccountUpdateReq.
Postal address line 2, not longer than 100 characters.
:return: The address_line2 of this AccountUpdateReq.
:rtype: str
'''
pass
@address_line2.setter
def address_line2(self):
'''
Sets the address_line2 of this AccountUpdateReq.
Postal address line 2, not longer than 100 characters.
:param address_line2: The address_line2 of this AccountUpdateReq.
:type: str
'''
pass
@property
def aliases(self):
'''
Gets the aliases of this AccountUpdateReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:return: The aliases of this AccountUpdateReq.
:rtype: list[str]
'''
pass
@aliases.setter
def aliases(self):
'''
Sets the aliases of this AccountUpdateReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:param aliases: The aliases of this AccountUpdateReq.
:type: list[str]
'''
pass
@property
def city(self):
'''
Gets the city of this AccountUpdateReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The city of this AccountUpdateReq.
:rtype: str
'''
pass
@city.setter
def city(self):
'''
Sets the city of this AccountUpdateReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param city: The city of this AccountUpdateReq.
:type: str
'''
pass
@property
def company(self):
'''
Gets the company of this AccountUpdateReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:return: The company of this AccountUpdateReq.
:rtype: str
'''
pass
@company.setter
def company(self):
'''
Sets the company of this AccountUpdateReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:param company: The company of this AccountUpdateReq.
:type: str
'''
pass
@property
def contact(self):
'''
Gets the contact of this AccountUpdateReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:return: The contact of this AccountUpdateReq.
:rtype: str
'''
pass
@contact.setter
def contact(self):
'''
Sets the contact of this AccountUpdateReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:param contact: The contact of this AccountUpdateReq.
:type: str
'''
pass
@property
def country(self):
'''
Gets the country of this AccountUpdateReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The country of this AccountUpdateReq.
:rtype: str
'''
pass
@country.setter
def country(self):
'''
Sets the country of this AccountUpdateReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param country: The country of this AccountUpdateReq.
:type: str
'''
pass
@property
def custom_fields(self):
'''
Gets the custom_fields of this AccountUpdateReq.
Account's custom properties as key-value pairs, with a maximum of 10 keys. The maximum length of a key is 100 characters. The values are handled as strings and the maximum length for a value is 1000 characters.
:return: The custom_fields of this AccountUpdateReq.
:rtype: dict(str, str)
'''
pass
@custom_fields.setter
def custom_fields(self):
'''
Sets the custom_fields of this AccountUpdateReq.
Account's custom properties as key-value pairs, with a maximum of 10 keys. The maximum length of a key is 100 characters. The values are handled as strings and the maximum length for a value is 1000 characters.
:param custom_fields: The custom_fields of this AccountUpdateReq.
:type: dict(str, str)
'''
pass
@property
def display_name(self):
'''
Gets the display_name of this AccountUpdateReq.
The display name for the account, not longer than 100 characters.
:return: The display_name of this AccountUpdateReq.
:rtype: str
'''
pass
@display_name.setter
def display_name(self):
'''
Sets the display_name of this AccountUpdateReq.
The display name for the account, not longer than 100 characters.
:param display_name: The display_name of this AccountUpdateReq.
:type: str
'''
pass
@property
def email(self):
'''
Gets the email of this AccountUpdateReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:return: The email of this AccountUpdateReq.
:rtype: str
'''
pass
@email.setter
def email(self):
'''
Sets the email of this AccountUpdateReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:param email: The email of this AccountUpdateReq.
:type: str
'''
pass
@property
def end_market(self):
'''
Gets the end_market of this AccountUpdateReq.
The end market for this account, not longer than 100 characters.
:return: The end_market of this AccountUpdateReq.
:rtype: str
'''
pass
@end_market.setter
def end_market(self):
'''
Sets the end_market of this AccountUpdateReq.
The end market for this account, not longer than 100 characters.
:param end_market: The end_market of this AccountUpdateReq.
:type: str
'''
pass
@property
def expiration_warning_threshold(self):
'''
Gets the expiration_warning_threshold of this AccountUpdateReq.
Indicates how many days before account expiration a notification email should be sent. Valid values are: 1-180.
:return: The expiration_warning_threshold of this AccountUpdateReq.
:rtype: str
'''
pass
@expiration_warning_threshold.setter
def expiration_warning_threshold(self):
'''
Sets the expiration_warning_threshold of this AccountUpdateReq.
Indicates how many days before account expiration a notification email should be sent. Valid values are: 1-180.
:param expiration_warning_threshold: The expiration_warning_threshold of this AccountUpdateReq.
:type: str
'''
pass
@property
def idle_timeout(self):
'''
Gets the idle_timeout of this AccountUpdateReq.
The reference token expiration time in minutes for this account. Between 1 and 120 minutes.
:return: The idle_timeout of this AccountUpdateReq.
:rtype: str
'''
pass
@idle_timeout.setter
def idle_timeout(self):
'''
Sets the idle_timeout of this AccountUpdateReq.
The reference token expiration time in minutes for this account. Between 1 and 120 minutes.
:param idle_timeout: The idle_timeout of this AccountUpdateReq.
:type: str
'''
pass
@property
def mfa_status(self):
'''
Gets the mfa_status of this AccountUpdateReq.
The enforcement status of setting up the multi-factor authentication. 'Enforced' means that setting up the MFA is required after login. 'Optional' means that the MFA is not required.
:return: The mfa_status of this AccountUpdateReq.
:rtype: str
'''
pass
@mfa_status.setter
def mfa_status(self):
'''
Sets the mfa_status of this AccountUpdateReq.
The enforcement status of setting up the multi-factor authentication. 'Enforced' means that setting up the MFA is required after login. 'Optional' means that the MFA is not required.
:param mfa_status: The mfa_status of this AccountUpdateReq.
:type: str
'''
pass
@property
def notification_emails(self):
'''
Gets the notification_emails of this AccountUpdateReq.
A list of notification email addresses.
:return: The notification_emails of this AccountUpdateReq.
:rtype: list[str]
'''
pass
@notification_emails.setter
def notification_emails(self):
'''
Sets the notification_emails of this AccountUpdateReq.
A list of notification email addresses.
:param notification_emails: The notification_emails of this AccountUpdateReq.
:type: list[str]
'''
pass
@property
def password_policy(self):
'''
Gets the password_policy of this AccountUpdateReq.
Password policy for this account.
:return: The password_policy of this AccountUpdateReq.
:rtype: PasswordPolicy
'''
pass
@password_policy.setter
def password_policy(self):
'''
Sets the password_policy of this AccountUpdateReq.
Password policy for this account.
:param password_policy: The password_policy of this AccountUpdateReq.
:type: PasswordPolicy
'''
pass
@property
def phone_number(self):
'''
Gets the phone_number of this AccountUpdateReq.
The phone number of a representative of the company, not longer than 100 characters.
:return: The phone_number of this AccountUpdateReq.
:rtype: str
'''
pass
@phone_number.setter
def phone_number(self):
'''
Sets the phone_number of this AccountUpdateReq.
The phone number of a representative of the company, not longer than 100 characters.
:param phone_number: The phone_number of this AccountUpdateReq.
:type: str
'''
pass
@property
def postal_code(self):
'''
Gets the postal_code of this AccountUpdateReq.
The postal code part of the postal address, not longer than 100 characters.
:return: The postal_code of this AccountUpdateReq.
:rtype: str
'''
pass
@postal_code.setter
def postal_code(self):
'''
Sets the postal_code of this AccountUpdateReq.
The postal code part of the postal address, not longer than 100 characters.
:param postal_code: The postal_code of this AccountUpdateReq.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this AccountUpdateReq.
The state part of the postal address, not longer than 100 characters.
:return: The state of this AccountUpdateReq.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this AccountUpdateReq.
The state part of the postal address, not longer than 100 characters.
:param state: The state of this AccountUpdateReq.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 83 | 45 | 10 | 1 | 3 | 6 | 1 | 1.2 | 1 | 4 | 0 | 0 | 44 | 20 | 44 | 44 | 579 | 108 | 214 | 109 | 131 | 257 | 123 | 71 | 78 | 5 | 1 | 2 | 50 |
2,419 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/account_info_list.py
|
mbed_cloud._backends.iam.models.account_info_list.AccountInfoList
|
class AccountInfoList(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 = {
'after': 'str',
'data': 'list[AccountInfo]',
'has_more': 'bool',
'limit': 'int',
'object': 'str',
'order': 'str',
'total_count': 'int'
}
attribute_map = {
'after': 'after',
'data': 'data',
'has_more': 'has_more',
'limit': 'limit',
'object': 'object',
'order': 'order',
'total_count': 'total_count'
}
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
"""
AccountInfoList - a model defined in Swagger
"""
self._after = after
self._data = data
self._has_more = has_more
self._limit = limit
self._object = object
self._order = order
self._total_count = total_count
self.discriminator = None
@property
def after(self):
"""
Gets the after of this AccountInfoList.
The entity ID to fetch after the given one.
:return: The after of this AccountInfoList.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this AccountInfoList.
The entity ID to fetch after the given one.
:param after: The after of this AccountInfoList.
:type: str
"""
self._after = after
@property
def data(self):
"""
Gets the data of this AccountInfoList.
A list of entities.
:return: The data of this AccountInfoList.
:rtype: list[AccountInfo]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this AccountInfoList.
A list of entities.
:param data: The data of this AccountInfoList.
:type: list[AccountInfo]
"""
if data is None:
raise ValueError("Invalid value for `data`, must not be `None`")
self._data = data
@property
def has_more(self):
"""
Gets the has_more of this AccountInfoList.
Flag indicating whether there is more results.
:return: The has_more of this AccountInfoList.
:rtype: bool
"""
return self._has_more
@has_more.setter
def has_more(self, has_more):
"""
Sets the has_more of this AccountInfoList.
Flag indicating whether there is more results.
:param has_more: The has_more of this AccountInfoList.
:type: bool
"""
if has_more is None:
raise ValueError("Invalid value for `has_more`, must not be `None`")
self._has_more = has_more
@property
def limit(self):
"""
Gets the limit of this AccountInfoList.
The number of results to return, (range: 2-1000), or equals to `total_count`
:return: The limit of this AccountInfoList.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this AccountInfoList.
The number of results to return, (range: 2-1000), or equals to `total_count`
:param limit: The limit of this AccountInfoList.
:type: int
"""
if limit is None:
raise ValueError("Invalid value for `limit`, must not be `None`")
self._limit = limit
@property
def object(self):
"""
Gets the object of this AccountInfoList.
Entity name: always 'list'
:return: The object of this AccountInfoList.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this AccountInfoList.
Entity name: always 'list'
:param object: The object of this AccountInfoList.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["list"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def order(self):
"""
Gets the order of this AccountInfoList.
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
:return: The order of this AccountInfoList.
:rtype: str
"""
return self._order
@order.setter
def order(self, order):
"""
Sets the order of this AccountInfoList.
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
:param order: The order of this AccountInfoList.
:type: str
"""
allowed_values = ["ASC", "DESC"]
if order not in allowed_values:
raise ValueError(
"Invalid value for `order` ({0}), must be one of {1}"
.format(order, allowed_values)
)
self._order = order
@property
def total_count(self):
"""
Gets the total_count of this AccountInfoList.
The total number or records, if requested. It might be returned also for small lists.
:return: The total_count of this AccountInfoList.
:rtype: int
"""
return self._total_count
@total_count.setter
def total_count(self, total_count):
"""
Sets the total_count of this AccountInfoList.
The total number or records, if requested. It might be returned also for small lists.
:param total_count: The total_count of this AccountInfoList.
:type: int
"""
if total_count is None:
raise ValueError("Invalid value for `total_count`, must not be `None`")
self._total_count = total_count
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, AccountInfoList):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class AccountInfoList(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
'''
AccountInfoList - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this AccountInfoList.
The entity ID to fetch after the given one.
:return: The after of this AccountInfoList.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this AccountInfoList.
The entity ID to fetch after the given one.
:param after: The after of this AccountInfoList.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this AccountInfoList.
A list of entities.
:return: The data of this AccountInfoList.
:rtype: list[AccountInfo]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this AccountInfoList.
A list of entities.
:param data: The data of this AccountInfoList.
:type: list[AccountInfo]
'''
pass
@property
def has_more(self):
'''
Gets the has_more of this AccountInfoList.
Flag indicating whether there is more results.
:return: The has_more of this AccountInfoList.
:rtype: bool
'''
pass
@has_more.setter
def has_more(self):
'''
Sets the has_more of this AccountInfoList.
Flag indicating whether there is more results.
:param has_more: The has_more of this AccountInfoList.
:type: bool
'''
pass
@property
def limit(self):
'''
Gets the limit of this AccountInfoList.
The number of results to return, (range: 2-1000), or equals to `total_count`
:return: The limit of this AccountInfoList.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this AccountInfoList.
The number of results to return, (range: 2-1000), or equals to `total_count`
:param limit: The limit of this AccountInfoList.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this AccountInfoList.
Entity name: always 'list'
:return: The object of this AccountInfoList.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this AccountInfoList.
Entity name: always 'list'
:param object: The object of this AccountInfoList.
:type: str
'''
pass
@property
def order(self):
'''
Gets the order of this AccountInfoList.
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
:return: The order of this AccountInfoList.
:rtype: str
'''
pass
@order.setter
def order(self):
'''
Sets the order of this AccountInfoList.
The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.
:param order: The order of this AccountInfoList.
:type: str
'''
pass
@property
def total_count(self):
'''
Gets the total_count of this AccountInfoList.
The total number or records, if requested. It might be returned also for small lists.
:return: The total_count of this AccountInfoList.
:rtype: int
'''
pass
@total_count.setter
def total_count(self):
'''
Sets the total_count of this AccountInfoList.
The total number or records, if requested. It might be returned also for small lists.
:param total_count: The total_count of this AccountInfoList.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 35 | 21 | 11 | 1 | 4 | 5 | 2 | 0.93 | 1 | 4 | 0 | 0 | 20 | 8 | 20 | 20 | 283 | 48 | 122 | 50 | 87 | 113 | 76 | 36 | 55 | 5 | 1 | 2 | 32 |
2,420 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/account_info.py
|
mbed_cloud._backends.iam.models.account_info.AccountInfo
|
class AccountInfo(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'address_line1': 'str',
'address_line2': 'str',
'aliases': 'list[str]',
'city': 'str',
'company': 'str',
'contact': 'str',
'contract_number': 'str',
'country': 'str',
'created_at': 'datetime',
'custom_fields': 'dict(str, str)',
'customer_number': 'str',
'display_name': 'str',
'email': 'str',
'end_market': 'str',
'etag': 'str',
'expiration_warning_threshold': 'str',
'id': 'str',
'idle_timeout': 'str',
'limits': 'dict(str, str)',
'mfa_status': 'str',
'notification_emails': 'list[str]',
'object': 'str',
'parent_id': 'str',
'password_policy': 'PasswordPolicy',
'phone_number': 'str',
'policies': 'list[FeaturePolicy]',
'postal_code': 'str',
'reason': 'str',
'reference_note': 'str',
'sales_contact': 'str',
'state': 'str',
'status': 'str',
'sub_accounts': 'list[AccountInfo]',
'template_id': 'str',
'tier': 'str',
'updated_at': 'datetime',
'upgraded_at': 'datetime'
}
attribute_map = {
'address_line1': 'address_line1',
'address_line2': 'address_line2',
'aliases': 'aliases',
'city': 'city',
'company': 'company',
'contact': 'contact',
'contract_number': 'contract_number',
'country': 'country',
'created_at': 'created_at',
'custom_fields': 'custom_fields',
'customer_number': 'customer_number',
'display_name': 'display_name',
'email': 'email',
'end_market': 'end_market',
'etag': 'etag',
'expiration_warning_threshold': 'expiration_warning_threshold',
'id': 'id',
'idle_timeout': 'idle_timeout',
'limits': 'limits',
'mfa_status': 'mfa_status',
'notification_emails': 'notification_emails',
'object': 'object',
'parent_id': 'parent_id',
'password_policy': 'password_policy',
'phone_number': 'phone_number',
'policies': 'policies',
'postal_code': 'postal_code',
'reason': 'reason',
'reference_note': 'reference_note',
'sales_contact': 'sales_contact',
'state': 'state',
'status': 'status',
'sub_accounts': 'sub_accounts',
'template_id': 'template_id',
'tier': 'tier',
'updated_at': 'updated_at',
'upgraded_at': 'upgraded_at'
}
def __init__(self, address_line1=None, address_line2=None, aliases=None, city=None, company=None, contact=None, contract_number=None, country=None, created_at=None, custom_fields=None, customer_number=None, display_name=None, email=None, end_market=None, etag=None, expiration_warning_threshold=None, id=None, idle_timeout=None, limits=None, mfa_status=None, notification_emails=None, object=None, parent_id=None, password_policy=None, phone_number=None, policies=None, postal_code=None, reason=None, reference_note=None, sales_contact=None, state=None, status=None, sub_accounts=None, template_id=None, tier=None, updated_at=None, upgraded_at=None):
"""
AccountInfo - a model defined in Swagger
"""
self._address_line1 = address_line1
self._address_line2 = address_line2
self._aliases = aliases
self._city = city
self._company = company
self._contact = contact
self._contract_number = contract_number
self._country = country
self._created_at = created_at
self._custom_fields = custom_fields
self._customer_number = customer_number
self._display_name = display_name
self._email = email
self._end_market = end_market
self._etag = etag
self._expiration_warning_threshold = expiration_warning_threshold
self._id = id
self._idle_timeout = idle_timeout
self._limits = limits
self._mfa_status = mfa_status
self._notification_emails = notification_emails
self._object = object
self._parent_id = parent_id
self._password_policy = password_policy
self._phone_number = phone_number
self._policies = policies
self._postal_code = postal_code
self._reason = reason
self._reference_note = reference_note
self._sales_contact = sales_contact
self._state = state
self._status = status
self._sub_accounts = sub_accounts
self._template_id = template_id
self._tier = tier
self._updated_at = updated_at
self._upgraded_at = upgraded_at
self.discriminator = None
@property
def address_line1(self):
"""
Gets the address_line1 of this AccountInfo.
Postal address line 1.
:return: The address_line1 of this AccountInfo.
:rtype: str
"""
return self._address_line1
@address_line1.setter
def address_line1(self, address_line1):
"""
Sets the address_line1 of this AccountInfo.
Postal address line 1.
:param address_line1: The address_line1 of this AccountInfo.
:type: str
"""
self._address_line1 = address_line1
@property
def address_line2(self):
"""
Gets the address_line2 of this AccountInfo.
Postal address line 2.
:return: The address_line2 of this AccountInfo.
:rtype: str
"""
return self._address_line2
@address_line2.setter
def address_line2(self, address_line2):
"""
Sets the address_line2 of this AccountInfo.
Postal address line 2.
:param address_line2: The address_line2 of this AccountInfo.
:type: str
"""
self._address_line2 = address_line2
@property
def aliases(self):
"""
Gets the aliases of this AccountInfo.
An array of aliases.
:return: The aliases of this AccountInfo.
:rtype: list[str]
"""
return self._aliases
@aliases.setter
def aliases(self, aliases):
"""
Sets the aliases of this AccountInfo.
An array of aliases.
:param aliases: The aliases of this AccountInfo.
:type: list[str]
"""
if aliases is None:
raise ValueError("Invalid value for `aliases`, must not be `None`")
self._aliases = aliases
@property
def city(self):
"""
Gets the city of this AccountInfo.
The city part of the postal address.
:return: The city of this AccountInfo.
:rtype: str
"""
return self._city
@city.setter
def city(self, city):
"""
Sets the city of this AccountInfo.
The city part of the postal address.
:param city: The city of this AccountInfo.
:type: str
"""
self._city = city
@property
def company(self):
"""
Gets the company of this AccountInfo.
The name of the company.
:return: The company of this AccountInfo.
:rtype: str
"""
return self._company
@company.setter
def company(self, company):
"""
Sets the company of this AccountInfo.
The name of the company.
:param company: The company of this AccountInfo.
:type: str
"""
self._company = company
@property
def contact(self):
"""
Gets the contact of this AccountInfo.
The name of the contact person for this account.
:return: The contact of this AccountInfo.
:rtype: str
"""
return self._contact
@contact.setter
def contact(self, contact):
"""
Sets the contact of this AccountInfo.
The name of the contact person for this account.
:param contact: The contact of this AccountInfo.
:type: str
"""
self._contact = contact
@property
def contract_number(self):
"""
Gets the contract_number of this AccountInfo.
Contract number of the customer.
:return: The contract_number of this AccountInfo.
:rtype: str
"""
return self._contract_number
@contract_number.setter
def contract_number(self, contract_number):
"""
Sets the contract_number of this AccountInfo.
Contract number of the customer.
:param contract_number: The contract_number of this AccountInfo.
:type: str
"""
self._contract_number = contract_number
@property
def country(self):
"""
Gets the country of this AccountInfo.
The country part of the postal address.
:return: The country of this AccountInfo.
:rtype: str
"""
return self._country
@country.setter
def country(self, country):
"""
Sets the country of this AccountInfo.
The country part of the postal address.
:param country: The country of this AccountInfo.
:type: str
"""
self._country = country
@property
def created_at(self):
"""
Gets the created_at of this AccountInfo.
Creation UTC time RFC3339.
:return: The created_at of this AccountInfo.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this AccountInfo.
Creation UTC time RFC3339.
:param created_at: The created_at of this AccountInfo.
:type: datetime
"""
self._created_at = created_at
@property
def custom_fields(self):
"""
Gets the custom_fields of this AccountInfo.
Account's custom properties as key-value pairs.
:return: The custom_fields of this AccountInfo.
:rtype: dict(str, str)
"""
return self._custom_fields
@custom_fields.setter
def custom_fields(self, custom_fields):
"""
Sets the custom_fields of this AccountInfo.
Account's custom properties as key-value pairs.
:param custom_fields: The custom_fields of this AccountInfo.
:type: dict(str, str)
"""
self._custom_fields = custom_fields
@property
def customer_number(self):
"""
Gets the customer_number of this AccountInfo.
Customer number of the customer.
:return: The customer_number of this AccountInfo.
:rtype: str
"""
return self._customer_number
@customer_number.setter
def customer_number(self, customer_number):
"""
Sets the customer_number of this AccountInfo.
Customer number of the customer.
:param customer_number: The customer_number of this AccountInfo.
:type: str
"""
self._customer_number = customer_number
@property
def display_name(self):
"""
Gets the display_name of this AccountInfo.
The display name for the account.
:return: The display_name of this AccountInfo.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this AccountInfo.
The display name for the account.
:param display_name: The display_name of this AccountInfo.
:type: str
"""
self._display_name = display_name
@property
def email(self):
"""
Gets the email of this AccountInfo.
The company email address for this account.
:return: The email of this AccountInfo.
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""
Sets the email of this AccountInfo.
The company email address for this account.
:param email: The email of this AccountInfo.
:type: str
"""
self._email = email
@property
def end_market(self):
"""
Gets the end_market of this AccountInfo.
Account end market.
:return: The end_market of this AccountInfo.
:rtype: str
"""
return self._end_market
@end_market.setter
def end_market(self, end_market):
"""
Sets the end_market of this AccountInfo.
Account end market.
:param end_market: The end_market of this AccountInfo.
:type: str
"""
if end_market is None:
raise ValueError("Invalid value for `end_market`, must not be `None`")
self._end_market = end_market
@property
def etag(self):
"""
Gets the etag of this AccountInfo.
API resource entity version.
:return: The etag of this AccountInfo.
:rtype: str
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this AccountInfo.
API resource entity version.
:param etag: The etag of this AccountInfo.
:type: str
"""
if etag is None:
raise ValueError("Invalid value for `etag`, must not be `None`")
self._etag = etag
@property
def expiration_warning_threshold(self):
"""
Gets the expiration_warning_threshold of this AccountInfo.
Indicates how many days (1-180) before account expiration a notification email should be sent.
:return: The expiration_warning_threshold of this AccountInfo.
:rtype: str
"""
return self._expiration_warning_threshold
@expiration_warning_threshold.setter
def expiration_warning_threshold(self, expiration_warning_threshold):
"""
Sets the expiration_warning_threshold of this AccountInfo.
Indicates how many days (1-180) before account expiration a notification email should be sent.
:param expiration_warning_threshold: The expiration_warning_threshold of this AccountInfo.
:type: str
"""
self._expiration_warning_threshold = expiration_warning_threshold
@property
def id(self):
"""
Gets the id of this AccountInfo.
Account ID.
:return: The id of this AccountInfo.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this AccountInfo.
Account ID.
:param id: The id of this AccountInfo.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def idle_timeout(self):
"""
Gets the idle_timeout of this AccountInfo.
The reference token expiration time in minutes for this account.
:return: The idle_timeout of this AccountInfo.
:rtype: str
"""
return self._idle_timeout
@idle_timeout.setter
def idle_timeout(self, idle_timeout):
"""
Sets the idle_timeout of this AccountInfo.
The reference token expiration time in minutes for this account.
:param idle_timeout: The idle_timeout of this AccountInfo.
:type: str
"""
self._idle_timeout = idle_timeout
@property
def limits(self):
"""
Gets the limits of this AccountInfo.
List of limits as key-value pairs if requested.
:return: The limits of this AccountInfo.
:rtype: dict(str, str)
"""
return self._limits
@limits.setter
def limits(self, limits):
"""
Sets the limits of this AccountInfo.
List of limits as key-value pairs if requested.
:param limits: The limits of this AccountInfo.
:type: dict(str, str)
"""
self._limits = limits
@property
def mfa_status(self):
"""
Gets the mfa_status of this AccountInfo.
The enforcement status of the multi-factor authentication, either 'enforced' or 'optional'.
:return: The mfa_status of this AccountInfo.
:rtype: str
"""
return self._mfa_status
@mfa_status.setter
def mfa_status(self, mfa_status):
"""
Sets the mfa_status of this AccountInfo.
The enforcement status of the multi-factor authentication, either 'enforced' or 'optional'.
:param mfa_status: The mfa_status of this AccountInfo.
:type: str
"""
allowed_values = ["enforced", "optional"]
if mfa_status not in allowed_values:
raise ValueError(
"Invalid value for `mfa_status` ({0}), must be one of {1}"
.format(mfa_status, allowed_values)
)
self._mfa_status = mfa_status
@property
def notification_emails(self):
"""
Gets the notification_emails of this AccountInfo.
A list of notification email addresses.
:return: The notification_emails of this AccountInfo.
:rtype: list[str]
"""
return self._notification_emails
@notification_emails.setter
def notification_emails(self, notification_emails):
"""
Sets the notification_emails of this AccountInfo.
A list of notification email addresses.
:param notification_emails: The notification_emails of this AccountInfo.
:type: list[str]
"""
self._notification_emails = notification_emails
@property
def object(self):
"""
Gets the object of this AccountInfo.
Entity name: always 'account'
:return: The object of this AccountInfo.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this AccountInfo.
Entity name: always 'account'
:param object: The object of this AccountInfo.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["account"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def parent_id(self):
"""
Gets the parent_id of this AccountInfo.
The ID of the parent account, if it has any.
:return: The parent_id of this AccountInfo.
:rtype: str
"""
return self._parent_id
@parent_id.setter
def parent_id(self, parent_id):
"""
Sets the parent_id of this AccountInfo.
The ID of the parent account, if it has any.
:param parent_id: The parent_id of this AccountInfo.
:type: str
"""
self._parent_id = parent_id
@property
def password_policy(self):
"""
Gets the password_policy of this AccountInfo.
The password policy for this account.
:return: The password_policy of this AccountInfo.
:rtype: PasswordPolicy
"""
return self._password_policy
@password_policy.setter
def password_policy(self, password_policy):
"""
Sets the password_policy of this AccountInfo.
The password policy for this account.
:param password_policy: The password_policy of this AccountInfo.
:type: PasswordPolicy
"""
self._password_policy = password_policy
@property
def phone_number(self):
"""
Gets the phone_number of this AccountInfo.
The phone number of a representative of the company.
:return: The phone_number of this AccountInfo.
:rtype: str
"""
return self._phone_number
@phone_number.setter
def phone_number(self, phone_number):
"""
Sets the phone_number of this AccountInfo.
The phone number of a representative of the company.
:param phone_number: The phone_number of this AccountInfo.
:type: str
"""
self._phone_number = phone_number
@property
def policies(self):
"""
Gets the policies of this AccountInfo.
List of policies if requested.
:return: The policies of this AccountInfo.
:rtype: list[FeaturePolicy]
"""
return self._policies
@policies.setter
def policies(self, policies):
"""
Sets the policies of this AccountInfo.
List of policies if requested.
:param policies: The policies of this AccountInfo.
:type: list[FeaturePolicy]
"""
self._policies = policies
@property
def postal_code(self):
"""
Gets the postal_code of this AccountInfo.
The postal code part of the postal address.
:return: The postal_code of this AccountInfo.
:rtype: str
"""
return self._postal_code
@postal_code.setter
def postal_code(self, postal_code):
"""
Sets the postal_code of this AccountInfo.
The postal code part of the postal address.
:param postal_code: The postal_code of this AccountInfo.
:type: str
"""
self._postal_code = postal_code
@property
def reason(self):
"""
Gets the reason of this AccountInfo.
A reason note for updating the status of the account
:return: The reason of this AccountInfo.
:rtype: str
"""
return self._reason
@reason.setter
def reason(self, reason):
"""
Sets the reason of this AccountInfo.
A reason note for updating the status of the account
:param reason: The reason of this AccountInfo.
:type: str
"""
self._reason = reason
@property
def reference_note(self):
"""
Gets the reference_note of this AccountInfo.
A reference note for updating the status of the account
:return: The reference_note of this AccountInfo.
:rtype: str
"""
return self._reference_note
@reference_note.setter
def reference_note(self, reference_note):
"""
Sets the reference_note of this AccountInfo.
A reference note for updating the status of the account
:param reference_note: The reference_note of this AccountInfo.
:type: str
"""
self._reference_note = reference_note
@property
def sales_contact(self):
"""
Gets the sales_contact of this AccountInfo.
Email address of the sales contact.
:return: The sales_contact of this AccountInfo.
:rtype: str
"""
return self._sales_contact
@sales_contact.setter
def sales_contact(self, sales_contact):
"""
Sets the sales_contact of this AccountInfo.
Email address of the sales contact.
:param sales_contact: The sales_contact of this AccountInfo.
:type: str
"""
self._sales_contact = sales_contact
@property
def state(self):
"""
Gets the state of this AccountInfo.
The state part of the postal address.
:return: The state of this AccountInfo.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this AccountInfo.
The state part of the postal address.
:param state: The state of this AccountInfo.
:type: str
"""
self._state = state
@property
def status(self):
"""
Gets the status of this AccountInfo.
The status of the account.
:return: The status of this AccountInfo.
:rtype: str
"""
return self._status
@status.setter
def status(self, status):
"""
Sets the status of this AccountInfo.
The status of the account.
:param status: The status of this AccountInfo.
:type: str
"""
if status is None:
raise ValueError("Invalid value for `status`, must not be `None`")
allowed_values = ["ENROLLING", "ACTIVE", "RESTRICTED", "SUSPENDED"]
if status not in allowed_values:
raise ValueError(
"Invalid value for `status` ({0}), must be one of {1}"
.format(status, allowed_values)
)
self._status = status
@property
def sub_accounts(self):
"""
Gets the sub_accounts of this AccountInfo.
List of sub accounts. Not available for developer users.
:return: The sub_accounts of this AccountInfo.
:rtype: list[AccountInfo]
"""
return self._sub_accounts
@sub_accounts.setter
def sub_accounts(self, sub_accounts):
"""
Sets the sub_accounts of this AccountInfo.
List of sub accounts. Not available for developer users.
:param sub_accounts: The sub_accounts of this AccountInfo.
:type: list[AccountInfo]
"""
self._sub_accounts = sub_accounts
@property
def template_id(self):
"""
Gets the template_id of this AccountInfo.
Account template ID.
:return: The template_id of this AccountInfo.
:rtype: str
"""
return self._template_id
@template_id.setter
def template_id(self, template_id):
"""
Sets the template_id of this AccountInfo.
Account template ID.
:param template_id: The template_id of this AccountInfo.
:type: str
"""
self._template_id = template_id
@property
def tier(self):
"""
Gets the tier of this AccountInfo.
The tier level of the account; '0': free tier, '1': commercial account, '2': partner tier. Other values are reserved for the future.
:return: The tier of this AccountInfo.
:rtype: str
"""
return self._tier
@tier.setter
def tier(self, tier):
"""
Sets the tier of this AccountInfo.
The tier level of the account; '0': free tier, '1': commercial account, '2': partner tier. Other values are reserved for the future.
:param tier: The tier of this AccountInfo.
:type: str
"""
if tier is None:
raise ValueError("Invalid value for `tier`, must not be `None`")
self._tier = tier
@property
def updated_at(self):
"""
Gets the updated_at of this AccountInfo.
Last update UTC time RFC3339.
:return: The updated_at of this AccountInfo.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this AccountInfo.
Last update UTC time RFC3339.
:param updated_at: The updated_at of this AccountInfo.
:type: datetime
"""
self._updated_at = updated_at
@property
def upgraded_at(self):
"""
Gets the upgraded_at of this AccountInfo.
Time when upgraded to commercial account in UTC format RFC3339.
:return: The upgraded_at of this AccountInfo.
:rtype: datetime
"""
return self._upgraded_at
@upgraded_at.setter
def upgraded_at(self, upgraded_at):
"""
Sets the upgraded_at of this AccountInfo.
Time when upgraded to commercial account in UTC format RFC3339.
:param upgraded_at: The upgraded_at of this AccountInfo.
:type: datetime
"""
self._upgraded_at = upgraded_at
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, AccountInfo):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class AccountInfo(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, address_line1=None, address_line2=None, aliases=None, city=None, company=None, contact=None, contract_number=None, country=None, created_at=None, custom_fields=None, customer_number=None, display_name=None, email=None, end_market=None, etag=None, expiration_warning_threshold=None, id=None, idle_timeout=None, limits=None, mfa_status=None, notification_emails=None, object=None, parent_id=None, password_policy=None, phone_number=None, policies=None, postal_code=None, reason=None, reference_note=None, sales_contact=None, state=None, status=None, sub_accounts=None, template_id=None, tier=None, updated_at=None, upgraded_at=None):
'''
AccountInfo - a model defined in Swagger
'''
pass
@property
def address_line1(self):
'''
Gets the address_line1 of this AccountInfo.
Postal address line 1.
:return: The address_line1 of this AccountInfo.
:rtype: str
'''
pass
@address_line1.setter
def address_line1(self):
'''
Sets the address_line1 of this AccountInfo.
Postal address line 1.
:param address_line1: The address_line1 of this AccountInfo.
:type: str
'''
pass
@property
def address_line2(self):
'''
Gets the address_line2 of this AccountInfo.
Postal address line 2.
:return: The address_line2 of this AccountInfo.
:rtype: str
'''
pass
@address_line2.setter
def address_line2(self):
'''
Sets the address_line2 of this AccountInfo.
Postal address line 2.
:param address_line2: The address_line2 of this AccountInfo.
:type: str
'''
pass
@property
def aliases(self):
'''
Gets the aliases of this AccountInfo.
An array of aliases.
:return: The aliases of this AccountInfo.
:rtype: list[str]
'''
pass
@aliases.setter
def aliases(self):
'''
Sets the aliases of this AccountInfo.
An array of aliases.
:param aliases: The aliases of this AccountInfo.
:type: list[str]
'''
pass
@property
def city(self):
'''
Gets the city of this AccountInfo.
The city part of the postal address.
:return: The city of this AccountInfo.
:rtype: str
'''
pass
@city.setter
def city(self):
'''
Sets the city of this AccountInfo.
The city part of the postal address.
:param city: The city of this AccountInfo.
:type: str
'''
pass
@property
def company(self):
'''
Gets the company of this AccountInfo.
The name of the company.
:return: The company of this AccountInfo.
:rtype: str
'''
pass
@company.setter
def company(self):
'''
Sets the company of this AccountInfo.
The name of the company.
:param company: The company of this AccountInfo.
:type: str
'''
pass
@property
def contact(self):
'''
Gets the contact of this AccountInfo.
The name of the contact person for this account.
:return: The contact of this AccountInfo.
:rtype: str
'''
pass
@contact.setter
def contact(self):
'''
Sets the contact of this AccountInfo.
The name of the contact person for this account.
:param contact: The contact of this AccountInfo.
:type: str
'''
pass
@property
def contract_number(self):
'''
Gets the contract_number of this AccountInfo.
Contract number of the customer.
:return: The contract_number of this AccountInfo.
:rtype: str
'''
pass
@contract_number.setter
def contract_number(self):
'''
Sets the contract_number of this AccountInfo.
Contract number of the customer.
:param contract_number: The contract_number of this AccountInfo.
:type: str
'''
pass
@property
def country(self):
'''
Gets the country of this AccountInfo.
The country part of the postal address.
:return: The country of this AccountInfo.
:rtype: str
'''
pass
@country.setter
def country(self):
'''
Sets the country of this AccountInfo.
The country part of the postal address.
:param country: The country of this AccountInfo.
:type: str
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this AccountInfo.
Creation UTC time RFC3339.
:return: The created_at of this AccountInfo.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this AccountInfo.
Creation UTC time RFC3339.
:param created_at: The created_at of this AccountInfo.
:type: datetime
'''
pass
@property
def custom_fields(self):
'''
Gets the custom_fields of this AccountInfo.
Account's custom properties as key-value pairs.
:return: The custom_fields of this AccountInfo.
:rtype: dict(str, str)
'''
pass
@custom_fields.setter
def custom_fields(self):
'''
Sets the custom_fields of this AccountInfo.
Account's custom properties as key-value pairs.
:param custom_fields: The custom_fields of this AccountInfo.
:type: dict(str, str)
'''
pass
@property
def customer_number(self):
'''
Gets the customer_number of this AccountInfo.
Customer number of the customer.
:return: The customer_number of this AccountInfo.
:rtype: str
'''
pass
@customer_number.setter
def customer_number(self):
'''
Sets the customer_number of this AccountInfo.
Customer number of the customer.
:param customer_number: The customer_number of this AccountInfo.
:type: str
'''
pass
@property
def display_name(self):
'''
Gets the display_name of this AccountInfo.
The display name for the account.
:return: The display_name of this AccountInfo.
:rtype: str
'''
pass
@display_name.setter
def display_name(self):
'''
Sets the display_name of this AccountInfo.
The display name for the account.
:param display_name: The display_name of this AccountInfo.
:type: str
'''
pass
@property
def email(self):
'''
Gets the email of this AccountInfo.
The company email address for this account.
:return: The email of this AccountInfo.
:rtype: str
'''
pass
@email.setter
def email(self):
'''
Sets the email of this AccountInfo.
The company email address for this account.
:param email: The email of this AccountInfo.
:type: str
'''
pass
@property
def end_market(self):
'''
Gets the end_market of this AccountInfo.
Account end market.
:return: The end_market of this AccountInfo.
:rtype: str
'''
pass
@end_market.setter
def end_market(self):
'''
Sets the end_market of this AccountInfo.
Account end market.
:param end_market: The end_market of this AccountInfo.
:type: str
'''
pass
@property
def etag(self):
'''
Gets the etag of this AccountInfo.
API resource entity version.
:return: The etag of this AccountInfo.
:rtype: str
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this AccountInfo.
API resource entity version.
:param etag: The etag of this AccountInfo.
:type: str
'''
pass
@property
def expiration_warning_threshold(self):
'''
Gets the expiration_warning_threshold of this AccountInfo.
Indicates how many days (1-180) before account expiration a notification email should be sent.
:return: The expiration_warning_threshold of this AccountInfo.
:rtype: str
'''
pass
@expiration_warning_threshold.setter
def expiration_warning_threshold(self):
'''
Sets the expiration_warning_threshold of this AccountInfo.
Indicates how many days (1-180) before account expiration a notification email should be sent.
:param expiration_warning_threshold: The expiration_warning_threshold of this AccountInfo.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this AccountInfo.
Account ID.
:return: The id of this AccountInfo.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this AccountInfo.
Account ID.
:param id: The id of this AccountInfo.
:type: str
'''
pass
@property
def idle_timeout(self):
'''
Gets the idle_timeout of this AccountInfo.
The reference token expiration time in minutes for this account.
:return: The idle_timeout of this AccountInfo.
:rtype: str
'''
pass
@idle_timeout.setter
def idle_timeout(self):
'''
Sets the idle_timeout of this AccountInfo.
The reference token expiration time in minutes for this account.
:param idle_timeout: The idle_timeout of this AccountInfo.
:type: str
'''
pass
@property
def limits(self):
'''
Gets the limits of this AccountInfo.
List of limits as key-value pairs if requested.
:return: The limits of this AccountInfo.
:rtype: dict(str, str)
'''
pass
@limits.setter
def limits(self):
'''
Sets the limits of this AccountInfo.
List of limits as key-value pairs if requested.
:param limits: The limits of this AccountInfo.
:type: dict(str, str)
'''
pass
@property
def mfa_status(self):
'''
Gets the mfa_status of this AccountInfo.
The enforcement status of the multi-factor authentication, either 'enforced' or 'optional'.
:return: The mfa_status of this AccountInfo.
:rtype: str
'''
pass
@mfa_status.setter
def mfa_status(self):
'''
Sets the mfa_status of this AccountInfo.
The enforcement status of the multi-factor authentication, either 'enforced' or 'optional'.
:param mfa_status: The mfa_status of this AccountInfo.
:type: str
'''
pass
@property
def notification_emails(self):
'''
Gets the notification_emails of this AccountInfo.
A list of notification email addresses.
:return: The notification_emails of this AccountInfo.
:rtype: list[str]
'''
pass
@notification_emails.setter
def notification_emails(self):
'''
Sets the notification_emails of this AccountInfo.
A list of notification email addresses.
:param notification_emails: The notification_emails of this AccountInfo.
:type: list[str]
'''
pass
@property
def object(self):
'''
Gets the object of this AccountInfo.
Entity name: always 'account'
:return: The object of this AccountInfo.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this AccountInfo.
Entity name: always 'account'
:param object: The object of this AccountInfo.
:type: str
'''
pass
@property
def parent_id(self):
'''
Gets the parent_id of this AccountInfo.
The ID of the parent account, if it has any.
:return: The parent_id of this AccountInfo.
:rtype: str
'''
pass
@parent_id.setter
def parent_id(self):
'''
Sets the parent_id of this AccountInfo.
The ID of the parent account, if it has any.
:param parent_id: The parent_id of this AccountInfo.
:type: str
'''
pass
@property
def password_policy(self):
'''
Gets the password_policy of this AccountInfo.
The password policy for this account.
:return: The password_policy of this AccountInfo.
:rtype: PasswordPolicy
'''
pass
@password_policy.setter
def password_policy(self):
'''
Sets the password_policy of this AccountInfo.
The password policy for this account.
:param password_policy: The password_policy of this AccountInfo.
:type: PasswordPolicy
'''
pass
@property
def phone_number(self):
'''
Gets the phone_number of this AccountInfo.
The phone number of a representative of the company.
:return: The phone_number of this AccountInfo.
:rtype: str
'''
pass
@phone_number.setter
def phone_number(self):
'''
Sets the phone_number of this AccountInfo.
The phone number of a representative of the company.
:param phone_number: The phone_number of this AccountInfo.
:type: str
'''
pass
@property
def policies(self):
'''
Gets the policies of this AccountInfo.
List of policies if requested.
:return: The policies of this AccountInfo.
:rtype: list[FeaturePolicy]
'''
pass
@policies.setter
def policies(self):
'''
Sets the policies of this AccountInfo.
List of policies if requested.
:param policies: The policies of this AccountInfo.
:type: list[FeaturePolicy]
'''
pass
@property
def postal_code(self):
'''
Gets the postal_code of this AccountInfo.
The postal code part of the postal address.
:return: The postal_code of this AccountInfo.
:rtype: str
'''
pass
@postal_code.setter
def postal_code(self):
'''
Sets the postal_code of this AccountInfo.
The postal code part of the postal address.
:param postal_code: The postal_code of this AccountInfo.
:type: str
'''
pass
@property
def reason(self):
'''
Gets the reason of this AccountInfo.
A reason note for updating the status of the account
:return: The reason of this AccountInfo.
:rtype: str
'''
pass
@reason.setter
def reason(self):
'''
Sets the reason of this AccountInfo.
A reason note for updating the status of the account
:param reason: The reason of this AccountInfo.
:type: str
'''
pass
@property
def reference_note(self):
'''
Gets the reference_note of this AccountInfo.
A reference note for updating the status of the account
:return: The reference_note of this AccountInfo.
:rtype: str
'''
pass
@reference_note.setter
def reference_note(self):
'''
Sets the reference_note of this AccountInfo.
A reference note for updating the status of the account
:param reference_note: The reference_note of this AccountInfo.
:type: str
'''
pass
@property
def sales_contact(self):
'''
Gets the sales_contact of this AccountInfo.
Email address of the sales contact.
:return: The sales_contact of this AccountInfo.
:rtype: str
'''
pass
@sales_contact.setter
def sales_contact(self):
'''
Sets the sales_contact of this AccountInfo.
Email address of the sales contact.
:param sales_contact: The sales_contact of this AccountInfo.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this AccountInfo.
The state part of the postal address.
:return: The state of this AccountInfo.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this AccountInfo.
The state part of the postal address.
:param state: The state of this AccountInfo.
:type: str
'''
pass
@property
def status(self):
'''
Gets the status of this AccountInfo.
The status of the account.
:return: The status of this AccountInfo.
:rtype: str
'''
pass
@status.setter
def status(self):
'''
Sets the status of this AccountInfo.
The status of the account.
:param status: The status of this AccountInfo.
:type: str
'''
pass
@property
def sub_accounts(self):
'''
Gets the sub_accounts of this AccountInfo.
List of sub accounts. Not available for developer users.
:return: The sub_accounts of this AccountInfo.
:rtype: list[AccountInfo]
'''
pass
@sub_accounts.setter
def sub_accounts(self):
'''
Sets the sub_accounts of this AccountInfo.
List of sub accounts. Not available for developer users.
:param sub_accounts: The sub_accounts of this AccountInfo.
:type: list[AccountInfo]
'''
pass
@property
def template_id(self):
'''
Gets the template_id of this AccountInfo.
Account template ID.
:return: The template_id of this AccountInfo.
:rtype: str
'''
pass
@template_id.setter
def template_id(self):
'''
Sets the template_id of this AccountInfo.
Account template ID.
:param template_id: The template_id of this AccountInfo.
:type: str
'''
pass
@property
def tier(self):
'''
Gets the tier of this AccountInfo.
The tier level of the account; '0': free tier, '1': commercial account, '2': partner tier. Other values are reserved for the future.
:return: The tier of this AccountInfo.
:rtype: str
'''
pass
@tier.setter
def tier(self):
'''
Sets the tier of this AccountInfo.
The tier level of the account; '0': free tier, '1': commercial account, '2': partner tier. Other values are reserved for the future.
:param tier: The tier of this AccountInfo.
:type: str
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this AccountInfo.
Last update UTC time RFC3339.
:return: The updated_at of this AccountInfo.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this AccountInfo.
Last update UTC time RFC3339.
:param updated_at: The updated_at of this AccountInfo.
:type: datetime
'''
pass
@property
def upgraded_at(self):
'''
Gets the upgraded_at of this AccountInfo.
Time when upgraded to commercial account in UTC format RFC3339.
:return: The upgraded_at of this AccountInfo.
:rtype: datetime
'''
pass
@upgraded_at.setter
def upgraded_at(self):
'''
Sets the upgraded_at of this AccountInfo.
Time when upgraded to commercial account in UTC format RFC3339.
:param upgraded_at: The upgraded_at of this AccountInfo.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 155 | 81 | 10 | 1 | 3 | 6 | 1 | 1.18 | 1 | 4 | 0 | 0 | 80 | 38 | 80 | 80 | 1,073 | 198 | 402 | 201 | 247 | 473 | 233 | 127 | 152 | 5 | 1 | 2 | 95 |
2,421 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/account_creation_resp.py
|
mbed_cloud._backends.iam.models.account_creation_resp.AccountCreationResp
|
class AccountCreationResp(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'address_line1': 'str',
'address_line2': 'str',
'admin_email': 'str',
'admin_full_name': 'str',
'admin_id': 'str',
'admin_key': 'str',
'admin_name': 'str',
'admin_password': 'str',
'aliases': 'list[str]',
'city': 'str',
'company': 'str',
'contact': 'str',
'contract_number': 'str',
'country': 'str',
'customer_number': 'str',
'display_name': 'str',
'email': 'str',
'end_market': 'str',
'id': 'str',
'phone_number': 'str',
'postal_code': 'str',
'state': 'str'
}
attribute_map = {
'address_line1': 'address_line1',
'address_line2': 'address_line2',
'admin_email': 'admin_email',
'admin_full_name': 'admin_full_name',
'admin_id': 'admin_id',
'admin_key': 'admin_key',
'admin_name': 'admin_name',
'admin_password': 'admin_password',
'aliases': 'aliases',
'city': 'city',
'company': 'company',
'contact': 'contact',
'contract_number': 'contract_number',
'country': 'country',
'customer_number': 'customer_number',
'display_name': 'display_name',
'email': 'email',
'end_market': 'end_market',
'id': 'id',
'phone_number': 'phone_number',
'postal_code': 'postal_code',
'state': 'state'
}
def __init__(self, address_line1=None, address_line2=None, admin_email=None, admin_full_name=None, admin_id=None, admin_key=None, admin_name=None, admin_password=None, aliases=None, city=None, company=None, contact=None, contract_number=None, country=None, customer_number=None, display_name=None, email=None, end_market=None, id=None, phone_number=None, postal_code=None, state=None):
"""
AccountCreationResp - a model defined in Swagger
"""
self._address_line1 = address_line1
self._address_line2 = address_line2
self._admin_email = admin_email
self._admin_full_name = admin_full_name
self._admin_id = admin_id
self._admin_key = admin_key
self._admin_name = admin_name
self._admin_password = admin_password
self._aliases = aliases
self._city = city
self._company = company
self._contact = contact
self._contract_number = contract_number
self._country = country
self._customer_number = customer_number
self._display_name = display_name
self._email = email
self._end_market = end_market
self._id = id
self._phone_number = phone_number
self._postal_code = postal_code
self._state = state
self.discriminator = None
@property
def address_line1(self):
"""
Gets the address_line1 of this AccountCreationResp.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:return: The address_line1 of this AccountCreationResp.
:rtype: str
"""
return self._address_line1
@address_line1.setter
def address_line1(self, address_line1):
"""
Sets the address_line1 of this AccountCreationResp.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:param address_line1: The address_line1 of this AccountCreationResp.
:type: str
"""
self._address_line1 = address_line1
@property
def address_line2(self):
"""
Gets the address_line2 of this AccountCreationResp.
Postal address line 2, not longer than 100 characters.
:return: The address_line2 of this AccountCreationResp.
:rtype: str
"""
return self._address_line2
@address_line2.setter
def address_line2(self, address_line2):
"""
Sets the address_line2 of this AccountCreationResp.
Postal address line 2, not longer than 100 characters.
:param address_line2: The address_line2 of this AccountCreationResp.
:type: str
"""
self._address_line2 = address_line2
@property
def admin_email(self):
"""
Gets the admin_email of this AccountCreationResp.
The email address of the account admin, not longer than 254 characters.
:return: The admin_email of this AccountCreationResp.
:rtype: str
"""
return self._admin_email
@admin_email.setter
def admin_email(self, admin_email):
"""
Sets the admin_email of this AccountCreationResp.
The email address of the account admin, not longer than 254 characters.
:param admin_email: The admin_email of this AccountCreationResp.
:type: str
"""
self._admin_email = admin_email
@property
def admin_full_name(self):
"""
Gets the admin_full_name of this AccountCreationResp.
The full name of the admin user to be created.
:return: The admin_full_name of this AccountCreationResp.
:rtype: str
"""
return self._admin_full_name
@admin_full_name.setter
def admin_full_name(self, admin_full_name):
"""
Sets the admin_full_name of this AccountCreationResp.
The full name of the admin user to be created.
:param admin_full_name: The admin_full_name of this AccountCreationResp.
:type: str
"""
self._admin_full_name = admin_full_name
@property
def admin_id(self):
"""
Gets the admin_id of this AccountCreationResp.
The ID of the admin user created.
:return: The admin_id of this AccountCreationResp.
:rtype: str
"""
return self._admin_id
@admin_id.setter
def admin_id(self, admin_id):
"""
Sets the admin_id of this AccountCreationResp.
The ID of the admin user created.
:param admin_id: The admin_id of this AccountCreationResp.
:type: str
"""
if admin_id is None:
raise ValueError("Invalid value for `admin_id`, must not be `None`")
self._admin_id = admin_id
@property
def admin_key(self):
"""
Gets the admin_key of this AccountCreationResp.
The admin API key created for the account.
:return: The admin_key of this AccountCreationResp.
:rtype: str
"""
return self._admin_key
@admin_key.setter
def admin_key(self, admin_key):
"""
Sets the admin_key of this AccountCreationResp.
The admin API key created for the account.
:param admin_key: The admin_key of this AccountCreationResp.
:type: str
"""
self._admin_key = admin_key
@property
def admin_name(self):
"""
Gets the admin_name of this AccountCreationResp.
The username of the admin user to be created, containing alphanumerical letters and -,._@+= characters. It must be at least 4 but not more than 30 character long.
:return: The admin_name of this AccountCreationResp.
:rtype: str
"""
return self._admin_name
@admin_name.setter
def admin_name(self, admin_name):
"""
Sets the admin_name of this AccountCreationResp.
The username of the admin user to be created, containing alphanumerical letters and -,._@+= characters. It must be at least 4 but not more than 30 character long.
:param admin_name: The admin_name of this AccountCreationResp.
:type: str
"""
self._admin_name = admin_name
@property
def admin_password(self):
"""
Gets the admin_password of this AccountCreationResp.
The password when creating a new user. It will be generated when not present in the request.
:return: The admin_password of this AccountCreationResp.
:rtype: str
"""
return self._admin_password
@admin_password.setter
def admin_password(self, admin_password):
"""
Sets the admin_password of this AccountCreationResp.
The password when creating a new user. It will be generated when not present in the request.
:param admin_password: The admin_password of this AccountCreationResp.
:type: str
"""
self._admin_password = admin_password
@property
def aliases(self):
"""
Gets the aliases of this AccountCreationResp.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:return: The aliases of this AccountCreationResp.
:rtype: list[str]
"""
return self._aliases
@aliases.setter
def aliases(self, aliases):
"""
Sets the aliases of this AccountCreationResp.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:param aliases: The aliases of this AccountCreationResp.
:type: list[str]
"""
self._aliases = aliases
@property
def city(self):
"""
Gets the city of this AccountCreationResp.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The city of this AccountCreationResp.
:rtype: str
"""
return self._city
@city.setter
def city(self, city):
"""
Sets the city of this AccountCreationResp.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param city: The city of this AccountCreationResp.
:type: str
"""
self._city = city
@property
def company(self):
"""
Gets the company of this AccountCreationResp.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:return: The company of this AccountCreationResp.
:rtype: str
"""
return self._company
@company.setter
def company(self, company):
"""
Sets the company of this AccountCreationResp.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:param company: The company of this AccountCreationResp.
:type: str
"""
self._company = company
@property
def contact(self):
"""
Gets the contact of this AccountCreationResp.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:return: The contact of this AccountCreationResp.
:rtype: str
"""
return self._contact
@contact.setter
def contact(self, contact):
"""
Sets the contact of this AccountCreationResp.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:param contact: The contact of this AccountCreationResp.
:type: str
"""
self._contact = contact
@property
def contract_number(self):
"""
Gets the contract_number of this AccountCreationResp.
Contract number of the customer.
:return: The contract_number of this AccountCreationResp.
:rtype: str
"""
return self._contract_number
@contract_number.setter
def contract_number(self, contract_number):
"""
Sets the contract_number of this AccountCreationResp.
Contract number of the customer.
:param contract_number: The contract_number of this AccountCreationResp.
:type: str
"""
self._contract_number = contract_number
@property
def country(self):
"""
Gets the country of this AccountCreationResp.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The country of this AccountCreationResp.
:rtype: str
"""
return self._country
@country.setter
def country(self, country):
"""
Sets the country of this AccountCreationResp.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param country: The country of this AccountCreationResp.
:type: str
"""
self._country = country
@property
def customer_number(self):
"""
Gets the customer_number of this AccountCreationResp.
Customer number of the customer.
:return: The customer_number of this AccountCreationResp.
:rtype: str
"""
return self._customer_number
@customer_number.setter
def customer_number(self, customer_number):
"""
Sets the customer_number of this AccountCreationResp.
Customer number of the customer.
:param customer_number: The customer_number of this AccountCreationResp.
:type: str
"""
self._customer_number = customer_number
@property
def display_name(self):
"""
Gets the display_name of this AccountCreationResp.
The display name for the account, not longer than 100 characters.
:return: The display_name of this AccountCreationResp.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this AccountCreationResp.
The display name for the account, not longer than 100 characters.
:param display_name: The display_name of this AccountCreationResp.
:type: str
"""
self._display_name = display_name
@property
def email(self):
"""
Gets the email of this AccountCreationResp.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:return: The email of this AccountCreationResp.
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""
Sets the email of this AccountCreationResp.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:param email: The email of this AccountCreationResp.
:type: str
"""
self._email = email
@property
def end_market(self):
"""
Gets the end_market of this AccountCreationResp.
The end market of the account to be created.
:return: The end_market of this AccountCreationResp.
:rtype: str
"""
return self._end_market
@end_market.setter
def end_market(self, end_market):
"""
Sets the end_market of this AccountCreationResp.
The end market of the account to be created.
:param end_market: The end_market of this AccountCreationResp.
:type: str
"""
if end_market is None:
raise ValueError("Invalid value for `end_market`, must not be `None`")
self._end_market = end_market
@property
def id(self):
"""
Gets the id of this AccountCreationResp.
Account ID.
:return: The id of this AccountCreationResp.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this AccountCreationResp.
Account ID.
:param id: The id of this AccountCreationResp.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def phone_number(self):
"""
Gets the phone_number of this AccountCreationResp.
The phone number of a representative of the company, not longer than 100 characters.
:return: The phone_number of this AccountCreationResp.
:rtype: str
"""
return self._phone_number
@phone_number.setter
def phone_number(self, phone_number):
"""
Sets the phone_number of this AccountCreationResp.
The phone number of a representative of the company, not longer than 100 characters.
:param phone_number: The phone_number of this AccountCreationResp.
:type: str
"""
self._phone_number = phone_number
@property
def postal_code(self):
"""
Gets the postal_code of this AccountCreationResp.
The postal code part of the postal address, not longer than 100 characters.
:return: The postal_code of this AccountCreationResp.
:rtype: str
"""
return self._postal_code
@postal_code.setter
def postal_code(self, postal_code):
"""
Sets the postal_code of this AccountCreationResp.
The postal code part of the postal address, not longer than 100 characters.
:param postal_code: The postal_code of this AccountCreationResp.
:type: str
"""
self._postal_code = postal_code
@property
def state(self):
"""
Gets the state of this AccountCreationResp.
The state part of the postal address, not longer than 100 characters.
:return: The state of this AccountCreationResp.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this AccountCreationResp.
The state part of the postal address, not longer than 100 characters.
:param state: The state of this AccountCreationResp.
:type: str
"""
self._state = state
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, AccountCreationResp):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class AccountCreationResp(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, address_line1=None, address_line2=None, admin_email=None, admin_full_name=None, admin_id=None, admin_key=None, admin_name=None, admin_password=None, aliases=None, city=None, company=None, contact=None, contract_number=None, country=None, customer_number=None, display_name=None, email=None, end_market=None, id=None, phone_number=None, postal_code=None, state=None):
'''
AccountCreationResp - a model defined in Swagger
'''
pass
@property
def address_line1(self):
'''
Gets the address_line1 of this AccountCreationResp.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:return: The address_line1 of this AccountCreationResp.
:rtype: str
'''
pass
@address_line1.setter
def address_line1(self):
'''
Sets the address_line1 of this AccountCreationResp.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:param address_line1: The address_line1 of this AccountCreationResp.
:type: str
'''
pass
@property
def address_line2(self):
'''
Gets the address_line2 of this AccountCreationResp.
Postal address line 2, not longer than 100 characters.
:return: The address_line2 of this AccountCreationResp.
:rtype: str
'''
pass
@address_line2.setter
def address_line2(self):
'''
Sets the address_line2 of this AccountCreationResp.
Postal address line 2, not longer than 100 characters.
:param address_line2: The address_line2 of this AccountCreationResp.
:type: str
'''
pass
@property
def admin_email(self):
'''
Gets the admin_email of this AccountCreationResp.
The email address of the account admin, not longer than 254 characters.
:return: The admin_email of this AccountCreationResp.
:rtype: str
'''
pass
@admin_email.setter
def admin_email(self):
'''
Sets the admin_email of this AccountCreationResp.
The email address of the account admin, not longer than 254 characters.
:param admin_email: The admin_email of this AccountCreationResp.
:type: str
'''
pass
@property
def admin_full_name(self):
'''
Gets the admin_full_name of this AccountCreationResp.
The full name of the admin user to be created.
:return: The admin_full_name of this AccountCreationResp.
:rtype: str
'''
pass
@admin_full_name.setter
def admin_full_name(self):
'''
Sets the admin_full_name of this AccountCreationResp.
The full name of the admin user to be created.
:param admin_full_name: The admin_full_name of this AccountCreationResp.
:type: str
'''
pass
@property
def admin_id(self):
'''
Gets the admin_id of this AccountCreationResp.
The ID of the admin user created.
:return: The admin_id of this AccountCreationResp.
:rtype: str
'''
pass
@admin_id.setter
def admin_id(self):
'''
Sets the admin_id of this AccountCreationResp.
The ID of the admin user created.
:param admin_id: The admin_id of this AccountCreationResp.
:type: str
'''
pass
@property
def admin_key(self):
'''
Gets the admin_key of this AccountCreationResp.
The admin API key created for the account.
:return: The admin_key of this AccountCreationResp.
:rtype: str
'''
pass
@admin_key.setter
def admin_key(self):
'''
Sets the admin_key of this AccountCreationResp.
The admin API key created for the account.
:param admin_key: The admin_key of this AccountCreationResp.
:type: str
'''
pass
@property
def admin_name(self):
'''
Gets the admin_name of this AccountCreationResp.
The username of the admin user to be created, containing alphanumerical letters and -,._@+= characters. It must be at least 4 but not more than 30 character long.
:return: The admin_name of this AccountCreationResp.
:rtype: str
'''
pass
@admin_name.setter
def admin_name(self):
'''
Sets the admin_name of this AccountCreationResp.
The username of the admin user to be created, containing alphanumerical letters and -,._@+= characters. It must be at least 4 but not more than 30 character long.
:param admin_name: The admin_name of this AccountCreationResp.
:type: str
'''
pass
@property
def admin_password(self):
'''
Gets the admin_password of this AccountCreationResp.
The password when creating a new user. It will be generated when not present in the request.
:return: The admin_password of this AccountCreationResp.
:rtype: str
'''
pass
@admin_password.setter
def admin_password(self):
'''
Sets the admin_password of this AccountCreationResp.
The password when creating a new user. It will be generated when not present in the request.
:param admin_password: The admin_password of this AccountCreationResp.
:type: str
'''
pass
@property
def aliases(self):
'''
Gets the aliases of this AccountCreationResp.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:return: The aliases of this AccountCreationResp.
:rtype: list[str]
'''
pass
@aliases.setter
def aliases(self):
'''
Sets the aliases of this AccountCreationResp.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:param aliases: The aliases of this AccountCreationResp.
:type: list[str]
'''
pass
@property
def city(self):
'''
Gets the city of this AccountCreationResp.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The city of this AccountCreationResp.
:rtype: str
'''
pass
@city.setter
def city(self):
'''
Sets the city of this AccountCreationResp.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param city: The city of this AccountCreationResp.
:type: str
'''
pass
@property
def company(self):
'''
Gets the company of this AccountCreationResp.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:return: The company of this AccountCreationResp.
:rtype: str
'''
pass
@company.setter
def company(self):
'''
Sets the company of this AccountCreationResp.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:param company: The company of this AccountCreationResp.
:type: str
'''
pass
@property
def contact(self):
'''
Gets the contact of this AccountCreationResp.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:return: The contact of this AccountCreationResp.
:rtype: str
'''
pass
@contact.setter
def contact(self):
'''
Sets the contact of this AccountCreationResp.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:param contact: The contact of this AccountCreationResp.
:type: str
'''
pass
@property
def contract_number(self):
'''
Gets the contract_number of this AccountCreationResp.
Contract number of the customer.
:return: The contract_number of this AccountCreationResp.
:rtype: str
'''
pass
@contract_number.setter
def contract_number(self):
'''
Sets the contract_number of this AccountCreationResp.
Contract number of the customer.
:param contract_number: The contract_number of this AccountCreationResp.
:type: str
'''
pass
@property
def country(self):
'''
Gets the country of this AccountCreationResp.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The country of this AccountCreationResp.
:rtype: str
'''
pass
@country.setter
def country(self):
'''
Sets the country of this AccountCreationResp.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param country: The country of this AccountCreationResp.
:type: str
'''
pass
@property
def customer_number(self):
'''
Gets the customer_number of this AccountCreationResp.
Customer number of the customer.
:return: The customer_number of this AccountCreationResp.
:rtype: str
'''
pass
@customer_number.setter
def customer_number(self):
'''
Sets the customer_number of this AccountCreationResp.
Customer number of the customer.
:param customer_number: The customer_number of this AccountCreationResp.
:type: str
'''
pass
@property
def display_name(self):
'''
Gets the display_name of this AccountCreationResp.
The display name for the account, not longer than 100 characters.
:return: The display_name of this AccountCreationResp.
:rtype: str
'''
pass
@display_name.setter
def display_name(self):
'''
Sets the display_name of this AccountCreationResp.
The display name for the account, not longer than 100 characters.
:param display_name: The display_name of this AccountCreationResp.
:type: str
'''
pass
@property
def email(self):
'''
Gets the email of this AccountCreationResp.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:return: The email of this AccountCreationResp.
:rtype: str
'''
pass
@email.setter
def email(self):
'''
Sets the email of this AccountCreationResp.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:param email: The email of this AccountCreationResp.
:type: str
'''
pass
@property
def end_market(self):
'''
Gets the end_market of this AccountCreationResp.
The end market of the account to be created.
:return: The end_market of this AccountCreationResp.
:rtype: str
'''
pass
@end_market.setter
def end_market(self):
'''
Sets the end_market of this AccountCreationResp.
The end market of the account to be created.
:param end_market: The end_market of this AccountCreationResp.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this AccountCreationResp.
Account ID.
:return: The id of this AccountCreationResp.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this AccountCreationResp.
Account ID.
:param id: The id of this AccountCreationResp.
:type: str
'''
pass
@property
def phone_number(self):
'''
Gets the phone_number of this AccountCreationResp.
The phone number of a representative of the company, not longer than 100 characters.
:return: The phone_number of this AccountCreationResp.
:rtype: str
'''
pass
@phone_number.setter
def phone_number(self):
'''
Sets the phone_number of this AccountCreationResp.
The phone number of a representative of the company, not longer than 100 characters.
:param phone_number: The phone_number of this AccountCreationResp.
:type: str
'''
pass
@property
def postal_code(self):
'''
Gets the postal_code of this AccountCreationResp.
The postal code part of the postal address, not longer than 100 characters.
:return: The postal_code of this AccountCreationResp.
:rtype: str
'''
pass
@postal_code.setter
def postal_code(self):
'''
Sets the postal_code of this AccountCreationResp.
The postal code part of the postal address, not longer than 100 characters.
:param postal_code: The postal_code of this AccountCreationResp.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this AccountCreationResp.
The state part of the postal address, not longer than 100 characters.
:return: The state of this AccountCreationResp.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this AccountCreationResp.
The state part of the postal address, not longer than 100 characters.
:param state: The state of this AccountCreationResp.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 95 | 51 | 10 | 1 | 3 | 6 | 1 | 1.22 | 1 | 4 | 0 | 0 | 50 | 23 | 50 | 50 | 657 | 123 | 241 | 123 | 146 | 293 | 141 | 79 | 90 | 5 | 1 | 2 | 58 |
2,422 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/account_creation_req.py
|
mbed_cloud._backends.iam.models.account_creation_req.AccountCreationReq
|
class AccountCreationReq(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'address_line1': 'str',
'address_line2': 'str',
'admin_email': 'str',
'admin_full_name': 'str',
'admin_name': 'str',
'admin_password': 'str',
'aliases': 'list[str]',
'city': 'str',
'company': 'str',
'contact': 'str',
'contract_number': 'str',
'country': 'str',
'customer_number': 'str',
'display_name': 'str',
'email': 'str',
'end_market': 'str',
'phone_number': 'str',
'postal_code': 'str',
'state': 'str'
}
attribute_map = {
'address_line1': 'address_line1',
'address_line2': 'address_line2',
'admin_email': 'admin_email',
'admin_full_name': 'admin_full_name',
'admin_name': 'admin_name',
'admin_password': 'admin_password',
'aliases': 'aliases',
'city': 'city',
'company': 'company',
'contact': 'contact',
'contract_number': 'contract_number',
'country': 'country',
'customer_number': 'customer_number',
'display_name': 'display_name',
'email': 'email',
'end_market': 'end_market',
'phone_number': 'phone_number',
'postal_code': 'postal_code',
'state': 'state'
}
def __init__(self, address_line1=None, address_line2=None, admin_email=None, admin_full_name=None, admin_name=None, admin_password=None, aliases=None, city=None, company=None, contact=None, contract_number=None, country=None, customer_number=None, display_name=None, email=None, end_market=None, phone_number=None, postal_code=None, state=None):
"""
AccountCreationReq - a model defined in Swagger
"""
self._address_line1 = address_line1
self._address_line2 = address_line2
self._admin_email = admin_email
self._admin_full_name = admin_full_name
self._admin_name = admin_name
self._admin_password = admin_password
self._aliases = aliases
self._city = city
self._company = company
self._contact = contact
self._contract_number = contract_number
self._country = country
self._customer_number = customer_number
self._display_name = display_name
self._email = email
self._end_market = end_market
self._phone_number = phone_number
self._postal_code = postal_code
self._state = state
self.discriminator = None
@property
def address_line1(self):
"""
Gets the address_line1 of this AccountCreationReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:return: The address_line1 of this AccountCreationReq.
:rtype: str
"""
return self._address_line1
@address_line1.setter
def address_line1(self, address_line1):
"""
Sets the address_line1 of this AccountCreationReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:param address_line1: The address_line1 of this AccountCreationReq.
:type: str
"""
self._address_line1 = address_line1
@property
def address_line2(self):
"""
Gets the address_line2 of this AccountCreationReq.
Postal address line 2, not longer than 100 characters.
:return: The address_line2 of this AccountCreationReq.
:rtype: str
"""
return self._address_line2
@address_line2.setter
def address_line2(self, address_line2):
"""
Sets the address_line2 of this AccountCreationReq.
Postal address line 2, not longer than 100 characters.
:param address_line2: The address_line2 of this AccountCreationReq.
:type: str
"""
self._address_line2 = address_line2
@property
def admin_email(self):
"""
Gets the admin_email of this AccountCreationReq.
The email address of the account admin, not longer than 254 characters.
:return: The admin_email of this AccountCreationReq.
:rtype: str
"""
return self._admin_email
@admin_email.setter
def admin_email(self, admin_email):
"""
Sets the admin_email of this AccountCreationReq.
The email address of the account admin, not longer than 254 characters.
:param admin_email: The admin_email of this AccountCreationReq.
:type: str
"""
self._admin_email = admin_email
@property
def admin_full_name(self):
"""
Gets the admin_full_name of this AccountCreationReq.
The full name of the admin user to be created.
:return: The admin_full_name of this AccountCreationReq.
:rtype: str
"""
return self._admin_full_name
@admin_full_name.setter
def admin_full_name(self, admin_full_name):
"""
Sets the admin_full_name of this AccountCreationReq.
The full name of the admin user to be created.
:param admin_full_name: The admin_full_name of this AccountCreationReq.
:type: str
"""
self._admin_full_name = admin_full_name
@property
def admin_name(self):
"""
Gets the admin_name of this AccountCreationReq.
The username of the admin user to be created, containing alphanumerical letters and -,._@+= characters. It must be at least 4 but not more than 30 character long.
:return: The admin_name of this AccountCreationReq.
:rtype: str
"""
return self._admin_name
@admin_name.setter
def admin_name(self, admin_name):
"""
Sets the admin_name of this AccountCreationReq.
The username of the admin user to be created, containing alphanumerical letters and -,._@+= characters. It must be at least 4 but not more than 30 character long.
:param admin_name: The admin_name of this AccountCreationReq.
:type: str
"""
self._admin_name = admin_name
@property
def admin_password(self):
"""
Gets the admin_password of this AccountCreationReq.
The password when creating a new user. It will be generated when not present in the request.
:return: The admin_password of this AccountCreationReq.
:rtype: str
"""
return self._admin_password
@admin_password.setter
def admin_password(self, admin_password):
"""
Sets the admin_password of this AccountCreationReq.
The password when creating a new user. It will be generated when not present in the request.
:param admin_password: The admin_password of this AccountCreationReq.
:type: str
"""
self._admin_password = admin_password
@property
def aliases(self):
"""
Gets the aliases of this AccountCreationReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:return: The aliases of this AccountCreationReq.
:rtype: list[str]
"""
return self._aliases
@aliases.setter
def aliases(self, aliases):
"""
Sets the aliases of this AccountCreationReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:param aliases: The aliases of this AccountCreationReq.
:type: list[str]
"""
self._aliases = aliases
@property
def city(self):
"""
Gets the city of this AccountCreationReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The city of this AccountCreationReq.
:rtype: str
"""
return self._city
@city.setter
def city(self, city):
"""
Sets the city of this AccountCreationReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param city: The city of this AccountCreationReq.
:type: str
"""
self._city = city
@property
def company(self):
"""
Gets the company of this AccountCreationReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:return: The company of this AccountCreationReq.
:rtype: str
"""
return self._company
@company.setter
def company(self, company):
"""
Sets the company of this AccountCreationReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:param company: The company of this AccountCreationReq.
:type: str
"""
self._company = company
@property
def contact(self):
"""
Gets the contact of this AccountCreationReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:return: The contact of this AccountCreationReq.
:rtype: str
"""
return self._contact
@contact.setter
def contact(self, contact):
"""
Sets the contact of this AccountCreationReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:param contact: The contact of this AccountCreationReq.
:type: str
"""
self._contact = contact
@property
def contract_number(self):
"""
Gets the contract_number of this AccountCreationReq.
Contract number of the customer.
:return: The contract_number of this AccountCreationReq.
:rtype: str
"""
return self._contract_number
@contract_number.setter
def contract_number(self, contract_number):
"""
Sets the contract_number of this AccountCreationReq.
Contract number of the customer.
:param contract_number: The contract_number of this AccountCreationReq.
:type: str
"""
self._contract_number = contract_number
@property
def country(self):
"""
Gets the country of this AccountCreationReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The country of this AccountCreationReq.
:rtype: str
"""
return self._country
@country.setter
def country(self, country):
"""
Sets the country of this AccountCreationReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param country: The country of this AccountCreationReq.
:type: str
"""
self._country = country
@property
def customer_number(self):
"""
Gets the customer_number of this AccountCreationReq.
Customer number of the customer.
:return: The customer_number of this AccountCreationReq.
:rtype: str
"""
return self._customer_number
@customer_number.setter
def customer_number(self, customer_number):
"""
Sets the customer_number of this AccountCreationReq.
Customer number of the customer.
:param customer_number: The customer_number of this AccountCreationReq.
:type: str
"""
self._customer_number = customer_number
@property
def display_name(self):
"""
Gets the display_name of this AccountCreationReq.
The display name for the account, not longer than 100 characters.
:return: The display_name of this AccountCreationReq.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this AccountCreationReq.
The display name for the account, not longer than 100 characters.
:param display_name: The display_name of this AccountCreationReq.
:type: str
"""
self._display_name = display_name
@property
def email(self):
"""
Gets the email of this AccountCreationReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:return: The email of this AccountCreationReq.
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""
Sets the email of this AccountCreationReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:param email: The email of this AccountCreationReq.
:type: str
"""
self._email = email
@property
def end_market(self):
"""
Gets the end_market of this AccountCreationReq.
The end market of the account to be created.
:return: The end_market of this AccountCreationReq.
:rtype: str
"""
return self._end_market
@end_market.setter
def end_market(self, end_market):
"""
Sets the end_market of this AccountCreationReq.
The end market of the account to be created.
:param end_market: The end_market of this AccountCreationReq.
:type: str
"""
if end_market is None:
raise ValueError("Invalid value for `end_market`, must not be `None`")
self._end_market = end_market
@property
def phone_number(self):
"""
Gets the phone_number of this AccountCreationReq.
The phone number of a representative of the company, not longer than 100 characters.
:return: The phone_number of this AccountCreationReq.
:rtype: str
"""
return self._phone_number
@phone_number.setter
def phone_number(self, phone_number):
"""
Sets the phone_number of this AccountCreationReq.
The phone number of a representative of the company, not longer than 100 characters.
:param phone_number: The phone_number of this AccountCreationReq.
:type: str
"""
self._phone_number = phone_number
@property
def postal_code(self):
"""
Gets the postal_code of this AccountCreationReq.
The postal code part of the postal address, not longer than 100 characters.
:return: The postal_code of this AccountCreationReq.
:rtype: str
"""
return self._postal_code
@postal_code.setter
def postal_code(self, postal_code):
"""
Sets the postal_code of this AccountCreationReq.
The postal code part of the postal address, not longer than 100 characters.
:param postal_code: The postal_code of this AccountCreationReq.
:type: str
"""
self._postal_code = postal_code
@property
def state(self):
"""
Gets the state of this AccountCreationReq.
The state part of the postal address, not longer than 100 characters.
:return: The state of this AccountCreationReq.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this AccountCreationReq.
The state part of the postal address, not longer than 100 characters.
:param state: The state of this AccountCreationReq.
:type: str
"""
self._state = state
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, AccountCreationReq):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class AccountCreationReq(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, address_line1=None, address_line2=None, admin_email=None, admin_full_name=None, admin_name=None, admin_password=None, aliases=None, city=None, company=None, contact=None, contract_number=None, country=None, customer_number=None, display_name=None, email=None, end_market=None, phone_number=None, postal_code=None, state=None):
'''
AccountCreationReq - a model defined in Swagger
'''
pass
@property
def address_line1(self):
'''
Gets the address_line1 of this AccountCreationReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:return: The address_line1 of this AccountCreationReq.
:rtype: str
'''
pass
@address_line1.setter
def address_line1(self):
'''
Sets the address_line1 of this AccountCreationReq.
Postal address line 1, not longer than 100 characters. Required for commercial accounts only.
:param address_line1: The address_line1 of this AccountCreationReq.
:type: str
'''
pass
@property
def address_line2(self):
'''
Gets the address_line2 of this AccountCreationReq.
Postal address line 2, not longer than 100 characters.
:return: The address_line2 of this AccountCreationReq.
:rtype: str
'''
pass
@address_line2.setter
def address_line2(self):
'''
Sets the address_line2 of this AccountCreationReq.
Postal address line 2, not longer than 100 characters.
:param address_line2: The address_line2 of this AccountCreationReq.
:type: str
'''
pass
@property
def admin_email(self):
'''
Gets the admin_email of this AccountCreationReq.
The email address of the account admin, not longer than 254 characters.
:return: The admin_email of this AccountCreationReq.
:rtype: str
'''
pass
@admin_email.setter
def admin_email(self):
'''
Sets the admin_email of this AccountCreationReq.
The email address of the account admin, not longer than 254 characters.
:param admin_email: The admin_email of this AccountCreationReq.
:type: str
'''
pass
@property
def admin_full_name(self):
'''
Gets the admin_full_name of this AccountCreationReq.
The full name of the admin user to be created.
:return: The admin_full_name of this AccountCreationReq.
:rtype: str
'''
pass
@admin_full_name.setter
def admin_full_name(self):
'''
Sets the admin_full_name of this AccountCreationReq.
The full name of the admin user to be created.
:param admin_full_name: The admin_full_name of this AccountCreationReq.
:type: str
'''
pass
@property
def admin_name(self):
'''
Gets the admin_name of this AccountCreationReq.
The username of the admin user to be created, containing alphanumerical letters and -,._@+= characters. It must be at least 4 but not more than 30 character long.
:return: The admin_name of this AccountCreationReq.
:rtype: str
'''
pass
@admin_name.setter
def admin_name(self):
'''
Sets the admin_name of this AccountCreationReq.
The username of the admin user to be created, containing alphanumerical letters and -,._@+= characters. It must be at least 4 but not more than 30 character long.
:param admin_name: The admin_name of this AccountCreationReq.
:type: str
'''
pass
@property
def admin_password(self):
'''
Gets the admin_password of this AccountCreationReq.
The password when creating a new user. It will be generated when not present in the request.
:return: The admin_password of this AccountCreationReq.
:rtype: str
'''
pass
@admin_password.setter
def admin_password(self):
'''
Sets the admin_password of this AccountCreationReq.
The password when creating a new user. It will be generated when not present in the request.
:param admin_password: The admin_password of this AccountCreationReq.
:type: str
'''
pass
@property
def aliases(self):
'''
Gets the aliases of this AccountCreationReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:return: The aliases of this AccountCreationReq.
:rtype: list[str]
'''
pass
@aliases.setter
def aliases(self):
'''
Sets the aliases of this AccountCreationReq.
An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.
:param aliases: The aliases of this AccountCreationReq.
:type: list[str]
'''
pass
@property
def city(self):
'''
Gets the city of this AccountCreationReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The city of this AccountCreationReq.
:rtype: str
'''
pass
@city.setter
def city(self):
'''
Sets the city of this AccountCreationReq.
The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param city: The city of this AccountCreationReq.
:type: str
'''
pass
@property
def company(self):
'''
Gets the company of this AccountCreationReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:return: The company of this AccountCreationReq.
:rtype: str
'''
pass
@company.setter
def company(self):
'''
Sets the company of this AccountCreationReq.
The name of the company, not longer than 100 characters. Required for commercial accounts only.
:param company: The company of this AccountCreationReq.
:type: str
'''
pass
@property
def contact(self):
'''
Gets the contact of this AccountCreationReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:return: The contact of this AccountCreationReq.
:rtype: str
'''
pass
@contact.setter
def contact(self):
'''
Sets the contact of this AccountCreationReq.
The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.
:param contact: The contact of this AccountCreationReq.
:type: str
'''
pass
@property
def contract_number(self):
'''
Gets the contract_number of this AccountCreationReq.
Contract number of the customer.
:return: The contract_number of this AccountCreationReq.
:rtype: str
'''
pass
@contract_number.setter
def contract_number(self):
'''
Sets the contract_number of this AccountCreationReq.
Contract number of the customer.
:param contract_number: The contract_number of this AccountCreationReq.
:type: str
'''
pass
@property
def country(self):
'''
Gets the country of this AccountCreationReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:return: The country of this AccountCreationReq.
:rtype: str
'''
pass
@country.setter
def country(self):
'''
Sets the country of this AccountCreationReq.
The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.
:param country: The country of this AccountCreationReq.
:type: str
'''
pass
@property
def customer_number(self):
'''
Gets the customer_number of this AccountCreationReq.
Customer number of the customer.
:return: The customer_number of this AccountCreationReq.
:rtype: str
'''
pass
@customer_number.setter
def customer_number(self):
'''
Sets the customer_number of this AccountCreationReq.
Customer number of the customer.
:param customer_number: The customer_number of this AccountCreationReq.
:type: str
'''
pass
@property
def display_name(self):
'''
Gets the display_name of this AccountCreationReq.
The display name for the account, not longer than 100 characters.
:return: The display_name of this AccountCreationReq.
:rtype: str
'''
pass
@display_name.setter
def display_name(self):
'''
Sets the display_name of this AccountCreationReq.
The display name for the account, not longer than 100 characters.
:param display_name: The display_name of this AccountCreationReq.
:type: str
'''
pass
@property
def email(self):
'''
Gets the email of this AccountCreationReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:return: The email of this AccountCreationReq.
:rtype: str
'''
pass
@email.setter
def email(self):
'''
Sets the email of this AccountCreationReq.
The company email address for this account, not longer than 254 characters. Required for commercial accounts only.
:param email: The email of this AccountCreationReq.
:type: str
'''
pass
@property
def end_market(self):
'''
Gets the end_market of this AccountCreationReq.
The end market of the account to be created.
:return: The end_market of this AccountCreationReq.
:rtype: str
'''
pass
@end_market.setter
def end_market(self):
'''
Sets the end_market of this AccountCreationReq.
The end market of the account to be created.
:param end_market: The end_market of this AccountCreationReq.
:type: str
'''
pass
@property
def phone_number(self):
'''
Gets the phone_number of this AccountCreationReq.
The phone number of a representative of the company, not longer than 100 characters.
:return: The phone_number of this AccountCreationReq.
:rtype: str
'''
pass
@phone_number.setter
def phone_number(self):
'''
Sets the phone_number of this AccountCreationReq.
The phone number of a representative of the company, not longer than 100 characters.
:param phone_number: The phone_number of this AccountCreationReq.
:type: str
'''
pass
@property
def postal_code(self):
'''
Gets the postal_code of this AccountCreationReq.
The postal code part of the postal address, not longer than 100 characters.
:return: The postal_code of this AccountCreationReq.
:rtype: str
'''
pass
@postal_code.setter
def postal_code(self):
'''
Sets the postal_code of this AccountCreationReq.
The postal code part of the postal address, not longer than 100 characters.
:param postal_code: The postal_code of this AccountCreationReq.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this AccountCreationReq.
The state part of the postal address, not longer than 100 characters.
:return: The state of this AccountCreationReq.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this AccountCreationReq.
The state part of the postal address, not longer than 100 characters.
:param state: The state of this AccountCreationReq.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 83 | 45 | 10 | 1 | 3 | 6 | 1 | 1.22 | 1 | 4 | 0 | 0 | 44 | 20 | 44 | 44 | 575 | 108 | 210 | 108 | 127 | 257 | 122 | 70 | 77 | 5 | 1 | 2 | 50 |
2,423 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/configuration.py
|
mbed_cloud._backends.iam.configuration.Configuration
|
class Configuration(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
"""
def __init__(self):
"""Constructor"""
# Default Base url
self.host = "https://api.us-east-1.mbedcloud.com"
# Temp file folder for downloading files
self.temp_folder_path = None
# Authentication Settings
# dict to store API key(s)
self.api_key = {}
# dict to store API prefix (e.g. Bearer)
self.api_key_prefix = {}
# Username for HTTP basic authentication
self.username = ""
# Password for HTTP basic authentication
self.password = ""
# Logging Settings
self.logger = {}
self.logger["package_logger"] = logging.getLogger("iam")
self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler
self.logger_stream_handler = None
# Log file handler
self.logger_file_handler = None
# Debug file location
self.logger_file = None
# Debug switch
self.debug = False
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True
# Set this to customize the certificate file to verify the peer.
self.ssl_ca_cert = None
# client certificate file
self.cert_file = None
# client key file
self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification.
self.assert_hostname = None
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
# Proxy URL
self.proxy = None
# Safe chars for path_param
self.safe_chars_for_path_param = ''
@property
def logger_file(self):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
return self.__logger_file
@logger_file.setter
def logger_file(self, value):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
self.__logger_file = value
if self.__logger_file:
# If set logging file,
# then add file handler and remove stream handler.
self.logger_file_handler = logging.FileHandler(self.__logger_file)
self.logger_file_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_file_handler)
if self.logger_stream_handler:
logger.removeHandler(self.logger_stream_handler)
else:
# If not set logging file,
# then add stream handler and remove file handler.
self.logger_stream_handler = logging.StreamHandler()
self.logger_stream_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_stream_handler)
if self.logger_file_handler:
logger.removeHandler(self.logger_file_handler)
@property
def debug(self):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
return self.__debug
@debug.setter
def debug(self, value):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
self.__debug = value
if self.__debug:
# if debug status is True, turn on debug logging
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.DEBUG)
# turn on httplib debug
httplib.HTTPConnection.debuglevel = 1
else:
# if debug status is False, turn off debug logging,
# setting log level to default `logging.WARNING`
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.WARNING)
# turn off httplib debug
httplib.HTTPConnection.debuglevel = 0
@property
def logger_format(self):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
return self.__logger_format
@logger_format.setter
def logger_format(self, value):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)
def get_api_key_with_prefix(self, identifier):
"""Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
"""
if (self.api_key.get(identifier) and
self.api_key_prefix.get(identifier)):
return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] # noqa: E501
elif self.api_key.get(identifier):
return self.api_key[identifier]
def get_basic_auth_token(self):
"""Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
"""
return urllib3.util.make_headers(
basic_auth=self.username + ':' + self.password
).get('authorization')
def auth_settings(self):
"""Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
"""
return {
'Bearer':
{
'type': 'api_key',
'in': 'header',
'key': 'Authorization',
'value': self.get_api_key_with_prefix('Authorization')
},
}
def to_debug_report(self):
"""Gets the essential information for debugging.
:return: The report for debugging.
"""
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: v3\n"\
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)
|
class Configuration(object):
'''NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
'''
def __init__(self):
'''Constructor'''
pass
@property
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@logger_file.setter
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@property
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@debug.setter
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@property
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
@logger_format.setter
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
def get_api_key_with_prefix(self, identifier):
'''Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
'''
pass
def get_basic_auth_token(self):
'''Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
'''
pass
def auth_settings(self):
'''Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
'''
pass
def to_debug_report(self):
'''Gets the essential information for debugging.
:return: The report for debugging.
'''
pass
| 18 | 12 | 17 | 2 | 8 | 7 | 2 | 0.92 | 1 | 3 | 0 | 0 | 11 | 21 | 11 | 11 | 208 | 32 | 92 | 41 | 74 | 85 | 67 | 35 | 55 | 6 | 1 | 3 | 21 |
2,424 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/apis/developer_api.py
|
mbed_cloud._backends.iam.apis.developer_api.DeveloperApi
|
class DeveloperApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def add_my_api_key_to_groups(self, body, **kwargs): # noqa: E501
"""Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_my_api_key_to_groups(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.add_my_api_key_to_groups_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.add_my_api_key_to_groups_with_http_info(body, **kwargs) # noqa: E501
return data
def add_my_api_key_to_groups_with_http_info(self, body, **kwargs): # noqa: E501
"""Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_my_api_key_to_groups_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method add_my_api_key_to_groups" % 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 `add_my_api_key_to_groups`") # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/me/groups', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def create_api_key(self, body, **kwargs): # noqa: E501
"""Create a new API key. # noqa: E501
An endpoint for creating a new API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys -d '{\"name\": \"MyKey1\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_api_key(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param ApiKeyInfoReq body: The details of the API key to be created. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.create_api_key_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.create_api_key_with_http_info(body, **kwargs) # noqa: E501
return data
def create_api_key_with_http_info(self, body, **kwargs): # noqa: E501
"""Create a new API key. # noqa: E501
An endpoint for creating a new API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys -d '{\"name\": \"MyKey1\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_api_key_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param ApiKeyInfoReq body: The details of the API key to be created. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_api_key" % 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 `create_api_key`") # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_api_key(self, api_key, **kwargs): # noqa: E501
"""Delete API key. # noqa: E501
An endpoint for deleting the API key. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_api_key(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key 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('asynchronous'):
return self.delete_api_key_with_http_info(api_key, **kwargs) # noqa: E501
else:
(data) = self.delete_api_key_with_http_info(api_key, **kwargs) # noqa: E501
return data
def delete_api_key_with_http_info(self, api_key, **kwargs): # noqa: E501
"""Delete API key. # noqa: E501
An endpoint for deleting the API key. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_api_key_with_http_info(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['api_key'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_api_key" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `delete_api_key`") # noqa: E501
collection_formats = {}
path_params = {}
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/{apiKey}', '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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_certificate(self, cert_id, **kwargs): # noqa: E501
"""Delete a trusted certificate by ID. # noqa: E501
An endpoint for deleting a trusted certificate. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_certificate(cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate 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('asynchronous'):
return self.delete_certificate_with_http_info(cert_id, **kwargs) # noqa: E501
else:
(data) = self.delete_certificate_with_http_info(cert_id, **kwargs) # noqa: E501
return data
def delete_certificate_with_http_info(self, cert_id, **kwargs): # noqa: E501
"""Delete a trusted certificate by ID. # noqa: E501
An endpoint for deleting a trusted certificate. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_certificate_with_http_info(cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['cert_id'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_certificate" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'cert_id' is set
if ('cert_id' not in params or
params['cert_id'] is None):
raise ValueError("Missing the required parameter `cert_id` when calling `delete_certificate`") # noqa: E501
collection_formats = {}
path_params = {}
if 'cert_id' in params:
path_params['cert-id'] = params['cert_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/trusted-certificates/{cert-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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_api_keys(self, **kwargs): # noqa: E501
"""Get all API keys # noqa: E501
An endpoint for retrieving API keys in an array, optionally filtered by the owner. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_api_keys(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str key__eq: API key filter.
:param str owner__eq: Owner name filter.
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_api_keys_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_all_api_keys_with_http_info(**kwargs) # noqa: E501
return data
def get_all_api_keys_with_http_info(self, **kwargs): # noqa: E501
"""Get all API keys # noqa: E501
An endpoint for retrieving API keys in an array, optionally filtered by the owner. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_api_keys_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str key__eq: API key filter.
:param str owner__eq: Owner name filter.
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'after', 'order', 'include', 'key__eq', 'owner__eq'] # noqa: E501
all_params.append('asynchronous')
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_all_api_keys" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'key__eq' in params:
query_params.append(('key__eq', params['key__eq'])) # noqa: E501
if 'owner__eq' in params:
query_params.append(('owner__eq', params['owner__eq'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_certificates(self, **kwargs): # noqa: E501
"""Get all trusted certificates. # noqa: E501
An endpoint for retrieving trusted certificates in an array. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/trusted-certificates -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_certificates(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for certificate name
:param str service__eq: Service filter, either lwm2m or bootstrap
:param int expire__eq: Expire filter in days
:param int device_execution_mode__eq: Device execution mode, as 1 for developer certificates or as another natural integer value
:param int device_execution_mode__neq: Device execution mode not equals filter
:param str owner__eq: Owner name filter
:param bool enrollment_mode__eq: Enrollment mode filter
:param str issuer__like: Issuer filter. Finds all matches where the filter value is a case insensitive substring of the result. Example: issuer__like=cn=iss matches CN=issuer.
:param str subject__like: Subject filter. Finds all matches where the filter value is a case insensitive substring of the result. Example: subject__like=cn=su matches CN=subject.
:return: TrustedCertificateRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_certificates_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_all_certificates_with_http_info(**kwargs) # noqa: E501
return data
def get_all_certificates_with_http_info(self, **kwargs): # noqa: E501
"""Get all trusted certificates. # noqa: E501
An endpoint for retrieving trusted certificates in an array. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/trusted-certificates -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_certificates_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for certificate name
:param str service__eq: Service filter, either lwm2m or bootstrap
:param int expire__eq: Expire filter in days
:param int device_execution_mode__eq: Device execution mode, as 1 for developer certificates or as another natural integer value
:param int device_execution_mode__neq: Device execution mode not equals filter
:param str owner__eq: Owner name filter
:param bool enrollment_mode__eq: Enrollment mode filter
:param str issuer__like: Issuer filter. Finds all matches where the filter value is a case insensitive substring of the result. Example: issuer__like=cn=iss matches CN=issuer.
:param str subject__like: Subject filter. Finds all matches where the filter value is a case insensitive substring of the result. Example: subject__like=cn=su matches CN=subject.
:return: TrustedCertificateRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'after', 'order', 'include', 'name__eq', 'service__eq', 'expire__eq', 'device_execution_mode__eq', 'device_execution_mode__neq', 'owner__eq', 'enrollment_mode__eq', 'issuer__like', 'subject__like'] # noqa: E501
all_params.append('asynchronous')
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_all_certificates" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'name__eq' in params:
query_params.append(('name__eq', params['name__eq'])) # noqa: E501
if 'service__eq' in params:
query_params.append(('service__eq', params['service__eq'])) # noqa: E501
if 'expire__eq' in params:
query_params.append(('expire__eq', params['expire__eq'])) # noqa: E501
if 'device_execution_mode__eq' in params:
query_params.append(('device_execution_mode__eq', params['device_execution_mode__eq'])) # noqa: E501
if 'device_execution_mode__neq' in params:
query_params.append(('device_execution_mode__neq', params['device_execution_mode__neq'])) # noqa: E501
if 'owner__eq' in params:
query_params.append(('owner__eq', params['owner__eq'])) # noqa: E501
if 'enrollment_mode__eq' in params:
query_params.append(('enrollment_mode__eq', params['enrollment_mode__eq'])) # noqa: E501
if 'issuer__like' in params:
query_params.append(('issuer__like', params['issuer__like'])) # noqa: E501
if 'subject__like' in params:
query_params.append(('subject__like', params['subject__like'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/trusted-certificates', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TrustedCertificateRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_groups(self, **kwargs): # noqa: E501
"""Get all group information. # noqa: E501
An endpoint for retrieving all group information. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_groups(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for group name
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_groups_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_all_groups_with_http_info(**kwargs) # noqa: E501
return data
def get_all_groups_with_http_info(self, **kwargs): # noqa: E501
"""Get all group information. # noqa: E501
An endpoint for retrieving all group information. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_groups_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for group name
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'after', 'order', 'include', 'name__eq'] # noqa: E501
all_params.append('asynchronous')
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_all_groups" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'name__eq' in params:
query_params.append(('name__eq', params['name__eq'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/policy-groups', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummaryList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_api_key(self, api_key, **kwargs): # noqa: E501
"""Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_key(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be retrieved. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_api_key_with_http_info(api_key, **kwargs) # noqa: E501
else:
(data) = self.get_api_key_with_http_info(api_key, **kwargs) # noqa: E501
return data
def get_api_key_with_http_info(self, api_key, **kwargs): # noqa: E501
"""Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_key_with_http_info(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be retrieved. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['api_key'] # noqa: E501
all_params.append('asynchronous')
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_api_key" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `get_api_key`") # noqa: E501
collection_formats = {}
path_params = {}
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/{apiKey}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_api_keys_of_group(self, group_id, **kwargs): # noqa: E501
"""Get the API keys of a group. # noqa: E501
An endpoint for listing the API keys of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_keys_of_group(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose API keys are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_api_keys_of_group_with_http_info(group_id, **kwargs) # noqa: E501
else:
(data) = self.get_api_keys_of_group_with_http_info(group_id, **kwargs) # noqa: E501
return data
def get_api_keys_of_group_with_http_info(self, group_id, **kwargs): # noqa: E501
"""Get the API keys of a group. # noqa: E501
An endpoint for listing the API keys of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_keys_of_group_with_http_info(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose API keys are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['group_id', 'limit', 'after', 'order', 'include'] # noqa: E501
all_params.append('asynchronous')
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_api_keys_of_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `get_api_keys_of_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'group_id' in params:
path_params['groupID'] = params['group_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/policy-groups/{groupID}/api-keys', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_certificate(self, cert_id, **kwargs): # noqa: E501
"""Get trusted certificate by ID. # noqa: E501
An endpoint for retrieving a trusted certificate by ID. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_certificate(cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be retrieved. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_certificate_with_http_info(cert_id, **kwargs) # noqa: E501
else:
(data) = self.get_certificate_with_http_info(cert_id, **kwargs) # noqa: E501
return data
def get_certificate_with_http_info(self, cert_id, **kwargs): # noqa: E501
"""Get trusted certificate by ID. # noqa: E501
An endpoint for retrieving a trusted certificate by ID. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_certificate_with_http_info(cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be retrieved. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['cert_id'] # noqa: E501
all_params.append('asynchronous')
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_certificate" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'cert_id' is set
if ('cert_id' not in params or
params['cert_id'] is None):
raise ValueError("Missing the required parameter `cert_id` when calling `get_certificate`") # noqa: E501
collection_formats = {}
path_params = {}
if 'cert_id' in params:
path_params['cert-id'] = params['cert_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/trusted-certificates/{cert-id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TrustedCertificateResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_group_summary(self, group_id, **kwargs): # noqa: E501
"""Get group information. # noqa: E501
An endpoint for getting general information about the group. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_group_summary(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be retrieved. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_group_summary_with_http_info(group_id, **kwargs) # noqa: E501
else:
(data) = self.get_group_summary_with_http_info(group_id, **kwargs) # noqa: E501
return data
def get_group_summary_with_http_info(self, group_id, **kwargs): # noqa: E501
"""Get group information. # noqa: E501
An endpoint for getting general information about the group. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_group_summary_with_http_info(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be retrieved. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['group_id'] # noqa: E501
all_params.append('asynchronous')
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_group_summary" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `get_group_summary`") # noqa: E501
collection_formats = {}
path_params = {}
if 'group_id' in params:
path_params['groupID'] = params['group_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/policy-groups/{groupID}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummary', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_groups_of_my_api_key(self, **kwargs): # noqa: E501
"""Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_my_api_key(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_groups_of_my_api_key_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_groups_of_my_api_key_with_http_info(**kwargs) # noqa: E501
return data
def get_groups_of_my_api_key_with_http_info(self, **kwargs): # noqa: E501
"""Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_my_api_key_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'after', 'order', 'include'] # noqa: E501
all_params.append('asynchronous')
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_groups_of_my_api_key" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/me/groups', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummaryList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_my_account_info(self, **kwargs): # noqa: E501
"""Get account info. # noqa: E501
Returns detailed information about the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/me?include=policies -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_my_account_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts.
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_my_account_info_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_my_account_info_with_http_info(**kwargs) # noqa: E501
return data
def get_my_account_info_with_http_info(self, **kwargs): # noqa: E501
"""Get account info. # noqa: E501
Returns detailed information about the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/me?include=policies -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_my_account_info_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts.
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['include', 'properties'] # noqa: E501
all_params.append('asynchronous')
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_my_account_info" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'properties' in params:
query_params.append(('properties', params['properties'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/me', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AccountInfo', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_my_api_key(self, **kwargs): # noqa: E501
"""Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/me -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_my_api_key(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_my_api_key_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_my_api_key_with_http_info(**kwargs) # noqa: E501
return data
def get_my_api_key_with_http_info(self, **kwargs): # noqa: E501
"""Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/me -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_my_api_key_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('asynchronous')
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_my_api_key" % 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/me', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def remove_api_keys_from_group(self, group_id, body, **kwargs): # noqa: E501
"""Remove API keys from a group. # noqa: E501
An endpoint for removing API keys from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/api-keys -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_keys_from_group(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose API keys are removed. (required)
:param SubjectList body: A list of API keys to be removed from the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.remove_api_keys_from_group_with_http_info(group_id, body, **kwargs) # noqa: E501
else:
(data) = self.remove_api_keys_from_group_with_http_info(group_id, body, **kwargs) # noqa: E501
return data
def remove_api_keys_from_group_with_http_info(self, group_id, body, **kwargs): # noqa: E501
"""Remove API keys from a group. # noqa: E501
An endpoint for removing API keys from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/api-keys -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_keys_from_group_with_http_info(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose API keys are removed. (required)
:param SubjectList body: A list of API keys to be removed from the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['group_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method remove_api_keys_from_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `remove_api_keys_from_group`") # 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 `remove_api_keys_from_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'group_id' in params:
path_params['groupID'] = params['group_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/policy-groups/{groupID}/api-keys', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def remove_my_api_key_from_groups(self, body, **kwargs): # noqa: E501
"""Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_my_api_key_from_groups(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.remove_my_api_key_from_groups_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.remove_my_api_key_from_groups_with_http_info(body, **kwargs) # noqa: E501
return data
def remove_my_api_key_from_groups_with_http_info(self, body, **kwargs): # noqa: E501
"""Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_my_api_key_from_groups_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method remove_my_api_key_from_groups" % 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 `remove_my_api_key_from_groups`") # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/me/groups', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_api_key(self, api_key, body, **kwargs): # noqa: E501
"""Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -d '{\"name\": \"TestApiKey25\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_api_key(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be updated. (required)
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_api_key_with_http_info(api_key, body, **kwargs) # noqa: E501
else:
(data) = self.update_api_key_with_http_info(api_key, body, **kwargs) # noqa: E501
return data
def update_api_key_with_http_info(self, api_key, body, **kwargs): # noqa: E501
"""Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -d '{\"name\": \"TestApiKey25\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_api_key_with_http_info(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be updated. (required)
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['api_key', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_api_key" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `update_api_key`") # 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 `update_api_key`") # noqa: E501
collection_formats = {}
path_params = {}
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/{apiKey}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_certificate(self, cert_id, body, **kwargs): # noqa: E501
"""Update trusted certificate. # noqa: E501
An endpoint for updating existing trusted certificates. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -d {\"description\": \"very important cert\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_certificate(cert_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be updated. (required)
:param TrustedCertificateUpdateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_certificate_with_http_info(cert_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_certificate_with_http_info(cert_id, body, **kwargs) # noqa: E501
return data
def update_certificate_with_http_info(self, cert_id, body, **kwargs): # noqa: E501
"""Update trusted certificate. # noqa: E501
An endpoint for updating existing trusted certificates. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -d {\"description\": \"very important cert\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_certificate_with_http_info(cert_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be updated. (required)
:param TrustedCertificateUpdateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['cert_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_certificate" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'cert_id' is set
if ('cert_id' not in params or
params['cert_id'] is None):
raise ValueError("Missing the required parameter `cert_id` when calling `update_certificate`") # 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 `update_certificate`") # noqa: E501
collection_formats = {}
path_params = {}
if 'cert_id' in params:
path_params['cert-id'] = params['cert_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/trusted-certificates/{cert-id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TrustedCertificateResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_my_api_key(self, body, **kwargs): # noqa: E501
"""Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/api-keys/me -d '{\"name\": \"TestApiKey25\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_my_api_key(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_my_api_key_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.update_my_api_key_with_http_info(body, **kwargs) # noqa: E501
return data
def update_my_api_key_with_http_info(self, body, **kwargs): # noqa: E501
"""Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/api-keys/me -d '{\"name\": \"TestApiKey25\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_my_api_key_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_my_api_key" % 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 `update_my_api_key`") # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/me', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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)
|
class DeveloperApi(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):
pass
def add_my_api_key_to_groups(self, body, **kwargs):
'''Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_my_api_key_to_groups(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_my_api_key_to_groups_with_http_info(self, body, **kwargs):
'''Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_my_api_key_to_groups_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_api_key(self, body, **kwargs):
'''Create a new API key. # noqa: E501
An endpoint for creating a new API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys -d '{"name": "MyKey1"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_api_key(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param ApiKeyInfoReq body: The details of the API key to be created. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_api_key_with_http_info(self, body, **kwargs):
'''Create a new API key. # noqa: E501
An endpoint for creating a new API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys -d '{"name": "MyKey1"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_api_key_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param ApiKeyInfoReq body: The details of the API key to be created. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_api_key(self, api_key, **kwargs):
'''Delete API key. # noqa: E501
An endpoint for deleting the API key. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_api_key(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_api_key_with_http_info(self, api_key, **kwargs):
'''Delete API key. # noqa: E501
An endpoint for deleting the API key. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_api_key_with_http_info(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_certificate(self, cert_id, **kwargs):
'''Delete a trusted certificate by ID. # noqa: E501
An endpoint for deleting a trusted certificate. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_certificate(cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_certificate_with_http_info(self, cert_id, **kwargs):
'''Delete a trusted certificate by ID. # noqa: E501
An endpoint for deleting a trusted certificate. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_certificate_with_http_info(cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_api_keys(self, **kwargs):
'''Get all API keys # noqa: E501
An endpoint for retrieving API keys in an array, optionally filtered by the owner. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_api_keys(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str key__eq: API key filter.
:param str owner__eq: Owner name filter.
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_api_keys_with_http_info(self, **kwargs):
'''Get all API keys # noqa: E501
An endpoint for retrieving API keys in an array, optionally filtered by the owner. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_api_keys_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str key__eq: API key filter.
:param str owner__eq: Owner name filter.
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_certificates(self, **kwargs):
'''Get all trusted certificates. # noqa: E501
An endpoint for retrieving trusted certificates in an array. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/trusted-certificates -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_certificates(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for certificate name
:param str service__eq: Service filter, either lwm2m or bootstrap
:param int expire__eq: Expire filter in days
:param int device_execution_mode__eq: Device execution mode, as 1 for developer certificates or as another natural integer value
:param int device_execution_mode__neq: Device execution mode not equals filter
:param str owner__eq: Owner name filter
:param bool enrollment_mode__eq: Enrollment mode filter
:param str issuer__like: Issuer filter. Finds all matches where the filter value is a case insensitive substring of the result. Example: issuer__like=cn=iss matches CN=issuer.
:param str subject__like: Subject filter. Finds all matches where the filter value is a case insensitive substring of the result. Example: subject__like=cn=su matches CN=subject.
:return: TrustedCertificateRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_certificates_with_http_info(self, **kwargs):
'''Get all trusted certificates. # noqa: E501
An endpoint for retrieving trusted certificates in an array. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/trusted-certificates -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_certificates_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for certificate name
:param str service__eq: Service filter, either lwm2m or bootstrap
:param int expire__eq: Expire filter in days
:param int device_execution_mode__eq: Device execution mode, as 1 for developer certificates or as another natural integer value
:param int device_execution_mode__neq: Device execution mode not equals filter
:param str owner__eq: Owner name filter
:param bool enrollment_mode__eq: Enrollment mode filter
:param str issuer__like: Issuer filter. Finds all matches where the filter value is a case insensitive substring of the result. Example: issuer__like=cn=iss matches CN=issuer.
:param str subject__like: Subject filter. Finds all matches where the filter value is a case insensitive substring of the result. Example: subject__like=cn=su matches CN=subject.
:return: TrustedCertificateRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_groups(self, **kwargs):
'''Get all group information. # noqa: E501
An endpoint for retrieving all group information. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_groups(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for group name
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_groups_with_http_info(self, **kwargs):
'''Get all group information. # noqa: E501
An endpoint for retrieving all group information. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_groups_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for group name
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_api_key(self, api_key, **kwargs):
'''Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_key(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be retrieved. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_api_key_with_http_info(self, api_key, **kwargs):
'''Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_key_with_http_info(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be retrieved. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_api_keys_of_group(self, group_id, **kwargs):
'''Get the API keys of a group. # noqa: E501
An endpoint for listing the API keys of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_keys_of_group(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose API keys are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_api_keys_of_group_with_http_info(self, group_id, **kwargs):
'''Get the API keys of a group. # noqa: E501
An endpoint for listing the API keys of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_keys_of_group_with_http_info(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose API keys are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_certificate(self, cert_id, **kwargs):
'''Get trusted certificate by ID. # noqa: E501
An endpoint for retrieving a trusted certificate by ID. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_certificate(cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be retrieved. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_certificate_with_http_info(self, cert_id, **kwargs):
'''Get trusted certificate by ID. # noqa: E501
An endpoint for retrieving a trusted certificate by ID. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_certificate_with_http_info(cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be retrieved. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_group_summary(self, group_id, **kwargs):
'''Get group information. # noqa: E501
An endpoint for getting general information about the group. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_group_summary(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be retrieved. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_group_summary_with_http_info(self, group_id, **kwargs):
'''Get group information. # noqa: E501
An endpoint for getting general information about the group. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_group_summary_with_http_info(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be retrieved. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_groups_of_my_api_key(self, **kwargs):
'''Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_my_api_key(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_groups_of_my_api_key_with_http_info(self, **kwargs):
'''Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_my_api_key_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_my_account_info(self, **kwargs):
'''Get account info. # noqa: E501
Returns detailed information about the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/me?include=policies -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_my_account_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts.
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_my_account_info_with_http_info(self, **kwargs):
'''Get account info. # noqa: E501
Returns detailed information about the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/me?include=policies -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_my_account_info_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts.
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_my_api_key(self, **kwargs):
'''Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/me -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_my_api_key(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_my_api_key_with_http_info(self, **kwargs):
'''Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/me -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_my_api_key_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_api_keys_from_group(self, group_id, body, **kwargs):
'''Remove API keys from a group. # noqa: E501
An endpoint for removing API keys from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/api-keys -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_keys_from_group(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose API keys are removed. (required)
:param SubjectList body: A list of API keys to be removed from the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_api_keys_from_group_with_http_info(self, group_id, body, **kwargs):
'''Remove API keys from a group. # noqa: E501
An endpoint for removing API keys from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/api-keys -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_keys_from_group_with_http_info(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose API keys are removed. (required)
:param SubjectList body: A list of API keys to be removed from the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_my_api_key_from_groups(self, body, **kwargs):
'''Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_my_api_key_from_groups(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_my_api_key_from_groups_with_http_info(self, body, **kwargs):
'''Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/me/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_my_api_key_from_groups_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_api_key(self, api_key, body, **kwargs):
'''Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -d '{"name": "TestApiKey25"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_api_key(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be updated. (required)
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_api_key_with_http_info(self, api_key, body, **kwargs):
'''Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id} -d '{"name": "TestApiKey25"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_api_key_with_http_info(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be updated. (required)
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_certificate(self, cert_id, body, **kwargs):
'''Update trusted certificate. # noqa: E501
An endpoint for updating existing trusted certificates. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -d {"description": "very important cert"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_certificate(cert_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be updated. (required)
:param TrustedCertificateUpdateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_certificate_with_http_info(self, cert_id, body, **kwargs):
'''Update trusted certificate. # noqa: E501
An endpoint for updating existing trusted certificates. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/trusted-certificates/{cert-id} -d {"description": "very important cert"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_certificate_with_http_info(cert_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str cert_id: The ID of the trusted certificate to be updated. (required)
:param TrustedCertificateUpdateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_my_api_key(self, body, **kwargs):
'''Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/api-keys/me -d '{"name": "TestApiKey25"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_my_api_key(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_my_api_key_with_http_info(self, body, **kwargs):
'''Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/api-keys/me -d '{"name": "TestApiKey25"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_my_api_key_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
| 40 | 39 | 49 | 7 | 27 | 20 | 4 | 0.76 | 1 | 3 | 1 | 0 | 39 | 1 | 39 | 39 | 1,948 | 311 | 1,056 | 269 | 1,016 | 802 | 674 | 269 | 634 | 16 | 1 | 2 | 163 |
2,425 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_group_page.py
|
mbed_cloud._backends.device_directory.models.device_group_page.DeviceGroupPage
|
class DeviceGroupPage(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 = {
'after': 'str',
'data': 'list[DeviceGroup]',
'has_more': 'bool',
'limit': 'int',
'object': 'str',
'order': 'str',
'total_count': 'int'
}
attribute_map = {
'after': 'after',
'data': 'data',
'has_more': 'has_more',
'limit': 'limit',
'object': 'object',
'order': 'order',
'total_count': 'total_count'
}
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
"""
DeviceGroupPage - a model defined in Swagger
"""
self._after = after
self._data = data
self._has_more = has_more
self._limit = limit
self._object = object
self._order = order
self._total_count = total_count
self.discriminator = None
@property
def after(self):
"""
Gets the after of this DeviceGroupPage.
An offset token for current page.
:return: The after of this DeviceGroupPage.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this DeviceGroupPage.
An offset token for current page.
:param after: The after of this DeviceGroupPage.
:type: str
"""
self._after = after
@property
def data(self):
"""
Gets the data of this DeviceGroupPage.
:return: The data of this DeviceGroupPage.
:rtype: list[DeviceGroup]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this DeviceGroupPage.
:param data: The data of this DeviceGroupPage.
:type: list[DeviceGroup]
"""
self._data = data
@property
def has_more(self):
"""
Gets the has_more of this DeviceGroupPage.
Are there more results available.
:return: The has_more of this DeviceGroupPage.
:rtype: bool
"""
return self._has_more
@has_more.setter
def has_more(self, has_more):
"""
Sets the has_more of this DeviceGroupPage.
Are there more results available.
:param has_more: The has_more of this DeviceGroupPage.
:type: bool
"""
self._has_more = has_more
@property
def limit(self):
"""
Gets the limit of this DeviceGroupPage.
The value of limit query parameter from the request, or default if not specified.
:return: The limit of this DeviceGroupPage.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this DeviceGroupPage.
The value of limit query parameter from the request, or default if not specified.
:param limit: The limit of this DeviceGroupPage.
:type: int
"""
self._limit = limit
@property
def object(self):
"""
Gets the object of this DeviceGroupPage.
The type of this API object is a \"list\".
:return: The object of this DeviceGroupPage.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DeviceGroupPage.
The type of this API object is a \"list\".
:param object: The object of this DeviceGroupPage.
:type: str
"""
self._object = object
@property
def order(self):
"""
Gets the order of this DeviceGroupPage.
The creation time based order of the entries.
:return: The order of this DeviceGroupPage.
:rtype: str
"""
return self._order
@order.setter
def order(self, order):
"""
Sets the order of this DeviceGroupPage.
The creation time based order of the entries.
:param order: The order of this DeviceGroupPage.
:type: str
"""
self._order = order
@property
def total_count(self):
"""
Gets the total_count of this DeviceGroupPage.
:return: The total_count of this DeviceGroupPage.
:rtype: int
"""
return self._total_count
@total_count.setter
def total_count(self, total_count):
"""
Sets the total_count of this DeviceGroupPage.
:param total_count: The total_count of this DeviceGroupPage.
:type: int
"""
self._total_count = total_count
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceGroupPage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceGroupPage(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
'''
DeviceGroupPage - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this DeviceGroupPage.
An offset token for current page.
:return: The after of this DeviceGroupPage.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this DeviceGroupPage.
An offset token for current page.
:param after: The after of this DeviceGroupPage.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this DeviceGroupPage.
:return: The data of this DeviceGroupPage.
:rtype: list[DeviceGroup]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this DeviceGroupPage.
:param data: The data of this DeviceGroupPage.
:type: list[DeviceGroup]
'''
pass
@property
def has_more(self):
'''
Gets the has_more of this DeviceGroupPage.
Are there more results available.
:return: The has_more of this DeviceGroupPage.
:rtype: bool
'''
pass
@has_more.setter
def has_more(self):
'''
Sets the has_more of this DeviceGroupPage.
Are there more results available.
:param has_more: The has_more of this DeviceGroupPage.
:type: bool
'''
pass
@property
def limit(self):
'''
Gets the limit of this DeviceGroupPage.
The value of limit query parameter from the request, or default if not specified.
:return: The limit of this DeviceGroupPage.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this DeviceGroupPage.
The value of limit query parameter from the request, or default if not specified.
:param limit: The limit of this DeviceGroupPage.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this DeviceGroupPage.
The type of this API object is a "list".
:return: The object of this DeviceGroupPage.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DeviceGroupPage.
The type of this API object is a "list".
:param object: The object of this DeviceGroupPage.
:type: str
'''
pass
@property
def order(self):
'''
Gets the order of this DeviceGroupPage.
The creation time based order of the entries.
:return: The order of this DeviceGroupPage.
:rtype: str
'''
pass
@order.setter
def order(self):
'''
Sets the order of this DeviceGroupPage.
The creation time based order of the entries.
:param order: The order of this DeviceGroupPage.
:type: str
'''
pass
@property
def total_count(self):
'''
Gets the total_count of this DeviceGroupPage.
:return: The total_count of this DeviceGroupPage.
:rtype: int
'''
pass
@total_count.setter
def total_count(self):
'''
Sets the total_count of this DeviceGroupPage.
:param total_count: The total_count of this DeviceGroupPage.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 35 | 21 | 10 | 1 | 3 | 5 | 1 | 1.09 | 1 | 3 | 0 | 0 | 20 | 8 | 20 | 20 | 257 | 48 | 100 | 48 | 65 | 109 | 60 | 34 | 39 | 5 | 1 | 2 | 25 |
2,426 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/apis/aggregator_account_admin_api.py
|
mbed_cloud._backends.iam.apis.aggregator_account_admin_api.AggregatorAccountAdminApi
|
class AggregatorAccountAdminApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def add_account_api_key_to_groups(self, account_id, api_key, body, **kwargs): # noqa: E501
"""Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apikey}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_api_key_to_groups(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.add_account_api_key_to_groups_with_http_info(account_id, api_key, body, **kwargs) # noqa: E501
else:
(data) = self.add_account_api_key_to_groups_with_http_info(account_id, api_key, body, **kwargs) # noqa: E501
return data
def add_account_api_key_to_groups_with_http_info(self, account_id, api_key, body, **kwargs): # noqa: E501
"""Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apikey}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_api_key_to_groups_with_http_info(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'api_key', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method add_account_api_key_to_groups" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `add_account_api_key_to_groups`") # noqa: E501
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `add_account_api_key_to_groups`") # 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 `add_account_api_key_to_groups`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/api-keys/{apiKey}/groups', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 add_account_certificate(self, account_id, body, **kwargs): # noqa: E501
"""Upload new trusted certificate. # noqa: E501
An endpoint for uploading new trusted certificates. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates -d {\"name\": \"myCert1\", \"description\": \"very important cert\", \"certificate\": \"certificate_data\", \"service\": \"lwm2m\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_certificate(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param TrustedCertificateRootReq body: A trusted certificate object with attributes, signature is optional. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.add_account_certificate_with_http_info(account_id, body, **kwargs) # noqa: E501
else:
(data) = self.add_account_certificate_with_http_info(account_id, body, **kwargs) # noqa: E501
return data
def add_account_certificate_with_http_info(self, account_id, body, **kwargs): # noqa: E501
"""Upload new trusted certificate. # noqa: E501
An endpoint for uploading new trusted certificates. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates -d {\"name\": \"myCert1\", \"description\": \"very important cert\", \"certificate\": \"certificate_data\", \"service\": \"lwm2m\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_certificate_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param TrustedCertificateRootReq body: A trusted certificate object with attributes, signature is optional. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method add_account_certificate" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `add_account_certificate`") # 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 `add_account_certificate`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/trusted-certificates', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TrustedCertificateResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 add_account_user_to_groups(self, account_id, user_id, body, **kwargs): # noqa: E501
"""Add user to a list of groups. # noqa: E501
An endpoint for adding user to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_user_to_groups(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.add_account_user_to_groups_with_http_info(account_id, user_id, body, **kwargs) # noqa: E501
else:
(data) = self.add_account_user_to_groups_with_http_info(account_id, user_id, body, **kwargs) # noqa: E501
return data
def add_account_user_to_groups_with_http_info(self, account_id, user_id, body, **kwargs): # noqa: E501
"""Add user to a list of groups. # noqa: E501
An endpoint for adding user to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_user_to_groups_with_http_info(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'user_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method add_account_user_to_groups" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `add_account_user_to_groups`") # noqa: E501
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `add_account_user_to_groups`") # 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 `add_account_user_to_groups`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'user_id' in params:
path_params['user-id'] = params['user_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/users/{user-id}/groups', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 add_subjects_to_account_group(self, account_id, group_id, body, **kwargs): # noqa: E501
"""Add members to a group. # noqa: E501
An endpoint for adding users and API keys to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -d '{\"users\": [0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_subjects_to_account_group(account_id, group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be updated. (required)
:param SubjectList body: A list of users and API keys to be added to the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.add_subjects_to_account_group_with_http_info(account_id, group_id, body, **kwargs) # noqa: E501
else:
(data) = self.add_subjects_to_account_group_with_http_info(account_id, group_id, body, **kwargs) # noqa: E501
return data
def add_subjects_to_account_group_with_http_info(self, account_id, group_id, body, **kwargs): # noqa: E501
"""Add members to a group. # noqa: E501
An endpoint for adding users and API keys to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -d '{\"users\": [0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_subjects_to_account_group_with_http_info(account_id, group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be updated. (required)
:param SubjectList body: A list of users and API keys to be added to the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'group_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method add_subjects_to_account_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `add_subjects_to_account_group`") # noqa: E501
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `add_subjects_to_account_group`") # 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 `add_subjects_to_account_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'group_id' in params:
path_params['groupID'] = params['group_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/policy-groups/{groupID}', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 check_account_api_key(self, account_id, api_key, **kwargs): # noqa: E501
"""Check the API key. # noqa: E501
An endpoint for checking API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.check_account_api_key(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The API key to be checked. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.check_account_api_key_with_http_info(account_id, api_key, **kwargs) # noqa: E501
else:
(data) = self.check_account_api_key_with_http_info(account_id, api_key, **kwargs) # noqa: E501
return data
def check_account_api_key_with_http_info(self, account_id, api_key, **kwargs): # noqa: E501
"""Check the API key. # noqa: E501
An endpoint for checking API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.check_account_api_key_with_http_info(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The API key to be checked. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'api_key'] # noqa: E501
all_params.append('asynchronous')
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 check_account_api_key" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `check_account_api_key`") # noqa: E501
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `check_account_api_key`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/api-keys/{apiKey}', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def create_account(self, body, **kwargs): # noqa: E501
"""Create a new account. # noqa: E501
An endpoint for creating a new account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts -d '{\"display_name\": \"MyAccount1\", \"admin_name\": \"accountAdmin1\", \"email\": \"[email protected]\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param AccountCreationReq body: Details of the account to be created. (required)
:param str action: Action, either 'create' or 'enroll'. <ul><li>'create' creates the account where its admin user has ACTIVE status if admin_password was defined in the request, or RESET status if no admin_password was defined. If the user already exists, its status is not modified. </li><li>'enroll' creates the account where its admin user has ENROLLING status. If the user already exists, its status is not modified. Email to finish the enrollment or to notify the existing user about the new account is sent to the admin_email defined in the request. </li></ul>
:return: AccountCreationResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.create_account_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.create_account_with_http_info(body, **kwargs) # noqa: E501
return data
def create_account_with_http_info(self, body, **kwargs): # noqa: E501
"""Create a new account. # noqa: E501
An endpoint for creating a new account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts -d '{\"display_name\": \"MyAccount1\", \"admin_name\": \"accountAdmin1\", \"email\": \"[email protected]\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param AccountCreationReq body: Details of the account to be created. (required)
:param str action: Action, either 'create' or 'enroll'. <ul><li>'create' creates the account where its admin user has ACTIVE status if admin_password was defined in the request, or RESET status if no admin_password was defined. If the user already exists, its status is not modified. </li><li>'enroll' creates the account where its admin user has ENROLLING status. If the user already exists, its status is not modified. Email to finish the enrollment or to notify the existing user about the new account is sent to the admin_email defined in the request. </li></ul>
:return: AccountCreationResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body', 'action'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_account" % 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 `create_account`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'action' in params:
query_params.append(('action', params['action'])) # noqa: E501
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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AccountCreationResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def create_account_api_key(self, account_id, body, **kwargs): # noqa: E501
"""Create a new API key. # noqa: E501
An endpoint for creating a new API key. There is no default value for the owner ID and it must be from the same account where the new API key is created. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys -d '{\"name\": \"MyKey1\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_api_key(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param ApiKeyInfoReq body: Details of the API key to be created. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.create_account_api_key_with_http_info(account_id, body, **kwargs) # noqa: E501
else:
(data) = self.create_account_api_key_with_http_info(account_id, body, **kwargs) # noqa: E501
return data
def create_account_api_key_with_http_info(self, account_id, body, **kwargs): # noqa: E501
"""Create a new API key. # noqa: E501
An endpoint for creating a new API key. There is no default value for the owner ID and it must be from the same account where the new API key is created. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys -d '{\"name\": \"MyKey1\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_api_key_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param ApiKeyInfoReq body: Details of the API key to be created. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_account_api_key" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `create_account_api_key`") # 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 `create_account_api_key`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/api-keys', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def create_account_group(self, account_id, body, **kwargs): # noqa: E501
"""Create a new group. # noqa: E501
An endpoint for creating a new group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups -d '{\"name\": \"MyGroup1\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_group(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param GroupCreationInfo body: Details of the group to be created. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.create_account_group_with_http_info(account_id, body, **kwargs) # noqa: E501
else:
(data) = self.create_account_group_with_http_info(account_id, body, **kwargs) # noqa: E501
return data
def create_account_group_with_http_info(self, account_id, body, **kwargs): # noqa: E501
"""Create a new group. # noqa: E501
An endpoint for creating a new group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups -d '{\"name\": \"MyGroup1\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_group_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param GroupCreationInfo body: Details of the group to be created. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_account_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `create_account_group`") # 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 `create_account_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/policy-groups', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummary', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def create_account_invitation(self, account_id, body, **kwargs): # noqa: E501
"""Create a user invitation. # noqa: E501
An endpoint for inviting a new or an existing user to join the account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accouns/{account-id}/user-invitations -d {\"email\": \"[email protected]\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_invitation(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param UserInvitationReq body: A user invitation object with attributes. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.create_account_invitation_with_http_info(account_id, body, **kwargs) # noqa: E501
else:
(data) = self.create_account_invitation_with_http_info(account_id, body, **kwargs) # noqa: E501
return data
def create_account_invitation_with_http_info(self, account_id, body, **kwargs): # noqa: E501
"""Create a user invitation. # noqa: E501
An endpoint for inviting a new or an existing user to join the account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accouns/{account-id}/user-invitations -d {\"email\": \"[email protected]\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_invitation_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param UserInvitationReq body: A user invitation object with attributes. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_account_invitation" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `create_account_invitation`") # 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 `create_account_invitation`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['account-id'] = params['account_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{account-id}/user-invitations', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInvitationResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def create_account_user(self, account_id, body, **kwargs): # noqa: E501
"""Create a new user. # noqa: E501
An endpoint for creating or inviting a new user to the account. In case of invitation email address is used only, other attributes are set in the 2nd step. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users -d {\"email\": \"[email protected]\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_user(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param UserInfoReq body: A user object with attributes. (required)
:param str action: Create or invite user.
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.create_account_user_with_http_info(account_id, body, **kwargs) # noqa: E501
else:
(data) = self.create_account_user_with_http_info(account_id, body, **kwargs) # noqa: E501
return data
def create_account_user_with_http_info(self, account_id, body, **kwargs): # noqa: E501
"""Create a new user. # noqa: E501
An endpoint for creating or inviting a new user to the account. In case of invitation email address is used only, other attributes are set in the 2nd step. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users -d {\"email\": \"[email protected]\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_user_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param UserInfoReq body: A user object with attributes. (required)
:param str action: Create or invite user.
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'body', 'action'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_account_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `create_account_user`") # 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 `create_account_user`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
query_params = []
if 'action' in params:
query_params.append(('action', params['action'])) # noqa: E501
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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/users', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_account_api_key(self, account_id, api_key, **kwargs): # noqa: E501
"""Delete the API key. # noqa: E501
An endpoint for deleting an API key. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apikey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_api_key(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key 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('asynchronous'):
return self.delete_account_api_key_with_http_info(account_id, api_key, **kwargs) # noqa: E501
else:
(data) = self.delete_account_api_key_with_http_info(account_id, api_key, **kwargs) # noqa: E501
return data
def delete_account_api_key_with_http_info(self, account_id, api_key, **kwargs): # noqa: E501
"""Delete the API key. # noqa: E501
An endpoint for deleting an API key. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apikey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_api_key_with_http_info(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'api_key'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_account_api_key" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `delete_account_api_key`") # noqa: E501
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `delete_account_api_key`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/api-keys/{apiKey}', '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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_account_certificate(self, account_id, cert_id, **kwargs): # noqa: E501
"""Delete trusted certificate by ID. # noqa: E501
An endpoint for deleting the trusted certificate. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_certificate(account_id, cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate 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('asynchronous'):
return self.delete_account_certificate_with_http_info(account_id, cert_id, **kwargs) # noqa: E501
else:
(data) = self.delete_account_certificate_with_http_info(account_id, cert_id, **kwargs) # noqa: E501
return data
def delete_account_certificate_with_http_info(self, account_id, cert_id, **kwargs): # noqa: E501
"""Delete trusted certificate by ID. # noqa: E501
An endpoint for deleting the trusted certificate. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_certificate_with_http_info(account_id, cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'cert_id'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_account_certificate" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `delete_account_certificate`") # noqa: E501
# verify the required parameter 'cert_id' is set
if ('cert_id' not in params or
params['cert_id'] is None):
raise ValueError("Missing the required parameter `cert_id` when calling `delete_account_certificate`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'cert_id' in params:
path_params['cert-id'] = params['cert_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/trusted-certificates/{cert-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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_account_group(self, account_id, group_id, **kwargs): # noqa: E501
"""Delete a group. # noqa: E501
An endpoint for deleting a group. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_group(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group 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('asynchronous'):
return self.delete_account_group_with_http_info(account_id, group_id, **kwargs) # noqa: E501
else:
(data) = self.delete_account_group_with_http_info(account_id, group_id, **kwargs) # noqa: E501
return data
def delete_account_group_with_http_info(self, account_id, group_id, **kwargs): # noqa: E501
"""Delete a group. # noqa: E501
An endpoint for deleting a group. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_group_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'group_id'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_account_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `delete_account_group`") # noqa: E501
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `delete_account_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'group_id' in params:
path_params['groupID'] = params['group_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/policy-groups/{groupID}', '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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_account_invitation(self, account_id, invitation_id, **kwargs): # noqa: E501
"""Delete a user invitation. # noqa: E501
An endpoint for deleting an active user invitation which has been sent for a new or an existing user to join the account. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_invitation(account_id, invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str invitation_id: The ID of the invitation 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('asynchronous'):
return self.delete_account_invitation_with_http_info(account_id, invitation_id, **kwargs) # noqa: E501
else:
(data) = self.delete_account_invitation_with_http_info(account_id, invitation_id, **kwargs) # noqa: E501
return data
def delete_account_invitation_with_http_info(self, account_id, invitation_id, **kwargs): # noqa: E501
"""Delete a user invitation. # noqa: E501
An endpoint for deleting an active user invitation which has been sent for a new or an existing user to join the account. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_invitation_with_http_info(account_id, invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str invitation_id: The ID of the invitation to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'invitation_id'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_account_invitation" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `delete_account_invitation`") # noqa: E501
# verify the required parameter 'invitation_id' is set
if ('invitation_id' not in params or
params['invitation_id'] is None):
raise ValueError("Missing the required parameter `invitation_id` when calling `delete_account_invitation`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['account-id'] = params['account_id'] # noqa: E501
if 'invitation_id' in params:
path_params['invitation-id'] = params['invitation_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{account-id}/user-invitations/{invitation-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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_account_user(self, account_id, user_id, **kwargs): # noqa: E501
"""Delete a user. # noqa: E501
An endpoint for deleting a user. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_user(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user 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('asynchronous'):
return self.delete_account_user_with_http_info(account_id, user_id, **kwargs) # noqa: E501
else:
(data) = self.delete_account_user_with_http_info(account_id, user_id, **kwargs) # noqa: E501
return data
def delete_account_user_with_http_info(self, account_id, user_id, **kwargs): # noqa: E501
"""Delete a user. # noqa: E501
An endpoint for deleting a user. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_user_with_http_info(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'user_id'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_account_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `delete_account_user`") # noqa: E501
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `delete_account_user`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'user_id' in params:
path_params['user-id'] = params['user_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/users/{user-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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_account_api_key(self, account_id, api_key, **kwargs): # noqa: E501
"""Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_api_key(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be retrieved. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_account_api_key_with_http_info(account_id, api_key, **kwargs) # noqa: E501
else:
(data) = self.get_account_api_key_with_http_info(account_id, api_key, **kwargs) # noqa: E501
return data
def get_account_api_key_with_http_info(self, account_id, api_key, **kwargs): # noqa: E501
"""Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_api_key_with_http_info(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be retrieved. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'api_key'] # noqa: E501
all_params.append('asynchronous')
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_account_api_key" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_account_api_key`") # noqa: E501
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `get_account_api_key`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/api-keys/{apiKey}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_account_certificate(self, account_id, cert_id, **kwargs): # noqa: E501
"""Get trusted certificate by ID. # noqa: E501
An endpoint for retrieving a trusted certificate by ID. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_certificate(account_id, cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be retrieved. (required)
:return: TrustedCertificateInternalResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_account_certificate_with_http_info(account_id, cert_id, **kwargs) # noqa: E501
else:
(data) = self.get_account_certificate_with_http_info(account_id, cert_id, **kwargs) # noqa: E501
return data
def get_account_certificate_with_http_info(self, account_id, cert_id, **kwargs): # noqa: E501
"""Get trusted certificate by ID. # noqa: E501
An endpoint for retrieving a trusted certificate by ID. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_certificate_with_http_info(account_id, cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be retrieved. (required)
:return: TrustedCertificateInternalResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'cert_id'] # noqa: E501
all_params.append('asynchronous')
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_account_certificate" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_account_certificate`") # noqa: E501
# verify the required parameter 'cert_id' is set
if ('cert_id' not in params or
params['cert_id'] is None):
raise ValueError("Missing the required parameter `cert_id` when calling `get_account_certificate`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'cert_id' in params:
path_params['cert-id'] = params['cert_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/trusted-certificates/{cert-id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TrustedCertificateInternalResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_account_group_summary(self, account_id, group_id, **kwargs): # noqa: E501
"""Get group information. # noqa: E501
An endpoint for getting general information about the group. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_group_summary(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be retrieved. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_account_group_summary_with_http_info(account_id, group_id, **kwargs) # noqa: E501
else:
(data) = self.get_account_group_summary_with_http_info(account_id, group_id, **kwargs) # noqa: E501
return data
def get_account_group_summary_with_http_info(self, account_id, group_id, **kwargs): # noqa: E501
"""Get group information. # noqa: E501
An endpoint for getting general information about the group. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_group_summary_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be retrieved. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'group_id'] # noqa: E501
all_params.append('asynchronous')
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_account_group_summary" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_account_group_summary`") # noqa: E501
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `get_account_group_summary`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'group_id' in params:
path_params['groupID'] = params['group_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/policy-groups/{groupID}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummary', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_account_info(self, account_id, **kwargs): # noqa: E501
"""Get account info. # noqa: E501
Returns detailed information about the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id} -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: The ID of the account to be fetched. (required)
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_account_info_with_http_info(account_id, **kwargs) # noqa: E501
else:
(data) = self.get_account_info_with_http_info(account_id, **kwargs) # noqa: E501
return data
def get_account_info_with_http_info(self, account_id, **kwargs): # noqa: E501
"""Get account info. # noqa: E501
Returns detailed information about the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id} -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_info_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: The ID of the account to be fetched. (required)
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'include', 'properties'] # noqa: E501
all_params.append('asynchronous')
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_account_info" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_account_info`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
query_params = []
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'properties' in params:
query_params.append(('properties', params['properties'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AccountInfo', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_account_invitation(self, account_id, invitation_id, **kwargs): # noqa: E501
"""Details of a user invitation. # noqa: E501
An endpoint for retrieving the details of an active user invitation sent for a new or an existing user to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_invitation(account_id, invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str invitation_id: The ID of the invitation to be retrieved. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_account_invitation_with_http_info(account_id, invitation_id, **kwargs) # noqa: E501
else:
(data) = self.get_account_invitation_with_http_info(account_id, invitation_id, **kwargs) # noqa: E501
return data
def get_account_invitation_with_http_info(self, account_id, invitation_id, **kwargs): # noqa: E501
"""Details of a user invitation. # noqa: E501
An endpoint for retrieving the details of an active user invitation sent for a new or an existing user to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_invitation_with_http_info(account_id, invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str invitation_id: The ID of the invitation to be retrieved. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'invitation_id'] # noqa: E501
all_params.append('asynchronous')
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_account_invitation" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_account_invitation`") # noqa: E501
# verify the required parameter 'invitation_id' is set
if ('invitation_id' not in params or
params['invitation_id'] is None):
raise ValueError("Missing the required parameter `invitation_id` when calling `get_account_invitation`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['account-id'] = params['account_id'] # noqa: E501
if 'invitation_id' in params:
path_params['invitation-id'] = params['invitation_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{account-id}/user-invitations/{invitation-id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInvitationResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_account_user(self, account_id, user_id, **kwargs): # noqa: E501
"""Details of the user. # noqa: E501
An endpoint for retrieving details of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{userID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_user(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be retrieved. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_account_user_with_http_info(account_id, user_id, **kwargs) # noqa: E501
else:
(data) = self.get_account_user_with_http_info(account_id, user_id, **kwargs) # noqa: E501
return data
def get_account_user_with_http_info(self, account_id, user_id, **kwargs): # noqa: E501
"""Details of the user. # noqa: E501
An endpoint for retrieving details of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{userID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_user_with_http_info(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be retrieved. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'user_id'] # noqa: E501
all_params.append('asynchronous')
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_account_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_account_user`") # noqa: E501
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `get_account_user`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'user_id' in params:
path_params['user-id'] = params['user_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/users/{user-id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_account_api_keys(self, account_id, **kwargs): # noqa: E501
"""Get all API keys. # noqa: E501
An endpoint for retrieving the API keys in an array, optionally filtered by the owner. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_api_keys(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str key__eq: API key filter.
:param str owner__eq: Owner name filter.
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_account_api_keys_with_http_info(account_id, **kwargs) # noqa: E501
else:
(data) = self.get_all_account_api_keys_with_http_info(account_id, **kwargs) # noqa: E501
return data
def get_all_account_api_keys_with_http_info(self, account_id, **kwargs): # noqa: E501
"""Get all API keys. # noqa: E501
An endpoint for retrieving the API keys in an array, optionally filtered by the owner. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_api_keys_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str key__eq: API key filter.
:param str owner__eq: Owner name filter.
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'limit', 'after', 'order', 'include', 'key__eq', 'owner__eq'] # noqa: E501
all_params.append('asynchronous')
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_all_account_api_keys" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_all_account_api_keys`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'key__eq' in params:
query_params.append(('key__eq', params['key__eq'])) # noqa: E501
if 'owner__eq' in params:
query_params.append(('owner__eq', params['owner__eq'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/api-keys', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_account_certificates(self, account_id, **kwargs): # noqa: E501
"""Get all trusted certificates. # noqa: E501
An endpoint for retrieving trusted certificates in an array. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_certificates(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for certificate name
:param str service__eq: Filter for service
:param int expire__eq: Filter for expire
:param int device_execution_mode__eq: Filter for developer certificates
:param int device_execution_mode__neq: Filter for not developer certificates
:param str owner__eq: Owner name filter
:param bool enrollment_mode__eq: Enrollment mode filter
:param str issuer__like: Filter for issuer. Finds all matches where the filter value is a case insensitive substring of the result. Example: issuer__like=cn=iss matches CN=issuer.
:param str subject__like: Filter for subject. Finds all matches where the filter value is a case insensitive substring of the result. Example: subject__like=cn=su matches CN=subject.
:return: TrustedCertificateInternalRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_account_certificates_with_http_info(account_id, **kwargs) # noqa: E501
else:
(data) = self.get_all_account_certificates_with_http_info(account_id, **kwargs) # noqa: E501
return data
def get_all_account_certificates_with_http_info(self, account_id, **kwargs): # noqa: E501
"""Get all trusted certificates. # noqa: E501
An endpoint for retrieving trusted certificates in an array. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_certificates_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for certificate name
:param str service__eq: Filter for service
:param int expire__eq: Filter for expire
:param int device_execution_mode__eq: Filter for developer certificates
:param int device_execution_mode__neq: Filter for not developer certificates
:param str owner__eq: Owner name filter
:param bool enrollment_mode__eq: Enrollment mode filter
:param str issuer__like: Filter for issuer. Finds all matches where the filter value is a case insensitive substring of the result. Example: issuer__like=cn=iss matches CN=issuer.
:param str subject__like: Filter for subject. Finds all matches where the filter value is a case insensitive substring of the result. Example: subject__like=cn=su matches CN=subject.
:return: TrustedCertificateInternalRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'limit', 'after', 'order', 'include', 'name__eq', 'service__eq', 'expire__eq', 'device_execution_mode__eq', 'device_execution_mode__neq', 'owner__eq', 'enrollment_mode__eq', 'issuer__like', 'subject__like'] # noqa: E501
all_params.append('asynchronous')
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_all_account_certificates" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_all_account_certificates`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'name__eq' in params:
query_params.append(('name__eq', params['name__eq'])) # noqa: E501
if 'service__eq' in params:
query_params.append(('service__eq', params['service__eq'])) # noqa: E501
if 'expire__eq' in params:
query_params.append(('expire__eq', params['expire__eq'])) # noqa: E501
if 'device_execution_mode__eq' in params:
query_params.append(('device_execution_mode__eq', params['device_execution_mode__eq'])) # noqa: E501
if 'device_execution_mode__neq' in params:
query_params.append(('device_execution_mode__neq', params['device_execution_mode__neq'])) # noqa: E501
if 'owner__eq' in params:
query_params.append(('owner__eq', params['owner__eq'])) # noqa: E501
if 'enrollment_mode__eq' in params:
query_params.append(('enrollment_mode__eq', params['enrollment_mode__eq'])) # noqa: E501
if 'issuer__like' in params:
query_params.append(('issuer__like', params['issuer__like'])) # noqa: E501
if 'subject__like' in params:
query_params.append(('subject__like', params['subject__like'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/trusted-certificates', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TrustedCertificateInternalRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_account_groups(self, account_id, **kwargs): # noqa: E501
"""Get all group information. # noqa: E501
An endpoint for retrieving all group information. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_groups(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for group name
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_account_groups_with_http_info(account_id, **kwargs) # noqa: E501
else:
(data) = self.get_all_account_groups_with_http_info(account_id, **kwargs) # noqa: E501
return data
def get_all_account_groups_with_http_info(self, account_id, **kwargs): # noqa: E501
"""Get all group information. # noqa: E501
An endpoint for retrieving all group information. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_groups_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for group name
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'limit', 'after', 'order', 'include', 'name__eq'] # noqa: E501
all_params.append('asynchronous')
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_all_account_groups" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_all_account_groups`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'name__eq' in params:
query_params.append(('name__eq', params['name__eq'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/policy-groups', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummaryList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_account_invitations(self, account_id, **kwargs): # noqa: E501
"""Get the details of all the user invitations. # noqa: E501
An endpoint for retrieving the details of all the active user invitations sent for new or existing users to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_invitations(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:return: UserInvitationRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_account_invitations_with_http_info(account_id, **kwargs) # noqa: E501
else:
(data) = self.get_all_account_invitations_with_http_info(account_id, **kwargs) # noqa: E501
return data
def get_all_account_invitations_with_http_info(self, account_id, **kwargs): # noqa: E501
"""Get the details of all the user invitations. # noqa: E501
An endpoint for retrieving the details of all the active user invitations sent for new or existing users to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_invitations_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:return: UserInvitationRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'limit', 'after', 'order'] # noqa: E501
all_params.append('asynchronous')
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_all_account_invitations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_all_account_invitations`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['account-id'] = params['account_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{account-id}/user-invitations', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInvitationRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_account_users(self, account_id, **kwargs): # noqa: E501
"""Get all user details. # noqa: E501
An endpoint for retrieving details of all users. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_users(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str email__eq: Filter for email address
:param str status__eq: Filter for status
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_account_users_with_http_info(account_id, **kwargs) # noqa: E501
else:
(data) = self.get_all_account_users_with_http_info(account_id, **kwargs) # noqa: E501
return data
def get_all_account_users_with_http_info(self, account_id, **kwargs): # noqa: E501
"""Get all user details. # noqa: E501
An endpoint for retrieving details of all users. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_users_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str email__eq: Filter for email address
:param str status__eq: Filter for status
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'limit', 'after', 'order', 'include', 'email__eq', 'status__eq', 'status__in', 'status__nin'] # noqa: E501
all_params.append('asynchronous')
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_all_account_users" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_all_account_users`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'email__eq' in params:
query_params.append(('email__eq', params['email__eq'])) # noqa: E501
if 'status__eq' in params:
query_params.append(('status__eq', params['status__eq'])) # noqa: E501
if 'status__in' in params:
query_params.append(('status__in', params['status__in'])) # noqa: E501
if 'status__nin' in params:
query_params.append(('status__nin', params['status__nin'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/users', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInfoRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_accounts(self, **kwargs): # noqa: E501
"""Get all accounts. # noqa: E501
Returns an array of account objects, optionally filtered by status and tier level. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_accounts(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str status__eq: An optional filter for account status, ENROLLING, ACTIVE, RESTRICTED or SUSPENDED.
:param str status__in: An optional filter for getting accounts with a specified set of statuses.
:param str status__nin: An optional filter for excluding accounts with a specified set of statuses.
:param str tier__eq: An optional filter for tier level, must be 0, 1, 2, 98, 99 or omitted.
:param str parent__eq: An optional filter for parent account ID.
:param str end_market__eq: An optional filter for account end market.
:param str country__like: An optional filter for account country. Finds all matches where the filter value is a case insensitive substring of the result. Example: country__like=LAND matches Ireland.
:param int limit: The number of results to return (2-1000), default is 1000.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC. Default value is ASC
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts
:param str format: Format information for the response to the query, supported: format=breakdown.
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfoList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_accounts_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_all_accounts_with_http_info(**kwargs) # noqa: E501
return data
def get_all_accounts_with_http_info(self, **kwargs): # noqa: E501
"""Get all accounts. # noqa: E501
Returns an array of account objects, optionally filtered by status and tier level. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_accounts_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str status__eq: An optional filter for account status, ENROLLING, ACTIVE, RESTRICTED or SUSPENDED.
:param str status__in: An optional filter for getting accounts with a specified set of statuses.
:param str status__nin: An optional filter for excluding accounts with a specified set of statuses.
:param str tier__eq: An optional filter for tier level, must be 0, 1, 2, 98, 99 or omitted.
:param str parent__eq: An optional filter for parent account ID.
:param str end_market__eq: An optional filter for account end market.
:param str country__like: An optional filter for account country. Finds all matches where the filter value is a case insensitive substring of the result. Example: country__like=LAND matches Ireland.
:param int limit: The number of results to return (2-1000), default is 1000.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC. Default value is ASC
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts
:param str format: Format information for the response to the query, supported: format=breakdown.
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfoList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['status__eq', 'status__in', 'status__nin', 'tier__eq', 'parent__eq', 'end_market__eq', 'country__like', 'limit', 'after', 'order', 'include', 'format', 'properties'] # noqa: E501
all_params.append('asynchronous')
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_all_accounts" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'status__eq' in params:
query_params.append(('status__eq', params['status__eq'])) # noqa: E501
if 'status__in' in params:
query_params.append(('status__in', params['status__in'])) # noqa: E501
if 'status__nin' in params:
query_params.append(('status__nin', params['status__nin'])) # noqa: E501
if 'tier__eq' in params:
query_params.append(('tier__eq', params['tier__eq'])) # noqa: E501
if 'parent__eq' in params:
query_params.append(('parent__eq', params['parent__eq'])) # noqa: E501
if 'end_market__eq' in params:
query_params.append(('end_market__eq', params['end_market__eq'])) # noqa: E501
if 'country__like' in params:
query_params.append(('country__like', params['country__like'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'format' in params:
query_params.append(('format', params['format'])) # noqa: E501
if 'properties' in params:
query_params.append(('properties', params['properties'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AccountInfoList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_api_keys_of_account_group(self, account_id, group_id, **kwargs): # noqa: E501
"""Get API keys of a group. # noqa: E501
An endpoint for listing the API keys of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_keys_of_account_group(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group whose API keys are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_api_keys_of_account_group_with_http_info(account_id, group_id, **kwargs) # noqa: E501
else:
(data) = self.get_api_keys_of_account_group_with_http_info(account_id, group_id, **kwargs) # noqa: E501
return data
def get_api_keys_of_account_group_with_http_info(self, account_id, group_id, **kwargs): # noqa: E501
"""Get API keys of a group. # noqa: E501
An endpoint for listing the API keys of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_keys_of_account_group_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group whose API keys are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'group_id', 'limit', 'after', 'order', 'include'] # noqa: E501
all_params.append('asynchronous')
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_api_keys_of_account_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_api_keys_of_account_group`") # noqa: E501
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `get_api_keys_of_account_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'group_id' in params:
path_params['groupID'] = params['group_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/policy-groups/{groupID}/api-keys', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_groups_of_account_apikey(self, account_id, api_key, **kwargs): # noqa: E501
"""Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_account_apikey(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_groups_of_account_apikey_with_http_info(account_id, api_key, **kwargs) # noqa: E501
else:
(data) = self.get_groups_of_account_apikey_with_http_info(account_id, api_key, **kwargs) # noqa: E501
return data
def get_groups_of_account_apikey_with_http_info(self, account_id, api_key, **kwargs): # noqa: E501
"""Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_account_apikey_with_http_info(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'api_key', 'limit', 'after', 'order', 'include'] # noqa: E501
all_params.append('asynchronous')
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_groups_of_account_apikey" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_groups_of_account_apikey`") # noqa: E501
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `get_groups_of_account_apikey`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/api-keys/{apiKey}/groups', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummaryList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_groups_of_account_user(self, account_id, user_id, **kwargs): # noqa: E501
"""Get groups of the user. # noqa: E501
An endpoint for retrieving groups of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_account_user(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_groups_of_account_user_with_http_info(account_id, user_id, **kwargs) # noqa: E501
else:
(data) = self.get_groups_of_account_user_with_http_info(account_id, user_id, **kwargs) # noqa: E501
return data
def get_groups_of_account_user_with_http_info(self, account_id, user_id, **kwargs): # noqa: E501
"""Get groups of the user. # noqa: E501
An endpoint for retrieving groups of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_account_user_with_http_info(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'user_id', 'limit', 'after', 'order', 'include'] # noqa: E501
all_params.append('asynchronous')
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_groups_of_account_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_groups_of_account_user`") # noqa: E501
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `get_groups_of_account_user`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'user_id' in params:
path_params['user-id'] = params['user_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/users/{user-id}/groups', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummaryList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_users_of_account_group(self, account_id, group_id, **kwargs): # noqa: E501
"""Get users of a group. # noqa: E501
An endpoint for listing users of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_users_of_account_group(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group whose users are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str status__eq: An optional filter for getting users by status.
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_users_of_account_group_with_http_info(account_id, group_id, **kwargs) # noqa: E501
else:
(data) = self.get_users_of_account_group_with_http_info(account_id, group_id, **kwargs) # noqa: E501
return data
def get_users_of_account_group_with_http_info(self, account_id, group_id, **kwargs): # noqa: E501
"""Get users of a group. # noqa: E501
An endpoint for listing users of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_users_of_account_group_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group whose users are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str status__eq: An optional filter for getting users by status.
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'group_id', 'limit', 'after', 'order', 'include', 'status__eq', 'status__in', 'status__nin'] # noqa: E501
all_params.append('asynchronous')
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_users_of_account_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_users_of_account_group`") # noqa: E501
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `get_users_of_account_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'group_id' in params:
path_params['groupID'] = params['group_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'status__eq' in params:
query_params.append(('status__eq', params['status__eq'])) # noqa: E501
if 'status__in' in params:
query_params.append(('status__in', params['status__in'])) # noqa: E501
if 'status__nin' in params:
query_params.append(('status__nin', params['status__nin'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/policy-groups/{groupID}/users', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInfoRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def remove_account_api_key_from_groups(self, account_id, api_key, body, **kwargs): # noqa: E501
"""Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_account_api_key_from_groups(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.remove_account_api_key_from_groups_with_http_info(account_id, api_key, body, **kwargs) # noqa: E501
else:
(data) = self.remove_account_api_key_from_groups_with_http_info(account_id, api_key, body, **kwargs) # noqa: E501
return data
def remove_account_api_key_from_groups_with_http_info(self, account_id, api_key, body, **kwargs): # noqa: E501
"""Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_account_api_key_from_groups_with_http_info(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'api_key', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method remove_account_api_key_from_groups" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `remove_account_api_key_from_groups`") # noqa: E501
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `remove_account_api_key_from_groups`") # 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 `remove_account_api_key_from_groups`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/api-keys/{apiKey}/groups', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def remove_account_user_from_groups(self, account_id, user_id, body, **kwargs): # noqa: E501
"""Remove user from groups. # noqa: E501
An endpoint for removing user from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_account_user_from_groups(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.remove_account_user_from_groups_with_http_info(account_id, user_id, body, **kwargs) # noqa: E501
else:
(data) = self.remove_account_user_from_groups_with_http_info(account_id, user_id, body, **kwargs) # noqa: E501
return data
def remove_account_user_from_groups_with_http_info(self, account_id, user_id, body, **kwargs): # noqa: E501
"""Remove user from groups. # noqa: E501
An endpoint for removing user from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_account_user_from_groups_with_http_info(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'user_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method remove_account_user_from_groups" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `remove_account_user_from_groups`") # noqa: E501
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `remove_account_user_from_groups`") # 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 `remove_account_user_from_groups`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'user_id' in params:
path_params['user-id'] = params['user_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/users/{user-id}/groups', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def remove_api_keys_from_account_group(self, account_id, group_id, **kwargs): # noqa: E501
"""Remove API keys from a group. # noqa: E501
An endpoint for removing API keys from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/api-keys -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_keys_from_account_group(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: A list of API keys to be removed from the group. (required)
:param SubjectList body:
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.remove_api_keys_from_account_group_with_http_info(account_id, group_id, **kwargs) # noqa: E501
else:
(data) = self.remove_api_keys_from_account_group_with_http_info(account_id, group_id, **kwargs) # noqa: E501
return data
def remove_api_keys_from_account_group_with_http_info(self, account_id, group_id, **kwargs): # noqa: E501
"""Remove API keys from a group. # noqa: E501
An endpoint for removing API keys from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/api-keys -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_keys_from_account_group_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: A list of API keys to be removed from the group. (required)
:param SubjectList body:
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'group_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method remove_api_keys_from_account_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `remove_api_keys_from_account_group`") # noqa: E501
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `remove_api_keys_from_account_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'group_id' in params:
path_params['groupID'] = params['group_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/policy-groups/{groupID}/api-keys', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def remove_users_from_account_group(self, account_id, group_id, **kwargs): # noqa: E501
"""Remove users from a group. # noqa: E501
An endpoint for removing users from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/users -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_users_from_account_group(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: (required)
:param SubjectList body:
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.remove_users_from_account_group_with_http_info(account_id, group_id, **kwargs) # noqa: E501
else:
(data) = self.remove_users_from_account_group_with_http_info(account_id, group_id, **kwargs) # noqa: E501
return data
def remove_users_from_account_group_with_http_info(self, account_id, group_id, **kwargs): # noqa: E501
"""Remove users from a group. # noqa: E501
An endpoint for removing users from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/users -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_users_from_account_group_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: (required)
:param SubjectList body:
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'group_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method remove_users_from_account_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `remove_users_from_account_group`") # noqa: E501
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `remove_users_from_account_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'group_id' in params:
path_params['groupID'] = params['group_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/policy-groups/{groupID}/users', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 reset_account_api_key_secret(self, account_id, api_key, **kwargs): # noqa: E501
"""Reset the secret key. # noqa: E501
An endpoint for resetting the secret key of the API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/reset-secret -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.reset_account_api_key_secret(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be reset. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.reset_account_api_key_secret_with_http_info(account_id, api_key, **kwargs) # noqa: E501
else:
(data) = self.reset_account_api_key_secret_with_http_info(account_id, api_key, **kwargs) # noqa: E501
return data
def reset_account_api_key_secret_with_http_info(self, account_id, api_key, **kwargs): # noqa: E501
"""Reset the secret key. # noqa: E501
An endpoint for resetting the secret key of the API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/reset-secret -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.reset_account_api_key_secret_with_http_info(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be reset. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'api_key'] # noqa: E501
all_params.append('asynchronous')
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 reset_account_api_key_secret" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `reset_account_api_key_secret`") # noqa: E501
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `reset_account_api_key_secret`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/api-keys/{apiKey}/reset-secret', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_account(self, account_id, body, **kwargs): # noqa: E501
"""Update attributes of an existing account. # noqa: E501
An endpoint for updating an account. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id} -d '{\"phone_number\": \"12345678\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: The ID of the account to be updated. (required)
:param AccountUpdateRootReq body: Details of the account to be updated. (required)
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_account_with_http_info(account_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_account_with_http_info(account_id, body, **kwargs) # noqa: E501
return data
def update_account_with_http_info(self, account_id, body, **kwargs): # noqa: E501
"""Update attributes of an existing account. # noqa: E501
An endpoint for updating an account. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id} -d '{\"phone_number\": \"12345678\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: The ID of the account to be updated. (required)
:param AccountUpdateRootReq body: Details of the account to be updated. (required)
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_account" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `update_account`") # 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 `update_account`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AccountInfo', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_account_api_key(self, account_id, api_key, body, **kwargs): # noqa: E501
"""Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -d '{\"name\": \"TestApiKey25\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_api_key(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be updated. (required)
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_account_api_key_with_http_info(account_id, api_key, body, **kwargs) # noqa: E501
else:
(data) = self.update_account_api_key_with_http_info(account_id, api_key, body, **kwargs) # noqa: E501
return data
def update_account_api_key_with_http_info(self, account_id, api_key, body, **kwargs): # noqa: E501
"""Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -d '{\"name\": \"TestApiKey25\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_api_key_with_http_info(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be updated. (required)
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'api_key', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_account_api_key" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `update_account_api_key`") # noqa: E501
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `update_account_api_key`") # 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 `update_account_api_key`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/api-keys/{apiKey}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiKeyInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_account_certificate(self, account_id, cert_id, body, **kwargs): # noqa: E501
"""Update trusted certificate. # noqa: E501
An endpoint for updating existing trusted certificates. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_certificate(account_id, cert_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be updated. (required)
:param TrustedCertificateUpdateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateInternalResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_account_certificate_with_http_info(account_id, cert_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_account_certificate_with_http_info(account_id, cert_id, body, **kwargs) # noqa: E501
return data
def update_account_certificate_with_http_info(self, account_id, cert_id, body, **kwargs): # noqa: E501
"""Update trusted certificate. # noqa: E501
An endpoint for updating existing trusted certificates. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_certificate_with_http_info(account_id, cert_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be updated. (required)
:param TrustedCertificateUpdateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateInternalResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'cert_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_account_certificate" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `update_account_certificate`") # noqa: E501
# verify the required parameter 'cert_id' is set
if ('cert_id' not in params or
params['cert_id'] is None):
raise ValueError("Missing the required parameter `cert_id` when calling `update_account_certificate`") # 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 `update_account_certificate`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'cert_id' in params:
path_params['cert-id'] = params['cert_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/trusted-certificates/{cert-id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TrustedCertificateInternalResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_account_group_name(self, account_id, group_id, body, **kwargs): # noqa: E501
"""Update the group name. # noqa: E501
An endpoint for updating a group name. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/ -d '{\"name\": \"TestGroup2\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_group_name(account_id, group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be updated. (required)
:param GroupUpdateInfo body: Details of the group to be created. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_account_group_name_with_http_info(account_id, group_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_account_group_name_with_http_info(account_id, group_id, body, **kwargs) # noqa: E501
return data
def update_account_group_name_with_http_info(self, account_id, group_id, body, **kwargs): # noqa: E501
"""Update the group name. # noqa: E501
An endpoint for updating a group name. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/ -d '{\"name\": \"TestGroup2\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_group_name_with_http_info(account_id, group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be updated. (required)
:param GroupUpdateInfo body: Details of the group to be created. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'group_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_account_group_name" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `update_account_group_name`") # noqa: E501
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `update_account_group_name`") # 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 `update_account_group_name`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'group_id' in params:
path_params['groupID'] = params['group_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/policy-groups/{groupID}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_account_user(self, account_id, user_id, body, **kwargs): # noqa: E501
"""Update user details. # noqa: E501
An endpoint for updating user details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id} -d '{\"username\": \"myusername\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_user(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be updated. (required)
:param UserUpdateReq body: A user object with attributes. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_account_user_with_http_info(account_id, user_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_account_user_with_http_info(account_id, user_id, body, **kwargs) # noqa: E501
return data
def update_account_user_with_http_info(self, account_id, user_id, body, **kwargs): # noqa: E501
"""Update user details. # noqa: E501
An endpoint for updating user details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id} -d '{\"username\": \"myusername\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_user_with_http_info(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be updated. (required)
:param UserUpdateReq body: A user object with attributes. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'user_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_account_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `update_account_user`") # noqa: E501
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `update_account_user`") # 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 `update_account_user`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'user_id' in params:
path_params['user-id'] = params['user_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/users/{user-id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 validate_account_user_email(self, account_id, user_id, **kwargs): # noqa: E501
"""Validate the user email. # noqa: E501
An endpoint for validating the user email. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/validate-email -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.validate_account_user_email(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user whose email is validated. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.validate_account_user_email_with_http_info(account_id, user_id, **kwargs) # noqa: E501
else:
(data) = self.validate_account_user_email_with_http_info(account_id, user_id, **kwargs) # noqa: E501
return data
def validate_account_user_email_with_http_info(self, account_id, user_id, **kwargs): # noqa: E501
"""Validate the user email. # noqa: E501
An endpoint for validating the user email. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/validate-email -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.validate_account_user_email_with_http_info(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user whose email is validated. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['account_id', 'user_id'] # noqa: E501
all_params.append('asynchronous')
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 validate_account_user_email" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params or
params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `validate_account_user_email`") # noqa: E501
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `validate_account_user_email`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['accountID'] = params['account_id'] # noqa: E501
if 'user_id' in params:
path_params['user-id'] = params['user_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/{accountID}/users/{user-id}/validate-email', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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)
|
class AggregatorAccountAdminApi(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):
pass
def add_account_api_key_to_groups(self, account_id, api_key, body, **kwargs):
'''Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apikey}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_api_key_to_groups(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_account_api_key_to_groups_with_http_info(self, account_id, api_key, body, **kwargs):
'''Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apikey}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_api_key_to_groups_with_http_info(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_account_certificate(self, account_id, body, **kwargs):
'''Upload new trusted certificate. # noqa: E501
An endpoint for uploading new trusted certificates. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates -d {"name": "myCert1", "description": "very important cert", "certificate": "certificate_data", "service": "lwm2m"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_certificate(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param TrustedCertificateRootReq body: A trusted certificate object with attributes, signature is optional. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_account_certificate_with_http_info(self, account_id, body, **kwargs):
'''Upload new trusted certificate. # noqa: E501
An endpoint for uploading new trusted certificates. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates -d {"name": "myCert1", "description": "very important cert", "certificate": "certificate_data", "service": "lwm2m"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_certificate_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param TrustedCertificateRootReq body: A trusted certificate object with attributes, signature is optional. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_account_user_to_groups(self, account_id, user_id, body, **kwargs):
'''Add user to a list of groups. # noqa: E501
An endpoint for adding user to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_user_to_groups(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_account_user_to_groups_with_http_info(self, account_id, user_id, body, **kwargs):
'''Add user to a list of groups. # noqa: E501
An endpoint for adding user to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_account_user_to_groups_with_http_info(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_subjects_to_account_group(self, account_id, group_id, body, **kwargs):
'''Add members to a group. # noqa: E501
An endpoint for adding users and API keys to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -d '{"users": [0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_subjects_to_account_group(account_id, group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be updated. (required)
:param SubjectList body: A list of users and API keys to be added to the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_subjects_to_account_group_with_http_info(self, account_id, group_id, body, **kwargs):
'''Add members to a group. # noqa: E501
An endpoint for adding users and API keys to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -d '{"users": [0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_subjects_to_account_group_with_http_info(account_id, group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be updated. (required)
:param SubjectList body: A list of users and API keys to be added to the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def check_account_api_key(self, account_id, api_key, **kwargs):
'''Check the API key. # noqa: E501
An endpoint for checking API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.check_account_api_key(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The API key to be checked. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def check_account_api_key_with_http_info(self, account_id, api_key, **kwargs):
'''Check the API key. # noqa: E501
An endpoint for checking API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.check_account_api_key_with_http_info(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The API key to be checked. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_account(self, body, **kwargs):
'''Create a new account. # noqa: E501
An endpoint for creating a new account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts -d '{"display_name": "MyAccount1", "admin_name": "accountAdmin1", "email": "[email protected]"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param AccountCreationReq body: Details of the account to be created. (required)
:param str action: Action, either 'create' or 'enroll'. <ul><li>'create' creates the account where its admin user has ACTIVE status if admin_password was defined in the request, or RESET status if no admin_password was defined. If the user already exists, its status is not modified. </li><li>'enroll' creates the account where its admin user has ENROLLING status. If the user already exists, its status is not modified. Email to finish the enrollment or to notify the existing user about the new account is sent to the admin_email defined in the request. </li></ul>
:return: AccountCreationResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_account_with_http_info(self, body, **kwargs):
'''Create a new account. # noqa: E501
An endpoint for creating a new account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts -d '{"display_name": "MyAccount1", "admin_name": "accountAdmin1", "email": "[email protected]"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param AccountCreationReq body: Details of the account to be created. (required)
:param str action: Action, either 'create' or 'enroll'. <ul><li>'create' creates the account where its admin user has ACTIVE status if admin_password was defined in the request, or RESET status if no admin_password was defined. If the user already exists, its status is not modified. </li><li>'enroll' creates the account where its admin user has ENROLLING status. If the user already exists, its status is not modified. Email to finish the enrollment or to notify the existing user about the new account is sent to the admin_email defined in the request. </li></ul>
:return: AccountCreationResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_account_api_key(self, account_id, body, **kwargs):
'''Create a new API key. # noqa: E501
An endpoint for creating a new API key. There is no default value for the owner ID and it must be from the same account where the new API key is created. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys -d '{"name": "MyKey1"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_api_key(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param ApiKeyInfoReq body: Details of the API key to be created. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_account_api_key_with_http_info(self, account_id, body, **kwargs):
'''Create a new API key. # noqa: E501
An endpoint for creating a new API key. There is no default value for the owner ID and it must be from the same account where the new API key is created. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys -d '{"name": "MyKey1"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_api_key_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param ApiKeyInfoReq body: Details of the API key to be created. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_account_group(self, account_id, body, **kwargs):
'''Create a new group. # noqa: E501
An endpoint for creating a new group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups -d '{"name": "MyGroup1"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_group(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param GroupCreationInfo body: Details of the group to be created. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_account_group_with_http_info(self, account_id, body, **kwargs):
'''Create a new group. # noqa: E501
An endpoint for creating a new group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups -d '{"name": "MyGroup1"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_group_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param GroupCreationInfo body: Details of the group to be created. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_account_invitation(self, account_id, body, **kwargs):
'''Create a user invitation. # noqa: E501
An endpoint for inviting a new or an existing user to join the account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accouns/{account-id}/user-invitations -d {"email": "[email protected]"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_invitation(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param UserInvitationReq body: A user invitation object with attributes. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_account_invitation_with_http_info(self, account_id, body, **kwargs):
'''Create a user invitation. # noqa: E501
An endpoint for inviting a new or an existing user to join the account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accouns/{account-id}/user-invitations -d {"email": "[email protected]"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_invitation_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param UserInvitationReq body: A user invitation object with attributes. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_account_user(self, account_id, body, **kwargs):
'''Create a new user. # noqa: E501
An endpoint for creating or inviting a new user to the account. In case of invitation email address is used only, other attributes are set in the 2nd step. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users -d {"email": "[email protected]"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_user(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param UserInfoReq body: A user object with attributes. (required)
:param str action: Create or invite user.
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_account_user_with_http_info(self, account_id, body, **kwargs):
'''Create a new user. # noqa: E501
An endpoint for creating or inviting a new user to the account. In case of invitation email address is used only, other attributes are set in the 2nd step. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users -d {"email": "[email protected]"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_account_user_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param UserInfoReq body: A user object with attributes. (required)
:param str action: Create or invite user.
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_account_api_key(self, account_id, api_key, **kwargs):
'''Delete the API key. # noqa: E501
An endpoint for deleting an API key. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apikey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_api_key(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_account_api_key_with_http_info(self, account_id, api_key, **kwargs):
'''Delete the API key. # noqa: E501
An endpoint for deleting an API key. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apikey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_api_key_with_http_info(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_account_certificate(self, account_id, cert_id, **kwargs):
'''Delete trusted certificate by ID. # noqa: E501
An endpoint for deleting the trusted certificate. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_certificate(account_id, cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_account_certificate_with_http_info(self, account_id, cert_id, **kwargs):
'''Delete trusted certificate by ID. # noqa: E501
An endpoint for deleting the trusted certificate. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_certificate_with_http_info(account_id, cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_account_group(self, account_id, group_id, **kwargs):
'''Delete a group. # noqa: E501
An endpoint for deleting a group. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_group(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_account_group_with_http_info(self, account_id, group_id, **kwargs):
'''Delete a group. # noqa: E501
An endpoint for deleting a group. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_group_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_account_invitation(self, account_id, invitation_id, **kwargs):
'''Delete a user invitation. # noqa: E501
An endpoint for deleting an active user invitation which has been sent for a new or an existing user to join the account. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_invitation(account_id, invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str invitation_id: The ID of the invitation to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_account_invitation_with_http_info(self, account_id, invitation_id, **kwargs):
'''Delete a user invitation. # noqa: E501
An endpoint for deleting an active user invitation which has been sent for a new or an existing user to join the account. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_invitation_with_http_info(account_id, invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str invitation_id: The ID of the invitation to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_account_user(self, account_id, user_id, **kwargs):
'''Delete a user. # noqa: E501
An endpoint for deleting a user. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_user(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_account_user_with_http_info(self, account_id, user_id, **kwargs):
'''Delete a user. # noqa: E501
An endpoint for deleting a user. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_account_user_with_http_info(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_api_key(self, account_id, api_key, **kwargs):
'''Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_api_key(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be retrieved. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_api_key_with_http_info(self, account_id, api_key, **kwargs):
'''Get API key details. # noqa: E501
An endpoint for retrieving API key details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_api_key_with_http_info(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be retrieved. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_certificate(self, account_id, cert_id, **kwargs):
'''Get trusted certificate by ID. # noqa: E501
An endpoint for retrieving a trusted certificate by ID. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_certificate(account_id, cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be retrieved. (required)
:return: TrustedCertificateInternalResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_certificate_with_http_info(self, account_id, cert_id, **kwargs):
'''Get trusted certificate by ID. # noqa: E501
An endpoint for retrieving a trusted certificate by ID. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates/{cert-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_certificate_with_http_info(account_id, cert_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be retrieved. (required)
:return: TrustedCertificateInternalResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_group_summary(self, account_id, group_id, **kwargs):
'''Get group information. # noqa: E501
An endpoint for getting general information about the group. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_group_summary(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be retrieved. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_group_summary_with_http_info(self, account_id, group_id, **kwargs):
'''Get group information. # noqa: E501
An endpoint for getting general information about the group. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_group_summary_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be retrieved. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_info(self, account_id, **kwargs):
'''Get account info. # noqa: E501
Returns detailed information about the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id} -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: The ID of the account to be fetched. (required)
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_info_with_http_info(self, account_id, **kwargs):
'''Get account info. # noqa: E501
Returns detailed information about the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id} -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_info_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: The ID of the account to be fetched. (required)
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_invitation(self, account_id, invitation_id, **kwargs):
'''Details of a user invitation. # noqa: E501
An endpoint for retrieving the details of an active user invitation sent for a new or an existing user to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_invitation(account_id, invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str invitation_id: The ID of the invitation to be retrieved. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_invitation_with_http_info(self, account_id, invitation_id, **kwargs):
'''Details of a user invitation. # noqa: E501
An endpoint for retrieving the details of an active user invitation sent for a new or an existing user to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_invitation_with_http_info(account_id, invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str invitation_id: The ID of the invitation to be retrieved. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_user(self, account_id, user_id, **kwargs):
'''Details of the user. # noqa: E501
An endpoint for retrieving details of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{userID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_user(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be retrieved. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_account_user_with_http_info(self, account_id, user_id, **kwargs):
'''Details of the user. # noqa: E501
An endpoint for retrieving details of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{userID} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_account_user_with_http_info(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be retrieved. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_account_api_keys(self, account_id, **kwargs):
'''Get all API keys. # noqa: E501
An endpoint for retrieving the API keys in an array, optionally filtered by the owner. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_api_keys(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str key__eq: API key filter.
:param str owner__eq: Owner name filter.
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_account_api_keys_with_http_info(self, account_id, **kwargs):
'''Get all API keys. # noqa: E501
An endpoint for retrieving the API keys in an array, optionally filtered by the owner. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_api_keys_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str key__eq: API key filter.
:param str owner__eq: Owner name filter.
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_account_certificates(self, account_id, **kwargs):
'''Get all trusted certificates. # noqa: E501
An endpoint for retrieving trusted certificates in an array. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_certificates(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for certificate name
:param str service__eq: Filter for service
:param int expire__eq: Filter for expire
:param int device_execution_mode__eq: Filter for developer certificates
:param int device_execution_mode__neq: Filter for not developer certificates
:param str owner__eq: Owner name filter
:param bool enrollment_mode__eq: Enrollment mode filter
:param str issuer__like: Filter for issuer. Finds all matches where the filter value is a case insensitive substring of the result. Example: issuer__like=cn=iss matches CN=issuer.
:param str subject__like: Filter for subject. Finds all matches where the filter value is a case insensitive substring of the result. Example: subject__like=cn=su matches CN=subject.
:return: TrustedCertificateInternalRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_account_certificates_with_http_info(self, account_id, **kwargs):
'''Get all trusted certificates. # noqa: E501
An endpoint for retrieving trusted certificates in an array. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/trusted-certificates -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_certificates_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for certificate name
:param str service__eq: Filter for service
:param int expire__eq: Filter for expire
:param int device_execution_mode__eq: Filter for developer certificates
:param int device_execution_mode__neq: Filter for not developer certificates
:param str owner__eq: Owner name filter
:param bool enrollment_mode__eq: Enrollment mode filter
:param str issuer__like: Filter for issuer. Finds all matches where the filter value is a case insensitive substring of the result. Example: issuer__like=cn=iss matches CN=issuer.
:param str subject__like: Filter for subject. Finds all matches where the filter value is a case insensitive substring of the result. Example: subject__like=cn=su matches CN=subject.
:return: TrustedCertificateInternalRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_account_groups(self, account_id, **kwargs):
'''Get all group information. # noqa: E501
An endpoint for retrieving all group information. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_groups(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for group name
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_account_groups_with_http_info(self, account_id, **kwargs):
'''Get all group information. # noqa: E501
An endpoint for retrieving all group information. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_groups_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str name__eq: Filter for group name
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_account_invitations(self, account_id, **kwargs):
'''Get the details of all the user invitations. # noqa: E501
An endpoint for retrieving the details of all the active user invitations sent for new or existing users to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_invitations(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:return: UserInvitationRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_account_invitations_with_http_info(self, account_id, **kwargs):
'''Get the details of all the user invitations. # noqa: E501
An endpoint for retrieving the details of all the active user invitations sent for new or existing users to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id}/user-invitations -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_invitations_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:return: UserInvitationRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_account_users(self, account_id, **kwargs):
'''Get all user details. # noqa: E501
An endpoint for retrieving details of all users. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_users(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str email__eq: Filter for email address
:param str status__eq: Filter for status
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_account_users_with_http_info(self, account_id, **kwargs):
'''Get all user details. # noqa: E501
An endpoint for retrieving details of all users. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_account_users_with_http_info(account_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str email__eq: Filter for email address
:param str status__eq: Filter for status
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_accounts(self, **kwargs):
'''Get all accounts. # noqa: E501
Returns an array of account objects, optionally filtered by status and tier level. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_accounts(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str status__eq: An optional filter for account status, ENROLLING, ACTIVE, RESTRICTED or SUSPENDED.
:param str status__in: An optional filter for getting accounts with a specified set of statuses.
:param str status__nin: An optional filter for excluding accounts with a specified set of statuses.
:param str tier__eq: An optional filter for tier level, must be 0, 1, 2, 98, 99 or omitted.
:param str parent__eq: An optional filter for parent account ID.
:param str end_market__eq: An optional filter for account end market.
:param str country__like: An optional filter for account country. Finds all matches where the filter value is a case insensitive substring of the result. Example: country__like=LAND matches Ireland.
:param int limit: The number of results to return (2-1000), default is 1000.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC. Default value is ASC
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts
:param str format: Format information for the response to the query, supported: format=breakdown.
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfoList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_accounts_with_http_info(self, **kwargs):
'''Get all accounts. # noqa: E501
Returns an array of account objects, optionally filtered by status and tier level. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts -H 'Authorization: Bearer API_KEY'`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_accounts_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str status__eq: An optional filter for account status, ENROLLING, ACTIVE, RESTRICTED or SUSPENDED.
:param str status__in: An optional filter for getting accounts with a specified set of statuses.
:param str status__nin: An optional filter for excluding accounts with a specified set of statuses.
:param str tier__eq: An optional filter for tier level, must be 0, 1, 2, 98, 99 or omitted.
:param str parent__eq: An optional filter for parent account ID.
:param str end_market__eq: An optional filter for account end market.
:param str country__like: An optional filter for account country. Finds all matches where the filter value is a case insensitive substring of the result. Example: country__like=LAND matches Ireland.
:param int limit: The number of results to return (2-1000), default is 1000.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC. Default value is ASC
:param str include: Comma separated additional data to return. Currently supported: limits, policies, sub_accounts
:param str format: Format information for the response to the query, supported: format=breakdown.
:param str properties: Property name to be returned from account specific properties.
:return: AccountInfoList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_api_keys_of_account_group(self, account_id, group_id, **kwargs):
'''Get API keys of a group. # noqa: E501
An endpoint for listing the API keys of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_keys_of_account_group(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group whose API keys are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_api_keys_of_account_group_with_http_info(self, account_id, group_id, **kwargs):
'''Get API keys of a group. # noqa: E501
An endpoint for listing the API keys of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/api-keys -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_api_keys_of_account_group_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group whose API keys are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: ApiKeyInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_groups_of_account_apikey(self, account_id, api_key, **kwargs):
'''Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_account_apikey(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_groups_of_account_apikey_with_http_info(self, account_id, api_key, **kwargs):
'''Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_account_apikey_with_http_info(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_groups_of_account_user(self, account_id, user_id, **kwargs):
'''Get groups of the user. # noqa: E501
An endpoint for retrieving groups of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_account_user(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_groups_of_account_user_with_http_info(self, account_id, user_id, **kwargs):
'''Get groups of the user. # noqa: E501
An endpoint for retrieving groups of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_account_user_with_http_info(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_users_of_account_group(self, account_id, group_id, **kwargs):
'''Get users of a group. # noqa: E501
An endpoint for listing users of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_users_of_account_group(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group whose users are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str status__eq: An optional filter for getting users by status.
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_users_of_account_group_with_http_info(self, account_id, group_id, **kwargs):
'''Get users of a group. # noqa: E501
An endpoint for listing users of the group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_users_of_account_group_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group whose users are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str status__eq: An optional filter for getting users by status.
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_account_api_key_from_groups(self, account_id, api_key, body, **kwargs):
'''Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_account_api_key_from_groups(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_account_api_key_from_groups_with_http_info(self, account_id, api_key, body, **kwargs):
'''Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_account_api_key_from_groups_with_http_info(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_account_user_from_groups(self, account_id, user_id, body, **kwargs):
'''Remove user from groups. # noqa: E501
An endpoint for removing user from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_account_user_from_groups(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_account_user_from_groups_with_http_info(self, account_id, user_id, body, **kwargs):
'''Remove user from groups. # noqa: E501
An endpoint for removing user from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_account_user_from_groups_with_http_info(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_api_keys_from_account_group(self, account_id, group_id, **kwargs):
'''Remove API keys from a group. # noqa: E501
An endpoint for removing API keys from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/api-keys -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_keys_from_account_group(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: A list of API keys to be removed from the group. (required)
:param SubjectList body:
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_api_keys_from_account_group_with_http_info(self, account_id, group_id, **kwargs):
'''Remove API keys from a group. # noqa: E501
An endpoint for removing API keys from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/api-keys -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_keys_from_account_group_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: A list of API keys to be removed from the group. (required)
:param SubjectList body:
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_users_from_account_group(self, account_id, group_id, **kwargs):
'''Remove users from a group. # noqa: E501
An endpoint for removing users from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/users -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_users_from_account_group(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: (required)
:param SubjectList body:
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_users_from_account_group_with_http_info(self, account_id, group_id, **kwargs):
'''Remove users from a group. # noqa: E501
An endpoint for removing users from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/users -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_users_from_account_group_with_http_info(account_id, group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: (required)
:param SubjectList body:
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def reset_account_api_key_secret(self, account_id, api_key, **kwargs):
'''Reset the secret key. # noqa: E501
An endpoint for resetting the secret key of the API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/reset-secret -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.reset_account_api_key_secret(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be reset. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def reset_account_api_key_secret_with_http_info(self, account_id, api_key, **kwargs):
'''Reset the secret key. # noqa: E501
An endpoint for resetting the secret key of the API key. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey}/reset-secret -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.reset_account_api_key_secret_with_http_info(account_id, api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be reset. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_account(self, account_id, body, **kwargs):
'''Update attributes of an existing account. # noqa: E501
An endpoint for updating an account. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id} -d '{"phone_number": "12345678"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: The ID of the account to be updated. (required)
:param AccountUpdateRootReq body: Details of the account to be updated. (required)
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_account_with_http_info(self, account_id, body, **kwargs):
'''Update attributes of an existing account. # noqa: E501
An endpoint for updating an account. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{account-id} -d '{"phone_number": "12345678"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_with_http_info(account_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: The ID of the account to be updated. (required)
:param AccountUpdateRootReq body: Details of the account to be updated. (required)
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_account_api_key(self, account_id, api_key, body, **kwargs):
'''Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -d '{"name": "TestApiKey25"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_api_key(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be updated. (required)
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_account_api_key_with_http_info(self, account_id, api_key, body, **kwargs):
'''Update API key details. # noqa: E501
An endpoint for updating API key details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/api-keys/{apiKey} -d '{"name": "TestApiKey25"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_api_key_with_http_info(account_id, api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str api_key: The ID of the API key to be updated. (required)
:param ApiKeyUpdateReq body: New API key attributes to be stored. (required)
:return: ApiKeyInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_account_certificate(self, account_id, cert_id, body, **kwargs):
'''Update trusted certificate. # noqa: E501
An endpoint for updating existing trusted certificates. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_certificate(account_id, cert_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be updated. (required)
:param TrustedCertificateUpdateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateInternalResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_account_certificate_with_http_info(self, account_id, cert_id, body, **kwargs):
'''Update trusted certificate. # noqa: E501
An endpoint for updating existing trusted certificates. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_certificate_with_http_info(account_id, cert_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str cert_id: The ID of the trusted certificate to be updated. (required)
:param TrustedCertificateUpdateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateInternalResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_account_group_name(self, account_id, group_id, body, **kwargs):
'''Update the group name. # noqa: E501
An endpoint for updating a group name. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/ -d '{"name": "TestGroup2"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_group_name(account_id, group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be updated. (required)
:param GroupUpdateInfo body: Details of the group to be created. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_account_group_name_with_http_info(self, account_id, group_id, body, **kwargs):
'''Update the group name. # noqa: E501
An endpoint for updating a group name. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/policy-groups/{groupID}/ -d '{"name": "TestGroup2"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_group_name_with_http_info(account_id, group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str group_id: The ID of the group to be updated. (required)
:param GroupUpdateInfo body: Details of the group to be created. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_account_user(self, account_id, user_id, body, **kwargs):
'''Update user details. # noqa: E501
An endpoint for updating user details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id} -d '{"username": "myusername"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_user(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be updated. (required)
:param UserUpdateReq body: A user object with attributes. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_account_user_with_http_info(self, account_id, user_id, body, **kwargs):
'''Update user details. # noqa: E501
An endpoint for updating user details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id} -d '{"username": "myusername"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_account_user_with_http_info(account_id, user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user to be updated. (required)
:param UserUpdateReq body: A user object with attributes. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def validate_account_user_email(self, account_id, user_id, **kwargs):
'''Validate the user email. # noqa: E501
An endpoint for validating the user email. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/validate-email -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.validate_account_user_email(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user whose email is validated. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def validate_account_user_email_with_http_info(self, account_id, user_id, **kwargs):
'''Validate the user email. # noqa: E501
An endpoint for validating the user email. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/accounts/{accountID}/users/{user-id}/validate-email -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.validate_account_user_email_with_http_info(account_id, user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str account_id: Account ID. (required)
:param str user_id: The ID of the user whose email is validated. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
| 86 | 85 | 54 | 7 | 30 | 24 | 5 | 0.78 | 1 | 3 | 1 | 0 | 85 | 1 | 85 | 85 | 4,697 | 691 | 2,579 | 591 | 2,493 | 2,020 | 1,680 | 591 | 1,594 | 18 | 1 | 2 | 453 |
2,427 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/global_sign_credentials.py
|
mbed_cloud._backends.external_ca.models.global_sign_credentials.GlobalSignCredentials
|
class GlobalSignCredentials(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 = {
'api_key': 'str',
'api_secret': 'str',
'client_certificate': 'str',
'passphrase': 'str',
'private_key': 'str'
}
attribute_map = {
'api_key': 'api_key',
'api_secret': 'api_secret',
'client_certificate': 'client_certificate',
'passphrase': 'passphrase',
'private_key': 'private_key'
}
def __init__(self, api_key=None, api_secret=None, client_certificate=None, passphrase=None, private_key=None):
"""
GlobalSignCredentials - a model defined in Swagger
"""
self._api_key = api_key
self._api_secret = api_secret
self._client_certificate = client_certificate
self._passphrase = passphrase
self._private_key = private_key
self.discriminator = None
@property
def api_key(self):
"""
Gets the api_key of this GlobalSignCredentials.
Unique ID for API client (provided by GlobalSign).
:return: The api_key of this GlobalSignCredentials.
:rtype: str
"""
return self._api_key
@api_key.setter
def api_key(self, api_key):
"""
Sets the api_key of this GlobalSignCredentials.
Unique ID for API client (provided by GlobalSign).
:param api_key: The api_key of this GlobalSignCredentials.
:type: str
"""
if api_key is None:
raise ValueError("Invalid value for `api_key`, must not be `None`")
if api_key is not None and len(api_key) > 1000:
raise ValueError("Invalid value for `api_key`, length must be less than or equal to `1000`")
self._api_key = api_key
@property
def api_secret(self):
"""
Gets the api_secret of this GlobalSignCredentials.
API Secret matching the API key (provided by GlobalSign).
:return: The api_secret of this GlobalSignCredentials.
:rtype: str
"""
return self._api_secret
@api_secret.setter
def api_secret(self, api_secret):
"""
Sets the api_secret of this GlobalSignCredentials.
API Secret matching the API key (provided by GlobalSign).
:param api_secret: The api_secret of this GlobalSignCredentials.
:type: str
"""
if api_secret is None:
raise ValueError("Invalid value for `api_secret`, must not be `None`")
if api_secret is not None and len(api_secret) > 250:
raise ValueError("Invalid value for `api_secret`, length must be less than or equal to `250`")
self._api_secret = api_secret
@property
def client_certificate(self):
"""
Gets the client_certificate of this GlobalSignCredentials.
The client certificate provided by GlobalSign to allow HTTPS connection over TLS/SSL. The certificate wraps a public key that matches a private key provided by the customer. The certificate must be in PEM format.
:return: The client_certificate of this GlobalSignCredentials.
:rtype: str
"""
return self._client_certificate
@client_certificate.setter
def client_certificate(self, client_certificate):
"""
Sets the client_certificate of this GlobalSignCredentials.
The client certificate provided by GlobalSign to allow HTTPS connection over TLS/SSL. The certificate wraps a public key that matches a private key provided by the customer. The certificate must be in PEM format.
:param client_certificate: The client_certificate of this GlobalSignCredentials.
:type: str
"""
if client_certificate is None:
raise ValueError("Invalid value for `client_certificate`, must not be `None`")
if client_certificate is not None and len(client_certificate) > 3000:
raise ValueError("Invalid value for `client_certificate`, length must be less than or equal to `3000`")
self._client_certificate = client_certificate
@property
def passphrase(self):
"""
Gets the passphrase of this GlobalSignCredentials.
The passphrase to decrypt the private key in case it is encrypted. Empty if the private key is not encrypted.
:return: The passphrase of this GlobalSignCredentials.
:rtype: str
"""
return self._passphrase
@passphrase.setter
def passphrase(self, passphrase):
"""
Sets the passphrase of this GlobalSignCredentials.
The passphrase to decrypt the private key in case it is encrypted. Empty if the private key is not encrypted.
:param passphrase: The passphrase of this GlobalSignCredentials.
:type: str
"""
if passphrase is not None and len(passphrase) > 1000:
raise ValueError("Invalid value for `passphrase`, length must be less than or equal to `1000`")
self._passphrase = passphrase
@property
def private_key(self):
"""
Gets the private_key of this GlobalSignCredentials.
The private key that matches the client certificate to allow HTTPS connection over TLS/SSL. The private key may be encrypted using a symmetric encryption key derived from a passphrase. The private key must be in PEM format.
:return: The private_key of this GlobalSignCredentials.
:rtype: str
"""
return self._private_key
@private_key.setter
def private_key(self, private_key):
"""
Sets the private_key of this GlobalSignCredentials.
The private key that matches the client certificate to allow HTTPS connection over TLS/SSL. The private key may be encrypted using a symmetric encryption key derived from a passphrase. The private key must be in PEM format.
:param private_key: The private_key of this GlobalSignCredentials.
:type: str
"""
if private_key is None:
raise ValueError("Invalid value for `private_key`, must not be `None`")
if private_key is not None and len(private_key) > 3000:
raise ValueError("Invalid value for `private_key`, length must be less than or equal to `3000`")
self._private_key = private_key
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, GlobalSignCredentials):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class GlobalSignCredentials(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, api_key=None, api_secret=None, client_certificate=None, passphrase=None, private_key=None):
'''
GlobalSignCredentials - a model defined in Swagger
'''
pass
@property
def api_key(self):
'''
Gets the api_key of this GlobalSignCredentials.
Unique ID for API client (provided by GlobalSign).
:return: The api_key of this GlobalSignCredentials.
:rtype: str
'''
pass
@api_key.setter
def api_key(self):
'''
Sets the api_key of this GlobalSignCredentials.
Unique ID for API client (provided by GlobalSign).
:param api_key: The api_key of this GlobalSignCredentials.
:type: str
'''
pass
@property
def api_secret(self):
'''
Gets the api_secret of this GlobalSignCredentials.
API Secret matching the API key (provided by GlobalSign).
:return: The api_secret of this GlobalSignCredentials.
:rtype: str
'''
pass
@api_secret.setter
def api_secret(self):
'''
Sets the api_secret of this GlobalSignCredentials.
API Secret matching the API key (provided by GlobalSign).
:param api_secret: The api_secret of this GlobalSignCredentials.
:type: str
'''
pass
@property
def client_certificate(self):
'''
Gets the client_certificate of this GlobalSignCredentials.
The client certificate provided by GlobalSign to allow HTTPS connection over TLS/SSL. The certificate wraps a public key that matches a private key provided by the customer. The certificate must be in PEM format.
:return: The client_certificate of this GlobalSignCredentials.
:rtype: str
'''
pass
@client_certificate.setter
def client_certificate(self):
'''
Sets the client_certificate of this GlobalSignCredentials.
The client certificate provided by GlobalSign to allow HTTPS connection over TLS/SSL. The certificate wraps a public key that matches a private key provided by the customer. The certificate must be in PEM format.
:param client_certificate: The client_certificate of this GlobalSignCredentials.
:type: str
'''
pass
@property
def passphrase(self):
'''
Gets the passphrase of this GlobalSignCredentials.
The passphrase to decrypt the private key in case it is encrypted. Empty if the private key is not encrypted.
:return: The passphrase of this GlobalSignCredentials.
:rtype: str
'''
pass
@passphrase.setter
def passphrase(self):
'''
Sets the passphrase of this GlobalSignCredentials.
The passphrase to decrypt the private key in case it is encrypted. Empty if the private key is not encrypted.
:param passphrase: The passphrase of this GlobalSignCredentials.
:type: str
'''
pass
@property
def private_key(self):
'''
Gets the private_key of this GlobalSignCredentials.
The private key that matches the client certificate to allow HTTPS connection over TLS/SSL. The private key may be encrypted using a symmetric encryption key derived from a passphrase. The private key must be in PEM format.
:return: The private_key of this GlobalSignCredentials.
:rtype: str
'''
pass
@private_key.setter
def private_key(self):
'''
Sets the private_key of this GlobalSignCredentials.
The private key that matches the client certificate to allow HTTPS connection over TLS/SSL. The private key may be encrypted using a symmetric encryption key derived from a passphrase. The private key must be in PEM format.
:param private_key: The private_key of this GlobalSignCredentials.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 27 | 17 | 11 | 1 | 5 | 5 | 2 | 0.89 | 1 | 4 | 0 | 0 | 16 | 6 | 16 | 16 | 227 | 38 | 100 | 38 | 73 | 89 | 68 | 28 | 51 | 5 | 1 | 2 | 30 |
2,428 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/field_message_entry.py
|
mbed_cloud._backends.external_ca.models.field_message_entry.FieldMessageEntry
|
class FieldMessageEntry(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 = {
'field': 'str',
'message': 'str'
}
attribute_map = {
'field': 'field',
'message': 'message'
}
def __init__(self, field=None, message=None):
"""
FieldMessageEntry - a model defined in Swagger
"""
self._field = field
self._message = message
self.discriminator = None
@property
def field(self):
"""
Gets the field of this FieldMessageEntry.
Field name.
:return: The field of this FieldMessageEntry.
:rtype: str
"""
return self._field
@field.setter
def field(self, field):
"""
Sets the field of this FieldMessageEntry.
Field name.
:param field: The field of this FieldMessageEntry.
:type: str
"""
self._field = field
@property
def message(self):
"""
Gets the message of this FieldMessageEntry.
Error message related to the field.
:return: The message of this FieldMessageEntry.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this FieldMessageEntry.
Error message related to the field.
:param message: The message of this FieldMessageEntry.
:type: str
"""
self._message = message
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, FieldMessageEntry):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class FieldMessageEntry(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, field=None, message=None):
'''
FieldMessageEntry - a model defined in Swagger
'''
pass
@property
def field(self):
'''
Gets the field of this FieldMessageEntry.
Field name.
:return: The field of this FieldMessageEntry.
:rtype: str
'''
pass
@field.setter
def field(self):
'''
Sets the field of this FieldMessageEntry.
Field name.
:param field: The field of this FieldMessageEntry.
:type: str
'''
pass
@property
def message(self):
'''
Gets the message of this FieldMessageEntry.
Error message related to the field.
:return: The message of this FieldMessageEntry.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this FieldMessageEntry.
Error message related to the field.
:param message: The message of this FieldMessageEntry.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 9 | 1 | 4 | 4 | 2 | 0.96 | 1 | 3 | 0 | 0 | 10 | 3 | 10 | 10 | 131 | 23 | 55 | 23 | 40 | 53 | 35 | 19 | 24 | 5 | 1 | 2 | 15 |
2,429 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/error_object_response.py
|
mbed_cloud._backends.external_ca.models.error_object_response.ErrorObjectResponse
|
class ErrorObjectResponse(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'code': 'int',
'fields': 'list[FieldMessageEntry]',
'message': 'str',
'object': 'str',
'request_id': 'str',
'type': 'str'
}
attribute_map = {
'code': 'code',
'fields': 'fields',
'message': 'message',
'object': 'object',
'request_id': 'request_id',
'type': 'type'
}
def __init__(self, code=None, fields=None, message=None, object=None, request_id=None, type=None):
"""
ErrorObjectResponse - a model defined in Swagger
"""
self._code = code
self._fields = fields
self._message = message
self._object = object
self._request_id = request_id
self._type = type
self.discriminator = None
@property
def code(self):
"""
Gets the code of this ErrorObjectResponse.
Error code. Correlates with response status code.
:return: The code of this ErrorObjectResponse.
:rtype: int
"""
return self._code
@code.setter
def code(self, code):
"""
Sets the code of this ErrorObjectResponse.
Error code. Correlates with response status code.
:param code: The code of this ErrorObjectResponse.
:type: int
"""
if code is None:
raise ValueError("Invalid value for `code`, must not be `None`")
self._code = code
@property
def fields(self):
"""
Gets the fields of this ErrorObjectResponse.
A list of request fields that failed the validation.
:return: The fields of this ErrorObjectResponse.
:rtype: list[FieldMessageEntry]
"""
return self._fields
@fields.setter
def fields(self, fields):
"""
Sets the fields of this ErrorObjectResponse.
A list of request fields that failed the validation.
:param fields: The fields of this ErrorObjectResponse.
:type: list[FieldMessageEntry]
"""
if fields is None:
raise ValueError("Invalid value for `fields`, must not be `None`")
self._fields = fields
@property
def message(self):
"""
Gets the message of this ErrorObjectResponse.
Error message.
:return: The message of this ErrorObjectResponse.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this ErrorObjectResponse.
Error message.
:param message: The message of this ErrorObjectResponse.
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`")
self._message = message
@property
def object(self):
"""
Gets the object of this ErrorObjectResponse.
entity name: 'error'
:return: The object of this ErrorObjectResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ErrorObjectResponse.
entity name: 'error'
:param object: The object of this ErrorObjectResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
self._object = object
@property
def request_id(self):
"""
Gets the request_id of this ErrorObjectResponse.
Request ID from JWT.
:return: The request_id of this ErrorObjectResponse.
:rtype: str
"""
return self._request_id
@request_id.setter
def request_id(self, request_id):
"""
Sets the request_id of this ErrorObjectResponse.
Request ID from JWT.
:param request_id: The request_id of this ErrorObjectResponse.
:type: str
"""
if request_id is None:
raise ValueError("Invalid value for `request_id`, must not be `None`")
self._request_id = request_id
@property
def type(self):
"""
Gets the type of this ErrorObjectResponse.
Error type.
:return: The type of this ErrorObjectResponse.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this ErrorObjectResponse.
Error type.
:param type: The type of this ErrorObjectResponse.
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`")
self._type = type
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ErrorObjectResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ErrorObjectResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, code=None, fields=None, message=None, object=None, request_id=None, type=None):
'''
ErrorObjectResponse - a model defined in Swagger
'''
pass
@property
def code(self):
'''
Gets the code of this ErrorObjectResponse.
Error code. Correlates with response status code.
:return: The code of this ErrorObjectResponse.
:rtype: int
'''
pass
@code.setter
def code(self):
'''
Sets the code of this ErrorObjectResponse.
Error code. Correlates with response status code.
:param code: The code of this ErrorObjectResponse.
:type: int
'''
pass
@property
def fields(self):
'''
Gets the fields of this ErrorObjectResponse.
A list of request fields that failed the validation.
:return: The fields of this ErrorObjectResponse.
:rtype: list[FieldMessageEntry]
'''
pass
@fields.setter
def fields(self):
'''
Sets the fields of this ErrorObjectResponse.
A list of request fields that failed the validation.
:param fields: The fields of this ErrorObjectResponse.
:type: list[FieldMessageEntry]
'''
pass
@property
def message(self):
'''
Gets the message of this ErrorObjectResponse.
Error message.
:return: The message of this ErrorObjectResponse.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this ErrorObjectResponse.
Error message.
:param message: The message of this ErrorObjectResponse.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this ErrorObjectResponse.
entity name: 'error'
:return: The object of this ErrorObjectResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ErrorObjectResponse.
entity name: 'error'
:param object: The object of this ErrorObjectResponse.
:type: str
'''
pass
@property
def request_id(self):
'''
Gets the request_id of this ErrorObjectResponse.
Request ID from JWT.
:return: The request_id of this ErrorObjectResponse.
:rtype: str
'''
pass
@request_id.setter
def request_id(self):
'''
Sets the request_id of this ErrorObjectResponse.
Request ID from JWT.
:param request_id: The request_id of this ErrorObjectResponse.
:type: str
'''
pass
@property
def type(self):
'''
Gets the type of this ErrorObjectResponse.
Error type.
:return: The type of this ErrorObjectResponse.
:rtype: str
'''
pass
@type.setter
def type(self):
'''
Sets the type of this ErrorObjectResponse.
Error type.
:param type: The type of this ErrorObjectResponse.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 10 | 1 | 4 | 5 | 2 | 0.98 | 1 | 4 | 0 | 0 | 18 | 7 | 18 | 18 | 247 | 43 | 103 | 43 | 72 | 101 | 67 | 31 | 48 | 5 | 1 | 2 | 29 |
2,430 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/create_certificate_issuer_config.py
|
mbed_cloud._backends.external_ca.models.create_certificate_issuer_config.CreateCertificateIssuerConfig
|
class CreateCertificateIssuerConfig(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 = {
'certificate_issuer_id': 'str',
'reference': 'str'
}
attribute_map = {
'certificate_issuer_id': 'certificate_issuer_id',
'reference': 'reference'
}
def __init__(self, certificate_issuer_id=None, reference=None):
"""
CreateCertificateIssuerConfig - a model defined in Swagger
"""
self._certificate_issuer_id = certificate_issuer_id
self._reference = reference
self.discriminator = None
@property
def certificate_issuer_id(self):
"""
Gets the certificate_issuer_id of this CreateCertificateIssuerConfig.
The ID of the certificate issuer.
:return: The certificate_issuer_id of this CreateCertificateIssuerConfig.
:rtype: str
"""
return self._certificate_issuer_id
@certificate_issuer_id.setter
def certificate_issuer_id(self, certificate_issuer_id):
"""
Sets the certificate_issuer_id of this CreateCertificateIssuerConfig.
The ID of the certificate issuer.
:param certificate_issuer_id: The certificate_issuer_id of this CreateCertificateIssuerConfig.
:type: str
"""
if certificate_issuer_id is None:
raise ValueError("Invalid value for `certificate_issuer_id`, must not be `None`")
if certificate_issuer_id is not None and len(certificate_issuer_id) > 32:
raise ValueError("Invalid value for `certificate_issuer_id`, length must be less than or equal to `32`")
self._certificate_issuer_id = certificate_issuer_id
@property
def reference(self):
"""
Gets the reference of this CreateCertificateIssuerConfig.
The certificate name, as created in the factory, to which the certificate issuer configuration applies. The following names are reserved and cannot be configured: LwM2M, BOOTSTRAP.
:return: The reference of this CreateCertificateIssuerConfig.
:rtype: str
"""
return self._reference
@reference.setter
def reference(self, reference):
"""
Sets the reference of this CreateCertificateIssuerConfig.
The certificate name, as created in the factory, to which the certificate issuer configuration applies. The following names are reserved and cannot be configured: LwM2M, BOOTSTRAP.
:param reference: The reference of this CreateCertificateIssuerConfig.
:type: str
"""
if reference is None:
raise ValueError("Invalid value for `reference`, must not be `None`")
if reference is not None and len(reference) > 50:
raise ValueError("Invalid value for `reference`, length must be less than or equal to `50`")
if reference is not None and not re.search('(?!mbed\\.)[\\w-_.]{1,50}', reference):
raise ValueError("Invalid value for `reference`, must be a follow pattern or equal to `/(?!mbed\\.)[\\w-_.]{1,50}/`")
self._reference = reference
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CreateCertificateIssuerConfig):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CreateCertificateIssuerConfig(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, certificate_issuer_id=None, reference=None):
'''
CreateCertificateIssuerConfig - a model defined in Swagger
'''
pass
@property
def certificate_issuer_id(self):
'''
Gets the certificate_issuer_id of this CreateCertificateIssuerConfig.
The ID of the certificate issuer.
:return: The certificate_issuer_id of this CreateCertificateIssuerConfig.
:rtype: str
'''
pass
@certificate_issuer_id.setter
def certificate_issuer_id(self):
'''
Sets the certificate_issuer_id of this CreateCertificateIssuerConfig.
The ID of the certificate issuer.
:param certificate_issuer_id: The certificate_issuer_id of this CreateCertificateIssuerConfig.
:type: str
'''
pass
@property
def reference(self):
'''
Gets the reference of this CreateCertificateIssuerConfig.
The certificate name, as created in the factory, to which the certificate issuer configuration applies. The following names are reserved and cannot be configured: LwM2M, BOOTSTRAP.
:return: The reference of this CreateCertificateIssuerConfig.
:rtype: str
'''
pass
@reference.setter
def reference(self):
'''
Sets the reference of this CreateCertificateIssuerConfig.
The certificate name, as created in the factory, to which the certificate issuer configuration applies. The following names are reserved and cannot be configured: LwM2M, BOOTSTRAP.
:param reference: The reference of this CreateCertificateIssuerConfig.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 10 | 1 | 5 | 4 | 2 | 0.82 | 1 | 4 | 0 | 0 | 10 | 3 | 10 | 10 | 141 | 23 | 65 | 23 | 50 | 53 | 45 | 19 | 34 | 5 | 1 | 2 | 20 |
2,431 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/cfssl_auth_credentials.py
|
mbed_cloud._backends.external_ca.models.cfssl_auth_credentials.CfsslAuthCredentials
|
class CfsslAuthCredentials(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 = {
'hmac_hex_key': 'str'
}
attribute_map = {
'hmac_hex_key': 'hmac_hex_key'
}
def __init__(self, hmac_hex_key=None):
"""
CfsslAuthCredentials - a model defined in Swagger
"""
self._hmac_hex_key = hmac_hex_key
self.discriminator = None
@property
def hmac_hex_key(self):
"""
Gets the hmac_hex_key of this CfsslAuthCredentials.
The key that is used to compute the HMAC of the request using the HMAC-SHA-256 algorithm. Must contain an even number of hexadecimal characters.
:return: The hmac_hex_key of this CfsslAuthCredentials.
:rtype: str
"""
return self._hmac_hex_key
@hmac_hex_key.setter
def hmac_hex_key(self, hmac_hex_key):
"""
Sets the hmac_hex_key of this CfsslAuthCredentials.
The key that is used to compute the HMAC of the request using the HMAC-SHA-256 algorithm. Must contain an even number of hexadecimal characters.
:param hmac_hex_key: The hmac_hex_key of this CfsslAuthCredentials.
:type: str
"""
if hmac_hex_key is None:
raise ValueError("Invalid value for `hmac_hex_key`, must not be `None`")
if hmac_hex_key is not None and len(hmac_hex_key) > 64:
raise ValueError("Invalid value for `hmac_hex_key`, length must be less than or equal to `64`")
if hmac_hex_key is not None and not re.search('^([a-fA-F0-9][a-fA-F0-9]){1,32}$', hmac_hex_key):
raise ValueError("Invalid value for `hmac_hex_key`, must be a follow pattern or equal to `/^([a-fA-F0-9][a-fA-F0-9]){1,32}$/`")
self._hmac_hex_key = hmac_hex_key
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CfsslAuthCredentials):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CfsslAuthCredentials(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, hmac_hex_key=None):
'''
CfsslAuthCredentials - a model defined in Swagger
'''
pass
@property
def hmac_hex_key(self):
'''
Gets the hmac_hex_key of this CfsslAuthCredentials.
The key that is used to compute the HMAC of the request using the HMAC-SHA-256 algorithm. Must contain an even number of hexadecimal characters.
:return: The hmac_hex_key of this CfsslAuthCredentials.
:rtype: str
'''
pass
@hmac_hex_key.setter
def hmac_hex_key(self):
'''
Sets the hmac_hex_key of this CfsslAuthCredentials.
The key that is used to compute the HMAC of the request using the HMAC-SHA-256 algorithm. Must contain an even number of hexadecimal characters.
:param hmac_hex_key: The hmac_hex_key of this CfsslAuthCredentials.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 11 | 9 | 10 | 1 | 5 | 4 | 2 | 0.79 | 1 | 4 | 0 | 0 | 8 | 2 | 8 | 8 | 111 | 18 | 52 | 18 | 41 | 41 | 36 | 16 | 27 | 5 | 1 | 2 | 16 |
2,432 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/cfssl_attributes.py
|
mbed_cloud._backends.external_ca.models.cfssl_attributes.CfsslAttributes
|
class CfsslAttributes(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 = {
'cfssl_label': 'str',
'cfssl_profile': 'str',
'host_url': 'str'
}
attribute_map = {
'cfssl_label': 'cfssl_label',
'cfssl_profile': 'cfssl_profile',
'host_url': 'host_url'
}
def __init__(self, cfssl_label=None, cfssl_profile=None, host_url=None):
"""
CfsslAttributes - a model defined in Swagger
"""
self._cfssl_label = cfssl_label
self._cfssl_profile = cfssl_profile
self._host_url = host_url
self.discriminator = None
@property
def cfssl_label(self):
"""
Gets the cfssl_label of this CfsslAttributes.
The label that is used by CFSSL when creating the certificate.
:return: The cfssl_label of this CfsslAttributes.
:rtype: str
"""
return self._cfssl_label
@cfssl_label.setter
def cfssl_label(self, cfssl_label):
"""
Sets the cfssl_label of this CfsslAttributes.
The label that is used by CFSSL when creating the certificate.
:param cfssl_label: The cfssl_label of this CfsslAttributes.
:type: str
"""
self._cfssl_label = cfssl_label
@property
def cfssl_profile(self):
"""
Gets the cfssl_profile of this CfsslAttributes.
The profile that is configured on the CFSSL server and is used by CFSSL when creating the certificate.
:return: The cfssl_profile of this CfsslAttributes.
:rtype: str
"""
return self._cfssl_profile
@cfssl_profile.setter
def cfssl_profile(self, cfssl_profile):
"""
Sets the cfssl_profile of this CfsslAttributes.
The profile that is configured on the CFSSL server and is used by CFSSL when creating the certificate.
:param cfssl_profile: The cfssl_profile of this CfsslAttributes.
:type: str
"""
self._cfssl_profile = cfssl_profile
@property
def host_url(self):
"""
Gets the host_url of this CfsslAttributes.
The URL to connect to the CFSSL server.
:return: The host_url of this CfsslAttributes.
:rtype: str
"""
return self._host_url
@host_url.setter
def host_url(self, host_url):
"""
Sets the host_url of this CfsslAttributes.
The URL to connect to the CFSSL server.
:param host_url: The host_url of this CfsslAttributes.
:type: str
"""
if host_url is None:
raise ValueError("Invalid value for `host_url`, must not be `None`")
self._host_url = host_url
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CfsslAttributes):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CfsslAttributes(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, cfssl_label=None, cfssl_profile=None, host_url=None):
'''
CfsslAttributes - a model defined in Swagger
'''
pass
@property
def cfssl_label(self):
'''
Gets the cfssl_label of this CfsslAttributes.
The label that is used by CFSSL when creating the certificate.
:return: The cfssl_label of this CfsslAttributes.
:rtype: str
'''
pass
@cfssl_label.setter
def cfssl_label(self):
'''
Sets the cfssl_label of this CfsslAttributes.
The label that is used by CFSSL when creating the certificate.
:param cfssl_label: The cfssl_label of this CfsslAttributes.
:type: str
'''
pass
@property
def cfssl_profile(self):
'''
Gets the cfssl_profile of this CfsslAttributes.
The profile that is configured on the CFSSL server and is used by CFSSL when creating the certificate.
:return: The cfssl_profile of this CfsslAttributes.
:rtype: str
'''
pass
@cfssl_profile.setter
def cfssl_profile(self):
'''
Sets the cfssl_profile of this CfsslAttributes.
The profile that is configured on the CFSSL server and is used by CFSSL when creating the certificate.
:param cfssl_profile: The cfssl_profile of this CfsslAttributes.
:type: str
'''
pass
@property
def host_url(self):
'''
Gets the host_url of this CfsslAttributes.
The URL to connect to the CFSSL server.
:return: The host_url of this CfsslAttributes.
:rtype: str
'''
pass
@host_url.setter
def host_url(self):
'''
Sets the host_url of this CfsslAttributes.
The URL to connect to the CFSSL server.
:param host_url: The host_url of this CfsslAttributes.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 19 | 13 | 10 | 1 | 4 | 5 | 2 | 0.98 | 1 | 4 | 0 | 0 | 12 | 4 | 12 | 12 | 159 | 28 | 66 | 28 | 47 | 65 | 42 | 22 | 29 | 5 | 1 | 2 | 18 |
2,433 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/certificate_issuer_verify_response.py
|
mbed_cloud._backends.external_ca.models.certificate_issuer_verify_response.CertificateIssuerVerifyResponse
|
class CertificateIssuerVerifyResponse(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': 'str',
'successful': 'bool'
}
attribute_map = {
'message': 'message',
'successful': 'successful'
}
def __init__(self, message=None, successful=None):
"""
CertificateIssuerVerifyResponse - a model defined in Swagger
"""
self._message = message
self._successful = successful
self.discriminator = None
@property
def message(self):
"""
Gets the message of this CertificateIssuerVerifyResponse.
Provides details in case of failure.
:return: The message of this CertificateIssuerVerifyResponse.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this CertificateIssuerVerifyResponse.
Provides details in case of failure.
:param message: The message of this CertificateIssuerVerifyResponse.
:type: str
"""
self._message = message
@property
def successful(self):
"""
Gets the successful of this CertificateIssuerVerifyResponse.
Indicates whether the certificate issuer was verified successfully.
:return: The successful of this CertificateIssuerVerifyResponse.
:rtype: bool
"""
return self._successful
@successful.setter
def successful(self, successful):
"""
Sets the successful of this CertificateIssuerVerifyResponse.
Indicates whether the certificate issuer was verified successfully.
:param successful: The successful of this CertificateIssuerVerifyResponse.
:type: bool
"""
self._successful = successful
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CertificateIssuerVerifyResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CertificateIssuerVerifyResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, message=None, successful=None):
'''
CertificateIssuerVerifyResponse - a model defined in Swagger
'''
pass
@property
def message(self):
'''
Gets the message of this CertificateIssuerVerifyResponse.
Provides details in case of failure.
:return: The message of this CertificateIssuerVerifyResponse.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this CertificateIssuerVerifyResponse.
Provides details in case of failure.
:param message: The message of this CertificateIssuerVerifyResponse.
:type: str
'''
pass
@property
def successful(self):
'''
Gets the successful of this CertificateIssuerVerifyResponse.
Indicates whether the certificate issuer was verified successfully.
:return: The successful of this CertificateIssuerVerifyResponse.
:rtype: bool
'''
pass
@successful.setter
def successful(self):
'''
Sets the successful of this CertificateIssuerVerifyResponse.
Indicates whether the certificate issuer was verified successfully.
:param successful: The successful of this CertificateIssuerVerifyResponse.
:type: bool
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 9 | 1 | 4 | 4 | 2 | 0.96 | 1 | 3 | 0 | 0 | 10 | 3 | 10 | 10 | 131 | 23 | 55 | 23 | 40 | 53 | 35 | 19 | 24 | 5 | 1 | 2 | 15 |
2,434 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/certificate_issuer_update_request.py
|
mbed_cloud._backends.external_ca.models.certificate_issuer_update_request.CertificateIssuerUpdateRequest
|
class CertificateIssuerUpdateRequest(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 = {
'description': 'str',
'issuer_attributes': 'dict(str, str)',
'issuer_credentials': 'dict(str, str)',
'name': 'str'
}
attribute_map = {
'description': 'description',
'issuer_attributes': 'issuer_attributes',
'issuer_credentials': 'issuer_credentials',
'name': 'name'
}
def __init__(self, description=None, issuer_attributes=None, issuer_credentials=None, name=None):
"""
CertificateIssuerUpdateRequest - a model defined in Swagger
"""
self._description = description
self._issuer_attributes = issuer_attributes
self._issuer_credentials = issuer_credentials
self._name = name
self.discriminator = None
@property
def description(self):
"""
Gets the description of this CertificateIssuerUpdateRequest.
General description for the certificate issuer.
:return: The description of this CertificateIssuerUpdateRequest.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this CertificateIssuerUpdateRequest.
General description for the certificate issuer.
:param description: The description of this CertificateIssuerUpdateRequest.
:type: str
"""
if description is not None and len(description) > 100:
raise ValueError("Invalid value for `description`, length must be less than or equal to `100`")
self._description = description
@property
def issuer_attributes(self):
"""
Gets the issuer_attributes of this CertificateIssuerUpdateRequest.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:return: The issuer_attributes of this CertificateIssuerUpdateRequest.
:rtype: dict(str, str)
"""
return self._issuer_attributes
@issuer_attributes.setter
def issuer_attributes(self, issuer_attributes):
"""
Sets the issuer_attributes of this CertificateIssuerUpdateRequest.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:param issuer_attributes: The issuer_attributes of this CertificateIssuerUpdateRequest.
:type: dict(str, str)
"""
self._issuer_attributes = issuer_attributes
@property
def issuer_credentials(self):
"""
Gets the issuer_credentials of this CertificateIssuerUpdateRequest.
The credentials required for connecting to the certificate issuer. When the issuer_type is GLOBAL_SIGN, see definition of GlobalSignCredentials. When the issuer_type is CFSSL_AUTH, see definition of CfsslAuthCredentials.
:return: The issuer_credentials of this CertificateIssuerUpdateRequest.
:rtype: dict(str, str)
"""
return self._issuer_credentials
@issuer_credentials.setter
def issuer_credentials(self, issuer_credentials):
"""
Sets the issuer_credentials of this CertificateIssuerUpdateRequest.
The credentials required for connecting to the certificate issuer. When the issuer_type is GLOBAL_SIGN, see definition of GlobalSignCredentials. When the issuer_type is CFSSL_AUTH, see definition of CfsslAuthCredentials.
:param issuer_credentials: The issuer_credentials of this CertificateIssuerUpdateRequest.
:type: dict(str, str)
"""
self._issuer_credentials = issuer_credentials
@property
def name(self):
"""
Gets the name of this CertificateIssuerUpdateRequest.
Certificate issuer name.
:return: The name of this CertificateIssuerUpdateRequest.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this CertificateIssuerUpdateRequest.
Certificate issuer name.
:param name: The name of this CertificateIssuerUpdateRequest.
:type: str
"""
if name is not None and len(name) > 50:
raise ValueError("Invalid value for `name`, length must be less than or equal to `50`")
self._name = name
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CertificateIssuerUpdateRequest):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CertificateIssuerUpdateRequest(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, description=None, issuer_attributes=None, issuer_credentials=None, name=None):
'''
CertificateIssuerUpdateRequest - a model defined in Swagger
'''
pass
@property
def description(self):
'''
Gets the description of this CertificateIssuerUpdateRequest.
General description for the certificate issuer.
:return: The description of this CertificateIssuerUpdateRequest.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this CertificateIssuerUpdateRequest.
General description for the certificate issuer.
:param description: The description of this CertificateIssuerUpdateRequest.
:type: str
'''
pass
@property
def issuer_attributes(self):
'''
Gets the issuer_attributes of this CertificateIssuerUpdateRequest.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:return: The issuer_attributes of this CertificateIssuerUpdateRequest.
:rtype: dict(str, str)
'''
pass
@issuer_attributes.setter
def issuer_attributes(self):
'''
Sets the issuer_attributes of this CertificateIssuerUpdateRequest.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:param issuer_attributes: The issuer_attributes of this CertificateIssuerUpdateRequest.
:type: dict(str, str)
'''
pass
@property
def issuer_credentials(self):
'''
Gets the issuer_credentials of this CertificateIssuerUpdateRequest.
The credentials required for connecting to the certificate issuer. When the issuer_type is GLOBAL_SIGN, see definition of GlobalSignCredentials. When the issuer_type is CFSSL_AUTH, see definition of CfsslAuthCredentials.
:return: The issuer_credentials of this CertificateIssuerUpdateRequest.
:rtype: dict(str, str)
'''
pass
@issuer_credentials.setter
def issuer_credentials(self):
'''
Sets the issuer_credentials of this CertificateIssuerUpdateRequest.
The credentials required for connecting to the certificate issuer. When the issuer_type is GLOBAL_SIGN, see definition of GlobalSignCredentials. When the issuer_type is CFSSL_AUTH, see definition of CfsslAuthCredentials.
:param issuer_credentials: The issuer_credentials of this CertificateIssuerUpdateRequest.
:type: dict(str, str)
'''
pass
@property
def name(self):
'''
Gets the name of this CertificateIssuerUpdateRequest.
Certificate issuer name.
:return: The name of this CertificateIssuerUpdateRequest.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this CertificateIssuerUpdateRequest.
Certificate issuer name.
:param name: The name of this CertificateIssuerUpdateRequest.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 23 | 15 | 10 | 1 | 4 | 5 | 2 | 1 | 1 | 4 | 0 | 0 | 14 | 5 | 14 | 14 | 187 | 33 | 77 | 33 | 54 | 77 | 49 | 25 | 34 | 5 | 1 | 2 | 21 |
2,435 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/certificate_issuer_request.py
|
mbed_cloud._backends.external_ca.models.certificate_issuer_request.CertificateIssuerRequest
|
class CertificateIssuerRequest(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 = {
'description': 'str',
'issuer_attributes': 'dict(str, str)',
'issuer_credentials': 'dict(str, str)',
'issuer_type': 'str',
'name': 'str'
}
attribute_map = {
'description': 'description',
'issuer_attributes': 'issuer_attributes',
'issuer_credentials': 'issuer_credentials',
'issuer_type': 'issuer_type',
'name': 'name'
}
def __init__(self, description=None, issuer_attributes=None, issuer_credentials=None, issuer_type=None, name=None):
"""
CertificateIssuerRequest - a model defined in Swagger
"""
self._description = description
self._issuer_attributes = issuer_attributes
self._issuer_credentials = issuer_credentials
self._issuer_type = issuer_type
self._name = name
self.discriminator = None
@property
def description(self):
"""
Gets the description of this CertificateIssuerRequest.
General description for the certificate issuer.
:return: The description of this CertificateIssuerRequest.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this CertificateIssuerRequest.
General description for the certificate issuer.
:param description: The description of this CertificateIssuerRequest.
:type: str
"""
if description is not None and len(description) > 100:
raise ValueError("Invalid value for `description`, length must be less than or equal to `100`")
self._description = description
@property
def issuer_attributes(self):
"""
Gets the issuer_attributes of this CertificateIssuerRequest.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:return: The issuer_attributes of this CertificateIssuerRequest.
:rtype: dict(str, str)
"""
return self._issuer_attributes
@issuer_attributes.setter
def issuer_attributes(self, issuer_attributes):
"""
Sets the issuer_attributes of this CertificateIssuerRequest.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:param issuer_attributes: The issuer_attributes of this CertificateIssuerRequest.
:type: dict(str, str)
"""
self._issuer_attributes = issuer_attributes
@property
def issuer_credentials(self):
"""
Gets the issuer_credentials of this CertificateIssuerRequest.
The credentials required for connecting to the certificate issuer. When the issuer_type is GLOBAL_SIGN, see definition of GlobalSignCredentials. When the issuer_type is CFSSL_AUTH, see definition of CfsslAuthCredentials.
:return: The issuer_credentials of this CertificateIssuerRequest.
:rtype: dict(str, str)
"""
return self._issuer_credentials
@issuer_credentials.setter
def issuer_credentials(self, issuer_credentials):
"""
Sets the issuer_credentials of this CertificateIssuerRequest.
The credentials required for connecting to the certificate issuer. When the issuer_type is GLOBAL_SIGN, see definition of GlobalSignCredentials. When the issuer_type is CFSSL_AUTH, see definition of CfsslAuthCredentials.
:param issuer_credentials: The issuer_credentials of this CertificateIssuerRequest.
:type: dict(str, str)
"""
self._issuer_credentials = issuer_credentials
@property
def issuer_type(self):
"""
Gets the issuer_type of this CertificateIssuerRequest.
The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
:return: The issuer_type of this CertificateIssuerRequest.
:rtype: str
"""
return self._issuer_type
@issuer_type.setter
def issuer_type(self, issuer_type):
"""
Sets the issuer_type of this CertificateIssuerRequest.
The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
:param issuer_type: The issuer_type of this CertificateIssuerRequest.
:type: str
"""
if issuer_type is None:
raise ValueError("Invalid value for `issuer_type`, must not be `None`")
allowed_values = ["GLOBAL_SIGN", "CFSSL_AUTH"]
if issuer_type not in allowed_values:
raise ValueError(
"Invalid value for `issuer_type` ({0}), must be one of {1}"
.format(issuer_type, allowed_values)
)
self._issuer_type = issuer_type
@property
def name(self):
"""
Gets the name of this CertificateIssuerRequest.
Certificate issuer name, unique per account.
:return: The name of this CertificateIssuerRequest.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this CertificateIssuerRequest.
Certificate issuer name, unique per account.
:param name: The name of this CertificateIssuerRequest.
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`")
if name is not None and len(name) > 50:
raise ValueError("Invalid value for `name`, length must be less than or equal to `50`")
self._name = name
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CertificateIssuerRequest):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CertificateIssuerRequest(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, description=None, issuer_attributes=None, issuer_credentials=None, issuer_type=None, name=None):
'''
CertificateIssuerRequest - a model defined in Swagger
'''
pass
@property
def description(self):
'''
Gets the description of this CertificateIssuerRequest.
General description for the certificate issuer.
:return: The description of this CertificateIssuerRequest.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this CertificateIssuerRequest.
General description for the certificate issuer.
:param description: The description of this CertificateIssuerRequest.
:type: str
'''
pass
@property
def issuer_attributes(self):
'''
Gets the issuer_attributes of this CertificateIssuerRequest.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:return: The issuer_attributes of this CertificateIssuerRequest.
:rtype: dict(str, str)
'''
pass
@issuer_attributes.setter
def issuer_attributes(self):
'''
Sets the issuer_attributes of this CertificateIssuerRequest.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:param issuer_attributes: The issuer_attributes of this CertificateIssuerRequest.
:type: dict(str, str)
'''
pass
@property
def issuer_credentials(self):
'''
Gets the issuer_credentials of this CertificateIssuerRequest.
The credentials required for connecting to the certificate issuer. When the issuer_type is GLOBAL_SIGN, see definition of GlobalSignCredentials. When the issuer_type is CFSSL_AUTH, see definition of CfsslAuthCredentials.
:return: The issuer_credentials of this CertificateIssuerRequest.
:rtype: dict(str, str)
'''
pass
@issuer_credentials.setter
def issuer_credentials(self):
'''
Sets the issuer_credentials of this CertificateIssuerRequest.
The credentials required for connecting to the certificate issuer. When the issuer_type is GLOBAL_SIGN, see definition of GlobalSignCredentials. When the issuer_type is CFSSL_AUTH, see definition of CfsslAuthCredentials.
:param issuer_credentials: The issuer_credentials of this CertificateIssuerRequest.
:type: dict(str, str)
'''
pass
@property
def issuer_type(self):
'''
Gets the issuer_type of this CertificateIssuerRequest.
The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
:return: The issuer_type of this CertificateIssuerRequest.
:rtype: str
'''
pass
@issuer_type.setter
def issuer_type(self):
'''
Sets the issuer_type of this CertificateIssuerRequest.
The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
:param issuer_type: The issuer_type of this CertificateIssuerRequest.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this CertificateIssuerRequest.
Certificate issuer name, unique per account.
:return: The name of this CertificateIssuerRequest.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this CertificateIssuerRequest.
Certificate issuer name, unique per account.
:param name: The name of this CertificateIssuerRequest.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 27 | 17 | 11 | 1 | 4 | 5 | 2 | 0.93 | 1 | 4 | 0 | 0 | 16 | 6 | 16 | 16 | 223 | 38 | 96 | 39 | 69 | 89 | 61 | 29 | 44 | 5 | 1 | 2 | 26 |
2,436 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/certificate_issuer_info_list_response.py
|
mbed_cloud._backends.external_ca.models.certificate_issuer_info_list_response.CertificateIssuerInfoListResponse
|
class CertificateIssuerInfoListResponse(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 = {
'after': 'str',
'data': 'list[CertificateIssuerInfo]',
'limit': 'int',
'object': 'str',
'order': 'str',
'total_count': 'int'
}
attribute_map = {
'after': 'after',
'data': 'data',
'limit': 'limit',
'object': 'object',
'order': 'order',
'total_count': 'total_count'
}
def __init__(self, after=None, data=None, limit=None, object=None, order=None, total_count=None):
"""
CertificateIssuerInfoListResponse - a model defined in Swagger
"""
self._after = after
self._data = data
self._limit = limit
self._object = object
self._order = order
self._total_count = total_count
self.discriminator = None
@property
def after(self):
"""
Gets the after of this CertificateIssuerInfoListResponse.
The entity ID to fetch after current result set.
:return: The after of this CertificateIssuerInfoListResponse.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this CertificateIssuerInfoListResponse.
The entity ID to fetch after current result set.
:param after: The after of this CertificateIssuerInfoListResponse.
:type: str
"""
self._after = after
@property
def data(self):
"""
Gets the data of this CertificateIssuerInfoListResponse.
List of certificate issuers.
:return: The data of this CertificateIssuerInfoListResponse.
:rtype: list[CertificateIssuerInfo]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this CertificateIssuerInfoListResponse.
List of certificate issuers.
:param data: The data of this CertificateIssuerInfoListResponse.
:type: list[CertificateIssuerInfo]
"""
self._data = data
@property
def limit(self):
"""
Gets the limit of this CertificateIssuerInfoListResponse.
The number of results returned.
:return: The limit of this CertificateIssuerInfoListResponse.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this CertificateIssuerInfoListResponse.
The number of results returned.
:param limit: The limit of this CertificateIssuerInfoListResponse.
:type: int
"""
self._limit = limit
@property
def object(self):
"""
Gets the object of this CertificateIssuerInfoListResponse.
Describes the type of objects in the list.
:return: The object of this CertificateIssuerInfoListResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this CertificateIssuerInfoListResponse.
Describes the type of objects in the list.
:param object: The object of this CertificateIssuerInfoListResponse.
:type: str
"""
allowed_values = ["list"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def order(self):
"""
Gets the order of this CertificateIssuerInfoListResponse.
The order of results.
:return: The order of this CertificateIssuerInfoListResponse.
:rtype: str
"""
return self._order
@order.setter
def order(self, order):
"""
Sets the order of this CertificateIssuerInfoListResponse.
The order of results.
:param order: The order of this CertificateIssuerInfoListResponse.
:type: str
"""
allowed_values = ["ASC", "DESC"]
if order not in allowed_values:
raise ValueError(
"Invalid value for `order` ({0}), must be one of {1}"
.format(order, allowed_values)
)
self._order = order
@property
def total_count(self):
"""
Gets the total_count of this CertificateIssuerInfoListResponse.
The total number or records.
:return: The total_count of this CertificateIssuerInfoListResponse.
:rtype: int
"""
return self._total_count
@total_count.setter
def total_count(self, total_count):
"""
Sets the total_count of this CertificateIssuerInfoListResponse.
The total number or records.
:param total_count: The total_count of this CertificateIssuerInfoListResponse.
:type: int
"""
self._total_count = total_count
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CertificateIssuerInfoListResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CertificateIssuerInfoListResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, data=None, limit=None, object=None, order=None, total_count=None):
'''
CertificateIssuerInfoListResponse - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this CertificateIssuerInfoListResponse.
The entity ID to fetch after current result set.
:return: The after of this CertificateIssuerInfoListResponse.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this CertificateIssuerInfoListResponse.
The entity ID to fetch after current result set.
:param after: The after of this CertificateIssuerInfoListResponse.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this CertificateIssuerInfoListResponse.
List of certificate issuers.
:return: The data of this CertificateIssuerInfoListResponse.
:rtype: list[CertificateIssuerInfo]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this CertificateIssuerInfoListResponse.
List of certificate issuers.
:param data: The data of this CertificateIssuerInfoListResponse.
:type: list[CertificateIssuerInfo]
'''
pass
@property
def limit(self):
'''
Gets the limit of this CertificateIssuerInfoListResponse.
The number of results returned.
:return: The limit of this CertificateIssuerInfoListResponse.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this CertificateIssuerInfoListResponse.
The number of results returned.
:param limit: The limit of this CertificateIssuerInfoListResponse.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this CertificateIssuerInfoListResponse.
Describes the type of objects in the list.
:return: The object of this CertificateIssuerInfoListResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this CertificateIssuerInfoListResponse.
Describes the type of objects in the list.
:param object: The object of this CertificateIssuerInfoListResponse.
:type: str
'''
pass
@property
def order(self):
'''
Gets the order of this CertificateIssuerInfoListResponse.
The order of results.
:return: The order of this CertificateIssuerInfoListResponse.
:rtype: str
'''
pass
@order.setter
def order(self):
'''
Sets the order of this CertificateIssuerInfoListResponse.
The order of results.
:param order: The order of this CertificateIssuerInfoListResponse.
:type: str
'''
pass
@property
def total_count(self):
'''
Gets the total_count of this CertificateIssuerInfoListResponse.
The total number or records.
:return: The total_count of this CertificateIssuerInfoListResponse.
:rtype: int
'''
pass
@total_count.setter
def total_count(self):
'''
Sets the total_count of this CertificateIssuerInfoListResponse.
The total number or records.
:param total_count: The total_count of this CertificateIssuerInfoListResponse.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 10 | 1 | 4 | 5 | 1 | 0.98 | 1 | 4 | 0 | 0 | 18 | 7 | 18 | 18 | 247 | 43 | 103 | 45 | 72 | 101 | 61 | 33 | 42 | 5 | 1 | 2 | 25 |
2,437 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/external_ca/models/certificate_issuer_info.py
|
mbed_cloud._backends.external_ca.models.certificate_issuer_info.CertificateIssuerInfo
|
class CertificateIssuerInfo(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 = {
'created_at': 'datetime',
'description': 'str',
'etag': 'str',
'id': 'str',
'issuer_attributes': 'dict(str, str)',
'issuer_type': 'str',
'name': 'str',
'object': 'str'
}
attribute_map = {
'created_at': 'created_at',
'description': 'description',
'etag': 'etag',
'id': 'id',
'issuer_attributes': 'issuer_attributes',
'issuer_type': 'issuer_type',
'name': 'name',
'object': 'object'
}
def __init__(self, created_at=None, description=None, etag=None, id=None, issuer_attributes=None, issuer_type=None, name=None, object=None):
"""
CertificateIssuerInfo - a model defined in Swagger
"""
self._created_at = created_at
self._description = description
self._etag = etag
self._id = id
self._issuer_attributes = issuer_attributes
self._issuer_type = issuer_type
self._name = name
self._object = object
self.discriminator = None
@property
def created_at(self):
"""
Gets the created_at of this CertificateIssuerInfo.
Creation UTC time RFC3339.
:return: The created_at of this CertificateIssuerInfo.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this CertificateIssuerInfo.
Creation UTC time RFC3339.
:param created_at: The created_at of this CertificateIssuerInfo.
:type: datetime
"""
self._created_at = created_at
@property
def description(self):
"""
Gets the description of this CertificateIssuerInfo.
General description for the certificate issuer.
:return: The description of this CertificateIssuerInfo.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this CertificateIssuerInfo.
General description for the certificate issuer.
:param description: The description of this CertificateIssuerInfo.
:type: str
"""
if description is not None and len(description) > 100:
raise ValueError("Invalid value for `description`, length must be less than or equal to `100`")
self._description = description
@property
def etag(self):
"""
Gets the etag of this CertificateIssuerInfo.
Entity instance signature.
:return: The etag of this CertificateIssuerInfo.
:rtype: str
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this CertificateIssuerInfo.
Entity instance signature.
:param etag: The etag of this CertificateIssuerInfo.
:type: str
"""
self._etag = etag
@property
def id(self):
"""
Gets the id of this CertificateIssuerInfo.
The ID of the certificate issuer.
:return: The id of this CertificateIssuerInfo.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this CertificateIssuerInfo.
The ID of the certificate issuer.
:param id: The id of this CertificateIssuerInfo.
:type: str
"""
self._id = id
@property
def issuer_attributes(self):
"""
Gets the issuer_attributes of this CertificateIssuerInfo.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:return: The issuer_attributes of this CertificateIssuerInfo.
:rtype: dict(str, str)
"""
return self._issuer_attributes
@issuer_attributes.setter
def issuer_attributes(self, issuer_attributes):
"""
Sets the issuer_attributes of this CertificateIssuerInfo.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:param issuer_attributes: The issuer_attributes of this CertificateIssuerInfo.
:type: dict(str, str)
"""
self._issuer_attributes = issuer_attributes
@property
def issuer_type(self):
"""
Gets the issuer_type of this CertificateIssuerInfo.
The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
:return: The issuer_type of this CertificateIssuerInfo.
:rtype: str
"""
return self._issuer_type
@issuer_type.setter
def issuer_type(self, issuer_type):
"""
Sets the issuer_type of this CertificateIssuerInfo.
The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
:param issuer_type: The issuer_type of this CertificateIssuerInfo.
:type: str
"""
if issuer_type is None:
raise ValueError("Invalid value for `issuer_type`, must not be `None`")
allowed_values = ["GLOBAL_SIGN", "CFSSL_AUTH"]
if issuer_type not in allowed_values:
raise ValueError(
"Invalid value for `issuer_type` ({0}), must be one of {1}"
.format(issuer_type, allowed_values)
)
self._issuer_type = issuer_type
@property
def name(self):
"""
Gets the name of this CertificateIssuerInfo.
Certificate issuer name, unique per account.
:return: The name of this CertificateIssuerInfo.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this CertificateIssuerInfo.
Certificate issuer name, unique per account.
:param name: The name of this CertificateIssuerInfo.
:type: str
"""
if name is not None and len(name) > 50:
raise ValueError("Invalid value for `name`, length must be less than or equal to `50`")
self._name = name
@property
def object(self):
"""
Gets the object of this CertificateIssuerInfo.
:return: The object of this CertificateIssuerInfo.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this CertificateIssuerInfo.
:param object: The object of this CertificateIssuerInfo.
:type: str
"""
allowed_values = ["certificate-issuer"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CertificateIssuerInfo):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CertificateIssuerInfo(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created_at=None, description=None, etag=None, id=None, issuer_attributes=None, issuer_type=None, name=None, object=None):
'''
CertificateIssuerInfo - a model defined in Swagger
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this CertificateIssuerInfo.
Creation UTC time RFC3339.
:return: The created_at of this CertificateIssuerInfo.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this CertificateIssuerInfo.
Creation UTC time RFC3339.
:param created_at: The created_at of this CertificateIssuerInfo.
:type: datetime
'''
pass
@property
def description(self):
'''
Gets the description of this CertificateIssuerInfo.
General description for the certificate issuer.
:return: The description of this CertificateIssuerInfo.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this CertificateIssuerInfo.
General description for the certificate issuer.
:param description: The description of this CertificateIssuerInfo.
:type: str
'''
pass
@property
def etag(self):
'''
Gets the etag of this CertificateIssuerInfo.
Entity instance signature.
:return: The etag of this CertificateIssuerInfo.
:rtype: str
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this CertificateIssuerInfo.
Entity instance signature.
:param etag: The etag of this CertificateIssuerInfo.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this CertificateIssuerInfo.
The ID of the certificate issuer.
:return: The id of this CertificateIssuerInfo.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this CertificateIssuerInfo.
The ID of the certificate issuer.
:param id: The id of this CertificateIssuerInfo.
:type: str
'''
pass
@property
def issuer_attributes(self):
'''
Gets the issuer_attributes of this CertificateIssuerInfo.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:return: The issuer_attributes of this CertificateIssuerInfo.
:rtype: dict(str, str)
'''
pass
@issuer_attributes.setter
def issuer_attributes(self):
'''
Sets the issuer_attributes of this CertificateIssuerInfo.
General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
:param issuer_attributes: The issuer_attributes of this CertificateIssuerInfo.
:type: dict(str, str)
'''
pass
@property
def issuer_type(self):
'''
Gets the issuer_type of this CertificateIssuerInfo.
The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
:return: The issuer_type of this CertificateIssuerInfo.
:rtype: str
'''
pass
@issuer_type.setter
def issuer_type(self):
'''
Sets the issuer_type of this CertificateIssuerInfo.
The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
:param issuer_type: The issuer_type of this CertificateIssuerInfo.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this CertificateIssuerInfo.
Certificate issuer name, unique per account.
:return: The name of this CertificateIssuerInfo.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this CertificateIssuerInfo.
Certificate issuer name, unique per account.
:param name: The name of this CertificateIssuerInfo.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this CertificateIssuerInfo.
:return: The object of this CertificateIssuerInfo.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this CertificateIssuerInfo.
:param object: The object of this CertificateIssuerInfo.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 39 | 23 | 10 | 1 | 4 | 5 | 1 | 0.97 | 1 | 4 | 0 | 0 | 22 | 9 | 22 | 22 | 303 | 53 | 127 | 55 | 88 | 123 | 77 | 39 | 54 | 5 | 1 | 2 | 32 |
2,438 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/apis/account_admin_api.py
|
mbed_cloud._backends.iam.apis.account_admin_api.AccountAdminApi
|
class AccountAdminApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def add_api_key_to_groups(self, api_key, body, **kwargs): # noqa: E501
"""Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_api_key_to_groups(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.add_api_key_to_groups_with_http_info(api_key, body, **kwargs) # noqa: E501
else:
(data) = self.add_api_key_to_groups_with_http_info(api_key, body, **kwargs) # noqa: E501
return data
def add_api_key_to_groups_with_http_info(self, api_key, body, **kwargs): # noqa: E501
"""Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_api_key_to_groups_with_http_info(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['api_key', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method add_api_key_to_groups" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `add_api_key_to_groups`") # 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 `add_api_key_to_groups`") # noqa: E501
collection_formats = {}
path_params = {}
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/{apiKey}/groups', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 add_certificate(self, body, **kwargs): # noqa: E501
"""Upload a new trusted certificate. # noqa: E501
An endpoint for uploading new trusted certificates. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/trusted-certificates -d {\"name\": \"myCert1\", \"description\": \"very important cert\", \"certificate\": \"certificate_data\", \"service\": \"lwm2m\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_certificate(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param TrustedCertificateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.add_certificate_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.add_certificate_with_http_info(body, **kwargs) # noqa: E501
return data
def add_certificate_with_http_info(self, body, **kwargs): # noqa: E501
"""Upload a new trusted certificate. # noqa: E501
An endpoint for uploading new trusted certificates. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/trusted-certificates -d {\"name\": \"myCert1\", \"description\": \"very important cert\", \"certificate\": \"certificate_data\", \"service\": \"lwm2m\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_certificate_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param TrustedCertificateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method add_certificate" % 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 `add_certificate`") # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/trusted-certificates', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TrustedCertificateResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 add_subjects_to_group(self, group_id, body, **kwargs): # noqa: E501
"""Add members to a group. # noqa: E501
An endpoint for adding users and API keys to a group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -d '{\"users\": [0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_subjects_to_group(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be updated. (required)
:param SubjectList body: A list of users and API keys to be added to the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.add_subjects_to_group_with_http_info(group_id, body, **kwargs) # noqa: E501
else:
(data) = self.add_subjects_to_group_with_http_info(group_id, body, **kwargs) # noqa: E501
return data
def add_subjects_to_group_with_http_info(self, group_id, body, **kwargs): # noqa: E501
"""Add members to a group. # noqa: E501
An endpoint for adding users and API keys to a group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -d '{\"users\": [0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_subjects_to_group_with_http_info(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be updated. (required)
:param SubjectList body: A list of users and API keys to be added to the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['group_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method add_subjects_to_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `add_subjects_to_group`") # 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 `add_subjects_to_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'group_id' in params:
path_params['groupID'] = params['group_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/policy-groups/{groupID}', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 add_user_to_groups(self, user_id, body, **kwargs): # noqa: E501
"""Add user to a list of groups. # noqa: E501
An endpoint for adding user to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_user_to_groups(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.add_user_to_groups_with_http_info(user_id, body, **kwargs) # noqa: E501
else:
(data) = self.add_user_to_groups_with_http_info(user_id, body, **kwargs) # noqa: E501
return data
def add_user_to_groups_with_http_info(self, user_id, body, **kwargs): # noqa: E501
"""Add user to a list of groups. # noqa: E501
An endpoint for adding user to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_user_to_groups_with_http_info(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['user_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method add_user_to_groups" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `add_user_to_groups`") # 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 `add_user_to_groups`") # noqa: E501
collection_formats = {}
path_params = {}
if 'user_id' in params:
path_params['user-id'] = params['user_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/users/{user-id}/groups', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def create_group(self, body, **kwargs): # noqa: E501
"""Create a new group. # noqa: E501
An endpoint for creating a new group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/policy-groups -d '{\"name\": \"MyGroup1\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_group(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param GroupCreationInfo body: Details of the group to be created. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.create_group_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.create_group_with_http_info(body, **kwargs) # noqa: E501
return data
def create_group_with_http_info(self, body, **kwargs): # noqa: E501
"""Create a new group. # noqa: E501
An endpoint for creating a new group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/policy-groups -d '{\"name\": \"MyGroup1\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_group_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param GroupCreationInfo body: Details of the group to be created. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_group" % 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 `create_group`") # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/policy-groups', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummary', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def create_invitation(self, body, **kwargs): # noqa: E501
"""Create a user invitation. # noqa: E501
An endpoint for inviting a new or an existing user to join the account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/user-invitations -d {\"email\": \"[email protected]\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_invitation(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param UserInvitationReq body: A user invitation object with attributes. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.create_invitation_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.create_invitation_with_http_info(body, **kwargs) # noqa: E501
return data
def create_invitation_with_http_info(self, body, **kwargs): # noqa: E501
"""Create a user invitation. # noqa: E501
An endpoint for inviting a new or an existing user to join the account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/user-invitations -d {\"email\": \"[email protected]\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_invitation_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param UserInvitationReq body: A user invitation object with attributes. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_invitation" % 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 `create_invitation`") # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/user-invitations', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInvitationResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def create_user(self, body, **kwargs): # noqa: E501
"""Create a new user. # noqa: E501
An endpoint for creating or inviting a new user to the account. In case of invitation email address is used only, other attributes are set in the 2nd step. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/users?action=invite -d {\"email\": \"[email protected]\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_user(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param UserInfoReq body: A user object with attributes. (required)
:param str action: Action, either 'create' or 'invite'.
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.create_user_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.create_user_with_http_info(body, **kwargs) # noqa: E501
return data
def create_user_with_http_info(self, body, **kwargs): # noqa: E501
"""Create a new user. # noqa: E501
An endpoint for creating or inviting a new user to the account. In case of invitation email address is used only, other attributes are set in the 2nd step. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/users?action=invite -d {\"email\": \"[email protected]\"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_user_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param UserInfoReq body: A user object with attributes. (required)
:param str action: Action, either 'create' or 'invite'.
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body', 'action'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_user" % 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 `create_user`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'action' in params:
query_params.append(('action', params['action'])) # noqa: E501
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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/users', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_group(self, group_id, **kwargs): # noqa: E501
"""Delete a group. # noqa: E501
An endpoint for deleting a group. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_group(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group 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('asynchronous'):
return self.delete_group_with_http_info(group_id, **kwargs) # noqa: E501
else:
(data) = self.delete_group_with_http_info(group_id, **kwargs) # noqa: E501
return data
def delete_group_with_http_info(self, group_id, **kwargs): # noqa: E501
"""Delete a group. # noqa: E501
An endpoint for deleting a group. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_group_with_http_info(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['group_id'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `delete_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'group_id' in params:
path_params['groupID'] = params['group_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/policy-groups/{groupID}', '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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_invitation(self, invitation_id, **kwargs): # noqa: E501
"""Delete a user invitation. # noqa: E501
An endpoint for deleting an active user invitation which has been sent for a new or an existing user to join the account. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_invitation(invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str invitation_id: The ID of the invitation 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('asynchronous'):
return self.delete_invitation_with_http_info(invitation_id, **kwargs) # noqa: E501
else:
(data) = self.delete_invitation_with_http_info(invitation_id, **kwargs) # noqa: E501
return data
def delete_invitation_with_http_info(self, invitation_id, **kwargs): # noqa: E501
"""Delete a user invitation. # noqa: E501
An endpoint for deleting an active user invitation which has been sent for a new or an existing user to join the account. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_invitation_with_http_info(invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str invitation_id: The ID of the invitation to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['invitation_id'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_invitation" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'invitation_id' is set
if ('invitation_id' not in params or
params['invitation_id'] is None):
raise ValueError("Missing the required parameter `invitation_id` when calling `delete_invitation`") # noqa: E501
collection_formats = {}
path_params = {}
if 'invitation_id' in params:
path_params['invitation-id'] = params['invitation_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/user-invitations/{invitation-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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_user(self, user_id, **kwargs): # noqa: E501
"""Delete a user. # noqa: E501
An endpoint for deleting a user. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_user(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user 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('asynchronous'):
return self.delete_user_with_http_info(user_id, **kwargs) # noqa: E501
else:
(data) = self.delete_user_with_http_info(user_id, **kwargs) # noqa: E501
return data
def delete_user_with_http_info(self, user_id, **kwargs): # noqa: E501
"""Delete a user. # noqa: E501
An endpoint for deleting a user. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_user_with_http_info(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['user_id'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `delete_user`") # noqa: E501
collection_formats = {}
path_params = {}
if 'user_id' in params:
path_params['user-id'] = params['user_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/users/{user-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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_invitations(self, **kwargs): # noqa: E501
"""Get the details of all the user invitations. # noqa: E501
An endpoint for retrieving the details of all the active user invitations sent for new or existing users to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/user-invitations -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_invitations(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:return: UserInvitationRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_invitations_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_all_invitations_with_http_info(**kwargs) # noqa: E501
return data
def get_all_invitations_with_http_info(self, **kwargs): # noqa: E501
"""Get the details of all the user invitations. # noqa: E501
An endpoint for retrieving the details of all the active user invitations sent for new or existing users to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/user-invitations -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_invitations_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:return: UserInvitationRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'after', 'order'] # noqa: E501
all_params.append('asynchronous')
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_all_invitations" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/user-invitations', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInvitationRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_all_users(self, **kwargs): # noqa: E501
"""Get the details of all users. # noqa: E501
An endpoint for retrieving the details of all users. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_users(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str email__eq: Filter for email address
:param str status__eq: Filter for status, for example active or reset
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_users_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_all_users_with_http_info(**kwargs) # noqa: E501
return data
def get_all_users_with_http_info(self, **kwargs): # noqa: E501
"""Get the details of all users. # noqa: E501
An endpoint for retrieving the details of all users. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_users_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str email__eq: Filter for email address
:param str status__eq: Filter for status, for example active or reset
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'after', 'order', 'include', 'email__eq', 'status__eq', 'status__in', 'status__nin'] # noqa: E501
all_params.append('asynchronous')
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_all_users" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'email__eq' in params:
query_params.append(('email__eq', params['email__eq'])) # noqa: E501
if 'status__eq' in params:
query_params.append(('status__eq', params['status__eq'])) # noqa: E501
if 'status__in' in params:
query_params.append(('status__in', params['status__in'])) # noqa: E501
if 'status__nin' in params:
query_params.append(('status__nin', params['status__nin'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/users', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInfoRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_groups_of_apikey(self, api_key, **kwargs): # noqa: E501
"""Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_apikey(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_groups_of_apikey_with_http_info(api_key, **kwargs) # noqa: E501
else:
(data) = self.get_groups_of_apikey_with_http_info(api_key, **kwargs) # noqa: E501
return data
def get_groups_of_apikey_with_http_info(self, api_key, **kwargs): # noqa: E501
"""Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_apikey_with_http_info(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['api_key', 'limit', 'after', 'order', 'include'] # noqa: E501
all_params.append('asynchronous')
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_groups_of_apikey" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `get_groups_of_apikey`") # noqa: E501
collection_formats = {}
path_params = {}
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/{apiKey}/groups', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummaryList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_groups_of_user(self, user_id, **kwargs): # noqa: E501
"""Get groups of the user. # noqa: E501
An endpoint for retrieving groups of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_user(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_groups_of_user_with_http_info(user_id, **kwargs) # noqa: E501
else:
(data) = self.get_groups_of_user_with_http_info(user_id, **kwargs) # noqa: E501
return data
def get_groups_of_user_with_http_info(self, user_id, **kwargs): # noqa: E501
"""Get groups of the user. # noqa: E501
An endpoint for retrieving groups of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_user_with_http_info(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['user_id', 'limit', 'after', 'order', 'include'] # noqa: E501
all_params.append('asynchronous')
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_groups_of_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `get_groups_of_user`") # noqa: E501
collection_formats = {}
path_params = {}
if 'user_id' in params:
path_params['user-id'] = params['user_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/users/{user-id}/groups', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GroupSummaryList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_invitation(self, invitation_id, **kwargs): # noqa: E501
"""Details of a user invitation. # noqa: E501
An endpoint for retrieving the details of an active user invitation sent for a new or an existing user to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_invitation(invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str invitation_id: The ID of the invitation to be retrieved. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_invitation_with_http_info(invitation_id, **kwargs) # noqa: E501
else:
(data) = self.get_invitation_with_http_info(invitation_id, **kwargs) # noqa: E501
return data
def get_invitation_with_http_info(self, invitation_id, **kwargs): # noqa: E501
"""Details of a user invitation. # noqa: E501
An endpoint for retrieving the details of an active user invitation sent for a new or an existing user to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_invitation_with_http_info(invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str invitation_id: The ID of the invitation to be retrieved. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['invitation_id'] # noqa: E501
all_params.append('asynchronous')
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_invitation" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'invitation_id' is set
if ('invitation_id' not in params or
params['invitation_id'] is None):
raise ValueError("Missing the required parameter `invitation_id` when calling `get_invitation`") # noqa: E501
collection_formats = {}
path_params = {}
if 'invitation_id' in params:
path_params['invitation-id'] = params['invitation_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/user-invitations/{invitation-id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInvitationResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_user(self, user_id, **kwargs): # noqa: E501
"""Details of a user. # noqa: E501
An endpoint for retrieving the details of a user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_user(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are retrieved. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_user_with_http_info(user_id, **kwargs) # noqa: E501
else:
(data) = self.get_user_with_http_info(user_id, **kwargs) # noqa: E501
return data
def get_user_with_http_info(self, user_id, **kwargs): # noqa: E501
"""Details of a user. # noqa: E501
An endpoint for retrieving the details of a user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_user_with_http_info(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are retrieved. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['user_id'] # noqa: E501
all_params.append('asynchronous')
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_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `get_user`") # noqa: E501
collection_formats = {}
path_params = {}
if 'user_id' in params:
path_params['user-id'] = params['user_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/users/{user-id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_users_of_group(self, group_id, **kwargs): # noqa: E501
"""Get users of a group. # noqa: E501
An endpoint for listing the users of a group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_users_of_group(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose users are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str status__eq: An optional filter for getting users by status.
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_users_of_group_with_http_info(group_id, **kwargs) # noqa: E501
else:
(data) = self.get_users_of_group_with_http_info(group_id, **kwargs) # noqa: E501
return data
def get_users_of_group_with_http_info(self, group_id, **kwargs): # noqa: E501
"""Get users of a group. # noqa: E501
An endpoint for listing the users of a group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_users_of_group_with_http_info(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose users are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str status__eq: An optional filter for getting users by status.
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['group_id', 'limit', 'after', 'order', 'include', 'status__eq', 'status__in', 'status__nin'] # noqa: E501
all_params.append('asynchronous')
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_users_of_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `get_users_of_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'group_id' in params:
path_params['groupID'] = params['group_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'status__eq' in params:
query_params.append(('status__eq', params['status__eq'])) # noqa: E501
if 'status__in' in params:
query_params.append(('status__in', params['status__in'])) # noqa: E501
if 'status__nin' in params:
query_params.append(('status__nin', params['status__nin'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/policy-groups/{groupID}/users', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInfoRespList', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def remove_api_key_from_groups(self, api_key, body, **kwargs): # noqa: E501
"""Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_key_from_groups(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.remove_api_key_from_groups_with_http_info(api_key, body, **kwargs) # noqa: E501
else:
(data) = self.remove_api_key_from_groups_with_http_info(api_key, body, **kwargs) # noqa: E501
return data
def remove_api_key_from_groups_with_http_info(self, api_key, body, **kwargs): # noqa: E501
"""Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_key_from_groups_with_http_info(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['api_key', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method remove_api_key_from_groups" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'api_key' is set
if ('api_key' not in params or
params['api_key'] is None):
raise ValueError("Missing the required parameter `api_key` when calling `remove_api_key_from_groups`") # 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 `remove_api_key_from_groups`") # noqa: E501
collection_formats = {}
path_params = {}
if 'api_key' in params:
path_params['apiKey'] = params['api_key'] # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/api-keys/{apiKey}/groups', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def remove_user_from_groups(self, user_id, body, **kwargs): # noqa: E501
"""Remove user from groups. # noqa: E501
An endpoint for removing user from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_user_from_groups(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.remove_user_from_groups_with_http_info(user_id, body, **kwargs) # noqa: E501
else:
(data) = self.remove_user_from_groups_with_http_info(user_id, body, **kwargs) # noqa: E501
return data
def remove_user_from_groups_with_http_info(self, user_id, body, **kwargs): # noqa: E501
"""Remove user from groups. # noqa: E501
An endpoint for removing user from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_user_from_groups_with_http_info(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['user_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method remove_user_from_groups" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `remove_user_from_groups`") # 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 `remove_user_from_groups`") # noqa: E501
collection_formats = {}
path_params = {}
if 'user_id' in params:
path_params['user-id'] = params['user_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/users/{user-id}/groups', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def remove_users_from_group(self, group_id, body, **kwargs): # noqa: E501
"""Remove users from a group. # noqa: E501
An endpoint for removing users from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/users -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_users_from_group(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose users are removed. (required)
:param SubjectList body: A list of users to be removed from the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.remove_users_from_group_with_http_info(group_id, body, **kwargs) # noqa: E501
else:
(data) = self.remove_users_from_group_with_http_info(group_id, body, **kwargs) # noqa: E501
return data
def remove_users_from_group_with_http_info(self, group_id, body, **kwargs): # noqa: E501
"""Remove users from a group. # noqa: E501
An endpoint for removing users from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/users -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_users_from_group_with_http_info(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose users are removed. (required)
:param SubjectList body: A list of users to be removed from the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['group_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method remove_users_from_group" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `remove_users_from_group`") # 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 `remove_users_from_group`") # noqa: E501
collection_formats = {}
path_params = {}
if 'group_id' in params:
path_params['groupID'] = params['group_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/policy-groups/{groupID}/users', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_group_name(self, group_id, body, **kwargs): # noqa: E501
"""Update the group name. # noqa: E501
An endpoint for updating a group name. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -d '{\"name\": \"TestGroup2\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_group_name(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be updated. (required)
:param GroupUpdateInfo body: Details of the group to be created. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_group_name_with_http_info(group_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_group_name_with_http_info(group_id, body, **kwargs) # noqa: E501
return data
def update_group_name_with_http_info(self, group_id, body, **kwargs): # noqa: E501
"""Update the group name. # noqa: E501
An endpoint for updating a group name. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -d '{\"name\": \"TestGroup2\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_group_name_with_http_info(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be updated. (required)
:param GroupUpdateInfo body: Details of the group to be created. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['group_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_group_name" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'group_id' is set
if ('group_id' not in params or
params['group_id'] is None):
raise ValueError("Missing the required parameter `group_id` when calling `update_group_name`") # 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 `update_group_name`") # noqa: E501
collection_formats = {}
path_params = {}
if 'group_id' in params:
path_params['groupID'] = params['group_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/policy-groups/{groupID}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_my_account(self, body, **kwargs): # noqa: E501
"""Updates attributes of the account. # noqa: E501
An endpoint for updating the account. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/me -d '{\"phone_number\": \"12345678\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_my_account(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param AccountUpdateReq body: Details of the account to be updated. (required)
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_my_account_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.update_my_account_with_http_info(body, **kwargs) # noqa: E501
return data
def update_my_account_with_http_info(self, body, **kwargs): # noqa: E501
"""Updates attributes of the account. # noqa: E501
An endpoint for updating the account. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/me -d '{\"phone_number\": \"12345678\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_my_account_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param AccountUpdateReq body: Details of the account to be updated. (required)
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_my_account" % 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 `update_my_account`") # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/accounts/me', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AccountInfo', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_user(self, user_id, body, **kwargs): # noqa: E501
"""Update user details. # noqa: E501
An endpoint for updating user details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -d '{\"username\": \"myusername\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_user(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are updated. (required)
:param UserUpdateReq body: A user object with attributes. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.update_user_with_http_info(user_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_user_with_http_info(user_id, body, **kwargs) # noqa: E501
return data
def update_user_with_http_info(self, user_id, body, **kwargs): # noqa: E501
"""Update user details. # noqa: E501
An endpoint for updating user details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -d '{\"username\": \"myusername\"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_user_with_http_info(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are updated. (required)
:param UserUpdateReq body: A user object with attributes. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['user_id', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'user_id' is set
if ('user_id' not in params or
params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `update_user`") # 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 `update_user`") # noqa: E501
collection_formats = {}
path_params = {}
if 'user_id' in params:
path_params['user-id'] = params['user_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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/users/{user-id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UserInfoResp', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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)
|
class AccountAdminApi(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):
pass
def add_api_key_to_groups(self, api_key, body, **kwargs):
'''Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_api_key_to_groups(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_api_key_to_groups_with_http_info(self, api_key, body, **kwargs):
'''Add API key to a list of groups. # noqa: E501
An endpoint for adding API key to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_api_key_to_groups_with_http_info(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_certificate(self, body, **kwargs):
'''Upload a new trusted certificate. # noqa: E501
An endpoint for uploading new trusted certificates. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/trusted-certificates -d {"name": "myCert1", "description": "very important cert", "certificate": "certificate_data", "service": "lwm2m"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_certificate(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param TrustedCertificateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_certificate_with_http_info(self, body, **kwargs):
'''Upload a new trusted certificate. # noqa: E501
An endpoint for uploading new trusted certificates. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/trusted-certificates -d {"name": "myCert1", "description": "very important cert", "certificate": "certificate_data", "service": "lwm2m"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_certificate_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param TrustedCertificateReq body: A trusted certificate object with attributes. (required)
:return: TrustedCertificateResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_subjects_to_group(self, group_id, body, **kwargs):
'''Add members to a group. # noqa: E501
An endpoint for adding users and API keys to a group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -d '{"users": [0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_subjects_to_group(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be updated. (required)
:param SubjectList body: A list of users and API keys to be added to the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_subjects_to_group_with_http_info(self, group_id, body, **kwargs):
'''Add members to a group. # noqa: E501
An endpoint for adding users and API keys to a group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -d '{"users": [0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_subjects_to_group_with_http_info(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be updated. (required)
:param SubjectList body: A list of users and API keys to be added to the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_user_to_groups(self, user_id, body, **kwargs):
'''Add user to a list of groups. # noqa: E501
An endpoint for adding user to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_user_to_groups(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def add_user_to_groups_with_http_info(self, user_id, body, **kwargs):
'''Add user to a list of groups. # noqa: E501
An endpoint for adding user to groups. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.add_user_to_groups_with_http_info(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be added to the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_group(self, body, **kwargs):
'''Create a new group. # noqa: E501
An endpoint for creating a new group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/policy-groups -d '{"name": "MyGroup1"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_group(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param GroupCreationInfo body: Details of the group to be created. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_group_with_http_info(self, body, **kwargs):
'''Create a new group. # noqa: E501
An endpoint for creating a new group. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/policy-groups -d '{"name": "MyGroup1"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_group_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param GroupCreationInfo body: Details of the group to be created. (required)
:return: GroupSummary
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_invitation(self, body, **kwargs):
'''Create a user invitation. # noqa: E501
An endpoint for inviting a new or an existing user to join the account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/user-invitations -d {"email": "[email protected]"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_invitation(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param UserInvitationReq body: A user invitation object with attributes. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_invitation_with_http_info(self, body, **kwargs):
'''Create a user invitation. # noqa: E501
An endpoint for inviting a new or an existing user to join the account. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/user-invitations -d {"email": "[email protected]"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_invitation_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param UserInvitationReq body: A user invitation object with attributes. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_user(self, body, **kwargs):
'''Create a new user. # noqa: E501
An endpoint for creating or inviting a new user to the account. In case of invitation email address is used only, other attributes are set in the 2nd step. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/users?action=invite -d {"email": "[email protected]"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_user(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param UserInfoReq body: A user object with attributes. (required)
:param str action: Action, either 'create' or 'invite'.
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_user_with_http_info(self, body, **kwargs):
'''Create a new user. # noqa: E501
An endpoint for creating or inviting a new user to the account. In case of invitation email address is used only, other attributes are set in the 2nd step. **Example usage:** `curl -X POST https://api.us-east-1.mbedcloud.com/v3/users?action=invite -d {"email": "[email protected]"} -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_user_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param UserInfoReq body: A user object with attributes. (required)
:param str action: Action, either 'create' or 'invite'.
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_group(self, group_id, **kwargs):
'''Delete a group. # noqa: E501
An endpoint for deleting a group. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_group(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_group_with_http_info(self, group_id, **kwargs):
'''Delete a group. # noqa: E501
An endpoint for deleting a group. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_group_with_http_info(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_invitation(self, invitation_id, **kwargs):
'''Delete a user invitation. # noqa: E501
An endpoint for deleting an active user invitation which has been sent for a new or an existing user to join the account. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_invitation(invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str invitation_id: The ID of the invitation to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_invitation_with_http_info(self, invitation_id, **kwargs):
'''Delete a user invitation. # noqa: E501
An endpoint for deleting an active user invitation which has been sent for a new or an existing user to join the account. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_invitation_with_http_info(invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str invitation_id: The ID of the invitation to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_user(self, user_id, **kwargs):
'''Delete a user. # noqa: E501
An endpoint for deleting a user. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_user(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_user_with_http_info(self, user_id, **kwargs):
'''Delete a user. # noqa: E501
An endpoint for deleting a user. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_user_with_http_info(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be deleted. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_invitations(self, **kwargs):
'''Get the details of all the user invitations. # noqa: E501
An endpoint for retrieving the details of all the active user invitations sent for new or existing users to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/user-invitations -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_invitations(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:return: UserInvitationRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_invitations_with_http_info(self, **kwargs):
'''Get the details of all the user invitations. # noqa: E501
An endpoint for retrieving the details of all the active user invitations sent for new or existing users to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/user-invitations -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_invitations_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:return: UserInvitationRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_users(self, **kwargs):
'''Get the details of all users. # noqa: E501
An endpoint for retrieving the details of all users. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_users(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str email__eq: Filter for email address
:param str status__eq: Filter for status, for example active or reset
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_users_with_http_info(self, **kwargs):
'''Get the details of all users. # noqa: E501
An endpoint for retrieving the details of all users. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_users_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str email__eq: Filter for email address
:param str status__eq: Filter for status, for example active or reset
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_groups_of_apikey(self, api_key, **kwargs):
'''Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_apikey(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_groups_of_apikey_with_http_info(self, api_key, **kwargs):
'''Get groups of the API key. # noqa: E501
An endpoint for retrieving groups of the API key. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_apikey_with_http_info(api_key, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_groups_of_user(self, user_id, **kwargs):
'''Get groups of the user. # noqa: E501
An endpoint for retrieving groups of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_user(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_groups_of_user_with_http_info(self, user_id, **kwargs):
'''Get groups of the user. # noqa: E501
An endpoint for retrieving groups of the user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_groups_of_user_with_http_info(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:return: GroupSummaryList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_invitation(self, invitation_id, **kwargs):
'''Details of a user invitation. # noqa: E501
An endpoint for retrieving the details of an active user invitation sent for a new or an existing user to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_invitation(invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str invitation_id: The ID of the invitation to be retrieved. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_invitation_with_http_info(self, invitation_id, **kwargs):
'''Details of a user invitation. # noqa: E501
An endpoint for retrieving the details of an active user invitation sent for a new or an existing user to join the account. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/user-invitations/{invitation-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_invitation_with_http_info(invitation_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str invitation_id: The ID of the invitation to be retrieved. (required)
:return: UserInvitationResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_user(self, user_id, **kwargs):
'''Details of a user. # noqa: E501
An endpoint for retrieving the details of a user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_user(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are retrieved. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_user_with_http_info(self, user_id, **kwargs):
'''Details of a user. # noqa: E501
An endpoint for retrieving the details of a user. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_user_with_http_info(user_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are retrieved. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_users_of_group(self, group_id, **kwargs):
'''Get users of a group. # noqa: E501
An endpoint for listing the users of a group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_users_of_group(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose users are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str status__eq: An optional filter for getting users by status.
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_users_of_group_with_http_info(self, group_id, **kwargs):
'''Get users of a group. # noqa: E501
An endpoint for listing the users of a group with details. **Example usage:** `curl https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/users -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_users_of_group_with_http_info(group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose users are retrieved. (required)
:param int limit: The number of results to return (2-1000), default is 50.
:param str after: The entity ID to fetch after the given one.
:param str order: The order of the records based on creation time, ASC or DESC; by default ASC
:param str include: Comma separated additional data to return. Currently supported: total_count
:param str status__eq: An optional filter for getting users by status.
:param str status__in: An optional filter for getting users with a specified set of statuses.
:param str status__nin: An optional filter for excluding users with a specified set of statuses.
:return: UserInfoRespList
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_api_key_from_groups(self, api_key, body, **kwargs):
'''Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_key_from_groups(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_api_key_from_groups_with_http_info(self, api_key, body, **kwargs):
'''Remove API key from groups. # noqa: E501
An endpoint for removing API key from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/api-keys/{apikey-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_api_key_from_groups_with_http_info(api_key, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str api_key: The ID of the API key to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_user_from_groups(self, user_id, body, **kwargs):
'''Remove user from groups. # noqa: E501
An endpoint for removing user from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_user_from_groups(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_user_from_groups_with_http_info(self, user_id, body, **kwargs):
'''Remove user from groups. # noqa: E501
An endpoint for removing user from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/users/{user-id}/groups -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_user_from_groups_with_http_info(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user to be removed from the group. (required)
:param list[str] body: A list of IDs of the groups to be updated. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_users_from_group(self, group_id, body, **kwargs):
'''Remove users from a group. # noqa: E501
An endpoint for removing users from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/users -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_users_from_group(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose users are removed. (required)
:param SubjectList body: A list of users to be removed from the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def remove_users_from_group_with_http_info(self, group_id, body, **kwargs):
'''Remove users from a group. # noqa: E501
An endpoint for removing users from groups. **Example usage:** `curl -X DELETE https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id}/users -d '[0162056a9a1586f30242590700000000,0117056a9a1586f30242590700000000]' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.remove_users_from_group_with_http_info(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group whose users are removed. (required)
:param SubjectList body: A list of users to be removed from the group. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_group_name(self, group_id, body, **kwargs):
'''Update the group name. # noqa: E501
An endpoint for updating a group name. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -d '{"name": "TestGroup2"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_group_name(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be updated. (required)
:param GroupUpdateInfo body: Details of the group to be created. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_group_name_with_http_info(self, group_id, body, **kwargs):
'''Update the group name. # noqa: E501
An endpoint for updating a group name. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/policy-groups/{group-id} -d '{"name": "TestGroup2"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_group_name_with_http_info(group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str group_id: The ID of the group to be updated. (required)
:param GroupUpdateInfo body: Details of the group to be created. (required)
:return: UpdatedResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_my_account(self, body, **kwargs):
'''Updates attributes of the account. # noqa: E501
An endpoint for updating the account. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/me -d '{"phone_number": "12345678"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_my_account(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param AccountUpdateReq body: Details of the account to be updated. (required)
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_my_account_with_http_info(self, body, **kwargs):
'''Updates attributes of the account. # noqa: E501
An endpoint for updating the account. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/accounts/me -d '{"phone_number": "12345678"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_my_account_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param AccountUpdateReq body: Details of the account to be updated. (required)
:return: AccountInfo
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_user(self, user_id, body, **kwargs):
'''Update user details. # noqa: E501
An endpoint for updating user details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -d '{"username": "myusername"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_user(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are updated. (required)
:param UserUpdateReq body: A user object with attributes. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
def update_user_with_http_info(self, user_id, body, **kwargs):
'''Update user details. # noqa: E501
An endpoint for updating user details. **Example usage:** `curl -X PUT https://api.us-east-1.mbedcloud.com/v3/users/{user-id} -d '{"username": "myusername"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_KEY'` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.update_user_with_http_info(user_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str user_id: The ID of the user whose details are updated. (required)
:param UserUpdateReq body: A user object with attributes. (required)
:return: UserInfoResp
If the method is called asynchronously,
returns the request thread.
'''
pass
| 48 | 47 | 50 | 7 | 28 | 21 | 4 | 0.76 | 1 | 3 | 1 | 0 | 47 | 1 | 47 | 47 | 2,404 | 383 | 1,311 | 325 | 1,263 | 992 | 832 | 325 | 784 | 12 | 1 | 2 | 202 |
2,439 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_group_manipulation.py
|
mbed_cloud._backends.device_directory.models.device_group_manipulation.DeviceGroupManipulation
|
class DeviceGroupManipulation(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 = {
'device_ids': 'list[str]'
}
attribute_map = {
'device_ids': 'device_ids'
}
def __init__(self, device_ids=None):
"""
DeviceGroupManipulation - a model defined in Swagger
"""
self._device_ids = device_ids
self.discriminator = None
@property
def device_ids(self):
"""
Gets the device_ids of this DeviceGroupManipulation.
:return: The device_ids of this DeviceGroupManipulation.
:rtype: list[str]
"""
return self._device_ids
@device_ids.setter
def device_ids(self, device_ids):
"""
Sets the device_ids of this DeviceGroupManipulation.
:param device_ids: The device_ids of this DeviceGroupManipulation.
:type: list[str]
"""
self._device_ids = device_ids
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceGroupManipulation):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceGroupManipulation(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, device_ids=None):
'''
DeviceGroupManipulation - a model defined in Swagger
'''
pass
@property
def device_ids(self):
'''
Gets the device_ids of this DeviceGroupManipulation.
:return: The device_ids of this DeviceGroupManipulation.
:rtype: list[str]
'''
pass
@device_ids.setter
def device_ids(self):
'''
Sets the device_ids of this DeviceGroupManipulation.
:param device_ids: The device_ids of this DeviceGroupManipulation.
:type: list[str]
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 11 | 9 | 9 | 1 | 5 | 4 | 2 | 0.85 | 1 | 3 | 0 | 0 | 8 | 2 | 8 | 8 | 103 | 18 | 46 | 18 | 35 | 39 | 30 | 16 | 21 | 5 | 1 | 2 | 13 |
2,440 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_group.py
|
mbed_cloud._backends.device_directory.models.device_group.DeviceGroup
|
class DeviceGroup(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 = {
'created_at': 'datetime',
'custom_attributes': 'dict(str, str)',
'description': 'str',
'devices_count': 'int',
'etag': 'datetime',
'id': 'str',
'name': 'str',
'object': 'str',
'updated_at': 'datetime'
}
attribute_map = {
'created_at': 'created_at',
'custom_attributes': 'custom_attributes',
'description': 'description',
'devices_count': 'devices_count',
'etag': 'etag',
'id': 'id',
'name': 'name',
'object': 'object',
'updated_at': 'updated_at'
}
def __init__(self, created_at=None, custom_attributes=None, description=None, devices_count=None, etag=None, id=None, name=None, object=None, updated_at=None):
"""
DeviceGroup - a model defined in Swagger
"""
self._created_at = created_at
self._custom_attributes = custom_attributes
self._description = description
self._devices_count = devices_count
self._etag = etag
self._id = id
self._name = name
self._object = object
self._updated_at = updated_at
self.discriminator = None
@property
def created_at(self):
"""
Gets the created_at of this DeviceGroup.
The time the campaign was created
:return: The created_at of this DeviceGroup.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeviceGroup.
The time the campaign was created
:param created_at: The created_at of this DeviceGroup.
:type: datetime
"""
self._created_at = created_at
@property
def custom_attributes(self):
"""
Gets the custom_attributes of this DeviceGroup.
Up to ten custom key-value attributes.
:return: The custom_attributes of this DeviceGroup.
:rtype: dict(str, str)
"""
return self._custom_attributes
@custom_attributes.setter
def custom_attributes(self, custom_attributes):
"""
Sets the custom_attributes of this DeviceGroup.
Up to ten custom key-value attributes.
:param custom_attributes: The custom_attributes of this DeviceGroup.
:type: dict(str, str)
"""
self._custom_attributes = custom_attributes
@property
def description(self):
"""
Gets the description of this DeviceGroup.
The description of the group
:return: The description of this DeviceGroup.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeviceGroup.
The description of the group
:param description: The description of this DeviceGroup.
:type: str
"""
if description is not None and len(description) > 2000:
raise ValueError("Invalid value for `description`, length must be less than or equal to `2000`")
self._description = description
@property
def devices_count(self):
"""
Gets the devices_count of this DeviceGroup.
The number of devices in this group
:return: The devices_count of this DeviceGroup.
:rtype: int
"""
return self._devices_count
@devices_count.setter
def devices_count(self, devices_count):
"""
Sets the devices_count of this DeviceGroup.
The number of devices in this group
:param devices_count: The devices_count of this DeviceGroup.
:type: int
"""
self._devices_count = devices_count
@property
def etag(self):
"""
Gets the etag of this DeviceGroup.
:return: The etag of this DeviceGroup.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeviceGroup.
:param etag: The etag of this DeviceGroup.
:type: datetime
"""
self._etag = etag
@property
def id(self):
"""
Gets the id of this DeviceGroup.
The group id
:return: The id of this DeviceGroup.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeviceGroup.
The group id
:param id: The id of this DeviceGroup.
:type: str
"""
self._id = id
@property
def name(self):
"""
Gets the name of this DeviceGroup.
Name of the group
:return: The name of this DeviceGroup.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceGroup.
Name of the group
:param name: The name of this DeviceGroup.
:type: str
"""
if name is not None and len(name) > 128:
raise ValueError("Invalid value for `name`, length must be less than or equal to `128`")
self._name = name
@property
def object(self):
"""
Gets the object of this DeviceGroup.
Entity name: always 'device-group'
:return: The object of this DeviceGroup.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DeviceGroup.
Entity name: always 'device-group'
:param object: The object of this DeviceGroup.
:type: str
"""
self._object = object
@property
def updated_at(self):
"""
Gets the updated_at of this DeviceGroup.
The time the object was updated
:return: The updated_at of this DeviceGroup.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this DeviceGroup.
The time the object was updated
:param updated_at: The updated_at of this DeviceGroup.
:type: datetime
"""
self._updated_at = updated_at
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceGroup):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceGroup(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created_at=None, custom_attributes=None, description=None, devices_count=None, etag=None, id=None, name=None, object=None, updated_at=None):
'''
DeviceGroup - a model defined in Swagger
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeviceGroup.
The time the campaign was created
:return: The created_at of this DeviceGroup.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeviceGroup.
The time the campaign was created
:param created_at: The created_at of this DeviceGroup.
:type: datetime
'''
pass
@property
def custom_attributes(self):
'''
Gets the custom_attributes of this DeviceGroup.
Up to ten custom key-value attributes.
:return: The custom_attributes of this DeviceGroup.
:rtype: dict(str, str)
'''
pass
@custom_attributes.setter
def custom_attributes(self):
'''
Sets the custom_attributes of this DeviceGroup.
Up to ten custom key-value attributes.
:param custom_attributes: The custom_attributes of this DeviceGroup.
:type: dict(str, str)
'''
pass
@property
def description(self):
'''
Gets the description of this DeviceGroup.
The description of the group
:return: The description of this DeviceGroup.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeviceGroup.
The description of the group
:param description: The description of this DeviceGroup.
:type: str
'''
pass
@property
def devices_count(self):
'''
Gets the devices_count of this DeviceGroup.
The number of devices in this group
:return: The devices_count of this DeviceGroup.
:rtype: int
'''
pass
@devices_count.setter
def devices_count(self):
'''
Sets the devices_count of this DeviceGroup.
The number of devices in this group
:param devices_count: The devices_count of this DeviceGroup.
:type: int
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeviceGroup.
:return: The etag of this DeviceGroup.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeviceGroup.
:param etag: The etag of this DeviceGroup.
:type: datetime
'''
pass
@property
def id(self):
'''
Gets the id of this DeviceGroup.
The group id
:return: The id of this DeviceGroup.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeviceGroup.
The group id
:param id: The id of this DeviceGroup.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceGroup.
Name of the group
:return: The name of this DeviceGroup.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceGroup.
Name of the group
:param name: The name of this DeviceGroup.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this DeviceGroup.
Entity name: always 'device-group'
:return: The object of this DeviceGroup.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DeviceGroup.
Entity name: always 'device-group'
:param object: The object of this DeviceGroup.
:type: str
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this DeviceGroup.
The time the object was updated
:return: The updated_at of this DeviceGroup.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this DeviceGroup.
The time the object was updated
:param updated_at: The updated_at of this DeviceGroup.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 43 | 25 | 10 | 1 | 3 | 5 | 1 | 1.11 | 1 | 4 | 0 | 0 | 24 | 10 | 24 | 24 | 315 | 58 | 122 | 58 | 79 | 135 | 74 | 40 | 49 | 5 | 1 | 2 | 31 |
2,441 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_event_page.py
|
mbed_cloud._backends.device_directory.models.device_event_page.DeviceEventPage
|
class DeviceEventPage(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 = {
'after': 'str',
'data': 'list[DeviceEventData]',
'has_more': 'bool',
'limit': 'int',
'object': 'str',
'order': 'str',
'total_count': 'int'
}
attribute_map = {
'after': 'after',
'data': 'data',
'has_more': 'has_more',
'limit': 'limit',
'object': 'object',
'order': 'order',
'total_count': 'total_count'
}
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
"""
DeviceEventPage - a model defined in Swagger
"""
self._after = after
self._data = data
self._has_more = has_more
self._limit = limit
self._object = object
self._order = order
self._total_count = total_count
self.discriminator = None
@property
def after(self):
"""
Gets the after of this DeviceEventPage.
:return: The after of this DeviceEventPage.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this DeviceEventPage.
:param after: The after of this DeviceEventPage.
:type: str
"""
self._after = after
@property
def data(self):
"""
Gets the data of this DeviceEventPage.
:return: The data of this DeviceEventPage.
:rtype: list[DeviceEventData]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this DeviceEventPage.
:param data: The data of this DeviceEventPage.
:type: list[DeviceEventData]
"""
self._data = data
@property
def has_more(self):
"""
Gets the has_more of this DeviceEventPage.
:return: The has_more of this DeviceEventPage.
:rtype: bool
"""
return self._has_more
@has_more.setter
def has_more(self, has_more):
"""
Sets the has_more of this DeviceEventPage.
:param has_more: The has_more of this DeviceEventPage.
:type: bool
"""
self._has_more = has_more
@property
def limit(self):
"""
Gets the limit of this DeviceEventPage.
:return: The limit of this DeviceEventPage.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this DeviceEventPage.
:param limit: The limit of this DeviceEventPage.
:type: int
"""
self._limit = limit
@property
def object(self):
"""
Gets the object of this DeviceEventPage.
:return: The object of this DeviceEventPage.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DeviceEventPage.
:param object: The object of this DeviceEventPage.
:type: str
"""
self._object = object
@property
def order(self):
"""
Gets the order of this DeviceEventPage.
:return: The order of this DeviceEventPage.
:rtype: str
"""
return self._order
@order.setter
def order(self, order):
"""
Sets the order of this DeviceEventPage.
:param order: The order of this DeviceEventPage.
:type: str
"""
self._order = order
@property
def total_count(self):
"""
Gets the total_count of this DeviceEventPage.
:return: The total_count of this DeviceEventPage.
:rtype: int
"""
return self._total_count
@total_count.setter
def total_count(self, total_count):
"""
Sets the total_count of this DeviceEventPage.
:param total_count: The total_count of this DeviceEventPage.
:type: int
"""
self._total_count = total_count
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceEventPage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceEventPage(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
'''
DeviceEventPage - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this DeviceEventPage.
:return: The after of this DeviceEventPage.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this DeviceEventPage.
:param after: The after of this DeviceEventPage.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this DeviceEventPage.
:return: The data of this DeviceEventPage.
:rtype: list[DeviceEventData]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this DeviceEventPage.
:param data: The data of this DeviceEventPage.
:type: list[DeviceEventData]
'''
pass
@property
def has_more(self):
'''
Gets the has_more of this DeviceEventPage.
:return: The has_more of this DeviceEventPage.
:rtype: bool
'''
pass
@has_more.setter
def has_more(self):
'''
Sets the has_more of this DeviceEventPage.
:param has_more: The has_more of this DeviceEventPage.
:type: bool
'''
pass
@property
def limit(self):
'''
Gets the limit of this DeviceEventPage.
:return: The limit of this DeviceEventPage.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this DeviceEventPage.
:param limit: The limit of this DeviceEventPage.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this DeviceEventPage.
:return: The object of this DeviceEventPage.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DeviceEventPage.
:param object: The object of this DeviceEventPage.
:type: str
'''
pass
@property
def order(self):
'''
Gets the order of this DeviceEventPage.
:return: The order of this DeviceEventPage.
:rtype: str
'''
pass
@order.setter
def order(self):
'''
Sets the order of this DeviceEventPage.
:param order: The order of this DeviceEventPage.
:type: str
'''
pass
@property
def total_count(self):
'''
Gets the total_count of this DeviceEventPage.
:return: The total_count of this DeviceEventPage.
:rtype: int
'''
pass
@total_count.setter
def total_count(self):
'''
Sets the total_count of this DeviceEventPage.
:param total_count: The total_count of this DeviceEventPage.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 35 | 21 | 9 | 1 | 3 | 4 | 1 | 0.99 | 1 | 3 | 0 | 0 | 20 | 8 | 20 | 20 | 247 | 48 | 100 | 48 | 65 | 99 | 60 | 34 | 39 | 5 | 1 | 2 | 25 |
2,442 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/service_packages_response.py
|
mbed_cloud._backends.billing.models.service_packages_response.ServicePackagesResponse
|
class ServicePackagesResponse(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 = {
'active': 'ActiveServicePackage',
'object': 'str',
'pending': 'PendingServicePackage',
'previous': 'list[PreviousServicePackage]'
}
attribute_map = {
'active': 'active',
'object': 'object',
'pending': 'pending',
'previous': 'previous'
}
def __init__(self, active=None, object=None, pending=None, previous=None):
"""
ServicePackagesResponse - a model defined in Swagger
"""
self._active = active
self._object = object
self._pending = pending
self._previous = previous
self.discriminator = None
@property
def active(self):
"""
Gets the active of this ServicePackagesResponse.
Currently active service package. Can be null.
:return: The active of this ServicePackagesResponse.
:rtype: ActiveServicePackage
"""
return self._active
@active.setter
def active(self, active):
"""
Sets the active of this ServicePackagesResponse.
Currently active service package. Can be null.
:param active: The active of this ServicePackagesResponse.
:type: ActiveServicePackage
"""
self._active = active
@property
def object(self):
"""
Gets the object of this ServicePackagesResponse.
Always set to 'service-packages'.
:return: The object of this ServicePackagesResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ServicePackagesResponse.
Always set to 'service-packages'.
:param object: The object of this ServicePackagesResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["service-packages"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def pending(self):
"""
Gets the pending of this ServicePackagesResponse.
Current pending service package. Can be null.
:return: The pending of this ServicePackagesResponse.
:rtype: PendingServicePackage
"""
return self._pending
@pending.setter
def pending(self, pending):
"""
Sets the pending of this ServicePackagesResponse.
Current pending service package. Can be null.
:param pending: The pending of this ServicePackagesResponse.
:type: PendingServicePackage
"""
self._pending = pending
@property
def previous(self):
"""
Gets the previous of this ServicePackagesResponse.
List of previous service packages.
:return: The previous of this ServicePackagesResponse.
:rtype: list[PreviousServicePackage]
"""
return self._previous
@previous.setter
def previous(self, previous):
"""
Sets the previous of this ServicePackagesResponse.
List of previous service packages.
:param previous: The previous of this ServicePackagesResponse.
:type: list[PreviousServicePackage]
"""
if previous is None:
raise ValueError("Invalid value for `previous`, must not be `None`")
self._previous = previous
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ServicePackagesResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ServicePackagesResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, active=None, object=None, pending=None, previous=None):
'''
ServicePackagesResponse - a model defined in Swagger
'''
pass
@property
def active(self):
'''
Gets the active of this ServicePackagesResponse.
Currently active service package. Can be null.
:return: The active of this ServicePackagesResponse.
:rtype: ActiveServicePackage
'''
pass
@active.setter
def active(self):
'''
Sets the active of this ServicePackagesResponse.
Currently active service package. Can be null.
:param active: The active of this ServicePackagesResponse.
:type: ActiveServicePackage
'''
pass
@property
def object(self):
'''
Gets the object of this ServicePackagesResponse.
Always set to 'service-packages'.
:return: The object of this ServicePackagesResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ServicePackagesResponse.
Always set to 'service-packages'.
:param object: The object of this ServicePackagesResponse.
:type: str
'''
pass
@property
def pending(self):
'''
Gets the pending of this ServicePackagesResponse.
Current pending service package. Can be null.
:return: The pending of this ServicePackagesResponse.
:rtype: PendingServicePackage
'''
pass
@pending.setter
def pending(self):
'''
Sets the pending of this ServicePackagesResponse.
Current pending service package. Can be null.
:param pending: The pending of this ServicePackagesResponse.
:type: PendingServicePackage
'''
pass
@property
def previous(self):
'''
Gets the previous of this ServicePackagesResponse.
List of previous service packages.
:return: The previous of this ServicePackagesResponse.
:rtype: list[PreviousServicePackage]
'''
pass
@previous.setter
def previous(self):
'''
Sets the previous of this ServicePackagesResponse.
List of previous service packages.
:param previous: The previous of this ServicePackagesResponse.
:type: list[PreviousServicePackage]
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 23 | 15 | 10 | 1 | 4 | 5 | 2 | 0.93 | 1 | 4 | 0 | 0 | 14 | 5 | 14 | 14 | 193 | 33 | 83 | 34 | 60 | 77 | 52 | 26 | 37 | 5 | 1 | 2 | 22 |
2,443 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/service_package_report.py
|
mbed_cloud._backends.billing.models.service_package_report.ServicePackageReport
|
class ServicePackageReport(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 = {
'aggregated_quota_usage': 'list[AggregatedQuotaUsageReport]',
'metadata': 'ServicePackageMetadata',
'quota_usage': 'list[QuotaUsageReport]'
}
attribute_map = {
'aggregated_quota_usage': 'aggregated_quota_usage',
'metadata': 'metadata',
'quota_usage': 'quota_usage'
}
def __init__(self, aggregated_quota_usage=None, metadata=None, quota_usage=None):
"""
ServicePackageReport - a model defined in Swagger
"""
self._aggregated_quota_usage = aggregated_quota_usage
self._metadata = metadata
self._quota_usage = quota_usage
self.discriminator = None
@property
def aggregated_quota_usage(self):
"""
Gets the aggregated_quota_usage of this ServicePackageReport.
:return: The aggregated_quota_usage of this ServicePackageReport.
:rtype: list[AggregatedQuotaUsageReport]
"""
return self._aggregated_quota_usage
@aggregated_quota_usage.setter
def aggregated_quota_usage(self, aggregated_quota_usage):
"""
Sets the aggregated_quota_usage of this ServicePackageReport.
:param aggregated_quota_usage: The aggregated_quota_usage of this ServicePackageReport.
:type: list[AggregatedQuotaUsageReport]
"""
if aggregated_quota_usage is None:
raise ValueError("Invalid value for `aggregated_quota_usage`, must not be `None`")
self._aggregated_quota_usage = aggregated_quota_usage
@property
def metadata(self):
"""
Gets the metadata of this ServicePackageReport.
:return: The metadata of this ServicePackageReport.
:rtype: ServicePackageMetadata
"""
return self._metadata
@metadata.setter
def metadata(self, metadata):
"""
Sets the metadata of this ServicePackageReport.
:param metadata: The metadata of this ServicePackageReport.
:type: ServicePackageMetadata
"""
if metadata is None:
raise ValueError("Invalid value for `metadata`, must not be `None`")
self._metadata = metadata
@property
def quota_usage(self):
"""
Gets the quota_usage of this ServicePackageReport.
:return: The quota_usage of this ServicePackageReport.
:rtype: list[QuotaUsageReport]
"""
return self._quota_usage
@quota_usage.setter
def quota_usage(self, quota_usage):
"""
Sets the quota_usage of this ServicePackageReport.
:param quota_usage: The quota_usage of this ServicePackageReport.
:type: list[QuotaUsageReport]
"""
if quota_usage is None:
raise ValueError("Invalid value for `quota_usage`, must not be `None`")
self._quota_usage = quota_usage
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ServicePackageReport):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ServicePackageReport(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, aggregated_quota_usage=None, metadata=None, quota_usage=None):
'''
ServicePackageReport - a model defined in Swagger
'''
pass
@property
def aggregated_quota_usage(self):
'''
Gets the aggregated_quota_usage of this ServicePackageReport.
:return: The aggregated_quota_usage of this ServicePackageReport.
:rtype: list[AggregatedQuotaUsageReport]
'''
pass
@aggregated_quota_usage.setter
def aggregated_quota_usage(self):
'''
Sets the aggregated_quota_usage of this ServicePackageReport.
:param aggregated_quota_usage: The aggregated_quota_usage of this ServicePackageReport.
:type: list[AggregatedQuotaUsageReport]
'''
pass
@property
def metadata(self):
'''
Gets the metadata of this ServicePackageReport.
:return: The metadata of this ServicePackageReport.
:rtype: ServicePackageMetadata
'''
pass
@metadata.setter
def metadata(self):
'''
Sets the metadata of this ServicePackageReport.
:param metadata: The metadata of this ServicePackageReport.
:type: ServicePackageMetadata
'''
pass
@property
def quota_usage(self):
'''
Gets the quota_usage of this ServicePackageReport.
:return: The quota_usage of this ServicePackageReport.
:rtype: list[QuotaUsageReport]
'''
pass
@quota_usage.setter
def quota_usage(self):
'''
Sets the quota_usage of this ServicePackageReport.
:param quota_usage: The quota_usage of this ServicePackageReport.
:type: list[QuotaUsageReport]
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 19 | 13 | 10 | 1 | 4 | 4 | 2 | 0.84 | 1 | 4 | 0 | 0 | 12 | 4 | 12 | 12 | 157 | 28 | 70 | 28 | 51 | 59 | 46 | 22 | 33 | 5 | 1 | 2 | 20 |
2,444 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/service_package_quota_history_service_package.py
|
mbed_cloud._backends.billing.models.service_package_quota_history_service_package.ServicePackageQuotaHistoryServicePackage
|
class ServicePackageQuotaHistoryServicePackage(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 = {
'expires': 'datetime',
'firmware_update_count': 'int',
'id': 'str',
'previous_id': 'str',
'start_time': 'datetime'
}
attribute_map = {
'expires': 'expires',
'firmware_update_count': 'firmware_update_count',
'id': 'id',
'previous_id': 'previous_id',
'start_time': 'start_time'
}
def __init__(self, expires=None, firmware_update_count=None, id=None, previous_id=None, start_time=None):
"""
ServicePackageQuotaHistoryServicePackage - a model defined in Swagger
"""
self._expires = expires
self._firmware_update_count = firmware_update_count
self._id = id
self._previous_id = previous_id
self._start_time = start_time
self.discriminator = None
@property
def expires(self):
"""
Gets the expires of this ServicePackageQuotaHistoryServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The expires of this ServicePackageQuotaHistoryServicePackage.
:rtype: datetime
"""
return self._expires
@expires.setter
def expires(self, expires):
"""
Sets the expires of this ServicePackageQuotaHistoryServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param expires: The expires of this ServicePackageQuotaHistoryServicePackage.
:type: datetime
"""
if expires is None:
raise ValueError("Invalid value for `expires`, must not be `None`")
self._expires = expires
@property
def firmware_update_count(self):
"""
Gets the firmware_update_count of this ServicePackageQuotaHistoryServicePackage.
Size of firmware update quota of this service package.
:return: The firmware_update_count of this ServicePackageQuotaHistoryServicePackage.
:rtype: int
"""
return self._firmware_update_count
@firmware_update_count.setter
def firmware_update_count(self, firmware_update_count):
"""
Sets the firmware_update_count of this ServicePackageQuotaHistoryServicePackage.
Size of firmware update quota of this service package.
:param firmware_update_count: The firmware_update_count of this ServicePackageQuotaHistoryServicePackage.
:type: int
"""
if firmware_update_count is None:
raise ValueError("Invalid value for `firmware_update_count`, must not be `None`")
self._firmware_update_count = firmware_update_count
@property
def id(self):
"""
Gets the id of this ServicePackageQuotaHistoryServicePackage.
ID of this service package.
:return: The id of this ServicePackageQuotaHistoryServicePackage.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this ServicePackageQuotaHistoryServicePackage.
ID of this service package.
:param id: The id of this ServicePackageQuotaHistoryServicePackage.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def previous_id(self):
"""
Gets the previous_id of this ServicePackageQuotaHistoryServicePackage.
Previous service package ID or null.
:return: The previous_id of this ServicePackageQuotaHistoryServicePackage.
:rtype: str
"""
return self._previous_id
@previous_id.setter
def previous_id(self, previous_id):
"""
Sets the previous_id of this ServicePackageQuotaHistoryServicePackage.
Previous service package ID or null.
:param previous_id: The previous_id of this ServicePackageQuotaHistoryServicePackage.
:type: str
"""
self._previous_id = previous_id
@property
def start_time(self):
"""
Gets the start_time of this ServicePackageQuotaHistoryServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The start_time of this ServicePackageQuotaHistoryServicePackage.
:rtype: datetime
"""
return self._start_time
@start_time.setter
def start_time(self, start_time):
"""
Sets the start_time of this ServicePackageQuotaHistoryServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param start_time: The start_time of this ServicePackageQuotaHistoryServicePackage.
:type: datetime
"""
if start_time is None:
raise ValueError("Invalid value for `start_time`, must not be `None`")
self._start_time = start_time
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ServicePackageQuotaHistoryServicePackage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ServicePackageQuotaHistoryServicePackage(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, expires=None, firmware_update_count=None, id=None, previous_id=None, start_time=None):
'''
ServicePackageQuotaHistoryServicePackage - a model defined in Swagger
'''
pass
@property
def expires(self):
'''
Gets the expires of this ServicePackageQuotaHistoryServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The expires of this ServicePackageQuotaHistoryServicePackage.
:rtype: datetime
'''
pass
@expires.setter
def expires(self):
'''
Sets the expires of this ServicePackageQuotaHistoryServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param expires: The expires of this ServicePackageQuotaHistoryServicePackage.
:type: datetime
'''
pass
@property
def firmware_update_count(self):
'''
Gets the firmware_update_count of this ServicePackageQuotaHistoryServicePackage.
Size of firmware update quota of this service package.
:return: The firmware_update_count of this ServicePackageQuotaHistoryServicePackage.
:rtype: int
'''
pass
@firmware_update_count.setter
def firmware_update_count(self):
'''
Sets the firmware_update_count of this ServicePackageQuotaHistoryServicePackage.
Size of firmware update quota of this service package.
:param firmware_update_count: The firmware_update_count of this ServicePackageQuotaHistoryServicePackage.
:type: int
'''
pass
@property
def id(self):
'''
Gets the id of this ServicePackageQuotaHistoryServicePackage.
ID of this service package.
:return: The id of this ServicePackageQuotaHistoryServicePackage.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this ServicePackageQuotaHistoryServicePackage.
ID of this service package.
:param id: The id of this ServicePackageQuotaHistoryServicePackage.
:type: str
'''
pass
@property
def previous_id(self):
'''
Gets the previous_id of this ServicePackageQuotaHistoryServicePackage.
Previous service package ID or null.
:return: The previous_id of this ServicePackageQuotaHistoryServicePackage.
:rtype: str
'''
pass
@previous_id.setter
def previous_id(self):
'''
Sets the previous_id of this ServicePackageQuotaHistoryServicePackage.
Previous service package ID or null.
:param previous_id: The previous_id of this ServicePackageQuotaHistoryServicePackage.
:type: str
'''
pass
@property
def start_time(self):
'''
Gets the start_time of this ServicePackageQuotaHistoryServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The start_time of this ServicePackageQuotaHistoryServicePackage.
:rtype: datetime
'''
pass
@start_time.setter
def start_time(self):
'''
Sets the start_time of this ServicePackageQuotaHistoryServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param start_time: The start_time of this ServicePackageQuotaHistoryServicePackage.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 27 | 17 | 10 | 1 | 4 | 5 | 2 | 0.99 | 1 | 4 | 0 | 0 | 16 | 6 | 16 | 16 | 217 | 38 | 90 | 38 | 63 | 89 | 58 | 28 | 41 | 5 | 1 | 2 | 25 |
2,445 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/service_package_quota_history_response.py
|
mbed_cloud._backends.billing.models.service_package_quota_history_response.ServicePackageQuotaHistoryResponse
|
class ServicePackageQuotaHistoryResponse(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 = {
'after': 'str',
'data': 'list[ServicePackageQuotaHistoryItem]',
'has_more': 'bool',
'limit': 'int',
'object': 'str',
'total_count': 'int'
}
attribute_map = {
'after': 'after',
'data': 'data',
'has_more': 'has_more',
'limit': 'limit',
'object': 'object',
'total_count': 'total_count'
}
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, total_count=None):
"""
ServicePackageQuotaHistoryResponse - a model defined in Swagger
"""
self._after = after
self._data = data
self._has_more = has_more
self._limit = limit
self._object = object
self._total_count = total_count
self.discriminator = None
@property
def after(self):
"""
Gets the after of this ServicePackageQuotaHistoryResponse.
After which quota history ID this paged response is fetched.
:return: The after of this ServicePackageQuotaHistoryResponse.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this ServicePackageQuotaHistoryResponse.
After which quota history ID this paged response is fetched.
:param after: The after of this ServicePackageQuotaHistoryResponse.
:type: str
"""
if after is not None and len(after) > 32:
raise ValueError("Invalid value for `after`, length must be less than or equal to `32`")
if after is not None and len(after) < 32:
raise ValueError("Invalid value for `after`, length must be greater than or equal to `32`")
self._after = after
@property
def data(self):
"""
Gets the data of this ServicePackageQuotaHistoryResponse.
List of history items, empty list if no entries are available.
:return: The data of this ServicePackageQuotaHistoryResponse.
:rtype: list[ServicePackageQuotaHistoryItem]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this ServicePackageQuotaHistoryResponse.
List of history items, empty list if no entries are available.
:param data: The data of this ServicePackageQuotaHistoryResponse.
:type: list[ServicePackageQuotaHistoryItem]
"""
if data is None:
raise ValueError("Invalid value for `data`, must not be `None`")
self._data = data
@property
def has_more(self):
"""
Gets the has_more of this ServicePackageQuotaHistoryResponse.
If there is next available quota history paged response to be fetched.
:return: The has_more of this ServicePackageQuotaHistoryResponse.
:rtype: bool
"""
return self._has_more
@has_more.setter
def has_more(self, has_more):
"""
Sets the has_more of this ServicePackageQuotaHistoryResponse.
If there is next available quota history paged response to be fetched.
:param has_more: The has_more of this ServicePackageQuotaHistoryResponse.
:type: bool
"""
if has_more is None:
raise ValueError("Invalid value for `has_more`, must not be `None`")
self._has_more = has_more
@property
def limit(self):
"""
Gets the limit of this ServicePackageQuotaHistoryResponse.
Maximum amount of quota history entries contained in one paged response.
:return: The limit of this ServicePackageQuotaHistoryResponse.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this ServicePackageQuotaHistoryResponse.
Maximum amount of quota history entries contained in one paged response.
:param limit: The limit of this ServicePackageQuotaHistoryResponse.
:type: int
"""
if limit is None:
raise ValueError("Invalid value for `limit`, must not be `None`")
if limit is not None and limit > 1000:
raise ValueError("Invalid value for `limit`, must be a value less than or equal to `1000`")
if limit is not None and limit < 2:
raise ValueError("Invalid value for `limit`, must be a value greater than or equal to `2`")
self._limit = limit
@property
def object(self):
"""
Gets the object of this ServicePackageQuotaHistoryResponse.
Always set to 'service-package-quota-history'.
:return: The object of this ServicePackageQuotaHistoryResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ServicePackageQuotaHistoryResponse.
Always set to 'service-package-quota-history'.
:param object: The object of this ServicePackageQuotaHistoryResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["service-package-quota-history"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def total_count(self):
"""
Gets the total_count of this ServicePackageQuotaHistoryResponse.
Sum of all quota history entries that should be returned
:return: The total_count of this ServicePackageQuotaHistoryResponse.
:rtype: int
"""
return self._total_count
@total_count.setter
def total_count(self, total_count):
"""
Sets the total_count of this ServicePackageQuotaHistoryResponse.
Sum of all quota history entries that should be returned
:param total_count: The total_count of this ServicePackageQuotaHistoryResponse.
:type: int
"""
if total_count is None:
raise ValueError("Invalid value for `total_count`, must not be `None`")
if total_count is not None and total_count < 0:
raise ValueError("Invalid value for `total_count`, must be a value greater than or equal to `0`")
self._total_count = total_count
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ServicePackageQuotaHistoryResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ServicePackageQuotaHistoryResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, total_count=None):
'''
ServicePackageQuotaHistoryResponse - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this ServicePackageQuotaHistoryResponse.
After which quota history ID this paged response is fetched.
:return: The after of this ServicePackageQuotaHistoryResponse.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this ServicePackageQuotaHistoryResponse.
After which quota history ID this paged response is fetched.
:param after: The after of this ServicePackageQuotaHistoryResponse.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this ServicePackageQuotaHistoryResponse.
List of history items, empty list if no entries are available.
:return: The data of this ServicePackageQuotaHistoryResponse.
:rtype: list[ServicePackageQuotaHistoryItem]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this ServicePackageQuotaHistoryResponse.
List of history items, empty list if no entries are available.
:param data: The data of this ServicePackageQuotaHistoryResponse.
:type: list[ServicePackageQuotaHistoryItem]
'''
pass
@property
def has_more(self):
'''
Gets the has_more of this ServicePackageQuotaHistoryResponse.
If there is next available quota history paged response to be fetched.
:return: The has_more of this ServicePackageQuotaHistoryResponse.
:rtype: bool
'''
pass
@has_more.setter
def has_more(self):
'''
Sets the has_more of this ServicePackageQuotaHistoryResponse.
If there is next available quota history paged response to be fetched.
:param has_more: The has_more of this ServicePackageQuotaHistoryResponse.
:type: bool
'''
pass
@property
def limit(self):
'''
Gets the limit of this ServicePackageQuotaHistoryResponse.
Maximum amount of quota history entries contained in one paged response.
:return: The limit of this ServicePackageQuotaHistoryResponse.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this ServicePackageQuotaHistoryResponse.
Maximum amount of quota history entries contained in one paged response.
:param limit: The limit of this ServicePackageQuotaHistoryResponse.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this ServicePackageQuotaHistoryResponse.
Always set to 'service-package-quota-history'.
:return: The object of this ServicePackageQuotaHistoryResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ServicePackageQuotaHistoryResponse.
Always set to 'service-package-quota-history'.
:param object: The object of this ServicePackageQuotaHistoryResponse.
:type: str
'''
pass
@property
def total_count(self):
'''
Gets the total_count of this ServicePackageQuotaHistoryResponse.
Sum of all quota history entries that should be returned
:return: The total_count of this ServicePackageQuotaHistoryResponse.
:rtype: int
'''
pass
@total_count.setter
def total_count(self):
'''
Sets the total_count of this ServicePackageQuotaHistoryResponse.
Sum of all quota history entries that should be returned
:param total_count: The total_count of this ServicePackageQuotaHistoryResponse.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 11 | 1 | 5 | 5 | 2 | 0.86 | 1 | 4 | 0 | 0 | 18 | 7 | 18 | 18 | 261 | 43 | 117 | 44 | 86 | 101 | 78 | 32 | 59 | 5 | 1 | 2 | 34 |
2,446 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/service_package_quota_history_reservation.py
|
mbed_cloud._backends.billing.models.service_package_quota_history_reservation.ServicePackageQuotaHistoryReservation
|
class ServicePackageQuotaHistoryReservation(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 = {
'account_id': 'str',
'campaign_name': 'str',
'id': 'str'
}
attribute_map = {
'account_id': 'account_id',
'campaign_name': 'campaign_name',
'id': 'id'
}
def __init__(self, account_id=None, campaign_name=None, id=None):
"""
ServicePackageQuotaHistoryReservation - a model defined in Swagger
"""
self._account_id = account_id
self._campaign_name = campaign_name
self._id = id
self.discriminator = None
@property
def account_id(self):
"""
Gets the account_id of this ServicePackageQuotaHistoryReservation.
Account ID.
:return: The account_id of this ServicePackageQuotaHistoryReservation.
:rtype: str
"""
return self._account_id
@account_id.setter
def account_id(self, account_id):
"""
Sets the account_id of this ServicePackageQuotaHistoryReservation.
Account ID.
:param account_id: The account_id of this ServicePackageQuotaHistoryReservation.
:type: str
"""
if account_id is None:
raise ValueError("Invalid value for `account_id`, must not be `None`")
if account_id is not None and len(account_id) > 250:
raise ValueError("Invalid value for `account_id`, length must be less than or equal to `250`")
if account_id is not None and len(account_id) < 1:
raise ValueError("Invalid value for `account_id`, length must be greater than or equal to `1`")
self._account_id = account_id
@property
def campaign_name(self):
"""
Gets the campaign_name of this ServicePackageQuotaHistoryReservation.
Textual campaign name for this reservation.
:return: The campaign_name of this ServicePackageQuotaHistoryReservation.
:rtype: str
"""
return self._campaign_name
@campaign_name.setter
def campaign_name(self, campaign_name):
"""
Sets the campaign_name of this ServicePackageQuotaHistoryReservation.
Textual campaign name for this reservation.
:param campaign_name: The campaign_name of this ServicePackageQuotaHistoryReservation.
:type: str
"""
if campaign_name is None:
raise ValueError("Invalid value for `campaign_name`, must not be `None`")
if campaign_name is not None and len(campaign_name) > 250:
raise ValueError("Invalid value for `campaign_name`, length must be less than or equal to `250`")
if campaign_name is not None and len(campaign_name) < 1:
raise ValueError("Invalid value for `campaign_name`, length must be greater than or equal to `1`")
self._campaign_name = campaign_name
@property
def id(self):
"""
Gets the id of this ServicePackageQuotaHistoryReservation.
Reservation ID.
:return: The id of this ServicePackageQuotaHistoryReservation.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this ServicePackageQuotaHistoryReservation.
Reservation ID.
:param id: The id of this ServicePackageQuotaHistoryReservation.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
if id is not None and len(id) > 250:
raise ValueError("Invalid value for `id`, length must be less than or equal to `250`")
if id is not None and len(id) < 1:
raise ValueError("Invalid value for `id`, length must be greater than or equal to `1`")
self._id = id
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ServicePackageQuotaHistoryReservation):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ServicePackageQuotaHistoryReservation(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, account_id=None, campaign_name=None, id=None):
'''
ServicePackageQuotaHistoryReservation - a model defined in Swagger
'''
pass
@property
def account_id(self):
'''
Gets the account_id of this ServicePackageQuotaHistoryReservation.
Account ID.
:return: The account_id of this ServicePackageQuotaHistoryReservation.
:rtype: str
'''
pass
@account_id.setter
def account_id(self):
'''
Sets the account_id of this ServicePackageQuotaHistoryReservation.
Account ID.
:param account_id: The account_id of this ServicePackageQuotaHistoryReservation.
:type: str
'''
pass
@property
def campaign_name(self):
'''
Gets the campaign_name of this ServicePackageQuotaHistoryReservation.
Textual campaign name for this reservation.
:return: The campaign_name of this ServicePackageQuotaHistoryReservation.
:rtype: str
'''
pass
@campaign_name.setter
def campaign_name(self):
'''
Sets the campaign_name of this ServicePackageQuotaHistoryReservation.
Textual campaign name for this reservation.
:param campaign_name: The campaign_name of this ServicePackageQuotaHistoryReservation.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this ServicePackageQuotaHistoryReservation.
Reservation ID.
:return: The id of this ServicePackageQuotaHistoryReservation.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this ServicePackageQuotaHistoryReservation.
Reservation ID.
:param id: The id of this ServicePackageQuotaHistoryReservation.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 19 | 13 | 11 | 1 | 5 | 5 | 2 | 0.79 | 1 | 4 | 0 | 0 | 12 | 4 | 12 | 12 | 175 | 28 | 82 | 28 | 63 | 65 | 58 | 22 | 45 | 5 | 1 | 2 | 26 |
2,447 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/service_package_quota_history_item.py
|
mbed_cloud._backends.billing.models.service_package_quota_history_item.ServicePackageQuotaHistoryItem
|
class ServicePackageQuotaHistoryItem(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 = {
'added': 'datetime',
'amount': 'int',
'id': 'str',
'reason': 'str',
'reservation': 'ServicePackageQuotaHistoryReservation',
'service_package': 'ServicePackageQuotaHistoryServicePackage'
}
attribute_map = {
'added': 'added',
'amount': 'amount',
'id': 'id',
'reason': 'reason',
'reservation': 'reservation',
'service_package': 'service_package'
}
def __init__(self, added=None, amount=None, id=None, reason=None, reservation=None, service_package=None):
"""
ServicePackageQuotaHistoryItem - a model defined in Swagger
"""
self._added = added
self._amount = amount
self._id = id
self._reason = reason
self._reservation = reservation
self._service_package = service_package
self.discriminator = None
@property
def added(self):
"""
Gets the added of this ServicePackageQuotaHistoryItem.
Added time of quota history entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The added of this ServicePackageQuotaHistoryItem.
:rtype: datetime
"""
return self._added
@added.setter
def added(self, added):
"""
Sets the added of this ServicePackageQuotaHistoryItem.
Added time of quota history entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param added: The added of this ServicePackageQuotaHistoryItem.
:type: datetime
"""
if added is None:
raise ValueError("Invalid value for `added`, must not be `None`")
self._added = added
@property
def amount(self):
"""
Gets the amount of this ServicePackageQuotaHistoryItem.
the amount of quota usage, negative or positive
:return: The amount of this ServicePackageQuotaHistoryItem.
:rtype: int
"""
return self._amount
@amount.setter
def amount(self, amount):
"""
Sets the amount of this ServicePackageQuotaHistoryItem.
the amount of quota usage, negative or positive
:param amount: The amount of this ServicePackageQuotaHistoryItem.
:type: int
"""
if amount is None:
raise ValueError("Invalid value for `amount`, must not be `None`")
self._amount = amount
@property
def id(self):
"""
Gets the id of this ServicePackageQuotaHistoryItem.
Service package quota history ID.
:return: The id of this ServicePackageQuotaHistoryItem.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this ServicePackageQuotaHistoryItem.
Service package quota history ID.
:param id: The id of this ServicePackageQuotaHistoryItem.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
if id is not None and len(id) > 32:
raise ValueError("Invalid value for `id`, length must be less than or equal to `32`")
if id is not None and len(id) < 32:
raise ValueError("Invalid value for `id`, length must be greater than or equal to `32`")
self._id = id
@property
def reason(self):
"""
Gets the reason of this ServicePackageQuotaHistoryItem.
Type of quota usage entry.
:return: The reason of this ServicePackageQuotaHistoryItem.
:rtype: str
"""
return self._reason
@reason.setter
def reason(self, reason):
"""
Sets the reason of this ServicePackageQuotaHistoryItem.
Type of quota usage entry.
:param reason: The reason of this ServicePackageQuotaHistoryItem.
:type: str
"""
if reason is None:
raise ValueError("Invalid value for `reason`, must not be `None`")
allowed_values = ["reservation", "reservation_release", "reservation_termination", "package_creation", "package_renewal", "package_termination"]
if reason not in allowed_values:
raise ValueError(
"Invalid value for `reason` ({0}), must be one of {1}"
.format(reason, allowed_values)
)
self._reason = reason
@property
def reservation(self):
"""
Gets the reservation of this ServicePackageQuotaHistoryItem.
Reservation details if reason is reservation, reservation_release or reservation_termination.
:return: The reservation of this ServicePackageQuotaHistoryItem.
:rtype: ServicePackageQuotaHistoryReservation
"""
return self._reservation
@reservation.setter
def reservation(self, reservation):
"""
Sets the reservation of this ServicePackageQuotaHistoryItem.
Reservation details if reason is reservation, reservation_release or reservation_termination.
:param reservation: The reservation of this ServicePackageQuotaHistoryItem.
:type: ServicePackageQuotaHistoryReservation
"""
self._reservation = reservation
@property
def service_package(self):
"""
Gets the service_package of this ServicePackageQuotaHistoryItem.
Service package details if reason is package_creation, package_renewal or package_termination
:return: The service_package of this ServicePackageQuotaHistoryItem.
:rtype: ServicePackageQuotaHistoryServicePackage
"""
return self._service_package
@service_package.setter
def service_package(self, service_package):
"""
Sets the service_package of this ServicePackageQuotaHistoryItem.
Service package details if reason is package_creation, package_renewal or package_termination
:param service_package: The service_package of this ServicePackageQuotaHistoryItem.
:type: ServicePackageQuotaHistoryServicePackage
"""
self._service_package = service_package
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ServicePackageQuotaHistoryItem):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ServicePackageQuotaHistoryItem(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, added=None, amount=None, id=None, reason=None, reservation=None, service_package=None):
'''
ServicePackageQuotaHistoryItem - a model defined in Swagger
'''
pass
@property
def added(self):
'''
Gets the added of this ServicePackageQuotaHistoryItem.
Added time of quota history entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The added of this ServicePackageQuotaHistoryItem.
:rtype: datetime
'''
pass
@added.setter
def added(self):
'''
Sets the added of this ServicePackageQuotaHistoryItem.
Added time of quota history entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param added: The added of this ServicePackageQuotaHistoryItem.
:type: datetime
'''
pass
@property
def amount(self):
'''
Gets the amount of this ServicePackageQuotaHistoryItem.
the amount of quota usage, negative or positive
:return: The amount of this ServicePackageQuotaHistoryItem.
:rtype: int
'''
pass
@amount.setter
def amount(self):
'''
Sets the amount of this ServicePackageQuotaHistoryItem.
the amount of quota usage, negative or positive
:param amount: The amount of this ServicePackageQuotaHistoryItem.
:type: int
'''
pass
@property
def id(self):
'''
Gets the id of this ServicePackageQuotaHistoryItem.
Service package quota history ID.
:return: The id of this ServicePackageQuotaHistoryItem.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this ServicePackageQuotaHistoryItem.
Service package quota history ID.
:param id: The id of this ServicePackageQuotaHistoryItem.
:type: str
'''
pass
@property
def reason(self):
'''
Gets the reason of this ServicePackageQuotaHistoryItem.
Type of quota usage entry.
:return: The reason of this ServicePackageQuotaHistoryItem.
:rtype: str
'''
pass
@reason.setter
def reason(self):
'''
Sets the reason of this ServicePackageQuotaHistoryItem.
Type of quota usage entry.
:param reason: The reason of this ServicePackageQuotaHistoryItem.
:type: str
'''
pass
@property
def reservation(self):
'''
Gets the reservation of this ServicePackageQuotaHistoryItem.
Reservation details if reason is reservation, reservation_release or reservation_termination.
:return: The reservation of this ServicePackageQuotaHistoryItem.
:rtype: ServicePackageQuotaHistoryReservation
'''
pass
@reservation.setter
def reservation(self):
'''
Sets the reservation of this ServicePackageQuotaHistoryItem.
Reservation details if reason is reservation, reservation_release or reservation_termination.
:param reservation: The reservation of this ServicePackageQuotaHistoryItem.
:type: ServicePackageQuotaHistoryReservation
'''
pass
@property
def service_package(self):
'''
Gets the service_package of this ServicePackageQuotaHistoryItem.
Service package details if reason is package_creation, package_renewal or package_termination
:return: The service_package of this ServicePackageQuotaHistoryItem.
:rtype: ServicePackageQuotaHistoryServicePackage
'''
pass
@service_package.setter
def service_package(self):
'''
Sets the service_package of this ServicePackageQuotaHistoryItem.
Service package details if reason is package_creation, package_renewal or package_termination
:param service_package: The service_package of this ServicePackageQuotaHistoryItem.
:type: ServicePackageQuotaHistoryServicePackage
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 11 | 1 | 4 | 5 | 2 | 0.93 | 1 | 4 | 0 | 0 | 18 | 7 | 18 | 18 | 253 | 43 | 109 | 44 | 78 | 101 | 70 | 32 | 51 | 5 | 1 | 2 | 30 |
2,448 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/service_package_quota.py
|
mbed_cloud._backends.billing.models.service_package_quota.ServicePackageQuota
|
class ServicePackageQuota(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 = {
'object': 'str',
'quota': 'int'
}
attribute_map = {
'object': 'object',
'quota': 'quota'
}
def __init__(self, object=None, quota=None):
"""
ServicePackageQuota - a model defined in Swagger
"""
self._object = object
self._quota = quota
self.discriminator = None
@property
def object(self):
"""
Gets the object of this ServicePackageQuota.
Always set to 'service-package-quota'.
:return: The object of this ServicePackageQuota.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ServicePackageQuota.
Always set to 'service-package-quota'.
:param object: The object of this ServicePackageQuota.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["service-package-quota"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def quota(self):
"""
Gets the quota of this ServicePackageQuota.
Available quota for the service package.
:return: The quota of this ServicePackageQuota.
:rtype: int
"""
return self._quota
@quota.setter
def quota(self, quota):
"""
Sets the quota of this ServicePackageQuota.
Available quota for the service package.
:param quota: The quota of this ServicePackageQuota.
:type: int
"""
if quota is None:
raise ValueError("Invalid value for `quota`, must not be `None`")
if quota is not None and quota < 0:
raise ValueError("Invalid value for `quota`, must be a value greater than or equal to `0`")
self._quota = quota
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ServicePackageQuota):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ServicePackageQuota(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, object=None, quota=None):
'''
ServicePackageQuota - a model defined in Swagger
'''
pass
@property
def object(self):
'''
Gets the object of this ServicePackageQuota.
Always set to 'service-package-quota'.
:return: The object of this ServicePackageQuota.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ServicePackageQuota.
Always set to 'service-package-quota'.
:param object: The object of this ServicePackageQuota.
:type: str
'''
pass
@property
def quota(self):
'''
Gets the quota of this ServicePackageQuota.
Available quota for the service package.
:return: The quota of this ServicePackageQuota.
:rtype: int
'''
pass
@quota.setter
def quota(self):
'''
Sets the quota of this ServicePackageQuota.
Available quota for the service package.
:param quota: The quota of this ServicePackageQuota.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 11 | 1 | 5 | 4 | 2 | 0.79 | 1 | 4 | 0 | 0 | 10 | 3 | 10 | 10 | 143 | 23 | 67 | 24 | 52 | 53 | 44 | 20 | 33 | 5 | 1 | 2 | 19 |
2,449 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/service_package_metadata.py
|
mbed_cloud._backends.billing.models.service_package_metadata.ServicePackageMetadata
|
class ServicePackageMetadata(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 = {
'end_time': 'datetime',
'remaining_quota': 'int',
'reserved_quota': 'int',
'start_time': 'datetime'
}
attribute_map = {
'end_time': 'end_time',
'remaining_quota': 'remaining_quota',
'reserved_quota': 'reserved_quota',
'start_time': 'start_time'
}
def __init__(self, end_time=None, remaining_quota=None, reserved_quota=None, start_time=None):
"""
ServicePackageMetadata - a model defined in Swagger
"""
self._end_time = end_time
self._remaining_quota = remaining_quota
self._reserved_quota = reserved_quota
self._start_time = start_time
self.discriminator = None
@property
def end_time(self):
"""
Gets the end_time of this ServicePackageMetadata.
Service package end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The end_time of this ServicePackageMetadata.
:rtype: datetime
"""
return self._end_time
@end_time.setter
def end_time(self, end_time):
"""
Sets the end_time of this ServicePackageMetadata.
Service package end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param end_time: The end_time of this ServicePackageMetadata.
:type: datetime
"""
if end_time is None:
raise ValueError("Invalid value for `end_time`, must not be `None`")
self._end_time = end_time
@property
def remaining_quota(self):
"""
Gets the remaining_quota of this ServicePackageMetadata.
Current available service package quota.
:return: The remaining_quota of this ServicePackageMetadata.
:rtype: int
"""
return self._remaining_quota
@remaining_quota.setter
def remaining_quota(self, remaining_quota):
"""
Sets the remaining_quota of this ServicePackageMetadata.
Current available service package quota.
:param remaining_quota: The remaining_quota of this ServicePackageMetadata.
:type: int
"""
if remaining_quota is None:
raise ValueError("Invalid value for `remaining_quota`, must not be `None`")
if remaining_quota is not None and remaining_quota < 0:
raise ValueError("Invalid value for `remaining_quota`, must be a value greater than or equal to `0`")
self._remaining_quota = remaining_quota
@property
def reserved_quota(self):
"""
Gets the reserved_quota of this ServicePackageMetadata.
Sum of all open reservations for this account.
:return: The reserved_quota of this ServicePackageMetadata.
:rtype: int
"""
return self._reserved_quota
@reserved_quota.setter
def reserved_quota(self, reserved_quota):
"""
Sets the reserved_quota of this ServicePackageMetadata.
Sum of all open reservations for this account.
:param reserved_quota: The reserved_quota of this ServicePackageMetadata.
:type: int
"""
if reserved_quota is None:
raise ValueError("Invalid value for `reserved_quota`, must not be `None`")
if reserved_quota is not None and reserved_quota < 0:
raise ValueError("Invalid value for `reserved_quota`, must be a value greater than or equal to `0`")
self._reserved_quota = reserved_quota
@property
def start_time(self):
"""
Gets the start_time of this ServicePackageMetadata.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The start_time of this ServicePackageMetadata.
:rtype: datetime
"""
return self._start_time
@start_time.setter
def start_time(self, start_time):
"""
Sets the start_time of this ServicePackageMetadata.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param start_time: The start_time of this ServicePackageMetadata.
:type: datetime
"""
if start_time is None:
raise ValueError("Invalid value for `start_time`, must not be `None`")
self._start_time = start_time
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ServicePackageMetadata):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ServicePackageMetadata(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, end_time=None, remaining_quota=None, reserved_quota=None, start_time=None):
'''
ServicePackageMetadata - a model defined in Swagger
'''
pass
@property
def end_time(self):
'''
Gets the end_time of this ServicePackageMetadata.
Service package end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The end_time of this ServicePackageMetadata.
:rtype: datetime
'''
pass
@end_time.setter
def end_time(self):
'''
Sets the end_time of this ServicePackageMetadata.
Service package end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param end_time: The end_time of this ServicePackageMetadata.
:type: datetime
'''
pass
@property
def remaining_quota(self):
'''
Gets the remaining_quota of this ServicePackageMetadata.
Current available service package quota.
:return: The remaining_quota of this ServicePackageMetadata.
:rtype: int
'''
pass
@remaining_quota.setter
def remaining_quota(self):
'''
Sets the remaining_quota of this ServicePackageMetadata.
Current available service package quota.
:param remaining_quota: The remaining_quota of this ServicePackageMetadata.
:type: int
'''
pass
@property
def reserved_quota(self):
'''
Gets the reserved_quota of this ServicePackageMetadata.
Sum of all open reservations for this account.
:return: The reserved_quota of this ServicePackageMetadata.
:rtype: int
'''
pass
@reserved_quota.setter
def reserved_quota(self):
'''
Sets the reserved_quota of this ServicePackageMetadata.
Sum of all open reservations for this account.
:param reserved_quota: The reserved_quota of this ServicePackageMetadata.
:type: int
'''
pass
@property
def start_time(self):
'''
Gets the start_time of this ServicePackageMetadata.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The start_time of this ServicePackageMetadata.
:rtype: datetime
'''
pass
@start_time.setter
def start_time(self):
'''
Sets the start_time of this ServicePackageMetadata.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param start_time: The start_time of this ServicePackageMetadata.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 23 | 15 | 10 | 1 | 5 | 5 | 2 | 0.91 | 1 | 4 | 0 | 0 | 14 | 5 | 14 | 14 | 195 | 33 | 85 | 33 | 62 | 77 | 57 | 25 | 42 | 5 | 1 | 2 | 25 |
2,450 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/report_response.py
|
mbed_cloud._backends.billing.models.report_response.ReportResponse
|
class ReportResponse(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 = {
'account': 'ReportAccountContactInfo',
'aggregated': 'ReportBillingData',
'billing_data': 'ReportBillingData',
'id': 'str',
'month': 'str',
'object': 'str',
'service_package': 'ServicePackageReport',
'subtenants': 'list[SubtenantAccountReport]'
}
attribute_map = {
'account': 'account',
'aggregated': 'aggregated',
'billing_data': 'billing_data',
'id': 'id',
'month': 'month',
'object': 'object',
'service_package': 'service_package',
'subtenants': 'subtenants'
}
def __init__(self, account=None, aggregated=None, billing_data=None, id=None, month=None, object=None, service_package=None, subtenants=None):
"""
ReportResponse - a model defined in Swagger
"""
self._account = account
self._aggregated = aggregated
self._billing_data = billing_data
self._id = id
self._month = month
self._object = object
self._service_package = service_package
self._subtenants = subtenants
self.discriminator = None
@property
def account(self):
"""
Gets the account of this ReportResponse.
Account contact information.
:return: The account of this ReportResponse.
:rtype: ReportAccountContactInfo
"""
return self._account
@account.setter
def account(self, account):
"""
Sets the account of this ReportResponse.
Account contact information.
:param account: The account of this ReportResponse.
:type: ReportAccountContactInfo
"""
if account is None:
raise ValueError("Invalid value for `account`, must not be `None`")
self._account = account
@property
def aggregated(self):
"""
Gets the aggregated of this ReportResponse.
Aggregated report billing data including all subtenant accounts if any.
:return: The aggregated of this ReportResponse.
:rtype: ReportBillingData
"""
return self._aggregated
@aggregated.setter
def aggregated(self, aggregated):
"""
Sets the aggregated of this ReportResponse.
Aggregated report billing data including all subtenant accounts if any.
:param aggregated: The aggregated of this ReportResponse.
:type: ReportBillingData
"""
if aggregated is None:
raise ValueError("Invalid value for `aggregated`, must not be `None`")
self._aggregated = aggregated
@property
def billing_data(self):
"""
Gets the billing_data of this ReportResponse.
Report billing data.
:return: The billing_data of this ReportResponse.
:rtype: ReportBillingData
"""
return self._billing_data
@billing_data.setter
def billing_data(self, billing_data):
"""
Sets the billing_data of this ReportResponse.
Report billing data.
:param billing_data: The billing_data of this ReportResponse.
:type: ReportBillingData
"""
if billing_data is None:
raise ValueError("Invalid value for `billing_data`, must not be `None`")
self._billing_data = billing_data
@property
def id(self):
"""
Gets the id of this ReportResponse.
Billing report ID.
:return: The id of this ReportResponse.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this ReportResponse.
Billing report ID.
:param id: The id of this ReportResponse.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def month(self):
"""
Gets the month of this ReportResponse.
Month of requested billing report
:return: The month of this ReportResponse.
:rtype: str
"""
return self._month
@month.setter
def month(self, month):
"""
Sets the month of this ReportResponse.
Month of requested billing report
:param month: The month of this ReportResponse.
:type: str
"""
if month is None:
raise ValueError("Invalid value for `month`, must not be `None`")
if month is not None and not re.search('^\\d{4}-\\d{2}$', month):
raise ValueError("Invalid value for `month`, must be a follow pattern or equal to `/^\\d{4}-\\d{2}$/`")
self._month = month
@property
def object(self):
"""
Gets the object of this ReportResponse.
Billing report response object. Always set to 'billing-report'.
:return: The object of this ReportResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ReportResponse.
Billing report response object. Always set to 'billing-report'.
:param object: The object of this ReportResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["billing-report"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def service_package(self):
"""
Gets the service_package of this ReportResponse.
Report service package.
:return: The service_package of this ReportResponse.
:rtype: ServicePackageReport
"""
return self._service_package
@service_package.setter
def service_package(self, service_package):
"""
Sets the service_package of this ReportResponse.
Report service package.
:param service_package: The service_package of this ReportResponse.
:type: ServicePackageReport
"""
self._service_package = service_package
@property
def subtenants(self):
"""
Gets the subtenants of this ReportResponse.
List of billing reports for subtenant accounts. Empty list if account does not have any subtenant account.
:return: The subtenants of this ReportResponse.
:rtype: list[SubtenantAccountReport]
"""
return self._subtenants
@subtenants.setter
def subtenants(self, subtenants):
"""
Sets the subtenants of this ReportResponse.
List of billing reports for subtenant accounts. Empty list if account does not have any subtenant account.
:param subtenants: The subtenants of this ReportResponse.
:type: list[SubtenantAccountReport]
"""
if subtenants is None:
raise ValueError("Invalid value for `subtenants`, must not be `None`")
self._subtenants = subtenants
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ReportResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ReportResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, account=None, aggregated=None, billing_data=None, id=None, month=None, object=None, service_package=None, subtenants=None):
'''
ReportResponse - a model defined in Swagger
'''
pass
@property
def account(self):
'''
Gets the account of this ReportResponse.
Account contact information.
:return: The account of this ReportResponse.
:rtype: ReportAccountContactInfo
'''
pass
@account.setter
def account(self):
'''
Sets the account of this ReportResponse.
Account contact information.
:param account: The account of this ReportResponse.
:type: ReportAccountContactInfo
'''
pass
@property
def aggregated(self):
'''
Gets the aggregated of this ReportResponse.
Aggregated report billing data including all subtenant accounts if any.
:return: The aggregated of this ReportResponse.
:rtype: ReportBillingData
'''
pass
@aggregated.setter
def aggregated(self):
'''
Sets the aggregated of this ReportResponse.
Aggregated report billing data including all subtenant accounts if any.
:param aggregated: The aggregated of this ReportResponse.
:type: ReportBillingData
'''
pass
@property
def billing_data(self):
'''
Gets the billing_data of this ReportResponse.
Report billing data.
:return: The billing_data of this ReportResponse.
:rtype: ReportBillingData
'''
pass
@billing_data.setter
def billing_data(self):
'''
Sets the billing_data of this ReportResponse.
Report billing data.
:param billing_data: The billing_data of this ReportResponse.
:type: ReportBillingData
'''
pass
@property
def id(self):
'''
Gets the id of this ReportResponse.
Billing report ID.
:return: The id of this ReportResponse.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this ReportResponse.
Billing report ID.
:param id: The id of this ReportResponse.
:type: str
'''
pass
@property
def month(self):
'''
Gets the month of this ReportResponse.
Month of requested billing report
:return: The month of this ReportResponse.
:rtype: str
'''
pass
@month.setter
def month(self):
'''
Sets the month of this ReportResponse.
Month of requested billing report
:param month: The month of this ReportResponse.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this ReportResponse.
Billing report response object. Always set to 'billing-report'.
:return: The object of this ReportResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ReportResponse.
Billing report response object. Always set to 'billing-report'.
:param object: The object of this ReportResponse.
:type: str
'''
pass
@property
def service_package(self):
'''
Gets the service_package of this ReportResponse.
Report service package.
:return: The service_package of this ReportResponse.
:rtype: ServicePackageReport
'''
pass
@service_package.setter
def service_package(self):
'''
Sets the service_package of this ReportResponse.
Report service package.
:param service_package: The service_package of this ReportResponse.
:type: ServicePackageReport
'''
pass
@property
def subtenants(self):
'''
Gets the subtenants of this ReportResponse.
List of billing reports for subtenant accounts. Empty list if account does not have any subtenant account.
:return: The subtenants of this ReportResponse.
:rtype: list[SubtenantAccountReport]
'''
pass
@subtenants.setter
def subtenants(self):
'''
Sets the subtenants of this ReportResponse.
List of billing reports for subtenant accounts. Empty list if account does not have any subtenant account.
:param subtenants: The subtenants of this ReportResponse.
:type: list[SubtenantAccountReport]
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 39 | 23 | 11 | 1 | 4 | 5 | 2 | 0.95 | 1 | 4 | 0 | 0 | 22 | 9 | 22 | 22 | 309 | 53 | 131 | 54 | 92 | 125 | 84 | 38 | 61 | 5 | 1 | 2 | 36 |
2,451 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/report_not_found_error_response.py
|
mbed_cloud._backends.billing.models.report_not_found_error_response.ReportNotFoundErrorResponse
|
class ReportNotFoundErrorResponse(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'code': 'int',
'message': 'str',
'object': 'str',
'request_id': 'str',
'type': 'str'
}
attribute_map = {
'code': 'code',
'message': 'message',
'object': 'object',
'request_id': 'request_id',
'type': 'type'
}
def __init__(self, code=None, message=None, object=None, request_id=None, type=None):
"""
ReportNotFoundErrorResponse - a model defined in Swagger
"""
self._code = code
self._message = message
self._object = object
self._request_id = request_id
self._type = type
self.discriminator = None
@property
def code(self):
"""
Gets the code of this ReportNotFoundErrorResponse.
Response code. Always set to 404.
:return: The code of this ReportNotFoundErrorResponse.
:rtype: int
"""
return self._code
@code.setter
def code(self, code):
"""
Sets the code of this ReportNotFoundErrorResponse.
Response code. Always set to 404.
:param code: The code of this ReportNotFoundErrorResponse.
:type: int
"""
if code is None:
raise ValueError("Invalid value for `code`, must not be `None`")
self._code = code
@property
def message(self):
"""
Gets the message of this ReportNotFoundErrorResponse.
A human readable message with detailed info.
:return: The message of this ReportNotFoundErrorResponse.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this ReportNotFoundErrorResponse.
A human readable message with detailed info.
:param message: The message of this ReportNotFoundErrorResponse.
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`")
self._message = message
@property
def object(self):
"""
Gets the object of this ReportNotFoundErrorResponse.
Always set to 'error'.
:return: The object of this ReportNotFoundErrorResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ReportNotFoundErrorResponse.
Always set to 'error'.
:param object: The object of this ReportNotFoundErrorResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["error"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def request_id(self):
"""
Gets the request_id of this ReportNotFoundErrorResponse.
Request ID
:return: The request_id of this ReportNotFoundErrorResponse.
:rtype: str
"""
return self._request_id
@request_id.setter
def request_id(self, request_id):
"""
Sets the request_id of this ReportNotFoundErrorResponse.
Request ID
:param request_id: The request_id of this ReportNotFoundErrorResponse.
:type: str
"""
if request_id is None:
raise ValueError("Invalid value for `request_id`, must not be `None`")
self._request_id = request_id
@property
def type(self):
"""
Gets the type of this ReportNotFoundErrorResponse.
Error type. Always set to 'report_not_found'.
:return: The type of this ReportNotFoundErrorResponse.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this ReportNotFoundErrorResponse.
Error type. Always set to 'report_not_found'.
:param type: The type of this ReportNotFoundErrorResponse.
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`")
allowed_values = ["report_not_found"]
if type not in allowed_values:
raise ValueError(
"Invalid value for `type` ({0}), must be one of {1}"
.format(type, allowed_values)
)
self._type = type
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ReportNotFoundErrorResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ReportNotFoundErrorResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, code=None, message=None, object=None, request_id=None, type=None):
'''
ReportNotFoundErrorResponse - a model defined in Swagger
'''
pass
@property
def code(self):
'''
Gets the code of this ReportNotFoundErrorResponse.
Response code. Always set to 404.
:return: The code of this ReportNotFoundErrorResponse.
:rtype: int
'''
pass
@code.setter
def code(self):
'''
Sets the code of this ReportNotFoundErrorResponse.
Response code. Always set to 404.
:param code: The code of this ReportNotFoundErrorResponse.
:type: int
'''
pass
@property
def message(self):
'''
Gets the message of this ReportNotFoundErrorResponse.
A human readable message with detailed info.
:return: The message of this ReportNotFoundErrorResponse.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this ReportNotFoundErrorResponse.
A human readable message with detailed info.
:param message: The message of this ReportNotFoundErrorResponse.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this ReportNotFoundErrorResponse.
Always set to 'error'.
:return: The object of this ReportNotFoundErrorResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ReportNotFoundErrorResponse.
Always set to 'error'.
:param object: The object of this ReportNotFoundErrorResponse.
:type: str
'''
pass
@property
def request_id(self):
'''
Gets the request_id of this ReportNotFoundErrorResponse.
Request ID
:return: The request_id of this ReportNotFoundErrorResponse.
:rtype: str
'''
pass
@request_id.setter
def request_id(self):
'''
Sets the request_id of this ReportNotFoundErrorResponse.
Request ID
:param request_id: The request_id of this ReportNotFoundErrorResponse.
:type: str
'''
pass
@property
def type(self):
'''
Gets the type of this ReportNotFoundErrorResponse.
Error type. Always set to 'report_not_found'.
:return: The type of this ReportNotFoundErrorResponse.
:rtype: str
'''
pass
@type.setter
def type(self):
'''
Sets the type of this ReportNotFoundErrorResponse.
Error type. Always set to 'report_not_found'.
:param type: The type of this ReportNotFoundErrorResponse.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 27 | 17 | 11 | 1 | 5 | 5 | 2 | 0.86 | 1 | 4 | 0 | 0 | 16 | 6 | 16 | 16 | 231 | 38 | 104 | 40 | 77 | 89 | 66 | 30 | 49 | 5 | 1 | 2 | 28 |
2,452 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/report_billing_data.py
|
mbed_cloud._backends.billing.models.report_billing_data.ReportBillingData
|
class ReportBillingData(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 = {
'active_devices': 'int',
'firmware_updates': 'int',
'generated': 'datetime',
'period_end': 'datetime',
'period_start': 'datetime'
}
attribute_map = {
'active_devices': 'active_devices',
'firmware_updates': 'firmware_updates',
'generated': 'generated',
'period_end': 'period_end',
'period_start': 'period_start'
}
def __init__(self, active_devices=None, firmware_updates=None, generated=None, period_end=None, period_start=None):
"""
ReportBillingData - a model defined in Swagger
"""
self._active_devices = active_devices
self._firmware_updates = firmware_updates
self._generated = generated
self._period_end = period_end
self._period_start = period_start
self.discriminator = None
@property
def active_devices(self):
"""
Gets the active_devices of this ReportBillingData.
:return: The active_devices of this ReportBillingData.
:rtype: int
"""
return self._active_devices
@active_devices.setter
def active_devices(self, active_devices):
"""
Sets the active_devices of this ReportBillingData.
:param active_devices: The active_devices of this ReportBillingData.
:type: int
"""
if active_devices is None:
raise ValueError("Invalid value for `active_devices`, must not be `None`")
if active_devices is not None and active_devices < 0:
raise ValueError("Invalid value for `active_devices`, must be a value greater than or equal to `0`")
self._active_devices = active_devices
@property
def firmware_updates(self):
"""
Gets the firmware_updates of this ReportBillingData.
:return: The firmware_updates of this ReportBillingData.
:rtype: int
"""
return self._firmware_updates
@firmware_updates.setter
def firmware_updates(self, firmware_updates):
"""
Sets the firmware_updates of this ReportBillingData.
:param firmware_updates: The firmware_updates of this ReportBillingData.
:type: int
"""
if firmware_updates is None:
raise ValueError("Invalid value for `firmware_updates`, must not be `None`")
if firmware_updates is not None and firmware_updates < 0:
raise ValueError("Invalid value for `firmware_updates`, must be a value greater than or equal to `0`")
self._firmware_updates = firmware_updates
@property
def generated(self):
"""
Gets the generated of this ReportBillingData.
Billing report generated time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The generated of this ReportBillingData.
:rtype: datetime
"""
return self._generated
@generated.setter
def generated(self, generated):
"""
Sets the generated of this ReportBillingData.
Billing report generated time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param generated: The generated of this ReportBillingData.
:type: datetime
"""
if generated is None:
raise ValueError("Invalid value for `generated`, must not be `None`")
self._generated = generated
@property
def period_end(self):
"""
Gets the period_end of this ReportBillingData.
Billing report end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The period_end of this ReportBillingData.
:rtype: datetime
"""
return self._period_end
@period_end.setter
def period_end(self, period_end):
"""
Sets the period_end of this ReportBillingData.
Billing report end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param period_end: The period_end of this ReportBillingData.
:type: datetime
"""
if period_end is None:
raise ValueError("Invalid value for `period_end`, must not be `None`")
self._period_end = period_end
@property
def period_start(self):
"""
Gets the period_start of this ReportBillingData.
Billing report start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The period_start of this ReportBillingData.
:rtype: datetime
"""
return self._period_start
@period_start.setter
def period_start(self, period_start):
"""
Sets the period_start of this ReportBillingData.
Billing report start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param period_start: The period_start of this ReportBillingData.
:type: datetime
"""
if period_start is None:
raise ValueError("Invalid value for `period_start`, must not be `None`")
self._period_start = period_start
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ReportBillingData):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ReportBillingData(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, active_devices=None, firmware_updates=None, generated=None, period_end=None, period_start=None):
'''
ReportBillingData - a model defined in Swagger
'''
pass
@property
def active_devices(self):
'''
Gets the active_devices of this ReportBillingData.
:return: The active_devices of this ReportBillingData.
:rtype: int
'''
pass
@active_devices.setter
def active_devices(self):
'''
Sets the active_devices of this ReportBillingData.
:param active_devices: The active_devices of this ReportBillingData.
:type: int
'''
pass
@property
def firmware_updates(self):
'''
Gets the firmware_updates of this ReportBillingData.
:return: The firmware_updates of this ReportBillingData.
:rtype: int
'''
pass
@firmware_updates.setter
def firmware_updates(self):
'''
Sets the firmware_updates of this ReportBillingData.
:param firmware_updates: The firmware_updates of this ReportBillingData.
:type: int
'''
pass
@property
def generated(self):
'''
Gets the generated of this ReportBillingData.
Billing report generated time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The generated of this ReportBillingData.
:rtype: datetime
'''
pass
@generated.setter
def generated(self):
'''
Sets the generated of this ReportBillingData.
Billing report generated time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param generated: The generated of this ReportBillingData.
:type: datetime
'''
pass
@property
def period_end(self):
'''
Gets the period_end of this ReportBillingData.
Billing report end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The period_end of this ReportBillingData.
:rtype: datetime
'''
pass
@period_end.setter
def period_end(self):
'''
Sets the period_end of this ReportBillingData.
Billing report end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param period_end: The period_end of this ReportBillingData.
:type: datetime
'''
pass
@property
def period_start(self):
'''
Gets the period_start of this ReportBillingData.
Billing report start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The period_start of this ReportBillingData.
:rtype: datetime
'''
pass
@period_start.setter
def period_start(self):
'''
Sets the period_start of this ReportBillingData.
Billing report start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param period_start: The period_start of this ReportBillingData.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 27 | 17 | 10 | 1 | 4 | 5 | 2 | 0.89 | 1 | 4 | 0 | 0 | 16 | 6 | 16 | 16 | 219 | 38 | 96 | 38 | 69 | 85 | 64 | 28 | 47 | 5 | 1 | 2 | 28 |
2,453 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/subtenant_account_report.py
|
mbed_cloud._backends.billing.models.subtenant_account_report.SubtenantAccountReport
|
class SubtenantAccountReport(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 = {
'account': 'SubtenantReportAccountContactInfo',
'billing_data': 'ReportBillingData',
'service_package': 'SubtenantServicePackageReport'
}
attribute_map = {
'account': 'account',
'billing_data': 'billing_data',
'service_package': 'service_package'
}
def __init__(self, account=None, billing_data=None, service_package=None):
"""
SubtenantAccountReport - a model defined in Swagger
"""
self._account = account
self._billing_data = billing_data
self._service_package = service_package
self.discriminator = None
@property
def account(self):
"""
Gets the account of this SubtenantAccountReport.
Subtenant account contact information.
:return: The account of this SubtenantAccountReport.
:rtype: SubtenantReportAccountContactInfo
"""
return self._account
@account.setter
def account(self, account):
"""
Sets the account of this SubtenantAccountReport.
Subtenant account contact information.
:param account: The account of this SubtenantAccountReport.
:type: SubtenantReportAccountContactInfo
"""
if account is None:
raise ValueError("Invalid value for `account`, must not be `None`")
self._account = account
@property
def billing_data(self):
"""
Gets the billing_data of this SubtenantAccountReport.
Report billing data.
:return: The billing_data of this SubtenantAccountReport.
:rtype: ReportBillingData
"""
return self._billing_data
@billing_data.setter
def billing_data(self, billing_data):
"""
Sets the billing_data of this SubtenantAccountReport.
Report billing data.
:param billing_data: The billing_data of this SubtenantAccountReport.
:type: ReportBillingData
"""
if billing_data is None:
raise ValueError("Invalid value for `billing_data`, must not be `None`")
self._billing_data = billing_data
@property
def service_package(self):
"""
Gets the service_package of this SubtenantAccountReport.
Report service package for subtenant account.
:return: The service_package of this SubtenantAccountReport.
:rtype: SubtenantServicePackageReport
"""
return self._service_package
@service_package.setter
def service_package(self, service_package):
"""
Sets the service_package of this SubtenantAccountReport.
Report service package for subtenant account.
:param service_package: The service_package of this SubtenantAccountReport.
:type: SubtenantServicePackageReport
"""
self._service_package = service_package
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, SubtenantAccountReport):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class SubtenantAccountReport(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, account=None, billing_data=None, service_package=None):
'''
SubtenantAccountReport - a model defined in Swagger
'''
pass
@property
def account(self):
'''
Gets the account of this SubtenantAccountReport.
Subtenant account contact information.
:return: The account of this SubtenantAccountReport.
:rtype: SubtenantReportAccountContactInfo
'''
pass
@account.setter
def account(self):
'''
Sets the account of this SubtenantAccountReport.
Subtenant account contact information.
:param account: The account of this SubtenantAccountReport.
:type: SubtenantReportAccountContactInfo
'''
pass
@property
def billing_data(self):
'''
Gets the billing_data of this SubtenantAccountReport.
Report billing data.
:return: The billing_data of this SubtenantAccountReport.
:rtype: ReportBillingData
'''
pass
@billing_data.setter
def billing_data(self):
'''
Sets the billing_data of this SubtenantAccountReport.
Report billing data.
:param billing_data: The billing_data of this SubtenantAccountReport.
:type: ReportBillingData
'''
pass
@property
def service_package(self):
'''
Gets the service_package of this SubtenantAccountReport.
Report service package for subtenant account.
:return: The service_package of this SubtenantAccountReport.
:rtype: SubtenantServicePackageReport
'''
pass
@service_package.setter
def service_package(self):
'''
Sets the service_package of this SubtenantAccountReport.
Report service package for subtenant account.
:param service_package: The service_package of this SubtenantAccountReport.
:type: SubtenantServicePackageReport
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 19 | 13 | 10 | 1 | 4 | 5 | 2 | 0.96 | 1 | 4 | 0 | 0 | 12 | 4 | 12 | 12 | 161 | 28 | 68 | 28 | 49 | 65 | 44 | 22 | 31 | 5 | 1 | 2 | 19 |
2,454 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/report_account_contact_info.py
|
mbed_cloud._backends.billing.models.report_account_contact_info.ReportAccountContactInfo
|
class ReportAccountContactInfo(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'address_line1': 'str',
'address_line2': 'str',
'city': 'str',
'company': 'str',
'contact': 'str',
'country': 'str',
'email': 'str',
'id': 'str',
'phone_number': 'str',
'postal_code': 'str',
'state': 'str'
}
attribute_map = {
'address_line1': 'address_line1',
'address_line2': 'address_line2',
'city': 'city',
'company': 'company',
'contact': 'contact',
'country': 'country',
'email': 'email',
'id': 'id',
'phone_number': 'phone_number',
'postal_code': 'postal_code',
'state': 'state'
}
def __init__(self, address_line1=None, address_line2=None, city=None, company=None, contact=None, country=None, email=None, id=None, phone_number=None, postal_code=None, state=None):
"""
ReportAccountContactInfo - a model defined in Swagger
"""
self._address_line1 = address_line1
self._address_line2 = address_line2
self._city = city
self._company = company
self._contact = contact
self._country = country
self._email = email
self._id = id
self._phone_number = phone_number
self._postal_code = postal_code
self._state = state
self.discriminator = None
@property
def address_line1(self):
"""
Gets the address_line1 of this ReportAccountContactInfo.
:return: The address_line1 of this ReportAccountContactInfo.
:rtype: str
"""
return self._address_line1
@address_line1.setter
def address_line1(self, address_line1):
"""
Sets the address_line1 of this ReportAccountContactInfo.
:param address_line1: The address_line1 of this ReportAccountContactInfo.
:type: str
"""
self._address_line1 = address_line1
@property
def address_line2(self):
"""
Gets the address_line2 of this ReportAccountContactInfo.
:return: The address_line2 of this ReportAccountContactInfo.
:rtype: str
"""
return self._address_line2
@address_line2.setter
def address_line2(self, address_line2):
"""
Sets the address_line2 of this ReportAccountContactInfo.
:param address_line2: The address_line2 of this ReportAccountContactInfo.
:type: str
"""
self._address_line2 = address_line2
@property
def city(self):
"""
Gets the city of this ReportAccountContactInfo.
:return: The city of this ReportAccountContactInfo.
:rtype: str
"""
return self._city
@city.setter
def city(self, city):
"""
Sets the city of this ReportAccountContactInfo.
:param city: The city of this ReportAccountContactInfo.
:type: str
"""
self._city = city
@property
def company(self):
"""
Gets the company of this ReportAccountContactInfo.
:return: The company of this ReportAccountContactInfo.
:rtype: str
"""
return self._company
@company.setter
def company(self, company):
"""
Sets the company of this ReportAccountContactInfo.
:param company: The company of this ReportAccountContactInfo.
:type: str
"""
if company is None:
raise ValueError("Invalid value for `company`, must not be `None`")
self._company = company
@property
def contact(self):
"""
Gets the contact of this ReportAccountContactInfo.
:return: The contact of this ReportAccountContactInfo.
:rtype: str
"""
return self._contact
@contact.setter
def contact(self, contact):
"""
Sets the contact of this ReportAccountContactInfo.
:param contact: The contact of this ReportAccountContactInfo.
:type: str
"""
self._contact = contact
@property
def country(self):
"""
Gets the country of this ReportAccountContactInfo.
:return: The country of this ReportAccountContactInfo.
:rtype: str
"""
return self._country
@country.setter
def country(self, country):
"""
Sets the country of this ReportAccountContactInfo.
:param country: The country of this ReportAccountContactInfo.
:type: str
"""
self._country = country
@property
def email(self):
"""
Gets the email of this ReportAccountContactInfo.
:return: The email of this ReportAccountContactInfo.
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""
Sets the email of this ReportAccountContactInfo.
:param email: The email of this ReportAccountContactInfo.
:type: str
"""
self._email = email
@property
def id(self):
"""
Gets the id of this ReportAccountContactInfo.
Account ID.
:return: The id of this ReportAccountContactInfo.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this ReportAccountContactInfo.
Account ID.
:param id: The id of this ReportAccountContactInfo.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def phone_number(self):
"""
Gets the phone_number of this ReportAccountContactInfo.
:return: The phone_number of this ReportAccountContactInfo.
:rtype: str
"""
return self._phone_number
@phone_number.setter
def phone_number(self, phone_number):
"""
Sets the phone_number of this ReportAccountContactInfo.
:param phone_number: The phone_number of this ReportAccountContactInfo.
:type: str
"""
self._phone_number = phone_number
@property
def postal_code(self):
"""
Gets the postal_code of this ReportAccountContactInfo.
:return: The postal_code of this ReportAccountContactInfo.
:rtype: str
"""
return self._postal_code
@postal_code.setter
def postal_code(self, postal_code):
"""
Sets the postal_code of this ReportAccountContactInfo.
:param postal_code: The postal_code of this ReportAccountContactInfo.
:type: str
"""
self._postal_code = postal_code
@property
def state(self):
"""
Gets the state of this ReportAccountContactInfo.
:return: The state of this ReportAccountContactInfo.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this ReportAccountContactInfo.
:param state: The state of this ReportAccountContactInfo.
:type: str
"""
self._state = state
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ReportAccountContactInfo):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ReportAccountContactInfo(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, address_line1=None, address_line2=None, city=None, company=None, contact=None, country=None, email=None, id=None, phone_number=None, postal_code=None, state=None):
'''
ReportAccountContactInfo - a model defined in Swagger
'''
pass
@property
def address_line1(self):
'''
Gets the address_line1 of this ReportAccountContactInfo.
:return: The address_line1 of this ReportAccountContactInfo.
:rtype: str
'''
pass
@address_line1.setter
def address_line1(self):
'''
Sets the address_line1 of this ReportAccountContactInfo.
:param address_line1: The address_line1 of this ReportAccountContactInfo.
:type: str
'''
pass
@property
def address_line2(self):
'''
Gets the address_line2 of this ReportAccountContactInfo.
:return: The address_line2 of this ReportAccountContactInfo.
:rtype: str
'''
pass
@address_line2.setter
def address_line2(self):
'''
Sets the address_line2 of this ReportAccountContactInfo.
:param address_line2: The address_line2 of this ReportAccountContactInfo.
:type: str
'''
pass
@property
def city(self):
'''
Gets the city of this ReportAccountContactInfo.
:return: The city of this ReportAccountContactInfo.
:rtype: str
'''
pass
@city.setter
def city(self):
'''
Sets the city of this ReportAccountContactInfo.
:param city: The city of this ReportAccountContactInfo.
:type: str
'''
pass
@property
def company(self):
'''
Gets the company of this ReportAccountContactInfo.
:return: The company of this ReportAccountContactInfo.
:rtype: str
'''
pass
@company.setter
def company(self):
'''
Sets the company of this ReportAccountContactInfo.
:param company: The company of this ReportAccountContactInfo.
:type: str
'''
pass
@property
def contact(self):
'''
Gets the contact of this ReportAccountContactInfo.
:return: The contact of this ReportAccountContactInfo.
:rtype: str
'''
pass
@contact.setter
def contact(self):
'''
Sets the contact of this ReportAccountContactInfo.
:param contact: The contact of this ReportAccountContactInfo.
:type: str
'''
pass
@property
def country(self):
'''
Gets the country of this ReportAccountContactInfo.
:return: The country of this ReportAccountContactInfo.
:rtype: str
'''
pass
@country.setter
def country(self):
'''
Sets the country of this ReportAccountContactInfo.
:param country: The country of this ReportAccountContactInfo.
:type: str
'''
pass
@property
def email(self):
'''
Gets the email of this ReportAccountContactInfo.
:return: The email of this ReportAccountContactInfo.
:rtype: str
'''
pass
@email.setter
def email(self):
'''
Sets the email of this ReportAccountContactInfo.
:param email: The email of this ReportAccountContactInfo.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this ReportAccountContactInfo.
Account ID.
:return: The id of this ReportAccountContactInfo.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this ReportAccountContactInfo.
Account ID.
:param id: The id of this ReportAccountContactInfo.
:type: str
'''
pass
@property
def phone_number(self):
'''
Gets the phone_number of this ReportAccountContactInfo.
:return: The phone_number of this ReportAccountContactInfo.
:rtype: str
'''
pass
@phone_number.setter
def phone_number(self):
'''
Sets the phone_number of this ReportAccountContactInfo.
:param phone_number: The phone_number of this ReportAccountContactInfo.
:type: str
'''
pass
@property
def postal_code(self):
'''
Gets the postal_code of this ReportAccountContactInfo.
:return: The postal_code of this ReportAccountContactInfo.
:rtype: str
'''
pass
@postal_code.setter
def postal_code(self):
'''
Sets the postal_code of this ReportAccountContactInfo.
:param postal_code: The postal_code of this ReportAccountContactInfo.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this ReportAccountContactInfo.
:return: The state of this ReportAccountContactInfo.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this ReportAccountContactInfo.
:param state: The state of this ReportAccountContactInfo.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 51 | 29 | 9 | 1 | 3 | 5 | 1 | 1.01 | 1 | 4 | 0 | 0 | 28 | 12 | 28 | 28 | 349 | 68 | 140 | 68 | 89 | 141 | 84 | 46 | 55 | 5 | 1 | 2 | 35 |
2,455 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/previous_service_package.py
|
mbed_cloud._backends.billing.models.previous_service_package.PreviousServicePackage
|
class PreviousServicePackage(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 = {
'created': 'datetime',
'end_time': 'datetime',
'expires': 'datetime',
'firmware_update_count': 'int',
'id': 'str',
'modified': 'datetime',
'next_id': 'str',
'previous_id': 'str',
'reason': 'str',
'start_time': 'datetime'
}
attribute_map = {
'created': 'created',
'end_time': 'end_time',
'expires': 'expires',
'firmware_update_count': 'firmware_update_count',
'id': 'id',
'modified': 'modified',
'next_id': 'next_id',
'previous_id': 'previous_id',
'reason': 'reason',
'start_time': 'start_time'
}
def __init__(self, created=None, end_time=None, expires=None, firmware_update_count=None, id=None, modified=None, next_id=None, previous_id=None, reason=None, start_time=None):
"""
PreviousServicePackage - a model defined in Swagger
"""
self._created = created
self._end_time = end_time
self._expires = expires
self._firmware_update_count = firmware_update_count
self._id = id
self._modified = modified
self._next_id = next_id
self._previous_id = previous_id
self._reason = reason
self._start_time = start_time
self.discriminator = None
@property
def created(self):
"""
Gets the created of this PreviousServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The created of this PreviousServicePackage.
:rtype: datetime
"""
return self._created
@created.setter
def created(self, created):
"""
Sets the created of this PreviousServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param created: The created of this PreviousServicePackage.
:type: datetime
"""
if created is None:
raise ValueError("Invalid value for `created`, must not be `None`")
self._created = created
@property
def end_time(self):
"""
Gets the end_time of this PreviousServicePackage.
Service package end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The end_time of this PreviousServicePackage.
:rtype: datetime
"""
return self._end_time
@end_time.setter
def end_time(self, end_time):
"""
Sets the end_time of this PreviousServicePackage.
Service package end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param end_time: The end_time of this PreviousServicePackage.
:type: datetime
"""
if end_time is None:
raise ValueError("Invalid value for `end_time`, must not be `None`")
self._end_time = end_time
@property
def expires(self):
"""
Gets the expires of this PreviousServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The expires of this PreviousServicePackage.
:rtype: datetime
"""
return self._expires
@expires.setter
def expires(self, expires):
"""
Sets the expires of this PreviousServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param expires: The expires of this PreviousServicePackage.
:type: datetime
"""
if expires is None:
raise ValueError("Invalid value for `expires`, must not be `None`")
self._expires = expires
@property
def firmware_update_count(self):
"""
Gets the firmware_update_count of this PreviousServicePackage.
Size of firmware update quota of this service package.
:return: The firmware_update_count of this PreviousServicePackage.
:rtype: int
"""
return self._firmware_update_count
@firmware_update_count.setter
def firmware_update_count(self, firmware_update_count):
"""
Sets the firmware_update_count of this PreviousServicePackage.
Size of firmware update quota of this service package.
:param firmware_update_count: The firmware_update_count of this PreviousServicePackage.
:type: int
"""
if firmware_update_count is None:
raise ValueError("Invalid value for `firmware_update_count`, must not be `None`")
self._firmware_update_count = firmware_update_count
@property
def id(self):
"""
Gets the id of this PreviousServicePackage.
ID of this service package.
:return: The id of this PreviousServicePackage.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this PreviousServicePackage.
ID of this service package.
:param id: The id of this PreviousServicePackage.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def modified(self):
"""
Gets the modified of this PreviousServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The modified of this PreviousServicePackage.
:rtype: datetime
"""
return self._modified
@modified.setter
def modified(self, modified):
"""
Sets the modified of this PreviousServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param modified: The modified of this PreviousServicePackage.
:type: datetime
"""
if modified is None:
raise ValueError("Invalid value for `modified`, must not be `None`")
self._modified = modified
@property
def next_id(self):
"""
Gets the next_id of this PreviousServicePackage.
Next service package ID if this service package has a pending renewal or null.
:return: The next_id of this PreviousServicePackage.
:rtype: str
"""
return self._next_id
@next_id.setter
def next_id(self, next_id):
"""
Sets the next_id of this PreviousServicePackage.
Next service package ID if this service package has a pending renewal or null.
:param next_id: The next_id of this PreviousServicePackage.
:type: str
"""
self._next_id = next_id
@property
def previous_id(self):
"""
Gets the previous_id of this PreviousServicePackage.
Previous service package ID.
:return: The previous_id of this PreviousServicePackage.
:rtype: str
"""
return self._previous_id
@previous_id.setter
def previous_id(self, previous_id):
"""
Sets the previous_id of this PreviousServicePackage.
Previous service package ID.
:param previous_id: The previous_id of this PreviousServicePackage.
:type: str
"""
self._previous_id = previous_id
@property
def reason(self):
"""
Gets the reason of this PreviousServicePackage.
Reason why this service package was ended
:return: The reason of this PreviousServicePackage.
:rtype: str
"""
return self._reason
@reason.setter
def reason(self, reason):
"""
Sets the reason of this PreviousServicePackage.
Reason why this service package was ended
:param reason: The reason of this PreviousServicePackage.
:type: str
"""
if reason is None:
raise ValueError("Invalid value for `reason`, must not be `None`")
allowed_values = ["renewed", "terminated"]
if reason not in allowed_values:
raise ValueError(
"Invalid value for `reason` ({0}), must be one of {1}"
.format(reason, allowed_values)
)
self._reason = reason
@property
def start_time(self):
"""
Gets the start_time of this PreviousServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The start_time of this PreviousServicePackage.
:rtype: datetime
"""
return self._start_time
@start_time.setter
def start_time(self, start_time):
"""
Sets the start_time of this PreviousServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param start_time: The start_time of this PreviousServicePackage.
:type: datetime
"""
if start_time is None:
raise ValueError("Invalid value for `start_time`, must not be `None`")
self._start_time = start_time
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, PreviousServicePackage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class PreviousServicePackage(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created=None, end_time=None, expires=None, firmware_update_count=None, id=None, modified=None, next_id=None, previous_id=None, reason=None, start_time=None):
'''
PreviousServicePackage - a model defined in Swagger
'''
pass
@property
def created(self):
'''
Gets the created of this PreviousServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The created of this PreviousServicePackage.
:rtype: datetime
'''
pass
@created.setter
def created(self):
'''
Sets the created of this PreviousServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param created: The created of this PreviousServicePackage.
:type: datetime
'''
pass
@property
def end_time(self):
'''
Gets the end_time of this PreviousServicePackage.
Service package end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The end_time of this PreviousServicePackage.
:rtype: datetime
'''
pass
@end_time.setter
def end_time(self):
'''
Sets the end_time of this PreviousServicePackage.
Service package end time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param end_time: The end_time of this PreviousServicePackage.
:type: datetime
'''
pass
@property
def expires(self):
'''
Gets the expires of this PreviousServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The expires of this PreviousServicePackage.
:rtype: datetime
'''
pass
@expires.setter
def expires(self):
'''
Sets the expires of this PreviousServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param expires: The expires of this PreviousServicePackage.
:type: datetime
'''
pass
@property
def firmware_update_count(self):
'''
Gets the firmware_update_count of this PreviousServicePackage.
Size of firmware update quota of this service package.
:return: The firmware_update_count of this PreviousServicePackage.
:rtype: int
'''
pass
@firmware_update_count.setter
def firmware_update_count(self):
'''
Sets the firmware_update_count of this PreviousServicePackage.
Size of firmware update quota of this service package.
:param firmware_update_count: The firmware_update_count of this PreviousServicePackage.
:type: int
'''
pass
@property
def id(self):
'''
Gets the id of this PreviousServicePackage.
ID of this service package.
:return: The id of this PreviousServicePackage.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this PreviousServicePackage.
ID of this service package.
:param id: The id of this PreviousServicePackage.
:type: str
'''
pass
@property
def modified(self):
'''
Gets the modified of this PreviousServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The modified of this PreviousServicePackage.
:rtype: datetime
'''
pass
@modified.setter
def modified(self):
'''
Sets the modified of this PreviousServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param modified: The modified of this PreviousServicePackage.
:type: datetime
'''
pass
@property
def next_id(self):
'''
Gets the next_id of this PreviousServicePackage.
Next service package ID if this service package has a pending renewal or null.
:return: The next_id of this PreviousServicePackage.
:rtype: str
'''
pass
@next_id.setter
def next_id(self):
'''
Sets the next_id of this PreviousServicePackage.
Next service package ID if this service package has a pending renewal or null.
:param next_id: The next_id of this PreviousServicePackage.
:type: str
'''
pass
@property
def previous_id(self):
'''
Gets the previous_id of this PreviousServicePackage.
Previous service package ID.
:return: The previous_id of this PreviousServicePackage.
:rtype: str
'''
pass
@previous_id.setter
def previous_id(self):
'''
Sets the previous_id of this PreviousServicePackage.
Previous service package ID.
:param previous_id: The previous_id of this PreviousServicePackage.
:type: str
'''
pass
@property
def reason(self):
'''
Gets the reason of this PreviousServicePackage.
Reason why this service package was ended
:return: The reason of this PreviousServicePackage.
:rtype: str
'''
pass
@reason.setter
def reason(self):
'''
Sets the reason of this PreviousServicePackage.
Reason why this service package was ended
:param reason: The reason of this PreviousServicePackage.
:type: str
'''
pass
@property
def start_time(self):
'''
Gets the start_time of this PreviousServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The start_time of this PreviousServicePackage.
:rtype: datetime
'''
pass
@start_time.setter
def start_time(self):
'''
Sets the start_time of this PreviousServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param start_time: The start_time of this PreviousServicePackage.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 47 | 27 | 11 | 1 | 4 | 5 | 2 | 1 | 1 | 4 | 0 | 0 | 26 | 11 | 26 | 26 | 361 | 63 | 149 | 64 | 102 | 149 | 94 | 44 | 67 | 5 | 1 | 2 | 40 |
2,456 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/pending_service_package.py
|
mbed_cloud._backends.billing.models.pending_service_package.PendingServicePackage
|
class PendingServicePackage(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 = {
'created': 'datetime',
'expires': 'datetime',
'firmware_update_count': 'int',
'id': 'str',
'modified': 'datetime',
'previous_id': 'str',
'start_time': 'datetime'
}
attribute_map = {
'created': 'created',
'expires': 'expires',
'firmware_update_count': 'firmware_update_count',
'id': 'id',
'modified': 'modified',
'previous_id': 'previous_id',
'start_time': 'start_time'
}
def __init__(self, created=None, expires=None, firmware_update_count=None, id=None, modified=None, previous_id=None, start_time=None):
"""
PendingServicePackage - a model defined in Swagger
"""
self._created = created
self._expires = expires
self._firmware_update_count = firmware_update_count
self._id = id
self._modified = modified
self._previous_id = previous_id
self._start_time = start_time
self.discriminator = None
@property
def created(self):
"""
Gets the created of this PendingServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The created of this PendingServicePackage.
:rtype: datetime
"""
return self._created
@created.setter
def created(self, created):
"""
Sets the created of this PendingServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param created: The created of this PendingServicePackage.
:type: datetime
"""
if created is None:
raise ValueError("Invalid value for `created`, must not be `None`")
self._created = created
@property
def expires(self):
"""
Gets the expires of this PendingServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The expires of this PendingServicePackage.
:rtype: datetime
"""
return self._expires
@expires.setter
def expires(self, expires):
"""
Sets the expires of this PendingServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param expires: The expires of this PendingServicePackage.
:type: datetime
"""
if expires is None:
raise ValueError("Invalid value for `expires`, must not be `None`")
self._expires = expires
@property
def firmware_update_count(self):
"""
Gets the firmware_update_count of this PendingServicePackage.
Size of firmware update quota of this service package.
:return: The firmware_update_count of this PendingServicePackage.
:rtype: int
"""
return self._firmware_update_count
@firmware_update_count.setter
def firmware_update_count(self, firmware_update_count):
"""
Sets the firmware_update_count of this PendingServicePackage.
Size of firmware update quota of this service package.
:param firmware_update_count: The firmware_update_count of this PendingServicePackage.
:type: int
"""
if firmware_update_count is None:
raise ValueError("Invalid value for `firmware_update_count`, must not be `None`")
self._firmware_update_count = firmware_update_count
@property
def id(self):
"""
Gets the id of this PendingServicePackage.
ID of this service package.
:return: The id of this PendingServicePackage.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this PendingServicePackage.
ID of this service package.
:param id: The id of this PendingServicePackage.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def modified(self):
"""
Gets the modified of this PendingServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The modified of this PendingServicePackage.
:rtype: datetime
"""
return self._modified
@modified.setter
def modified(self, modified):
"""
Sets the modified of this PendingServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param modified: The modified of this PendingServicePackage.
:type: datetime
"""
if modified is None:
raise ValueError("Invalid value for `modified`, must not be `None`")
self._modified = modified
@property
def previous_id(self):
"""
Gets the previous_id of this PendingServicePackage.
Previous service package ID.
:return: The previous_id of this PendingServicePackage.
:rtype: str
"""
return self._previous_id
@previous_id.setter
def previous_id(self, previous_id):
"""
Sets the previous_id of this PendingServicePackage.
Previous service package ID.
:param previous_id: The previous_id of this PendingServicePackage.
:type: str
"""
if previous_id is None:
raise ValueError("Invalid value for `previous_id`, must not be `None`")
self._previous_id = previous_id
@property
def start_time(self):
"""
Gets the start_time of this PendingServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The start_time of this PendingServicePackage.
:rtype: datetime
"""
return self._start_time
@start_time.setter
def start_time(self, start_time):
"""
Sets the start_time of this PendingServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param start_time: The start_time of this PendingServicePackage.
:type: datetime
"""
if start_time is None:
raise ValueError("Invalid value for `start_time`, must not be `None`")
self._start_time = start_time
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, PendingServicePackage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class PendingServicePackage(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created=None, expires=None, firmware_update_count=None, id=None, modified=None, previous_id=None, start_time=None):
'''
PendingServicePackage - a model defined in Swagger
'''
pass
@property
def created(self):
'''
Gets the created of this PendingServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The created of this PendingServicePackage.
:rtype: datetime
'''
pass
@created.setter
def created(self):
'''
Sets the created of this PendingServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param created: The created of this PendingServicePackage.
:type: datetime
'''
pass
@property
def expires(self):
'''
Gets the expires of this PendingServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The expires of this PendingServicePackage.
:rtype: datetime
'''
pass
@expires.setter
def expires(self):
'''
Sets the expires of this PendingServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param expires: The expires of this PendingServicePackage.
:type: datetime
'''
pass
@property
def firmware_update_count(self):
'''
Gets the firmware_update_count of this PendingServicePackage.
Size of firmware update quota of this service package.
:return: The firmware_update_count of this PendingServicePackage.
:rtype: int
'''
pass
@firmware_update_count.setter
def firmware_update_count(self):
'''
Sets the firmware_update_count of this PendingServicePackage.
Size of firmware update quota of this service package.
:param firmware_update_count: The firmware_update_count of this PendingServicePackage.
:type: int
'''
pass
@property
def id(self):
'''
Gets the id of this PendingServicePackage.
ID of this service package.
:return: The id of this PendingServicePackage.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this PendingServicePackage.
ID of this service package.
:param id: The id of this PendingServicePackage.
:type: str
'''
pass
@property
def modified(self):
'''
Gets the modified of this PendingServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The modified of this PendingServicePackage.
:rtype: datetime
'''
pass
@modified.setter
def modified(self):
'''
Sets the modified of this PendingServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param modified: The modified of this PendingServicePackage.
:type: datetime
'''
pass
@property
def previous_id(self):
'''
Gets the previous_id of this PendingServicePackage.
Previous service package ID.
:return: The previous_id of this PendingServicePackage.
:rtype: str
'''
pass
@previous_id.setter
def previous_id(self):
'''
Sets the previous_id of this PendingServicePackage.
Previous service package ID.
:param previous_id: The previous_id of this PendingServicePackage.
:type: str
'''
pass
@property
def start_time(self):
'''
Gets the start_time of this PendingServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The start_time of this PendingServicePackage.
:rtype: datetime
'''
pass
@start_time.setter
def start_time(self):
'''
Sets the start_time of this PendingServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param start_time: The start_time of this PendingServicePackage.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 35 | 21 | 10 | 1 | 4 | 5 | 2 | 0.99 | 1 | 4 | 0 | 0 | 20 | 8 | 20 | 20 | 275 | 48 | 114 | 48 | 79 | 113 | 74 | 34 | 53 | 5 | 1 | 2 | 32 |
2,457 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/internal_server_error_response.py
|
mbed_cloud._backends.billing.models.internal_server_error_response.InternalServerErrorResponse
|
class InternalServerErrorResponse(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'code': 'int',
'message': 'str',
'object': 'str',
'request_id': 'str',
'type': 'str'
}
attribute_map = {
'code': 'code',
'message': 'message',
'object': 'object',
'request_id': 'request_id',
'type': 'type'
}
def __init__(self, code=None, message=None, object=None, request_id=None, type=None):
"""
InternalServerErrorResponse - a model defined in Swagger
"""
self._code = code
self._message = message
self._object = object
self._request_id = request_id
self._type = type
self.discriminator = None
@property
def code(self):
"""
Gets the code of this InternalServerErrorResponse.
Response code. Always set to 500.
:return: The code of this InternalServerErrorResponse.
:rtype: int
"""
return self._code
@code.setter
def code(self, code):
"""
Sets the code of this InternalServerErrorResponse.
Response code. Always set to 500.
:param code: The code of this InternalServerErrorResponse.
:type: int
"""
if code is None:
raise ValueError("Invalid value for `code`, must not be `None`")
self._code = code
@property
def message(self):
"""
Gets the message of this InternalServerErrorResponse.
A human readable message with detailed info.
:return: The message of this InternalServerErrorResponse.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this InternalServerErrorResponse.
A human readable message with detailed info.
:param message: The message of this InternalServerErrorResponse.
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`")
self._message = message
@property
def object(self):
"""
Gets the object of this InternalServerErrorResponse.
Always set to 'error'.
:return: The object of this InternalServerErrorResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this InternalServerErrorResponse.
Always set to 'error'.
:param object: The object of this InternalServerErrorResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["error"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def request_id(self):
"""
Gets the request_id of this InternalServerErrorResponse.
Request ID
:return: The request_id of this InternalServerErrorResponse.
:rtype: str
"""
return self._request_id
@request_id.setter
def request_id(self, request_id):
"""
Sets the request_id of this InternalServerErrorResponse.
Request ID
:param request_id: The request_id of this InternalServerErrorResponse.
:type: str
"""
if request_id is None:
raise ValueError("Invalid value for `request_id`, must not be `None`")
self._request_id = request_id
@property
def type(self):
"""
Gets the type of this InternalServerErrorResponse.
Error type. Always set to 'internal_error'.
:return: The type of this InternalServerErrorResponse.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this InternalServerErrorResponse.
Error type. Always set to 'internal_error'.
:param type: The type of this InternalServerErrorResponse.
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`")
allowed_values = ["internal_error"]
if type not in allowed_values:
raise ValueError(
"Invalid value for `type` ({0}), must be one of {1}"
.format(type, allowed_values)
)
self._type = type
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, InternalServerErrorResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class InternalServerErrorResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, code=None, message=None, object=None, request_id=None, type=None):
'''
InternalServerErrorResponse - a model defined in Swagger
'''
pass
@property
def code(self):
'''
Gets the code of this InternalServerErrorResponse.
Response code. Always set to 500.
:return: The code of this InternalServerErrorResponse.
:rtype: int
'''
pass
@code.setter
def code(self):
'''
Sets the code of this InternalServerErrorResponse.
Response code. Always set to 500.
:param code: The code of this InternalServerErrorResponse.
:type: int
'''
pass
@property
def message(self):
'''
Gets the message of this InternalServerErrorResponse.
A human readable message with detailed info.
:return: The message of this InternalServerErrorResponse.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this InternalServerErrorResponse.
A human readable message with detailed info.
:param message: The message of this InternalServerErrorResponse.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this InternalServerErrorResponse.
Always set to 'error'.
:return: The object of this InternalServerErrorResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this InternalServerErrorResponse.
Always set to 'error'.
:param object: The object of this InternalServerErrorResponse.
:type: str
'''
pass
@property
def request_id(self):
'''
Gets the request_id of this InternalServerErrorResponse.
Request ID
:return: The request_id of this InternalServerErrorResponse.
:rtype: str
'''
pass
@request_id.setter
def request_id(self):
'''
Sets the request_id of this InternalServerErrorResponse.
Request ID
:param request_id: The request_id of this InternalServerErrorResponse.
:type: str
'''
pass
@property
def type(self):
'''
Gets the type of this InternalServerErrorResponse.
Error type. Always set to 'internal_error'.
:return: The type of this InternalServerErrorResponse.
:rtype: str
'''
pass
@type.setter
def type(self):
'''
Sets the type of this InternalServerErrorResponse.
Error type. Always set to 'internal_error'.
:param type: The type of this InternalServerErrorResponse.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 27 | 17 | 11 | 1 | 5 | 5 | 2 | 0.86 | 1 | 4 | 0 | 0 | 16 | 6 | 16 | 16 | 231 | 38 | 104 | 40 | 77 | 89 | 66 | 30 | 49 | 5 | 1 | 2 | 28 |
2,458 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/forbidden_error_response.py
|
mbed_cloud._backends.billing.models.forbidden_error_response.ForbiddenErrorResponse
|
class ForbiddenErrorResponse(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'code': 'int',
'message': 'str',
'object': 'str',
'request_id': 'str',
'type': 'str'
}
attribute_map = {
'code': 'code',
'message': 'message',
'object': 'object',
'request_id': 'request_id',
'type': 'type'
}
def __init__(self, code=None, message=None, object=None, request_id=None, type=None):
"""
ForbiddenErrorResponse - a model defined in Swagger
"""
self._code = code
self._message = message
self._object = object
self._request_id = request_id
self._type = type
self.discriminator = None
@property
def code(self):
"""
Gets the code of this ForbiddenErrorResponse.
Response code. Always set to 403.
:return: The code of this ForbiddenErrorResponse.
:rtype: int
"""
return self._code
@code.setter
def code(self, code):
"""
Sets the code of this ForbiddenErrorResponse.
Response code. Always set to 403.
:param code: The code of this ForbiddenErrorResponse.
:type: int
"""
if code is None:
raise ValueError("Invalid value for `code`, must not be `None`")
self._code = code
@property
def message(self):
"""
Gets the message of this ForbiddenErrorResponse.
A human readable message with detailed info.
:return: The message of this ForbiddenErrorResponse.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this ForbiddenErrorResponse.
A human readable message with detailed info.
:param message: The message of this ForbiddenErrorResponse.
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`")
self._message = message
@property
def object(self):
"""
Gets the object of this ForbiddenErrorResponse.
Always set to 'error'.
:return: The object of this ForbiddenErrorResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ForbiddenErrorResponse.
Always set to 'error'.
:param object: The object of this ForbiddenErrorResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["error"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def request_id(self):
"""
Gets the request_id of this ForbiddenErrorResponse.
Request ID
:return: The request_id of this ForbiddenErrorResponse.
:rtype: str
"""
return self._request_id
@request_id.setter
def request_id(self, request_id):
"""
Sets the request_id of this ForbiddenErrorResponse.
Request ID
:param request_id: The request_id of this ForbiddenErrorResponse.
:type: str
"""
if request_id is None:
raise ValueError("Invalid value for `request_id`, must not be `None`")
self._request_id = request_id
@property
def type(self):
"""
Gets the type of this ForbiddenErrorResponse.
Error type. Always set to 'forbidden'.
:return: The type of this ForbiddenErrorResponse.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this ForbiddenErrorResponse.
Error type. Always set to 'forbidden'.
:param type: The type of this ForbiddenErrorResponse.
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`")
allowed_values = ["forbidden"]
if type not in allowed_values:
raise ValueError(
"Invalid value for `type` ({0}), must be one of {1}"
.format(type, allowed_values)
)
self._type = type
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ForbiddenErrorResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ForbiddenErrorResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, code=None, message=None, object=None, request_id=None, type=None):
'''
ForbiddenErrorResponse - a model defined in Swagger
'''
pass
@property
def code(self):
'''
Gets the code of this ForbiddenErrorResponse.
Response code. Always set to 403.
:return: The code of this ForbiddenErrorResponse.
:rtype: int
'''
pass
@code.setter
def code(self):
'''
Sets the code of this ForbiddenErrorResponse.
Response code. Always set to 403.
:param code: The code of this ForbiddenErrorResponse.
:type: int
'''
pass
@property
def message(self):
'''
Gets the message of this ForbiddenErrorResponse.
A human readable message with detailed info.
:return: The message of this ForbiddenErrorResponse.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this ForbiddenErrorResponse.
A human readable message with detailed info.
:param message: The message of this ForbiddenErrorResponse.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this ForbiddenErrorResponse.
Always set to 'error'.
:return: The object of this ForbiddenErrorResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ForbiddenErrorResponse.
Always set to 'error'.
:param object: The object of this ForbiddenErrorResponse.
:type: str
'''
pass
@property
def request_id(self):
'''
Gets the request_id of this ForbiddenErrorResponse.
Request ID
:return: The request_id of this ForbiddenErrorResponse.
:rtype: str
'''
pass
@request_id.setter
def request_id(self):
'''
Sets the request_id of this ForbiddenErrorResponse.
Request ID
:param request_id: The request_id of this ForbiddenErrorResponse.
:type: str
'''
pass
@property
def type(self):
'''
Gets the type of this ForbiddenErrorResponse.
Error type. Always set to 'forbidden'.
:return: The type of this ForbiddenErrorResponse.
:rtype: str
'''
pass
@type.setter
def type(self):
'''
Sets the type of this ForbiddenErrorResponse.
Error type. Always set to 'forbidden'.
:param type: The type of this ForbiddenErrorResponse.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 27 | 17 | 11 | 1 | 5 | 5 | 2 | 0.86 | 1 | 4 | 0 | 0 | 16 | 6 | 16 | 16 | 231 | 38 | 104 | 40 | 77 | 89 | 66 | 30 | 49 | 5 | 1 | 2 | 28 |
2,459 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/billing_report_raw_data_response.py
|
mbed_cloud._backends.billing.models.billing_report_raw_data_response.BillingReportRawDataResponse
|
class BillingReportRawDataResponse(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 = {
'filename': 'str',
'object': 'str',
'url': 'str'
}
attribute_map = {
'filename': 'filename',
'object': 'object',
'url': 'url'
}
def __init__(self, filename=None, object=None, url=None):
"""
BillingReportRawDataResponse - a model defined in Swagger
"""
self._filename = filename
self._object = object
self._url = url
self.discriminator = None
@property
def filename(self):
"""
Gets the filename of this BillingReportRawDataResponse.
The filename of the raw billing data file to be downloaded. It contains the file extensions.
:return: The filename of this BillingReportRawDataResponse.
:rtype: str
"""
return self._filename
@filename.setter
def filename(self, filename):
"""
Sets the filename of this BillingReportRawDataResponse.
The filename of the raw billing data file to be downloaded. It contains the file extensions.
:param filename: The filename of this BillingReportRawDataResponse.
:type: str
"""
if filename is None:
raise ValueError("Invalid value for `filename`, must not be `None`")
self._filename = filename
@property
def object(self):
"""
Gets the object of this BillingReportRawDataResponse.
API Resource name.
:return: The object of this BillingReportRawDataResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this BillingReportRawDataResponse.
API Resource name.
:param object: The object of this BillingReportRawDataResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
self._object = object
@property
def url(self):
"""
Gets the url of this BillingReportRawDataResponse.
The URL to download the raw billing data.
:return: The url of this BillingReportRawDataResponse.
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""
Sets the url of this BillingReportRawDataResponse.
The URL to download the raw billing data.
:param url: The url of this BillingReportRawDataResponse.
:type: str
"""
if url is None:
raise ValueError("Invalid value for `url`, must not be `None`")
self._url = url
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, BillingReportRawDataResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class BillingReportRawDataResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, filename=None, object=None, url=None):
'''
BillingReportRawDataResponse - a model defined in Swagger
'''
pass
@property
def filename(self):
'''
Gets the filename of this BillingReportRawDataResponse.
The filename of the raw billing data file to be downloaded. It contains the file extensions.
:return: The filename of this BillingReportRawDataResponse.
:rtype: str
'''
pass
@filename.setter
def filename(self):
'''
Sets the filename of this BillingReportRawDataResponse.
The filename of the raw billing data file to be downloaded. It contains the file extensions.
:param filename: The filename of this BillingReportRawDataResponse.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this BillingReportRawDataResponse.
API Resource name.
:return: The object of this BillingReportRawDataResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this BillingReportRawDataResponse.
API Resource name.
:param object: The object of this BillingReportRawDataResponse.
:type: str
'''
pass
@property
def url(self):
'''
Gets the url of this BillingReportRawDataResponse.
The URL to download the raw billing data.
:return: The url of this BillingReportRawDataResponse.
:rtype: str
'''
pass
@url.setter
def url(self):
'''
Sets the url of this BillingReportRawDataResponse.
The URL to download the raw billing data.
:param url: The url of this BillingReportRawDataResponse.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 19 | 13 | 10 | 1 | 4 | 5 | 2 | 0.93 | 1 | 4 | 0 | 0 | 12 | 4 | 12 | 12 | 163 | 28 | 70 | 28 | 51 | 65 | 46 | 22 | 33 | 5 | 1 | 2 | 20 |
2,460 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/bad_request_error_response_field.py
|
mbed_cloud._backends.billing.models.bad_request_error_response_field.BadRequestErrorResponseField
|
class BadRequestErrorResponseField(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': 'str',
'name': 'str'
}
attribute_map = {
'message': 'message',
'name': 'name'
}
def __init__(self, message=None, name=None):
"""
BadRequestErrorResponseField - a model defined in Swagger
"""
self._message = message
self._name = name
self.discriminator = None
@property
def message(self):
"""
Gets the message of this BadRequestErrorResponseField.
A human readable message with detailed validation error.
:return: The message of this BadRequestErrorResponseField.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this BadRequestErrorResponseField.
A human readable message with detailed validation error.
:param message: The message of this BadRequestErrorResponseField.
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`")
self._message = message
@property
def name(self):
"""
Gets the name of this BadRequestErrorResponseField.
Name of the field that failed the validation. If name is set to \"body\" then the validation failed on request body.
:return: The name of this BadRequestErrorResponseField.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this BadRequestErrorResponseField.
Name of the field that failed the validation. If name is set to \"body\" then the validation failed on request body.
:param name: The name of this BadRequestErrorResponseField.
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`")
self._name = name
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, BadRequestErrorResponseField):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class BadRequestErrorResponseField(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, message=None, name=None):
'''
BadRequestErrorResponseField - a model defined in Swagger
'''
pass
@property
def message(self):
'''
Gets the message of this BadRequestErrorResponseField.
A human readable message with detailed validation error.
:return: The message of this BadRequestErrorResponseField.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this BadRequestErrorResponseField.
A human readable message with detailed validation error.
:param message: The message of this BadRequestErrorResponseField.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this BadRequestErrorResponseField.
Name of the field that failed the validation. If name is set to "body" then the validation failed on request body.
:return: The name of this BadRequestErrorResponseField.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this BadRequestErrorResponseField.
Name of the field that failed the validation. If name is set to "body" then the validation failed on request body.
:param name: The name of this BadRequestErrorResponseField.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 10 | 1 | 5 | 4 | 2 | 0.9 | 1 | 4 | 0 | 0 | 10 | 3 | 10 | 10 | 135 | 23 | 59 | 23 | 44 | 53 | 39 | 19 | 28 | 5 | 1 | 2 | 17 |
2,461 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/bad_request_error_response.py
|
mbed_cloud._backends.billing.models.bad_request_error_response.BadRequestErrorResponse
|
class BadRequestErrorResponse(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'code': 'int',
'fields': 'list[BadRequestErrorResponseField]',
'message': 'str',
'object': 'str',
'request_id': 'str',
'type': 'str'
}
attribute_map = {
'code': 'code',
'fields': 'fields',
'message': 'message',
'object': 'object',
'request_id': 'request_id',
'type': 'type'
}
def __init__(self, code=None, fields=None, message=None, object=None, request_id=None, type=None):
"""
BadRequestErrorResponse - a model defined in Swagger
"""
self._code = code
self._fields = fields
self._message = message
self._object = object
self._request_id = request_id
self._type = type
self.discriminator = None
@property
def code(self):
"""
Gets the code of this BadRequestErrorResponse.
Response code. Always set to 400.
:return: The code of this BadRequestErrorResponse.
:rtype: int
"""
return self._code
@code.setter
def code(self, code):
"""
Sets the code of this BadRequestErrorResponse.
Response code. Always set to 400.
:param code: The code of this BadRequestErrorResponse.
:type: int
"""
if code is None:
raise ValueError("Invalid value for `code`, must not be `None`")
self._code = code
@property
def fields(self):
"""
Gets the fields of this BadRequestErrorResponse.
:return: The fields of this BadRequestErrorResponse.
:rtype: list[BadRequestErrorResponseField]
"""
return self._fields
@fields.setter
def fields(self, fields):
"""
Sets the fields of this BadRequestErrorResponse.
:param fields: The fields of this BadRequestErrorResponse.
:type: list[BadRequestErrorResponseField]
"""
if fields is None:
raise ValueError("Invalid value for `fields`, must not be `None`")
self._fields = fields
@property
def message(self):
"""
Gets the message of this BadRequestErrorResponse.
A human readable message with detailed info.
:return: The message of this BadRequestErrorResponse.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this BadRequestErrorResponse.
A human readable message with detailed info.
:param message: The message of this BadRequestErrorResponse.
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`")
self._message = message
@property
def object(self):
"""
Gets the object of this BadRequestErrorResponse.
Always set to 'error'.
:return: The object of this BadRequestErrorResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this BadRequestErrorResponse.
Always set to 'error'.
:param object: The object of this BadRequestErrorResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["error"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def request_id(self):
"""
Gets the request_id of this BadRequestErrorResponse.
Request ID
:return: The request_id of this BadRequestErrorResponse.
:rtype: str
"""
return self._request_id
@request_id.setter
def request_id(self, request_id):
"""
Sets the request_id of this BadRequestErrorResponse.
Request ID
:param request_id: The request_id of this BadRequestErrorResponse.
:type: str
"""
if request_id is None:
raise ValueError("Invalid value for `request_id`, must not be `None`")
self._request_id = request_id
@property
def type(self):
"""
Gets the type of this BadRequestErrorResponse.
Error type. Always set to 'validation_error'.
:return: The type of this BadRequestErrorResponse.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this BadRequestErrorResponse.
Error type. Always set to 'validation_error'.
:param type: The type of this BadRequestErrorResponse.
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`")
allowed_values = ["validation_error"]
if type not in allowed_values:
raise ValueError(
"Invalid value for `type` ({0}), must be one of {1}"
.format(type, allowed_values)
)
self._type = type
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, BadRequestErrorResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class BadRequestErrorResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, code=None, fields=None, message=None, object=None, request_id=None, type=None):
'''
BadRequestErrorResponse - a model defined in Swagger
'''
pass
@property
def code(self):
'''
Gets the code of this BadRequestErrorResponse.
Response code. Always set to 400.
:return: The code of this BadRequestErrorResponse.
:rtype: int
'''
pass
@code.setter
def code(self):
'''
Sets the code of this BadRequestErrorResponse.
Response code. Always set to 400.
:param code: The code of this BadRequestErrorResponse.
:type: int
'''
pass
@property
def fields(self):
'''
Gets the fields of this BadRequestErrorResponse.
:return: The fields of this BadRequestErrorResponse.
:rtype: list[BadRequestErrorResponseField]
'''
pass
@fields.setter
def fields(self):
'''
Sets the fields of this BadRequestErrorResponse.
:param fields: The fields of this BadRequestErrorResponse.
:type: list[BadRequestErrorResponseField]
'''
pass
@property
def message(self):
'''
Gets the message of this BadRequestErrorResponse.
A human readable message with detailed info.
:return: The message of this BadRequestErrorResponse.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this BadRequestErrorResponse.
A human readable message with detailed info.
:param message: The message of this BadRequestErrorResponse.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this BadRequestErrorResponse.
Always set to 'error'.
:return: The object of this BadRequestErrorResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this BadRequestErrorResponse.
Always set to 'error'.
:param object: The object of this BadRequestErrorResponse.
:type: str
'''
pass
@property
def request_id(self):
'''
Gets the request_id of this BadRequestErrorResponse.
Request ID
:return: The request_id of this BadRequestErrorResponse.
:rtype: str
'''
pass
@request_id.setter
def request_id(self):
'''
Sets the request_id of this BadRequestErrorResponse.
Request ID
:param request_id: The request_id of this BadRequestErrorResponse.
:type: str
'''
pass
@property
def type(self):
'''
Gets the type of this BadRequestErrorResponse.
Error type. Always set to 'validation_error'.
:return: The type of this BadRequestErrorResponse.
:rtype: str
'''
pass
@type.setter
def type(self):
'''
Sets the type of this BadRequestErrorResponse.
Error type. Always set to 'validation_error'.
:param type: The type of this BadRequestErrorResponse.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 11 | 1 | 5 | 5 | 2 | 0.86 | 1 | 4 | 0 | 0 | 18 | 7 | 18 | 18 | 257 | 43 | 115 | 45 | 84 | 99 | 73 | 33 | 54 | 5 | 1 | 2 | 31 |
2,462 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/aggregated_quota_usage_report.py
|
mbed_cloud._backends.billing.models.aggregated_quota_usage_report.AggregatedQuotaUsageReport
|
class AggregatedQuotaUsageReport(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 = {
'account_id': 'str',
'amount': 'int',
'campaign_name': 'str',
'time': 'datetime',
'type': 'str'
}
attribute_map = {
'account_id': 'account_id',
'amount': 'amount',
'campaign_name': 'campaign_name',
'time': 'time',
'type': 'type'
}
def __init__(self, account_id=None, amount=None, campaign_name=None, time=None, type=None):
"""
AggregatedQuotaUsageReport - a model defined in Swagger
"""
self._account_id = account_id
self._amount = amount
self._campaign_name = campaign_name
self._time = time
self._type = type
self.discriminator = None
@property
def account_id(self):
"""
Gets the account_id of this AggregatedQuotaUsageReport.
:return: The account_id of this AggregatedQuotaUsageReport.
:rtype: str
"""
return self._account_id
@account_id.setter
def account_id(self, account_id):
"""
Sets the account_id of this AggregatedQuotaUsageReport.
:param account_id: The account_id of this AggregatedQuotaUsageReport.
:type: str
"""
if account_id is None:
raise ValueError("Invalid value for `account_id`, must not be `None`")
self._account_id = account_id
@property
def amount(self):
"""
Gets the amount of this AggregatedQuotaUsageReport.
Amount of quota usage entry. Negative if it is quota consumption.
:return: The amount of this AggregatedQuotaUsageReport.
:rtype: int
"""
return self._amount
@amount.setter
def amount(self, amount):
"""
Sets the amount of this AggregatedQuotaUsageReport.
Amount of quota usage entry. Negative if it is quota consumption.
:param amount: The amount of this AggregatedQuotaUsageReport.
:type: int
"""
if amount is None:
raise ValueError("Invalid value for `amount`, must not be `None`")
self._amount = amount
@property
def campaign_name(self):
"""
Gets the campaign_name of this AggregatedQuotaUsageReport.
Campaign name of quota usage entry. Null if quota usage entry type is not reservation or reservation release.
:return: The campaign_name of this AggregatedQuotaUsageReport.
:rtype: str
"""
return self._campaign_name
@campaign_name.setter
def campaign_name(self, campaign_name):
"""
Sets the campaign_name of this AggregatedQuotaUsageReport.
Campaign name of quota usage entry. Null if quota usage entry type is not reservation or reservation release.
:param campaign_name: The campaign_name of this AggregatedQuotaUsageReport.
:type: str
"""
self._campaign_name = campaign_name
@property
def time(self):
"""
Gets the time of this AggregatedQuotaUsageReport.
Added time of quota usage entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The time of this AggregatedQuotaUsageReport.
:rtype: datetime
"""
return self._time
@time.setter
def time(self, time):
"""
Sets the time of this AggregatedQuotaUsageReport.
Added time of quota usage entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param time: The time of this AggregatedQuotaUsageReport.
:type: datetime
"""
if time is None:
raise ValueError("Invalid value for `time`, must not be `None`")
self._time = time
@property
def type(self):
"""
Gets the type of this AggregatedQuotaUsageReport.
Type of quota usage entry.
:return: The type of this AggregatedQuotaUsageReport.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this AggregatedQuotaUsageReport.
Type of quota usage entry.
:param type: The type of this AggregatedQuotaUsageReport.
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`")
allowed_values = ["reservation", "reservation_release", "reservation_termination", "package_renewal", "package_creation", "package_termination"]
if type not in allowed_values:
raise ValueError(
"Invalid value for `type` ({0}), must be one of {1}"
.format(type, allowed_values)
)
self._type = type
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, AggregatedQuotaUsageReport):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class AggregatedQuotaUsageReport(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, account_id=None, amount=None, campaign_name=None, time=None, type=None):
'''
AggregatedQuotaUsageReport - a model defined in Swagger
'''
pass
@property
def account_id(self):
'''
Gets the account_id of this AggregatedQuotaUsageReport.
:return: The account_id of this AggregatedQuotaUsageReport.
:rtype: str
'''
pass
@account_id.setter
def account_id(self):
'''
Sets the account_id of this AggregatedQuotaUsageReport.
:param account_id: The account_id of this AggregatedQuotaUsageReport.
:type: str
'''
pass
@property
def amount(self):
'''
Gets the amount of this AggregatedQuotaUsageReport.
Amount of quota usage entry. Negative if it is quota consumption.
:return: The amount of this AggregatedQuotaUsageReport.
:rtype: int
'''
pass
@amount.setter
def amount(self):
'''
Sets the amount of this AggregatedQuotaUsageReport.
Amount of quota usage entry. Negative if it is quota consumption.
:param amount: The amount of this AggregatedQuotaUsageReport.
:type: int
'''
pass
@property
def campaign_name(self):
'''
Gets the campaign_name of this AggregatedQuotaUsageReport.
Campaign name of quota usage entry. Null if quota usage entry type is not reservation or reservation release.
:return: The campaign_name of this AggregatedQuotaUsageReport.
:rtype: str
'''
pass
@campaign_name.setter
def campaign_name(self):
'''
Sets the campaign_name of this AggregatedQuotaUsageReport.
Campaign name of quota usage entry. Null if quota usage entry type is not reservation or reservation release.
:param campaign_name: The campaign_name of this AggregatedQuotaUsageReport.
:type: str
'''
pass
@property
def time(self):
'''
Gets the time of this AggregatedQuotaUsageReport.
Added time of quota usage entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The time of this AggregatedQuotaUsageReport.
:rtype: datetime
'''
pass
@time.setter
def time(self):
'''
Sets the time of this AggregatedQuotaUsageReport.
Added time of quota usage entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param time: The time of this AggregatedQuotaUsageReport.
:type: datetime
'''
pass
@property
def type(self):
'''
Gets the type of this AggregatedQuotaUsageReport.
Type of quota usage entry.
:return: The type of this AggregatedQuotaUsageReport.
:rtype: str
'''
pass
@type.setter
def type(self):
'''
Sets the type of this AggregatedQuotaUsageReport.
Type of quota usage entry.
:param type: The type of this AggregatedQuotaUsageReport.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 27 | 17 | 10 | 1 | 4 | 5 | 2 | 0.91 | 1 | 4 | 0 | 0 | 16 | 6 | 16 | 16 | 221 | 38 | 96 | 39 | 69 | 87 | 61 | 29 | 44 | 5 | 1 | 2 | 26 |
2,463 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/active_service_package.py
|
mbed_cloud._backends.billing.models.active_service_package.ActiveServicePackage
|
class ActiveServicePackage(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 = {
'created': 'datetime',
'expires': 'datetime',
'firmware_update_count': 'int',
'grace_period': 'bool',
'id': 'str',
'modified': 'datetime',
'next_id': 'str',
'previous_id': 'str',
'start_time': 'datetime'
}
attribute_map = {
'created': 'created',
'expires': 'expires',
'firmware_update_count': 'firmware_update_count',
'grace_period': 'grace_period',
'id': 'id',
'modified': 'modified',
'next_id': 'next_id',
'previous_id': 'previous_id',
'start_time': 'start_time'
}
def __init__(self, created=None, expires=None, firmware_update_count=None, grace_period=None, id=None, modified=None, next_id=None, previous_id=None, start_time=None):
"""
ActiveServicePackage - a model defined in Swagger
"""
self._created = created
self._expires = expires
self._firmware_update_count = firmware_update_count
self._grace_period = grace_period
self._id = id
self._modified = modified
self._next_id = next_id
self._previous_id = previous_id
self._start_time = start_time
self.discriminator = None
@property
def created(self):
"""
Gets the created of this ActiveServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The created of this ActiveServicePackage.
:rtype: datetime
"""
return self._created
@created.setter
def created(self, created):
"""
Sets the created of this ActiveServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param created: The created of this ActiveServicePackage.
:type: datetime
"""
if created is None:
raise ValueError("Invalid value for `created`, must not be `None`")
self._created = created
@property
def expires(self):
"""
Gets the expires of this ActiveServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The expires of this ActiveServicePackage.
:rtype: datetime
"""
return self._expires
@expires.setter
def expires(self, expires):
"""
Sets the expires of this ActiveServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param expires: The expires of this ActiveServicePackage.
:type: datetime
"""
if expires is None:
raise ValueError("Invalid value for `expires`, must not be `None`")
self._expires = expires
@property
def firmware_update_count(self):
"""
Gets the firmware_update_count of this ActiveServicePackage.
Size of firmware update quota of this service package.
:return: The firmware_update_count of this ActiveServicePackage.
:rtype: int
"""
return self._firmware_update_count
@firmware_update_count.setter
def firmware_update_count(self, firmware_update_count):
"""
Sets the firmware_update_count of this ActiveServicePackage.
Size of firmware update quota of this service package.
:param firmware_update_count: The firmware_update_count of this ActiveServicePackage.
:type: int
"""
if firmware_update_count is None:
raise ValueError("Invalid value for `firmware_update_count`, must not be `None`")
self._firmware_update_count = firmware_update_count
@property
def grace_period(self):
"""
Gets the grace_period of this ActiveServicePackage.
Is this service package on grace period or not?
:return: The grace_period of this ActiveServicePackage.
:rtype: bool
"""
return self._grace_period
@grace_period.setter
def grace_period(self, grace_period):
"""
Sets the grace_period of this ActiveServicePackage.
Is this service package on grace period or not?
:param grace_period: The grace_period of this ActiveServicePackage.
:type: bool
"""
if grace_period is None:
raise ValueError("Invalid value for `grace_period`, must not be `None`")
self._grace_period = grace_period
@property
def id(self):
"""
Gets the id of this ActiveServicePackage.
ID of this service package.
:return: The id of this ActiveServicePackage.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this ActiveServicePackage.
ID of this service package.
:param id: The id of this ActiveServicePackage.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def modified(self):
"""
Gets the modified of this ActiveServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The modified of this ActiveServicePackage.
:rtype: datetime
"""
return self._modified
@modified.setter
def modified(self, modified):
"""
Sets the modified of this ActiveServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param modified: The modified of this ActiveServicePackage.
:type: datetime
"""
if modified is None:
raise ValueError("Invalid value for `modified`, must not be `None`")
self._modified = modified
@property
def next_id(self):
"""
Gets the next_id of this ActiveServicePackage.
Next service package ID if this service package has a pending renewal or null.
:return: The next_id of this ActiveServicePackage.
:rtype: str
"""
return self._next_id
@next_id.setter
def next_id(self, next_id):
"""
Sets the next_id of this ActiveServicePackage.
Next service package ID if this service package has a pending renewal or null.
:param next_id: The next_id of this ActiveServicePackage.
:type: str
"""
self._next_id = next_id
@property
def previous_id(self):
"""
Gets the previous_id of this ActiveServicePackage.
Previous service package ID or null.
:return: The previous_id of this ActiveServicePackage.
:rtype: str
"""
return self._previous_id
@previous_id.setter
def previous_id(self, previous_id):
"""
Sets the previous_id of this ActiveServicePackage.
Previous service package ID or null.
:param previous_id: The previous_id of this ActiveServicePackage.
:type: str
"""
self._previous_id = previous_id
@property
def start_time(self):
"""
Gets the start_time of this ActiveServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The start_time of this ActiveServicePackage.
:rtype: datetime
"""
return self._start_time
@start_time.setter
def start_time(self, start_time):
"""
Sets the start_time of this ActiveServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param start_time: The start_time of this ActiveServicePackage.
:type: datetime
"""
if start_time is None:
raise ValueError("Invalid value for `start_time`, must not be `None`")
self._start_time = start_time
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ActiveServicePackage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ActiveServicePackage(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created=None, expires=None, firmware_update_count=None, grace_period=None, id=None, modified=None, next_id=None, previous_id=None, start_time=None):
'''
ActiveServicePackage - a model defined in Swagger
'''
pass
@property
def created(self):
'''
Gets the created of this ActiveServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The created of this ActiveServicePackage.
:rtype: datetime
'''
pass
@created.setter
def created(self):
'''
Sets the created of this ActiveServicePackage.
Service package creation time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param created: The created of this ActiveServicePackage.
:type: datetime
'''
pass
@property
def expires(self):
'''
Gets the expires of this ActiveServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The expires of this ActiveServicePackage.
:rtype: datetime
'''
pass
@expires.setter
def expires(self):
'''
Sets the expires of this ActiveServicePackage.
Service package expiration time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param expires: The expires of this ActiveServicePackage.
:type: datetime
'''
pass
@property
def firmware_update_count(self):
'''
Gets the firmware_update_count of this ActiveServicePackage.
Size of firmware update quota of this service package.
:return: The firmware_update_count of this ActiveServicePackage.
:rtype: int
'''
pass
@firmware_update_count.setter
def firmware_update_count(self):
'''
Sets the firmware_update_count of this ActiveServicePackage.
Size of firmware update quota of this service package.
:param firmware_update_count: The firmware_update_count of this ActiveServicePackage.
:type: int
'''
pass
@property
def grace_period(self):
'''
Gets the grace_period of this ActiveServicePackage.
Is this service package on grace period or not?
:return: The grace_period of this ActiveServicePackage.
:rtype: bool
'''
pass
@grace_period.setter
def grace_period(self):
'''
Sets the grace_period of this ActiveServicePackage.
Is this service package on grace period or not?
:param grace_period: The grace_period of this ActiveServicePackage.
:type: bool
'''
pass
@property
def id(self):
'''
Gets the id of this ActiveServicePackage.
ID of this service package.
:return: The id of this ActiveServicePackage.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this ActiveServicePackage.
ID of this service package.
:param id: The id of this ActiveServicePackage.
:type: str
'''
pass
@property
def modified(self):
'''
Gets the modified of this ActiveServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The modified of this ActiveServicePackage.
:rtype: datetime
'''
pass
@modified.setter
def modified(self):
'''
Sets the modified of this ActiveServicePackage.
Service package latest modified time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param modified: The modified of this ActiveServicePackage.
:type: datetime
'''
pass
@property
def next_id(self):
'''
Gets the next_id of this ActiveServicePackage.
Next service package ID if this service package has a pending renewal or null.
:return: The next_id of this ActiveServicePackage.
:rtype: str
'''
pass
@next_id.setter
def next_id(self):
'''
Sets the next_id of this ActiveServicePackage.
Next service package ID if this service package has a pending renewal or null.
:param next_id: The next_id of this ActiveServicePackage.
:type: str
'''
pass
@property
def previous_id(self):
'''
Gets the previous_id of this ActiveServicePackage.
Previous service package ID or null.
:return: The previous_id of this ActiveServicePackage.
:rtype: str
'''
pass
@previous_id.setter
def previous_id(self):
'''
Sets the previous_id of this ActiveServicePackage.
Previous service package ID or null.
:param previous_id: The previous_id of this ActiveServicePackage.
:type: str
'''
pass
@property
def start_time(self):
'''
Gets the start_time of this ActiveServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The start_time of this ActiveServicePackage.
:rtype: datetime
'''
pass
@start_time.setter
def start_time(self):
'''
Sets the start_time of this ActiveServicePackage.
Service package start time in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param start_time: The start_time of this ActiveServicePackage.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 43 | 25 | 10 | 1 | 4 | 5 | 2 | 1.04 | 1 | 4 | 0 | 0 | 24 | 10 | 24 | 24 | 327 | 58 | 132 | 58 | 89 | 137 | 84 | 40 | 59 | 5 | 1 | 2 | 36 |
2,464 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/configuration.py
|
mbed_cloud._backends.billing.configuration.Configuration
|
class Configuration(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
"""
def __init__(self):
"""Constructor"""
# Default Base url
self.host = "http://api.us-east-1.mbedcloud.com"
# Temp file folder for downloading files
self.temp_folder_path = None
# Authentication Settings
# dict to store API key(s)
self.api_key = {}
# dict to store API prefix (e.g. Bearer)
self.api_key_prefix = {}
# Username for HTTP basic authentication
self.username = ""
# Password for HTTP basic authentication
self.password = ""
# Logging Settings
self.logger = {}
self.logger["package_logger"] = logging.getLogger("billing")
self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler
self.logger_stream_handler = None
# Log file handler
self.logger_file_handler = None
# Debug file location
self.logger_file = None
# Debug switch
self.debug = False
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True
# Set this to customize the certificate file to verify the peer.
self.ssl_ca_cert = None
# client certificate file
self.cert_file = None
# client key file
self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification.
self.assert_hostname = None
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
# Proxy URL
self.proxy = None
# Safe chars for path_param
self.safe_chars_for_path_param = ''
@property
def logger_file(self):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
return self.__logger_file
@logger_file.setter
def logger_file(self, value):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
self.__logger_file = value
if self.__logger_file:
# If set logging file,
# then add file handler and remove stream handler.
self.logger_file_handler = logging.FileHandler(self.__logger_file)
self.logger_file_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_file_handler)
if self.logger_stream_handler:
logger.removeHandler(self.logger_stream_handler)
else:
# If not set logging file,
# then add stream handler and remove file handler.
self.logger_stream_handler = logging.StreamHandler()
self.logger_stream_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_stream_handler)
if self.logger_file_handler:
logger.removeHandler(self.logger_file_handler)
@property
def debug(self):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
return self.__debug
@debug.setter
def debug(self, value):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
self.__debug = value
if self.__debug:
# if debug status is True, turn on debug logging
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.DEBUG)
# turn on httplib debug
httplib.HTTPConnection.debuglevel = 1
else:
# if debug status is False, turn off debug logging,
# setting log level to default `logging.WARNING`
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.WARNING)
# turn off httplib debug
httplib.HTTPConnection.debuglevel = 0
@property
def logger_format(self):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
return self.__logger_format
@logger_format.setter
def logger_format(self, value):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)
def get_api_key_with_prefix(self, identifier):
"""Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
"""
if (self.api_key.get(identifier) and
self.api_key_prefix.get(identifier)):
return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] # noqa: E501
elif self.api_key.get(identifier):
return self.api_key[identifier]
def get_basic_auth_token(self):
"""Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
"""
return urllib3.util.make_headers(
basic_auth=self.username + ':' + self.password
).get('authorization')
def auth_settings(self):
"""Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
"""
return {
'Bearer':
{
'type': 'api_key',
'in': 'header',
'key': 'Authorization',
'value': self.get_api_key_with_prefix('Authorization')
},
}
def to_debug_report(self):
"""Gets the essential information for debugging.
:return: The report for debugging.
"""
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: 1.4.7\n"\
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)
|
class Configuration(object):
'''NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
'''
def __init__(self):
'''Constructor'''
pass
@property
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@logger_file.setter
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@property
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@debug.setter
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@property
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
@logger_format.setter
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
def get_api_key_with_prefix(self, identifier):
'''Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
'''
pass
def get_basic_auth_token(self):
'''Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
'''
pass
def auth_settings(self):
'''Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
'''
pass
def to_debug_report(self):
'''Gets the essential information for debugging.
:return: The report for debugging.
'''
pass
| 18 | 12 | 17 | 2 | 8 | 7 | 2 | 0.92 | 1 | 3 | 0 | 0 | 11 | 21 | 11 | 11 | 208 | 32 | 92 | 41 | 74 | 85 | 67 | 35 | 55 | 6 | 1 | 3 | 21 |
2,465 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/apis/default_api.py
|
mbed_cloud._backends.billing.apis.default_api.DefaultApi
|
class DefaultApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def get_billing_report(self, month, **kwargs): # noqa: E501
"""Get billing report. # noqa: E501
Fetch the billing report generated for the currently authenticated commercial non-subtenant account. Billing reports for subtenant accounts are included in their aggregator's billing report response. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: ReportResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_billing_report_with_http_info(month, **kwargs) # noqa: E501
else:
(data) = self.get_billing_report_with_http_info(month, **kwargs) # noqa: E501
return data
def get_billing_report_with_http_info(self, month, **kwargs): # noqa: E501
"""Get billing report. # noqa: E501
Fetch the billing report generated for the currently authenticated commercial non-subtenant account. Billing reports for subtenant accounts are included in their aggregator's billing report response. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report_with_http_info(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: ReportResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['month'] # noqa: E501
all_params.append('asynchronous')
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_billing_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'month' is set
if ('month' not in params or
params['month'] is None):
raise ValueError("Missing the required parameter `month` when calling `get_billing_report`") # noqa: E501
if 'month' in params and not re.search('^\\d{4}-\\d{2}$', params['month']): # noqa: E501
raise ValueError("Invalid value for parameter `month` when calling `get_billing_report`, must conform to the pattern `/^\\d{4}-\\d{2}$/`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'month' in params:
query_params.append(('month', params['month'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/billing-report', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ReportResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_billing_report_active_devices(self, month, **kwargs): # noqa: E501
"""Get raw billing data of the active devices for the month. # noqa: E501
Fetch the raw billing data of the active devices for the currently authenticated commercial non-subtenant account. This is supplementary data for the billing report. The raw billing data of the active devices for subtenant accounts are included in their aggregator's raw billing data of the active devices. The endpoint returns the URL to download the gzipped CSV file. The first line is the header providing information on the active devices. For example, the ID of an active device. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report-active-devices?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report_active_devices(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: BillingReportRawDataResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_billing_report_active_devices_with_http_info(month, **kwargs) # noqa: E501
else:
(data) = self.get_billing_report_active_devices_with_http_info(month, **kwargs) # noqa: E501
return data
def get_billing_report_active_devices_with_http_info(self, month, **kwargs): # noqa: E501
"""Get raw billing data of the active devices for the month. # noqa: E501
Fetch the raw billing data of the active devices for the currently authenticated commercial non-subtenant account. This is supplementary data for the billing report. The raw billing data of the active devices for subtenant accounts are included in their aggregator's raw billing data of the active devices. The endpoint returns the URL to download the gzipped CSV file. The first line is the header providing information on the active devices. For example, the ID of an active device. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report-active-devices?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report_active_devices_with_http_info(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: BillingReportRawDataResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['month'] # noqa: E501
all_params.append('asynchronous')
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_billing_report_active_devices" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'month' is set
if ('month' not in params or
params['month'] is None):
raise ValueError("Missing the required parameter `month` when calling `get_billing_report_active_devices`") # noqa: E501
if 'month' in params and not re.search('^\\d{4}-\\d{2}$', params['month']): # noqa: E501
raise ValueError("Invalid value for parameter `month` when calling `get_billing_report_active_devices`, must conform to the pattern `/^\\d{4}-\\d{2}$/`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'month' in params:
query_params.append(('month', params['month'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/billing-report-active-devices', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='BillingReportRawDataResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_billing_report_firmware_updates(self, month, **kwargs): # noqa: E501
"""Get raw billing data of the firmware updates for the month. # noqa: E501
Fetch raw billing data of the firmware updates for the currently authenticated commercial non-subtenant account. This is supplementary data for the billing report. The raw billing data of the firmware updates for subtenant accounts are included in their aggregator's raw billing data of the firmware updates. The endpoint returns the URL to download the gzipped CSV file. The first line is the header providing information on the firmware updates. For example, the ID of an firmware update. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report-firmware-updates?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report_firmware_updates(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: BillingReportRawDataResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_billing_report_firmware_updates_with_http_info(month, **kwargs) # noqa: E501
else:
(data) = self.get_billing_report_firmware_updates_with_http_info(month, **kwargs) # noqa: E501
return data
def get_billing_report_firmware_updates_with_http_info(self, month, **kwargs): # noqa: E501
"""Get raw billing data of the firmware updates for the month. # noqa: E501
Fetch raw billing data of the firmware updates for the currently authenticated commercial non-subtenant account. This is supplementary data for the billing report. The raw billing data of the firmware updates for subtenant accounts are included in their aggregator's raw billing data of the firmware updates. The endpoint returns the URL to download the gzipped CSV file. The first line is the header providing information on the firmware updates. For example, the ID of an firmware update. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report-firmware-updates?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report_firmware_updates_with_http_info(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: BillingReportRawDataResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['month'] # noqa: E501
all_params.append('asynchronous')
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_billing_report_firmware_updates" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'month' is set
if ('month' not in params or
params['month'] is None):
raise ValueError("Missing the required parameter `month` when calling `get_billing_report_firmware_updates`") # noqa: E501
if 'month' in params and not re.search('^\\d{4}-\\d{2}$', params['month']): # noqa: E501
raise ValueError("Invalid value for parameter `month` when calling `get_billing_report_firmware_updates`, must conform to the pattern `/^\\d{4}-\\d{2}$/`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'month' in params:
query_params.append(('month', params['month'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/billing-report-firmware-updates', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='BillingReportRawDataResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_service_package_quota(self, **kwargs): # noqa: E501
"""Service package quota. # noqa: E501
Get the available firmware update quota for the currently authenticated commercial account. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages-quota -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_package_quota(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ServicePackageQuota
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_service_package_quota_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_service_package_quota_with_http_info(**kwargs) # noqa: E501
return data
def get_service_package_quota_with_http_info(self, **kwargs): # noqa: E501
"""Service package quota. # noqa: E501
Get the available firmware update quota for the currently authenticated commercial account. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages-quota -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_package_quota_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ServicePackageQuota
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('asynchronous')
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_service_package_quota" % 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/service-packages-quota', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ServicePackageQuota', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_service_package_quota_history(self, **kwargs): # noqa: E501
"""Service package quota history. # noqa: E501
Get your quota usage history. This API is available for commercial accounts. Aggregator accounts can see own and subtenant quota usage data. History data is ordered in ascending order based on the added timestamp. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages-quota-history -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_package_quota_history(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: Maximum amount of quota history entries contained in one paged response.
:param str after: To fetch after which quota history ID. The results will contain entries after specified entry.
:return: ServicePackageQuotaHistoryResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_service_package_quota_history_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_service_package_quota_history_with_http_info(**kwargs) # noqa: E501
return data
def get_service_package_quota_history_with_http_info(self, **kwargs): # noqa: E501
"""Service package quota history. # noqa: E501
Get your quota usage history. This API is available for commercial accounts. Aggregator accounts can see own and subtenant quota usage data. History data is ordered in ascending order based on the added timestamp. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages-quota-history -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_package_quota_history_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: Maximum amount of quota history entries contained in one paged response.
:param str after: To fetch after which quota history ID. The results will contain entries after specified entry.
:return: ServicePackageQuotaHistoryResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'after'] # noqa: E501
all_params.append('asynchronous')
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_service_package_quota_history" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_service_package_quota_history`, must be a value less than or equal to `1000`") # noqa: E501
if 'limit' in params and params['limit'] < 2: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_service_package_quota_history`, must be a value greater than or equal to `2`") # noqa: E501
if ('after' in params and
len(params['after']) > 32):
raise ValueError("Invalid value for parameter `after` when calling `get_service_package_quota_history`, length must be less than or equal to `32`") # noqa: E501
if ('after' in params and
len(params['after']) < 32):
raise ValueError("Invalid value for parameter `after` when calling `get_service_package_quota_history`, length must be greater than or equal to `32`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/service-packages-quota-history', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ServicePackageQuotaHistoryResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_service_packages(self, **kwargs): # noqa: E501
"""Get all service packages. # noqa: E501
Get information of all service packages for the currently authenticated commercial account. The response is returned in descending order by service package created timestamp, listing first the pending service package, then the active service package and finally the previous service packages. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_packages(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ServicePackagesResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_service_packages_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_service_packages_with_http_info(**kwargs) # noqa: E501
return data
def get_service_packages_with_http_info(self, **kwargs): # noqa: E501
"""Get all service packages. # noqa: E501
Get information of all service packages for the currently authenticated commercial account. The response is returned in descending order by service package created timestamp, listing first the pending service package, then the active service package and finally the previous service packages. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_packages_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ServicePackagesResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('asynchronous')
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_service_packages" % 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/service-packages', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ServicePackagesResponse', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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)
|
class DefaultApi(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):
pass
def get_billing_report(self, month, **kwargs):
'''Get billing report. # noqa: E501
Fetch the billing report generated for the currently authenticated commercial non-subtenant account. Billing reports for subtenant accounts are included in their aggregator's billing report response. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: ReportResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_billing_report_with_http_info(self, month, **kwargs):
'''Get billing report. # noqa: E501
Fetch the billing report generated for the currently authenticated commercial non-subtenant account. Billing reports for subtenant accounts are included in their aggregator's billing report response. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report_with_http_info(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: ReportResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_billing_report_active_devices(self, month, **kwargs):
'''Get raw billing data of the active devices for the month. # noqa: E501
Fetch the raw billing data of the active devices for the currently authenticated commercial non-subtenant account. This is supplementary data for the billing report. The raw billing data of the active devices for subtenant accounts are included in their aggregator's raw billing data of the active devices. The endpoint returns the URL to download the gzipped CSV file. The first line is the header providing information on the active devices. For example, the ID of an active device. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report-active-devices?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report_active_devices(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: BillingReportRawDataResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_billing_report_active_devices_with_http_info(self, month, **kwargs):
'''Get raw billing data of the active devices for the month. # noqa: E501
Fetch the raw billing data of the active devices for the currently authenticated commercial non-subtenant account. This is supplementary data for the billing report. The raw billing data of the active devices for subtenant accounts are included in their aggregator's raw billing data of the active devices. The endpoint returns the URL to download the gzipped CSV file. The first line is the header providing information on the active devices. For example, the ID of an active device. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report-active-devices?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report_active_devices_with_http_info(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: BillingReportRawDataResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_billing_report_firmware_updates(self, month, **kwargs):
'''Get raw billing data of the firmware updates for the month. # noqa: E501
Fetch raw billing data of the firmware updates for the currently authenticated commercial non-subtenant account. This is supplementary data for the billing report. The raw billing data of the firmware updates for subtenant accounts are included in their aggregator's raw billing data of the firmware updates. The endpoint returns the URL to download the gzipped CSV file. The first line is the header providing information on the firmware updates. For example, the ID of an firmware update. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report-firmware-updates?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report_firmware_updates(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: BillingReportRawDataResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_billing_report_firmware_updates_with_http_info(self, month, **kwargs):
'''Get raw billing data of the firmware updates for the month. # noqa: E501
Fetch raw billing data of the firmware updates for the currently authenticated commercial non-subtenant account. This is supplementary data for the billing report. The raw billing data of the firmware updates for subtenant accounts are included in their aggregator's raw billing data of the firmware updates. The endpoint returns the URL to download the gzipped CSV file. The first line is the header providing information on the firmware updates. For example, the ID of an firmware update. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/billing-report-firmware-updates?month=2018-07 -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_billing_report_firmware_updates_with_http_info(month, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str month: Queried year and month of billing report. (required)
:return: BillingReportRawDataResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_service_package_quota(self, **kwargs):
'''Service package quota. # noqa: E501
Get the available firmware update quota for the currently authenticated commercial account. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages-quota -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_package_quota(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ServicePackageQuota
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_service_package_quota_with_http_info(self, **kwargs):
'''Service package quota. # noqa: E501
Get the available firmware update quota for the currently authenticated commercial account. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages-quota -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_package_quota_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ServicePackageQuota
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_service_package_quota_history(self, **kwargs):
'''Service package quota history. # noqa: E501
Get your quota usage history. This API is available for commercial accounts. Aggregator accounts can see own and subtenant quota usage data. History data is ordered in ascending order based on the added timestamp. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages-quota-history -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_package_quota_history(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: Maximum amount of quota history entries contained in one paged response.
:param str after: To fetch after which quota history ID. The results will contain entries after specified entry.
:return: ServicePackageQuotaHistoryResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_service_package_quota_history_with_http_info(self, **kwargs):
'''Service package quota history. # noqa: E501
Get your quota usage history. This API is available for commercial accounts. Aggregator accounts can see own and subtenant quota usage data. History data is ordered in ascending order based on the added timestamp. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages-quota-history -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_package_quota_history_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: Maximum amount of quota history entries contained in one paged response.
:param str after: To fetch after which quota history ID. The results will contain entries after specified entry.
:return: ServicePackageQuotaHistoryResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_service_packages(self, **kwargs):
'''Get all service packages. # noqa: E501
Get information of all service packages for the currently authenticated commercial account. The response is returned in descending order by service package created timestamp, listing first the pending service package, then the active service package and finally the previous service packages. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_packages(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ServicePackagesResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_service_packages_with_http_info(self, **kwargs):
'''Get all service packages. # noqa: E501
Get information of all service packages for the currently authenticated commercial account. The response is returned in descending order by service package created timestamp, listing first the pending service package, then the active service package and finally the previous service packages. **Example usage:** curl -X GET https://api.us-east-1.mbedcloud.com/v3/service-packages -H 'authorization: Bearer {api-key}' # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_service_packages_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:return: ServicePackagesResponse
If the method is called asynchronously,
returns the request thread.
'''
pass
| 14 | 13 | 43 | 6 | 25 | 17 | 4 | 0.71 | 1 | 3 | 1 | 0 | 13 | 1 | 13 | 13 | 581 | 98 | 322 | 87 | 308 | 229 | 203 | 87 | 189 | 9 | 1 | 2 | 47 |
2,466 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/quota_usage_report.py
|
mbed_cloud._backends.billing.models.quota_usage_report.QuotaUsageReport
|
class QuotaUsageReport(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 = {
'amount': 'int',
'campaign_name': 'str',
'time': 'datetime',
'type': 'str'
}
attribute_map = {
'amount': 'amount',
'campaign_name': 'campaign_name',
'time': 'time',
'type': 'type'
}
def __init__(self, amount=None, campaign_name=None, time=None, type=None):
"""
QuotaUsageReport - a model defined in Swagger
"""
self._amount = amount
self._campaign_name = campaign_name
self._time = time
self._type = type
self.discriminator = None
@property
def amount(self):
"""
Gets the amount of this QuotaUsageReport.
Amount of quota usage entry. Negative if it is quota consumption.
:return: The amount of this QuotaUsageReport.
:rtype: int
"""
return self._amount
@amount.setter
def amount(self, amount):
"""
Sets the amount of this QuotaUsageReport.
Amount of quota usage entry. Negative if it is quota consumption.
:param amount: The amount of this QuotaUsageReport.
:type: int
"""
if amount is None:
raise ValueError("Invalid value for `amount`, must not be `None`")
self._amount = amount
@property
def campaign_name(self):
"""
Gets the campaign_name of this QuotaUsageReport.
Campaign name of quota usage entry. Null if quota usage entry type is not reservation or reservation release.
:return: The campaign_name of this QuotaUsageReport.
:rtype: str
"""
return self._campaign_name
@campaign_name.setter
def campaign_name(self, campaign_name):
"""
Sets the campaign_name of this QuotaUsageReport.
Campaign name of quota usage entry. Null if quota usage entry type is not reservation or reservation release.
:param campaign_name: The campaign_name of this QuotaUsageReport.
:type: str
"""
self._campaign_name = campaign_name
@property
def time(self):
"""
Gets the time of this QuotaUsageReport.
Added time of quota usage entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The time of this QuotaUsageReport.
:rtype: datetime
"""
return self._time
@time.setter
def time(self, time):
"""
Sets the time of this QuotaUsageReport.
Added time of quota usage entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param time: The time of this QuotaUsageReport.
:type: datetime
"""
if time is None:
raise ValueError("Invalid value for `time`, must not be `None`")
self._time = time
@property
def type(self):
"""
Gets the type of this QuotaUsageReport.
Type of quota usage entry.
:return: The type of this QuotaUsageReport.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this QuotaUsageReport.
Type of quota usage entry.
:param type: The type of this QuotaUsageReport.
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`")
allowed_values = ["reservation", "reservation_release", "reservation_termination", "package_renewal", "package_creation", "package_termination"]
if type not in allowed_values:
raise ValueError(
"Invalid value for `type` ({0}), must be one of {1}"
.format(type, allowed_values)
)
self._type = type
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, QuotaUsageReport):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class QuotaUsageReport(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, amount=None, campaign_name=None, time=None, type=None):
'''
QuotaUsageReport - a model defined in Swagger
'''
pass
@property
def amount(self):
'''
Gets the amount of this QuotaUsageReport.
Amount of quota usage entry. Negative if it is quota consumption.
:return: The amount of this QuotaUsageReport.
:rtype: int
'''
pass
@amount.setter
def amount(self):
'''
Sets the amount of this QuotaUsageReport.
Amount of quota usage entry. Negative if it is quota consumption.
:param amount: The amount of this QuotaUsageReport.
:type: int
'''
pass
@property
def campaign_name(self):
'''
Gets the campaign_name of this QuotaUsageReport.
Campaign name of quota usage entry. Null if quota usage entry type is not reservation or reservation release.
:return: The campaign_name of this QuotaUsageReport.
:rtype: str
'''
pass
@campaign_name.setter
def campaign_name(self):
'''
Sets the campaign_name of this QuotaUsageReport.
Campaign name of quota usage entry. Null if quota usage entry type is not reservation or reservation release.
:param campaign_name: The campaign_name of this QuotaUsageReport.
:type: str
'''
pass
@property
def time(self):
'''
Gets the time of this QuotaUsageReport.
Added time of quota usage entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:return: The time of this QuotaUsageReport.
:rtype: datetime
'''
pass
@time.setter
def time(self):
'''
Sets the time of this QuotaUsageReport.
Added time of quota usage entry in RFC3339 date-time with millisecond accuracy and UTC time zone.
:param time: The time of this QuotaUsageReport.
:type: datetime
'''
pass
@property
def type(self):
'''
Gets the type of this QuotaUsageReport.
Type of quota usage entry.
:return: The type of this QuotaUsageReport.
:rtype: str
'''
pass
@type.setter
def type(self):
'''
Sets the type of this QuotaUsageReport.
Type of quota usage entry.
:param type: The type of this QuotaUsageReport.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 23 | 15 | 10 | 1 | 5 | 5 | 2 | 0.91 | 1 | 4 | 0 | 0 | 14 | 5 | 14 | 14 | 195 | 33 | 85 | 34 | 62 | 77 | 54 | 26 | 39 | 5 | 1 | 2 | 23 |
2,467 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/api_key_update_req.py
|
mbed_cloud._backends.iam.models.api_key_update_req.ApiKeyUpdateReq
|
class ApiKeyUpdateReq(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 = {
'groups': 'list[str]',
'name': 'str',
'owner': 'str',
'status': 'str'
}
attribute_map = {
'groups': 'groups',
'name': 'name',
'owner': 'owner',
'status': 'status'
}
def __init__(self, groups=None, name=None, owner=None, status=None):
"""
ApiKeyUpdateReq - a model defined in Swagger
"""
self._groups = groups
self._name = name
self._owner = owner
self._status = status
self.discriminator = None
@property
def groups(self):
"""
Gets the groups of this ApiKeyUpdateReq.
A list of group IDs this API key belongs to.
:return: The groups of this ApiKeyUpdateReq.
:rtype: list[str]
"""
return self._groups
@groups.setter
def groups(self, groups):
"""
Sets the groups of this ApiKeyUpdateReq.
A list of group IDs this API key belongs to.
:param groups: The groups of this ApiKeyUpdateReq.
:type: list[str]
"""
self._groups = groups
@property
def name(self):
"""
Gets the name of this ApiKeyUpdateReq.
The display name for the API key, not longer than 100 characters.
:return: The name of this ApiKeyUpdateReq.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this ApiKeyUpdateReq.
The display name for the API key, not longer than 100 characters.
:param name: The name of this ApiKeyUpdateReq.
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`")
self._name = name
@property
def owner(self):
"""
Gets the owner of this ApiKeyUpdateReq.
The owner of this API key.
:return: The owner of this ApiKeyUpdateReq.
:rtype: str
"""
return self._owner
@owner.setter
def owner(self, owner):
"""
Sets the owner of this ApiKeyUpdateReq.
The owner of this API key.
:param owner: The owner of this ApiKeyUpdateReq.
:type: str
"""
self._owner = owner
@property
def status(self):
"""
Gets the status of this ApiKeyUpdateReq.
The status of the API key.
:return: The status of this ApiKeyUpdateReq.
:rtype: str
"""
return self._status
@status.setter
def status(self, status):
"""
Sets the status of this ApiKeyUpdateReq.
The status of the API key.
:param status: The status of this ApiKeyUpdateReq.
:type: str
"""
allowed_values = ["ACTIVE", "INACTIVE"]
if status not in allowed_values:
raise ValueError(
"Invalid value for `status` ({0}), must be one of {1}"
.format(status, allowed_values)
)
self._status = status
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ApiKeyUpdateReq):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ApiKeyUpdateReq(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, groups=None, name=None, owner=None, status=None):
'''
ApiKeyUpdateReq - a model defined in Swagger
'''
pass
@property
def groups(self):
'''
Gets the groups of this ApiKeyUpdateReq.
A list of group IDs this API key belongs to.
:return: The groups of this ApiKeyUpdateReq.
:rtype: list[str]
'''
pass
@groups.setter
def groups(self):
'''
Sets the groups of this ApiKeyUpdateReq.
A list of group IDs this API key belongs to.
:param groups: The groups of this ApiKeyUpdateReq.
:type: list[str]
'''
pass
@property
def name(self):
'''
Gets the name of this ApiKeyUpdateReq.
The display name for the API key, not longer than 100 characters.
:return: The name of this ApiKeyUpdateReq.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this ApiKeyUpdateReq.
The display name for the API key, not longer than 100 characters.
:param name: The name of this ApiKeyUpdateReq.
:type: str
'''
pass
@property
def owner(self):
'''
Gets the owner of this ApiKeyUpdateReq.
The owner of this API key.
:return: The owner of this ApiKeyUpdateReq.
:rtype: str
'''
pass
@owner.setter
def owner(self):
'''
Sets the owner of this ApiKeyUpdateReq.
The owner of this API key.
:param owner: The owner of this ApiKeyUpdateReq.
:type: str
'''
pass
@property
def status(self):
'''
Gets the status of this ApiKeyUpdateReq.
The status of the API key.
:return: The status of this ApiKeyUpdateReq.
:rtype: str
'''
pass
@status.setter
def status(self):
'''
Sets the status of this ApiKeyUpdateReq.
The status of the API key.
:param status: The status of this ApiKeyUpdateReq.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 23 | 15 | 10 | 1 | 4 | 5 | 2 | 0.95 | 1 | 4 | 0 | 0 | 14 | 5 | 14 | 14 | 191 | 33 | 81 | 34 | 58 | 77 | 50 | 26 | 35 | 5 | 1 | 2 | 21 |
2,468 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/subtenant_report_account_contact_info.py
|
mbed_cloud._backends.billing.models.subtenant_report_account_contact_info.SubtenantReportAccountContactInfo
|
class SubtenantReportAccountContactInfo(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'address_line1': 'str',
'address_line2': 'str',
'city': 'str',
'company': 'str',
'contact': 'str',
'country': 'str',
'customer_subtenant_id': 'str',
'email': 'str',
'id': 'str',
'phone_number': 'str',
'postal_code': 'str',
'state': 'str'
}
attribute_map = {
'address_line1': 'address_line1',
'address_line2': 'address_line2',
'city': 'city',
'company': 'company',
'contact': 'contact',
'country': 'country',
'customer_subtenant_id': 'customer_subtenant_id',
'email': 'email',
'id': 'id',
'phone_number': 'phone_number',
'postal_code': 'postal_code',
'state': 'state'
}
def __init__(self, address_line1=None, address_line2=None, city=None, company=None, contact=None, country=None, customer_subtenant_id=None, email=None, id=None, phone_number=None, postal_code=None, state=None):
"""
SubtenantReportAccountContactInfo - a model defined in Swagger
"""
self._address_line1 = address_line1
self._address_line2 = address_line2
self._city = city
self._company = company
self._contact = contact
self._country = country
self._customer_subtenant_id = customer_subtenant_id
self._email = email
self._id = id
self._phone_number = phone_number
self._postal_code = postal_code
self._state = state
self.discriminator = None
@property
def address_line1(self):
"""
Gets the address_line1 of this SubtenantReportAccountContactInfo.
:return: The address_line1 of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._address_line1
@address_line1.setter
def address_line1(self, address_line1):
"""
Sets the address_line1 of this SubtenantReportAccountContactInfo.
:param address_line1: The address_line1 of this SubtenantReportAccountContactInfo.
:type: str
"""
self._address_line1 = address_line1
@property
def address_line2(self):
"""
Gets the address_line2 of this SubtenantReportAccountContactInfo.
:return: The address_line2 of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._address_line2
@address_line2.setter
def address_line2(self, address_line2):
"""
Sets the address_line2 of this SubtenantReportAccountContactInfo.
:param address_line2: The address_line2 of this SubtenantReportAccountContactInfo.
:type: str
"""
self._address_line2 = address_line2
@property
def city(self):
"""
Gets the city of this SubtenantReportAccountContactInfo.
:return: The city of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._city
@city.setter
def city(self, city):
"""
Sets the city of this SubtenantReportAccountContactInfo.
:param city: The city of this SubtenantReportAccountContactInfo.
:type: str
"""
self._city = city
@property
def company(self):
"""
Gets the company of this SubtenantReportAccountContactInfo.
:return: The company of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._company
@company.setter
def company(self, company):
"""
Sets the company of this SubtenantReportAccountContactInfo.
:param company: The company of this SubtenantReportAccountContactInfo.
:type: str
"""
if company is None:
raise ValueError("Invalid value for `company`, must not be `None`")
self._company = company
@property
def contact(self):
"""
Gets the contact of this SubtenantReportAccountContactInfo.
:return: The contact of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._contact
@contact.setter
def contact(self, contact):
"""
Sets the contact of this SubtenantReportAccountContactInfo.
:param contact: The contact of this SubtenantReportAccountContactInfo.
:type: str
"""
self._contact = contact
@property
def country(self):
"""
Gets the country of this SubtenantReportAccountContactInfo.
:return: The country of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._country
@country.setter
def country(self, country):
"""
Sets the country of this SubtenantReportAccountContactInfo.
:param country: The country of this SubtenantReportAccountContactInfo.
:type: str
"""
self._country = country
@property
def customer_subtenant_id(self):
"""
Gets the customer_subtenant_id of this SubtenantReportAccountContactInfo.
Account subtenant ID if it is a subtenant.
:return: The customer_subtenant_id of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._customer_subtenant_id
@customer_subtenant_id.setter
def customer_subtenant_id(self, customer_subtenant_id):
"""
Sets the customer_subtenant_id of this SubtenantReportAccountContactInfo.
Account subtenant ID if it is a subtenant.
:param customer_subtenant_id: The customer_subtenant_id of this SubtenantReportAccountContactInfo.
:type: str
"""
if customer_subtenant_id is None:
raise ValueError("Invalid value for `customer_subtenant_id`, must not be `None`")
self._customer_subtenant_id = customer_subtenant_id
@property
def email(self):
"""
Gets the email of this SubtenantReportAccountContactInfo.
:return: The email of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""
Sets the email of this SubtenantReportAccountContactInfo.
:param email: The email of this SubtenantReportAccountContactInfo.
:type: str
"""
self._email = email
@property
def id(self):
"""
Gets the id of this SubtenantReportAccountContactInfo.
Account ID.
:return: The id of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this SubtenantReportAccountContactInfo.
Account ID.
:param id: The id of this SubtenantReportAccountContactInfo.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def phone_number(self):
"""
Gets the phone_number of this SubtenantReportAccountContactInfo.
:return: The phone_number of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._phone_number
@phone_number.setter
def phone_number(self, phone_number):
"""
Sets the phone_number of this SubtenantReportAccountContactInfo.
:param phone_number: The phone_number of this SubtenantReportAccountContactInfo.
:type: str
"""
self._phone_number = phone_number
@property
def postal_code(self):
"""
Gets the postal_code of this SubtenantReportAccountContactInfo.
:return: The postal_code of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._postal_code
@postal_code.setter
def postal_code(self, postal_code):
"""
Sets the postal_code of this SubtenantReportAccountContactInfo.
:param postal_code: The postal_code of this SubtenantReportAccountContactInfo.
:type: str
"""
self._postal_code = postal_code
@property
def state(self):
"""
Gets the state of this SubtenantReportAccountContactInfo.
:return: The state of this SubtenantReportAccountContactInfo.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this SubtenantReportAccountContactInfo.
:param state: The state of this SubtenantReportAccountContactInfo.
:type: str
"""
self._state = state
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, SubtenantReportAccountContactInfo):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class SubtenantReportAccountContactInfo(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, address_line1=None, address_line2=None, city=None, company=None, contact=None, country=None, customer_subtenant_id=None, email=None, id=None, phone_number=None, postal_code=None, state=None):
'''
SubtenantReportAccountContactInfo - a model defined in Swagger
'''
pass
@property
def address_line1(self):
'''
Gets the address_line1 of this SubtenantReportAccountContactInfo.
:return: The address_line1 of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@address_line1.setter
def address_line1(self):
'''
Sets the address_line1 of this SubtenantReportAccountContactInfo.
:param address_line1: The address_line1 of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def address_line2(self):
'''
Gets the address_line2 of this SubtenantReportAccountContactInfo.
:return: The address_line2 of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@address_line2.setter
def address_line2(self):
'''
Sets the address_line2 of this SubtenantReportAccountContactInfo.
:param address_line2: The address_line2 of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def city(self):
'''
Gets the city of this SubtenantReportAccountContactInfo.
:return: The city of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@city.setter
def city(self):
'''
Sets the city of this SubtenantReportAccountContactInfo.
:param city: The city of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def company(self):
'''
Gets the company of this SubtenantReportAccountContactInfo.
:return: The company of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@company.setter
def company(self):
'''
Sets the company of this SubtenantReportAccountContactInfo.
:param company: The company of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def contact(self):
'''
Gets the contact of this SubtenantReportAccountContactInfo.
:return: The contact of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@contact.setter
def contact(self):
'''
Sets the contact of this SubtenantReportAccountContactInfo.
:param contact: The contact of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def country(self):
'''
Gets the country of this SubtenantReportAccountContactInfo.
:return: The country of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@country.setter
def country(self):
'''
Sets the country of this SubtenantReportAccountContactInfo.
:param country: The country of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def customer_subtenant_id(self):
'''
Gets the customer_subtenant_id of this SubtenantReportAccountContactInfo.
Account subtenant ID if it is a subtenant.
:return: The customer_subtenant_id of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@customer_subtenant_id.setter
def customer_subtenant_id(self):
'''
Sets the customer_subtenant_id of this SubtenantReportAccountContactInfo.
Account subtenant ID if it is a subtenant.
:param customer_subtenant_id: The customer_subtenant_id of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def email(self):
'''
Gets the email of this SubtenantReportAccountContactInfo.
:return: The email of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@email.setter
def email(self):
'''
Sets the email of this SubtenantReportAccountContactInfo.
:param email: The email of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this SubtenantReportAccountContactInfo.
Account ID.
:return: The id of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this SubtenantReportAccountContactInfo.
Account ID.
:param id: The id of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def phone_number(self):
'''
Gets the phone_number of this SubtenantReportAccountContactInfo.
:return: The phone_number of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@phone_number.setter
def phone_number(self):
'''
Sets the phone_number of this SubtenantReportAccountContactInfo.
:param phone_number: The phone_number of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def postal_code(self):
'''
Gets the postal_code of this SubtenantReportAccountContactInfo.
:return: The postal_code of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@postal_code.setter
def postal_code(self):
'''
Sets the postal_code of this SubtenantReportAccountContactInfo.
:param postal_code: The postal_code of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this SubtenantReportAccountContactInfo.
:return: The state of this SubtenantReportAccountContactInfo.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this SubtenantReportAccountContactInfo.
:param state: The state of this SubtenantReportAccountContactInfo.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 55 | 31 | 9 | 1 | 3 | 5 | 1 | 1.01 | 1 | 4 | 0 | 0 | 30 | 13 | 30 | 30 | 377 | 73 | 151 | 73 | 96 | 153 | 91 | 49 | 60 | 5 | 1 | 2 | 38 |
2,469 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/unauthorized_error_response.py
|
mbed_cloud._backends.billing.models.unauthorized_error_response.UnauthorizedErrorResponse
|
class UnauthorizedErrorResponse(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'code': 'int',
'message': 'str',
'object': 'str',
'request_id': 'str',
'type': 'str'
}
attribute_map = {
'code': 'code',
'message': 'message',
'object': 'object',
'request_id': 'request_id',
'type': 'type'
}
def __init__(self, code=None, message=None, object=None, request_id=None, type=None):
"""
UnauthorizedErrorResponse - a model defined in Swagger
"""
self._code = code
self._message = message
self._object = object
self._request_id = request_id
self._type = type
self.discriminator = None
@property
def code(self):
"""
Gets the code of this UnauthorizedErrorResponse.
Response code. Always set to 401.
:return: The code of this UnauthorizedErrorResponse.
:rtype: int
"""
return self._code
@code.setter
def code(self, code):
"""
Sets the code of this UnauthorizedErrorResponse.
Response code. Always set to 401.
:param code: The code of this UnauthorizedErrorResponse.
:type: int
"""
if code is None:
raise ValueError("Invalid value for `code`, must not be `None`")
self._code = code
@property
def message(self):
"""
Gets the message of this UnauthorizedErrorResponse.
A human readable message with detailed info.
:return: The message of this UnauthorizedErrorResponse.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this UnauthorizedErrorResponse.
A human readable message with detailed info.
:param message: The message of this UnauthorizedErrorResponse.
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`")
self._message = message
@property
def object(self):
"""
Gets the object of this UnauthorizedErrorResponse.
Always set to 'error'.
:return: The object of this UnauthorizedErrorResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this UnauthorizedErrorResponse.
Always set to 'error'.
:param object: The object of this UnauthorizedErrorResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["error"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def request_id(self):
"""
Gets the request_id of this UnauthorizedErrorResponse.
Request ID
:return: The request_id of this UnauthorizedErrorResponse.
:rtype: str
"""
return self._request_id
@request_id.setter
def request_id(self, request_id):
"""
Sets the request_id of this UnauthorizedErrorResponse.
Request ID
:param request_id: The request_id of this UnauthorizedErrorResponse.
:type: str
"""
if request_id is None:
raise ValueError("Invalid value for `request_id`, must not be `None`")
self._request_id = request_id
@property
def type(self):
"""
Gets the type of this UnauthorizedErrorResponse.
Error type. Always set to 'unauthorized'.
:return: The type of this UnauthorizedErrorResponse.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this UnauthorizedErrorResponse.
Error type. Always set to 'unauthorized'.
:param type: The type of this UnauthorizedErrorResponse.
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`")
allowed_values = ["unauthorized"]
if type not in allowed_values:
raise ValueError(
"Invalid value for `type` ({0}), must be one of {1}"
.format(type, allowed_values)
)
self._type = type
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, UnauthorizedErrorResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class UnauthorizedErrorResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, code=None, message=None, object=None, request_id=None, type=None):
'''
UnauthorizedErrorResponse - a model defined in Swagger
'''
pass
@property
def code(self):
'''
Gets the code of this UnauthorizedErrorResponse.
Response code. Always set to 401.
:return: The code of this UnauthorizedErrorResponse.
:rtype: int
'''
pass
@code.setter
def code(self):
'''
Sets the code of this UnauthorizedErrorResponse.
Response code. Always set to 401.
:param code: The code of this UnauthorizedErrorResponse.
:type: int
'''
pass
@property
def message(self):
'''
Gets the message of this UnauthorizedErrorResponse.
A human readable message with detailed info.
:return: The message of this UnauthorizedErrorResponse.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this UnauthorizedErrorResponse.
A human readable message with detailed info.
:param message: The message of this UnauthorizedErrorResponse.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this UnauthorizedErrorResponse.
Always set to 'error'.
:return: The object of this UnauthorizedErrorResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this UnauthorizedErrorResponse.
Always set to 'error'.
:param object: The object of this UnauthorizedErrorResponse.
:type: str
'''
pass
@property
def request_id(self):
'''
Gets the request_id of this UnauthorizedErrorResponse.
Request ID
:return: The request_id of this UnauthorizedErrorResponse.
:rtype: str
'''
pass
@request_id.setter
def request_id(self):
'''
Sets the request_id of this UnauthorizedErrorResponse.
Request ID
:param request_id: The request_id of this UnauthorizedErrorResponse.
:type: str
'''
pass
@property
def type(self):
'''
Gets the type of this UnauthorizedErrorResponse.
Error type. Always set to 'unauthorized'.
:return: The type of this UnauthorizedErrorResponse.
:rtype: str
'''
pass
@type.setter
def type(self):
'''
Sets the type of this UnauthorizedErrorResponse.
Error type. Always set to 'unauthorized'.
:param type: The type of this UnauthorizedErrorResponse.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 27 | 17 | 11 | 1 | 5 | 5 | 2 | 0.86 | 1 | 4 | 0 | 0 | 16 | 6 | 16 | 16 | 231 | 38 | 104 | 40 | 77 | 89 | 66 | 30 | 49 | 5 | 1 | 2 | 28 |
2,470 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_event_in_nin_filter.py
|
mbed_cloud._backends.device_directory.models.device_event_in_nin_filter.DeviceEventInNinFilter
|
class DeviceEventInNinFilter(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 = {
'date_time': 'datetime',
'description': 'str',
'device_id': 'str',
'event_type': 'str',
'id': 'str',
'state_change': 'bool'
}
attribute_map = {
'date_time': 'date_time',
'description': 'description',
'device_id': 'device_id',
'event_type': 'event_type',
'id': 'id',
'state_change': 'state_change'
}
def __init__(self, date_time=None, description=None, device_id=None, event_type=None, id=None, state_change=None):
"""
DeviceEventInNinFilter - a model defined in Swagger
"""
self._date_time = date_time
self._description = description
self._device_id = device_id
self._event_type = event_type
self._id = id
self._state_change = state_change
self.discriminator = None
@property
def date_time(self):
"""
Gets the date_time of this DeviceEventInNinFilter.
:return: The date_time of this DeviceEventInNinFilter.
:rtype: datetime
"""
return self._date_time
@date_time.setter
def date_time(self, date_time):
"""
Sets the date_time of this DeviceEventInNinFilter.
:param date_time: The date_time of this DeviceEventInNinFilter.
:type: datetime
"""
self._date_time = date_time
@property
def description(self):
"""
Gets the description of this DeviceEventInNinFilter.
:return: The description of this DeviceEventInNinFilter.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeviceEventInNinFilter.
:param description: The description of this DeviceEventInNinFilter.
:type: str
"""
self._description = description
@property
def device_id(self):
"""
Gets the device_id of this DeviceEventInNinFilter.
:return: The device_id of this DeviceEventInNinFilter.
:rtype: str
"""
return self._device_id
@device_id.setter
def device_id(self, device_id):
"""
Sets the device_id of this DeviceEventInNinFilter.
:param device_id: The device_id of this DeviceEventInNinFilter.
:type: str
"""
self._device_id = device_id
@property
def event_type(self):
"""
Gets the event_type of this DeviceEventInNinFilter.
:return: The event_type of this DeviceEventInNinFilter.
:rtype: str
"""
return self._event_type
@event_type.setter
def event_type(self, event_type):
"""
Sets the event_type of this DeviceEventInNinFilter.
:param event_type: The event_type of this DeviceEventInNinFilter.
:type: str
"""
self._event_type = event_type
@property
def id(self):
"""
Gets the id of this DeviceEventInNinFilter.
:return: The id of this DeviceEventInNinFilter.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeviceEventInNinFilter.
:param id: The id of this DeviceEventInNinFilter.
:type: str
"""
self._id = id
@property
def state_change(self):
"""
Gets the state_change of this DeviceEventInNinFilter.
:return: The state_change of this DeviceEventInNinFilter.
:rtype: bool
"""
return self._state_change
@state_change.setter
def state_change(self, state_change):
"""
Sets the state_change of this DeviceEventInNinFilter.
:param state_change: The state_change of this DeviceEventInNinFilter.
:type: bool
"""
self._state_change = state_change
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceEventInNinFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceEventInNinFilter(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, date_time=None, description=None, device_id=None, event_type=None, id=None, state_change=None):
'''
DeviceEventInNinFilter - a model defined in Swagger
'''
pass
@property
def date_time(self):
'''
Gets the date_time of this DeviceEventInNinFilter.
:return: The date_time of this DeviceEventInNinFilter.
:rtype: datetime
'''
pass
@date_time.setter
def date_time(self):
'''
Sets the date_time of this DeviceEventInNinFilter.
:param date_time: The date_time of this DeviceEventInNinFilter.
:type: datetime
'''
pass
@property
def description(self):
'''
Gets the description of this DeviceEventInNinFilter.
:return: The description of this DeviceEventInNinFilter.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeviceEventInNinFilter.
:param description: The description of this DeviceEventInNinFilter.
:type: str
'''
pass
@property
def device_id(self):
'''
Gets the device_id of this DeviceEventInNinFilter.
:return: The device_id of this DeviceEventInNinFilter.
:rtype: str
'''
pass
@device_id.setter
def device_id(self):
'''
Sets the device_id of this DeviceEventInNinFilter.
:param device_id: The device_id of this DeviceEventInNinFilter.
:type: str
'''
pass
@property
def event_type(self):
'''
Gets the event_type of this DeviceEventInNinFilter.
:return: The event_type of this DeviceEventInNinFilter.
:rtype: str
'''
pass
@event_type.setter
def event_type(self):
'''
Sets the event_type of this DeviceEventInNinFilter.
:param event_type: The event_type of this DeviceEventInNinFilter.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this DeviceEventInNinFilter.
:return: The id of this DeviceEventInNinFilter.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeviceEventInNinFilter.
:param id: The id of this DeviceEventInNinFilter.
:type: str
'''
pass
@property
def state_change(self):
'''
Gets the state_change of this DeviceEventInNinFilter.
:return: The state_change of this DeviceEventInNinFilter.
:rtype: bool
'''
pass
@state_change.setter
def state_change(self):
'''
Sets the state_change of this DeviceEventInNinFilter.
:param state_change: The state_change of this DeviceEventInNinFilter.
:type: bool
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 9 | 1 | 3 | 4 | 1 | 0.98 | 1 | 3 | 0 | 0 | 18 | 7 | 18 | 18 | 223 | 43 | 91 | 43 | 60 | 89 | 55 | 31 | 36 | 5 | 1 | 2 | 23 |
2,471 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_event_gte_lte_filter.py
|
mbed_cloud._backends.device_directory.models.device_event_gte_lte_filter.DeviceEventGteLteFilter
|
class DeviceEventGteLteFilter(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 = {
'date_time': 'datetime'
}
attribute_map = {
'date_time': 'date_time'
}
def __init__(self, date_time=None):
"""
DeviceEventGteLteFilter - a model defined in Swagger
"""
self._date_time = date_time
self.discriminator = None
@property
def date_time(self):
"""
Gets the date_time of this DeviceEventGteLteFilter.
:return: The date_time of this DeviceEventGteLteFilter.
:rtype: datetime
"""
return self._date_time
@date_time.setter
def date_time(self, date_time):
"""
Sets the date_time of this DeviceEventGteLteFilter.
:param date_time: The date_time of this DeviceEventGteLteFilter.
:type: datetime
"""
self._date_time = date_time
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceEventGteLteFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceEventGteLteFilter(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, date_time=None):
'''
DeviceEventGteLteFilter - a model defined in Swagger
'''
pass
@property
def date_time(self):
'''
Gets the date_time of this DeviceEventGteLteFilter.
:return: The date_time of this DeviceEventGteLteFilter.
:rtype: datetime
'''
pass
@date_time.setter
def date_time(self):
'''
Sets the date_time of this DeviceEventGteLteFilter.
:param date_time: The date_time of this DeviceEventGteLteFilter.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 11 | 9 | 9 | 1 | 5 | 4 | 2 | 0.85 | 1 | 3 | 0 | 0 | 8 | 2 | 8 | 8 | 103 | 18 | 46 | 18 | 35 | 39 | 30 | 16 | 21 | 5 | 1 | 2 | 13 |
2,472 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_event_eq_neq_filter.py
|
mbed_cloud._backends.device_directory.models.device_event_eq_neq_filter.DeviceEventEqNeqFilter
|
class DeviceEventEqNeqFilter(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 = {
'date_time': 'datetime',
'description': 'str',
'device_id': 'str',
'event_type': 'str',
'id': 'str',
'state_change': 'bool'
}
attribute_map = {
'date_time': 'date_time',
'description': 'description',
'device_id': 'device_id',
'event_type': 'event_type',
'id': 'id',
'state_change': 'state_change'
}
def __init__(self, date_time=None, description=None, device_id=None, event_type=None, id=None, state_change=None):
"""
DeviceEventEqNeqFilter - a model defined in Swagger
"""
self._date_time = date_time
self._description = description
self._device_id = device_id
self._event_type = event_type
self._id = id
self._state_change = state_change
self.discriminator = None
@property
def date_time(self):
"""
Gets the date_time of this DeviceEventEqNeqFilter.
:return: The date_time of this DeviceEventEqNeqFilter.
:rtype: datetime
"""
return self._date_time
@date_time.setter
def date_time(self, date_time):
"""
Sets the date_time of this DeviceEventEqNeqFilter.
:param date_time: The date_time of this DeviceEventEqNeqFilter.
:type: datetime
"""
self._date_time = date_time
@property
def description(self):
"""
Gets the description of this DeviceEventEqNeqFilter.
:return: The description of this DeviceEventEqNeqFilter.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeviceEventEqNeqFilter.
:param description: The description of this DeviceEventEqNeqFilter.
:type: str
"""
self._description = description
@property
def device_id(self):
"""
Gets the device_id of this DeviceEventEqNeqFilter.
:return: The device_id of this DeviceEventEqNeqFilter.
:rtype: str
"""
return self._device_id
@device_id.setter
def device_id(self, device_id):
"""
Sets the device_id of this DeviceEventEqNeqFilter.
:param device_id: The device_id of this DeviceEventEqNeqFilter.
:type: str
"""
self._device_id = device_id
@property
def event_type(self):
"""
Gets the event_type of this DeviceEventEqNeqFilter.
:return: The event_type of this DeviceEventEqNeqFilter.
:rtype: str
"""
return self._event_type
@event_type.setter
def event_type(self, event_type):
"""
Sets the event_type of this DeviceEventEqNeqFilter.
:param event_type: The event_type of this DeviceEventEqNeqFilter.
:type: str
"""
self._event_type = event_type
@property
def id(self):
"""
Gets the id of this DeviceEventEqNeqFilter.
:return: The id of this DeviceEventEqNeqFilter.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeviceEventEqNeqFilter.
:param id: The id of this DeviceEventEqNeqFilter.
:type: str
"""
self._id = id
@property
def state_change(self):
"""
Gets the state_change of this DeviceEventEqNeqFilter.
:return: The state_change of this DeviceEventEqNeqFilter.
:rtype: bool
"""
return self._state_change
@state_change.setter
def state_change(self, state_change):
"""
Sets the state_change of this DeviceEventEqNeqFilter.
:param state_change: The state_change of this DeviceEventEqNeqFilter.
:type: bool
"""
self._state_change = state_change
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceEventEqNeqFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceEventEqNeqFilter(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, date_time=None, description=None, device_id=None, event_type=None, id=None, state_change=None):
'''
DeviceEventEqNeqFilter - a model defined in Swagger
'''
pass
@property
def date_time(self):
'''
Gets the date_time of this DeviceEventEqNeqFilter.
:return: The date_time of this DeviceEventEqNeqFilter.
:rtype: datetime
'''
pass
@date_time.setter
def date_time(self):
'''
Sets the date_time of this DeviceEventEqNeqFilter.
:param date_time: The date_time of this DeviceEventEqNeqFilter.
:type: datetime
'''
pass
@property
def description(self):
'''
Gets the description of this DeviceEventEqNeqFilter.
:return: The description of this DeviceEventEqNeqFilter.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeviceEventEqNeqFilter.
:param description: The description of this DeviceEventEqNeqFilter.
:type: str
'''
pass
@property
def device_id(self):
'''
Gets the device_id of this DeviceEventEqNeqFilter.
:return: The device_id of this DeviceEventEqNeqFilter.
:rtype: str
'''
pass
@device_id.setter
def device_id(self):
'''
Sets the device_id of this DeviceEventEqNeqFilter.
:param device_id: The device_id of this DeviceEventEqNeqFilter.
:type: str
'''
pass
@property
def event_type(self):
'''
Gets the event_type of this DeviceEventEqNeqFilter.
:return: The event_type of this DeviceEventEqNeqFilter.
:rtype: str
'''
pass
@event_type.setter
def event_type(self):
'''
Sets the event_type of this DeviceEventEqNeqFilter.
:param event_type: The event_type of this DeviceEventEqNeqFilter.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this DeviceEventEqNeqFilter.
:return: The id of this DeviceEventEqNeqFilter.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeviceEventEqNeqFilter.
:param id: The id of this DeviceEventEqNeqFilter.
:type: str
'''
pass
@property
def state_change(self):
'''
Gets the state_change of this DeviceEventEqNeqFilter.
:return: The state_change of this DeviceEventEqNeqFilter.
:rtype: bool
'''
pass
@state_change.setter
def state_change(self):
'''
Sets the state_change of this DeviceEventEqNeqFilter.
:param state_change: The state_change of this DeviceEventEqNeqFilter.
:type: bool
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 9 | 1 | 3 | 4 | 1 | 0.98 | 1 | 3 | 0 | 0 | 18 | 7 | 18 | 18 | 223 | 43 | 91 | 43 | 60 | 89 | 55 | 31 | 36 | 5 | 1 | 2 | 23 |
2,473 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_event_data.py
|
mbed_cloud._backends.device_directory.models.device_event_data.DeviceEventData
|
class DeviceEventData(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 = {
'changes': 'dict(str, str)',
'created_at': 'datetime',
'data': 'object',
'date_time': 'datetime',
'description': 'str',
'device_id': 'str',
'etag': 'datetime',
'event_type': 'str',
'event_type_category': 'str',
'event_type_description': 'str',
'id': 'str',
'object': 'str',
'state_change': 'bool'
}
attribute_map = {
'changes': 'changes',
'created_at': 'created_at',
'data': 'data',
'date_time': 'date_time',
'description': 'description',
'device_id': 'device_id',
'etag': 'etag',
'event_type': 'event_type',
'event_type_category': 'event_type_category',
'event_type_description': 'event_type_description',
'id': 'id',
'object': 'object',
'state_change': 'state_change'
}
def __init__(self, changes=None, created_at=None, data=None, date_time=None, description=None, device_id=None, etag=None, event_type=None, event_type_category=None, event_type_description=None, id=None, object=None, state_change=None):
"""
DeviceEventData - a model defined in Swagger
"""
self._changes = changes
self._created_at = created_at
self._data = data
self._date_time = date_time
self._description = description
self._device_id = device_id
self._etag = etag
self._event_type = event_type
self._event_type_category = event_type_category
self._event_type_description = event_type_description
self._id = id
self._object = object
self._state_change = state_change
self.discriminator = None
@property
def changes(self):
"""
Gets the changes of this DeviceEventData.
Additional data relevant to the event.
:return: The changes of this DeviceEventData.
:rtype: dict(str, str)
"""
return self._changes
@changes.setter
def changes(self, changes):
"""
Sets the changes of this DeviceEventData.
Additional data relevant to the event.
:param changes: The changes of this DeviceEventData.
:type: dict(str, str)
"""
self._changes = changes
@property
def created_at(self):
"""
Gets the created_at of this DeviceEventData.
:return: The created_at of this DeviceEventData.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeviceEventData.
:param created_at: The created_at of this DeviceEventData.
:type: datetime
"""
self._created_at = created_at
@property
def data(self):
"""
Gets the data of this DeviceEventData.
:return: The data of this DeviceEventData.
:rtype: object
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this DeviceEventData.
:param data: The data of this DeviceEventData.
:type: object
"""
self._data = data
@property
def date_time(self):
"""
Gets the date_time of this DeviceEventData.
:return: The date_time of this DeviceEventData.
:rtype: datetime
"""
return self._date_time
@date_time.setter
def date_time(self, date_time):
"""
Sets the date_time of this DeviceEventData.
:param date_time: The date_time of this DeviceEventData.
:type: datetime
"""
if date_time is None:
raise ValueError("Invalid value for `date_time`, must not be `None`")
self._date_time = date_time
@property
def description(self):
"""
Gets the description of this DeviceEventData.
:return: The description of this DeviceEventData.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeviceEventData.
:param description: The description of this DeviceEventData.
:type: str
"""
self._description = description
@property
def device_id(self):
"""
Gets the device_id of this DeviceEventData.
:return: The device_id of this DeviceEventData.
:rtype: str
"""
return self._device_id
@device_id.setter
def device_id(self, device_id):
"""
Sets the device_id of this DeviceEventData.
:param device_id: The device_id of this DeviceEventData.
:type: str
"""
self._device_id = device_id
@property
def etag(self):
"""
Gets the etag of this DeviceEventData.
:return: The etag of this DeviceEventData.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeviceEventData.
:param etag: The etag of this DeviceEventData.
:type: datetime
"""
self._etag = etag
@property
def event_type(self):
"""
Gets the event_type of this DeviceEventData.
Event code
:return: The event_type of this DeviceEventData.
:rtype: str
"""
return self._event_type
@event_type.setter
def event_type(self, event_type):
"""
Sets the event_type of this DeviceEventData.
Event code
:param event_type: The event_type of this DeviceEventData.
:type: str
"""
if event_type is not None and len(event_type) > 100:
raise ValueError("Invalid value for `event_type`, length must be less than or equal to `100`")
self._event_type = event_type
@property
def event_type_category(self):
"""
Gets the event_type_category of this DeviceEventData.
Category code which groups the event type by a summary category.
:return: The event_type_category of this DeviceEventData.
:rtype: str
"""
return self._event_type_category
@event_type_category.setter
def event_type_category(self, event_type_category):
"""
Sets the event_type_category of this DeviceEventData.
Category code which groups the event type by a summary category.
:param event_type_category: The event_type_category of this DeviceEventData.
:type: str
"""
self._event_type_category = event_type_category
@property
def event_type_description(self):
"""
Gets the event_type_description of this DeviceEventData.
Generic description of the event
:return: The event_type_description of this DeviceEventData.
:rtype: str
"""
return self._event_type_description
@event_type_description.setter
def event_type_description(self, event_type_description):
"""
Sets the event_type_description of this DeviceEventData.
Generic description of the event
:param event_type_description: The event_type_description of this DeviceEventData.
:type: str
"""
self._event_type_description = event_type_description
@property
def id(self):
"""
Gets the id of this DeviceEventData.
:return: The id of this DeviceEventData.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeviceEventData.
:param id: The id of this DeviceEventData.
:type: str
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
@property
def object(self):
"""
Gets the object of this DeviceEventData.
The API resource entity.
:return: The object of this DeviceEventData.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DeviceEventData.
The API resource entity.
:param object: The object of this DeviceEventData.
:type: str
"""
self._object = object
@property
def state_change(self):
"""
Gets the state_change of this DeviceEventData.
:return: The state_change of this DeviceEventData.
:rtype: bool
"""
return self._state_change
@state_change.setter
def state_change(self, state_change):
"""
Sets the state_change of this DeviceEventData.
:param state_change: The state_change of this DeviceEventData.
:type: bool
"""
self._state_change = state_change
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceEventData):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceEventData(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, changes=None, created_at=None, data=None, date_time=None, description=None, device_id=None, etag=None, event_type=None, event_type_category=None, event_type_description=None, id=None, object=None, state_change=None):
'''
DeviceEventData - a model defined in Swagger
'''
pass
@property
def changes(self):
'''
Gets the changes of this DeviceEventData.
Additional data relevant to the event.
:return: The changes of this DeviceEventData.
:rtype: dict(str, str)
'''
pass
@changes.setter
def changes(self):
'''
Sets the changes of this DeviceEventData.
Additional data relevant to the event.
:param changes: The changes of this DeviceEventData.
:type: dict(str, str)
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeviceEventData.
:return: The created_at of this DeviceEventData.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeviceEventData.
:param created_at: The created_at of this DeviceEventData.
:type: datetime
'''
pass
@property
def data(self):
'''
Gets the data of this DeviceEventData.
:return: The data of this DeviceEventData.
:rtype: object
'''
pass
@data.setter
def data(self):
'''
Sets the data of this DeviceEventData.
:param data: The data of this DeviceEventData.
:type: object
'''
pass
@property
def date_time(self):
'''
Gets the date_time of this DeviceEventData.
:return: The date_time of this DeviceEventData.
:rtype: datetime
'''
pass
@date_time.setter
def date_time(self):
'''
Sets the date_time of this DeviceEventData.
:param date_time: The date_time of this DeviceEventData.
:type: datetime
'''
pass
@property
def description(self):
'''
Gets the description of this DeviceEventData.
:return: The description of this DeviceEventData.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeviceEventData.
:param description: The description of this DeviceEventData.
:type: str
'''
pass
@property
def device_id(self):
'''
Gets the device_id of this DeviceEventData.
:return: The device_id of this DeviceEventData.
:rtype: str
'''
pass
@device_id.setter
def device_id(self):
'''
Sets the device_id of this DeviceEventData.
:param device_id: The device_id of this DeviceEventData.
:type: str
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeviceEventData.
:return: The etag of this DeviceEventData.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeviceEventData.
:param etag: The etag of this DeviceEventData.
:type: datetime
'''
pass
@property
def event_type(self):
'''
Gets the event_type of this DeviceEventData.
Event code
:return: The event_type of this DeviceEventData.
:rtype: str
'''
pass
@event_type.setter
def event_type(self):
'''
Sets the event_type of this DeviceEventData.
Event code
:param event_type: The event_type of this DeviceEventData.
:type: str
'''
pass
@property
def event_type_category(self):
'''
Gets the event_type_category of this DeviceEventData.
Category code which groups the event type by a summary category.
:return: The event_type_category of this DeviceEventData.
:rtype: str
'''
pass
@event_type_category.setter
def event_type_category(self):
'''
Sets the event_type_category of this DeviceEventData.
Category code which groups the event type by a summary category.
:param event_type_category: The event_type_category of this DeviceEventData.
:type: str
'''
pass
@property
def event_type_description(self):
'''
Gets the event_type_description of this DeviceEventData.
Generic description of the event
:return: The event_type_description of this DeviceEventData.
:rtype: str
'''
pass
@event_type_description.setter
def event_type_description(self):
'''
Sets the event_type_description of this DeviceEventData.
Generic description of the event
:param event_type_description: The event_type_description of this DeviceEventData.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this DeviceEventData.
:return: The id of this DeviceEventData.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeviceEventData.
:param id: The id of this DeviceEventData.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this DeviceEventData.
The API resource entity.
:return: The object of this DeviceEventData.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DeviceEventData.
The API resource entity.
:param object: The object of this DeviceEventData.
:type: str
'''
pass
@property
def state_change(self):
'''
Gets the state_change of this DeviceEventData.
:return: The state_change of this DeviceEventData.
:rtype: bool
'''
pass
@state_change.setter
def state_change(self):
'''
Sets the state_change of this DeviceEventData.
:param state_change: The state_change of this DeviceEventData.
:type: bool
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 59 | 33 | 10 | 1 | 3 | 5 | 1 | 1.06 | 1 | 4 | 0 | 1 | 32 | 14 | 32 | 32 | 407 | 78 | 160 | 78 | 101 | 169 | 96 | 52 | 63 | 5 | 1 | 2 | 40 |
2,474 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_eq_neq_filter.py
|
mbed_cloud._backends.device_directory.models.device_eq_neq_filter.DeviceEqNeqFilter
|
class DeviceEqNeqFilter(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 = {
'account_id': 'str',
'auto_update': 'bool',
'bootstrap_expiration_date': 'datetime',
'bootstrapped_timestamp': 'datetime',
'ca_id': 'str',
'connector_expiration_date': 'datetime',
'created_at': 'datetime',
'custom_attributes': 'dict(str, str)',
'deployed_state': 'str',
'deployment': 'str',
'description': 'str',
'device_class': 'str',
'device_execution_mode': 'int',
'device_key': 'str',
'endpoint_name': 'str',
'endpoint_type': 'str',
'enrolment_list_timestamp': 'datetime',
'etag': 'datetime',
'firmware_checksum': 'str',
'host_gateway': 'str',
'id': 'str',
'manifest': 'str',
'manifest_timestamp': 'datetime',
'mechanism': 'str',
'mechanism_url': 'str',
'name': 'str',
'serial_number': 'str',
'state': 'str',
'updated_at': 'datetime',
'vendor_id': 'str'
}
attribute_map = {
'account_id': 'account_id',
'auto_update': 'auto_update',
'bootstrap_expiration_date': 'bootstrap_expiration_date',
'bootstrapped_timestamp': 'bootstrapped_timestamp',
'ca_id': 'ca_id',
'connector_expiration_date': 'connector_expiration_date',
'created_at': 'created_at',
'custom_attributes': 'custom_attributes',
'deployed_state': 'deployed_state',
'deployment': 'deployment',
'description': 'description',
'device_class': 'device_class',
'device_execution_mode': 'device_execution_mode',
'device_key': 'device_key',
'endpoint_name': 'endpoint_name',
'endpoint_type': 'endpoint_type',
'enrolment_list_timestamp': 'enrolment_list_timestamp',
'etag': 'etag',
'firmware_checksum': 'firmware_checksum',
'host_gateway': 'host_gateway',
'id': 'id',
'manifest': 'manifest',
'manifest_timestamp': 'manifest_timestamp',
'mechanism': 'mechanism',
'mechanism_url': 'mechanism_url',
'name': 'name',
'serial_number': 'serial_number',
'state': 'state',
'updated_at': 'updated_at',
'vendor_id': 'vendor_id'
}
def __init__(self, account_id=None, auto_update=None, bootstrap_expiration_date=None, bootstrapped_timestamp=None, ca_id=None, connector_expiration_date=None, created_at=None, custom_attributes=None, deployed_state=None, deployment=None, description=None, device_class=None, device_execution_mode=None, device_key=None, endpoint_name=None, endpoint_type=None, enrolment_list_timestamp=None, etag=None, firmware_checksum=None, host_gateway=None, id=None, manifest=None, manifest_timestamp=None, mechanism=None, mechanism_url=None, name=None, serial_number=None, state=None, updated_at=None, vendor_id=None):
"""
DeviceEqNeqFilter - a model defined in Swagger
"""
self._account_id = account_id
self._auto_update = auto_update
self._bootstrap_expiration_date = bootstrap_expiration_date
self._bootstrapped_timestamp = bootstrapped_timestamp
self._ca_id = ca_id
self._connector_expiration_date = connector_expiration_date
self._created_at = created_at
self._custom_attributes = custom_attributes
self._deployed_state = deployed_state
self._deployment = deployment
self._description = description
self._device_class = device_class
self._device_execution_mode = device_execution_mode
self._device_key = device_key
self._endpoint_name = endpoint_name
self._endpoint_type = endpoint_type
self._enrolment_list_timestamp = enrolment_list_timestamp
self._etag = etag
self._firmware_checksum = firmware_checksum
self._host_gateway = host_gateway
self._id = id
self._manifest = manifest
self._manifest_timestamp = manifest_timestamp
self._mechanism = mechanism
self._mechanism_url = mechanism_url
self._name = name
self._serial_number = serial_number
self._state = state
self._updated_at = updated_at
self._vendor_id = vendor_id
self.discriminator = None
@property
def account_id(self):
"""
Gets the account_id of this DeviceEqNeqFilter.
:return: The account_id of this DeviceEqNeqFilter.
:rtype: str
"""
return self._account_id
@account_id.setter
def account_id(self, account_id):
"""
Sets the account_id of this DeviceEqNeqFilter.
:param account_id: The account_id of this DeviceEqNeqFilter.
:type: str
"""
self._account_id = account_id
@property
def auto_update(self):
"""
Gets the auto_update of this DeviceEqNeqFilter.
:return: The auto_update of this DeviceEqNeqFilter.
:rtype: bool
"""
return self._auto_update
@auto_update.setter
def auto_update(self, auto_update):
"""
Sets the auto_update of this DeviceEqNeqFilter.
:param auto_update: The auto_update of this DeviceEqNeqFilter.
:type: bool
"""
self._auto_update = auto_update
@property
def bootstrap_expiration_date(self):
"""
Gets the bootstrap_expiration_date of this DeviceEqNeqFilter.
:return: The bootstrap_expiration_date of this DeviceEqNeqFilter.
:rtype: datetime
"""
return self._bootstrap_expiration_date
@bootstrap_expiration_date.setter
def bootstrap_expiration_date(self, bootstrap_expiration_date):
"""
Sets the bootstrap_expiration_date of this DeviceEqNeqFilter.
:param bootstrap_expiration_date: The bootstrap_expiration_date of this DeviceEqNeqFilter.
:type: datetime
"""
self._bootstrap_expiration_date = bootstrap_expiration_date
@property
def bootstrapped_timestamp(self):
"""
Gets the bootstrapped_timestamp of this DeviceEqNeqFilter.
:return: The bootstrapped_timestamp of this DeviceEqNeqFilter.
:rtype: datetime
"""
return self._bootstrapped_timestamp
@bootstrapped_timestamp.setter
def bootstrapped_timestamp(self, bootstrapped_timestamp):
"""
Sets the bootstrapped_timestamp of this DeviceEqNeqFilter.
:param bootstrapped_timestamp: The bootstrapped_timestamp of this DeviceEqNeqFilter.
:type: datetime
"""
self._bootstrapped_timestamp = bootstrapped_timestamp
@property
def ca_id(self):
"""
Gets the ca_id of this DeviceEqNeqFilter.
:return: The ca_id of this DeviceEqNeqFilter.
:rtype: str
"""
return self._ca_id
@ca_id.setter
def ca_id(self, ca_id):
"""
Sets the ca_id of this DeviceEqNeqFilter.
:param ca_id: The ca_id of this DeviceEqNeqFilter.
:type: str
"""
self._ca_id = ca_id
@property
def connector_expiration_date(self):
"""
Gets the connector_expiration_date of this DeviceEqNeqFilter.
:return: The connector_expiration_date of this DeviceEqNeqFilter.
:rtype: datetime
"""
return self._connector_expiration_date
@connector_expiration_date.setter
def connector_expiration_date(self, connector_expiration_date):
"""
Sets the connector_expiration_date of this DeviceEqNeqFilter.
:param connector_expiration_date: The connector_expiration_date of this DeviceEqNeqFilter.
:type: datetime
"""
self._connector_expiration_date = connector_expiration_date
@property
def created_at(self):
"""
Gets the created_at of this DeviceEqNeqFilter.
:return: The created_at of this DeviceEqNeqFilter.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeviceEqNeqFilter.
:param created_at: The created_at of this DeviceEqNeqFilter.
:type: datetime
"""
self._created_at = created_at
@property
def custom_attributes(self):
"""
Gets the custom_attributes of this DeviceEqNeqFilter.
:return: The custom_attributes of this DeviceEqNeqFilter.
:rtype: dict(str, str)
"""
return self._custom_attributes
@custom_attributes.setter
def custom_attributes(self, custom_attributes):
"""
Sets the custom_attributes of this DeviceEqNeqFilter.
:param custom_attributes: The custom_attributes of this DeviceEqNeqFilter.
:type: dict(str, str)
"""
self._custom_attributes = custom_attributes
@property
def deployed_state(self):
"""
Gets the deployed_state of this DeviceEqNeqFilter.
:return: The deployed_state of this DeviceEqNeqFilter.
:rtype: str
"""
return self._deployed_state
@deployed_state.setter
def deployed_state(self, deployed_state):
"""
Sets the deployed_state of this DeviceEqNeqFilter.
:param deployed_state: The deployed_state of this DeviceEqNeqFilter.
:type: str
"""
self._deployed_state = deployed_state
@property
def deployment(self):
"""
Gets the deployment of this DeviceEqNeqFilter.
:return: The deployment of this DeviceEqNeqFilter.
:rtype: str
"""
return self._deployment
@deployment.setter
def deployment(self, deployment):
"""
Sets the deployment of this DeviceEqNeqFilter.
:param deployment: The deployment of this DeviceEqNeqFilter.
:type: str
"""
self._deployment = deployment
@property
def description(self):
"""
Gets the description of this DeviceEqNeqFilter.
:return: The description of this DeviceEqNeqFilter.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeviceEqNeqFilter.
:param description: The description of this DeviceEqNeqFilter.
:type: str
"""
self._description = description
@property
def device_class(self):
"""
Gets the device_class of this DeviceEqNeqFilter.
:return: The device_class of this DeviceEqNeqFilter.
:rtype: str
"""
return self._device_class
@device_class.setter
def device_class(self, device_class):
"""
Sets the device_class of this DeviceEqNeqFilter.
:param device_class: The device_class of this DeviceEqNeqFilter.
:type: str
"""
self._device_class = device_class
@property
def device_execution_mode(self):
"""
Gets the device_execution_mode of this DeviceEqNeqFilter.
:return: The device_execution_mode of this DeviceEqNeqFilter.
:rtype: int
"""
return self._device_execution_mode
@device_execution_mode.setter
def device_execution_mode(self, device_execution_mode):
"""
Sets the device_execution_mode of this DeviceEqNeqFilter.
:param device_execution_mode: The device_execution_mode of this DeviceEqNeqFilter.
:type: int
"""
self._device_execution_mode = device_execution_mode
@property
def device_key(self):
"""
Gets the device_key of this DeviceEqNeqFilter.
:return: The device_key of this DeviceEqNeqFilter.
:rtype: str
"""
return self._device_key
@device_key.setter
def device_key(self, device_key):
"""
Sets the device_key of this DeviceEqNeqFilter.
:param device_key: The device_key of this DeviceEqNeqFilter.
:type: str
"""
self._device_key = device_key
@property
def endpoint_name(self):
"""
Gets the endpoint_name of this DeviceEqNeqFilter.
:return: The endpoint_name of this DeviceEqNeqFilter.
:rtype: str
"""
return self._endpoint_name
@endpoint_name.setter
def endpoint_name(self, endpoint_name):
"""
Sets the endpoint_name of this DeviceEqNeqFilter.
:param endpoint_name: The endpoint_name of this DeviceEqNeqFilter.
:type: str
"""
self._endpoint_name = endpoint_name
@property
def endpoint_type(self):
"""
Gets the endpoint_type of this DeviceEqNeqFilter.
:return: The endpoint_type of this DeviceEqNeqFilter.
:rtype: str
"""
return self._endpoint_type
@endpoint_type.setter
def endpoint_type(self, endpoint_type):
"""
Sets the endpoint_type of this DeviceEqNeqFilter.
:param endpoint_type: The endpoint_type of this DeviceEqNeqFilter.
:type: str
"""
self._endpoint_type = endpoint_type
@property
def enrolment_list_timestamp(self):
"""
Gets the enrolment_list_timestamp of this DeviceEqNeqFilter.
:return: The enrolment_list_timestamp of this DeviceEqNeqFilter.
:rtype: datetime
"""
return self._enrolment_list_timestamp
@enrolment_list_timestamp.setter
def enrolment_list_timestamp(self, enrolment_list_timestamp):
"""
Sets the enrolment_list_timestamp of this DeviceEqNeqFilter.
:param enrolment_list_timestamp: The enrolment_list_timestamp of this DeviceEqNeqFilter.
:type: datetime
"""
self._enrolment_list_timestamp = enrolment_list_timestamp
@property
def etag(self):
"""
Gets the etag of this DeviceEqNeqFilter.
:return: The etag of this DeviceEqNeqFilter.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeviceEqNeqFilter.
:param etag: The etag of this DeviceEqNeqFilter.
:type: datetime
"""
self._etag = etag
@property
def firmware_checksum(self):
"""
Gets the firmware_checksum of this DeviceEqNeqFilter.
:return: The firmware_checksum of this DeviceEqNeqFilter.
:rtype: str
"""
return self._firmware_checksum
@firmware_checksum.setter
def firmware_checksum(self, firmware_checksum):
"""
Sets the firmware_checksum of this DeviceEqNeqFilter.
:param firmware_checksum: The firmware_checksum of this DeviceEqNeqFilter.
:type: str
"""
self._firmware_checksum = firmware_checksum
@property
def host_gateway(self):
"""
Gets the host_gateway of this DeviceEqNeqFilter.
:return: The host_gateway of this DeviceEqNeqFilter.
:rtype: str
"""
return self._host_gateway
@host_gateway.setter
def host_gateway(self, host_gateway):
"""
Sets the host_gateway of this DeviceEqNeqFilter.
:param host_gateway: The host_gateway of this DeviceEqNeqFilter.
:type: str
"""
self._host_gateway = host_gateway
@property
def id(self):
"""
Gets the id of this DeviceEqNeqFilter.
:return: The id of this DeviceEqNeqFilter.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeviceEqNeqFilter.
:param id: The id of this DeviceEqNeqFilter.
:type: str
"""
self._id = id
@property
def manifest(self):
"""
Gets the manifest of this DeviceEqNeqFilter.
:return: The manifest of this DeviceEqNeqFilter.
:rtype: str
"""
return self._manifest
@manifest.setter
def manifest(self, manifest):
"""
Sets the manifest of this DeviceEqNeqFilter.
:param manifest: The manifest of this DeviceEqNeqFilter.
:type: str
"""
self._manifest = manifest
@property
def manifest_timestamp(self):
"""
Gets the manifest_timestamp of this DeviceEqNeqFilter.
:return: The manifest_timestamp of this DeviceEqNeqFilter.
:rtype: datetime
"""
return self._manifest_timestamp
@manifest_timestamp.setter
def manifest_timestamp(self, manifest_timestamp):
"""
Sets the manifest_timestamp of this DeviceEqNeqFilter.
:param manifest_timestamp: The manifest_timestamp of this DeviceEqNeqFilter.
:type: datetime
"""
self._manifest_timestamp = manifest_timestamp
@property
def mechanism(self):
"""
Gets the mechanism of this DeviceEqNeqFilter.
:return: The mechanism of this DeviceEqNeqFilter.
:rtype: str
"""
return self._mechanism
@mechanism.setter
def mechanism(self, mechanism):
"""
Sets the mechanism of this DeviceEqNeqFilter.
:param mechanism: The mechanism of this DeviceEqNeqFilter.
:type: str
"""
self._mechanism = mechanism
@property
def mechanism_url(self):
"""
Gets the mechanism_url of this DeviceEqNeqFilter.
:return: The mechanism_url of this DeviceEqNeqFilter.
:rtype: str
"""
return self._mechanism_url
@mechanism_url.setter
def mechanism_url(self, mechanism_url):
"""
Sets the mechanism_url of this DeviceEqNeqFilter.
:param mechanism_url: The mechanism_url of this DeviceEqNeqFilter.
:type: str
"""
self._mechanism_url = mechanism_url
@property
def name(self):
"""
Gets the name of this DeviceEqNeqFilter.
:return: The name of this DeviceEqNeqFilter.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceEqNeqFilter.
:param name: The name of this DeviceEqNeqFilter.
:type: str
"""
self._name = name
@property
def serial_number(self):
"""
Gets the serial_number of this DeviceEqNeqFilter.
:return: The serial_number of this DeviceEqNeqFilter.
:rtype: str
"""
return self._serial_number
@serial_number.setter
def serial_number(self, serial_number):
"""
Sets the serial_number of this DeviceEqNeqFilter.
:param serial_number: The serial_number of this DeviceEqNeqFilter.
:type: str
"""
self._serial_number = serial_number
@property
def state(self):
"""
Gets the state of this DeviceEqNeqFilter.
:return: The state of this DeviceEqNeqFilter.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this DeviceEqNeqFilter.
:param state: The state of this DeviceEqNeqFilter.
:type: str
"""
self._state = state
@property
def updated_at(self):
"""
Gets the updated_at of this DeviceEqNeqFilter.
:return: The updated_at of this DeviceEqNeqFilter.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this DeviceEqNeqFilter.
:param updated_at: The updated_at of this DeviceEqNeqFilter.
:type: datetime
"""
self._updated_at = updated_at
@property
def vendor_id(self):
"""
Gets the vendor_id of this DeviceEqNeqFilter.
:return: The vendor_id of this DeviceEqNeqFilter.
:rtype: str
"""
return self._vendor_id
@vendor_id.setter
def vendor_id(self, vendor_id):
"""
Sets the vendor_id of this DeviceEqNeqFilter.
:param vendor_id: The vendor_id of this DeviceEqNeqFilter.
:type: str
"""
self._vendor_id = vendor_id
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceEqNeqFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceEqNeqFilter(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, account_id=None, auto_update=None, bootstrap_expiration_date=None, bootstrapped_timestamp=None, ca_id=None, connector_expiration_date=None, created_at=None, custom_attributes=None, deployed_state=None, deployment=None, description=None, device_class=None, device_execution_mode=None, device_key=None, endpoint_name=None, endpoint_type=None, enrolment_list_timestamp=None, etag=None, firmware_checksum=None, host_gateway=None, id=None, manifest=None, manifest_timestamp=None, mechanism=None, mechanism_url=None, name=None, serial_number=None, state=None, updated_at=None, vendor_id=None):
'''
DeviceEqNeqFilter - a model defined in Swagger
'''
pass
@property
def account_id(self):
'''
Gets the account_id of this DeviceEqNeqFilter.
:return: The account_id of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@account_id.setter
def account_id(self):
'''
Sets the account_id of this DeviceEqNeqFilter.
:param account_id: The account_id of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def auto_update(self):
'''
Gets the auto_update of this DeviceEqNeqFilter.
:return: The auto_update of this DeviceEqNeqFilter.
:rtype: bool
'''
pass
@auto_update.setter
def auto_update(self):
'''
Sets the auto_update of this DeviceEqNeqFilter.
:param auto_update: The auto_update of this DeviceEqNeqFilter.
:type: bool
'''
pass
@property
def bootstrap_expiration_date(self):
'''
Gets the bootstrap_expiration_date of this DeviceEqNeqFilter.
:return: The bootstrap_expiration_date of this DeviceEqNeqFilter.
:rtype: datetime
'''
pass
@bootstrap_expiration_date.setter
def bootstrap_expiration_date(self):
'''
Sets the bootstrap_expiration_date of this DeviceEqNeqFilter.
:param bootstrap_expiration_date: The bootstrap_expiration_date of this DeviceEqNeqFilter.
:type: datetime
'''
pass
@property
def bootstrapped_timestamp(self):
'''
Gets the bootstrapped_timestamp of this DeviceEqNeqFilter.
:return: The bootstrapped_timestamp of this DeviceEqNeqFilter.
:rtype: datetime
'''
pass
@bootstrapped_timestamp.setter
def bootstrapped_timestamp(self):
'''
Sets the bootstrapped_timestamp of this DeviceEqNeqFilter.
:param bootstrapped_timestamp: The bootstrapped_timestamp of this DeviceEqNeqFilter.
:type: datetime
'''
pass
@property
def ca_id(self):
'''
Gets the ca_id of this DeviceEqNeqFilter.
:return: The ca_id of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@ca_id.setter
def ca_id(self):
'''
Sets the ca_id of this DeviceEqNeqFilter.
:param ca_id: The ca_id of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def connector_expiration_date(self):
'''
Gets the connector_expiration_date of this DeviceEqNeqFilter.
:return: The connector_expiration_date of this DeviceEqNeqFilter.
:rtype: datetime
'''
pass
@connector_expiration_date.setter
def connector_expiration_date(self):
'''
Sets the connector_expiration_date of this DeviceEqNeqFilter.
:param connector_expiration_date: The connector_expiration_date of this DeviceEqNeqFilter.
:type: datetime
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeviceEqNeqFilter.
:return: The created_at of this DeviceEqNeqFilter.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeviceEqNeqFilter.
:param created_at: The created_at of this DeviceEqNeqFilter.
:type: datetime
'''
pass
@property
def custom_attributes(self):
'''
Gets the custom_attributes of this DeviceEqNeqFilter.
:return: The custom_attributes of this DeviceEqNeqFilter.
:rtype: dict(str, str)
'''
pass
@custom_attributes.setter
def custom_attributes(self):
'''
Sets the custom_attributes of this DeviceEqNeqFilter.
:param custom_attributes: The custom_attributes of this DeviceEqNeqFilter.
:type: dict(str, str)
'''
pass
@property
def deployed_state(self):
'''
Gets the deployed_state of this DeviceEqNeqFilter.
:return: The deployed_state of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@deployed_state.setter
def deployed_state(self):
'''
Sets the deployed_state of this DeviceEqNeqFilter.
:param deployed_state: The deployed_state of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def deployment(self):
'''
Gets the deployment of this DeviceEqNeqFilter.
:return: The deployment of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@deployment.setter
def deployment(self):
'''
Sets the deployment of this DeviceEqNeqFilter.
:param deployment: The deployment of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def description(self):
'''
Gets the description of this DeviceEqNeqFilter.
:return: The description of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeviceEqNeqFilter.
:param description: The description of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def device_class(self):
'''
Gets the device_class of this DeviceEqNeqFilter.
:return: The device_class of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@device_class.setter
def device_class(self):
'''
Sets the device_class of this DeviceEqNeqFilter.
:param device_class: The device_class of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def device_execution_mode(self):
'''
Gets the device_execution_mode of this DeviceEqNeqFilter.
:return: The device_execution_mode of this DeviceEqNeqFilter.
:rtype: int
'''
pass
@device_execution_mode.setter
def device_execution_mode(self):
'''
Sets the device_execution_mode of this DeviceEqNeqFilter.
:param device_execution_mode: The device_execution_mode of this DeviceEqNeqFilter.
:type: int
'''
pass
@property
def device_key(self):
'''
Gets the device_key of this DeviceEqNeqFilter.
:return: The device_key of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@device_key.setter
def device_key(self):
'''
Sets the device_key of this DeviceEqNeqFilter.
:param device_key: The device_key of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def endpoint_name(self):
'''
Gets the endpoint_name of this DeviceEqNeqFilter.
:return: The endpoint_name of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@endpoint_name.setter
def endpoint_name(self):
'''
Sets the endpoint_name of this DeviceEqNeqFilter.
:param endpoint_name: The endpoint_name of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def endpoint_type(self):
'''
Gets the endpoint_type of this DeviceEqNeqFilter.
:return: The endpoint_type of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@endpoint_type.setter
def endpoint_type(self):
'''
Sets the endpoint_type of this DeviceEqNeqFilter.
:param endpoint_type: The endpoint_type of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def enrolment_list_timestamp(self):
'''
Gets the enrolment_list_timestamp of this DeviceEqNeqFilter.
:return: The enrolment_list_timestamp of this DeviceEqNeqFilter.
:rtype: datetime
'''
pass
@enrolment_list_timestamp.setter
def enrolment_list_timestamp(self):
'''
Sets the enrolment_list_timestamp of this DeviceEqNeqFilter.
:param enrolment_list_timestamp: The enrolment_list_timestamp of this DeviceEqNeqFilter.
:type: datetime
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeviceEqNeqFilter.
:return: The etag of this DeviceEqNeqFilter.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeviceEqNeqFilter.
:param etag: The etag of this DeviceEqNeqFilter.
:type: datetime
'''
pass
@property
def firmware_checksum(self):
'''
Gets the firmware_checksum of this DeviceEqNeqFilter.
:return: The firmware_checksum of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@firmware_checksum.setter
def firmware_checksum(self):
'''
Sets the firmware_checksum of this DeviceEqNeqFilter.
:param firmware_checksum: The firmware_checksum of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def host_gateway(self):
'''
Gets the host_gateway of this DeviceEqNeqFilter.
:return: The host_gateway of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@host_gateway.setter
def host_gateway(self):
'''
Sets the host_gateway of this DeviceEqNeqFilter.
:param host_gateway: The host_gateway of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this DeviceEqNeqFilter.
:return: The id of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeviceEqNeqFilter.
:param id: The id of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def manifest(self):
'''
Gets the manifest of this DeviceEqNeqFilter.
:return: The manifest of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@manifest.setter
def manifest(self):
'''
Sets the manifest of this DeviceEqNeqFilter.
:param manifest: The manifest of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def manifest_timestamp(self):
'''
Gets the manifest_timestamp of this DeviceEqNeqFilter.
:return: The manifest_timestamp of this DeviceEqNeqFilter.
:rtype: datetime
'''
pass
@manifest_timestamp.setter
def manifest_timestamp(self):
'''
Sets the manifest_timestamp of this DeviceEqNeqFilter.
:param manifest_timestamp: The manifest_timestamp of this DeviceEqNeqFilter.
:type: datetime
'''
pass
@property
def mechanism(self):
'''
Gets the mechanism of this DeviceEqNeqFilter.
:return: The mechanism of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@mechanism.setter
def mechanism(self):
'''
Sets the mechanism of this DeviceEqNeqFilter.
:param mechanism: The mechanism of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def mechanism_url(self):
'''
Gets the mechanism_url of this DeviceEqNeqFilter.
:return: The mechanism_url of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@mechanism_url.setter
def mechanism_url(self):
'''
Sets the mechanism_url of this DeviceEqNeqFilter.
:param mechanism_url: The mechanism_url of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceEqNeqFilter.
:return: The name of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceEqNeqFilter.
:param name: The name of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def serial_number(self):
'''
Gets the serial_number of this DeviceEqNeqFilter.
:return: The serial_number of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@serial_number.setter
def serial_number(self):
'''
Sets the serial_number of this DeviceEqNeqFilter.
:param serial_number: The serial_number of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this DeviceEqNeqFilter.
:return: The state of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this DeviceEqNeqFilter.
:param state: The state of this DeviceEqNeqFilter.
:type: str
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this DeviceEqNeqFilter.
:return: The updated_at of this DeviceEqNeqFilter.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this DeviceEqNeqFilter.
:param updated_at: The updated_at of this DeviceEqNeqFilter.
:type: datetime
'''
pass
@property
def vendor_id(self):
'''
Gets the vendor_id of this DeviceEqNeqFilter.
:return: The vendor_id of this DeviceEqNeqFilter.
:rtype: str
'''
pass
@vendor_id.setter
def vendor_id(self):
'''
Sets the vendor_id of this DeviceEqNeqFilter.
:param vendor_id: The vendor_id of this DeviceEqNeqFilter.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 127 | 67 | 9 | 1 | 3 | 5 | 1 | 1.07 | 1 | 3 | 0 | 0 | 66 | 31 | 66 | 66 | 799 | 163 | 307 | 163 | 180 | 329 | 175 | 103 | 108 | 5 | 1 | 2 | 71 |
2,475 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_data_put_request.py
|
mbed_cloud._backends.device_directory.models.device_data_put_request.DeviceDataPutRequest
|
class DeviceDataPutRequest(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 = {
'auto_update': 'bool',
'ca_id': 'str',
'custom_attributes': 'dict(str, str)',
'description': 'str',
'device_key': 'str',
'endpoint_name': 'str',
'endpoint_type': 'str',
'groups': 'list[str]',
'host_gateway': 'str',
'name': 'str',
'object': 'str'
}
attribute_map = {
'auto_update': 'auto_update',
'ca_id': 'ca_id',
'custom_attributes': 'custom_attributes',
'description': 'description',
'device_key': 'device_key',
'endpoint_name': 'endpoint_name',
'endpoint_type': 'endpoint_type',
'groups': 'groups',
'host_gateway': 'host_gateway',
'name': 'name',
'object': 'object'
}
def __init__(self, auto_update=None, ca_id=None, custom_attributes=None, description=None, device_key=None, endpoint_name=None, endpoint_type=None, groups=None, host_gateway=None, name=None, object=None):
"""
DeviceDataPutRequest - a model defined in Swagger
"""
self._auto_update = auto_update
self._ca_id = ca_id
self._custom_attributes = custom_attributes
self._description = description
self._device_key = device_key
self._endpoint_name = endpoint_name
self._endpoint_type = endpoint_type
self._groups = groups
self._host_gateway = host_gateway
self._name = name
self._object = object
self.discriminator = None
@property
def auto_update(self):
"""
Gets the auto_update of this DeviceDataPutRequest.
DEPRECATED: Mark this device for automatic firmware update.
:return: The auto_update of this DeviceDataPutRequest.
:rtype: bool
"""
return self._auto_update
@auto_update.setter
def auto_update(self, auto_update):
"""
Sets the auto_update of this DeviceDataPutRequest.
DEPRECATED: Mark this device for automatic firmware update.
:param auto_update: The auto_update of this DeviceDataPutRequest.
:type: bool
"""
self._auto_update = auto_update
@property
def ca_id(self):
"""
Gets the ca_id of this DeviceDataPutRequest.
The certificate issuer's ID.
:return: The ca_id of this DeviceDataPutRequest.
:rtype: str
"""
return self._ca_id
@ca_id.setter
def ca_id(self, ca_id):
"""
Sets the ca_id of this DeviceDataPutRequest.
The certificate issuer's ID.
:param ca_id: The ca_id of this DeviceDataPutRequest.
:type: str
"""
if ca_id is not None and len(ca_id) > 500:
raise ValueError("Invalid value for `ca_id`, length must be less than or equal to `500`")
self._ca_id = ca_id
@property
def custom_attributes(self):
"""
Gets the custom_attributes of this DeviceDataPutRequest.
Up to five custom key-value attributes. Note that keys cannot start with a number. Both keys and values are limited to 128 characters.
:return: The custom_attributes of this DeviceDataPutRequest.
:rtype: dict(str, str)
"""
return self._custom_attributes
@custom_attributes.setter
def custom_attributes(self, custom_attributes):
"""
Sets the custom_attributes of this DeviceDataPutRequest.
Up to five custom key-value attributes. Note that keys cannot start with a number. Both keys and values are limited to 128 characters.
:param custom_attributes: The custom_attributes of this DeviceDataPutRequest.
:type: dict(str, str)
"""
self._custom_attributes = custom_attributes
@property
def description(self):
"""
Gets the description of this DeviceDataPutRequest.
The description of the device.
:return: The description of this DeviceDataPutRequest.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeviceDataPutRequest.
The description of the device.
:param description: The description of this DeviceDataPutRequest.
:type: str
"""
if description is not None and len(description) > 2000:
raise ValueError("Invalid value for `description`, length must be less than or equal to `2000`")
self._description = description
@property
def device_key(self):
"""
Gets the device_key of this DeviceDataPutRequest.
The fingerprint of the device certificate.
:return: The device_key of this DeviceDataPutRequest.
:rtype: str
"""
return self._device_key
@device_key.setter
def device_key(self, device_key):
"""
Sets the device_key of this DeviceDataPutRequest.
The fingerprint of the device certificate.
:param device_key: The device_key of this DeviceDataPutRequest.
:type: str
"""
if device_key is not None and len(device_key) > 512:
raise ValueError("Invalid value for `device_key`, length must be less than or equal to `512`")
self._device_key = device_key
@property
def endpoint_name(self):
"""
Gets the endpoint_name of this DeviceDataPutRequest.
The endpoint name given to the device.
:return: The endpoint_name of this DeviceDataPutRequest.
:rtype: str
"""
return self._endpoint_name
@endpoint_name.setter
def endpoint_name(self, endpoint_name):
"""
Sets the endpoint_name of this DeviceDataPutRequest.
The endpoint name given to the device.
:param endpoint_name: The endpoint_name of this DeviceDataPutRequest.
:type: str
"""
if endpoint_name is not None and len(endpoint_name) > 64:
raise ValueError("Invalid value for `endpoint_name`, length must be less than or equal to `64`")
self._endpoint_name = endpoint_name
@property
def endpoint_type(self):
"""
Gets the endpoint_type of this DeviceDataPutRequest.
The endpoint type of the device. For example, the device is a gateway.
:return: The endpoint_type of this DeviceDataPutRequest.
:rtype: str
"""
return self._endpoint_type
@endpoint_type.setter
def endpoint_type(self, endpoint_type):
"""
Sets the endpoint_type of this DeviceDataPutRequest.
The endpoint type of the device. For example, the device is a gateway.
:param endpoint_type: The endpoint_type of this DeviceDataPutRequest.
:type: str
"""
if endpoint_type is not None and len(endpoint_type) > 64:
raise ValueError("Invalid value for `endpoint_type`, length must be less than or equal to `64`")
self._endpoint_type = endpoint_type
@property
def groups(self):
"""
Gets the groups of this DeviceDataPutRequest.
An array containing an id of each group this device belongs to
:return: The groups of this DeviceDataPutRequest.
:rtype: list[str]
"""
return self._groups
@groups.setter
def groups(self, groups):
"""
Sets the groups of this DeviceDataPutRequest.
An array containing an id of each group this device belongs to
:param groups: The groups of this DeviceDataPutRequest.
:type: list[str]
"""
self._groups = groups
@property
def host_gateway(self):
"""
Gets the host_gateway of this DeviceDataPutRequest.
The `endpoint_name` of the host gateway, if appropriate.
:return: The host_gateway of this DeviceDataPutRequest.
:rtype: str
"""
return self._host_gateway
@host_gateway.setter
def host_gateway(self, host_gateway):
"""
Sets the host_gateway of this DeviceDataPutRequest.
The `endpoint_name` of the host gateway, if appropriate.
:param host_gateway: The host_gateway of this DeviceDataPutRequest.
:type: str
"""
self._host_gateway = host_gateway
@property
def name(self):
"""
Gets the name of this DeviceDataPutRequest.
The name of the device.
:return: The name of this DeviceDataPutRequest.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceDataPutRequest.
The name of the device.
:param name: The name of this DeviceDataPutRequest.
:type: str
"""
if name is not None and len(name) > 128:
raise ValueError("Invalid value for `name`, length must be less than or equal to `128`")
self._name = name
@property
def object(self):
"""
Gets the object of this DeviceDataPutRequest.
The API resource entity.
:return: The object of this DeviceDataPutRequest.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DeviceDataPutRequest.
The API resource entity.
:param object: The object of this DeviceDataPutRequest.
:type: str
"""
self._object = object
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceDataPutRequest):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceDataPutRequest(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, auto_update=None, ca_id=None, custom_attributes=None, description=None, device_key=None, endpoint_name=None, endpoint_type=None, groups=None, host_gateway=None, name=None, object=None):
'''
DeviceDataPutRequest - a model defined in Swagger
'''
pass
@property
def auto_update(self):
'''
Gets the auto_update of this DeviceDataPutRequest.
DEPRECATED: Mark this device for automatic firmware update.
:return: The auto_update of this DeviceDataPutRequest.
:rtype: bool
'''
pass
@auto_update.setter
def auto_update(self):
'''
Sets the auto_update of this DeviceDataPutRequest.
DEPRECATED: Mark this device for automatic firmware update.
:param auto_update: The auto_update of this DeviceDataPutRequest.
:type: bool
'''
pass
@property
def ca_id(self):
'''
Gets the ca_id of this DeviceDataPutRequest.
The certificate issuer's ID.
:return: The ca_id of this DeviceDataPutRequest.
:rtype: str
'''
pass
@ca_id.setter
def ca_id(self):
'''
Sets the ca_id of this DeviceDataPutRequest.
The certificate issuer's ID.
:param ca_id: The ca_id of this DeviceDataPutRequest.
:type: str
'''
pass
@property
def custom_attributes(self):
'''
Gets the custom_attributes of this DeviceDataPutRequest.
Up to five custom key-value attributes. Note that keys cannot start with a number. Both keys and values are limited to 128 characters.
:return: The custom_attributes of this DeviceDataPutRequest.
:rtype: dict(str, str)
'''
pass
@custom_attributes.setter
def custom_attributes(self):
'''
Sets the custom_attributes of this DeviceDataPutRequest.
Up to five custom key-value attributes. Note that keys cannot start with a number. Both keys and values are limited to 128 characters.
:param custom_attributes: The custom_attributes of this DeviceDataPutRequest.
:type: dict(str, str)
'''
pass
@property
def description(self):
'''
Gets the description of this DeviceDataPutRequest.
The description of the device.
:return: The description of this DeviceDataPutRequest.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeviceDataPutRequest.
The description of the device.
:param description: The description of this DeviceDataPutRequest.
:type: str
'''
pass
@property
def device_key(self):
'''
Gets the device_key of this DeviceDataPutRequest.
The fingerprint of the device certificate.
:return: The device_key of this DeviceDataPutRequest.
:rtype: str
'''
pass
@device_key.setter
def device_key(self):
'''
Sets the device_key of this DeviceDataPutRequest.
The fingerprint of the device certificate.
:param device_key: The device_key of this DeviceDataPutRequest.
:type: str
'''
pass
@property
def endpoint_name(self):
'''
Gets the endpoint_name of this DeviceDataPutRequest.
The endpoint name given to the device.
:return: The endpoint_name of this DeviceDataPutRequest.
:rtype: str
'''
pass
@endpoint_name.setter
def endpoint_name(self):
'''
Sets the endpoint_name of this DeviceDataPutRequest.
The endpoint name given to the device.
:param endpoint_name: The endpoint_name of this DeviceDataPutRequest.
:type: str
'''
pass
@property
def endpoint_type(self):
'''
Gets the endpoint_type of this DeviceDataPutRequest.
The endpoint type of the device. For example, the device is a gateway.
:return: The endpoint_type of this DeviceDataPutRequest.
:rtype: str
'''
pass
@endpoint_type.setter
def endpoint_type(self):
'''
Sets the endpoint_type of this DeviceDataPutRequest.
The endpoint type of the device. For example, the device is a gateway.
:param endpoint_type: The endpoint_type of this DeviceDataPutRequest.
:type: str
'''
pass
@property
def groups(self):
'''
Gets the groups of this DeviceDataPutRequest.
An array containing an id of each group this device belongs to
:return: The groups of this DeviceDataPutRequest.
:rtype: list[str]
'''
pass
@groups.setter
def groups(self):
'''
Sets the groups of this DeviceDataPutRequest.
An array containing an id of each group this device belongs to
:param groups: The groups of this DeviceDataPutRequest.
:type: list[str]
'''
pass
@property
def host_gateway(self):
'''
Gets the host_gateway of this DeviceDataPutRequest.
The `endpoint_name` of the host gateway, if appropriate.
:return: The host_gateway of this DeviceDataPutRequest.
:rtype: str
'''
pass
@host_gateway.setter
def host_gateway(self):
'''
Sets the host_gateway of this DeviceDataPutRequest.
The `endpoint_name` of the host gateway, if appropriate.
:param host_gateway: The host_gateway of this DeviceDataPutRequest.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceDataPutRequest.
The name of the device.
:return: The name of this DeviceDataPutRequest.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceDataPutRequest.
The name of the device.
:param name: The name of this DeviceDataPutRequest.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this DeviceDataPutRequest.
The API resource entity.
:return: The object of this DeviceDataPutRequest.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DeviceDataPutRequest.
The API resource entity.
:param object: The object of this DeviceDataPutRequest.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 51 | 29 | 10 | 1 | 4 | 5 | 1 | 1.09 | 1 | 4 | 0 | 0 | 28 | 12 | 28 | 28 | 377 | 68 | 148 | 68 | 97 | 161 | 92 | 46 | 63 | 5 | 1 | 2 | 39 |
2,476 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_data_post_request.py
|
mbed_cloud._backends.device_directory.models.device_data_post_request.DeviceDataPostRequest
|
class DeviceDataPostRequest(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 = {
'auto_update': 'bool',
'bootstrap_expiration_date': 'datetime',
'bootstrapped_timestamp': 'datetime',
'ca_id': 'str',
'connector_expiration_date': 'datetime',
'custom_attributes': 'dict(str, str)',
'deployment': 'str',
'description': 'str',
'device_class': 'str',
'device_execution_mode': 'int',
'device_key': 'str',
'endpoint_name': 'str',
'endpoint_type': 'str',
'firmware_checksum': 'str',
'groups': 'list[str]',
'host_gateway': 'str',
'manifest': 'str',
'mechanism': 'str',
'mechanism_url': 'str',
'name': 'str',
'object': 'str',
'serial_number': 'str',
'state': 'str',
'vendor_id': 'str'
}
attribute_map = {
'auto_update': 'auto_update',
'bootstrap_expiration_date': 'bootstrap_expiration_date',
'bootstrapped_timestamp': 'bootstrapped_timestamp',
'ca_id': 'ca_id',
'connector_expiration_date': 'connector_expiration_date',
'custom_attributes': 'custom_attributes',
'deployment': 'deployment',
'description': 'description',
'device_class': 'device_class',
'device_execution_mode': 'device_execution_mode',
'device_key': 'device_key',
'endpoint_name': 'endpoint_name',
'endpoint_type': 'endpoint_type',
'firmware_checksum': 'firmware_checksum',
'groups': 'groups',
'host_gateway': 'host_gateway',
'manifest': 'manifest',
'mechanism': 'mechanism',
'mechanism_url': 'mechanism_url',
'name': 'name',
'object': 'object',
'serial_number': 'serial_number',
'state': 'state',
'vendor_id': 'vendor_id'
}
def __init__(self, auto_update=None, bootstrap_expiration_date=None, bootstrapped_timestamp=None, ca_id=None, connector_expiration_date=None, custom_attributes=None, deployment=None, description=None, device_class=None, device_execution_mode=None, device_key=None, endpoint_name=None, endpoint_type=None, firmware_checksum=None, groups=None, host_gateway=None, manifest=None, mechanism=None, mechanism_url=None, name=None, object=None, serial_number=None, state=None, vendor_id=None):
"""
DeviceDataPostRequest - a model defined in Swagger
"""
self._auto_update = auto_update
self._bootstrap_expiration_date = bootstrap_expiration_date
self._bootstrapped_timestamp = bootstrapped_timestamp
self._ca_id = ca_id
self._connector_expiration_date = connector_expiration_date
self._custom_attributes = custom_attributes
self._deployment = deployment
self._description = description
self._device_class = device_class
self._device_execution_mode = device_execution_mode
self._device_key = device_key
self._endpoint_name = endpoint_name
self._endpoint_type = endpoint_type
self._firmware_checksum = firmware_checksum
self._groups = groups
self._host_gateway = host_gateway
self._manifest = manifest
self._mechanism = mechanism
self._mechanism_url = mechanism_url
self._name = name
self._object = object
self._serial_number = serial_number
self._state = state
self._vendor_id = vendor_id
self.discriminator = None
@property
def auto_update(self):
"""
Gets the auto_update of this DeviceDataPostRequest.
DEPRECATED: Mark this device for automatic firmware update.
:return: The auto_update of this DeviceDataPostRequest.
:rtype: bool
"""
return self._auto_update
@auto_update.setter
def auto_update(self, auto_update):
"""
Sets the auto_update of this DeviceDataPostRequest.
DEPRECATED: Mark this device for automatic firmware update.
:param auto_update: The auto_update of this DeviceDataPostRequest.
:type: bool
"""
self._auto_update = auto_update
@property
def bootstrap_expiration_date(self):
"""
Gets the bootstrap_expiration_date of this DeviceDataPostRequest.
The expiration date of the certificate used to connect to bootstrap server.
:return: The bootstrap_expiration_date of this DeviceDataPostRequest.
:rtype: datetime
"""
return self._bootstrap_expiration_date
@bootstrap_expiration_date.setter
def bootstrap_expiration_date(self, bootstrap_expiration_date):
"""
Sets the bootstrap_expiration_date of this DeviceDataPostRequest.
The expiration date of the certificate used to connect to bootstrap server.
:param bootstrap_expiration_date: The bootstrap_expiration_date of this DeviceDataPostRequest.
:type: datetime
"""
self._bootstrap_expiration_date = bootstrap_expiration_date
@property
def bootstrapped_timestamp(self):
"""
Gets the bootstrapped_timestamp of this DeviceDataPostRequest.
The timestamp of the device's most recent bootstrap process.
:return: The bootstrapped_timestamp of this DeviceDataPostRequest.
:rtype: datetime
"""
return self._bootstrapped_timestamp
@bootstrapped_timestamp.setter
def bootstrapped_timestamp(self, bootstrapped_timestamp):
"""
Sets the bootstrapped_timestamp of this DeviceDataPostRequest.
The timestamp of the device's most recent bootstrap process.
:param bootstrapped_timestamp: The bootstrapped_timestamp of this DeviceDataPostRequest.
:type: datetime
"""
self._bootstrapped_timestamp = bootstrapped_timestamp
@property
def ca_id(self):
"""
Gets the ca_id of this DeviceDataPostRequest.
The certificate issuer's ID.
:return: The ca_id of this DeviceDataPostRequest.
:rtype: str
"""
return self._ca_id
@ca_id.setter
def ca_id(self, ca_id):
"""
Sets the ca_id of this DeviceDataPostRequest.
The certificate issuer's ID.
:param ca_id: The ca_id of this DeviceDataPostRequest.
:type: str
"""
if ca_id is not None and len(ca_id) > 500:
raise ValueError("Invalid value for `ca_id`, length must be less than or equal to `500`")
self._ca_id = ca_id
@property
def connector_expiration_date(self):
"""
Gets the connector_expiration_date of this DeviceDataPostRequest.
The expiration date of the certificate used to connect to the LwM2M server.
:return: The connector_expiration_date of this DeviceDataPostRequest.
:rtype: datetime
"""
return self._connector_expiration_date
@connector_expiration_date.setter
def connector_expiration_date(self, connector_expiration_date):
"""
Sets the connector_expiration_date of this DeviceDataPostRequest.
The expiration date of the certificate used to connect to the LwM2M server.
:param connector_expiration_date: The connector_expiration_date of this DeviceDataPostRequest.
:type: datetime
"""
self._connector_expiration_date = connector_expiration_date
@property
def custom_attributes(self):
"""
Gets the custom_attributes of this DeviceDataPostRequest.
Up to five custom key-value attributes. Note that keys cannot start with a number. Both keys and values are limited to 128 characters.
:return: The custom_attributes of this DeviceDataPostRequest.
:rtype: dict(str, str)
"""
return self._custom_attributes
@custom_attributes.setter
def custom_attributes(self, custom_attributes):
"""
Sets the custom_attributes of this DeviceDataPostRequest.
Up to five custom key-value attributes. Note that keys cannot start with a number. Both keys and values are limited to 128 characters.
:param custom_attributes: The custom_attributes of this DeviceDataPostRequest.
:type: dict(str, str)
"""
self._custom_attributes = custom_attributes
@property
def deployment(self):
"""
Gets the deployment of this DeviceDataPostRequest.
DEPRECATED: The last deployment used on the device.
:return: The deployment of this DeviceDataPostRequest.
:rtype: str
"""
return self._deployment
@deployment.setter
def deployment(self, deployment):
"""
Sets the deployment of this DeviceDataPostRequest.
DEPRECATED: The last deployment used on the device.
:param deployment: The deployment of this DeviceDataPostRequest.
:type: str
"""
self._deployment = deployment
@property
def description(self):
"""
Gets the description of this DeviceDataPostRequest.
The description of the device.
:return: The description of this DeviceDataPostRequest.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeviceDataPostRequest.
The description of the device.
:param description: The description of this DeviceDataPostRequest.
:type: str
"""
if description is not None and len(description) > 2000:
raise ValueError("Invalid value for `description`, length must be less than or equal to `2000`")
self._description = description
@property
def device_class(self):
"""
Gets the device_class of this DeviceDataPostRequest.
An ID representing the model and hardware revision of the device.
:return: The device_class of this DeviceDataPostRequest.
:rtype: str
"""
return self._device_class
@device_class.setter
def device_class(self, device_class):
"""
Sets the device_class of this DeviceDataPostRequest.
An ID representing the model and hardware revision of the device.
:param device_class: The device_class of this DeviceDataPostRequest.
:type: str
"""
if device_class is not None and len(device_class) > 32:
raise ValueError("Invalid value for `device_class`, length must be less than or equal to `32`")
self._device_class = device_class
@property
def device_execution_mode(self):
"""
Gets the device_execution_mode of this DeviceDataPostRequest.
The execution mode from the certificate of the device. Permitted values: - 0 - unspecified execution mode (default) - 1 - development devices - 5 - production devices
:return: The device_execution_mode of this DeviceDataPostRequest.
:rtype: int
"""
return self._device_execution_mode
@device_execution_mode.setter
def device_execution_mode(self, device_execution_mode):
"""
Sets the device_execution_mode of this DeviceDataPostRequest.
The execution mode from the certificate of the device. Permitted values: - 0 - unspecified execution mode (default) - 1 - development devices - 5 - production devices
:param device_execution_mode: The device_execution_mode of this DeviceDataPostRequest.
:type: int
"""
self._device_execution_mode = device_execution_mode
@property
def device_key(self):
"""
Gets the device_key of this DeviceDataPostRequest.
The fingerprint of the device certificate.
:return: The device_key of this DeviceDataPostRequest.
:rtype: str
"""
return self._device_key
@device_key.setter
def device_key(self, device_key):
"""
Sets the device_key of this DeviceDataPostRequest.
The fingerprint of the device certificate.
:param device_key: The device_key of this DeviceDataPostRequest.
:type: str
"""
if device_key is not None and len(device_key) > 512:
raise ValueError("Invalid value for `device_key`, length must be less than or equal to `512`")
self._device_key = device_key
@property
def endpoint_name(self):
"""
Gets the endpoint_name of this DeviceDataPostRequest.
The endpoint name given to the device.
:return: The endpoint_name of this DeviceDataPostRequest.
:rtype: str
"""
return self._endpoint_name
@endpoint_name.setter
def endpoint_name(self, endpoint_name):
"""
Sets the endpoint_name of this DeviceDataPostRequest.
The endpoint name given to the device.
:param endpoint_name: The endpoint_name of this DeviceDataPostRequest.
:type: str
"""
if endpoint_name is not None and len(endpoint_name) > 64:
raise ValueError("Invalid value for `endpoint_name`, length must be less than or equal to `64`")
self._endpoint_name = endpoint_name
@property
def endpoint_type(self):
"""
Gets the endpoint_type of this DeviceDataPostRequest.
The endpoint type of the device. For example, the device is a gateway.
:return: The endpoint_type of this DeviceDataPostRequest.
:rtype: str
"""
return self._endpoint_type
@endpoint_type.setter
def endpoint_type(self, endpoint_type):
"""
Sets the endpoint_type of this DeviceDataPostRequest.
The endpoint type of the device. For example, the device is a gateway.
:param endpoint_type: The endpoint_type of this DeviceDataPostRequest.
:type: str
"""
if endpoint_type is not None and len(endpoint_type) > 64:
raise ValueError("Invalid value for `endpoint_type`, length must be less than or equal to `64`")
self._endpoint_type = endpoint_type
@property
def firmware_checksum(self):
"""
Gets the firmware_checksum of this DeviceDataPostRequest.
The SHA256 checksum of the current firmware image.
:return: The firmware_checksum of this DeviceDataPostRequest.
:rtype: str
"""
return self._firmware_checksum
@firmware_checksum.setter
def firmware_checksum(self, firmware_checksum):
"""
Sets the firmware_checksum of this DeviceDataPostRequest.
The SHA256 checksum of the current firmware image.
:param firmware_checksum: The firmware_checksum of this DeviceDataPostRequest.
:type: str
"""
if firmware_checksum is not None and len(firmware_checksum) > 64:
raise ValueError("Invalid value for `firmware_checksum`, length must be less than or equal to `64`")
self._firmware_checksum = firmware_checksum
@property
def groups(self):
"""
Gets the groups of this DeviceDataPostRequest.
An array containing an id of each group this device belongs to
:return: The groups of this DeviceDataPostRequest.
:rtype: list[str]
"""
return self._groups
@groups.setter
def groups(self, groups):
"""
Sets the groups of this DeviceDataPostRequest.
An array containing an id of each group this device belongs to
:param groups: The groups of this DeviceDataPostRequest.
:type: list[str]
"""
self._groups = groups
@property
def host_gateway(self):
"""
Gets the host_gateway of this DeviceDataPostRequest.
The `endpoint_name` of the host gateway, if appropriate.
:return: The host_gateway of this DeviceDataPostRequest.
:rtype: str
"""
return self._host_gateway
@host_gateway.setter
def host_gateway(self, host_gateway):
"""
Sets the host_gateway of this DeviceDataPostRequest.
The `endpoint_name` of the host gateway, if appropriate.
:param host_gateway: The host_gateway of this DeviceDataPostRequest.
:type: str
"""
self._host_gateway = host_gateway
@property
def manifest(self):
"""
Gets the manifest of this DeviceDataPostRequest.
DEPRECATED: The URL for the current device manifest.
:return: The manifest of this DeviceDataPostRequest.
:rtype: str
"""
return self._manifest
@manifest.setter
def manifest(self, manifest):
"""
Sets the manifest of this DeviceDataPostRequest.
DEPRECATED: The URL for the current device manifest.
:param manifest: The manifest of this DeviceDataPostRequest.
:type: str
"""
self._manifest = manifest
@property
def mechanism(self):
"""
Gets the mechanism of this DeviceDataPostRequest.
The ID of the channel used to communicate with the device.
:return: The mechanism of this DeviceDataPostRequest.
:rtype: str
"""
return self._mechanism
@mechanism.setter
def mechanism(self, mechanism):
"""
Sets the mechanism of this DeviceDataPostRequest.
The ID of the channel used to communicate with the device.
:param mechanism: The mechanism of this DeviceDataPostRequest.
:type: str
"""
allowed_values = ["connector", "direct"]
if mechanism not in allowed_values:
raise ValueError(
"Invalid value for `mechanism` ({0}), must be one of {1}"
.format(mechanism, allowed_values)
)
self._mechanism = mechanism
@property
def mechanism_url(self):
"""
Gets the mechanism_url of this DeviceDataPostRequest.
The address of the connector to use.
:return: The mechanism_url of this DeviceDataPostRequest.
:rtype: str
"""
return self._mechanism_url
@mechanism_url.setter
def mechanism_url(self, mechanism_url):
"""
Sets the mechanism_url of this DeviceDataPostRequest.
The address of the connector to use.
:param mechanism_url: The mechanism_url of this DeviceDataPostRequest.
:type: str
"""
self._mechanism_url = mechanism_url
@property
def name(self):
"""
Gets the name of this DeviceDataPostRequest.
The name of the device.
:return: The name of this DeviceDataPostRequest.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceDataPostRequest.
The name of the device.
:param name: The name of this DeviceDataPostRequest.
:type: str
"""
if name is not None and len(name) > 128:
raise ValueError("Invalid value for `name`, length must be less than or equal to `128`")
self._name = name
@property
def object(self):
"""
Gets the object of this DeviceDataPostRequest.
The API resource entity.
:return: The object of this DeviceDataPostRequest.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DeviceDataPostRequest.
The API resource entity.
:param object: The object of this DeviceDataPostRequest.
:type: str
"""
self._object = object
@property
def serial_number(self):
"""
Gets the serial_number of this DeviceDataPostRequest.
The serial number of the device.
:return: The serial_number of this DeviceDataPostRequest.
:rtype: str
"""
return self._serial_number
@serial_number.setter
def serial_number(self, serial_number):
"""
Sets the serial_number of this DeviceDataPostRequest.
The serial number of the device.
:param serial_number: The serial_number of this DeviceDataPostRequest.
:type: str
"""
if serial_number is not None and len(serial_number) > 64:
raise ValueError("Invalid value for `serial_number`, length must be less than or equal to `64`")
self._serial_number = serial_number
@property
def state(self):
"""
Gets the state of this DeviceDataPostRequest.
The current state of the device.
:return: The state of this DeviceDataPostRequest.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this DeviceDataPostRequest.
The current state of the device.
:param state: The state of this DeviceDataPostRequest.
:type: str
"""
allowed_values = ["unenrolled", "cloud_enrolling", "bootstrapped", "registered", "deregistered"]
if state not in allowed_values:
raise ValueError(
"Invalid value for `state` ({0}), must be one of {1}"
.format(state, allowed_values)
)
self._state = state
@property
def vendor_id(self):
"""
Gets the vendor_id of this DeviceDataPostRequest.
The device vendor ID.
:return: The vendor_id of this DeviceDataPostRequest.
:rtype: str
"""
return self._vendor_id
@vendor_id.setter
def vendor_id(self, vendor_id):
"""
Sets the vendor_id of this DeviceDataPostRequest.
The device vendor ID.
:param vendor_id: The vendor_id of this DeviceDataPostRequest.
:type: str
"""
if vendor_id is not None and len(vendor_id) > 255:
raise ValueError("Invalid value for `vendor_id`, length must be less than or equal to `255`")
self._vendor_id = vendor_id
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceDataPostRequest):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceDataPostRequest(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, auto_update=None, bootstrap_expiration_date=None, bootstrapped_timestamp=None, ca_id=None, connector_expiration_date=None, custom_attributes=None, deployment=None, description=None, device_class=None, device_execution_mode=None, device_key=None, endpoint_name=None, endpoint_type=None, firmware_checksum=None, groups=None, host_gateway=None, manifest=None, mechanism=None, mechanism_url=None, name=None, object=None, serial_number=None, state=None, vendor_id=None):
'''
DeviceDataPostRequest - a model defined in Swagger
'''
pass
@property
def auto_update(self):
'''
Gets the auto_update of this DeviceDataPostRequest.
DEPRECATED: Mark this device for automatic firmware update.
:return: The auto_update of this DeviceDataPostRequest.
:rtype: bool
'''
pass
@auto_update.setter
def auto_update(self):
'''
Sets the auto_update of this DeviceDataPostRequest.
DEPRECATED: Mark this device for automatic firmware update.
:param auto_update: The auto_update of this DeviceDataPostRequest.
:type: bool
'''
pass
@property
def bootstrap_expiration_date(self):
'''
Gets the bootstrap_expiration_date of this DeviceDataPostRequest.
The expiration date of the certificate used to connect to bootstrap server.
:return: The bootstrap_expiration_date of this DeviceDataPostRequest.
:rtype: datetime
'''
pass
@bootstrap_expiration_date.setter
def bootstrap_expiration_date(self):
'''
Sets the bootstrap_expiration_date of this DeviceDataPostRequest.
The expiration date of the certificate used to connect to bootstrap server.
:param bootstrap_expiration_date: The bootstrap_expiration_date of this DeviceDataPostRequest.
:type: datetime
'''
pass
@property
def bootstrapped_timestamp(self):
'''
Gets the bootstrapped_timestamp of this DeviceDataPostRequest.
The timestamp of the device's most recent bootstrap process.
:return: The bootstrapped_timestamp of this DeviceDataPostRequest.
:rtype: datetime
'''
pass
@bootstrapped_timestamp.setter
def bootstrapped_timestamp(self):
'''
Sets the bootstrapped_timestamp of this DeviceDataPostRequest.
The timestamp of the device's most recent bootstrap process.
:param bootstrapped_timestamp: The bootstrapped_timestamp of this DeviceDataPostRequest.
:type: datetime
'''
pass
@property
def ca_id(self):
'''
Gets the ca_id of this DeviceDataPostRequest.
The certificate issuer's ID.
:return: The ca_id of this DeviceDataPostRequest.
:rtype: str
'''
pass
@ca_id.setter
def ca_id(self):
'''
Sets the ca_id of this DeviceDataPostRequest.
The certificate issuer's ID.
:param ca_id: The ca_id of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def connector_expiration_date(self):
'''
Gets the connector_expiration_date of this DeviceDataPostRequest.
The expiration date of the certificate used to connect to the LwM2M server.
:return: The connector_expiration_date of this DeviceDataPostRequest.
:rtype: datetime
'''
pass
@connector_expiration_date.setter
def connector_expiration_date(self):
'''
Sets the connector_expiration_date of this DeviceDataPostRequest.
The expiration date of the certificate used to connect to the LwM2M server.
:param connector_expiration_date: The connector_expiration_date of this DeviceDataPostRequest.
:type: datetime
'''
pass
@property
def custom_attributes(self):
'''
Gets the custom_attributes of this DeviceDataPostRequest.
Up to five custom key-value attributes. Note that keys cannot start with a number. Both keys and values are limited to 128 characters.
:return: The custom_attributes of this DeviceDataPostRequest.
:rtype: dict(str, str)
'''
pass
@custom_attributes.setter
def custom_attributes(self):
'''
Sets the custom_attributes of this DeviceDataPostRequest.
Up to five custom key-value attributes. Note that keys cannot start with a number. Both keys and values are limited to 128 characters.
:param custom_attributes: The custom_attributes of this DeviceDataPostRequest.
:type: dict(str, str)
'''
pass
@property
def deployment(self):
'''
Gets the deployment of this DeviceDataPostRequest.
DEPRECATED: The last deployment used on the device.
:return: The deployment of this DeviceDataPostRequest.
:rtype: str
'''
pass
@deployment.setter
def deployment(self):
'''
Sets the deployment of this DeviceDataPostRequest.
DEPRECATED: The last deployment used on the device.
:param deployment: The deployment of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def description(self):
'''
Gets the description of this DeviceDataPostRequest.
The description of the device.
:return: The description of this DeviceDataPostRequest.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeviceDataPostRequest.
The description of the device.
:param description: The description of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def device_class(self):
'''
Gets the device_class of this DeviceDataPostRequest.
An ID representing the model and hardware revision of the device.
:return: The device_class of this DeviceDataPostRequest.
:rtype: str
'''
pass
@device_class.setter
def device_class(self):
'''
Sets the device_class of this DeviceDataPostRequest.
An ID representing the model and hardware revision of the device.
:param device_class: The device_class of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def device_execution_mode(self):
'''
Gets the device_execution_mode of this DeviceDataPostRequest.
The execution mode from the certificate of the device. Permitted values: - 0 - unspecified execution mode (default) - 1 - development devices - 5 - production devices
:return: The device_execution_mode of this DeviceDataPostRequest.
:rtype: int
'''
pass
@device_execution_mode.setter
def device_execution_mode(self):
'''
Sets the device_execution_mode of this DeviceDataPostRequest.
The execution mode from the certificate of the device. Permitted values: - 0 - unspecified execution mode (default) - 1 - development devices - 5 - production devices
:param device_execution_mode: The device_execution_mode of this DeviceDataPostRequest.
:type: int
'''
pass
@property
def device_key(self):
'''
Gets the device_key of this DeviceDataPostRequest.
The fingerprint of the device certificate.
:return: The device_key of this DeviceDataPostRequest.
:rtype: str
'''
pass
@device_key.setter
def device_key(self):
'''
Sets the device_key of this DeviceDataPostRequest.
The fingerprint of the device certificate.
:param device_key: The device_key of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def endpoint_name(self):
'''
Gets the endpoint_name of this DeviceDataPostRequest.
The endpoint name given to the device.
:return: The endpoint_name of this DeviceDataPostRequest.
:rtype: str
'''
pass
@endpoint_name.setter
def endpoint_name(self):
'''
Sets the endpoint_name of this DeviceDataPostRequest.
The endpoint name given to the device.
:param endpoint_name: The endpoint_name of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def endpoint_type(self):
'''
Gets the endpoint_type of this DeviceDataPostRequest.
The endpoint type of the device. For example, the device is a gateway.
:return: The endpoint_type of this DeviceDataPostRequest.
:rtype: str
'''
pass
@endpoint_type.setter
def endpoint_type(self):
'''
Sets the endpoint_type of this DeviceDataPostRequest.
The endpoint type of the device. For example, the device is a gateway.
:param endpoint_type: The endpoint_type of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def firmware_checksum(self):
'''
Gets the firmware_checksum of this DeviceDataPostRequest.
The SHA256 checksum of the current firmware image.
:return: The firmware_checksum of this DeviceDataPostRequest.
:rtype: str
'''
pass
@firmware_checksum.setter
def firmware_checksum(self):
'''
Sets the firmware_checksum of this DeviceDataPostRequest.
The SHA256 checksum of the current firmware image.
:param firmware_checksum: The firmware_checksum of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def groups(self):
'''
Gets the groups of this DeviceDataPostRequest.
An array containing an id of each group this device belongs to
:return: The groups of this DeviceDataPostRequest.
:rtype: list[str]
'''
pass
@groups.setter
def groups(self):
'''
Sets the groups of this DeviceDataPostRequest.
An array containing an id of each group this device belongs to
:param groups: The groups of this DeviceDataPostRequest.
:type: list[str]
'''
pass
@property
def host_gateway(self):
'''
Gets the host_gateway of this DeviceDataPostRequest.
The `endpoint_name` of the host gateway, if appropriate.
:return: The host_gateway of this DeviceDataPostRequest.
:rtype: str
'''
pass
@host_gateway.setter
def host_gateway(self):
'''
Sets the host_gateway of this DeviceDataPostRequest.
The `endpoint_name` of the host gateway, if appropriate.
:param host_gateway: The host_gateway of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def manifest(self):
'''
Gets the manifest of this DeviceDataPostRequest.
DEPRECATED: The URL for the current device manifest.
:return: The manifest of this DeviceDataPostRequest.
:rtype: str
'''
pass
@manifest.setter
def manifest(self):
'''
Sets the manifest of this DeviceDataPostRequest.
DEPRECATED: The URL for the current device manifest.
:param manifest: The manifest of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def mechanism(self):
'''
Gets the mechanism of this DeviceDataPostRequest.
The ID of the channel used to communicate with the device.
:return: The mechanism of this DeviceDataPostRequest.
:rtype: str
'''
pass
@mechanism.setter
def mechanism(self):
'''
Sets the mechanism of this DeviceDataPostRequest.
The ID of the channel used to communicate with the device.
:param mechanism: The mechanism of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def mechanism_url(self):
'''
Gets the mechanism_url of this DeviceDataPostRequest.
The address of the connector to use.
:return: The mechanism_url of this DeviceDataPostRequest.
:rtype: str
'''
pass
@mechanism_url.setter
def mechanism_url(self):
'''
Sets the mechanism_url of this DeviceDataPostRequest.
The address of the connector to use.
:param mechanism_url: The mechanism_url of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceDataPostRequest.
The name of the device.
:return: The name of this DeviceDataPostRequest.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceDataPostRequest.
The name of the device.
:param name: The name of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this DeviceDataPostRequest.
The API resource entity.
:return: The object of this DeviceDataPostRequest.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DeviceDataPostRequest.
The API resource entity.
:param object: The object of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def serial_number(self):
'''
Gets the serial_number of this DeviceDataPostRequest.
The serial number of the device.
:return: The serial_number of this DeviceDataPostRequest.
:rtype: str
'''
pass
@serial_number.setter
def serial_number(self):
'''
Sets the serial_number of this DeviceDataPostRequest.
The serial number of the device.
:param serial_number: The serial_number of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this DeviceDataPostRequest.
The current state of the device.
:return: The state of this DeviceDataPostRequest.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this DeviceDataPostRequest.
The current state of the device.
:param state: The state of this DeviceDataPostRequest.
:type: str
'''
pass
@property
def vendor_id(self):
'''
Gets the vendor_id of this DeviceDataPostRequest.
The device vendor ID.
:return: The vendor_id of this DeviceDataPostRequest.
:rtype: str
'''
pass
@vendor_id.setter
def vendor_id(self):
'''
Sets the vendor_id of this DeviceDataPostRequest.
The device vendor ID.
:param vendor_id: The vendor_id of this DeviceDataPostRequest.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 103 | 55 | 10 | 1 | 3 | 6 | 1 | 1.11 | 1 | 4 | 0 | 0 | 54 | 25 | 54 | 54 | 735 | 133 | 285 | 135 | 182 | 317 | 171 | 87 | 116 | 5 | 1 | 2 | 71 |
2,477 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/models/device_data.py
|
mbed_cloud._backends.device_directory.models.device_data.DeviceData
|
class DeviceData(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 = {
'account_id': 'str',
'auto_update': 'bool',
'bootstrap_expiration_date': 'date',
'bootstrapped_timestamp': 'datetime',
'ca_id': 'str',
'connector_expiration_date': 'date',
'created_at': 'datetime',
'custom_attributes': 'dict(str, str)',
'deployed_state': 'str',
'deployment': 'str',
'description': 'str',
'device_class': 'str',
'device_execution_mode': 'int',
'device_key': 'str',
'endpoint_name': 'str',
'endpoint_type': 'str',
'enrolment_list_timestamp': 'datetime',
'etag': 'datetime',
'firmware_checksum': 'str',
'groups': 'list[str]',
'host_gateway': 'str',
'id': 'str',
'manifest': 'str',
'manifest_timestamp': 'datetime',
'mechanism': 'str',
'mechanism_url': 'str',
'name': 'str',
'object': 'str',
'serial_number': 'str',
'state': 'str',
'updated_at': 'datetime',
'vendor_id': 'str'
}
attribute_map = {
'account_id': 'account_id',
'auto_update': 'auto_update',
'bootstrap_expiration_date': 'bootstrap_expiration_date',
'bootstrapped_timestamp': 'bootstrapped_timestamp',
'ca_id': 'ca_id',
'connector_expiration_date': 'connector_expiration_date',
'created_at': 'created_at',
'custom_attributes': 'custom_attributes',
'deployed_state': 'deployed_state',
'deployment': 'deployment',
'description': 'description',
'device_class': 'device_class',
'device_execution_mode': 'device_execution_mode',
'device_key': 'device_key',
'endpoint_name': 'endpoint_name',
'endpoint_type': 'endpoint_type',
'enrolment_list_timestamp': 'enrolment_list_timestamp',
'etag': 'etag',
'firmware_checksum': 'firmware_checksum',
'groups': 'groups',
'host_gateway': 'host_gateway',
'id': 'id',
'manifest': 'manifest',
'manifest_timestamp': 'manifest_timestamp',
'mechanism': 'mechanism',
'mechanism_url': 'mechanism_url',
'name': 'name',
'object': 'object',
'serial_number': 'serial_number',
'state': 'state',
'updated_at': 'updated_at',
'vendor_id': 'vendor_id'
}
def __init__(self, account_id=None, auto_update=None, bootstrap_expiration_date=None, bootstrapped_timestamp=None, ca_id=None, connector_expiration_date=None, created_at=None, custom_attributes=None, deployed_state=None, deployment=None, description=None, device_class=None, device_execution_mode=None, device_key=None, endpoint_name=None, endpoint_type=None, enrolment_list_timestamp=None, etag=None, firmware_checksum=None, groups=None, host_gateway=None, id=None, manifest=None, manifest_timestamp=None, mechanism=None, mechanism_url=None, name=None, object=None, serial_number=None, state=None, updated_at=None, vendor_id=None):
"""
DeviceData - a model defined in Swagger
"""
self._account_id = account_id
self._auto_update = auto_update
self._bootstrap_expiration_date = bootstrap_expiration_date
self._bootstrapped_timestamp = bootstrapped_timestamp
self._ca_id = ca_id
self._connector_expiration_date = connector_expiration_date
self._created_at = created_at
self._custom_attributes = custom_attributes
self._deployed_state = deployed_state
self._deployment = deployment
self._description = description
self._device_class = device_class
self._device_execution_mode = device_execution_mode
self._device_key = device_key
self._endpoint_name = endpoint_name
self._endpoint_type = endpoint_type
self._enrolment_list_timestamp = enrolment_list_timestamp
self._etag = etag
self._firmware_checksum = firmware_checksum
self._groups = groups
self._host_gateway = host_gateway
self._id = id
self._manifest = manifest
self._manifest_timestamp = manifest_timestamp
self._mechanism = mechanism
self._mechanism_url = mechanism_url
self._name = name
self._object = object
self._serial_number = serial_number
self._state = state
self._updated_at = updated_at
self._vendor_id = vendor_id
self.discriminator = None
@property
def account_id(self):
"""
Gets the account_id of this DeviceData.
The ID of the associated account.
:return: The account_id of this DeviceData.
:rtype: str
"""
return self._account_id
@account_id.setter
def account_id(self, account_id):
"""
Sets the account_id of this DeviceData.
The ID of the associated account.
:param account_id: The account_id of this DeviceData.
:type: str
"""
self._account_id = account_id
@property
def auto_update(self):
"""
Gets the auto_update of this DeviceData.
DEPRECATED: Mark this device for automatic firmware update.
:return: The auto_update of this DeviceData.
:rtype: bool
"""
return self._auto_update
@auto_update.setter
def auto_update(self, auto_update):
"""
Sets the auto_update of this DeviceData.
DEPRECATED: Mark this device for automatic firmware update.
:param auto_update: The auto_update of this DeviceData.
:type: bool
"""
self._auto_update = auto_update
@property
def bootstrap_expiration_date(self):
"""
Gets the bootstrap_expiration_date of this DeviceData.
The expiration date of the certificate used to connect to bootstrap server.
:return: The bootstrap_expiration_date of this DeviceData.
:rtype: date
"""
return self._bootstrap_expiration_date
@bootstrap_expiration_date.setter
def bootstrap_expiration_date(self, bootstrap_expiration_date):
"""
Sets the bootstrap_expiration_date of this DeviceData.
The expiration date of the certificate used to connect to bootstrap server.
:param bootstrap_expiration_date: The bootstrap_expiration_date of this DeviceData.
:type: date
"""
self._bootstrap_expiration_date = bootstrap_expiration_date
@property
def bootstrapped_timestamp(self):
"""
Gets the bootstrapped_timestamp of this DeviceData.
The timestamp of the device's most recent bootstrap process.
:return: The bootstrapped_timestamp of this DeviceData.
:rtype: datetime
"""
return self._bootstrapped_timestamp
@bootstrapped_timestamp.setter
def bootstrapped_timestamp(self, bootstrapped_timestamp):
"""
Sets the bootstrapped_timestamp of this DeviceData.
The timestamp of the device's most recent bootstrap process.
:param bootstrapped_timestamp: The bootstrapped_timestamp of this DeviceData.
:type: datetime
"""
self._bootstrapped_timestamp = bootstrapped_timestamp
@property
def ca_id(self):
"""
Gets the ca_id of this DeviceData.
The certificate issuer's ID.
:return: The ca_id of this DeviceData.
:rtype: str
"""
return self._ca_id
@ca_id.setter
def ca_id(self, ca_id):
"""
Sets the ca_id of this DeviceData.
The certificate issuer's ID.
:param ca_id: The ca_id of this DeviceData.
:type: str
"""
if ca_id is not None and len(ca_id) > 500:
raise ValueError("Invalid value for `ca_id`, length must be less than or equal to `500`")
self._ca_id = ca_id
@property
def connector_expiration_date(self):
"""
Gets the connector_expiration_date of this DeviceData.
The expiration date of the certificate used to connect to LwM2M server.
:return: The connector_expiration_date of this DeviceData.
:rtype: date
"""
return self._connector_expiration_date
@connector_expiration_date.setter
def connector_expiration_date(self, connector_expiration_date):
"""
Sets the connector_expiration_date of this DeviceData.
The expiration date of the certificate used to connect to LwM2M server.
:param connector_expiration_date: The connector_expiration_date of this DeviceData.
:type: date
"""
self._connector_expiration_date = connector_expiration_date
@property
def created_at(self):
"""
Gets the created_at of this DeviceData.
The timestamp of when the device was created in the device directory.
:return: The created_at of this DeviceData.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeviceData.
The timestamp of when the device was created in the device directory.
:param created_at: The created_at of this DeviceData.
:type: datetime
"""
self._created_at = created_at
@property
def custom_attributes(self):
"""
Gets the custom_attributes of this DeviceData.
Up to five custom key-value attributes.
:return: The custom_attributes of this DeviceData.
:rtype: dict(str, str)
"""
return self._custom_attributes
@custom_attributes.setter
def custom_attributes(self, custom_attributes):
"""
Sets the custom_attributes of this DeviceData.
Up to five custom key-value attributes.
:param custom_attributes: The custom_attributes of this DeviceData.
:type: dict(str, str)
"""
self._custom_attributes = custom_attributes
@property
def deployed_state(self):
"""
Gets the deployed_state of this DeviceData.
DEPRECATED: The state of the device's deployment.
:return: The deployed_state of this DeviceData.
:rtype: str
"""
return self._deployed_state
@deployed_state.setter
def deployed_state(self, deployed_state):
"""
Sets the deployed_state of this DeviceData.
DEPRECATED: The state of the device's deployment.
:param deployed_state: The deployed_state of this DeviceData.
:type: str
"""
allowed_values = ["development", "production"]
if deployed_state not in allowed_values:
raise ValueError(
"Invalid value for `deployed_state` ({0}), must be one of {1}"
.format(deployed_state, allowed_values)
)
self._deployed_state = deployed_state
@property
def deployment(self):
"""
Gets the deployment of this DeviceData.
DEPRECATED: The last deployment used on the device.
:return: The deployment of this DeviceData.
:rtype: str
"""
return self._deployment
@deployment.setter
def deployment(self, deployment):
"""
Sets the deployment of this DeviceData.
DEPRECATED: The last deployment used on the device.
:param deployment: The deployment of this DeviceData.
:type: str
"""
self._deployment = deployment
@property
def description(self):
"""
Gets the description of this DeviceData.
The description of the device.
:return: The description of this DeviceData.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeviceData.
The description of the device.
:param description: The description of this DeviceData.
:type: str
"""
if description is not None and len(description) > 2000:
raise ValueError("Invalid value for `description`, length must be less than or equal to `2000`")
self._description = description
@property
def device_class(self):
"""
Gets the device_class of this DeviceData.
An ID representing the model and hardware revision of the device.
:return: The device_class of this DeviceData.
:rtype: str
"""
return self._device_class
@device_class.setter
def device_class(self, device_class):
"""
Sets the device_class of this DeviceData.
An ID representing the model and hardware revision of the device.
:param device_class: The device_class of this DeviceData.
:type: str
"""
if device_class is not None and len(device_class) > 32:
raise ValueError("Invalid value for `device_class`, length must be less than or equal to `32`")
self._device_class = device_class
@property
def device_execution_mode(self):
"""
Gets the device_execution_mode of this DeviceData.
The execution mode from the certificate of the device. Defaults to inheriting from host_gateway device. Permitted values: - 0 - unspecified execution mode (default if host_gateway invalid or not set) - 1 - development devices - 5 - production devices
:return: The device_execution_mode of this DeviceData.
:rtype: int
"""
return self._device_execution_mode
@device_execution_mode.setter
def device_execution_mode(self, device_execution_mode):
"""
Sets the device_execution_mode of this DeviceData.
The execution mode from the certificate of the device. Defaults to inheriting from host_gateway device. Permitted values: - 0 - unspecified execution mode (default if host_gateway invalid or not set) - 1 - development devices - 5 - production devices
:param device_execution_mode: The device_execution_mode of this DeviceData.
:type: int
"""
self._device_execution_mode = device_execution_mode
@property
def device_key(self):
"""
Gets the device_key of this DeviceData.
The fingerprint of the device certificate.
:return: The device_key of this DeviceData.
:rtype: str
"""
return self._device_key
@device_key.setter
def device_key(self, device_key):
"""
Sets the device_key of this DeviceData.
The fingerprint of the device certificate.
:param device_key: The device_key of this DeviceData.
:type: str
"""
if device_key is not None and len(device_key) > 512:
raise ValueError("Invalid value for `device_key`, length must be less than or equal to `512`")
self._device_key = device_key
@property
def endpoint_name(self):
"""
Gets the endpoint_name of this DeviceData.
The endpoint name given to the device.
:return: The endpoint_name of this DeviceData.
:rtype: str
"""
return self._endpoint_name
@endpoint_name.setter
def endpoint_name(self, endpoint_name):
"""
Sets the endpoint_name of this DeviceData.
The endpoint name given to the device.
:param endpoint_name: The endpoint_name of this DeviceData.
:type: str
"""
self._endpoint_name = endpoint_name
@property
def endpoint_type(self):
"""
Gets the endpoint_type of this DeviceData.
The endpoint type of the device. For example, the device is a gateway.
:return: The endpoint_type of this DeviceData.
:rtype: str
"""
return self._endpoint_type
@endpoint_type.setter
def endpoint_type(self, endpoint_type):
"""
Sets the endpoint_type of this DeviceData.
The endpoint type of the device. For example, the device is a gateway.
:param endpoint_type: The endpoint_type of this DeviceData.
:type: str
"""
if endpoint_type is not None and len(endpoint_type) > 64:
raise ValueError("Invalid value for `endpoint_type`, length must be less than or equal to `64`")
self._endpoint_type = endpoint_type
@property
def enrolment_list_timestamp(self):
"""
Gets the enrolment_list_timestamp of this DeviceData.
The claim date/time.
:return: The enrolment_list_timestamp of this DeviceData.
:rtype: datetime
"""
return self._enrolment_list_timestamp
@enrolment_list_timestamp.setter
def enrolment_list_timestamp(self, enrolment_list_timestamp):
"""
Sets the enrolment_list_timestamp of this DeviceData.
The claim date/time.
:param enrolment_list_timestamp: The enrolment_list_timestamp of this DeviceData.
:type: datetime
"""
self._enrolment_list_timestamp = enrolment_list_timestamp
@property
def etag(self):
"""
Gets the etag of this DeviceData.
The entity instance signature.
:return: The etag of this DeviceData.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeviceData.
The entity instance signature.
:param etag: The etag of this DeviceData.
:type: datetime
"""
self._etag = etag
@property
def firmware_checksum(self):
"""
Gets the firmware_checksum of this DeviceData.
The SHA256 checksum of the current firmware image.
:return: The firmware_checksum of this DeviceData.
:rtype: str
"""
return self._firmware_checksum
@firmware_checksum.setter
def firmware_checksum(self, firmware_checksum):
"""
Sets the firmware_checksum of this DeviceData.
The SHA256 checksum of the current firmware image.
:param firmware_checksum: The firmware_checksum of this DeviceData.
:type: str
"""
self._firmware_checksum = firmware_checksum
@property
def groups(self):
"""
Gets the groups of this DeviceData.
An array containing an id of each group this device belongs to
:return: The groups of this DeviceData.
:rtype: list[str]
"""
return self._groups
@groups.setter
def groups(self, groups):
"""
Sets the groups of this DeviceData.
An array containing an id of each group this device belongs to
:param groups: The groups of this DeviceData.
:type: list[str]
"""
self._groups = groups
@property
def host_gateway(self):
"""
Gets the host_gateway of this DeviceData.
The `endpoint_name` of the host gateway, if appropriate.
:return: The host_gateway of this DeviceData.
:rtype: str
"""
return self._host_gateway
@host_gateway.setter
def host_gateway(self, host_gateway):
"""
Sets the host_gateway of this DeviceData.
The `endpoint_name` of the host gateway, if appropriate.
:param host_gateway: The host_gateway of this DeviceData.
:type: str
"""
self._host_gateway = host_gateway
@property
def id(self):
"""
Gets the id of this DeviceData.
The ID of the device. The device ID is used across all Device Management APIs.
:return: The id of this DeviceData.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeviceData.
The ID of the device. The device ID is used across all Device Management APIs.
:param id: The id of this DeviceData.
:type: str
"""
self._id = id
@property
def manifest(self):
"""
Gets the manifest of this DeviceData.
DEPRECATED: The URL for the current device manifest.
:return: The manifest of this DeviceData.
:rtype: str
"""
return self._manifest
@manifest.setter
def manifest(self, manifest):
"""
Sets the manifest of this DeviceData.
DEPRECATED: The URL for the current device manifest.
:param manifest: The manifest of this DeviceData.
:type: str
"""
self._manifest = manifest
@property
def manifest_timestamp(self):
"""
Gets the manifest_timestamp of this DeviceData.
The timestamp of the current manifest version.
:return: The manifest_timestamp of this DeviceData.
:rtype: datetime
"""
return self._manifest_timestamp
@manifest_timestamp.setter
def manifest_timestamp(self, manifest_timestamp):
"""
Sets the manifest_timestamp of this DeviceData.
The timestamp of the current manifest version.
:param manifest_timestamp: The manifest_timestamp of this DeviceData.
:type: datetime
"""
self._manifest_timestamp = manifest_timestamp
@property
def mechanism(self):
"""
Gets the mechanism of this DeviceData.
The ID of the channel used to communicate with the device.
:return: The mechanism of this DeviceData.
:rtype: str
"""
return self._mechanism
@mechanism.setter
def mechanism(self, mechanism):
"""
Sets the mechanism of this DeviceData.
The ID of the channel used to communicate with the device.
:param mechanism: The mechanism of this DeviceData.
:type: str
"""
allowed_values = ["connector", "direct"]
if mechanism not in allowed_values:
raise ValueError(
"Invalid value for `mechanism` ({0}), must be one of {1}"
.format(mechanism, allowed_values)
)
self._mechanism = mechanism
@property
def mechanism_url(self):
"""
Gets the mechanism_url of this DeviceData.
The address of the connector to use.
:return: The mechanism_url of this DeviceData.
:rtype: str
"""
return self._mechanism_url
@mechanism_url.setter
def mechanism_url(self, mechanism_url):
"""
Sets the mechanism_url of this DeviceData.
The address of the connector to use.
:param mechanism_url: The mechanism_url of this DeviceData.
:type: str
"""
self._mechanism_url = mechanism_url
@property
def name(self):
"""
Gets the name of this DeviceData.
The name of the device.
:return: The name of this DeviceData.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeviceData.
The name of the device.
:param name: The name of this DeviceData.
:type: str
"""
if name is not None and len(name) > 128:
raise ValueError("Invalid value for `name`, length must be less than or equal to `128`")
self._name = name
@property
def object(self):
"""
Gets the object of this DeviceData.
The API resource entity.
:return: The object of this DeviceData.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DeviceData.
The API resource entity.
:param object: The object of this DeviceData.
:type: str
"""
self._object = object
@property
def serial_number(self):
"""
Gets the serial_number of this DeviceData.
The serial number of the device.
:return: The serial_number of this DeviceData.
:rtype: str
"""
return self._serial_number
@serial_number.setter
def serial_number(self, serial_number):
"""
Sets the serial_number of this DeviceData.
The serial number of the device.
:param serial_number: The serial_number of this DeviceData.
:type: str
"""
self._serial_number = serial_number
@property
def state(self):
"""
Gets the state of this DeviceData.
The current state of the device.
:return: The state of this DeviceData.
:rtype: str
"""
return self._state
@state.setter
def state(self, state):
"""
Sets the state of this DeviceData.
The current state of the device.
:param state: The state of this DeviceData.
:type: str
"""
allowed_values = ["unenrolled", "cloud_enrolling", "bootstrapped", "registered", "deregistered"]
if state not in allowed_values:
raise ValueError(
"Invalid value for `state` ({0}), must be one of {1}"
.format(state, allowed_values)
)
self._state = state
@property
def updated_at(self):
"""
Gets the updated_at of this DeviceData.
The time the object was updated.
:return: The updated_at of this DeviceData.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this DeviceData.
The time the object was updated.
:param updated_at: The updated_at of this DeviceData.
:type: datetime
"""
self._updated_at = updated_at
@property
def vendor_id(self):
"""
Gets the vendor_id of this DeviceData.
The device vendor ID.
:return: The vendor_id of this DeviceData.
:rtype: str
"""
return self._vendor_id
@vendor_id.setter
def vendor_id(self, vendor_id):
"""
Sets the vendor_id of this DeviceData.
The device vendor ID.
:param vendor_id: The vendor_id of this DeviceData.
:type: str
"""
self._vendor_id = vendor_id
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeviceData):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeviceData(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, account_id=None, auto_update=None, bootstrap_expiration_date=None, bootstrapped_timestamp=None, ca_id=None, connector_expiration_date=None, created_at=None, custom_attributes=None, deployed_state=None, deployment=None, description=None, device_class=None, device_execution_mode=None, device_key=None, endpoint_name=None, endpoint_type=None, enrolment_list_timestamp=None, etag=None, firmware_checksum=None, groups=None, host_gateway=None, id=None, manifest=None, manifest_timestamp=None, mechanism=None, mechanism_url=None, name=None, object=None, serial_number=None, state=None, updated_at=None, vendor_id=None):
'''
DeviceData - a model defined in Swagger
'''
pass
@property
def account_id(self):
'''
Gets the account_id of this DeviceData.
The ID of the associated account.
:return: The account_id of this DeviceData.
:rtype: str
'''
pass
@account_id.setter
def account_id(self):
'''
Sets the account_id of this DeviceData.
The ID of the associated account.
:param account_id: The account_id of this DeviceData.
:type: str
'''
pass
@property
def auto_update(self):
'''
Gets the auto_update of this DeviceData.
DEPRECATED: Mark this device for automatic firmware update.
:return: The auto_update of this DeviceData.
:rtype: bool
'''
pass
@auto_update.setter
def auto_update(self):
'''
Sets the auto_update of this DeviceData.
DEPRECATED: Mark this device for automatic firmware update.
:param auto_update: The auto_update of this DeviceData.
:type: bool
'''
pass
@property
def bootstrap_expiration_date(self):
'''
Gets the bootstrap_expiration_date of this DeviceData.
The expiration date of the certificate used to connect to bootstrap server.
:return: The bootstrap_expiration_date of this DeviceData.
:rtype: date
'''
pass
@bootstrap_expiration_date.setter
def bootstrap_expiration_date(self):
'''
Sets the bootstrap_expiration_date of this DeviceData.
The expiration date of the certificate used to connect to bootstrap server.
:param bootstrap_expiration_date: The bootstrap_expiration_date of this DeviceData.
:type: date
'''
pass
@property
def bootstrapped_timestamp(self):
'''
Gets the bootstrapped_timestamp of this DeviceData.
The timestamp of the device's most recent bootstrap process.
:return: The bootstrapped_timestamp of this DeviceData.
:rtype: datetime
'''
pass
@bootstrapped_timestamp.setter
def bootstrapped_timestamp(self):
'''
Sets the bootstrapped_timestamp of this DeviceData.
The timestamp of the device's most recent bootstrap process.
:param bootstrapped_timestamp: The bootstrapped_timestamp of this DeviceData.
:type: datetime
'''
pass
@property
def ca_id(self):
'''
Gets the ca_id of this DeviceData.
The certificate issuer's ID.
:return: The ca_id of this DeviceData.
:rtype: str
'''
pass
@ca_id.setter
def ca_id(self):
'''
Sets the ca_id of this DeviceData.
The certificate issuer's ID.
:param ca_id: The ca_id of this DeviceData.
:type: str
'''
pass
@property
def connector_expiration_date(self):
'''
Gets the connector_expiration_date of this DeviceData.
The expiration date of the certificate used to connect to LwM2M server.
:return: The connector_expiration_date of this DeviceData.
:rtype: date
'''
pass
@connector_expiration_date.setter
def connector_expiration_date(self):
'''
Sets the connector_expiration_date of this DeviceData.
The expiration date of the certificate used to connect to LwM2M server.
:param connector_expiration_date: The connector_expiration_date of this DeviceData.
:type: date
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeviceData.
The timestamp of when the device was created in the device directory.
:return: The created_at of this DeviceData.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeviceData.
The timestamp of when the device was created in the device directory.
:param created_at: The created_at of this DeviceData.
:type: datetime
'''
pass
@property
def custom_attributes(self):
'''
Gets the custom_attributes of this DeviceData.
Up to five custom key-value attributes.
:return: The custom_attributes of this DeviceData.
:rtype: dict(str, str)
'''
pass
@custom_attributes.setter
def custom_attributes(self):
'''
Sets the custom_attributes of this DeviceData.
Up to five custom key-value attributes.
:param custom_attributes: The custom_attributes of this DeviceData.
:type: dict(str, str)
'''
pass
@property
def deployed_state(self):
'''
Gets the deployed_state of this DeviceData.
DEPRECATED: The state of the device's deployment.
:return: The deployed_state of this DeviceData.
:rtype: str
'''
pass
@deployed_state.setter
def deployed_state(self):
'''
Sets the deployed_state of this DeviceData.
DEPRECATED: The state of the device's deployment.
:param deployed_state: The deployed_state of this DeviceData.
:type: str
'''
pass
@property
def deployment(self):
'''
Gets the deployment of this DeviceData.
DEPRECATED: The last deployment used on the device.
:return: The deployment of this DeviceData.
:rtype: str
'''
pass
@deployment.setter
def deployment(self):
'''
Sets the deployment of this DeviceData.
DEPRECATED: The last deployment used on the device.
:param deployment: The deployment of this DeviceData.
:type: str
'''
pass
@property
def description(self):
'''
Gets the description of this DeviceData.
The description of the device.
:return: The description of this DeviceData.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeviceData.
The description of the device.
:param description: The description of this DeviceData.
:type: str
'''
pass
@property
def device_class(self):
'''
Gets the device_class of this DeviceData.
An ID representing the model and hardware revision of the device.
:return: The device_class of this DeviceData.
:rtype: str
'''
pass
@device_class.setter
def device_class(self):
'''
Sets the device_class of this DeviceData.
An ID representing the model and hardware revision of the device.
:param device_class: The device_class of this DeviceData.
:type: str
'''
pass
@property
def device_execution_mode(self):
'''
Gets the device_execution_mode of this DeviceData.
The execution mode from the certificate of the device. Defaults to inheriting from host_gateway device. Permitted values: - 0 - unspecified execution mode (default if host_gateway invalid or not set) - 1 - development devices - 5 - production devices
:return: The device_execution_mode of this DeviceData.
:rtype: int
'''
pass
@device_execution_mode.setter
def device_execution_mode(self):
'''
Sets the device_execution_mode of this DeviceData.
The execution mode from the certificate of the device. Defaults to inheriting from host_gateway device. Permitted values: - 0 - unspecified execution mode (default if host_gateway invalid or not set) - 1 - development devices - 5 - production devices
:param device_execution_mode: The device_execution_mode of this DeviceData.
:type: int
'''
pass
@property
def device_key(self):
'''
Gets the device_key of this DeviceData.
The fingerprint of the device certificate.
:return: The device_key of this DeviceData.
:rtype: str
'''
pass
@device_key.setter
def device_key(self):
'''
Sets the device_key of this DeviceData.
The fingerprint of the device certificate.
:param device_key: The device_key of this DeviceData.
:type: str
'''
pass
@property
def endpoint_name(self):
'''
Gets the endpoint_name of this DeviceData.
The endpoint name given to the device.
:return: The endpoint_name of this DeviceData.
:rtype: str
'''
pass
@endpoint_name.setter
def endpoint_name(self):
'''
Sets the endpoint_name of this DeviceData.
The endpoint name given to the device.
:param endpoint_name: The endpoint_name of this DeviceData.
:type: str
'''
pass
@property
def endpoint_type(self):
'''
Gets the endpoint_type of this DeviceData.
The endpoint type of the device. For example, the device is a gateway.
:return: The endpoint_type of this DeviceData.
:rtype: str
'''
pass
@endpoint_type.setter
def endpoint_type(self):
'''
Sets the endpoint_type of this DeviceData.
The endpoint type of the device. For example, the device is a gateway.
:param endpoint_type: The endpoint_type of this DeviceData.
:type: str
'''
pass
@property
def enrolment_list_timestamp(self):
'''
Gets the enrolment_list_timestamp of this DeviceData.
The claim date/time.
:return: The enrolment_list_timestamp of this DeviceData.
:rtype: datetime
'''
pass
@enrolment_list_timestamp.setter
def enrolment_list_timestamp(self):
'''
Sets the enrolment_list_timestamp of this DeviceData.
The claim date/time.
:param enrolment_list_timestamp: The enrolment_list_timestamp of this DeviceData.
:type: datetime
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeviceData.
The entity instance signature.
:return: The etag of this DeviceData.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeviceData.
The entity instance signature.
:param etag: The etag of this DeviceData.
:type: datetime
'''
pass
@property
def firmware_checksum(self):
'''
Gets the firmware_checksum of this DeviceData.
The SHA256 checksum of the current firmware image.
:return: The firmware_checksum of this DeviceData.
:rtype: str
'''
pass
@firmware_checksum.setter
def firmware_checksum(self):
'''
Sets the firmware_checksum of this DeviceData.
The SHA256 checksum of the current firmware image.
:param firmware_checksum: The firmware_checksum of this DeviceData.
:type: str
'''
pass
@property
def groups(self):
'''
Gets the groups of this DeviceData.
An array containing an id of each group this device belongs to
:return: The groups of this DeviceData.
:rtype: list[str]
'''
pass
@groups.setter
def groups(self):
'''
Sets the groups of this DeviceData.
An array containing an id of each group this device belongs to
:param groups: The groups of this DeviceData.
:type: list[str]
'''
pass
@property
def host_gateway(self):
'''
Gets the host_gateway of this DeviceData.
The `endpoint_name` of the host gateway, if appropriate.
:return: The host_gateway of this DeviceData.
:rtype: str
'''
pass
@host_gateway.setter
def host_gateway(self):
'''
Sets the host_gateway of this DeviceData.
The `endpoint_name` of the host gateway, if appropriate.
:param host_gateway: The host_gateway of this DeviceData.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this DeviceData.
The ID of the device. The device ID is used across all Device Management APIs.
:return: The id of this DeviceData.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeviceData.
The ID of the device. The device ID is used across all Device Management APIs.
:param id: The id of this DeviceData.
:type: str
'''
pass
@property
def manifest(self):
'''
Gets the manifest of this DeviceData.
DEPRECATED: The URL for the current device manifest.
:return: The manifest of this DeviceData.
:rtype: str
'''
pass
@manifest.setter
def manifest(self):
'''
Sets the manifest of this DeviceData.
DEPRECATED: The URL for the current device manifest.
:param manifest: The manifest of this DeviceData.
:type: str
'''
pass
@property
def manifest_timestamp(self):
'''
Gets the manifest_timestamp of this DeviceData.
The timestamp of the current manifest version.
:return: The manifest_timestamp of this DeviceData.
:rtype: datetime
'''
pass
@manifest_timestamp.setter
def manifest_timestamp(self):
'''
Sets the manifest_timestamp of this DeviceData.
The timestamp of the current manifest version.
:param manifest_timestamp: The manifest_timestamp of this DeviceData.
:type: datetime
'''
pass
@property
def mechanism(self):
'''
Gets the mechanism of this DeviceData.
The ID of the channel used to communicate with the device.
:return: The mechanism of this DeviceData.
:rtype: str
'''
pass
@mechanism.setter
def mechanism(self):
'''
Sets the mechanism of this DeviceData.
The ID of the channel used to communicate with the device.
:param mechanism: The mechanism of this DeviceData.
:type: str
'''
pass
@property
def mechanism_url(self):
'''
Gets the mechanism_url of this DeviceData.
The address of the connector to use.
:return: The mechanism_url of this DeviceData.
:rtype: str
'''
pass
@mechanism_url.setter
def mechanism_url(self):
'''
Sets the mechanism_url of this DeviceData.
The address of the connector to use.
:param mechanism_url: The mechanism_url of this DeviceData.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeviceData.
The name of the device.
:return: The name of this DeviceData.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeviceData.
The name of the device.
:param name: The name of this DeviceData.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this DeviceData.
The API resource entity.
:return: The object of this DeviceData.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DeviceData.
The API resource entity.
:param object: The object of this DeviceData.
:type: str
'''
pass
@property
def serial_number(self):
'''
Gets the serial_number of this DeviceData.
The serial number of the device.
:return: The serial_number of this DeviceData.
:rtype: str
'''
pass
@serial_number.setter
def serial_number(self):
'''
Sets the serial_number of this DeviceData.
The serial number of the device.
:param serial_number: The serial_number of this DeviceData.
:type: str
'''
pass
@property
def state(self):
'''
Gets the state of this DeviceData.
The current state of the device.
:return: The state of this DeviceData.
:rtype: str
'''
pass
@state.setter
def state(self):
'''
Sets the state of this DeviceData.
The current state of the device.
:param state: The state of this DeviceData.
:type: str
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this DeviceData.
The time the object was updated.
:return: The updated_at of this DeviceData.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this DeviceData.
The time the object was updated.
:param updated_at: The updated_at of this DeviceData.
:type: datetime
'''
pass
@property
def vendor_id(self):
'''
Gets the vendor_id of this DeviceData.
The device vendor ID.
:return: The vendor_id of this DeviceData.
:rtype: str
'''
pass
@vendor_id.setter
def vendor_id(self):
'''
Sets the vendor_id of this DeviceData.
The device vendor ID.
:param vendor_id: The vendor_id of this DeviceData.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 135 | 71 | 10 | 1 | 3 | 6 | 1 | 1.16 | 1 | 4 | 0 | 0 | 70 | 33 | 70 | 70 | 941 | 173 | 355 | 176 | 220 | 413 | 206 | 112 | 135 | 5 | 1 | 2 | 84 |
2,478 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/configuration.py
|
mbed_cloud._backends.device_directory.configuration.Configuration
|
class Configuration(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
"""
def __init__(self):
"""Constructor"""
# Default Base url
self.host = "https://api.us-east-1.mbedcloud.com"
# Temp file folder for downloading files
self.temp_folder_path = None
# Authentication Settings
# dict to store API key(s)
self.api_key = {}
# dict to store API prefix (e.g. Bearer)
self.api_key_prefix = {}
# Username for HTTP basic authentication
self.username = ""
# Password for HTTP basic authentication
self.password = ""
# Logging Settings
self.logger = {}
self.logger["package_logger"] = logging.getLogger("device_directory")
self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler
self.logger_stream_handler = None
# Log file handler
self.logger_file_handler = None
# Debug file location
self.logger_file = None
# Debug switch
self.debug = False
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True
# Set this to customize the certificate file to verify the peer.
self.ssl_ca_cert = None
# client certificate file
self.cert_file = None
# client key file
self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification.
self.assert_hostname = None
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
# Proxy URL
self.proxy = None
# Safe chars for path_param
self.safe_chars_for_path_param = ''
@property
def logger_file(self):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
return self.__logger_file
@logger_file.setter
def logger_file(self, value):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
self.__logger_file = value
if self.__logger_file:
# If set logging file,
# then add file handler and remove stream handler.
self.logger_file_handler = logging.FileHandler(self.__logger_file)
self.logger_file_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_file_handler)
if self.logger_stream_handler:
logger.removeHandler(self.logger_stream_handler)
else:
# If not set logging file,
# then add stream handler and remove file handler.
self.logger_stream_handler = logging.StreamHandler()
self.logger_stream_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_stream_handler)
if self.logger_file_handler:
logger.removeHandler(self.logger_file_handler)
@property
def debug(self):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
return self.__debug
@debug.setter
def debug(self, value):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
self.__debug = value
if self.__debug:
# if debug status is True, turn on debug logging
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.DEBUG)
# turn on httplib debug
httplib.HTTPConnection.debuglevel = 1
else:
# if debug status is False, turn off debug logging,
# setting log level to default `logging.WARNING`
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.WARNING)
# turn off httplib debug
httplib.HTTPConnection.debuglevel = 0
@property
def logger_format(self):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
return self.__logger_format
@logger_format.setter
def logger_format(self, value):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)
def get_api_key_with_prefix(self, identifier):
"""Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
"""
if (self.api_key.get(identifier) and
self.api_key_prefix.get(identifier)):
return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] # noqa: E501
elif self.api_key.get(identifier):
return self.api_key[identifier]
def get_basic_auth_token(self):
"""Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
"""
return urllib3.util.make_headers(
basic_auth=self.username + ':' + self.password
).get('authorization')
def auth_settings(self):
"""Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
"""
return {
'Bearer':
{
'type': 'api_key',
'in': 'header',
'key': 'Authorization',
'value': self.get_api_key_with_prefix('Authorization')
},
}
def to_debug_report(self):
"""Gets the essential information for debugging.
:return: The report for debugging.
"""
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: 3\n"\
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)
|
class Configuration(object):
'''NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
'''
def __init__(self):
'''Constructor'''
pass
@property
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@logger_file.setter
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@property
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@debug.setter
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@property
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
@logger_format.setter
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
def get_api_key_with_prefix(self, identifier):
'''Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
'''
pass
def get_basic_auth_token(self):
'''Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
'''
pass
def auth_settings(self):
'''Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
'''
pass
def to_debug_report(self):
'''Gets the essential information for debugging.
:return: The report for debugging.
'''
pass
| 18 | 12 | 17 | 2 | 8 | 7 | 2 | 0.92 | 1 | 3 | 0 | 0 | 11 | 21 | 11 | 11 | 208 | 32 | 92 | 41 | 74 | 85 | 67 | 35 | 55 | 6 | 1 | 3 | 21 |
2,479 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/device_directory/apis/default_api.py
|
mbed_cloud._backends.device_directory.apis.default_api.DefaultApi
|
class DefaultApi(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 device_create(self, device, **kwargs): # noqa: E501
"""Create a device # noqa: E501
Create a new device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_create(device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param DeviceDataPostRequest device: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_create_with_http_info(device, **kwargs) # noqa: E501
else:
(data) = self.device_create_with_http_info(device, **kwargs) # noqa: E501
return data
def device_create_with_http_info(self, device, **kwargs): # noqa: E501
"""Create a device # noqa: E501
Create a new device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_create_with_http_info(device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param DeviceDataPostRequest device: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['device'] # noqa: E501
all_params.append('asynchronous')
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 device_create" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'device' is set
if ('device' not in params or
params['device'] is None):
raise ValueError("Missing the required parameter `device` when calling `device_create`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'device' in params:
body_params = params['device']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/devices/', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceData', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_destroy(self, id, **kwargs): # noqa: E501
"""Delete a device. # noqa: E501
Delete device. Only available for devices with a developer certificate. Attempts to delete a device with a production certicate will return a 400 response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_destroy(id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_destroy_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.device_destroy_with_http_info(id, **kwargs) # noqa: E501
return data
def device_destroy_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete a device. # noqa: E501
Delete device. Only available for devices with a developer certificate. Attempts to delete a device with a production certicate will return a 400 response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_destroy_with_http_info(id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id'] # noqa: E501
all_params.append('asynchronous')
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 device_destroy" % 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 `device_destroy`") # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/devices/{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,
asynchronous=params.get('asynchronous'),
_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 device_event_list(self, **kwargs): # noqa: E501
"""List all device events. # noqa: E501
List all device events for an account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_event_list(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>date_time</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>event_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state_change</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By id: ```id={id}``` ###### By state change: ```state_change=[True|False]``` ###### By event type: ```event_type={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```id=0158d38771f70000000000010010038c&state_change=True&date_time__gte=2016-11-30T16:25:12.1234Z``` Encoded: ```?filter=id%3D0158d38771f70000000000010010038c%26state_change%3DTrue%26date_time__gte%3D2016-11-30T16%3A25%3A12.1234Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `event_type__in=update.device.device-created,update.device.device-updated`
:return: DeviceEventPage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_event_list_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.device_event_list_with_http_info(**kwargs) # noqa: E501
return data
def device_event_list_with_http_info(self, **kwargs): # noqa: E501
"""List all device events. # noqa: E501
List all device events for an account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_event_list_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>date_time</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>event_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state_change</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By id: ```id={id}``` ###### By state change: ```state_change=[True|False]``` ###### By event type: ```event_type={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```id=0158d38771f70000000000010010038c&state_change=True&date_time__gte=2016-11-30T16:25:12.1234Z``` Encoded: ```?filter=id%3D0158d38771f70000000000010010038c%26state_change%3DTrue%26date_time__gte%3D2016-11-30T16%3A25%3A12.1234Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `event_type__in=update.device.device-created,update.device.device-updated`
:return: DeviceEventPage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'order', 'after', 'include', 'filter'] # noqa: E501
all_params.append('asynchronous')
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 device_event_list" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'filter' in params:
query_params.append(('filter', params['filter'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-events/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceEventPage', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_event_retrieve(self, device_event_id, **kwargs): # noqa: E501
"""Retrieve a device event. # noqa: E501
Retrieve a specific device event. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_event_retrieve(device_event_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_event_id: (required)
:return: DeviceEventData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_event_retrieve_with_http_info(device_event_id, **kwargs) # noqa: E501
else:
(data) = self.device_event_retrieve_with_http_info(device_event_id, **kwargs) # noqa: E501
return data
def device_event_retrieve_with_http_info(self, device_event_id, **kwargs): # noqa: E501
"""Retrieve a device event. # noqa: E501
Retrieve a specific device event. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_event_retrieve_with_http_info(device_event_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_event_id: (required)
:return: DeviceEventData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['device_event_id'] # noqa: E501
all_params.append('asynchronous')
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 device_event_retrieve" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'device_event_id' is set
if ('device_event_id' not in params or
params['device_event_id'] is None):
raise ValueError("Missing the required parameter `device_event_id` when calling `device_event_retrieve`") # noqa: E501
collection_formats = {}
path_params = {}
if 'device_event_id' in params:
path_params['device_event_id'] = params['device_event_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-events/{device_event_id}/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceEventData', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_list(self, **kwargs): # noqa: E501
"""List all devices. # noqa: E501
List all devices. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_list(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>account_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>auto_update</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>bootstrap_expiration_date</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>bootstrapped_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>ca_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>connector_expiration_date</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> <td> </td> </tr> <tr> <td>deployed_state</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>deployment</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_class</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_execution_mode</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_key</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>endpoint_name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>endpoint_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>enrolment_list_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>firmware_checksum</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>host_gateway</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>manifest</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>manifest_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>mechanism</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>mechanism_url</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>serial_number</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>vendor_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By device properties (all properties are filterable): ```state=[unenrolled|cloud_enrolling|bootstrapped|registered]``` ```device_class={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ###### On device custom attributes: ```custom_attributes__{param}={value}``` ```custom_attributes__tag=TAG1``` ##### Multi-field example ```state=bootstrapped&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z``` Encoded: ```?filter=state%3Dbootstrapped%26created_at__gte%3D2016-11-30T16%3A25%3A12.1234Z%26created_at__lte%3D2016-11-30T00%3A00%3A00Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `state__nin=unenrolled,dergistered`
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_list_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.device_list_with_http_info(**kwargs) # noqa: E501
return data
def device_list_with_http_info(self, **kwargs): # noqa: E501
"""List all devices. # noqa: E501
List all devices. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_list_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>account_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>auto_update</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>bootstrap_expiration_date</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>bootstrapped_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>ca_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>connector_expiration_date</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> <td> </td> </tr> <tr> <td>deployed_state</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>deployment</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_class</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_execution_mode</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_key</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>endpoint_name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>endpoint_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>enrolment_list_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>firmware_checksum</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>host_gateway</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>manifest</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>manifest_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>mechanism</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>mechanism_url</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>serial_number</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>vendor_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By device properties (all properties are filterable): ```state=[unenrolled|cloud_enrolling|bootstrapped|registered]``` ```device_class={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ###### On device custom attributes: ```custom_attributes__{param}={value}``` ```custom_attributes__tag=TAG1``` ##### Multi-field example ```state=bootstrapped&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z``` Encoded: ```?filter=state%3Dbootstrapped%26created_at__gte%3D2016-11-30T16%3A25%3A12.1234Z%26created_at__lte%3D2016-11-30T00%3A00%3A00Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `state__nin=unenrolled,dergistered`
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'order', 'after', 'include', 'filter'] # noqa: E501
all_params.append('asynchronous')
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 device_list" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'filter' in params:
query_params.append(('filter', params['filter'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/devices/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DevicePage', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_log_list(self, **kwargs): # noqa: E501
"""DEPRECATED: List all device events. # noqa: E501
DEPRECATED: List all device events. Use `/v3/device-events/` instead. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_log_list(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>date_time</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>event_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state_change</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By id: ```id={id}``` ###### By state change: ```state_change=[True|False]``` ###### By event type: ```event_type={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```id=0158d38771f70000000000010010038c&state_change=True&date_time__gte=2016-11-30T16:25:12.1234Z``` Encoded: ```?filter=id%3D0158d38771f70000000000010010038c%26state_change%3DTrue%26date_time__gte%3D2016-11-30T16%3A25%3A12.1234Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `event_type__in=update.device.device-created,update.device.device-updated`
:return: DeviceEventPage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_log_list_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.device_log_list_with_http_info(**kwargs) # noqa: E501
return data
def device_log_list_with_http_info(self, **kwargs): # noqa: E501
"""DEPRECATED: List all device events. # noqa: E501
DEPRECATED: List all device events. Use `/v3/device-events/` instead. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_log_list_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>date_time</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>event_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state_change</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By id: ```id={id}``` ###### By state change: ```state_change=[True|False]``` ###### By event type: ```event_type={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```id=0158d38771f70000000000010010038c&state_change=True&date_time__gte=2016-11-30T16:25:12.1234Z``` Encoded: ```?filter=id%3D0158d38771f70000000000010010038c%26state_change%3DTrue%26date_time__gte%3D2016-11-30T16%3A25%3A12.1234Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `event_type__in=update.device.device-created,update.device.device-updated`
:return: DeviceEventPage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'order', 'after', 'include', 'filter'] # noqa: E501
all_params.append('asynchronous')
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 device_log_list" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'filter' in params:
query_params.append(('filter', params['filter'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/devicelog/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceEventPage', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_log_retrieve(self, device_event_id, **kwargs): # noqa: E501
"""DEPRECATED: Retrieve a device event. # noqa: E501
Retrieve device event (deprecated, use /v3/device-events/{device_event_id}/ instead) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_log_retrieve(device_event_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_event_id: (required)
:return: DeviceEventData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_log_retrieve_with_http_info(device_event_id, **kwargs) # noqa: E501
else:
(data) = self.device_log_retrieve_with_http_info(device_event_id, **kwargs) # noqa: E501
return data
def device_log_retrieve_with_http_info(self, device_event_id, **kwargs): # noqa: E501
"""DEPRECATED: Retrieve a device event. # noqa: E501
Retrieve device event (deprecated, use /v3/device-events/{device_event_id}/ instead) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_log_retrieve_with_http_info(device_event_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_event_id: (required)
:return: DeviceEventData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['device_event_id'] # noqa: E501
all_params.append('asynchronous')
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 device_log_retrieve" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'device_event_id' is set
if ('device_event_id' not in params or
params['device_event_id'] is None):
raise ValueError("Missing the required parameter `device_event_id` when calling `device_log_retrieve`") # noqa: E501
collection_formats = {}
path_params = {}
if 'device_event_id' in params:
path_params['device_event_id'] = params['device_event_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/devicelog/{device_event_id}/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceEventData', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_query_create(self, device, **kwargs): # noqa: E501
"""Create a device query # noqa: E501
Create a new device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_create(device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param DeviceQueryPostPutRequest device: (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_query_create_with_http_info(device, **kwargs) # noqa: E501
else:
(data) = self.device_query_create_with_http_info(device, **kwargs) # noqa: E501
return data
def device_query_create_with_http_info(self, device, **kwargs): # noqa: E501
"""Create a device query # noqa: E501
Create a new device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_create_with_http_info(device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param DeviceQueryPostPutRequest device: (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['device'] # noqa: E501
all_params.append('asynchronous')
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 device_query_create" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'device' is set
if ('device' not in params or
params['device'] is None):
raise ValueError("Missing the required parameter `device` when calling `device_query_create`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'device' in params:
body_params = params['device']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-queries/', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceQuery', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_query_destroy(self, query_id, **kwargs): # noqa: E501
"""Delete a device query # noqa: E501
Delete a device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_destroy(query_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_query_destroy_with_http_info(query_id, **kwargs) # noqa: E501
else:
(data) = self.device_query_destroy_with_http_info(query_id, **kwargs) # noqa: E501
return data
def device_query_destroy_with_http_info(self, query_id, **kwargs): # noqa: E501
"""Delete a device query # noqa: E501
Delete a device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_destroy_with_http_info(query_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['query_id'] # noqa: E501
all_params.append('asynchronous')
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 device_query_destroy" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'query_id' is set
if ('query_id' not in params or
params['query_id'] is None):
raise ValueError("Missing the required parameter `query_id` when calling `device_query_destroy`") # noqa: E501
collection_formats = {}
path_params = {}
if 'query_id' in params:
path_params['query_id'] = params['query_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-queries/{query_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,
asynchronous=params.get('asynchronous'),
_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 device_query_list(self, **kwargs): # noqa: E501
"""List device queries. # noqa: E501
List all device queries. The result will be paged into pages of 100. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_list(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>query</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By device query properties (all properties are filterable): For example: ```description={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```query_id=0158d38771f70000000000010010038c&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z``` Encoded: ```filter=query_id%3D0158d38771f70000000000010010038c%26created_at__gte%3D2016-11-30T16%3A25%3A12.1234Z%26created_at__lte%3D2016-11-30T00%3A00%3A00Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__nin=query1,query2`
:return: DeviceQueryPage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_query_list_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.device_query_list_with_http_info(**kwargs) # noqa: E501
return data
def device_query_list_with_http_info(self, **kwargs): # noqa: E501
"""List device queries. # noqa: E501
List all device queries. The result will be paged into pages of 100. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_list_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>query</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By device query properties (all properties are filterable): For example: ```description={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```query_id=0158d38771f70000000000010010038c&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z``` Encoded: ```filter=query_id%3D0158d38771f70000000000010010038c%26created_at__gte%3D2016-11-30T16%3A25%3A12.1234Z%26created_at__lte%3D2016-11-30T00%3A00%3A00Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__nin=query1,query2`
:return: DeviceQueryPage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'order', 'after', 'include', 'filter'] # noqa: E501
all_params.append('asynchronous')
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 device_query_list" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'filter' in params:
query_params.append(('filter', params['filter'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-queries/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceQueryPage', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_query_retrieve(self, query_id, **kwargs): # noqa: E501
"""Retrieve a device query. # noqa: E501
Retrieve a specific device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_retrieve(query_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_query_retrieve_with_http_info(query_id, **kwargs) # noqa: E501
else:
(data) = self.device_query_retrieve_with_http_info(query_id, **kwargs) # noqa: E501
return data
def device_query_retrieve_with_http_info(self, query_id, **kwargs): # noqa: E501
"""Retrieve a device query. # noqa: E501
Retrieve a specific device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_retrieve_with_http_info(query_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['query_id'] # noqa: E501
all_params.append('asynchronous')
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 device_query_retrieve" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'query_id' is set
if ('query_id' not in params or
params['query_id'] is None):
raise ValueError("Missing the required parameter `query_id` when calling `device_query_retrieve`") # noqa: E501
collection_formats = {}
path_params = {}
if 'query_id' in params:
path_params['query_id'] = params['query_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-queries/{query_id}/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceQuery', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_query_update(self, query_id, body, **kwargs): # noqa: E501
"""Update a device query # noqa: E501
Update a specifc device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_update(query_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:param DeviceQueryPostPutRequest body: Device query update object. (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_query_update_with_http_info(query_id, body, **kwargs) # noqa: E501
else:
(data) = self.device_query_update_with_http_info(query_id, body, **kwargs) # noqa: E501
return data
def device_query_update_with_http_info(self, query_id, body, **kwargs): # noqa: E501
"""Update a device query # noqa: E501
Update a specifc device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_update_with_http_info(query_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:param DeviceQueryPostPutRequest body: Device query update object. (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['query_id', 'body'] # noqa: E501
all_params.append('asynchronous')
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 device_query_update" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'query_id' is set
if ('query_id' not in params or
params['query_id'] is None):
raise ValueError("Missing the required parameter `query_id` when calling `device_query_update`") # 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 `device_query_update`") # noqa: E501
collection_formats = {}
path_params = {}
if 'query_id' in params:
path_params['query_id'] = params['query_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-queries/{query_id}/', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceQuery', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_retrieve(self, id, **kwargs): # noqa: E501
"""Get a devices # noqa: E501
Retrieve information about a specific device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_retrieve(id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_retrieve_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.device_retrieve_with_http_info(id, **kwargs) # noqa: E501
return data
def device_retrieve_with_http_info(self, id, **kwargs): # noqa: E501
"""Get a devices # noqa: E501
Retrieve information about a specific device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_retrieve_with_http_info(id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id'] # noqa: E501
all_params.append('asynchronous')
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 device_retrieve" % 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 `device_retrieve`") # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/devices/{id}/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceData', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 device_update(self, id, device, **kwargs): # noqa: E501
"""Update a device # noqa: E501
Update a specific device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_update(id, device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: The ID of the device. (required)
:param DeviceDataPutRequest device: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.device_update_with_http_info(id, device, **kwargs) # noqa: E501
else:
(data) = self.device_update_with_http_info(id, device, **kwargs) # noqa: E501
return data
def device_update_with_http_info(self, id, device, **kwargs): # noqa: E501
"""Update a device # noqa: E501
Update a specific device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_update_with_http_info(id, device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: The ID of the device. (required)
:param DeviceDataPutRequest device: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id', 'device'] # noqa: E501
all_params.append('asynchronous')
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 device_update" % 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 `device_update`") # noqa: E501
# verify the required parameter 'device' is set
if ('device' not in params or
params['device'] is None):
raise ValueError("Missing the required parameter `device` when calling `device_update`") # 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 'device' in params:
body_params = params['device']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/devices/{id}/', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceData', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 group_create(self, group, **kwargs): # noqa: E501
"""Create a group # noqa: E501
Create a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_create(group, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param Group group: Group (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.group_create_with_http_info(group, **kwargs) # noqa: E501
else:
(data) = self.group_create_with_http_info(group, **kwargs) # noqa: E501
return data
def group_create_with_http_info(self, group, **kwargs): # noqa: E501
"""Create a group # noqa: E501
Create a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_create_with_http_info(group, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param Group group: Group (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['group'] # noqa: E501
all_params.append('asynchronous')
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 group_create" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'group' is set
if ('group' not in params or
params['group'] is None):
raise ValueError("Missing the required parameter `group` when calling `group_create`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'group' in params:
body_params = params['group']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-groups/', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceGroup', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 group_delete(self, device_group_id, **kwargs): # noqa: E501
"""Delete a group # noqa: E501
Delete a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_delete(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.group_delete_with_http_info(device_group_id, **kwargs) # noqa: E501
else:
(data) = self.group_delete_with_http_info(device_group_id, **kwargs) # noqa: E501
return data
def group_delete_with_http_info(self, device_group_id, **kwargs): # noqa: E501
"""Delete a group # noqa: E501
Delete a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_delete_with_http_info(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['device_group_id'] # noqa: E501
all_params.append('asynchronous')
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 group_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'device_group_id' is set
if ('device_group_id' not in params or
params['device_group_id'] is None):
raise ValueError("Missing the required parameter `device_group_id` when calling `group_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'device_group_id' in params:
path_params['device-group-id'] = params['device_group_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-groups/{device-group-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,
asynchronous=params.get('asynchronous'),
_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 group_list(self, **kwargs): # noqa: E501
"""List all groups. # noqa: E501
List all groups. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_list(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>devices_count</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1=value1&key2=value2&key3=value3` would be URL-encoded as: `?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` **Filtering by properties** `name__eq=mygroup` **Filtering on date-time fields** Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `__eq` to the field name * greater than or equal to by appending `__gte` to the field name * less than or equal to by appending `__lte` to the field name `{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `__gte` and `__lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering on multiple fields** `name__eq=mygroup&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering with filter operators** String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__in=group1,group2`
:return: DeviceGroupPage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.group_list_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.group_list_with_http_info(**kwargs) # noqa: E501
return data
def group_list_with_http_info(self, **kwargs): # noqa: E501
"""List all groups. # noqa: E501
List all groups. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_list_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>devices_count</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1=value1&key2=value2&key3=value3` would be URL-encoded as: `?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` **Filtering by properties** `name__eq=mygroup` **Filtering on date-time fields** Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `__eq` to the field name * greater than or equal to by appending `__gte` to the field name * less than or equal to by appending `__lte` to the field name `{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `__gte` and `__lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering on multiple fields** `name__eq=mygroup&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering with filter operators** String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__in=group1,group2`
:return: DeviceGroupPage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'order', 'after', 'include', 'filter'] # noqa: E501
all_params.append('asynchronous')
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 group_list" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'filter' in params:
query_params.append(('filter', params['filter'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-groups/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceGroupPage', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 group_members_add(self, device_group_id, body, **kwargs): # noqa: E501
"""Add a device to a group # noqa: E501
Add one device to a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_add(device_group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:param DeviceGroupManipulation body: Body of the request (required)
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.group_members_add_with_http_info(device_group_id, body, **kwargs) # noqa: E501
else:
(data) = self.group_members_add_with_http_info(device_group_id, body, **kwargs) # noqa: E501
return data
def group_members_add_with_http_info(self, device_group_id, body, **kwargs): # noqa: E501
"""Add a device to a group # noqa: E501
Add one device to a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_add_with_http_info(device_group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:param DeviceGroupManipulation body: Body of the request (required)
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['device_group_id', 'body'] # noqa: E501
all_params.append('asynchronous')
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 group_members_add" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'device_group_id' is set
if ('device_group_id' not in params or
params['device_group_id'] is None):
raise ValueError("Missing the required parameter `device_group_id` when calling `group_members_add`") # 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 `group_members_add`") # noqa: E501
collection_formats = {}
path_params = {}
if 'device_group_id' in params:
path_params['device-group-id'] = params['device_group_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-groups/{device-group-id}/devices/add/', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DevicePage', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 group_members_remove(self, device_group_id, body, **kwargs): # noqa: E501
"""Remove a device from a group # noqa: E501
Remove one device from a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_remove(device_group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:param DeviceGroupManipulation body: Body of the request (required)
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.group_members_remove_with_http_info(device_group_id, body, **kwargs) # noqa: E501
else:
(data) = self.group_members_remove_with_http_info(device_group_id, body, **kwargs) # noqa: E501
return data
def group_members_remove_with_http_info(self, device_group_id, body, **kwargs): # noqa: E501
"""Remove a device from a group # noqa: E501
Remove one device from a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_remove_with_http_info(device_group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:param DeviceGroupManipulation body: Body of the request (required)
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['device_group_id', 'body'] # noqa: E501
all_params.append('asynchronous')
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 group_members_remove" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'device_group_id' is set
if ('device_group_id' not in params or
params['device_group_id'] is None):
raise ValueError("Missing the required parameter `device_group_id` when calling `group_members_remove`") # 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 `group_members_remove`") # noqa: E501
collection_formats = {}
path_params = {}
if 'device_group_id' in params:
path_params['device-group-id'] = params['device_group_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-groups/{device-group-id}/devices/remove/', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DevicePage', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 group_members_retrieve(self, device_group_id, **kwargs): # noqa: E501
"""Get a page of devices # noqa: E501
Get a page of device # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_retrieve(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: (required)
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>devices_count</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1=value1&key2=value2&key3=value3` would be URL-encoded as: `?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` **Filtering by properties** `name__eq=mygroup` **Filtering on date-time fields** Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `__eq` to the field name * greater than or equal to by appending `__gte` to the field name * less than or equal to by appending `__lte` to the field name `{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `__gte` and `__lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering on multiple fields** `name__eq=mygroup&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering with filter operators** String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__in=group1,group2`
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.group_members_retrieve_with_http_info(device_group_id, **kwargs) # noqa: E501
else:
(data) = self.group_members_retrieve_with_http_info(device_group_id, **kwargs) # noqa: E501
return data
def group_members_retrieve_with_http_info(self, device_group_id, **kwargs): # noqa: E501
"""Get a page of devices # noqa: E501
Get a page of device # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_retrieve_with_http_info(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: (required)
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>devices_count</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1=value1&key2=value2&key3=value3` would be URL-encoded as: `?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` **Filtering by properties** `name__eq=mygroup` **Filtering on date-time fields** Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `__eq` to the field name * greater than or equal to by appending `__gte` to the field name * less than or equal to by appending `__lte` to the field name `{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `__gte` and `__lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering on multiple fields** `name__eq=mygroup&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering with filter operators** String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__in=group1,group2`
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['device_group_id', 'limit', 'order', 'after', 'include', 'filter'] # noqa: E501
all_params.append('asynchronous')
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 group_members_retrieve" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'device_group_id' is set
if ('device_group_id' not in params or
params['device_group_id'] is None):
raise ValueError("Missing the required parameter `device_group_id` when calling `group_members_retrieve`") # noqa: E501
collection_formats = {}
path_params = {}
if 'device_group_id' in params:
path_params['device-group-id'] = params['device_group_id'] # noqa: E501
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'order' in params:
query_params.append(('order', params['order'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # noqa: E501
if 'include' in params:
query_params.append(('include', params['include'])) # noqa: E501
if 'filter' in params:
query_params.append(('filter', params['filter'])) # 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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-groups/{device-group-id}/devices/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DevicePage', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 group_retrieve(self, device_group_id, **kwargs): # noqa: E501
"""Get a group. # noqa: E501
Get a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_retrieve(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The group ID (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.group_retrieve_with_http_info(device_group_id, **kwargs) # noqa: E501
else:
(data) = self.group_retrieve_with_http_info(device_group_id, **kwargs) # noqa: E501
return data
def group_retrieve_with_http_info(self, device_group_id, **kwargs): # noqa: E501
"""Get a group. # noqa: E501
Get a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_retrieve_with_http_info(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The group ID (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['device_group_id'] # noqa: E501
all_params.append('asynchronous')
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 group_retrieve" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'device_group_id' is set
if ('device_group_id' not in params or
params['device_group_id'] is None):
raise ValueError("Missing the required parameter `device_group_id` when calling `group_retrieve`") # noqa: E501
collection_formats = {}
path_params = {}
if 'device_group_id' in params:
path_params['device-group-id'] = params['device_group_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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-groups/{device-group-id}/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceGroup', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 group_update(self, device_group_id, group, **kwargs): # noqa: E501
"""Modify the attributes of a group. # noqa: E501
Modify the attributes of a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_update(device_group_id, group, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: (required)
:param Group1 group: Group (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.group_update_with_http_info(device_group_id, group, **kwargs) # noqa: E501
else:
(data) = self.group_update_with_http_info(device_group_id, group, **kwargs) # noqa: E501
return data
def group_update_with_http_info(self, device_group_id, group, **kwargs): # noqa: E501
"""Modify the attributes of a group. # noqa: E501
Modify the attributes of a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_update_with_http_info(device_group_id, group, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: (required)
:param Group1 group: Group (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['device_group_id', 'group'] # noqa: E501
all_params.append('asynchronous')
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 group_update" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'device_group_id' is set
if ('device_group_id' not in params or
params['device_group_id'] is None):
raise ValueError("Missing the required parameter `device_group_id` when calling `group_update`") # noqa: E501
# verify the required parameter 'group' is set
if ('group' not in params or
params['group'] is None):
raise ValueError("Missing the required parameter `group` when calling `group_update`") # noqa: E501
collection_formats = {}
path_params = {}
if 'device_group_id' in params:
path_params['device-group-id'] = params['device_group_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'group' in params:
body_params = params['group']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/device-groups/{device-group-id}/', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeviceGroup', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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)
|
class DefaultApi(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):
pass
def device_create(self, device, **kwargs):
'''Create a device # noqa: E501
Create a new device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_create(device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param DeviceDataPostRequest device: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_create_with_http_info(self, device, **kwargs):
'''Create a device # noqa: E501
Create a new device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_create_with_http_info(device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param DeviceDataPostRequest device: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_destroy(self, id, **kwargs):
'''Delete a device. # noqa: E501
Delete device. Only available for devices with a developer certificate. Attempts to delete a device with a production certicate will return a 400 response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_destroy(id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_destroy_with_http_info(self, id, **kwargs):
'''Delete a device. # noqa: E501
Delete device. Only available for devices with a developer certificate. Attempts to delete a device with a production certicate will return a 400 response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_destroy_with_http_info(id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_event_list(self, **kwargs):
'''List all device events. # noqa: E501
List all device events for an account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_event_list(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>date_time</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>event_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state_change</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By id: ```id={id}``` ###### By state change: ```state_change=[True|False]``` ###### By event type: ```event_type={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```id=0158d38771f70000000000010010038c&state_change=True&date_time__gte=2016-11-30T16:25:12.1234Z``` Encoded: ```?filter=id%3D0158d38771f70000000000010010038c%26state_change%3DTrue%26date_time__gte%3D2016-11-30T16%3A25%3A12.1234Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `event_type__in=update.device.device-created,update.device.device-updated`
:return: DeviceEventPage
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_event_list_with_http_info(self, **kwargs):
'''List all device events. # noqa: E501
List all device events for an account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_event_list_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>date_time</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>event_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state_change</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By id: ```id={id}``` ###### By state change: ```state_change=[True|False]``` ###### By event type: ```event_type={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```id=0158d38771f70000000000010010038c&state_change=True&date_time__gte=2016-11-30T16:25:12.1234Z``` Encoded: ```?filter=id%3D0158d38771f70000000000010010038c%26state_change%3DTrue%26date_time__gte%3D2016-11-30T16%3A25%3A12.1234Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `event_type__in=update.device.device-created,update.device.device-updated`
:return: DeviceEventPage
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_event_retrieve(self, device_event_id, **kwargs):
'''Retrieve a device event. # noqa: E501
Retrieve a specific device event. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_event_retrieve(device_event_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_event_id: (required)
:return: DeviceEventData
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_event_retrieve_with_http_info(self, device_event_id, **kwargs):
'''Retrieve a device event. # noqa: E501
Retrieve a specific device event. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_event_retrieve_with_http_info(device_event_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_event_id: (required)
:return: DeviceEventData
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_list(self, **kwargs):
'''List all devices. # noqa: E501
List all devices. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_list(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>account_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>auto_update</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>bootstrap_expiration_date</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>bootstrapped_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>ca_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>connector_expiration_date</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> <td> </td> </tr> <tr> <td>deployed_state</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>deployment</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_class</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_execution_mode</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_key</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>endpoint_name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>endpoint_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>enrolment_list_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>firmware_checksum</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>host_gateway</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>manifest</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>manifest_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>mechanism</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>mechanism_url</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>serial_number</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>vendor_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By device properties (all properties are filterable): ```state=[unenrolled|cloud_enrolling|bootstrapped|registered]``` ```device_class={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ###### On device custom attributes: ```custom_attributes__{param}={value}``` ```custom_attributes__tag=TAG1``` ##### Multi-field example ```state=bootstrapped&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z``` Encoded: ```?filter=state%3Dbootstrapped%26created_at__gte%3D2016-11-30T16%3A25%3A12.1234Z%26created_at__lte%3D2016-11-30T00%3A00%3A00Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `state__nin=unenrolled,dergistered`
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_list_with_http_info(self, **kwargs):
'''List all devices. # noqa: E501
List all devices. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_list_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>account_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>auto_update</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>bootstrap_expiration_date</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>bootstrapped_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>ca_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>connector_expiration_date</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> <td> </td> </tr> <tr> <td>deployed_state</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>deployment</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_class</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_execution_mode</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_key</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>endpoint_name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>endpoint_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>enrolment_list_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>firmware_checksum</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>host_gateway</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>manifest</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>manifest_timestamp</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>mechanism</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>mechanism_url</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>serial_number</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>vendor_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By device properties (all properties are filterable): ```state=[unenrolled|cloud_enrolling|bootstrapped|registered]``` ```device_class={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ###### On device custom attributes: ```custom_attributes__{param}={value}``` ```custom_attributes__tag=TAG1``` ##### Multi-field example ```state=bootstrapped&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z``` Encoded: ```?filter=state%3Dbootstrapped%26created_at__gte%3D2016-11-30T16%3A25%3A12.1234Z%26created_at__lte%3D2016-11-30T00%3A00%3A00Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `state__nin=unenrolled,dergistered`
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_log_list(self, **kwargs):
'''DEPRECATED: List all device events. # noqa: E501
DEPRECATED: List all device events. Use `/v3/device-events/` instead. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_log_list(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>date_time</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>event_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state_change</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By id: ```id={id}``` ###### By state change: ```state_change=[True|False]``` ###### By event type: ```event_type={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```id=0158d38771f70000000000010010038c&state_change=True&date_time__gte=2016-11-30T16:25:12.1234Z``` Encoded: ```?filter=id%3D0158d38771f70000000000010010038c%26state_change%3DTrue%26date_time__gte%3D2016-11-30T16%3A25%3A12.1234Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `event_type__in=update.device.device-created,update.device.device-updated`
:return: DeviceEventPage
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_log_list_with_http_info(self, **kwargs):
'''DEPRECATED: List all device events. # noqa: E501
DEPRECATED: List all device events. Use `/v3/device-events/` instead. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_log_list_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` ###### Filterable fields: The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>date_time</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>device_id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>event_type</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>state_change</td> <td>✓</td> <td>✓</td> <td> </td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By id: ```id={id}``` ###### By state change: ```state_change=[True|False]``` ###### By event type: ```event_type={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```id=0158d38771f70000000000010010038c&state_change=True&date_time__gte=2016-11-30T16:25:12.1234Z``` Encoded: ```?filter=id%3D0158d38771f70000000000010010038c%26state_change%3DTrue%26date_time__gte%3D2016-11-30T16%3A25%3A12.1234Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `event_type__in=update.device.device-created,update.device.device-updated`
:return: DeviceEventPage
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_log_retrieve(self, device_event_id, **kwargs):
'''DEPRECATED: Retrieve a device event. # noqa: E501
Retrieve device event (deprecated, use /v3/device-events/{device_event_id}/ instead) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_log_retrieve(device_event_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_event_id: (required)
:return: DeviceEventData
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_log_retrieve_with_http_info(self, device_event_id, **kwargs):
'''DEPRECATED: Retrieve a device event. # noqa: E501
Retrieve device event (deprecated, use /v3/device-events/{device_event_id}/ instead) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_log_retrieve_with_http_info(device_event_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_event_id: (required)
:return: DeviceEventData
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_query_create(self, device, **kwargs):
'''Create a device query # noqa: E501
Create a new device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_create(device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param DeviceQueryPostPutRequest device: (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_query_create_with_http_info(self, device, **kwargs):
'''Create a device query # noqa: E501
Create a new device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_create_with_http_info(device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param DeviceQueryPostPutRequest device: (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_query_destroy(self, query_id, **kwargs):
'''Delete a device query # noqa: E501
Delete a device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_destroy(query_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_query_destroy_with_http_info(self, query_id, **kwargs):
'''Delete a device query # noqa: E501
Delete a device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_destroy_with_http_info(query_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_query_list(self, **kwargs):
'''List device queries. # noqa: E501
List all device queries. The result will be paged into pages of 100. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_list(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>query</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By device query properties (all properties are filterable): For example: ```description={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```query_id=0158d38771f70000000000010010038c&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z``` Encoded: ```filter=query_id%3D0158d38771f70000000000010010038c%26created_at__gte%3D2016-11-30T16%3A25%3A12.1234Z%26created_at__lte%3D2016-11-30T00%3A00%3A00Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__nin=query1,query2`
:return: DeviceQueryPage
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_query_list_with_http_info(self, **kwargs):
'''List device queries. # noqa: E501
List all device queries. The result will be paged into pages of 100. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_list_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL encoded query string parameter to filter returned data. ##### Filtering ```?filter={URL encoded query string}``` The query string is made up of key/value pairs separated by ampersands. So for a query of ```key1=value1&key2=value2&key3=value3``` this would be encoded as follows: ```?filter=key1%3Dvalue1%26key2%3Dvalue2%26key3%3Dvalue3``` The below table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>query</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The examples below show the queries in *unencoded* form. ###### By device query properties (all properties are filterable): For example: ```description={value}``` ###### On date-time fields: Date-time fields should be specified in UTC RFC3339 format ```YYYY-MM-DDThh:mm:ss.msZ```. There are three permitted variations: * UTC RFC3339 with milliseconds e.g. 2016-11-30T16:25:12.1234Z * UTC RFC3339 without milliseconds e.g. 2016-11-30T16:25:12Z * UTC RFC3339 shortened - without milliseconds and punctuation e.g. 20161130T162512Z Date-time filtering supports three operators: * equality * greater than or equal to – field name suffixed with ```__gte``` * less than or equal to – field name suffixed with ```__lte``` Lower and upper limits to a date-time range may be specified by including both the ```__gte``` and ```__lte``` forms in the filter. ```{field name}[|__lte|__gte]={UTC RFC3339 date-time}``` ##### Multi-field example ```query_id=0158d38771f70000000000010010038c&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z``` Encoded: ```filter=query_id%3D0158d38771f70000000000010010038c%26created_at__gte%3D2016-11-30T16%3A25%3A12.1234Z%26created_at__lte%3D2016-11-30T00%3A00%3A00Z``` ##### Filtering with filter operators String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__nin=query1,query2`
:return: DeviceQueryPage
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_query_retrieve(self, query_id, **kwargs):
'''Retrieve a device query. # noqa: E501
Retrieve a specific device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_retrieve(query_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_query_retrieve_with_http_info(self, query_id, **kwargs):
'''Retrieve a device query. # noqa: E501
Retrieve a specific device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_retrieve_with_http_info(query_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_query_update(self, query_id, body, **kwargs):
'''Update a device query # noqa: E501
Update a specifc device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_update(query_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:param DeviceQueryPostPutRequest body: Device query update object. (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_query_update_with_http_info(self, query_id, body, **kwargs):
'''Update a device query # noqa: E501
Update a specifc device query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_query_update_with_http_info(query_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str query_id: (required)
:param DeviceQueryPostPutRequest body: Device query update object. (required)
:return: DeviceQuery
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_retrieve(self, id, **kwargs):
'''Get a devices # noqa: E501
Retrieve information about a specific device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_retrieve(id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_retrieve_with_http_info(self, id, **kwargs):
'''Get a devices # noqa: E501
Retrieve information about a specific device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_retrieve_with_http_info(id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_update(self, id, device, **kwargs):
'''Update a device # noqa: E501
Update a specific device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_update(id, device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: The ID of the device. (required)
:param DeviceDataPutRequest device: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
'''
pass
def device_update_with_http_info(self, id, device, **kwargs):
'''Update a device # noqa: E501
Update a specific device. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.device_update_with_http_info(id, device, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str id: The ID of the device. (required)
:param DeviceDataPutRequest device: (required)
:return: DeviceData
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_create(self, group, **kwargs):
'''Create a group # noqa: E501
Create a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_create(group, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param Group group: Group (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_create_with_http_info(self, group, **kwargs):
'''Create a group # noqa: E501
Create a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_create_with_http_info(group, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param Group group: Group (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_delete(self, device_group_id, **kwargs):
'''Delete a group # noqa: E501
Delete a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_delete(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_delete_with_http_info(self, device_group_id, **kwargs):
'''Delete a group # noqa: E501
Delete a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_delete_with_http_info(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_list(self, **kwargs):
'''List all groups. # noqa: E501
List all groups. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_list(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>devices_count</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1=value1&key2=value2&key3=value3` would be URL-encoded as: `?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` **Filtering by properties** `name__eq=mygroup` **Filtering on date-time fields** Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `__eq` to the field name * greater than or equal to by appending `__gte` to the field name * less than or equal to by appending `__lte` to the field name `{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `__gte` and `__lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering on multiple fields** `name__eq=mygroup&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering with filter operators** String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__in=group1,group2`
:return: DeviceGroupPage
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_list_with_http_info(self, **kwargs):
'''List all groups. # noqa: E501
List all groups. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_list_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>devices_count</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1=value1&key2=value2&key3=value3` would be URL-encoded as: `?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` **Filtering by properties** `name__eq=mygroup` **Filtering on date-time fields** Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `__eq` to the field name * greater than or equal to by appending `__gte` to the field name * less than or equal to by appending `__lte` to the field name `{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `__gte` and `__lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering on multiple fields** `name__eq=mygroup&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering with filter operators** String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__in=group1,group2`
:return: DeviceGroupPage
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_members_add(self, device_group_id, body, **kwargs):
'''Add a device to a group # noqa: E501
Add one device to a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_add(device_group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:param DeviceGroupManipulation body: Body of the request (required)
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_members_add_with_http_info(self, device_group_id, body, **kwargs):
'''Add a device to a group # noqa: E501
Add one device to a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_add_with_http_info(device_group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:param DeviceGroupManipulation body: Body of the request (required)
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_members_remove(self, device_group_id, body, **kwargs):
'''Remove a device from a group # noqa: E501
Remove one device from a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_remove(device_group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:param DeviceGroupManipulation body: Body of the request (required)
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_members_remove_with_http_info(self, device_group_id, body, **kwargs):
'''Remove a device from a group # noqa: E501
Remove one device from a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_remove_with_http_info(device_group_id, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The ID of the group (required)
:param DeviceGroupManipulation body: Body of the request (required)
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_members_retrieve(self, device_group_id, **kwargs):
'''Get a page of devices # noqa: E501
Get a page of device # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_retrieve(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: (required)
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>devices_count</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1=value1&key2=value2&key3=value3` would be URL-encoded as: `?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` **Filtering by properties** `name__eq=mygroup` **Filtering on date-time fields** Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `__eq` to the field name * greater than or equal to by appending `__gte` to the field name * less than or equal to by appending `__lte` to the field name `{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `__gte` and `__lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering on multiple fields** `name__eq=mygroup&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering with filter operators** String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__in=group1,group2`
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_members_retrieve_with_http_info(self, device_group_id, **kwargs):
'''Get a page of devices # noqa: E501
Get a page of device # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_members_retrieve_with_http_info(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: (required)
:param int limit: How many objects to retrieve in the page.
:param str order: The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`.
:param str after: The ID of The item after which to retrieve the next page.
:param str include: Comma-separated list of data fields to return. Currently supported: `total_count`.
:param str filter: URL-encoded query string parameter to filter returned data `?filter={URL-encoded query string}` ###### Filterable fields: The table lists all the fields that can be filtered on with certain filters: <table> <thead> <tr> <th>Field</th> <th>= / __eq / __neq</th> <th>__in / __nin</th> <th>__lte / __gte</th> <tr> <thead> <tbody> <tr> <td>id</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>devices_count</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>name</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>description</td> <td>✓</td> <td>✓</td> <td> </td> </tr> <tr> <td>custom_attributes</td> <td>✓</td> <td> </td> </tr> <tr> <td>created_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>updated_at</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> <tr> <td>etag</td> <td>✓</td> <td>✓</td> <td>✓</td> </tr> </tbody> </table> The query string is made up of key-value pairs separated by ampersands. For example, this query: `key1=value1&key2=value2&key3=value3` would be URL-encoded as: `?filter=key1__eq%3Dvalue1%26key2__eq%3Dvalue2%26key3__eq%3Dvalue3` **Filtering by properties** `name__eq=mygroup` **Filtering on date-time fields** Date-time fields should be specified in UTC RFC3339 format, `YYYY-MM-DDThh:mm:ss.msZ`. There are three permitted variations: * UTC RFC3339 with milliseconds. Example: `2016-11-30T16:25:12.1234Z` * UTC RFC3339 without milliseconds. Example: `2016-11-30T16:25:12Z` * UTC RFC3339 shortened without milliseconds and punctuation. Example: `20161130T162512Z` Date-time filtering supports three operators: * equality by appending `__eq` to the field name * greater than or equal to by appending `__gte` to the field name * less than or equal to by appending `__lte` to the field name `{field name}[|__eq|__lte|__gte]={UTC RFC3339 date-time}` Time ranges may be specified by including both the `__gte` and `__lte` forms in the filter. For example: `created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering on multiple fields** `name__eq=mygroup&created_at__gte=2016-11-30T16:25:12.1234Z&created_at__lte=2016-12-30T00:00:00Z` **Filtering with filter operators** String field filtering supports the following operators: * equality: `__eq` * non-equality: `__neq` * in : `__in` * not in: `__nin` For `__in` and `__nin` filters list of parameters must be comma-separated: `name__in=group1,group2`
:return: DevicePage
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_retrieve(self, device_group_id, **kwargs):
'''Get a group. # noqa: E501
Get a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_retrieve(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The group ID (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_retrieve_with_http_info(self, device_group_id, **kwargs):
'''Get a group. # noqa: E501
Get a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_retrieve_with_http_info(device_group_id, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: The group ID (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_update(self, device_group_id, group, **kwargs):
'''Modify the attributes of a group. # noqa: E501
Modify the attributes of a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_update(device_group_id, group, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: (required)
:param Group1 group: Group (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
'''
pass
def group_update_with_http_info(self, device_group_id, group, **kwargs):
'''Modify the attributes of a group. # noqa: E501
Modify the attributes of a group. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.group_update_with_http_info(device_group_id, group, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str device_group_id: (required)
:param Group1 group: Group (required)
:return: DeviceGroup
If the method is called asynchronously,
returns the request thread.
'''
pass
| 46 | 45 | 48 | 7 | 27 | 20 | 4 | 0.74 | 1 | 3 | 1 | 0 | 45 | 1 | 45 | 45 | 2,221 | 354 | 1,209 | 311 | 1,163 | 900 | 769 | 311 | 723 | 10 | 1 | 2 | 186 |
2,480 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_ca/models/server_credentials_response_data.py
|
mbed_cloud._backends.connector_ca.models.server_credentials_response_data.ServerCredentialsResponseData
|
class ServerCredentialsResponseData(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 = {
'created_at': 'datetime',
'etag': 'str',
'id': 'str',
'object': 'str',
'server_certificate': 'str',
'server_uri': 'str'
}
attribute_map = {
'created_at': 'created_at',
'etag': 'etag',
'id': 'id',
'object': 'object',
'server_certificate': 'server_certificate',
'server_uri': 'server_uri'
}
def __init__(self, created_at=None, etag=None, id=None, object=None, server_certificate=None, server_uri=None):
"""
ServerCredentialsResponseData - a model defined in Swagger
"""
self._created_at = created_at
self._etag = etag
self._id = id
self._object = object
self._server_certificate = server_certificate
self._server_uri = server_uri
self.discriminator = None
@property
def created_at(self):
"""
Gets the created_at of this ServerCredentialsResponseData.
Creation UTC time RFC3339.
:return: The created_at of this ServerCredentialsResponseData.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this ServerCredentialsResponseData.
Creation UTC time RFC3339.
:param created_at: The created_at of this ServerCredentialsResponseData.
:type: datetime
"""
self._created_at = created_at
@property
def etag(self):
"""
Gets the etag of this ServerCredentialsResponseData.
API resource entity version.
:return: The etag of this ServerCredentialsResponseData.
:rtype: str
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this ServerCredentialsResponseData.
API resource entity version.
:param etag: The etag of this ServerCredentialsResponseData.
:type: str
"""
self._etag = etag
@property
def id(self):
"""
Gets the id of this ServerCredentialsResponseData.
mUUID that uniquely identifies the entity.
:return: The id of this ServerCredentialsResponseData.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this ServerCredentialsResponseData.
mUUID that uniquely identifies the entity.
:param id: The id of this ServerCredentialsResponseData.
:type: str
"""
self._id = id
@property
def object(self):
"""
Gets the object of this ServerCredentialsResponseData.
Entity name, always 'server-credentials'
:return: The object of this ServerCredentialsResponseData.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ServerCredentialsResponseData.
Entity name, always 'server-credentials'
:param object: The object of this ServerCredentialsResponseData.
:type: str
"""
self._object = object
@property
def server_certificate(self):
"""
Gets the server_certificate of this ServerCredentialsResponseData.
PEM format X.509 server certificate that will be used to validate the server certificate that will be received during the TLS/DTLS handshake.
:return: The server_certificate of this ServerCredentialsResponseData.
:rtype: str
"""
return self._server_certificate
@server_certificate.setter
def server_certificate(self, server_certificate):
"""
Sets the server_certificate of this ServerCredentialsResponseData.
PEM format X.509 server certificate that will be used to validate the server certificate that will be received during the TLS/DTLS handshake.
:param server_certificate: The server_certificate of this ServerCredentialsResponseData.
:type: str
"""
self._server_certificate = server_certificate
@property
def server_uri(self):
"""
Gets the server_uri of this ServerCredentialsResponseData.
Server URI to which the client needs to connect to.
:return: The server_uri of this ServerCredentialsResponseData.
:rtype: str
"""
return self._server_uri
@server_uri.setter
def server_uri(self, server_uri):
"""
Sets the server_uri of this ServerCredentialsResponseData.
Server URI to which the client needs to connect to.
:param server_uri: The server_uri of this ServerCredentialsResponseData.
:type: str
"""
self._server_uri = server_uri
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ServerCredentialsResponseData):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ServerCredentialsResponseData(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created_at=None, etag=None, id=None, object=None, server_certificate=None, server_uri=None):
'''
ServerCredentialsResponseData - a model defined in Swagger
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this ServerCredentialsResponseData.
Creation UTC time RFC3339.
:return: The created_at of this ServerCredentialsResponseData.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this ServerCredentialsResponseData.
Creation UTC time RFC3339.
:param created_at: The created_at of this ServerCredentialsResponseData.
:type: datetime
'''
pass
@property
def etag(self):
'''
Gets the etag of this ServerCredentialsResponseData.
API resource entity version.
:return: The etag of this ServerCredentialsResponseData.
:rtype: str
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this ServerCredentialsResponseData.
API resource entity version.
:param etag: The etag of this ServerCredentialsResponseData.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this ServerCredentialsResponseData.
mUUID that uniquely identifies the entity.
:return: The id of this ServerCredentialsResponseData.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this ServerCredentialsResponseData.
mUUID that uniquely identifies the entity.
:param id: The id of this ServerCredentialsResponseData.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this ServerCredentialsResponseData.
Entity name, always 'server-credentials'
:return: The object of this ServerCredentialsResponseData.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ServerCredentialsResponseData.
Entity name, always 'server-credentials'
:param object: The object of this ServerCredentialsResponseData.
:type: str
'''
pass
@property
def server_certificate(self):
'''
Gets the server_certificate of this ServerCredentialsResponseData.
PEM format X.509 server certificate that will be used to validate the server certificate that will be received during the TLS/DTLS handshake.
:return: The server_certificate of this ServerCredentialsResponseData.
:rtype: str
'''
pass
@server_certificate.setter
def server_certificate(self):
'''
Sets the server_certificate of this ServerCredentialsResponseData.
PEM format X.509 server certificate that will be used to validate the server certificate that will be received during the TLS/DTLS handshake.
:param server_certificate: The server_certificate of this ServerCredentialsResponseData.
:type: str
'''
pass
@property
def server_uri(self):
'''
Gets the server_uri of this ServerCredentialsResponseData.
Server URI to which the client needs to connect to.
:return: The server_uri of this ServerCredentialsResponseData.
:rtype: str
'''
pass
@server_uri.setter
def server_uri(self):
'''
Sets the server_uri of this ServerCredentialsResponseData.
Server URI to which the client needs to connect to.
:param server_uri: The server_uri of this ServerCredentialsResponseData.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 10 | 1 | 3 | 5 | 1 | 1.11 | 1 | 3 | 0 | 0 | 18 | 7 | 18 | 18 | 235 | 43 | 91 | 43 | 60 | 101 | 55 | 31 | 36 | 5 | 1 | 2 | 23 |
2,481 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/billing/models/subtenant_service_package_report.py
|
mbed_cloud._backends.billing.models.subtenant_service_package_report.SubtenantServicePackageReport
|
class SubtenantServicePackageReport(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 = {
'quota_usage': 'list[QuotaUsageReport]'
}
attribute_map = {
'quota_usage': 'quota_usage'
}
def __init__(self, quota_usage=None):
"""
SubtenantServicePackageReport - a model defined in Swagger
"""
self._quota_usage = quota_usage
self.discriminator = None
@property
def quota_usage(self):
"""
Gets the quota_usage of this SubtenantServicePackageReport.
:return: The quota_usage of this SubtenantServicePackageReport.
:rtype: list[QuotaUsageReport]
"""
return self._quota_usage
@quota_usage.setter
def quota_usage(self, quota_usage):
"""
Sets the quota_usage of this SubtenantServicePackageReport.
:param quota_usage: The quota_usage of this SubtenantServicePackageReport.
:type: list[QuotaUsageReport]
"""
if quota_usage is None:
raise ValueError("Invalid value for `quota_usage`, must not be `None`")
self._quota_usage = quota_usage
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, SubtenantServicePackageReport):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class SubtenantServicePackageReport(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, quota_usage=None):
'''
SubtenantServicePackageReport - a model defined in Swagger
'''
pass
@property
def quota_usage(self):
'''
Gets the quota_usage of this SubtenantServicePackageReport.
:return: The quota_usage of this SubtenantServicePackageReport.
:rtype: list[QuotaUsageReport]
'''
pass
@quota_usage.setter
def quota_usage(self):
'''
Sets the quota_usage of this SubtenantServicePackageReport.
:param quota_usage: The quota_usage of this SubtenantServicePackageReport.
:type: list[QuotaUsageReport]
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 11 | 9 | 9 | 1 | 5 | 4 | 2 | 0.81 | 1 | 4 | 0 | 0 | 8 | 2 | 8 | 8 | 105 | 18 | 48 | 18 | 37 | 39 | 32 | 16 | 23 | 5 | 1 | 2 | 14 |
2,482 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_ca/models/error_response.py
|
mbed_cloud._backends.connector_ca.models.error_response.ErrorResponse
|
class ErrorResponse(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'code': 'int',
'fields': 'list[Field]',
'message': 'str',
'object': 'str',
'request_id': 'str',
'type': 'str'
}
attribute_map = {
'code': 'code',
'fields': 'fields',
'message': 'message',
'object': 'object',
'request_id': 'request_id',
'type': 'type'
}
def __init__(self, code=None, fields=None, message=None, object='error', request_id=None, type=None):
"""
ErrorResponse - a model defined in Swagger
"""
self._code = code
self._fields = fields
self._message = message
self._object = object
self._request_id = request_id
self._type = type
self.discriminator = None
@property
def code(self):
"""
Gets the code of this ErrorResponse.
Response code.
:return: The code of this ErrorResponse.
:rtype: int
"""
return self._code
@code.setter
def code(self, code):
"""
Sets the code of this ErrorResponse.
Response code.
:param code: The code of this ErrorResponse.
:type: int
"""
allowed_values = [400, 401, 404]
if code not in allowed_values:
raise ValueError(
"Invalid value for `code` ({0}), must be one of {1}"
.format(code, allowed_values)
)
self._code = code
@property
def fields(self):
"""
Gets the fields of this ErrorResponse.
Failed input fields during request object validation.
:return: The fields of this ErrorResponse.
:rtype: list[Field]
"""
return self._fields
@fields.setter
def fields(self, fields):
"""
Sets the fields of this ErrorResponse.
Failed input fields during request object validation.
:param fields: The fields of this ErrorResponse.
:type: list[Field]
"""
self._fields = fields
@property
def message(self):
"""
Gets the message of this ErrorResponse.
A human readable message with detailed info.
:return: The message of this ErrorResponse.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this ErrorResponse.
A human readable message with detailed info.
:param message: The message of this ErrorResponse.
:type: str
"""
self._message = message
@property
def object(self):
"""
Gets the object of this ErrorResponse.
Entity name, always 'error'.
:return: The object of this ErrorResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ErrorResponse.
Entity name, always 'error'.
:param object: The object of this ErrorResponse.
:type: str
"""
allowed_values = ["error"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def request_id(self):
"""
Gets the request_id of this ErrorResponse.
Request ID (muuid).
:return: The request_id of this ErrorResponse.
:rtype: str
"""
return self._request_id
@request_id.setter
def request_id(self, request_id):
"""
Sets the request_id of this ErrorResponse.
Request ID (muuid).
:param request_id: The request_id of this ErrorResponse.
:type: str
"""
if request_id is not None and not re.search('^[A-Za-z0-9]{32}', request_id):
raise ValueError("Invalid value for `request_id`, must be a follow pattern or equal to `/^[A-Za-z0-9]{32}/`")
self._request_id = request_id
@property
def type(self):
"""
Gets the type of this ErrorResponse.
Error type.
:return: The type of this ErrorResponse.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this ErrorResponse.
Error type.
:param type: The type of this ErrorResponse.
:type: str
"""
allowed_values = ["validation_error", "invalid_token", "invalid_apikey", "reauth_required", "access_denied", "account_limit_exceeded", "not_found", "method_not_supported", "not_acceptable", "duplicate", "precondition_failed", "unsupported_media_type", "rate_limit_exceeded", "internal_server_error", "system_unavailable"]
if type not in allowed_values:
raise ValueError(
"Invalid value for `type` ({0}), must be one of {1}"
.format(type, allowed_values)
)
self._type = type
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ErrorResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ErrorResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, code=None, fields=None, message=None, object='error', request_id=None, type=None):
'''
ErrorResponse - a model defined in Swagger
'''
pass
@property
def code(self):
'''
Gets the code of this ErrorResponse.
Response code.
:return: The code of this ErrorResponse.
:rtype: int
'''
pass
@code.setter
def code(self):
'''
Sets the code of this ErrorResponse.
Response code.
:param code: The code of this ErrorResponse.
:type: int
'''
pass
@property
def fields(self):
'''
Gets the fields of this ErrorResponse.
Failed input fields during request object validation.
:return: The fields of this ErrorResponse.
:rtype: list[Field]
'''
pass
@fields.setter
def fields(self):
'''
Sets the fields of this ErrorResponse.
Failed input fields during request object validation.
:param fields: The fields of this ErrorResponse.
:type: list[Field]
'''
pass
@property
def message(self):
'''
Gets the message of this ErrorResponse.
A human readable message with detailed info.
:return: The message of this ErrorResponse.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this ErrorResponse.
A human readable message with detailed info.
:param message: The message of this ErrorResponse.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this ErrorResponse.
Entity name, always 'error'.
:return: The object of this ErrorResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ErrorResponse.
Entity name, always 'error'.
:param object: The object of this ErrorResponse.
:type: str
'''
pass
@property
def request_id(self):
'''
Gets the request_id of this ErrorResponse.
Request ID (muuid).
:return: The request_id of this ErrorResponse.
:rtype: str
'''
pass
@request_id.setter
def request_id(self):
'''
Sets the request_id of this ErrorResponse.
Request ID (muuid).
:param request_id: The request_id of this ErrorResponse.
:type: str
'''
pass
@property
def type(self):
'''
Gets the type of this ErrorResponse.
Error type.
:return: The type of this ErrorResponse.
:rtype: str
'''
pass
@type.setter
def type(self):
'''
Sets the type of this ErrorResponse.
Error type.
:param type: The type of this ErrorResponse.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 11 | 1 | 5 | 5 | 2 | 0.91 | 1 | 4 | 0 | 0 | 18 | 7 | 18 | 18 | 255 | 43 | 111 | 46 | 80 | 101 | 66 | 34 | 47 | 5 | 1 | 2 | 27 |
2,483 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_ca/models/developer_certificate_request_data.py
|
mbed_cloud._backends.connector_ca.models.developer_certificate_request_data.DeveloperCertificateRequestData
|
class DeveloperCertificateRequestData(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 = {
'description': 'str',
'name': 'str'
}
attribute_map = {
'description': 'description',
'name': 'name'
}
def __init__(self, description=None, name=None):
"""
DeveloperCertificateRequestData - a model defined in Swagger
"""
self._description = description
self._name = name
self.discriminator = None
@property
def description(self):
"""
Gets the description of this DeveloperCertificateRequestData.
Description for the developer certificate. There is a limit on the length of the description. Please see [TrustedCertificateReq](/docs/current/api-references/account-management-api.html#trustedcertificatereq)
:return: The description of this DeveloperCertificateRequestData.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeveloperCertificateRequestData.
Description for the developer certificate. There is a limit on the length of the description. Please see [TrustedCertificateReq](/docs/current/api-references/account-management-api.html#trustedcertificatereq)
:param description: The description of this DeveloperCertificateRequestData.
:type: str
"""
self._description = description
@property
def name(self):
"""
Gets the name of this DeveloperCertificateRequestData.
Name of the developer certificate, must be unique. There is a limit on the length of the name. Please see [TrustedCertificateReq](/docs/current/api-references/account-management-api.html#trustedcertificatereq)
:return: The name of this DeveloperCertificateRequestData.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeveloperCertificateRequestData.
Name of the developer certificate, must be unique. There is a limit on the length of the name. Please see [TrustedCertificateReq](/docs/current/api-references/account-management-api.html#trustedcertificatereq)
:param name: The name of this DeveloperCertificateRequestData.
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`")
self._name = name
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeveloperCertificateRequestData):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeveloperCertificateRequestData(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, description=None, name=None):
'''
DeveloperCertificateRequestData - a model defined in Swagger
'''
pass
@property
def description(self):
'''
Gets the description of this DeveloperCertificateRequestData.
Description for the developer certificate. There is a limit on the length of the description. Please see [TrustedCertificateReq](/docs/current/api-references/account-management-api.html#trustedcertificatereq)
:return: The description of this DeveloperCertificateRequestData.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeveloperCertificateRequestData.
Description for the developer certificate. There is a limit on the length of the description. Please see [TrustedCertificateReq](/docs/current/api-references/account-management-api.html#trustedcertificatereq)
:param description: The description of this DeveloperCertificateRequestData.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeveloperCertificateRequestData.
Name of the developer certificate, must be unique. There is a limit on the length of the name. Please see [TrustedCertificateReq](/docs/current/api-references/account-management-api.html#trustedcertificatereq)
:return: The name of this DeveloperCertificateRequestData.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeveloperCertificateRequestData.
Name of the developer certificate, must be unique. There is a limit on the length of the name. Please see [TrustedCertificateReq](/docs/current/api-references/account-management-api.html#trustedcertificatereq)
:param name: The name of this DeveloperCertificateRequestData.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 10 | 1 | 4 | 4 | 2 | 0.93 | 1 | 4 | 0 | 0 | 10 | 3 | 10 | 10 | 133 | 23 | 57 | 23 | 42 | 53 | 37 | 19 | 26 | 5 | 1 | 2 | 16 |
2,484 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_ca/models/credentials_response_data.py
|
mbed_cloud._backends.connector_ca.models.credentials_response_data.CredentialsResponseData
|
class CredentialsResponseData(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 = {
'certificate': 'str',
'url': 'str'
}
attribute_map = {
'certificate': 'certificate',
'url': 'url'
}
def __init__(self, certificate=None, url=None):
"""
CredentialsResponseData - a model defined in Swagger
"""
self._certificate = certificate
self._url = url
self.discriminator = None
@property
def certificate(self):
"""
Gets the certificate of this CredentialsResponseData.
PEM format X.509 server certificate that will be used to validate the server certificate that will be received during the TLS/DTLS handshake.
:return: The certificate of this CredentialsResponseData.
:rtype: str
"""
return self._certificate
@certificate.setter
def certificate(self, certificate):
"""
Sets the certificate of this CredentialsResponseData.
PEM format X.509 server certificate that will be used to validate the server certificate that will be received during the TLS/DTLS handshake.
:param certificate: The certificate of this CredentialsResponseData.
:type: str
"""
self._certificate = certificate
@property
def url(self):
"""
Gets the url of this CredentialsResponseData.
Server URI to which the client needs to connect to.
:return: The url of this CredentialsResponseData.
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""
Sets the url of this CredentialsResponseData.
Server URI to which the client needs to connect to.
:param url: The url of this CredentialsResponseData.
:type: str
"""
self._url = url
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, CredentialsResponseData):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class CredentialsResponseData(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, certificate=None, url=None):
'''
CredentialsResponseData - a model defined in Swagger
'''
pass
@property
def certificate(self):
'''
Gets the certificate of this CredentialsResponseData.
PEM format X.509 server certificate that will be used to validate the server certificate that will be received during the TLS/DTLS handshake.
:return: The certificate of this CredentialsResponseData.
:rtype: str
'''
pass
@certificate.setter
def certificate(self):
'''
Sets the certificate of this CredentialsResponseData.
PEM format X.509 server certificate that will be used to validate the server certificate that will be received during the TLS/DTLS handshake.
:param certificate: The certificate of this CredentialsResponseData.
:type: str
'''
pass
@property
def url(self):
'''
Gets the url of this CredentialsResponseData.
Server URI to which the client needs to connect to.
:return: The url of this CredentialsResponseData.
:rtype: str
'''
pass
@url.setter
def url(self):
'''
Sets the url of this CredentialsResponseData.
Server URI to which the client needs to connect to.
:param url: The url of this CredentialsResponseData.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 9 | 1 | 4 | 4 | 2 | 0.96 | 1 | 3 | 0 | 0 | 10 | 3 | 10 | 10 | 131 | 23 | 55 | 23 | 40 | 53 | 35 | 19 | 24 | 5 | 1 | 2 | 15 |
2,485 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_ca/models/all_server_credentials_response_data.py
|
mbed_cloud._backends.connector_ca.models.all_server_credentials_response_data.AllServerCredentialsResponseData
|
class AllServerCredentialsResponseData(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 = {
'bootstrap': 'CredentialsResponseData',
'lwm2m': 'CredentialsResponseData'
}
attribute_map = {
'bootstrap': 'bootstrap',
'lwm2m': 'lwm2m'
}
def __init__(self, bootstrap=None, lwm2m=None):
"""
AllServerCredentialsResponseData - a model defined in Swagger
"""
self._bootstrap = bootstrap
self._lwm2m = lwm2m
self.discriminator = None
@property
def bootstrap(self):
"""
Gets the bootstrap of this AllServerCredentialsResponseData.
:return: The bootstrap of this AllServerCredentialsResponseData.
:rtype: CredentialsResponseData
"""
return self._bootstrap
@bootstrap.setter
def bootstrap(self, bootstrap):
"""
Sets the bootstrap of this AllServerCredentialsResponseData.
:param bootstrap: The bootstrap of this AllServerCredentialsResponseData.
:type: CredentialsResponseData
"""
self._bootstrap = bootstrap
@property
def lwm2m(self):
"""
Gets the lwm2m of this AllServerCredentialsResponseData.
:return: The lwm2m of this AllServerCredentialsResponseData.
:rtype: CredentialsResponseData
"""
return self._lwm2m
@lwm2m.setter
def lwm2m(self, lwm2m):
"""
Sets the lwm2m of this AllServerCredentialsResponseData.
:param lwm2m: The lwm2m of this AllServerCredentialsResponseData.
:type: CredentialsResponseData
"""
self._lwm2m = lwm2m
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, AllServerCredentialsResponseData):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class AllServerCredentialsResponseData(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, bootstrap=None, lwm2m=None):
'''
AllServerCredentialsResponseData - a model defined in Swagger
'''
pass
@property
def bootstrap(self):
'''
Gets the bootstrap of this AllServerCredentialsResponseData.
:return: The bootstrap of this AllServerCredentialsResponseData.
:rtype: CredentialsResponseData
'''
pass
@bootstrap.setter
def bootstrap(self):
'''
Sets the bootstrap of this AllServerCredentialsResponseData.
:param bootstrap: The bootstrap of this AllServerCredentialsResponseData.
:type: CredentialsResponseData
'''
pass
@property
def lwm2m(self):
'''
Gets the lwm2m of this AllServerCredentialsResponseData.
:return: The lwm2m of this AllServerCredentialsResponseData.
:rtype: CredentialsResponseData
'''
pass
@lwm2m.setter
def lwm2m(self):
'''
Sets the lwm2m of this AllServerCredentialsResponseData.
:param lwm2m: The lwm2m of this AllServerCredentialsResponseData.
:type: CredentialsResponseData
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 9 | 1 | 4 | 4 | 2 | 0.89 | 1 | 3 | 0 | 0 | 10 | 3 | 10 | 10 | 127 | 23 | 55 | 23 | 40 | 49 | 35 | 19 | 24 | 5 | 1 | 2 | 15 |
2,486 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_ca/configuration.py
|
mbed_cloud._backends.connector_ca.configuration.Configuration
|
class Configuration(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
"""
def __init__(self):
"""Constructor"""
# Default Base url
self.host = "http://api.us-east-1.mbedcloud.com"
# Temp file folder for downloading files
self.temp_folder_path = None
# Authentication Settings
# dict to store API key(s)
self.api_key = {}
# dict to store API prefix (e.g. Bearer)
self.api_key_prefix = {}
# Username for HTTP basic authentication
self.username = ""
# Password for HTTP basic authentication
self.password = ""
# Logging Settings
self.logger = {}
self.logger["package_logger"] = logging.getLogger("connector_ca")
self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler
self.logger_stream_handler = None
# Log file handler
self.logger_file_handler = None
# Debug file location
self.logger_file = None
# Debug switch
self.debug = False
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True
# Set this to customize the certificate file to verify the peer.
self.ssl_ca_cert = None
# client certificate file
self.cert_file = None
# client key file
self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification.
self.assert_hostname = None
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
# Proxy URL
self.proxy = None
# Safe chars for path_param
self.safe_chars_for_path_param = ''
@property
def logger_file(self):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
return self.__logger_file
@logger_file.setter
def logger_file(self, value):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
self.__logger_file = value
if self.__logger_file:
# If set logging file,
# then add file handler and remove stream handler.
self.logger_file_handler = logging.FileHandler(self.__logger_file)
self.logger_file_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_file_handler)
if self.logger_stream_handler:
logger.removeHandler(self.logger_stream_handler)
else:
# If not set logging file,
# then add stream handler and remove file handler.
self.logger_stream_handler = logging.StreamHandler()
self.logger_stream_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_stream_handler)
if self.logger_file_handler:
logger.removeHandler(self.logger_file_handler)
@property
def debug(self):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
return self.__debug
@debug.setter
def debug(self, value):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
self.__debug = value
if self.__debug:
# if debug status is True, turn on debug logging
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.DEBUG)
# turn on httplib debug
httplib.HTTPConnection.debuglevel = 1
else:
# if debug status is False, turn off debug logging,
# setting log level to default `logging.WARNING`
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.WARNING)
# turn off httplib debug
httplib.HTTPConnection.debuglevel = 0
@property
def logger_format(self):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
return self.__logger_format
@logger_format.setter
def logger_format(self, value):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)
def get_api_key_with_prefix(self, identifier):
"""Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
"""
if (self.api_key.get(identifier) and
self.api_key_prefix.get(identifier)):
return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] # noqa: E501
elif self.api_key.get(identifier):
return self.api_key[identifier]
def get_basic_auth_token(self):
"""Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
"""
return urllib3.util.make_headers(
basic_auth=self.username + ':' + self.password
).get('authorization')
def auth_settings(self):
"""Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
"""
return {
'Bearer':
{
'type': 'api_key',
'in': 'header',
'key': 'Authorization',
'value': self.get_api_key_with_prefix('Authorization')
},
}
def to_debug_report(self):
"""Gets the essential information for debugging.
:return: The report for debugging.
"""
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: 3\n"\
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)
|
class Configuration(object):
'''NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
'''
def __init__(self):
'''Constructor'''
pass
@property
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@logger_file.setter
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@property
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@debug.setter
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@property
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
@logger_format.setter
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
def get_api_key_with_prefix(self, identifier):
'''Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
'''
pass
def get_basic_auth_token(self):
'''Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
'''
pass
def auth_settings(self):
'''Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
'''
pass
def to_debug_report(self):
'''Gets the essential information for debugging.
:return: The report for debugging.
'''
pass
| 18 | 12 | 17 | 2 | 8 | 7 | 2 | 0.92 | 1 | 3 | 0 | 0 | 11 | 21 | 11 | 11 | 208 | 32 | 92 | 41 | 74 | 85 | 67 | 35 | 55 | 6 | 1 | 3 | 21 |
2,487 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_ca/apis/server_credentials_api.py
|
mbed_cloud._backends.connector_ca.apis.server_credentials_api.ServerCredentialsApi
|
class ServerCredentialsApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def get_all_server_credentials(self, authorization, **kwargs): # noqa: E501
"""Fetch all (Bootstrap and LwM2M) server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch all (Bootstrap and LwM2M) server credentials that they will need to use with their clients to connect to bootstrap or LwM2M server. **Example usage:** curl -X GET \"http://api.us-east-1.mbedcloud.com/v3/server-credentials\" -H \"accept: application/json\" -H \"Authorization: Bearer THE_ACCESS_TOKEN\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_server_credentials(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: AllServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_all_server_credentials_with_http_info(authorization, **kwargs) # noqa: E501
else:
(data) = self.get_all_server_credentials_with_http_info(authorization, **kwargs) # noqa: E501
return data
def get_all_server_credentials_with_http_info(self, authorization, **kwargs): # noqa: E501
"""Fetch all (Bootstrap and LwM2M) server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch all (Bootstrap and LwM2M) server credentials that they will need to use with their clients to connect to bootstrap or LwM2M server. **Example usage:** curl -X GET \"http://api.us-east-1.mbedcloud.com/v3/server-credentials\" -H \"accept: application/json\" -H \"Authorization: Bearer THE_ACCESS_TOKEN\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_server_credentials_with_http_info(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: AllServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['authorization'] # noqa: E501
all_params.append('asynchronous')
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_all_server_credentials" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'authorization' is set
if ('authorization' not in params or
params['authorization'] is None):
raise ValueError("Missing the required parameter `authorization` when calling `get_all_server_credentials`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
if 'authorization' in params:
header_params['Authorization'] = params['authorization'] # noqa: E501
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/server-credentials', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AllServerCredentialsResponseData', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_bootstrap_server_credentials(self, authorization, **kwargs): # noqa: E501
"""Fetch bootstrap server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch bootstrap server credentials that they will need to use with their clients to connect to bootstrap server. **Example usage:** curl -X GET \"http://api.us-east-1.mbedcloud.com/v3/server-credentials/bootstrap\" -H \"accept: application/json\" -H \"Authorization: Bearer THE_ACCESS_TOKEN\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_bootstrap_server_credentials(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: ServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_bootstrap_server_credentials_with_http_info(authorization, **kwargs) # noqa: E501
else:
(data) = self.get_bootstrap_server_credentials_with_http_info(authorization, **kwargs) # noqa: E501
return data
def get_bootstrap_server_credentials_with_http_info(self, authorization, **kwargs): # noqa: E501
"""Fetch bootstrap server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch bootstrap server credentials that they will need to use with their clients to connect to bootstrap server. **Example usage:** curl -X GET \"http://api.us-east-1.mbedcloud.com/v3/server-credentials/bootstrap\" -H \"accept: application/json\" -H \"Authorization: Bearer THE_ACCESS_TOKEN\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_bootstrap_server_credentials_with_http_info(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: ServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['authorization'] # noqa: E501
all_params.append('asynchronous')
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_bootstrap_server_credentials" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'authorization' is set
if ('authorization' not in params or
params['authorization'] is None):
raise ValueError("Missing the required parameter `authorization` when calling `get_bootstrap_server_credentials`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
if 'authorization' in params:
header_params['Authorization'] = params['authorization'] # noqa: E501
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/server-credentials/bootstrap', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ServerCredentialsResponseData', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_l2_m2_m_server_credentials(self, authorization, **kwargs): # noqa: E501
"""Fetch LwM2M server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch LwM2M server credentials that they will need to use with their clients to connect to LwM2M server. **Example usage:** curl -X GET \"http://api.us-east-1.mbedcloud.com/v3/server-credentials/lwm2m\" -H \"accept: application/json\" -H \"Authorization: Bearer THE_ACCESS_TOKEN\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_l2_m2_m_server_credentials(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: ServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_l2_m2_m_server_credentials_with_http_info(authorization, **kwargs) # noqa: E501
else:
(data) = self.get_l2_m2_m_server_credentials_with_http_info(authorization, **kwargs) # noqa: E501
return data
def get_l2_m2_m_server_credentials_with_http_info(self, authorization, **kwargs): # noqa: E501
"""Fetch LwM2M server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch LwM2M server credentials that they will need to use with their clients to connect to LwM2M server. **Example usage:** curl -X GET \"http://api.us-east-1.mbedcloud.com/v3/server-credentials/lwm2m\" -H \"accept: application/json\" -H \"Authorization: Bearer THE_ACCESS_TOKEN\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_l2_m2_m_server_credentials_with_http_info(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: ServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['authorization'] # noqa: E501
all_params.append('asynchronous')
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_l2_m2_m_server_credentials" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'authorization' is set
if ('authorization' not in params or
params['authorization'] is None):
raise ValueError("Missing the required parameter `authorization` when calling `get_l2_m2_m_server_credentials`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
if 'authorization' in params:
header_params['Authorization'] = params['authorization'] # noqa: E501
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/server-credentials/lwm2m', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ServerCredentialsResponseData', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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)
|
class ServerCredentialsApi(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):
pass
def get_all_server_credentials(self, authorization, **kwargs):
'''Fetch all (Bootstrap and LwM2M) server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch all (Bootstrap and LwM2M) server credentials that they will need to use with their clients to connect to bootstrap or LwM2M server. **Example usage:** curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_server_credentials(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: AllServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_all_server_credentials_with_http_info(self, authorization, **kwargs):
'''Fetch all (Bootstrap and LwM2M) server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch all (Bootstrap and LwM2M) server credentials that they will need to use with their clients to connect to bootstrap or LwM2M server. **Example usage:** curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_all_server_credentials_with_http_info(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: AllServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_bootstrap_server_credentials(self, authorization, **kwargs):
'''Fetch bootstrap server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch bootstrap server credentials that they will need to use with their clients to connect to bootstrap server. **Example usage:** curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials/bootstrap" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_bootstrap_server_credentials(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: ServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_bootstrap_server_credentials_with_http_info(self, authorization, **kwargs):
'''Fetch bootstrap server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch bootstrap server credentials that they will need to use with their clients to connect to bootstrap server. **Example usage:** curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials/bootstrap" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_bootstrap_server_credentials_with_http_info(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: ServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_l2_m2_m_server_credentials(self, authorization, **kwargs):
'''Fetch LwM2M server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch LwM2M server credentials that they will need to use with their clients to connect to LwM2M server. **Example usage:** curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials/lwm2m" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_l2_m2_m_server_credentials(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: ServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_l2_m2_m_server_credentials_with_http_info(self, authorization, **kwargs):
'''Fetch LwM2M server credentials. # noqa: E501
This REST API is intended to be used by customers to fetch LwM2M server credentials that they will need to use with their clients to connect to LwM2M server. **Example usage:** curl -X GET "http://api.us-east-1.mbedcloud.com/v3/server-credentials/lwm2m" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_l2_m2_m_server_credentials_with_http_info(authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:return: ServerCredentialsResponseData
If the method is called asynchronously,
returns the request thread.
'''
pass
| 8 | 7 | 40 | 6 | 23 | 16 | 3 | 0.71 | 1 | 3 | 1 | 0 | 7 | 1 | 7 | 7 | 296 | 50 | 161 | 45 | 153 | 115 | 101 | 45 | 93 | 5 | 1 | 2 | 23 |
2,488 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_ca/apis/developer_certificate_api.py
|
mbed_cloud._backends.connector_ca.apis.developer_certificate_api.DeveloperCertificateApi
|
class DeveloperCertificateApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def create_developer_certificate(self, authorization, body, **kwargs): # noqa: E501
"""Create a new developer certificate to connect to the bootstrap server. # noqa: E501
This REST API is intended to be used by customers to get a developer certificate (a certificate that can be flashed into multiple devices to connect to bootstrap server). **Note:** The number of developer certificates allowed per account is limited. Please see [Using your own certificate authority](/docs/current/mbed-cloud-deploy/instructions-for-factory-setup-and-device-provision.html#using-your-own-certificate-authority-with-mbed-cloud). **Example usage:** curl -X POST \"http://api.us-east-1.mbedcloud.com/v3/developer-certificates\" -H \"accept: application/json\" -H \"Authorization: Bearer THE_ACCESS_TOKEN\" -H \"content-type: application/json\" -d \"{ \\\"name\\\": \\\"THE_CERTIFICATE_NAME\\\", \\\"description\\\": \\\"THE_CERTIFICATE_DESCRIPTION\\\"}\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_developer_certificate(authorization, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:param DeveloperCertificateRequestData body: (required)
:return: DeveloperCertificateResponseData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.create_developer_certificate_with_http_info(authorization, body, **kwargs) # noqa: E501
else:
(data) = self.create_developer_certificate_with_http_info(authorization, body, **kwargs) # noqa: E501
return data
def create_developer_certificate_with_http_info(self, authorization, body, **kwargs): # noqa: E501
"""Create a new developer certificate to connect to the bootstrap server. # noqa: E501
This REST API is intended to be used by customers to get a developer certificate (a certificate that can be flashed into multiple devices to connect to bootstrap server). **Note:** The number of developer certificates allowed per account is limited. Please see [Using your own certificate authority](/docs/current/mbed-cloud-deploy/instructions-for-factory-setup-and-device-provision.html#using-your-own-certificate-authority-with-mbed-cloud). **Example usage:** curl -X POST \"http://api.us-east-1.mbedcloud.com/v3/developer-certificates\" -H \"accept: application/json\" -H \"Authorization: Bearer THE_ACCESS_TOKEN\" -H \"content-type: application/json\" -d \"{ \\\"name\\\": \\\"THE_CERTIFICATE_NAME\\\", \\\"description\\\": \\\"THE_CERTIFICATE_DESCRIPTION\\\"}\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_developer_certificate_with_http_info(authorization, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:param DeveloperCertificateRequestData body: (required)
:return: DeveloperCertificateResponseData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['authorization', 'body'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_developer_certificate" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'authorization' is set
if ('authorization' not in params or
params['authorization'] is None):
raise ValueError("Missing the required parameter `authorization` when calling `create_developer_certificate`") # 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 `create_developer_certificate`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
if 'authorization' in params:
header_params['Authorization'] = params['authorization'] # noqa: E501
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
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/developer-certificates', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeveloperCertificateResponseData', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_developer_certificate(self, developer_certificate_id, authorization, **kwargs): # noqa: E501
"""Fetch an existing developer certificate to connect to the bootstrap server. # noqa: E501
This REST API is intended to be used by customers to fetch an existing developer certificate (a certificate that can be flashed into multiple devices to connect to bootstrap server). **Example usage:** curl -X GET \"http://api.us-east-1.mbedcloud.com/v3/developer-certificates/THE_CERTIFICATE_ID\" -H \"accept: application/json\" -H \"Authorization: Bearer THE_ACCESS_TOKEN\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_developer_certificate(developer_certificate_id, authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str developer_certificate_id: A unique identifier for the developer certificate. (required)
:param str authorization: Bearer {Access Token}. (required)
:return: DeveloperCertificateResponseData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_developer_certificate_with_http_info(developer_certificate_id, authorization, **kwargs) # noqa: E501
else:
(data) = self.get_developer_certificate_with_http_info(developer_certificate_id, authorization, **kwargs) # noqa: E501
return data
def get_developer_certificate_with_http_info(self, developer_certificate_id, authorization, **kwargs): # noqa: E501
"""Fetch an existing developer certificate to connect to the bootstrap server. # noqa: E501
This REST API is intended to be used by customers to fetch an existing developer certificate (a certificate that can be flashed into multiple devices to connect to bootstrap server). **Example usage:** curl -X GET \"http://api.us-east-1.mbedcloud.com/v3/developer-certificates/THE_CERTIFICATE_ID\" -H \"accept: application/json\" -H \"Authorization: Bearer THE_ACCESS_TOKEN\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_developer_certificate_with_http_info(developer_certificate_id, authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str developer_certificate_id: A unique identifier for the developer certificate. (required)
:param str authorization: Bearer {Access Token}. (required)
:return: DeveloperCertificateResponseData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['developer_certificate_id', 'authorization'] # noqa: E501
all_params.append('asynchronous')
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_developer_certificate" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'developer_certificate_id' is set
if ('developer_certificate_id' not in params or
params['developer_certificate_id'] is None):
raise ValueError("Missing the required parameter `developer_certificate_id` when calling `get_developer_certificate`") # noqa: E501
# verify the required parameter 'authorization' is set
if ('authorization' not in params or
params['authorization'] is None):
raise ValueError("Missing the required parameter `authorization` when calling `get_developer_certificate`") # noqa: E501
collection_formats = {}
path_params = {}
if 'developer_certificate_id' in params:
path_params['developerCertificateId'] = params['developer_certificate_id'] # noqa: E501
query_params = []
header_params = {}
if 'authorization' in params:
header_params['Authorization'] = params['authorization'] # noqa: E501
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v3/developer-certificates/{developerCertificateId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeveloperCertificateResponseData', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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)
|
class DeveloperCertificateApi(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):
pass
def create_developer_certificate(self, authorization, body, **kwargs):
'''Create a new developer certificate to connect to the bootstrap server. # noqa: E501
This REST API is intended to be used by customers to get a developer certificate (a certificate that can be flashed into multiple devices to connect to bootstrap server). **Note:** The number of developer certificates allowed per account is limited. Please see [Using your own certificate authority](/docs/current/mbed-cloud-deploy/instructions-for-factory-setup-and-device-provision.html#using-your-own-certificate-authority-with-mbed-cloud). **Example usage:** curl -X POST "http://api.us-east-1.mbedcloud.com/v3/developer-certificates" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" -H "content-type: application/json" -d "{ \"name\": \"THE_CERTIFICATE_NAME\", \"description\": \"THE_CERTIFICATE_DESCRIPTION\"}" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_developer_certificate(authorization, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:param DeveloperCertificateRequestData body: (required)
:return: DeveloperCertificateResponseData
If the method is called asynchronously,
returns the request thread.
'''
pass
def create_developer_certificate_with_http_info(self, authorization, body, **kwargs):
'''Create a new developer certificate to connect to the bootstrap server. # noqa: E501
This REST API is intended to be used by customers to get a developer certificate (a certificate that can be flashed into multiple devices to connect to bootstrap server). **Note:** The number of developer certificates allowed per account is limited. Please see [Using your own certificate authority](/docs/current/mbed-cloud-deploy/instructions-for-factory-setup-and-device-provision.html#using-your-own-certificate-authority-with-mbed-cloud). **Example usage:** curl -X POST "http://api.us-east-1.mbedcloud.com/v3/developer-certificates" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" -H "content-type: application/json" -d "{ \"name\": \"THE_CERTIFICATE_NAME\", \"description\": \"THE_CERTIFICATE_DESCRIPTION\"}" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.create_developer_certificate_with_http_info(authorization, body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str authorization: Bearer {Access Token}. (required)
:param DeveloperCertificateRequestData body: (required)
:return: DeveloperCertificateResponseData
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_developer_certificate(self, developer_certificate_id, authorization, **kwargs):
'''Fetch an existing developer certificate to connect to the bootstrap server. # noqa: E501
This REST API is intended to be used by customers to fetch an existing developer certificate (a certificate that can be flashed into multiple devices to connect to bootstrap server). **Example usage:** curl -X GET "http://api.us-east-1.mbedcloud.com/v3/developer-certificates/THE_CERTIFICATE_ID" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_developer_certificate(developer_certificate_id, authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str developer_certificate_id: A unique identifier for the developer certificate. (required)
:param str authorization: Bearer {Access Token}. (required)
:return: DeveloperCertificateResponseData
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_developer_certificate_with_http_info(self, developer_certificate_id, authorization, **kwargs):
'''Fetch an existing developer certificate to connect to the bootstrap server. # noqa: E501
This REST API is intended to be used by customers to fetch an existing developer certificate (a certificate that can be flashed into multiple devices to connect to bootstrap server). **Example usage:** curl -X GET "http://api.us-east-1.mbedcloud.com/v3/developer-certificates/THE_CERTIFICATE_ID" -H "accept: application/json" -H "Authorization: Bearer THE_ACCESS_TOKEN" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_developer_certificate_with_http_info(developer_certificate_id, authorization, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str developer_certificate_id: A unique identifier for the developer certificate. (required)
:param str authorization: Bearer {Access Token}. (required)
:return: DeveloperCertificateResponseData
If the method is called asynchronously,
returns the request thread.
'''
pass
| 6 | 5 | 41 | 6 | 24 | 17 | 4 | 0.73 | 1 | 3 | 1 | 0 | 5 | 1 | 5 | 5 | 217 | 34 | 119 | 31 | 113 | 87 | 77 | 31 | 71 | 7 | 1 | 2 | 20 |
2,489 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_bootstrap/models/pre_shared_key_without_secret.py
|
mbed_cloud._backends.connector_bootstrap.models.pre_shared_key_without_secret.PreSharedKeyWithoutSecret
|
class PreSharedKeyWithoutSecret(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 = {
'created_at': 'datetime',
'endpoint_name': 'str'
}
attribute_map = {
'created_at': 'created_at',
'endpoint_name': 'endpoint_name'
}
def __init__(self, created_at=None, endpoint_name=None):
"""
PreSharedKeyWithoutSecret - a model defined in Swagger
"""
self._created_at = created_at
self._endpoint_name = endpoint_name
self.discriminator = None
@property
def created_at(self):
"""
Gets the created_at of this PreSharedKeyWithoutSecret.
The date-time (RFC3339) when this pre-shared key was uploaded to Pelion device management.
:return: The created_at of this PreSharedKeyWithoutSecret.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this PreSharedKeyWithoutSecret.
The date-time (RFC3339) when this pre-shared key was uploaded to Pelion device management.
:param created_at: The created_at of this PreSharedKeyWithoutSecret.
:type: datetime
"""
self._created_at = created_at
@property
def endpoint_name(self):
"""
Gets the endpoint_name of this PreSharedKeyWithoutSecret.
The unique endpoint identifier that this pre-shared key applies to. 16-64 [printable](https://en.wikipedia.org/wiki/ASCII#Printable_characters) (non-control) ASCII characters.
:return: The endpoint_name of this PreSharedKeyWithoutSecret.
:rtype: str
"""
return self._endpoint_name
@endpoint_name.setter
def endpoint_name(self, endpoint_name):
"""
Sets the endpoint_name of this PreSharedKeyWithoutSecret.
The unique endpoint identifier that this pre-shared key applies to. 16-64 [printable](https://en.wikipedia.org/wiki/ASCII#Printable_characters) (non-control) ASCII characters.
:param endpoint_name: The endpoint_name of this PreSharedKeyWithoutSecret.
:type: str
"""
if endpoint_name is None:
raise ValueError("Invalid value for `endpoint_name`, must not be `None`")
if endpoint_name is not None and not re.search('^[ -~]{16,64}$', endpoint_name):
raise ValueError("Invalid value for `endpoint_name`, must be a follow pattern or equal to `/^[ -~]{16,64}$/`")
self._endpoint_name = endpoint_name
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, PreSharedKeyWithoutSecret):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class PreSharedKeyWithoutSecret(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created_at=None, endpoint_name=None):
'''
PreSharedKeyWithoutSecret - a model defined in Swagger
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this PreSharedKeyWithoutSecret.
The date-time (RFC3339) when this pre-shared key was uploaded to Pelion device management.
:return: The created_at of this PreSharedKeyWithoutSecret.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this PreSharedKeyWithoutSecret.
The date-time (RFC3339) when this pre-shared key was uploaded to Pelion device management.
:param created_at: The created_at of this PreSharedKeyWithoutSecret.
:type: datetime
'''
pass
@property
def endpoint_name(self):
'''
Gets the endpoint_name of this PreSharedKeyWithoutSecret.
The unique endpoint identifier that this pre-shared key applies to. 16-64 [printable](https://en.wikipedia.org/wiki/ASCII#Printable_characters) (non-control) ASCII characters.
:return: The endpoint_name of this PreSharedKeyWithoutSecret.
:rtype: str
'''
pass
@endpoint_name.setter
def endpoint_name(self):
'''
Sets the endpoint_name of this PreSharedKeyWithoutSecret.
The unique endpoint identifier that this pre-shared key applies to. 16-64 [printable](https://en.wikipedia.org/wiki/ASCII#Printable_characters) (non-control) ASCII characters.
:param endpoint_name: The endpoint_name of this PreSharedKeyWithoutSecret.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 10 | 1 | 5 | 4 | 2 | 0.9 | 1 | 4 | 0 | 0 | 10 | 3 | 10 | 10 | 135 | 23 | 59 | 23 | 44 | 53 | 39 | 19 | 28 | 5 | 1 | 2 | 17 |
2,490 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_bootstrap/models/pre_shared_key.py
|
mbed_cloud._backends.connector_bootstrap.models.pre_shared_key.PreSharedKey
|
class PreSharedKey(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 = {
'endpoint_name': 'str',
'secret_hex': 'str'
}
attribute_map = {
'endpoint_name': 'endpoint_name',
'secret_hex': 'secret_hex'
}
def __init__(self, endpoint_name=None, secret_hex=None):
"""
PreSharedKey - a model defined in Swagger
"""
self._endpoint_name = endpoint_name
self._secret_hex = secret_hex
self.discriminator = None
@property
def endpoint_name(self):
"""
Gets the endpoint_name of this PreSharedKey.
The unique endpoint identifier that this pre-shared key applies to. 16-64 [printable](https://en.wikipedia.org/wiki/ASCII#Printable_characters) (non-control) ASCII characters.
:return: The endpoint_name of this PreSharedKey.
:rtype: str
"""
return self._endpoint_name
@endpoint_name.setter
def endpoint_name(self, endpoint_name):
"""
Sets the endpoint_name of this PreSharedKey.
The unique endpoint identifier that this pre-shared key applies to. 16-64 [printable](https://en.wikipedia.org/wiki/ASCII#Printable_characters) (non-control) ASCII characters.
:param endpoint_name: The endpoint_name of this PreSharedKey.
:type: str
"""
if endpoint_name is None:
raise ValueError("Invalid value for `endpoint_name`, must not be `None`")
if endpoint_name is not None and not re.search('^[ -~]{16,64}$', endpoint_name):
raise ValueError("Invalid value for `endpoint_name`, must be a follow pattern or equal to `/^[ -~]{16,64}$/`")
self._endpoint_name = endpoint_name
@property
def secret_hex(self):
"""
Gets the secret_hex of this PreSharedKey.
The secret of the pre-shared key in hexadecimal. It is not case sensitive; 4a is same as 4A, and it is allowed with or without 0x in the beginning. The minimum length of the secret is 128 bits and maximum 256 bits.
:return: The secret_hex of this PreSharedKey.
:rtype: str
"""
return self._secret_hex
@secret_hex.setter
def secret_hex(self, secret_hex):
"""
Sets the secret_hex of this PreSharedKey.
The secret of the pre-shared key in hexadecimal. It is not case sensitive; 4a is same as 4A, and it is allowed with or without 0x in the beginning. The minimum length of the secret is 128 bits and maximum 256 bits.
:param secret_hex: The secret_hex of this PreSharedKey.
:type: str
"""
if secret_hex is None:
raise ValueError("Invalid value for `secret_hex`, must not be `None`")
if secret_hex is not None and not re.search('^(0[xX])?[0-9a-fA-F]{32,64}$', secret_hex):
raise ValueError("Invalid value for `secret_hex`, must be a follow pattern or equal to `/^(0[xX])?[0-9a-fA-F]{32,64}$/`")
self._secret_hex = secret_hex
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, PreSharedKey):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class PreSharedKey(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, endpoint_name=None, secret_hex=None):
'''
PreSharedKey - a model defined in Swagger
'''
pass
@property
def endpoint_name(self):
'''
Gets the endpoint_name of this PreSharedKey.
The unique endpoint identifier that this pre-shared key applies to. 16-64 [printable](https://en.wikipedia.org/wiki/ASCII#Printable_characters) (non-control) ASCII characters.
:return: The endpoint_name of this PreSharedKey.
:rtype: str
'''
pass
@endpoint_name.setter
def endpoint_name(self):
'''
Sets the endpoint_name of this PreSharedKey.
The unique endpoint identifier that this pre-shared key applies to. 16-64 [printable](https://en.wikipedia.org/wiki/ASCII#Printable_characters) (non-control) ASCII characters.
:param endpoint_name: The endpoint_name of this PreSharedKey.
:type: str
'''
pass
@property
def secret_hex(self):
'''
Gets the secret_hex of this PreSharedKey.
The secret of the pre-shared key in hexadecimal. It is not case sensitive; 4a is same as 4A, and it is allowed with or without 0x in the beginning. The minimum length of the secret is 128 bits and maximum 256 bits.
:return: The secret_hex of this PreSharedKey.
:rtype: str
'''
pass
@secret_hex.setter
def secret_hex(self):
'''
Sets the secret_hex of this PreSharedKey.
The secret of the pre-shared key in hexadecimal. It is not case sensitive; 4a is same as 4A, and it is allowed with or without 0x in the beginning. The minimum length of the secret is 128 bits and maximum 256 bits.
:param secret_hex: The secret_hex of this PreSharedKey.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 10 | 1 | 5 | 4 | 2 | 0.84 | 1 | 4 | 0 | 0 | 10 | 3 | 10 | 10 | 139 | 23 | 63 | 23 | 48 | 53 | 43 | 19 | 32 | 5 | 1 | 2 | 19 |
2,491 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_bootstrap/models/list_of_pre_shared_keys_without_secret.py
|
mbed_cloud._backends.connector_bootstrap.models.list_of_pre_shared_keys_without_secret.ListOfPreSharedKeysWithoutSecret
|
class ListOfPreSharedKeysWithoutSecret(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 = {
'after': 'str',
'continuation_marker': 'str',
'data': 'list[PreSharedKeyWithoutSecret]',
'has_more': 'bool',
'limit': 'int',
'object': 'str',
'order': 'str'
}
attribute_map = {
'after': 'after',
'continuation_marker': 'continuation_marker',
'data': 'data',
'has_more': 'has_more',
'limit': 'limit',
'object': 'object',
'order': 'order'
}
def __init__(self, after=None, continuation_marker=None, data=None, has_more=None, limit=None, object=None, order=None):
"""
ListOfPreSharedKeysWithoutSecret - a model defined in Swagger
"""
self._after = after
self._continuation_marker = continuation_marker
self._data = data
self._has_more = has_more
self._limit = limit
self._object = object
self._order = order
self.discriminator = None
@property
def after(self):
"""
Gets the after of this ListOfPreSharedKeysWithoutSecret.
An offset token for current page.
:return: The after of this ListOfPreSharedKeysWithoutSecret.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this ListOfPreSharedKeysWithoutSecret.
An offset token for current page.
:param after: The after of this ListOfPreSharedKeysWithoutSecret.
:type: str
"""
self._after = after
@property
def continuation_marker(self):
"""
Gets the continuation_marker of this ListOfPreSharedKeysWithoutSecret.
An offset token for fetching the next page. Note that exactly the same limit needs to be used on the request for fetching the subsequent pages.
:return: The continuation_marker of this ListOfPreSharedKeysWithoutSecret.
:rtype: str
"""
return self._continuation_marker
@continuation_marker.setter
def continuation_marker(self, continuation_marker):
"""
Sets the continuation_marker of this ListOfPreSharedKeysWithoutSecret.
An offset token for fetching the next page. Note that exactly the same limit needs to be used on the request for fetching the subsequent pages.
:param continuation_marker: The continuation_marker of this ListOfPreSharedKeysWithoutSecret.
:type: str
"""
self._continuation_marker = continuation_marker
@property
def data(self):
"""
Gets the data of this ListOfPreSharedKeysWithoutSecret.
Array of the pre-shared key entries. The array is empty if there are no pre-shared keys.
:return: The data of this ListOfPreSharedKeysWithoutSecret.
:rtype: list[PreSharedKeyWithoutSecret]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this ListOfPreSharedKeysWithoutSecret.
Array of the pre-shared key entries. The array is empty if there are no pre-shared keys.
:param data: The data of this ListOfPreSharedKeysWithoutSecret.
:type: list[PreSharedKeyWithoutSecret]
"""
if data is None:
raise ValueError("Invalid value for `data`, must not be `None`")
self._data = data
@property
def has_more(self):
"""
Gets the has_more of this ListOfPreSharedKeysWithoutSecret.
Are there more results available.
:return: The has_more of this ListOfPreSharedKeysWithoutSecret.
:rtype: bool
"""
return self._has_more
@has_more.setter
def has_more(self, has_more):
"""
Sets the has_more of this ListOfPreSharedKeysWithoutSecret.
Are there more results available.
:param has_more: The has_more of this ListOfPreSharedKeysWithoutSecret.
:type: bool
"""
if has_more is None:
raise ValueError("Invalid value for `has_more`, must not be `None`")
self._has_more = has_more
@property
def limit(self):
"""
Gets the limit of this ListOfPreSharedKeysWithoutSecret.
The value of limit query parameter from the request, or default if not specified.
:return: The limit of this ListOfPreSharedKeysWithoutSecret.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this ListOfPreSharedKeysWithoutSecret.
The value of limit query parameter from the request, or default if not specified.
:param limit: The limit of this ListOfPreSharedKeysWithoutSecret.
:type: int
"""
if limit is None:
raise ValueError("Invalid value for `limit`, must not be `None`")
self._limit = limit
@property
def object(self):
"""
Gets the object of this ListOfPreSharedKeysWithoutSecret.
The type of this API object is a \"list\".
:return: The object of this ListOfPreSharedKeysWithoutSecret.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ListOfPreSharedKeysWithoutSecret.
The type of this API object is a \"list\".
:param object: The object of this ListOfPreSharedKeysWithoutSecret.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
self._object = object
@property
def order(self):
"""
Gets the order of this ListOfPreSharedKeysWithoutSecret.
The creation time based order of the entries.
:return: The order of this ListOfPreSharedKeysWithoutSecret.
:rtype: str
"""
return self._order
@order.setter
def order(self, order):
"""
Sets the order of this ListOfPreSharedKeysWithoutSecret.
The creation time based order of the entries.
:param order: The order of this ListOfPreSharedKeysWithoutSecret.
:type: str
"""
if order is None:
raise ValueError("Invalid value for `order`, must not be `None`")
self._order = order
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ListOfPreSharedKeysWithoutSecret):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ListOfPreSharedKeysWithoutSecret(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, continuation_marker=None, data=None, has_more=None, limit=None, object=None, order=None):
'''
ListOfPreSharedKeysWithoutSecret - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this ListOfPreSharedKeysWithoutSecret.
An offset token for current page.
:return: The after of this ListOfPreSharedKeysWithoutSecret.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this ListOfPreSharedKeysWithoutSecret.
An offset token for current page.
:param after: The after of this ListOfPreSharedKeysWithoutSecret.
:type: str
'''
pass
@property
def continuation_marker(self):
'''
Gets the continuation_marker of this ListOfPreSharedKeysWithoutSecret.
An offset token for fetching the next page. Note that exactly the same limit needs to be used on the request for fetching the subsequent pages.
:return: The continuation_marker of this ListOfPreSharedKeysWithoutSecret.
:rtype: str
'''
pass
@continuation_marker.setter
def continuation_marker(self):
'''
Sets the continuation_marker of this ListOfPreSharedKeysWithoutSecret.
An offset token for fetching the next page. Note that exactly the same limit needs to be used on the request for fetching the subsequent pages.
:param continuation_marker: The continuation_marker of this ListOfPreSharedKeysWithoutSecret.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this ListOfPreSharedKeysWithoutSecret.
Array of the pre-shared key entries. The array is empty if there are no pre-shared keys.
:return: The data of this ListOfPreSharedKeysWithoutSecret.
:rtype: list[PreSharedKeyWithoutSecret]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this ListOfPreSharedKeysWithoutSecret.
Array of the pre-shared key entries. The array is empty if there are no pre-shared keys.
:param data: The data of this ListOfPreSharedKeysWithoutSecret.
:type: list[PreSharedKeyWithoutSecret]
'''
pass
@property
def has_more(self):
'''
Gets the has_more of this ListOfPreSharedKeysWithoutSecret.
Are there more results available.
:return: The has_more of this ListOfPreSharedKeysWithoutSecret.
:rtype: bool
'''
pass
@has_more.setter
def has_more(self):
'''
Sets the has_more of this ListOfPreSharedKeysWithoutSecret.
Are there more results available.
:param has_more: The has_more of this ListOfPreSharedKeysWithoutSecret.
:type: bool
'''
pass
@property
def limit(self):
'''
Gets the limit of this ListOfPreSharedKeysWithoutSecret.
The value of limit query parameter from the request, or default if not specified.
:return: The limit of this ListOfPreSharedKeysWithoutSecret.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this ListOfPreSharedKeysWithoutSecret.
The value of limit query parameter from the request, or default if not specified.
:param limit: The limit of this ListOfPreSharedKeysWithoutSecret.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this ListOfPreSharedKeysWithoutSecret.
The type of this API object is a "list".
:return: The object of this ListOfPreSharedKeysWithoutSecret.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ListOfPreSharedKeysWithoutSecret.
The type of this API object is a "list".
:param object: The object of this ListOfPreSharedKeysWithoutSecret.
:type: str
'''
pass
@property
def order(self):
'''
Gets the order of this ListOfPreSharedKeysWithoutSecret.
The creation time based order of the entries.
:return: The order of this ListOfPreSharedKeysWithoutSecret.
:rtype: str
'''
pass
@order.setter
def order(self):
'''
Sets the order of this ListOfPreSharedKeysWithoutSecret.
The creation time based order of the entries.
:param order: The order of this ListOfPreSharedKeysWithoutSecret.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 35 | 21 | 10 | 1 | 4 | 5 | 2 | 1.03 | 1 | 4 | 0 | 0 | 20 | 8 | 20 | 20 | 271 | 48 | 110 | 48 | 75 | 113 | 70 | 34 | 49 | 5 | 1 | 2 | 30 |
2,492 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_bootstrap/configuration.py
|
mbed_cloud._backends.connector_bootstrap.configuration.Configuration
|
class Configuration(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
"""
def __init__(self):
"""Constructor"""
# Default Base url
self.host = "https://api.us-east-1.mbedcloud.com"
# Temp file folder for downloading files
self.temp_folder_path = None
# Authentication Settings
# dict to store API key(s)
self.api_key = {}
# dict to store API prefix (e.g. Bearer)
self.api_key_prefix = {}
# Username for HTTP basic authentication
self.username = ""
# Password for HTTP basic authentication
self.password = ""
# Logging Settings
self.logger = {}
self.logger["package_logger"] = logging.getLogger("connector_bootstrap")
self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler
self.logger_stream_handler = None
# Log file handler
self.logger_file_handler = None
# Debug file location
self.logger_file = None
# Debug switch
self.debug = False
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True
# Set this to customize the certificate file to verify the peer.
self.ssl_ca_cert = None
# client certificate file
self.cert_file = None
# client key file
self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification.
self.assert_hostname = None
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
# Proxy URL
self.proxy = None
# Safe chars for path_param
self.safe_chars_for_path_param = ''
@property
def logger_file(self):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
return self.__logger_file
@logger_file.setter
def logger_file(self, value):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
"""
self.__logger_file = value
if self.__logger_file:
# If set logging file,
# then add file handler and remove stream handler.
self.logger_file_handler = logging.FileHandler(self.__logger_file)
self.logger_file_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_file_handler)
if self.logger_stream_handler:
logger.removeHandler(self.logger_stream_handler)
else:
# If not set logging file,
# then add stream handler and remove file handler.
self.logger_stream_handler = logging.StreamHandler()
self.logger_stream_handler.setFormatter(self.logger_formatter)
for _, logger in six.iteritems(self.logger):
logger.addHandler(self.logger_stream_handler)
if self.logger_file_handler:
logger.removeHandler(self.logger_file_handler)
@property
def debug(self):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
return self.__debug
@debug.setter
def debug(self, value):
"""Debug status
:param value: The debug status, True or False.
:type: bool
"""
self.__debug = value
if self.__debug:
# if debug status is True, turn on debug logging
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.DEBUG)
# turn on httplib debug
httplib.HTTPConnection.debuglevel = 1
else:
# if debug status is False, turn off debug logging,
# setting log level to default `logging.WARNING`
for _, logger in six.iteritems(self.logger):
logger.setLevel(logging.WARNING)
# turn off httplib debug
httplib.HTTPConnection.debuglevel = 0
@property
def logger_format(self):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
return self.__logger_format
@logger_format.setter
def logger_format(self, value):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
"""
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)
def get_api_key_with_prefix(self, identifier):
"""Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
"""
if (self.api_key.get(identifier) and
self.api_key_prefix.get(identifier)):
return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] # noqa: E501
elif self.api_key.get(identifier):
return self.api_key[identifier]
def get_basic_auth_token(self):
"""Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
"""
return urllib3.util.make_headers(
basic_auth=self.username + ':' + self.password
).get('authorization')
def auth_settings(self):
"""Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
"""
return {
'Bearer':
{
'type': 'api_key',
'in': 'header',
'key': 'Authorization',
'value': self.get_api_key_with_prefix('Authorization')
},
}
def to_debug_report(self):
"""Gets the essential information for debugging.
:return: The report for debugging.
"""
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: 2\n"\
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)
|
class Configuration(object):
'''NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.
'''
def __init__(self):
'''Constructor'''
pass
@property
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@logger_file.setter
def logger_file(self):
'''The logger file.
If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
'''
pass
@property
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@debug.setter
def debug(self):
'''Debug status
:param value: The debug status, True or False.
:type: bool
'''
pass
@property
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
@logger_format.setter
def logger_format(self):
'''The logger format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
'''
pass
def get_api_key_with_prefix(self, identifier):
'''Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
'''
pass
def get_basic_auth_token(self):
'''Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
'''
pass
def auth_settings(self):
'''Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
'''
pass
def to_debug_report(self):
'''Gets the essential information for debugging.
:return: The report for debugging.
'''
pass
| 18 | 12 | 17 | 2 | 8 | 7 | 2 | 0.92 | 1 | 3 | 0 | 0 | 11 | 21 | 11 | 11 | 208 | 32 | 92 | 41 | 74 | 85 | 67 | 35 | 55 | 6 | 1 | 3 | 21 |
2,493 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_bootstrap/apis/pre_shared_keys_api.py
|
mbed_cloud._backends.connector_bootstrap.apis.pre_shared_keys_api.PreSharedKeysApi
|
class PreSharedKeysApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def delete_pre_shared_key(self, endpoint_name, **kwargs): # noqa: E501
"""Remove a pre-shared key. # noqa: E501
Remove a pre-shared key. **Example usage:** ``` curl -H \"authorization: Bearer ${API_TOKEN}\" -X DELETE https://api.us-east-1.mbedcloud.com/v2/device-shared-keys/my-endpoint-0001 ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_pre_shared_key(endpoint_name, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str endpoint_name: The unique endpoint identifier that this pre-shared key applies to. [Reserved characters](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters) must be percent-encoded. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.delete_pre_shared_key_with_http_info(endpoint_name, **kwargs) # noqa: E501
else:
(data) = self.delete_pre_shared_key_with_http_info(endpoint_name, **kwargs) # noqa: E501
return data
def delete_pre_shared_key_with_http_info(self, endpoint_name, **kwargs): # noqa: E501
"""Remove a pre-shared key. # noqa: E501
Remove a pre-shared key. **Example usage:** ``` curl -H \"authorization: Bearer ${API_TOKEN}\" -X DELETE https://api.us-east-1.mbedcloud.com/v2/device-shared-keys/my-endpoint-0001 ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_pre_shared_key_with_http_info(endpoint_name, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str endpoint_name: The unique endpoint identifier that this pre-shared key applies to. [Reserved characters](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters) must be percent-encoded. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['endpoint_name'] # noqa: E501
all_params.append('asynchronous')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_pre_shared_key" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'endpoint_name' is set
if ('endpoint_name' not in params or
params['endpoint_name'] is None):
raise ValueError("Missing the required parameter `endpoint_name` when calling `delete_pre_shared_key`") # noqa: E501
collection_formats = {}
path_params = {}
if 'endpoint_name' in params:
path_params['endpoint_name'] = params['endpoint_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v2/device-shared-keys/{endpoint_name}', '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,
asynchronous=params.get('asynchronous'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_pre_shared_key(self, endpoint_name, **kwargs): # noqa: E501
"""Get a pre-shared key. # noqa: E501
Check if a pre-shared key for an endpoint exists or not. The response does not contain the secret itself. **Example usage:** ``` curl -H \"authorization: Bearer ${API_TOKEN}\" https://api.us-east-1.mbedcloud.com/v2/device-shared-keys/my-endpoint-0001 ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_pre_shared_key(endpoint_name, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str endpoint_name: The unique endpoint identifier that this pre-shared key applies to. [Reserved characters](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters) must be percent-encoded. (required)
:return: PreSharedKeyWithoutSecret
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.get_pre_shared_key_with_http_info(endpoint_name, **kwargs) # noqa: E501
else:
(data) = self.get_pre_shared_key_with_http_info(endpoint_name, **kwargs) # noqa: E501
return data
def get_pre_shared_key_with_http_info(self, endpoint_name, **kwargs): # noqa: E501
"""Get a pre-shared key. # noqa: E501
Check if a pre-shared key for an endpoint exists or not. The response does not contain the secret itself. **Example usage:** ``` curl -H \"authorization: Bearer ${API_TOKEN}\" https://api.us-east-1.mbedcloud.com/v2/device-shared-keys/my-endpoint-0001 ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_pre_shared_key_with_http_info(endpoint_name, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str endpoint_name: The unique endpoint identifier that this pre-shared key applies to. [Reserved characters](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters) must be percent-encoded. (required)
:return: PreSharedKeyWithoutSecret
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['endpoint_name'] # noqa: E501
all_params.append('asynchronous')
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_pre_shared_key" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'endpoint_name' is set
if ('endpoint_name' not in params or
params['endpoint_name'] is None):
raise ValueError("Missing the required parameter `endpoint_name` when calling `get_pre_shared_key`") # noqa: E501
collection_formats = {}
path_params = {}
if 'endpoint_name' in params:
path_params['endpoint_name'] = params['endpoint_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v2/device-shared-keys/{endpoint_name}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PreSharedKeyWithoutSecret', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 list_pre_shared_keys(self, **kwargs): # noqa: E501
"""List pre-shared keys. # noqa: E501
List pre-shared keys with pagination and default page size of 50 entries. **Example usage:** ``` curl -H \"authorization: Bearer ${API_TOKEN}\" https://api.us-east-1.mbedcloud.com/v2/device-shared-keys ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.list_pre_shared_keys(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of entries per page
:param str after: An offset token for fetching a specific page. Provided by the server.
:return: ListOfPreSharedKeysWithoutSecret
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.list_pre_shared_keys_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.list_pre_shared_keys_with_http_info(**kwargs) # noqa: E501
return data
def list_pre_shared_keys_with_http_info(self, **kwargs): # noqa: E501
"""List pre-shared keys. # noqa: E501
List pre-shared keys with pagination and default page size of 50 entries. **Example usage:** ``` curl -H \"authorization: Bearer ${API_TOKEN}\" https://api.us-east-1.mbedcloud.com/v2/device-shared-keys ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.list_pre_shared_keys_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of entries per page
:param str after: An offset token for fetching a specific page. Provided by the server.
:return: ListOfPreSharedKeysWithoutSecret
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'after'] # noqa: E501
all_params.append('asynchronous')
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 list_pre_shared_keys" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'after' in params:
query_params.append(('after', params['after'])) # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v2/device-shared-keys', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ListOfPreSharedKeysWithoutSecret', # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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 upload_pre_shared_key(self, body, **kwargs): # noqa: E501
"""Upload a pre-shared key to Pelion Device Management. # noqa: E501
Upload a pre-shared key (PSK) for an endpoint to allow it to bootstrap. The existing key will not be overwritten but needs to be deleted first in case of re-setting PSK for an endpoint. **Note**: The PSK APIs are available only to accounts that have this feature enabled. **Example usage:** ``` curl -H \"authorization: Bearer ${API_TOKEN}\" -H \"content-type: application/json\" -X POST https://api.us-east-1.mbedcloud.com/v2/device-shared-keys \\ -d '{\"endpoint_name\": \"my-endpoint-0001\", \"secret_hex\": \"4a4a4a4a4a4a4a4a4a4a4a4a4a4a4a4a\" }' ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.upload_pre_shared_key(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param PreSharedKey body: Pre-shared key to be uploaded. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('asynchronous'):
return self.upload_pre_shared_key_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.upload_pre_shared_key_with_http_info(body, **kwargs) # noqa: E501
return data
def upload_pre_shared_key_with_http_info(self, body, **kwargs): # noqa: E501
"""Upload a pre-shared key to Pelion Device Management. # noqa: E501
Upload a pre-shared key (PSK) for an endpoint to allow it to bootstrap. The existing key will not be overwritten but needs to be deleted first in case of re-setting PSK for an endpoint. **Note**: The PSK APIs are available only to accounts that have this feature enabled. **Example usage:** ``` curl -H \"authorization: Bearer ${API_TOKEN}\" -H \"content-type: application/json\" -X POST https://api.us-east-1.mbedcloud.com/v2/device-shared-keys \\ -d '{\"endpoint_name\": \"my-endpoint-0001\", \"secret_hex\": \"4a4a4a4a4a4a4a4a4a4a4a4a4a4a4a4a\" }' ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.upload_pre_shared_key_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param PreSharedKey body: Pre-shared key to be uploaded. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('asynchronous')
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 upload_pre_shared_key" % 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 `upload_pre_shared_key`") # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v2/device-shared-keys', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
asynchronous=params.get('asynchronous'),
_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)
|
class PreSharedKeysApi(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):
pass
def delete_pre_shared_key(self, endpoint_name, **kwargs):
'''Remove a pre-shared key. # noqa: E501
Remove a pre-shared key. **Example usage:** ``` curl -H "authorization: Bearer ${API_TOKEN}" -X DELETE https://api.us-east-1.mbedcloud.com/v2/device-shared-keys/my-endpoint-0001 ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_pre_shared_key(endpoint_name, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str endpoint_name: The unique endpoint identifier that this pre-shared key applies to. [Reserved characters](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters) must be percent-encoded. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def delete_pre_shared_key_with_http_info(self, endpoint_name, **kwargs):
'''Remove a pre-shared key. # noqa: E501
Remove a pre-shared key. **Example usage:** ``` curl -H "authorization: Bearer ${API_TOKEN}" -X DELETE https://api.us-east-1.mbedcloud.com/v2/device-shared-keys/my-endpoint-0001 ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.delete_pre_shared_key_with_http_info(endpoint_name, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str endpoint_name: The unique endpoint identifier that this pre-shared key applies to. [Reserved characters](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters) must be percent-encoded. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_pre_shared_key(self, endpoint_name, **kwargs):
'''Get a pre-shared key. # noqa: E501
Check if a pre-shared key for an endpoint exists or not. The response does not contain the secret itself. **Example usage:** ``` curl -H "authorization: Bearer ${API_TOKEN}" https://api.us-east-1.mbedcloud.com/v2/device-shared-keys/my-endpoint-0001 ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_pre_shared_key(endpoint_name, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str endpoint_name: The unique endpoint identifier that this pre-shared key applies to. [Reserved characters](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters) must be percent-encoded. (required)
:return: PreSharedKeyWithoutSecret
If the method is called asynchronously,
returns the request thread.
'''
pass
def get_pre_shared_key_with_http_info(self, endpoint_name, **kwargs):
'''Get a pre-shared key. # noqa: E501
Check if a pre-shared key for an endpoint exists or not. The response does not contain the secret itself. **Example usage:** ``` curl -H "authorization: Bearer ${API_TOKEN}" https://api.us-east-1.mbedcloud.com/v2/device-shared-keys/my-endpoint-0001 ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.get_pre_shared_key_with_http_info(endpoint_name, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param str endpoint_name: The unique endpoint identifier that this pre-shared key applies to. [Reserved characters](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters) must be percent-encoded. (required)
:return: PreSharedKeyWithoutSecret
If the method is called asynchronously,
returns the request thread.
'''
pass
def list_pre_shared_keys(self, **kwargs):
'''List pre-shared keys. # noqa: E501
List pre-shared keys with pagination and default page size of 50 entries. **Example usage:** ``` curl -H "authorization: Bearer ${API_TOKEN}" https://api.us-east-1.mbedcloud.com/v2/device-shared-keys ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.list_pre_shared_keys(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of entries per page
:param str after: An offset token for fetching a specific page. Provided by the server.
:return: ListOfPreSharedKeysWithoutSecret
If the method is called asynchronously,
returns the request thread.
'''
pass
def list_pre_shared_keys_with_http_info(self, **kwargs):
'''List pre-shared keys. # noqa: E501
List pre-shared keys with pagination and default page size of 50 entries. **Example usage:** ``` curl -H "authorization: Bearer ${API_TOKEN}" https://api.us-east-1.mbedcloud.com/v2/device-shared-keys ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.list_pre_shared_keys_with_http_info(asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param int limit: The number of entries per page
:param str after: An offset token for fetching a specific page. Provided by the server.
:return: ListOfPreSharedKeysWithoutSecret
If the method is called asynchronously,
returns the request thread.
'''
pass
def upload_pre_shared_key(self, body, **kwargs):
'''Upload a pre-shared key to Pelion Device Management. # noqa: E501
Upload a pre-shared key (PSK) for an endpoint to allow it to bootstrap. The existing key will not be overwritten but needs to be deleted first in case of re-setting PSK for an endpoint. **Note**: The PSK APIs are available only to accounts that have this feature enabled. **Example usage:** ``` curl -H "authorization: Bearer ${API_TOKEN}" -H "content-type: application/json" -X POST https://api.us-east-1.mbedcloud.com/v2/device-shared-keys \ -d '{"endpoint_name": "my-endpoint-0001", "secret_hex": "4a4a4a4a4a4a4a4a4a4a4a4a4a4a4a4a" }' ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.upload_pre_shared_key(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param PreSharedKey body: Pre-shared key to be uploaded. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
def upload_pre_shared_key_with_http_info(self, body, **kwargs):
'''Upload a pre-shared key to Pelion Device Management. # noqa: E501
Upload a pre-shared key (PSK) for an endpoint to allow it to bootstrap. The existing key will not be overwritten but needs to be deleted first in case of re-setting PSK for an endpoint. **Note**: The PSK APIs are available only to accounts that have this feature enabled. **Example usage:** ``` curl -H "authorization: Bearer ${API_TOKEN}" -H "content-type: application/json" -X POST https://api.us-east-1.mbedcloud.com/v2/device-shared-keys \ -d '{"endpoint_name": "my-endpoint-0001", "secret_hex": "4a4a4a4a4a4a4a4a4a4a4a4a4a4a4a4a" }' ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass asynchronous=True
>>> thread = api.upload_pre_shared_key_with_http_info(body, asynchronous=True)
>>> result = thread.get()
:param asynchronous bool
:param PreSharedKey body: Pre-shared key to be uploaded. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
'''
pass
| 10 | 9 | 42 | 6 | 23 | 17 | 3 | 0.73 | 1 | 3 | 1 | 0 | 9 | 1 | 9 | 9 | 391 | 66 | 212 | 59 | 202 | 154 | 133 | 59 | 123 | 5 | 1 | 2 | 30 |
2,494 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/connector_ca/models/developer_certificate_response_data.py
|
mbed_cloud._backends.connector_ca.models.developer_certificate_response_data.DeveloperCertificateResponseData
|
class DeveloperCertificateResponseData(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 = {
'account_id': 'str',
'created_at': 'datetime',
'description': 'str',
'developer_certificate': 'str',
'developer_private_key': 'str',
'etag': 'str',
'id': 'str',
'name': 'str',
'object': 'str',
'security_file_content': 'str'
}
attribute_map = {
'account_id': 'account_id',
'created_at': 'created_at',
'description': 'description',
'developer_certificate': 'developer_certificate',
'developer_private_key': 'developer_private_key',
'etag': 'etag',
'id': 'id',
'name': 'name',
'object': 'object',
'security_file_content': 'security_file_content'
}
def __init__(self, account_id=None, created_at=None, description=None, developer_certificate=None, developer_private_key=None, etag=None, id=None, name=None, object=None, security_file_content=None):
"""
DeveloperCertificateResponseData - a model defined in Swagger
"""
self._account_id = account_id
self._created_at = created_at
self._description = description
self._developer_certificate = developer_certificate
self._developer_private_key = developer_private_key
self._etag = etag
self._id = id
self._name = name
self._object = object
self._security_file_content = security_file_content
self.discriminator = None
@property
def account_id(self):
"""
Gets the account_id of this DeveloperCertificateResponseData.
account to which the developer certificate belongs
:return: The account_id of this DeveloperCertificateResponseData.
:rtype: str
"""
return self._account_id
@account_id.setter
def account_id(self, account_id):
"""
Sets the account_id of this DeveloperCertificateResponseData.
account to which the developer certificate belongs
:param account_id: The account_id of this DeveloperCertificateResponseData.
:type: str
"""
self._account_id = account_id
@property
def created_at(self):
"""
Gets the created_at of this DeveloperCertificateResponseData.
Creation UTC time RFC3339.
:return: The created_at of this DeveloperCertificateResponseData.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this DeveloperCertificateResponseData.
Creation UTC time RFC3339.
:param created_at: The created_at of this DeveloperCertificateResponseData.
:type: datetime
"""
self._created_at = created_at
@property
def description(self):
"""
Gets the description of this DeveloperCertificateResponseData.
Description for the developer certificate.
:return: The description of this DeveloperCertificateResponseData.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DeveloperCertificateResponseData.
Description for the developer certificate.
:param description: The description of this DeveloperCertificateResponseData.
:type: str
"""
self._description = description
@property
def developer_certificate(self):
"""
Gets the developer_certificate of this DeveloperCertificateResponseData.
PEM format X.509 developer certificate.
:return: The developer_certificate of this DeveloperCertificateResponseData.
:rtype: str
"""
return self._developer_certificate
@developer_certificate.setter
def developer_certificate(self, developer_certificate):
"""
Sets the developer_certificate of this DeveloperCertificateResponseData.
PEM format X.509 developer certificate.
:param developer_certificate: The developer_certificate of this DeveloperCertificateResponseData.
:type: str
"""
self._developer_certificate = developer_certificate
@property
def developer_private_key(self):
"""
Gets the developer_private_key of this DeveloperCertificateResponseData.
PEM format developer private key associated to the certificate.
:return: The developer_private_key of this DeveloperCertificateResponseData.
:rtype: str
"""
return self._developer_private_key
@developer_private_key.setter
def developer_private_key(self, developer_private_key):
"""
Sets the developer_private_key of this DeveloperCertificateResponseData.
PEM format developer private key associated to the certificate.
:param developer_private_key: The developer_private_key of this DeveloperCertificateResponseData.
:type: str
"""
self._developer_private_key = developer_private_key
@property
def etag(self):
"""
Gets the etag of this DeveloperCertificateResponseData.
API resource entity version.
:return: The etag of this DeveloperCertificateResponseData.
:rtype: str
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this DeveloperCertificateResponseData.
API resource entity version.
:param etag: The etag of this DeveloperCertificateResponseData.
:type: str
"""
self._etag = etag
@property
def id(self):
"""
Gets the id of this DeveloperCertificateResponseData.
mUUID that uniquely identifies the developer certificate.
:return: The id of this DeveloperCertificateResponseData.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DeveloperCertificateResponseData.
mUUID that uniquely identifies the developer certificate.
:param id: The id of this DeveloperCertificateResponseData.
:type: str
"""
self._id = id
@property
def name(self):
"""
Gets the name of this DeveloperCertificateResponseData.
Name of the developer certificate.
:return: The name of this DeveloperCertificateResponseData.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DeveloperCertificateResponseData.
Name of the developer certificate.
:param name: The name of this DeveloperCertificateResponseData.
:type: str
"""
self._name = name
@property
def object(self):
"""
Gets the object of this DeveloperCertificateResponseData.
Entity name, always 'trusted-cert'
:return: The object of this DeveloperCertificateResponseData.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this DeveloperCertificateResponseData.
Entity name, always 'trusted-cert'
:param object: The object of this DeveloperCertificateResponseData.
:type: str
"""
self._object = object
@property
def security_file_content(self):
"""
Gets the security_file_content of this DeveloperCertificateResponseData.
Content of the security.c file that will be flashed into the device to provide the security credentials
:return: The security_file_content of this DeveloperCertificateResponseData.
:rtype: str
"""
return self._security_file_content
@security_file_content.setter
def security_file_content(self, security_file_content):
"""
Sets the security_file_content of this DeveloperCertificateResponseData.
Content of the security.c file that will be flashed into the device to provide the security credentials
:param security_file_content: The security_file_content of this DeveloperCertificateResponseData.
:type: str
"""
self._security_file_content = security_file_content
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, DeveloperCertificateResponseData):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class DeveloperCertificateResponseData(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, account_id=None, created_at=None, description=None, developer_certificate=None, developer_private_key=None, etag=None, id=None, name=None, object=None, security_file_content=None):
'''
DeveloperCertificateResponseData - a model defined in Swagger
'''
pass
@property
def account_id(self):
'''
Gets the account_id of this DeveloperCertificateResponseData.
account to which the developer certificate belongs
:return: The account_id of this DeveloperCertificateResponseData.
:rtype: str
'''
pass
@account_id.setter
def account_id(self):
'''
Sets the account_id of this DeveloperCertificateResponseData.
account to which the developer certificate belongs
:param account_id: The account_id of this DeveloperCertificateResponseData.
:type: str
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this DeveloperCertificateResponseData.
Creation UTC time RFC3339.
:return: The created_at of this DeveloperCertificateResponseData.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this DeveloperCertificateResponseData.
Creation UTC time RFC3339.
:param created_at: The created_at of this DeveloperCertificateResponseData.
:type: datetime
'''
pass
@property
def description(self):
'''
Gets the description of this DeveloperCertificateResponseData.
Description for the developer certificate.
:return: The description of this DeveloperCertificateResponseData.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this DeveloperCertificateResponseData.
Description for the developer certificate.
:param description: The description of this DeveloperCertificateResponseData.
:type: str
'''
pass
@property
def developer_certificate(self):
'''
Gets the developer_certificate of this DeveloperCertificateResponseData.
PEM format X.509 developer certificate.
:return: The developer_certificate of this DeveloperCertificateResponseData.
:rtype: str
'''
pass
@developer_certificate.setter
def developer_certificate(self):
'''
Sets the developer_certificate of this DeveloperCertificateResponseData.
PEM format X.509 developer certificate.
:param developer_certificate: The developer_certificate of this DeveloperCertificateResponseData.
:type: str
'''
pass
@property
def developer_private_key(self):
'''
Gets the developer_private_key of this DeveloperCertificateResponseData.
PEM format developer private key associated to the certificate.
:return: The developer_private_key of this DeveloperCertificateResponseData.
:rtype: str
'''
pass
@developer_private_key.setter
def developer_private_key(self):
'''
Sets the developer_private_key of this DeveloperCertificateResponseData.
PEM format developer private key associated to the certificate.
:param developer_private_key: The developer_private_key of this DeveloperCertificateResponseData.
:type: str
'''
pass
@property
def etag(self):
'''
Gets the etag of this DeveloperCertificateResponseData.
API resource entity version.
:return: The etag of this DeveloperCertificateResponseData.
:rtype: str
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this DeveloperCertificateResponseData.
API resource entity version.
:param etag: The etag of this DeveloperCertificateResponseData.
:type: str
'''
pass
@property
def id(self):
'''
Gets the id of this DeveloperCertificateResponseData.
mUUID that uniquely identifies the developer certificate.
:return: The id of this DeveloperCertificateResponseData.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this DeveloperCertificateResponseData.
mUUID that uniquely identifies the developer certificate.
:param id: The id of this DeveloperCertificateResponseData.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this DeveloperCertificateResponseData.
Name of the developer certificate.
:return: The name of this DeveloperCertificateResponseData.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this DeveloperCertificateResponseData.
Name of the developer certificate.
:param name: The name of this DeveloperCertificateResponseData.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this DeveloperCertificateResponseData.
Entity name, always 'trusted-cert'
:return: The object of this DeveloperCertificateResponseData.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this DeveloperCertificateResponseData.
Entity name, always 'trusted-cert'
:param object: The object of this DeveloperCertificateResponseData.
:type: str
'''
pass
@property
def security_file_content(self):
'''
Gets the security_file_content of this DeveloperCertificateResponseData.
Content of the security.c file that will be flashed into the device to provide the security credentials
:return: The security_file_content of this DeveloperCertificateResponseData.
:rtype: str
'''
pass
@security_file_content.setter
def security_file_content(self):
'''
Sets the security_file_content of this DeveloperCertificateResponseData.
Content of the security.c file that will be flashed into the device to provide the security credentials
:param security_file_content: The security_file_content of this DeveloperCertificateResponseData.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 47 | 27 | 10 | 1 | 3 | 5 | 1 | 1.17 | 1 | 3 | 0 | 0 | 26 | 11 | 26 | 26 | 339 | 63 | 127 | 63 | 80 | 149 | 75 | 43 | 48 | 5 | 1 | 2 | 31 |
2,495 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/error_response.py
|
mbed_cloud._backends.iam.models.error_response.ErrorResponse
|
class ErrorResponse(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'code': 'int',
'fields': 'list[Field]',
'message': 'str',
'object': 'str',
'request_id': 'str',
'type': 'str'
}
attribute_map = {
'code': 'code',
'fields': 'fields',
'message': 'message',
'object': 'object',
'request_id': 'request_id',
'type': 'type'
}
def __init__(self, code=None, fields=None, message=None, object=None, request_id=None, type=None):
"""
ErrorResponse - a model defined in Swagger
"""
self._code = code
self._fields = fields
self._message = message
self._object = object
self._request_id = request_id
self._type = type
self.discriminator = None
@property
def code(self):
"""
Gets the code of this ErrorResponse.
Response code.
:return: The code of this ErrorResponse.
:rtype: int
"""
return self._code
@code.setter
def code(self, code):
"""
Sets the code of this ErrorResponse.
Response code.
:param code: The code of this ErrorResponse.
:type: int
"""
if code is None:
raise ValueError("Invalid value for `code`, must not be `None`")
self._code = code
@property
def fields(self):
"""
Gets the fields of this ErrorResponse.
Failed input fields during request object validation.
:return: The fields of this ErrorResponse.
:rtype: list[Field]
"""
return self._fields
@fields.setter
def fields(self, fields):
"""
Sets the fields of this ErrorResponse.
Failed input fields during request object validation.
:param fields: The fields of this ErrorResponse.
:type: list[Field]
"""
self._fields = fields
@property
def message(self):
"""
Gets the message of this ErrorResponse.
A human readable message with detailed info.
:return: The message of this ErrorResponse.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this ErrorResponse.
A human readable message with detailed info.
:param message: The message of this ErrorResponse.
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`")
self._message = message
@property
def object(self):
"""
Gets the object of this ErrorResponse.
Entity name, always 'error'.
:return: The object of this ErrorResponse.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this ErrorResponse.
Entity name, always 'error'.
:param object: The object of this ErrorResponse.
:type: str
"""
if object is None:
raise ValueError("Invalid value for `object`, must not be `None`")
allowed_values = ["error"]
if object not in allowed_values:
raise ValueError(
"Invalid value for `object` ({0}), must be one of {1}"
.format(object, allowed_values)
)
self._object = object
@property
def request_id(self):
"""
Gets the request_id of this ErrorResponse.
Request ID.
:return: The request_id of this ErrorResponse.
:rtype: str
"""
return self._request_id
@request_id.setter
def request_id(self, request_id):
"""
Sets the request_id of this ErrorResponse.
Request ID.
:param request_id: The request_id of this ErrorResponse.
:type: str
"""
if request_id is None:
raise ValueError("Invalid value for `request_id`, must not be `None`")
self._request_id = request_id
@property
def type(self):
"""
Gets the type of this ErrorResponse.
Error type.
:return: The type of this ErrorResponse.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this ErrorResponse.
Error type.
:param type: The type of this ErrorResponse.
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`")
allowed_values = ["success", "created", "accepted", "permanently_deleted", "validation_error", "invalid_token", "invalid_apikey", "reauth_required", "access_denied", "account_limit_exceeded", "not_found", "method_not_supported", "not_acceptable", "duplicate", "precondition_failed", "unsupported_media_type", "rate_limit_exceeded", "internal_server_error", "system_unavailable"]
if type not in allowed_values:
raise ValueError(
"Invalid value for `type` ({0}), must be one of {1}"
.format(type, allowed_values)
)
self._type = type
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, ErrorResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class ErrorResponse(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, code=None, fields=None, message=None, object=None, request_id=None, type=None):
'''
ErrorResponse - a model defined in Swagger
'''
pass
@property
def code(self):
'''
Gets the code of this ErrorResponse.
Response code.
:return: The code of this ErrorResponse.
:rtype: int
'''
pass
@code.setter
def code(self):
'''
Sets the code of this ErrorResponse.
Response code.
:param code: The code of this ErrorResponse.
:type: int
'''
pass
@property
def fields(self):
'''
Gets the fields of this ErrorResponse.
Failed input fields during request object validation.
:return: The fields of this ErrorResponse.
:rtype: list[Field]
'''
pass
@fields.setter
def fields(self):
'''
Sets the fields of this ErrorResponse.
Failed input fields during request object validation.
:param fields: The fields of this ErrorResponse.
:type: list[Field]
'''
pass
@property
def message(self):
'''
Gets the message of this ErrorResponse.
A human readable message with detailed info.
:return: The message of this ErrorResponse.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this ErrorResponse.
A human readable message with detailed info.
:param message: The message of this ErrorResponse.
:type: str
'''
pass
@property
def object(self):
'''
Gets the object of this ErrorResponse.
Entity name, always 'error'.
:return: The object of this ErrorResponse.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this ErrorResponse.
Entity name, always 'error'.
:param object: The object of this ErrorResponse.
:type: str
'''
pass
@property
def request_id(self):
'''
Gets the request_id of this ErrorResponse.
Request ID.
:return: The request_id of this ErrorResponse.
:rtype: str
'''
pass
@request_id.setter
def request_id(self):
'''
Sets the request_id of this ErrorResponse.
Request ID.
:param request_id: The request_id of this ErrorResponse.
:type: str
'''
pass
@property
def type(self):
'''
Gets the type of this ErrorResponse.
Error type.
:return: The type of this ErrorResponse.
:rtype: str
'''
pass
@type.setter
def type(self):
'''
Sets the type of this ErrorResponse.
Error type.
:param type: The type of this ErrorResponse.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 31 | 19 | 11 | 1 | 5 | 5 | 2 | 0.89 | 1 | 4 | 0 | 0 | 18 | 7 | 18 | 18 | 257 | 43 | 113 | 45 | 82 | 101 | 71 | 33 | 52 | 5 | 1 | 2 | 30 |
2,496 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/feature_policy.py
|
mbed_cloud._backends.iam.models.feature_policy.FeaturePolicy
|
class FeaturePolicy(object):
"""
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'action': 'str',
'allow': 'bool',
'feature': 'str',
'inherited': 'bool',
'resource': 'str'
}
attribute_map = {
'action': 'action',
'allow': 'allow',
'feature': 'feature',
'inherited': 'inherited',
'resource': 'resource'
}
def __init__(self, action=None, allow=None, feature=None, inherited=None, resource=None):
"""
FeaturePolicy - a model defined in Swagger
"""
self._action = action
self._allow = allow
self._feature = feature
self._inherited = inherited
self._resource = resource
self.discriminator = None
@property
def action(self):
"""
Gets the action of this FeaturePolicy.
Comma separated list of actions, empty string represents all actions.
:return: The action of this FeaturePolicy.
:rtype: str
"""
return self._action
@action.setter
def action(self, action):
"""
Sets the action of this FeaturePolicy.
Comma separated list of actions, empty string represents all actions.
:param action: The action of this FeaturePolicy.
:type: str
"""
self._action = action
@property
def allow(self):
"""
Gets the allow of this FeaturePolicy.
True or false controlling whether an action is allowed or not.
:return: The allow of this FeaturePolicy.
:rtype: bool
"""
return self._allow
@allow.setter
def allow(self, allow):
"""
Sets the allow of this FeaturePolicy.
True or false controlling whether an action is allowed or not.
:param allow: The allow of this FeaturePolicy.
:type: bool
"""
self._allow = allow
@property
def feature(self):
"""
Gets the feature of this FeaturePolicy.
Feature name corresponding to this policy.
:return: The feature of this FeaturePolicy.
:rtype: str
"""
return self._feature
@feature.setter
def feature(self, feature):
"""
Sets the feature of this FeaturePolicy.
Feature name corresponding to this policy.
:param feature: The feature of this FeaturePolicy.
:type: str
"""
self._feature = feature
@property
def inherited(self):
"""
Gets the inherited of this FeaturePolicy.
Flag indicating whether this feature is inherited or overwritten specifically.
:return: The inherited of this FeaturePolicy.
:rtype: bool
"""
return self._inherited
@inherited.setter
def inherited(self, inherited):
"""
Sets the inherited of this FeaturePolicy.
Flag indicating whether this feature is inherited or overwritten specifically.
:param inherited: The inherited of this FeaturePolicy.
:type: bool
"""
self._inherited = inherited
@property
def resource(self):
"""
Gets the resource of this FeaturePolicy.
Resource that is protected by this policy.
:return: The resource of this FeaturePolicy.
:rtype: str
"""
return self._resource
@resource.setter
def resource(self, resource):
"""
Sets the resource of this FeaturePolicy.
Resource that is protected by this policy.
:param resource: The resource of this FeaturePolicy.
:type: str
"""
self._resource = resource
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, FeaturePolicy):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class FeaturePolicy(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, action=None, allow=None, feature=None, inherited=None, resource=None):
'''
FeaturePolicy - a model defined in Swagger
'''
pass
@property
def action(self):
'''
Gets the action of this FeaturePolicy.
Comma separated list of actions, empty string represents all actions.
:return: The action of this FeaturePolicy.
:rtype: str
'''
pass
@action.setter
def action(self):
'''
Sets the action of this FeaturePolicy.
Comma separated list of actions, empty string represents all actions.
:param action: The action of this FeaturePolicy.
:type: str
'''
pass
@property
def allow(self):
'''
Gets the allow of this FeaturePolicy.
True or false controlling whether an action is allowed or not.
:return: The allow of this FeaturePolicy.
:rtype: bool
'''
pass
@allow.setter
def allow(self):
'''
Sets the allow of this FeaturePolicy.
True or false controlling whether an action is allowed or not.
:param allow: The allow of this FeaturePolicy.
:type: bool
'''
pass
@property
def feature(self):
'''
Gets the feature of this FeaturePolicy.
Feature name corresponding to this policy.
:return: The feature of this FeaturePolicy.
:rtype: str
'''
pass
@feature.setter
def feature(self):
'''
Sets the feature of this FeaturePolicy.
Feature name corresponding to this policy.
:param feature: The feature of this FeaturePolicy.
:type: str
'''
pass
@property
def inherited(self):
'''
Gets the inherited of this FeaturePolicy.
Flag indicating whether this feature is inherited or overwritten specifically.
:return: The inherited of this FeaturePolicy.
:rtype: bool
'''
pass
@inherited.setter
def inherited(self):
'''
Sets the inherited of this FeaturePolicy.
Flag indicating whether this feature is inherited or overwritten specifically.
:param inherited: The inherited of this FeaturePolicy.
:type: bool
'''
pass
@property
def resource(self):
'''
Gets the resource of this FeaturePolicy.
Resource that is protected by this policy.
:return: The resource of this FeaturePolicy.
:rtype: str
'''
pass
@resource.setter
def resource(self):
'''
Sets the resource of this FeaturePolicy.
Resource that is protected by this policy.
:param resource: The resource of this FeaturePolicy.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 27 | 17 | 10 | 1 | 4 | 5 | 1 | 1.09 | 1 | 3 | 0 | 0 | 16 | 6 | 16 | 16 | 209 | 38 | 82 | 38 | 55 | 89 | 50 | 28 | 33 | 5 | 1 | 2 | 21 |
2,497 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/iam/models/field.py
|
mbed_cloud._backends.iam.models.field.Field
|
class Field(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': 'str',
'name': 'str'
}
attribute_map = {
'message': 'message',
'name': 'name'
}
def __init__(self, message=None, name=None):
"""
Field - a model defined in Swagger
"""
self._message = message
self._name = name
self.discriminator = None
@property
def message(self):
"""
Gets the message of this Field.
Message describing the erroneous situation.
:return: The message of this Field.
:rtype: str
"""
return self._message
@message.setter
def message(self, message):
"""
Sets the message of this Field.
Message describing the erroneous situation.
:param message: The message of this Field.
:type: str
"""
if message is None:
raise ValueError("Invalid value for `message`, must not be `None`")
self._message = message
@property
def name(self):
"""
Gets the name of this Field.
Name of the erroneous field.
:return: The name of this Field.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this Field.
Name of the erroneous field.
:param name: The name of this Field.
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`")
self._name = name
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, Field):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class Field(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, message=None, name=None):
'''
Field - a model defined in Swagger
'''
pass
@property
def message(self):
'''
Gets the message of this Field.
Message describing the erroneous situation.
:return: The message of this Field.
:rtype: str
'''
pass
@message.setter
def message(self):
'''
Sets the message of this Field.
Message describing the erroneous situation.
:param message: The message of this Field.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this Field.
Name of the erroneous field.
:return: The name of this Field.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this Field.
Name of the erroneous field.
:param name: The name of this Field.
:type: str
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 15 | 11 | 10 | 1 | 5 | 4 | 2 | 0.9 | 1 | 4 | 0 | 0 | 10 | 3 | 10 | 10 | 135 | 23 | 59 | 23 | 44 | 53 | 39 | 19 | 28 | 5 | 1 | 2 | 17 |
2,498 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/update_service/models/firmware_manifest_page.py
|
mbed_cloud._backends.update_service.models.firmware_manifest_page.FirmwareManifestPage
|
class FirmwareManifestPage(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 = {
'after': 'str',
'data': 'list[FirmwareManifest]',
'has_more': 'bool',
'limit': 'int',
'object': 'str',
'order': 'str',
'total_count': 'int'
}
attribute_map = {
'after': 'after',
'data': 'data',
'has_more': 'has_more',
'limit': 'limit',
'object': 'object',
'order': 'order',
'total_count': 'total_count'
}
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
"""
FirmwareManifestPage - a model defined in Swagger
"""
self._after = after
self._data = data
self._has_more = has_more
self._limit = limit
self._object = object
self._order = order
self._total_count = total_count
self.discriminator = None
@property
def after(self):
"""
Gets the after of this FirmwareManifestPage.
:return: The after of this FirmwareManifestPage.
:rtype: str
"""
return self._after
@after.setter
def after(self, after):
"""
Sets the after of this FirmwareManifestPage.
:param after: The after of this FirmwareManifestPage.
:type: str
"""
self._after = after
@property
def data(self):
"""
Gets the data of this FirmwareManifestPage.
:return: The data of this FirmwareManifestPage.
:rtype: list[FirmwareManifest]
"""
return self._data
@data.setter
def data(self, data):
"""
Sets the data of this FirmwareManifestPage.
:param data: The data of this FirmwareManifestPage.
:type: list[FirmwareManifest]
"""
self._data = data
@property
def has_more(self):
"""
Gets the has_more of this FirmwareManifestPage.
:return: The has_more of this FirmwareManifestPage.
:rtype: bool
"""
return self._has_more
@has_more.setter
def has_more(self, has_more):
"""
Sets the has_more of this FirmwareManifestPage.
:param has_more: The has_more of this FirmwareManifestPage.
:type: bool
"""
self._has_more = has_more
@property
def limit(self):
"""
Gets the limit of this FirmwareManifestPage.
:return: The limit of this FirmwareManifestPage.
:rtype: int
"""
return self._limit
@limit.setter
def limit(self, limit):
"""
Sets the limit of this FirmwareManifestPage.
:param limit: The limit of this FirmwareManifestPage.
:type: int
"""
self._limit = limit
@property
def object(self):
"""
Gets the object of this FirmwareManifestPage.
:return: The object of this FirmwareManifestPage.
:rtype: str
"""
return self._object
@object.setter
def object(self, object):
"""
Sets the object of this FirmwareManifestPage.
:param object: The object of this FirmwareManifestPage.
:type: str
"""
self._object = object
@property
def order(self):
"""
Gets the order of this FirmwareManifestPage.
The order of the records to return. Acceptable values: ASC, DESC. Default: ASC
:return: The order of this FirmwareManifestPage.
:rtype: str
"""
return self._order
@order.setter
def order(self, order):
"""
Sets the order of this FirmwareManifestPage.
The order of the records to return. Acceptable values: ASC, DESC. Default: ASC
:param order: The order of this FirmwareManifestPage.
:type: str
"""
allowed_values = ["ASC", "DESC"]
if order not in allowed_values:
raise ValueError(
"Invalid value for `order` ({0}), must be one of {1}"
.format(order, allowed_values)
)
self._order = order
@property
def total_count(self):
"""
Gets the total_count of this FirmwareManifestPage.
:return: The total_count of this FirmwareManifestPage.
:rtype: int
"""
return self._total_count
@total_count.setter
def total_count(self, total_count):
"""
Sets the total_count of this FirmwareManifestPage.
:param total_count: The total_count of this FirmwareManifestPage.
:type: int
"""
self._total_count = total_count
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, FirmwareManifestPage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class FirmwareManifestPage(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, after=None, data=None, has_more=None, limit=None, object=None, order=None, total_count=None):
'''
FirmwareManifestPage - a model defined in Swagger
'''
pass
@property
def after(self):
'''
Gets the after of this FirmwareManifestPage.
:return: The after of this FirmwareManifestPage.
:rtype: str
'''
pass
@after.setter
def after(self):
'''
Sets the after of this FirmwareManifestPage.
:param after: The after of this FirmwareManifestPage.
:type: str
'''
pass
@property
def data(self):
'''
Gets the data of this FirmwareManifestPage.
:return: The data of this FirmwareManifestPage.
:rtype: list[FirmwareManifest]
'''
pass
@data.setter
def data(self):
'''
Sets the data of this FirmwareManifestPage.
:param data: The data of this FirmwareManifestPage.
:type: list[FirmwareManifest]
'''
pass
@property
def has_more(self):
'''
Gets the has_more of this FirmwareManifestPage.
:return: The has_more of this FirmwareManifestPage.
:rtype: bool
'''
pass
@has_more.setter
def has_more(self):
'''
Sets the has_more of this FirmwareManifestPage.
:param has_more: The has_more of this FirmwareManifestPage.
:type: bool
'''
pass
@property
def limit(self):
'''
Gets the limit of this FirmwareManifestPage.
:return: The limit of this FirmwareManifestPage.
:rtype: int
'''
pass
@limit.setter
def limit(self):
'''
Sets the limit of this FirmwareManifestPage.
:param limit: The limit of this FirmwareManifestPage.
:type: int
'''
pass
@property
def object(self):
'''
Gets the object of this FirmwareManifestPage.
:return: The object of this FirmwareManifestPage.
:rtype: str
'''
pass
@object.setter
def object(self):
'''
Sets the object of this FirmwareManifestPage.
:param object: The object of this FirmwareManifestPage.
:type: str
'''
pass
@property
def order(self):
'''
Gets the order of this FirmwareManifestPage.
The order of the records to return. Acceptable values: ASC, DESC. Default: ASC
:return: The order of this FirmwareManifestPage.
:rtype: str
'''
pass
@order.setter
def order(self):
'''
Sets the order of this FirmwareManifestPage.
The order of the records to return. Acceptable values: ASC, DESC. Default: ASC
:param order: The order of this FirmwareManifestPage.
:type: str
'''
pass
@property
def total_count(self):
'''
Gets the total_count of this FirmwareManifestPage.
:return: The total_count of this FirmwareManifestPage.
:rtype: int
'''
pass
@total_count.setter
def total_count(self):
'''
Sets the total_count of this FirmwareManifestPage.
:param total_count: The total_count of this FirmwareManifestPage.
:type: int
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 35 | 21 | 9 | 1 | 4 | 5 | 1 | 0.95 | 1 | 4 | 0 | 0 | 20 | 8 | 20 | 20 | 255 | 48 | 106 | 49 | 71 | 101 | 63 | 35 | 42 | 5 | 1 | 2 | 26 |
2,499 |
ARMmbed/mbed-cloud-sdk-python
|
ARMmbed_mbed-cloud-sdk-python/src/mbed_cloud/_backends/update_service/models/firmware_manifest_in_nin_filter.py
|
mbed_cloud._backends.update_service.models.firmware_manifest_in_nin_filter.FirmwareManifestInNinFilter
|
class FirmwareManifestInNinFilter(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 = {
'created_at': 'datetime',
'datafile': 'str',
'datafile_size': 'int',
'description': 'str',
'device_class': 'str',
'etag': 'datetime',
'id': 'str',
'name': 'str',
'timestamp': 'datetime',
'updated_at': 'datetime'
}
attribute_map = {
'created_at': 'created_at',
'datafile': 'datafile',
'datafile_size': 'datafile_size',
'description': 'description',
'device_class': 'device_class',
'etag': 'etag',
'id': 'id',
'name': 'name',
'timestamp': 'timestamp',
'updated_at': 'updated_at'
}
def __init__(self, created_at=None, datafile=None, datafile_size=None, description=None, device_class=None, etag=None, id=None, name=None, timestamp=None, updated_at=None):
"""
FirmwareManifestInNinFilter - a model defined in Swagger
"""
self._created_at = created_at
self._datafile = datafile
self._datafile_size = datafile_size
self._description = description
self._device_class = device_class
self._etag = etag
self._id = id
self._name = name
self._timestamp = timestamp
self._updated_at = updated_at
self.discriminator = None
@property
def created_at(self):
"""
Gets the created_at of this FirmwareManifestInNinFilter.
:return: The created_at of this FirmwareManifestInNinFilter.
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""
Sets the created_at of this FirmwareManifestInNinFilter.
:param created_at: The created_at of this FirmwareManifestInNinFilter.
:type: datetime
"""
self._created_at = created_at
@property
def datafile(self):
"""
Gets the datafile of this FirmwareManifestInNinFilter.
:return: The datafile of this FirmwareManifestInNinFilter.
:rtype: str
"""
return self._datafile
@datafile.setter
def datafile(self, datafile):
"""
Sets the datafile of this FirmwareManifestInNinFilter.
:param datafile: The datafile of this FirmwareManifestInNinFilter.
:type: str
"""
self._datafile = datafile
@property
def datafile_size(self):
"""
Gets the datafile_size of this FirmwareManifestInNinFilter.
:return: The datafile_size of this FirmwareManifestInNinFilter.
:rtype: int
"""
return self._datafile_size
@datafile_size.setter
def datafile_size(self, datafile_size):
"""
Sets the datafile_size of this FirmwareManifestInNinFilter.
:param datafile_size: The datafile_size of this FirmwareManifestInNinFilter.
:type: int
"""
self._datafile_size = datafile_size
@property
def description(self):
"""
Gets the description of this FirmwareManifestInNinFilter.
:return: The description of this FirmwareManifestInNinFilter.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this FirmwareManifestInNinFilter.
:param description: The description of this FirmwareManifestInNinFilter.
:type: str
"""
self._description = description
@property
def device_class(self):
"""
Gets the device_class of this FirmwareManifestInNinFilter.
:return: The device_class of this FirmwareManifestInNinFilter.
:rtype: str
"""
return self._device_class
@device_class.setter
def device_class(self, device_class):
"""
Sets the device_class of this FirmwareManifestInNinFilter.
:param device_class: The device_class of this FirmwareManifestInNinFilter.
:type: str
"""
self._device_class = device_class
@property
def etag(self):
"""
Gets the etag of this FirmwareManifestInNinFilter.
:return: The etag of this FirmwareManifestInNinFilter.
:rtype: datetime
"""
return self._etag
@etag.setter
def etag(self, etag):
"""
Sets the etag of this FirmwareManifestInNinFilter.
:param etag: The etag of this FirmwareManifestInNinFilter.
:type: datetime
"""
self._etag = etag
@property
def id(self):
"""
Gets the id of this FirmwareManifestInNinFilter.
:return: The id of this FirmwareManifestInNinFilter.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this FirmwareManifestInNinFilter.
:param id: The id of this FirmwareManifestInNinFilter.
:type: str
"""
self._id = id
@property
def name(self):
"""
Gets the name of this FirmwareManifestInNinFilter.
:return: The name of this FirmwareManifestInNinFilter.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this FirmwareManifestInNinFilter.
:param name: The name of this FirmwareManifestInNinFilter.
:type: str
"""
self._name = name
@property
def timestamp(self):
"""
Gets the timestamp of this FirmwareManifestInNinFilter.
:return: The timestamp of this FirmwareManifestInNinFilter.
:rtype: datetime
"""
return self._timestamp
@timestamp.setter
def timestamp(self, timestamp):
"""
Sets the timestamp of this FirmwareManifestInNinFilter.
:param timestamp: The timestamp of this FirmwareManifestInNinFilter.
:type: datetime
"""
self._timestamp = timestamp
@property
def updated_at(self):
"""
Gets the updated_at of this FirmwareManifestInNinFilter.
:return: The updated_at of this FirmwareManifestInNinFilter.
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""
Sets the updated_at of this FirmwareManifestInNinFilter.
:param updated_at: The updated_at of this FirmwareManifestInNinFilter.
:type: datetime
"""
self._updated_at = updated_at
def to_dict(self):
"""
Returns the model properties as a dict
"""
result = {}
for attr, _ in 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
return result
def to_str(self):
"""
Returns the string representation of the model
"""
return 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, FirmwareManifestInNinFilter):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""
Returns true if both objects are not equal
"""
return not self == other
|
class FirmwareManifestInNinFilter(object):
'''
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
'''
def __init__(self, created_at=None, datafile=None, datafile_size=None, description=None, device_class=None, etag=None, id=None, name=None, timestamp=None, updated_at=None):
'''
FirmwareManifestInNinFilter - a model defined in Swagger
'''
pass
@property
def created_at(self):
'''
Gets the created_at of this FirmwareManifestInNinFilter.
:return: The created_at of this FirmwareManifestInNinFilter.
:rtype: datetime
'''
pass
@created_at.setter
def created_at(self):
'''
Sets the created_at of this FirmwareManifestInNinFilter.
:param created_at: The created_at of this FirmwareManifestInNinFilter.
:type: datetime
'''
pass
@property
def datafile(self):
'''
Gets the datafile of this FirmwareManifestInNinFilter.
:return: The datafile of this FirmwareManifestInNinFilter.
:rtype: str
'''
pass
@datafile.setter
def datafile(self):
'''
Sets the datafile of this FirmwareManifestInNinFilter.
:param datafile: The datafile of this FirmwareManifestInNinFilter.
:type: str
'''
pass
@property
def datafile_size(self):
'''
Gets the datafile_size of this FirmwareManifestInNinFilter.
:return: The datafile_size of this FirmwareManifestInNinFilter.
:rtype: int
'''
pass
@datafile_size.setter
def datafile_size(self):
'''
Sets the datafile_size of this FirmwareManifestInNinFilter.
:param datafile_size: The datafile_size of this FirmwareManifestInNinFilter.
:type: int
'''
pass
@property
def description(self):
'''
Gets the description of this FirmwareManifestInNinFilter.
:return: The description of this FirmwareManifestInNinFilter.
:rtype: str
'''
pass
@description.setter
def description(self):
'''
Sets the description of this FirmwareManifestInNinFilter.
:param description: The description of this FirmwareManifestInNinFilter.
:type: str
'''
pass
@property
def device_class(self):
'''
Gets the device_class of this FirmwareManifestInNinFilter.
:return: The device_class of this FirmwareManifestInNinFilter.
:rtype: str
'''
pass
@device_class.setter
def device_class(self):
'''
Sets the device_class of this FirmwareManifestInNinFilter.
:param device_class: The device_class of this FirmwareManifestInNinFilter.
:type: str
'''
pass
@property
def etag(self):
'''
Gets the etag of this FirmwareManifestInNinFilter.
:return: The etag of this FirmwareManifestInNinFilter.
:rtype: datetime
'''
pass
@etag.setter
def etag(self):
'''
Sets the etag of this FirmwareManifestInNinFilter.
:param etag: The etag of this FirmwareManifestInNinFilter.
:type: datetime
'''
pass
@property
def id(self):
'''
Gets the id of this FirmwareManifestInNinFilter.
:return: The id of this FirmwareManifestInNinFilter.
:rtype: str
'''
pass
@id.setter
def id(self):
'''
Sets the id of this FirmwareManifestInNinFilter.
:param id: The id of this FirmwareManifestInNinFilter.
:type: str
'''
pass
@property
def name(self):
'''
Gets the name of this FirmwareManifestInNinFilter.
:return: The name of this FirmwareManifestInNinFilter.
:rtype: str
'''
pass
@name.setter
def name(self):
'''
Sets the name of this FirmwareManifestInNinFilter.
:param name: The name of this FirmwareManifestInNinFilter.
:type: str
'''
pass
@property
def timestamp(self):
'''
Gets the timestamp of this FirmwareManifestInNinFilter.
:return: The timestamp of this FirmwareManifestInNinFilter.
:rtype: datetime
'''
pass
@timestamp.setter
def timestamp(self):
'''
Sets the timestamp of this FirmwareManifestInNinFilter.
:param timestamp: The timestamp of this FirmwareManifestInNinFilter.
:type: datetime
'''
pass
@property
def updated_at(self):
'''
Gets the updated_at of this FirmwareManifestInNinFilter.
:return: The updated_at of this FirmwareManifestInNinFilter.
:rtype: datetime
'''
pass
@updated_at.setter
def updated_at(self):
'''
Sets the updated_at of this FirmwareManifestInNinFilter.
:param updated_at: The updated_at of this FirmwareManifestInNinFilter.
:type: datetime
'''
pass
def to_dict(self):
'''
Returns the model properties as a dict
'''
pass
def to_str(self):
'''
Returns the string representation of the model
'''
pass
def __repr__(self):
'''
For `print` and `pprint`
'''
pass
def __eq__(self, other):
'''
Returns true if both objects are equal
'''
pass
def __ne__(self, other):
'''
Returns true if both objects are not equal
'''
pass
| 47 | 27 | 9 | 1 | 3 | 5 | 1 | 1.02 | 1 | 3 | 0 | 0 | 26 | 11 | 26 | 26 | 319 | 63 | 127 | 63 | 80 | 129 | 75 | 43 | 48 | 5 | 1 | 2 | 31 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.