contact#

Autogenerated API

argus_api.lib.customers.v1.contact.add_contact(customer: str = None, language: str = None, user: str = None, name: str = None, email: str = None, workPhone: str = None, mobilePhone: str = None, description: str = None, services: str = None, mailSettings: dict = None, smsSettings: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Create a new customer contact. (INTERNAL)

Parameters

  • customer (str) – Customer this contact is bound to

  • language (str) – Language this contact should receive notifications in. Disregarded if subject is specified. Defaults to english.

  • user (str) – User ID or shortname for user to bind this contact to. If not specified, name and contact settings must be specified.

  • name (str) – The displayName of this contact. If user is set, this is disregarded.

  • email (str) – The email address of this contact. If user is set, this is disregarded. => format:email

  • workPhone (str) – The work phone number of this contact. If user is set, this is disregarded. => format:phone

  • mobilePhone (str) – The mobile phone number of this contact. If user is set, this is disregarded. => format:phone

  • description (str) – A description of this contact. If user is set, this is disregarded.

  • services (list) – A list of service shortnames or IDs for services that this contact should be notified on.

  • mailSettings (dict) –

  • smsSettings (dict) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customers.v1.contact.add_contact_service(contactID: int, service: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Enable a service for a customer contact. (INTERNAL)

Parameters

  • contactID (int) – ID of contact

  • service (str) – The service to enable for this contact

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customers.v1.contact.delete_contact(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Delete an existing customer contact. (INTERNAL)

Parameters

  • id (int) – Contact ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customers.v1.contact.get_contact(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a customer contact identified by its ID. (INTERNAL)

Parameters

  • id (int) – Contact ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customers.v1.contact.list_contacts(customer: str = None, service: str = None, user: str = None, keywords: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns all customer contacts matching criteria. (INTERNAL)

Parameters

  • customer (list) – Filter by customer ID or shortname

  • service (list) – Filter by service ID or shortname

  • user (list) – Filter by user ID or shortname

  • keywords (list) – Limit search to contacts matching these keywords (for either name, email or description). Note: will not search on associated user.

  • limit (int) – Limit number of results

  • offset (int) – Skip results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customers.v1.contact.remove_contact_service(contactID: int, service: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Disable a service for a customer contact. (INTERNAL)

Parameters

  • contactID (int) – ID of contact

  • service (str) – Name of service to disable

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customers.v1.contact.search_contacts(customer: str = None, service: str = None, user: str = None, keywords: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns all customer contacts matching criteria. (INTERNAL)

Parameters

  • customer (list) – ID or shortname of customers of contacts to search for. Customer groups will return contacts for all subcustomers.

  • service (list) – ID or shortname of services of contacts to search for. Will return contacts which are bound to any of these services.

  • user (list) – ID or shortname of users of contacts to search for. Will return contacts which is bound to any of these users.

  • keywords (list) – Limit search to contacts matching these keywords (for either name, email or description). Note: will not search on associated user.

  • limit (int) – Limit search results (default 25)

  • offset (int) – Skip search results (default 0)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customers.v1.contact.update_contact(id: int, language: str = None, name: str = None, email: str = None, workPhone: str = None, mobilePhone: str = None, description: str = None, services: str = None, mailSettings: dict = None, smsSettings: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update an existing customer contact. (INTERNAL)

Parameters

  • id (int) – Contact ID

  • language (str) – If set, change the language this contact should receive notifications in. If the contact is bound to a user, this field is invalid.

  • name (str) – If set, change the displayName of this contact. If the contact is bound to a user, this field is invalid.

  • email (str) – If set, change the email address of this contact. If the contact is bound to a user, this field is invalid. => format:email

  • workPhone (str) – If set, change the work phone number of this contact. If the contact is bound to a user, this field is invalid. => format:phone

  • mobilePhone (str) – If set, change the mobile phone number of this contact. If the contact is bound to a user, this field is invalid. => format:phone

  • description (str) – If set, change the description of this contact. If the contact is bound to a user, this field is invalid.

  • services (list) – If set, overwrite the list of service shortnames or IDs which this contact is enabled for.

  • mailSettings (dict) –

  • smsSettings (dict) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON