API

XMSession

class XMSession(xm_url, **kwargs)

Starting class used to interact with xMatters API.

Parameters

  • xm_url (str) – Name of xMatters instance, xMatters instance url, or xMatters instance API base url

  • timeout (int) – timeout (in seconds) for requests. Defaults to 5.

  • max_retries (int) – maximum number of request retries to attempt. Defaults to 3.

set_authentication(username=None, password=None, client_id=None, **kwargs)
Set the authentication method when interacting with the API.
OAuth2 authentication is used if a client_id is provided; otherwise basic authentication is used.
Parameters

  • username (str) – xMatters username

  • password (str) – xMatters password

  • client_id (str) – xMatters instance client id

  • token (dict) – token object

  • refresh_token (str) – refresh token

  • token_storage (class) – Class instance used to store token. Any class instance should work as long is it has read_token() and write_token() methods.

Returns

self

Return type

XMSession

attachments_endpoint()

Get the ‘/attachments’ top-level endpoint.

Returns

Endpoint

Return type

AttachmentsEndpoint

audits_endpoint()

Get the ‘/audits’ top-level endpoint.

Returns

Endpoint

Return type

AuditsEndpoint

conference_bridges_endpoint()

Get the ‘/conference-bridges’ top-level endpoint.

Returns

Endpoint

Return type

ConferenceBridgesEndpoint

device_names_endpoint()

Get the ‘/device-names’ top-level endpoint.

Returns

Endpoint

Return type

DeviceNamesEndpoint

device_types_endpoint()

Get the ‘/device-types’ top-level endpoint.

Returns

Endpoint

Return type

DeviceTypesEndpoint

devices_endpoint()

Get the ‘/device’ top-level endpoint.

Returns

Endpoint

Return type

DevicesEndpoint

dynamic_teams_endpoint()

Get the ‘/dynamic-teams’ top-level endpoint.

Returns

Endpoint

Return type

DynamicTeamsEndpoint

events_endpoint()

Get the ‘/events’ top-level endpoint.

Returns

Endpoint

Return type

EventsEndpoint

event_suppressions_endpoint()

Get the ‘/event-suppressions’ top-level endpoint.

Returns

Endpoint

Return type

EventSuppressionsEndpoint

forms_endpoint()

Get the ‘/forms’ top-level endpoint.

Returns

Endpoint

Return type

FormsEndpoint

imports_endpoint()

Get the ‘/imports’ top-level endpoint.

Returns

Endpoint

Return type

ImportsEndpoint

groups_endpoint()

Get the ‘/groups’ top-level endpoint.

Returns

Endpoint

Return type

GroupsEndpoint

incidents_endpoint()

Get the ‘/incidents’ top-level endpoint.

Returns

Endpoint

Return type

IncidentsEndpoint

oncall_endpoint()

Get the ‘/on-call’ top-level endpoint.

Returns

Endpoint

Return type

OnCallEndpoint

oncall_summary_endpoint()

Get the ‘/on-call-summary’ top-level endpoint.

Returns

Endpoint

Return type

OnCallSummaryEndpoint

people_endpoint()

Get the ‘/people’ top-level endpoint.

Returns

Endpoint

Return type

PeopleEndpoint

plans_endpoint()

Get the ‘/plans’ top-level endpoint.

Returns

Endpoint

Return type

PlansEndpoint

roles_endpoint()

Get the ‘/roles’ top-level endpoint.

Returns

Endpoint

Return type

RolesEndpoint

scenarios_endpoint()

Get the ‘/scenarios’ top-level endpoint.

Returns

Endpoint

Return type

ScenariosEndpoint

services_endpoint()

Get the ‘/services’ top-level endpoint.

Returns

Endpoint

Return type

ServicesEndpoint

sites_endpoint()

Get the ‘/sites’ top-level endpoint.

Returns

Endpoint

Return type

SitesEndpoint

subscriptions_endpoint()

Get the ‘/subscriptions’ top-level endpoint.

Returns

Endpoint

Return type

SubscriptionsEndpoint

subscription_forms_endpoint()

Get the ‘/subscription-forms’ top-level endpoint.

Returns

Endpoint

Return type

SubscriptionFormsEndpoint

temporary_absences_endpoint()

Get the ‘/temporary-absences’ top-level endpoint.

Returns

Endpoint

Return type

TemporaryAbsencesEndpoint

Top-Level Endpoints

Attachments

class AttachmentsEndpoint(parent)

Used to interact with ‘/attachments’ top-level endpoint

upload_attachment(data)
Return type

Attachments

Audits

class AuditsEndpoint(parent)

Used to interact with ‘/audits’ top-level endpoint

get_audits(params=None, **kwargs)
Return type

Pagination of AuditFactory

Conference Bridges

class ConferenceBridgesEndpoint(parent)
create_conference_bridge(data)
Return type

ConferenceBridge

delete_conference_bridge(bridge_id)
Return type

ConferenceBridge

get_conference_bridge_by_id(bridge_id, params=None, **kwargs)
Return type

ConferenceBridge

get_conference_bridges(params=None, **kwargs)
Return type

Pagination of ConferenceBridge

update_conference_bridge(data)
Return type

ConferenceBridge

Devices

class DevicesEndpoint(parent)

Used to interact with ‘/devices’ top-level endpoint

create_device(data)
Return type

DeviceFactory

delete_device(device_id)
Return type

DeviceFactory

get_device_by_id(device_id, params=None, **kwargs)
Return type

DeviceFactory

get_devices(params=None, **kwargs)
Return type

Pagination of DeviceFactory

update_device(data)
Return type

DeviceFactory

Device Names

class DeviceNamesEndpoint(parent)

Used to interact with ‘/device-names’ top-level endpoint

create_device_name(data)
Return type

DeviceNameFactory

delete_device_name(device_name_id)
Return type

DeviceNameFactory

get_device_names(params=None, **kwargs)
Return type

Pagination of DeviceNameFactory

update_device_name(data)
Return type

DeviceNameFactory

Device Types

class DeviceTypesEndpoint(parent)
get_device_types(params=None, **kwargs)
Return type

DeviceNameFactory

Dynamic Teams

class DynamicTeamsEndpoint(parent)
create_dynamic_team(data)
Return type

DynamicTeam

delete_dynamic_team(dynamic_team_id)
Return type

DynamicTeam

get_dynamic_team_by_id(dynamic_team_id, params=None, **kwargs)
Return type

DynamicTeam

get_dynamic_teams(params=None, **kwargs)
Return type

Pagination of DynamicTeam

update_dynamic_team(data)
Return type

DynamicTeam

Events

class EventsEndpoint(parent)
change_event_status(data)
Return type

Event

get_event_by_id(event_id, params=None, **kwargs)
Return type

Event

get_events(params=None, **kwargs)
Return type

Pagination of Event

Event Suppressions

class EventSuppressionsEndpoint(parent)
get_suppressions_by_event_id(event_id, params=None, **kwargs)
Return type

Pagination of EventSuppression

Groups

class GroupsEndpoint(parent)
create_group(data)
Return type

Group

delete_group(group_id)
Return type

Group

get_group_by_id(group_id, params=None, **kwargs)
Return type

Group

get_groups(params=None, **kwargs)
Return type

Pagination of Group

get_license_quotas()
Return type

GroupQuota

update_group(data)
Return type

Group

Import Jobs

class ImportsEndpoint(parent)
get_import_job_by_id(import_id, params=None, **kwargs)
Return type

Import

get_import_jobs(params=None, **kwargs)
Return type

Pagination of Import

On-Call

class OnCallEndpoint(parent)
get_oncall(params=None, **kwargs)
Return type

Pagination of OnCall

On-Call Summary

class OnCallSummaryEndpoint(parent)
get_oncall_summary(params=None, **kwargs)
Return type

Pagination of OnCallSummary

People

class PeopleEndpoint(parent)
create_person(data)
Return type

Person

delete_person(person_id)
Return type

Person

get_license_quotas()
Return type

UserQuota

get_people(params=None, **kwargs)
Return type

Pagination of Person

get_person_by_id(person_id, params=None, **kwargs)
Return type

Person

update_person(data)
Return type

Person

Plans

class PlansEndpoint(parent)
create_plan(data)
Return type

Plan

delete_plan(plan_id)
Return type

Plan

get_plan_by_id(plan_id, params=None, **kwargs)
Return type

Plan

get_plans(params=None, **kwargs)
Return type

Pagination of Plan

update_plan(data)
Return type

Plan

Roles

class RolesEndpoint(parent)
get_roles(params=None, **kwargs)
Return type

Pagination of Role

Scenarios

class ScenariosEndpoint(parent)
get_scenario_by_id(scenario_id, params=None, **kwargs)
Return type

Scenario

get_scenarios(params=None, **kwargs)
Return type

Pagination of Scenario

Services

class ServicesEndpoint(parent)
create_service(data)
Return type

Service

delete_service(service_id)
Return type

Service

get_service_by_id(service_id, params=None, **kwargs)
Return type

Service

get_services(params=None, **kwargs)
Return type

Pagination of Service

update_service(data)
Return type

Service

Sites

class SitesEndpoint(parent)
create_site(data)
Return type

Site

delete_site(site_id)
Return type

Site

get_site_by_id(site_id, params=None, **kwargs)
Return type

Site

get_sites(params=None, **kwargs)
Return type

Pagination of Site

update_site(data)
Return type

Site

Subscriptions

class SubscriptionsEndpoint(parent)
create_subscription(data)
Return type

Subscription

delete_subscription(subscription_id)
Return type

Subscription

get_subscribers(params=None, **kwargs)
Return type

Pagination of Person

get_subscription_by_id(subscription_id, params=None, **kwargs)
Return type

Subscription

get_subscriptions(params=None, **kwargs)
Return type

Pagination of Subscription

unsubscribe_person(person_id)
Return type

Subscription

update_subscription(data)
Return type

Subscription

Subscription Forms

class SubscriptionFormsEndpoint(parent)
get_subscription_form_by_id(sub_form_id, params=None, **kwargs)
Return type

SubscriptionForm

get_subscription_forms(params=None, **kwargs)
Return type

Pagination of SubscriptionForm

Temporary Absences

class TemporaryAbsencesEndpoint(parent)
create_temporary_absence(data)
Return type

TemporaryAbsence

delete_temporary_absence(temporary_absence_id)
Return type

TemporaryAbsence

get_temporary_absences(params=None, **kwargs)
Return type

Pagination of TemporaryAbsence

Objects

See xMatters REST API Reference for more detailed information.

Attachments

class Attachments(parent, data)

Bases: xmatters.connection.ApiBase

name
Vartype

str

path
Vartype

str

size
Vartype

str

class AttachmentsReference(parent, data)

Bases: xmatters.connection.ApiBase

path
Vartype

str

Audits

class Annotation(parent, data)

Bases: xmatters.connection.ApiBase

author
Vartype

PersonReference

comment
Vartype

str

event
Vartype

EventReference

class Audit(parent, data)

Bases: xmatters.objects.audits.AuditBase

at
Vartype

TimeAttribute

event
Vartype

EventReference

id
Vartype

str

order_id
Vartype

int

type
Vartype

str

class AuditAnnotation(parent, data)

Bases: xmatters.objects.audits.AuditBase

annotation
Vartype

Annotation

at
Vartype

TimeAttribute

id
Vartype

str

order_id
Vartype

int

type
Vartype

str

class AuditBase(parent, data)

Bases: xmatters.connection.ApiBase

at
Vartype

TimeAttribute

id
Vartype

str

order_id
Vartype

int

type
Vartype

str

class AuditNotification(parent, data)

Bases: xmatters.objects.audits.AuditBase

at
Vartype

TimeAttribute

id
Vartype

str

notification
Vartype

Notification

order_id
Vartype

int

type
Vartype

str

class AuditResponse(parent, data)

Bases: xmatters.objects.audits.AuditBase

at
Vartype

TimeAttribute

id
Vartype

str

order_id
Vartype

int

response
Vartype

Response

type
Vartype

str

class Notification(parent, data)

Bases: xmatters.connection.ApiBase

category
created
Vartype

TimeAttribute

delivery_status
event
Vartype

EventReference

id
recipient
Vartype

Recipient

class Response(parent, data)

Bases: xmatters.connection.ApiBase

comment
notification
Vartype

Notification

options
Vartype

[ResponseOption]

received
Vartype

TimeAttribute

response
source

Common

Bases: xmatters.connection.ApiBase

next
Vartype

str

previous
Vartype

str

self
Vartype

str

class PropertyDefinition(parent, data)

Bases: xmatters.connection.ApiBase

default
Vartype

str

description
Vartype

str

help_text
Vartype

str

id
Vartype

str

max_length
Vartype

int

min_length
Vartype

int

name
Vartype

str

pattern
Vartype

str

validate
Vartype

bool

class QuotaItem(parent, data)

Bases: xmatters.connection.ApiBase

active
Vartype

int

total
Vartype

int

unused
Vartype

int

class Recipient(parent, data)

Bases: xmatters.connection.ApiBase

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

recipient_type
Vartype

str

status
Vartype

str

target_name
Vartype

str

class RecipientPointer(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

recipient_type
Vartype

str

class RecipientReference(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

Vartype

SelfLink

recipient_type
Vartype

str

target_name
Vartype

str

class ReferenceById(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

Bases: xmatters.connection.ApiBase

id
Vartype

str

Vartype

SelfLink

class RequestReference(parent, data)

Bases: xmatters.connection.ApiBase

request_id

str

Bases: xmatters.connection.ApiBase

self
Vartype

str

Conference Bridges

class ConferenceBridge(parent, data)

Bases: xmatters.connection.ApiBase

bridge_number
Vartype

int

description
Vartype

str

dial_after_bridge
Vartype

str

id
Vartype

str

Vartype

SelfLink

name
Vartype

str

pause_before_bridge_prompt
Vartype

int

preferred_connection_type
Vartype

str

static_bridge_number
Vartype

bool

toll_free_number
Vartype

str

toll_number
Vartype

str

Device Names

class DeviceName(parent, data)

Bases: xmatters.connection.ApiBase

description
Vartype

str

device_type
Vartype

str

id
Vartype

str

name
Vartype

str

privileged
Vartype

bool

class DeviceNameEmail(parent, data)

Bases: xmatters.objects.device_names.DeviceName

description
Vartype

str

device_type
Vartype

str

domains
Vartype

list

id
Vartype

str

name
Vartype

str

privileged
Vartype

bool

class TargetDeviceNameSelector(parent, data)

Bases: xmatters.connection.ApiBase

name
Vartype

str

selected
Vartype

bool

visible
Vartype

bool

Device Types

class DeviceTypes(parent, data)

Bases: xmatters.connection.ApiBase

count
Vartype

int

data
Vartype

list

total
Vartype

int

Devices

class AndroidPushDevice(parent, data)

Bases: xmatters.objects.devices.Device

get_timeframes()

Get device timeframes

Returns

list

Return type

list[DeviceTimeframe]

account_id
Vartype

str

default_device
Vartype

bool

delay
Vartype

int

description
Vartype

str

device_type
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

name
Vartype

str

owner
Vartype

PersonReference

priority_threshold
Vartype

str

provider
Vartype

ReferenceById

recipient_type
Vartype

str

registration_id
Vartype

str

sequence
Vartype

int

status
Vartype

str

target_name
Vartype

str

test_status
Vartype

str

property timeframes

Alias of get_timeframes()

class ApplePushDevice(parent, data)

Bases: xmatters.objects.devices.Device

get_timeframes()

Get device timeframes

Returns

list

Return type

list[DeviceTimeframe]

account_id
Vartype

str

alert_sound
Vartype

str

apn_token
Vartype

str

default_device
Vartype

bool

delay
Vartype

int

description
Vartype

str

device_type
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

name
Vartype

str

owner
Vartype

PersonReference

priority_threshold
Vartype

str

provider
Vartype

ReferenceById

recipient_type
Vartype

str

sequence
Vartype

int

sound_status
Vartype

str

sounds_threshold
Vartype

str

status
Vartype

str

target_name
Vartype

str

test_status
Vartype

str

property timeframes

Alias of get_timeframes()

class Device(parent, data)

Bases: xmatters.objects.common.Recipient

get_timeframes()

Get device timeframes

Returns

list

Return type

list[DeviceTimeframe]

default_device
Vartype

bool

delay
Vartype

int

description
Vartype

str

device_type
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

name
Vartype

str

owner
Vartype

PersonReference

priority_threshold
Vartype

str

provider
Vartype

ReferenceById

recipient_type
Vartype

str

sequence
Vartype

int

status
Vartype

str

target_name
Vartype

str

test_status
Vartype

str

property timeframes

Alias of get_timeframes()

class DeviceTimeframe(parent, data)

Bases: xmatters.connection.ApiBase

days
Vartype

str

duration_in_minutes
Vartype

int

exclude_holidays
Vartype

bool

name
Vartype

str

start_time
Vartype

str

timezone
Vartype

str

class EmailDevice(parent, data)

Bases: xmatters.objects.devices.Device

get_timeframes()

Get device timeframes

Returns

list

Return type

list[DeviceTimeframe]

default_device
Vartype

bool

delay
Vartype

int

description
Vartype

str

device_type
Vartype

str

email_address
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

name
Vartype

str

owner
Vartype

PersonReference

priority_threshold
Vartype

str

provider
Vartype

ReferenceById

recipient_type
Vartype

str

sequence
Vartype

int

status
Vartype

str

target_name
Vartype

str

test_status
Vartype

str

property timeframes

Alias of get_timeframes()

class FaxDevice(parent, data)

Bases: xmatters.objects.devices.Device

get_timeframes()

Get device timeframes

Returns

list

Return type

list[DeviceTimeframe]

country
Vartype

str

default_device
Vartype

bool

delay
Vartype

int

description
Vartype

str

device_type
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

name
Vartype

str

owner
Vartype

PersonReference

phone_number
Vartype

str

priority_threshold
Vartype

str

provider
Vartype

ReferenceById

recipient_type
Vartype

str

sequence
Vartype

int

status
Vartype

str

target_name
Vartype

str

test_status
Vartype

str

property timeframes

Alias of get_timeframes()

class GenericDevice(parent, data)

Bases: xmatters.objects.devices.Device

get_timeframes()

Get device timeframes

Returns

list

Return type

list[DeviceTimeframe]

default_device
Vartype

bool

delay
Vartype

int

description
Vartype

str

device_type
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

name
Vartype

str

owner
Vartype

PersonReference

phone_number
Vartype

str

priority_threshold
Vartype

str

provider
Vartype

ReferenceById

recipient_type
Vartype

str

sequence
Vartype

int

status
Vartype

str

target_name
Vartype

str

test_status
Vartype

str

property timeframes

Alias of get_timeframes()

class Provider(parent, data)

Bases: xmatters.connection.ApiBase

id

str

class PublicAddressDevice(parent, data)

Bases: xmatters.objects.devices.Device

get_timeframes()

Get device timeframes

Returns

list

Return type

list[DeviceTimeframe]

default_device
Vartype

bool

delay
Vartype

int

description
Vartype

str

device_type
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

name
Vartype

str

owner
Vartype

PersonReference

phone_number
Vartype

str

priority_threshold
Vartype

str

provider
Vartype

ReferenceById

recipient_type
Vartype

str

sequence
Vartype

int

status
Vartype

str

target_name
Vartype

str

test_status
Vartype

str

property timeframes

Alias of get_timeframes()

class SMSDevice(parent, data)

Bases: xmatters.objects.devices.Device

get_timeframes()

Get device timeframes

Returns

list

Return type

list[DeviceTimeframe]

default_device
Vartype

bool

delay
Vartype

int

description
Vartype

str

device_type
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

name
Vartype

str

owner
Vartype

PersonReference

phone_number
Vartype

str

priority_threshold
Vartype

str

provider
Vartype

ReferenceById

recipient_type
Vartype

str

sequence
Vartype

int

status
Vartype

str

target_name
Vartype

str

test_status
Vartype

str

property timeframes

Alias of get_timeframes()

class TextPagerDevice(parent, data)

Bases: xmatters.objects.devices.Device

get_timeframes()

Get device timeframes

Returns

list

Return type

list[DeviceTimeframe]

default_device
Vartype

bool

delay
Vartype

int

description
Vartype

str

device_type
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

name
Vartype

str

owner
Vartype

PersonReference

pin
Vartype

str

priority_threshold
Vartype

str

provider
Vartype

ReferenceById

recipient_type
Vartype

str

sequence
Vartype

int

status
Vartype

str

target_name
Vartype

str

test_status
Vartype

str

property timeframes

Alias of get_timeframes()

two_way_device
Vartype

bool

class VoiceDevice(parent, data)

Bases: xmatters.objects.devices.Device

get_timeframes()

Get device timeframes

Returns

list

Return type

list[DeviceTimeframe]

default_device
Vartype

bool

delay
Vartype

int

description
Vartype

str

device_type
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

name
Vartype

str

owner
Vartype

PersonReference

phone_number
Vartype

str

priority_threshold
Vartype

str

provider
Vartype

ReferenceById

recipient_type
Vartype

str

sequence
Vartype

int

status
Vartype

str

target_name
Vartype

str

test_status
Vartype

str

property timeframes

Alias of get_timeframes()

Dynamic Teams

class DynamicTeam(parent, data)

Bases: xmatters.objects.common.Recipient

get_members()
get_observers()
get_supervisors()
criteria
Vartype

DynamicTeamsCriterion

description
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

property observers

Alias of get_observers()

recipient_type
Vartype

str

response_count
Vartype

int

response_count_threshold
Vartype

str

status
Vartype

str

property supervisors
target_name
Vartype

str

use_emergency_device
Vartype

bool

class DynamicTeamsCriterion(parent, data)

Bases: xmatters.connection.ApiBase

category
Vartype

str

criterion_type
Vartype

str

field
Vartype

str

operand
Vartype

str

value
Vartype

str

class DynamicTeamsReference(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

recipient_type
Vartype

str

target_name
Vartype

str

Event Suppressions

class EventFloodFilter(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

name
Vartype

str

class EventSuppression(parent, data)

Bases: xmatters.connection.ApiBase

at
Vartype

TimeAttribute

event
Vartype

EventReference

filter
Vartype

[EventFloodFilter]

Vartype

SelfLink

match
Vartype

SuppressionMatch

class SuppressionMatch(parent, data)

Bases: xmatters.connection.ApiBase

event_id
Vartype

str

id
Vartype

str

Vartype

SelfLink

Events

class Annotation(parent, data)

Bases: xmatters.connection.ApiBase

author
Vartype

PersonReference

comment
Vartype

str

created
Vartype

TimeAttribute

event
Vartype

EventReference

id
Vartype

str

class Conference(parent, data)

Bases: xmatters.connection.ApiBase

bridge_id
Vartype

str

bridge_number
Vartype

str

id
Vartype

str

type
Vartype

str

class ConferencePointer(parent, data)

Bases: xmatters.connection.ApiBase

bridge_id
Vartype

str

bridge_number
Vartype

str

type
Vartype

str

class Event(parent, data)

Bases: xmatters.connection.ApiBase

add_annotation(data)
get_annotation_by_id(annotation_id)
get_annotations(params=None, **kwargs)
get_audits(params=None, **kwargs)
get_messages()
get_properties()
get_recipients()
get_response_options()
get_suppressions(params=None, **kwargs)
get_targeted_recipients()
get_user_delivery_data(params=None, **kwargs)
update_status(status)
property annotations

Alias of get_annotations()

bypass_phone_intro
Vartype

bool

conference
Vartype

Conference

created
Vartype

TimeAttribute

escalation_override
Vartype

bool

event_id
Vartype

str

event_type
Vartype

str

expiration_in_minutes
Vartype

int

flood_control
Vartype

bool

form
Vartype

FormReference

id
Vartype

str

incident
Vartype

str

Vartype

SelfLink

property messages

Alias of get_messages()

other_response_count
Vartype

int

other_response_count_threshold
Vartype

str

override_device_restrictions
Vartype

bool

plan
Vartype

PlanReference

priority
Vartype

str

property properties

Alias of get_properties()

property recipients

Alias of get_recipients()

require_phone_password
Vartype

bool

response_count_enabled
Vartype

bool

property response_options

Alias of get_response_options()

status
Vartype

str

submitter
Vartype

PersonReference

property suppressions

Alias of get_suppressions()

property targeted_recipients

Alias of get_targeted_recipients()

terminated
Vartype

TimeAttribute

voicemail_options
Vartype

VoicemailOptions

class EventReference(parent, data)

Bases: xmatters.connection.ApiBase

event_id
Vartype

str

id
Vartype

str

Vartype

SelfLink

class Message(parent, data)

Bases: xmatters.connection.ApiBase

body
Vartype

str

id
Vartype

str

message_type
Vartype

str

subject
Vartype

str

class Notification(parent, data)

Bases: xmatters.connection.ApiBase

created
Vartype

TimeAttribute

delivered
Vartype

TimeAttribute

delivery_status
Vartype

str

id
Vartype

str

recipient
Vartype

Recipient

responded
Vartype

TimeAttribute

responses
Vartype

[UserDeliveryResponse]

class ResponseOption(parent, data)

Bases: xmatters.connection.ApiBase

action
Vartype

str

allow_comments
Vartype

bool

contribution
Vartype

str

description
Vartype

str

id
Vartype

str

join_conference
Vartype

bool

number
Vartype

int

prompt
Vartype

str

redirect_rul
Vartype

str

text
Vartype

str

translations
Vartype

[Translation]

class Translation(parent, data)

Bases: xmatters.connection.ApiBase

description
Vartype

str

id
Vartype

str

language
Vartype

str

prompt
Vartype

str

text
Vartype

str

class UserDeliveryData(parent, data)

Bases: xmatters.connection.ApiBase

delivery_status
Vartype

str

event
Vartype

EventReference

Vartype

SelfLink

notifications
Vartype

[Notification]

person
Vartype

PersonReference

response
Vartype

UserDeliveryResponse

class UserDeliveryResponse(parent, data)

Bases: xmatters.connection.ApiBase

notification
Vartype

str

received
Vartype

TimeAttribute

text
Vartype

str

class VoicemailOptions(parent, data)

Bases: xmatters.connection.ApiBase

every
Vartype

int

leave
Vartype

str

retry
Vartype

int

Forms

class ConferenceBridgeSection(parent, data)

Bases: xmatters.objects.forms.FormSection

bridge_type
Vartype

str

collapsed
Vartype

bool

form
Vartype

FormReference

id
Vartype

str

order_num
Vartype

int

title
Vartype

str

type
Vartype

str

visible
Vartype

bool

class CustomSection(parent, data)

Bases: xmatters.connection.ApiBase

form_section
Vartype

FormReference

id
Vartype

str

include_in_callback
Vartype

bool

multiline_text
Vartype

bool

order_num
Vartype

int

property_definition
Vartype

PropertyDefinition

required
Vartype

bool

visible
Vartype

bool

class CustomSectionItems(parent, data)

Bases: xmatters.objects.forms.FormSection

collapsed
Vartype

bool

form
Vartype

FormReference

id
Vartype

str

items
Vartype

[CustomSection]

order_num
Vartype

int

title
Vartype

str

type
Vartype

str

visible
Vartype

bool

class DevicesSection(parent, data)

Bases: xmatters.objects.forms.FormSection

collapsed
Vartype

bool

form
Vartype

FormReference

id
Vartype

str

order_num
Vartype

int

target_device_names
Vartype

Pagination of TargetDeviceNameSelector

title
Vartype

str

type
Vartype

str

visible
Vartype

bool

class Form(parent, data)

Bases: xmatters.connection.ApiBase

create_scenario(data)
get_recipients(params=None, **kwargs)
get_response_options(params=None, **kwargs)
get_scenarios(params=None, **kwargs)
get_sections(params=None, **kwargs)
update_scenario(data)
api_enabled
Vartype

bool

description
Vartype

str

form_id
Vartype

str

id
Vartype

str

Vartype

SelfLink

mobile_enabled
Vartype

str

name
Vartype

str

plan
Vartype

PlanReference

property recipients

Alias of get_recipients()

property response_options

Alias of get_response_options()

sender_overrides
Vartype

SenderOverrides

ui_enabled
Vartype

bool

class FormReference(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

name
Vartype

str

class FormSection(parent, data)

Bases: xmatters.connection.ApiBase

collapsed
Vartype

bool

form
Vartype

FormReference

id
Vartype

str

order_num
Vartype

int

title
Vartype

str

type
Vartype

str

visible
Vartype

bool

class HandlingSection(parent, data)

Bases: xmatters.objects.forms.FormSection

bypass_phone_intro
Vartype

SectionValue

collapsed
Vartype

bool

escalation_override
Vartype

SectionValue

expiration_in_minutes
Vartype

SectionValue

form
Vartype

FormReference

id
Vartype

str

order_num
Vartype

int

other_response_count_threshold
Vartype

SectionValue

override_device_restrictions
Vartype

SectionValue

priority
Vartype

SectionValue

require_phone_password
Vartype

SectionValue

title
Vartype

str

type
Vartype

str

visible
Vartype

bool

voicemail_options
Vartype

VoicemailOptions

class IncidentSection(parent, data)

Bases: xmatters.objects.forms.FormSection

collapsed
Vartype

bool

description
Vartype

IncidentSectionItem

form
Vartype

FormReference

id
Vartype

str

order_num
Vartype

int

severity
Vartype

IncidentSectionItem

summary
Vartype

IncidentSectionItem

title
Vartype

str

type
Vartype

str

visible
Vartype

bool

class IncidentSectionItem(parent, data)

Bases: xmatters.connection.ApiBase

order_num
Vartype

int

required
Vartype

bool

value
Vartype

str

visible
Vartype

bool

class RecipientsSection(parent, data)

Bases: xmatters.objects.forms.FormSection

collapsed
Vartype

bool

form
Vartype

FormReference

id
Vartype

str

order_num
Vartype

int

recipients
Vartype

Pagination of Recipient

title
Vartype

str

type
Vartype

str

visible
Vartype

bool

class SectionValue(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

value
Vartype

str

visible
Vartype

bool

class SenderOverrides(parent, data)

Bases: xmatters.connection.ApiBase

caller_id
Vartype

SectionValue

display_name
Vartype

SectionValue

class SenderOverridesSection(parent, data)

Bases: xmatters.objects.forms.FormSection

collapsed
Vartype

bool

form
Vartype

FormReference

id
Vartype

str

order_num
Vartype

int

sender_overrides
Vartype

SenderOverrides

title
Vartype

str

type
Vartype

str

visible
Vartype

bool

Groups

class Group(parent, data)

Bases: xmatters.objects.common.Recipient

add_member(data)
create_shift(data)
delete_shift(shift_id)
get_members()
get_observers()
get_oncall(params=None, **kwargs)
get_shift_by_id(shift_id, params=None, **kwargs)
get_shifts(params=None, **kwargs)
get_supervisors()
remove_member(member_id)
allow_duplicates
Vartype

bool

created
Vartype

TimeAttribute

description
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

group_type
Vartype

str

id
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

observed_by_all
Vartype

bool

property observers

Alias of get_observers()

recipient_type
Vartype

str

response_count
Vartype

int

response_count_threshold
Vartype

str

services
Vartype

list

site
Vartype

ReferenceByIdAndSelfLink

status
Vartype

str

property supervisors

Alias of get_supervisors()

target_name
Vartype

str

use_default_devices
Vartype

bool

class GroupMembership(parent, data)

Bases: xmatters.connection.ApiBase

group
Vartype

GroupReference

member
Vartype

RecipientReference

shifts
Vartype

Pagination of GroupMembershipShiftReference

class GroupMembershipShiftReference(parent, data=None, endpoint=None)

Bases: xmatters.connection.ApiBase

Custom object for shift information embedded in a group membership response

class GroupQuota(parent, data)

Bases: xmatters.connection.ApiBase

group_quota_enabled
Vartype

bool

stakeholder_users
Vartype

QuotaItem

Import Jobs

class Import(parent, data)

Bases: xmatters.connection.ApiBase

get_messages(params=None, **kwargs)
by
Vartype

PersonReference

finished_at
Vartype

TimeAttribute

id
Vartype

str

last_updated_at
Vartype

TimeAttribute

Vartype

SelfLink

name
Vartype

str

processed_count
Vartype

int

started
Vartype

TimeAttribute

status
Vartype

str

total_count
Vartype

int

transform
Vartype

str

class ImportMessage(parent, data)

Bases: xmatters.connection.ApiBase

description
Vartype

str

id
Vartype

str

line
Vartype

int

message_level
Vartype

str

message_type
Vartype

str

Incidents

class Incident(parent, data)

Bases: xmatters.connection.ApiBase

add_timeline_note(data)
acknowledged_at
Vartype

TimeAttribute

commander
Vartype

PersonReference

created_at
Vartype

TimeAttribute

description
Vartype

str

id
Vartype

str

impacted_services
Vartype

list of Service

incident_identifier
Vartype

str

initiated_by
Vartype

PersonReference

Vartype

SelfLink

reporter
Vartype

PersonReference

request_id
Vartype

str

severity
Vartype

IncidentProperty

status
Vartype

IncidentProperty

summary
Vartype

str

updated_at
Vartype

TimeAttribute

class IncidentDetails(parent, data)

Bases: xmatters.connection.ApiBase

description
Vartype

str

severity
Vartype

str

summary
Vartype

str

class IncidentNote(parent, data)

Bases: xmatters.connection.ApiBase

added_dy
Vartype

PersonReference

at
Vartype

TimeAttribute

entry_type
Vartype

str

id
Vartype

str

text
Vartype

str

class IncidentProperty(parent, data)

Bases: xmatters.connection.ApiBase

level
Vartype

str

name
Vartype

str

Integrations

class Integration(parent, data)

Bases: xmatters.connection.ApiBase

get_logs()
Return type

Pagination of IntegrationLog

authentication_type
Vartype

str

created_by
Vartype

str

deployed
Vartype

bool

endpoint
Vartype

Endpoint

form
Vartype

ReferenceById

id
Vartype

str

integration_type
Vartype

str

is_run_by_service_owner
Vartype

str

Vartype

SelfLink

property logs

Alias for get_logs()

migrated_outbound_trigger
Vartype

str

name
Vartype

str

operation
Vartype

str

origin_type
Vartype

str

plan
Vartype

ReferenceById

script
Vartype

str

triggered_by
Vartype

str

class IntegrationLog(parent, data)

Bases: xmatters.connection.ApiBase

by
Vartype

PersonReference

completed
Vartype

TimeAttribute

id
Vartype

str

integration
Vartype

IntegrationReference

remote_address
Vartype

str

request_body
Vartype

str

request_headers
Vartype

dict

request_id
Vartype

str

request_method
Vartype

str

request_parameters
Vartype

dict

status
Vartype

str

class IntegrationReference(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

plan
Vartype

PlanReference

On-Call

class OnCall(parent, data)

Bases: xmatters.connection.ApiBase

get_shift()
end
Vartype

TimeAttribute

group
Vartype

GroupReference

members
Vartype

Pagination of ShiftOccurrenceMember

property shift

Alias for get_shift()

start
Vartype

TimeAttribute

class Replacer(parent, data)

Bases: xmatters.connection.ApiBase

first_name
Vartype

str

property full_name
id
Vartype

str

last_name
Vartype

str

Vartype

SelfLink

recipient_type
Vartype

str

status
Vartype

str

target_name
Vartype

str

class ShiftOccurrenceMember(parent, data)

Bases: xmatters.connection.ApiBase

delay
Vartype

int

escalation_type
Vartype

str

member
Vartype

RecipientFactory

position
Vartype

int

replacements
Vartype

Pagination of TemporaryReplacement

class ShiftReference(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

Vartype

SelfLink

name
Vartype

str

class TemporaryReplacement(parent, data)

Bases: xmatters.connection.ApiBase

end
Vartype

TimeAttribute

replacement
Vartype

TemporaryReplacement

start
Vartype

TimeAttribute

On-Call Summary

class OnCallSummary(parent, data)

Bases: xmatters.connection.ApiBase

absence
Vartype

PersonReference

delay
Vartype

int

escalation_level
Vartype

str

group
Vartype

GroupReference

recipient
Vartype

compose

shift
Vartype

ShiftReference

People

class Person(parent, data)

Bases: xmatters.objects.common.Recipient

get_devices(params=None, **kwargs)
get_groups(params=None, **kwargs)
get_roles()
get_supervisors(params=None, **kwargs)
property devices

Alias for get_devices()

external_key
Vartype

str

externally_owned
Vartype

bool

first_name
Vartype

str

property full_name

Get person’s full name

Returns

person’s full name

Return type

str

id
Vartype

str

language
Vartype

str

last_login
Vartype

TimeAttribute

last_name
Vartype

str

license_type
Vartype

str

Vartype

SelfLink

locked
Vartype

bool

phone_login
Vartype

str

phone_pin
Vartype

str

properties
Vartype

dict

recipient_type
Vartype

str

property roles

Alias for get_roles()

status
Vartype

str

property supervisors

Alias for get_supervisors()

target_name
Vartype

str

timezone
Vartype

str

web_login
Vartype

str

when_created
Vartype

TimeAttribute

when_updated
Vartype

TimeAttribute

class PersonReference(parent, data)

Bases: xmatters.connection.ApiBase

first_name
Vartype

str

property full_name
Return type

str

id
Vartype

str

last_name
Vartype

str

Vartype

SelfLink

recipient_type
Vartype

str

target_name
Vartype

str

class UserQuota(parent, data)

Bases: xmatters.connection.ApiBase

full_users
Vartype

QuotaItem

stakeholder_users
Vartype

QuotaItem

stakeholder_users_enabled
Vartype

bool

Plan Constants

class PlanConstant(parent, data)

Bases: xmatters.connection.ApiBase

description
Vartype

str

id
Vartype

str

Vartype

SelfLink

name
Vartype

str

plan
Vartype

PlanPointer

value
Vartype

str

Plan Endpoints

class BasicAuthentication(parent, data)

Bases: xmatters.connection.ApiBase

password
Vartype

str

username
Vartype

str

class Endpoint(parent, data)

Bases: xmatters.connection.ApiBase

authentication
Vartype

AuthFactory

authentication_type
Vartype

str

data
Vartype

str

endpoint_type
Vartype

str

id
Vartype

str

Vartype

SelfLink

plan
Vartype

PlanReference

preemptive
Vartype

bool

trust_self_signed
Vartype

bool

url
Vartype

str

class OAuth2Authentication(parent, data)

Bases: xmatters.connection.ApiBase

client_secret
Vartype

str

oauth_client_id
Vartype

str

oauth_token_url
Vartype

str

username
Vartype

str

class ServiceAuthentication(parent, data)

Bases: xmatters.connection.ApiBase

connection_status
Vartype

str

username
Vartype

str

Plan Properties

class Boolean(parent, data)

Bases: xmatters.objects.plan_properties.Property

default
Vartype

str

description
Vartype

str

help_text
Vartype

str

id
Vartype

str

name
Vartype

str

property_type
Vartype

str

class Hierarchy(parent, data)

Bases: xmatters.objects.plan_properties.Property

categories
Vartype

list

default
Vartype

str

delimiter
Vartype

str

description
Vartype

str

help_text
Vartype

str

id
Vartype

str

name
Vartype

str

paths
Vartype

list

property_type
Vartype

str

class MultLinkSelectList(parent, data)

Bases: xmatters.objects.plan_properties.Property

description
Vartype

str

help_text
Vartype

str

id
Vartype

str

items
Vartype

list

name
Vartype

str

property_type
Vartype

str

class Number(parent, data)

Bases: xmatters.objects.plan_properties.Property

default
Vartype

str

description
Vartype

str

help_text
Vartype

str

id
Vartype

str

max_length
Vartype

int

min_length
Vartype

int

name
Vartype

str

property_type
Vartype

str

units
Vartype

str

class Password(parent, data)

Bases: xmatters.objects.plan_properties.Property

description
Vartype

str

help_text
Vartype

str

id
Vartype

str

max_length
Vartype

int

min_length
Vartype

int

name
Vartype

str

pattern
Vartype

str

property_type
Vartype

str

validate
Vartype

bool

class Property(parent, data)

Bases: xmatters.connection.ApiBase

description
Vartype

str

help_text
Vartype

str

id
Vartype

str

name
Vartype

str

property_type
Vartype

str

class SingleSelectList(parent, data)

Bases: xmatters.objects.plan_properties.Property

description
Vartype

str

help_text
Vartype

str

id
Vartype

str

items
Vartype

list

name
Vartype

str

property_type
Vartype

str

class Text(parent, data)

Bases: xmatters.objects.plan_properties.Property

description
Vartype

str

help_text
Vartype

str

id
Vartype

str

max_length
Vartype

int

min_length
Vartype

int

name
Vartype

str

pattern
Vartype

str

property_type
Vartype

str

validate
Vartype

bool

Plans

class Plan(parent, data)

Bases: xmatters.connection.ApiBase

create_constant(data)
create_endpoint(data)
create_form(data)
create_integration(data)
create_property(data)
create_shared_library(data)
create_subscription_form(data)
delete_constant(constant_id)
delete_endpoint(endpoint_id)
delete_integration(integration_id)
delete_property(property_id)
delete_shared_library(library_id)
get_constants()
get_creator()

Get plan creator

Returns

Plan creator

Return type

Person

get_endpoints()
get_form_by_id(form_id, params=None, **kwargs)
get_forms(params=None, **kwargs)
get_integration_by_id(integration_id)
get_integrations(integration_type=None, deployed=None, **kwargs)
get_properties()
get_shared_libraries(params=None, **kwargs)
get_shared_library_by_id(library_id)
get_subscription_forms(params=None, **kwargs)
update_constant(data)
update_endpoint(data)
update_form(data)
update_integration(data)
update_property(data)
update_shared_library(data)
update_subscription_form(data)
accessible
Vartype

bool

property constants

Alias of get_constants()

created
Vartype

TimeAttribute

property creator

Alias of get_creator()

description
Vartype

str

editable
Vartype

bool

enabled
Vartype

bool

property endpoints

Alias of get_endpoints()

flood_control
Vartype

bool

property forms

Alias of get_forms()

id
Vartype

str

property integrations

Alias of get_integrations()

Vartype

SelfLink

logging_level
Vartype

str

name
Vartype

str

plan_type
Vartype

str

position
Vartype

int

property property_definitions

Alias of get_properties()

class PlanPointer(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

class PlanReference(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

name
Vartype

str

Roles

class Role(parent, data)

Bases: xmatters.connection.ApiBase

description
Vartype

str

id
Vartype

str

name
Vartype

str

Scenarios

class Scenario(parent, data)

Bases: xmatters.connection.ApiBase

get_form()
get_plan()
get_properties()
get_properties_translations()
bypass_phone_intro
Vartype

bool

created
Vartype

TimeAttribute

description
Vartype

str

escalation_override
Vartype

bool

expiration_in_minutes
Vartype

int

property form

Alias of get_form()

id
Vartype

str

Vartype

SelfLink

name
Vartype

str

override_device_restrictions
Vartype

bool

permitted
Vartype

[compose(self, p)]

property plan

Alias of get_plan()

position
Vartype

int

priority
Vartype

str

property properties

Alias of get_properties()

property properties_translations

Alias of get_properties_translations()

recipients
Vartype

Pagination of RecipientFactory

require_phone_password
Vartype

bool

sender_overrides
Vartype

SenderOverrides

target_device_names
Vartype

Pagination of DeviceNameFactory

voicemail_options
Vartype

VoicemailOptions

class ScenarioPermission(parent, data)

Bases: xmatters.connection.ApiBase

editor
Vartype

str

permissible_type
Vartype

str

class ScenarioPermissionPerson(parent, data)

Bases: xmatters.objects.scenarios.ScenarioPermission

editor
Vartype

str

permissible_type
Vartype

str

person
Vartype

PersonReference

class ScenarioPermissionRole(parent, data)

Bases: xmatters.objects.scenarios.ScenarioPermission

editor
Vartype

str

permissible_type
Vartype

str

role
Vartype

Role

Services

class Service(parent, data)

Bases: xmatters.connection.ApiBase

description
Vartype

str

id
Vartype

str

owned_by
Vartype

GroupReference

recipients_type
Vartype

str

target_name
Vartype

str

Shared Libraries

class SharedLibrary(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

name
Vartype

str

plan
Vartype

PlanReference

script
Vartype

str

Shifts

class End(parent, data)

Bases: xmatters.connection.ApiBase

date
Vartype

TimeAttribute

end_by
Vartype

str

repetitions
Vartype

int

class GroupReference(parent, data)

Bases: xmatters.connection.ApiBase

group_type
Vartype

str

id
Vartype

str

Vartype

SelfLink

recipient_type
Vartype

str

target_name
Vartype

str

class Rotation(parent, data)

Bases: xmatters.connection.ApiBase

direction
Vartype

str

interval
Vartype

int

interval_unit
Vartype

str

next_rotation_time
Vartype

TimeAttribute

type
Vartype

str

class Shift(parent, data)

Bases: xmatters.connection.ApiBase

add_member(data)
get_members()
end
Vartype

TimeAttribute

group
Vartype

GroupReference

id
Vartype

str

Vartype

SelfLink

property members

Alias of get_members()

name
Vartype

str

recurrence
Vartype

ShiftRecurrence

start
Vartype

TimeAttribute

timezone
Vartype

str

class ShiftMember(parent, data)

Bases: xmatters.connection.ApiBase

delay
Vartype

int

escalation_type
Vartype

str

in_rotation
Vartype

bool

position
Vartype

int

recipient
Vartype

Recipient

shift
Vartype

ReferenceByIdAndSelfLink

class ShiftRecurrence(parent, data)

Bases: xmatters.connection.ApiBase

data_on_month
Vartype

str

day_of_week
Vartype

str

day_of_week_classifier
Vartype

str

end
Vartype

End

frequency
Vartype

str

months
Vartype

list

on
Vartype

str

on_days
Vartype

list

repeat_every
Vartype

str

Sites

class Site(parent, data)

Bases: xmatters.connection.ApiBase

address1
Vartype

str

address2
Vartype

str

city
Vartype

str

country
Vartype

str

external_key
Vartype

str

externally_owned
Vartype

bool

id
Vartype

str

language
Vartype

str

latitude
Vartype

str

Vartype

SelfLink

longitude
Vartype

str

name
Vartype

str

postal_code
Vartype

str

state
Vartype

str

status
Vartype

str

timezone
Vartype

str

Subscription Forms

class SubscriptionForm(parent, data)

Bases: xmatters.connection.ApiBase

created
Vartype

TimeAttribute

description
Vartype

str

form
Vartype

FormReference

id
Vartype

str

Vartype

SelfLink

name
Vartype

str

notification_delay
Vartype

int

one_way
Vartype

bool

plan
Vartype

PlanReference

property property_definitions
property roles
scope
Vartype

str

subscribe_others
Vartype

bool

property target_device_names
property visible_target_device_names
class SubscriptionFormReference(parent, data)

Bases: xmatters.connection.ApiBase

id
Vartype

str

name
Vartype

str

plan
Vartype

PlanReference

Subscriptions

class Subscription(parent, data)

Bases: xmatters.connection.ApiBase

get_subscribers(params=None, **kwargs)
created
Vartype

TimeAttribute

criteria
Vartype

Pagination of SubscriptionCriteriaReference

description
Vartype

str

form
Vartype

FormReference

id
Vartype

str

Vartype

SelfLink

name
Vartype

str

notification_delay
Vartype

int

owner
Vartype

PersonReference

recipients
Vartype

Pagination of RecipientFactory

target_device_names
Vartype

Pagination of DeviceNameFactory

class SubscriptionCriteriaReference(parent, data)

Bases: xmatters.connection.ApiBase

name
Vartype

str

operator
Vartype

str

value
Vartype

str

values
Vartype

list

Temporary Absences

class TemporaryAbsence(parent, data)

Bases: xmatters.connection.ApiBase

absence_type
Vartype

str

end
Vartype

TimeAttribute

group
Vartype

GroupReference

id
Vartype

str

member
Vartype

PersonReference

replacement
Vartype

PersonReference

start
Vartype

TimeAttribute

Utilities

class Pagination(parent, data, constructor)

Bases: xmatters.connection.ApiBase

Iterator to handle returned pagination objects from the xMatters API.

Parameters

  • parent (subclass of xmatters.connection.ApiBridge) – class that initialized Pagination

  • data (dict) – request data

  • constructor (class) – class used to process request data into representation of an API object.

count

Count of total objects in page

index

Count of objects iterated from current page

state

Count of total objects iterated

total

Count of total objects within pagination

class TimeAttribute

Bases: str

datetime()

Get datetime object.

Returns

datetime object

Return type

datetime.datetime

local()

Get timestamp adjusted to your local timezone.

Returns

ISO-8601 formatted timestamp

Return type

str

local_dt()

Get datetime object adjusted to your local timezone.

Returns

datetime object adjusted to your local timezone

Return type

datetime.datetime

class TokenFileStorage(token_filepath)

Bases: object

Used to store session token in a file.

Parameters

token_filepath (str or pathlib.Path) – filepath to store token in

read_token()

Read token from file

write_token(token)

Write token to file

Parameters

token (dict) – token object

property token

Factories

class AuditFactory(parent, data)

Bases: xmatters.factories.Factory

Construct audit object based on ‘type’ attribute

classmethod construct(parent, data)

Determine which object to construct from ‘identifier’ attribute in object

factory_objects = {'EVENT_ANNOTATED': <class 'xmatters.objects.audits.AuditAnnotation'>, 'EVENT_COMPLETED': <class 'xmatters.objects.audits.Audit'>, 'EVENT_CREATED': <class 'xmatters.objects.audits.Audit'>, 'EVENT_RESUMED': <class 'xmatters.objects.audits.Audit'>, 'EVENT_SUSPENDED': <class 'xmatters.objects.audits.Audit'>, 'EVENT_TERMINATED': <class 'xmatters.objects.audits.Audit'>, 'NOTIFICATION_DELIVERED': <class 'xmatters.objects.audits.AuditNotification'>, 'NOTIFICATION_FAILED': <class 'xmatters.objects.audits.AuditNotification'>, 'RESPONSE_RECEIVED': <class 'xmatters.objects.audits.AuditResponse'>}
id_attr = 'type'
class AuthFactory(parent, data)

Bases: xmatters.factories.Factory

Construct authentication object based on ‘authenticationType’ attribute

classmethod construct(parent, data)

Determine which object to construct from ‘identifier’ attribute in object

factory_objects = {'BASIC': <class 'xmatters.objects.plan_endpoints.BasicAuthentication'>, 'NO_AUTH': None, 'OAUTH2': <class 'xmatters.objects.plan_endpoints.OAuth2Authentication'>, 'OAUTH2_FORCE': <class 'xmatters.objects.plan_endpoints.OAuth2Authentication'>, 'OAUTH_SLACK': <class 'xmatters.objects.plan_endpoints.OAuth2Authentication'>, 'SERVICENOW': <class 'xmatters.objects.plan_endpoints.ServiceAuthentication'>, 'XMATTERS': <class 'xmatters.objects.plan_endpoints.ServiceAuthentication'>}
id_attr = 'authenticationType'
class DeviceFactory(parent, data)

Bases: xmatters.factories.Factory

Construct Device object based on ‘deviceType’ attribute

classmethod construct(parent, data)

Determine which object to construct from ‘identifier’ attribute in object

factory_objects = {'ANDROID_PUSH': <class 'xmatters.objects.devices.AndroidPushDevice'>, 'APPLE_PUSH': <class 'xmatters.objects.devices.ApplePushDevice'>, 'EMAIL': <class 'xmatters.objects.devices.EmailDevice'>, 'FAX': <class 'xmatters.objects.devices.FaxDevice'>, 'GENERIC': <class 'xmatters.objects.devices.GenericDevice'>, 'TEXT_PAGER': <class 'xmatters.objects.devices.TextPagerDevice'>, 'TEXT_PHONE': <class 'xmatters.objects.devices.SMSDevice'>, 'VOICE': <class 'xmatters.objects.devices.VoiceDevice'>, 'VOICE_IVR': <class 'xmatters.objects.devices.PublicAddressDevice'>}
id_attr = 'deviceType'
class DeviceNameFactory(parent, data)

Bases: xmatters.factories.Factory

Construct device name object based on ‘deviceType’ attribute

classmethod construct(parent, data)

Determine which object to construct from ‘identifier’ attribute in object

factory_objects = {'ANDROID_PUSH': <class 'xmatters.objects.device_names.DeviceName'>, 'APPLE_PUSH': <class 'xmatters.objects.device_names.DeviceName'>, 'EMAIL': <class 'xmatters.objects.device_names.DeviceNameEmail'>, 'FAX': <class 'xmatters.objects.device_names.DeviceName'>, 'GENERIC': <class 'xmatters.objects.device_names.DeviceName'>, 'TEXT_PAGER': <class 'xmatters.objects.device_names.DeviceName'>, 'TEXT_PHONE': <class 'xmatters.objects.device_names.DeviceName'>, 'VOICE': <class 'xmatters.objects.device_names.DeviceName'>, 'VOICE_IVR': <class 'xmatters.objects.device_names.DeviceName'>}
id_attr = 'deviceType'
class Factory(parent, data)

Bases: abc.ABC

ABC for factory objects

classmethod construct(parent, data)

Determine which object to construct from ‘identifier’ attribute in object

abstract property factory_objects
abstract property id_attr
class PropertiesFactory(parent, data)

Bases: xmatters.factories.Factory

Construct plan property object based on ‘propertyType’ attribute

classmethod construct(parent, data)

Determine which object to construct from ‘identifier’ attribute in object

factory_objects = {'BOOLEAN': <class 'xmatters.objects.plan_properties.Boolean'>, 'HIERARCHY': <class 'xmatters.objects.plan_properties.Hierarchy'>, 'LIST_TEXT_MULTI_SELECT': <class 'xmatters.objects.plan_properties.MultLinkSelectList'>, 'LIST_TEXT_SINGLE_SELECT': <class 'xmatters.objects.plan_properties.SingleSelectList'>, 'NUMBER': <class 'xmatters.objects.plan_properties.Number'>, 'PASSWORD': <class 'xmatters.objects.plan_properties.Password'>, 'TEXT': <class 'xmatters.objects.plan_properties.Text'>}
id_attr = 'propertyType'
class RecipientFactory(parent, data)

Bases: xmatters.factories.Factory

Construct recipient object based on ‘recipientType’ attribute

classmethod construct(parent, data)

Determine which object to construct from ‘identifier’ attribute in object

factory_objects = {'DEVICE': <class 'xmatters.objects.devices.Device'>, 'DYNAMIC_TEAM': <class 'xmatters.objects.dynamic_teams.DynamicTeam'>, 'GROUP': <class 'xmatters.objects.groups.Group'>, 'PERSON': <class 'xmatters.objects.people.Person'>}
id_attr = 'recipientType'
class ScenarioPermFactory(parent, data)

Bases: xmatters.factories.Factory

Construct scenario permission object based on ‘permissibleType’ attribute

classmethod construct(parent, data)

Determine which object to construct from ‘identifier’ attribute in object

factory_objects = {'PERSON': <class 'xmatters.objects.scenarios.ScenarioPermissionPerson'>, 'ROLE': <class 'xmatters.objects.scenarios.ScenarioPermissionRole'>}
id_attr = 'permissibleType'
class SectionFactory(parent, data)

Bases: xmatters.factories.Factory

Construct section object based on ‘type’ attribute

classmethod construct(parent, data)

Determine which object to construct from ‘identifier’ attribute in object

factory_objects = {'ATTACHMENTS': <class 'xmatters.objects.forms.FormSection'>, 'CONFERENCE_BRIDGE': <class 'xmatters.objects.forms.ConferenceBridgeSection'>, 'CUSTOM_SECTION': <class 'xmatters.objects.forms.CustomSectionItems'>, 'DEVICE_FILTER': <class 'xmatters.objects.forms.DevicesSection'>, 'DOCUMENT_UPLOAD': <class 'xmatters.objects.forms.FormSection'>, 'HANDLING_OPTIONS': <class 'xmatters.objects.forms.HandlingSection'>, 'INCIDENT': <class 'xmatters.objects.forms.IncidentSection'>, 'RECIPIENTS': <class 'xmatters.objects.forms.RecipientsSection'>, 'RESPONSE_CHOICES': <class 'xmatters.objects.forms.FormSection'>, 'SENDER_OVERRIDES': <class 'xmatters.objects.forms.SenderOverridesSection'>}
id_attr = 'type'