api.customers.v1 package

Submodules

api.customers.v1.customer module

Autogenerated API

api.customers.v1.customer.add_customer(name: str = None, shortName: str = None, properties: dict = None, logoURL: str = None, accountManagerID: int = None, features: list = None, language: str = 'ENGLISH', timeZone: str = 'Europe/Oslo', type: str = 'CUSTOMER', parentID: int = 0, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Create a new customer (PUBLIC)

Return type:

dict

Parameters:
  • name (str) – Name to set for new customer. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • shortName (str) – shortName to set for new customer (must be unique). => [a-zA-Z0-9_-.]*
  • properties (dict) – Properties to set for customer. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • logoURL (str) – Customer logo data url. On format data:image/jpeg;base64,BASE64STRING. => Sanitize by regex data:.*
  • accountManagerID (int) – ID of account manager to assign to customer. If not set, no account manager is set.
  • features (list) – Features to enable on customer.
  • language (str) – Language to set for customer. (default ENGLISH)
  • timeZone (str) – Name of timezone to set for customer. (default Europe/Oslo)
  • type (str) – Object type. If set to GROUP, this customer can have subcustomers. (default CUSTOMER)
  • parentID (int) – ID of parent customer group to add this customer to. (default 0)
Raises:
Returns:

{“offset”: 816, “limit”: 980, “responseCode”: 200, “count”: 432, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “No ground new police call mean.”, “messageTemplate”: “Whatever crime deal outside about assume medical.”, “field”: “Adult and game measure edge put technology.”, “parameter”: {}, “timestamp”: 646362498}], “currentPage”: 838, “size”: 14}

api.customers.v1.customer.add_customer_service(customerID: int, service: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Add a service to a customer. (PUBLIC)

Return type:

dict

Parameters:
  • customerID (int) – Customer ID
  • service (str) – Name of service to enable on customer
Raises:
Returns:

{“offset”: 68, “limit”: 523, “responseCode”: 200, “count”: 945, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Right find herself fine set.”, “messageTemplate”: “Nearly everybody after sing.”, “field”: “Event side develop.”, “parameter”: {}, “timestamp”: 547241580}], “currentPage”: 130, “size”: 655}

api.customers.v1.customer.disable_customer(id: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Disable customer. (PUBLIC)

Return type:

dict

Parameters:

id (int) – Customer ID

Raises:
Returns:

{“offset”: 441, “limit”: 239, “responseCode”: 200, “count”: 597, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Image worry put Mrs quality.”, “messageTemplate”: “To out see.”, “field”: “Piece agreement difficult.”, “parameter”: {}, “timestamp”: 536529158}], “currentPage”: 168, “size”: 695}

api.customers.v1.customer.get_customer_by_id(id: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a Customer identified by its ID. (PUBLIC)

Return type:

dict

Parameters:

id (int) – Customer ID

Raises:
Returns:

{“offset”: 2, “limit”: 560, “responseCode”: 200, “count”: 489, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Avoid nothing the memory different.”, “messageTemplate”: “Present yourself hold.”, “field”: “Baby and main crime.”, “parameter”: {}, “timestamp”: 686513327}], “currentPage”: 771, “size”: 203}

api.customers.v1.customer.get_customer_by_shortname(shortName: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a Customer identified by its shortname. (PUBLIC)

Return type:

dict

Parameters:

shortName (str) – Customer shortname

Raises:
Returns:

{“offset”: 593, “limit”: 335, “responseCode”: 200, “count”: 16, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Important somebody material subject.”, “messageTemplate”: “Economy before them stand week language.”, “field”: “His better crime well.”, “parameter”: {}, “timestamp”: 849716569}], “currentPage”: 376, “size”: 171}

api.customers.v1.customer.get_customer_logo_by_id(id: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a Customer logo by customer shortname. (PUBLIC)

Return type:

dict

Parameters:

id (int) – Customer ID

Raises:
Returns:

{}

api.customers.v1.customer.get_customer_logo_by_shortname(shortName: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a Customer logo by customer shortname. (PUBLIC)

Return type:

dict

Parameters:

shortName (str) – Customer shortname

Raises:
Returns:

{}

api.customers.v1.customer.list_customers(parentID: list = None, service: list = None, keywords: list = None, keywordField: list = None, sortBy: list = None, offset: int = 0, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns customers defined by query parameters (PUBLIC)

Return type:

dict

Parameters:
  • parentID (list) – Search by parentID
  • service (list) – Search by services
  • keywords (list) – Search by keywords
  • keywordField (list) – Set field strategy for keyword search
  • sortBy (list) – Sort search result
  • offset (int) – Skip a number of results
  • limit (int) – Maximum number of returned results
  • keywordMatch (str) – Set match strategy for keyword search
Raises:
Returns:

{“offset”: 53, “limit”: 530, “responseCode”: 200, “count”: 982, “data”: [{“id”: 76, “flags”: [“DENY_SUBMIT_FOR_OTHER_USER”], “name”: “Emily Mcdaniel”, “shortName”: “Affect law technology sound son.”, “properties”: {“additionalProperties”: “Skill here factor build soldier door.”}, “services”: [{“id”: 301, “name”: “Laura Martin”, “description”: “Power again foreign before like enjoy become.”}], “createdByUser”: {“id”: 695, “customerID”: 722, “userName”: “michaelmitchell”, “name”: “Christopher Johns”}, “createdTimestamp”: 1278844909, “lastUpdatedByUser”: {“id”: 190, “customerID”: 573, “userName”: “josephvanessa”, “name”: “Barbara Chavez”}, “accountManager”: {“id”: 740, “customerID”: 249, “userName”: “marymedina”, “name”: “Rachel Powell”}, “lastUpdatedTimestamp”: 567049493, “language”: “ENGLISH”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Especially it sometimes score garden board.”, “messageTemplate”: “Clear leg rock though health.”, “field”: “Image officer see chance.”, “parameter”: {}, “timestamp”: 1103028302}], “currentPage”: 839, “size”: 508}

api.customers.v1.customer.remove_customer_service(customerID: int, service: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Remove a service from a customer. (PUBLIC)

Return type:

dict

Parameters:
  • customerID (int) – Customer ID
  • service (str) – Name of service to remove
Raises:
Returns:

{“offset”: 953, “limit”: 742, “responseCode”: 200, “count”: 371, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Keep western star speak leg.”, “messageTemplate”: “Look room beautiful thus.”, “field”: “Occur everybody quality structure effect.”, “parameter”: {}, “timestamp”: 14694556}], “currentPage”: 87, “size”: 923}

api.customers.v1.customer.search_customers(limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, parentID: list = None, keywords: list = None, keywordMatchStrategy: str = None, keywordFieldStrategy: list = None, service: list = None, domain: list = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns customers defined by CustomerSearchCriteria (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • parentID (list) – Search for customers by parent customer ID.
  • keywords (list) – Search for customers by keywords.
  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).
  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).
  • service (list) – Search for customers having any of these services (service shortname).
  • domain (list) – Search for customers in one of these domains (by domain id or name).
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • includeFlags (list) – Only include objects which have includeFlags set.
  • excludeFlags (list) – Exclude objects which have excludeFlags set.
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
Raises:
Returns:

{“offset”: 744, “limit”: 94, “responseCode”: 200, “count”: 192, “data”: [{“id”: 272, “flags”: [“DENY_SUBMIT_FOR_OTHER_USER”], “name”: “Thomas Perez”, “shortName”: “Particularly I wife really financial.”, “properties”: {“additionalProperties”: “Answer top at throughout book.”}, “services”: [{“id”: 155, “name”: “Alvin Moon”, “description”: “Effect piece admit many participant actually.”}], “createdByUser”: {“id”: 487, “customerID”: 788, “userName”: “james23”, “name”: “Ashley Mendoza”}, “createdTimestamp”: 1302122335, “lastUpdatedByUser”: {“id”: 293, “customerID”: 160, “userName”: “moraleslisa”, “name”: “Loretta Jennings”}, “accountManager”: {“id”: 534, “customerID”: 330, “userName”: “jamesweaver”, “name”: “Lauren King”}, “lastUpdatedTimestamp”: 116366020, “language”: “NORWEGIAN”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Business enter network guess.”, “messageTemplate”: “Fly camera news some live.”, “field”: “Hour senior recent day community reduce.”, “parameter”: {}, “timestamp”: 639938189}], “currentPage”: 68, “size”: 231}

api.customers.v1.customer.update_customer(id: int, name: str = None, shortName: str = None, language: str = None, addProperties: dict = None, deleteProperties: list = None, logoURL: str = None, timeZone: str = None, accountManagerID: int = None, addFeatures: list = None, deleteFeatures: list = None, type: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Update a customer object. (PUBLIC)

Return type:

dict

Parameters:
  • id (int) – Customer ID
  • name (str) – If set, change customer name to this value. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • shortName (str) – If set, change customer shortname to this value (must be unique). => [a-zA-Z0-9_-.]*
  • language (str) – If set, change customer language.
  • addProperties (dict) – If set, add these properties. If the keys exist, they will be overwritten. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • deleteProperties (list) – If set, remove properties with these keys. Missing keys are ignored.
  • logoURL (str) – If set, change customer logo. On format data:image/jpeg;base64,BASE64STRING. => Sanitize by regex data:.*
  • timeZone (str) – If set, change customer timezone to timezone with this name.
  • accountManagerID (int) – If set, change customer account manmager to specified user.
  • addFeatures (list) – If set, add these features to customer.
  • deleteFeatures (list) – If set, remove these features from customer.
  • type (str) – Customer type. If set to GROUP, this customer can have subcustomers.
Raises:
Returns:

{“offset”: 750, “limit”: 414, “responseCode”: 200, “count”: 394, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Say like really loss difference including.”, “messageTemplate”: “Laugh address west hard town.”, “field”: “Behind usually property off arm card expert.”, “parameter”: {}, “timestamp”: 375010370}], “currentPage”: 376, “size”: 55}

Module contents