From f488bf49ac517c3d0a2b7dad6c33d3089ef03d48 Mon Sep 17 00:00:00 2001 From: Demitri Morgan Date: Fri, 3 Jan 2025 10:20:42 -0700 Subject: [PATCH] Clarity updates in the migration guide, retry behavior docs and installation sections (readme/user guide) --- README.rst | 2 +- docs/pdpyras_migration_guide.html | 15 +++++++++------ docs/searchindex.js | 2 +- docs/user_guide.html | 8 ++++---- sphinx/source/pdpyras_migration_guide.rst | 17 ++++++++++------- sphinx/source/user_guide.rst | 8 ++++---- 6 files changed, 29 insertions(+), 23 deletions(-) diff --git a/README.rst b/README.rst index a9a2461..21b9683 100644 --- a/README.rst +++ b/README.rst @@ -8,7 +8,7 @@ For in-depth usage documentation, refer to the `User Guide Installation ------------ -This library is available on PyPI as `pagerduty `_, e.g.: +This library is available on the Python Package Index as `pagerduty `_, e.g.: .. code-block:: bash diff --git a/docs/pdpyras_migration_guide.html b/docs/pdpyras_migration_guide.html index 7680b8a..edcefe6 100644 --- a/docs/pdpyras_migration_guide.html +++ b/docs/pdpyras_migration_guide.html @@ -85,15 +85,18 @@

PDPYRAS Migration Guidepdpyras source code. This was done so that nomenclature clearly reflects the hierarchy of APIs and errors, and to make the relationship between API clients and their respective APIs more clear.

-

The following replacements are expressed in sed-style substitution format, -i.e. if replacing all instances of {{pattern}} with {{replacement}}:

-
s/{{pattern}}/{{replacement}}/g
+
Replacements are expressed in sed-style substitution format,
+i.e. if replacing all instances of {{pattern}} with {{replacement}},
+the pattern is s/{{pattern}}/{{replacement}}/g.

+
The first substitution that should be made is s/pdpyras/pagerduty/g, i.e.

+
- import pdpyras
++ import pagerduty
 

 

 

 
Client Classes

-
In downstream code that uses pdpyras, the following name replacements
-should be made in order to switch to using python-pagerduty. The first
+
In code that uses pdpyras, the following class name replacements should be
+made to switch to using their equivalents in python-pagerduty. The first
 three should be done in the order shown, so as to avoid name overlap issues:

 
    
 
  1. s/ChangeEventsAPISession/EventsApiV2Client/g
    2. 
@@ -101,7 +104,7 @@ 
    Client Classess/APISession/RestApiV2Client/g
    
 
  2. s/PDSession/ApiClient/g
    3. 
 

-
The Change Events API client has been merged into the Events API v2 client
+
Note, the Change Events API client has been merged into the Events API v2 client
 because the former API is effectively a component of the latter. The
 differences are trivial enough to support both use cases with a single client
 class, and there are no method or property name collisions between the two
diff --git a/docs/searchindex.js b/docs/searchindex.js
index 74a6583..52bb1be 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["changelog", "contributing", "index", "module_reference", "pdpyras_migration_guide", "user_guide"], "filenames": ["changelog.rst", "contributing.rst", "index.rst", "module_reference.rst", "pdpyras_migration_guide.rst", "user_guide.rst"], "titles": ["Changelog", "Contribution Guide", "python-pagerduty: Clients for PagerDuty\u2019s APIs", "Module Reference", "PDPYRAS Migration Guide", "User Guide"], "terms": {"2025": 0, "01": 0, "02": 0, "migrat": [0, 2], "from": [0, 1, 2, 3, 4], "pdpyra": [0, 1, 2], "version": [0, 2, 3, 4], "1": [0, 1, 3, 4, 5], "0": [0, 1, 3, 4, 5], "break": 0, "chang": [0, 2, 3, 4, 5], "class": [0, 1, 2, 5], "name": [0, 1, 3, 4, 5], "have": [0, 1, 3, 4, 5], "what": [0, 3, 5], "thei": [0, 1, 3, 5], "were": 0, "see": [0, 1, 3, 5], "guid": [0, 2, 3], "The": [0, 1, 2, 3, 4], "rest": [0, 1, 2, 3], "api": [0, 1, 4], "client": [0, 1], "now": 0, "support": [0, 2, 3, 4, 5], "new": [0, 2, 3, 5], "statu": [0, 3, 5], "page": [0, 2, 3, 5], "event": [0, 2, 3, 4], "orchestr": 0, "custom": [0, 3, 5], "incid": [0, 1, 3, 5], "field": [0, 3], "oauth": [0, 3], "deleg": 0, "alert": [0, 3, 5], "group": [0, 5], "set": [0, 2, 3, 5], "bug": [1, 3], "report": [1, 3], "pull": 1, "request": [1, 2, 3], "fix": [1, 3], "issu": [1, 3, 4, 5], "ar": [1, 3, 4, 5], "alwai": [1, 3, 5], "welcom": 1, "built": 1, "If": [1, 3, 5], "featur": [1, 2, 3], "make": [1, 3, 4, 5], "i": [1, 3, 4, 5], "recommend": [1, 3, 5], "add": [1, 3, 5], "assert": 1, "appropri": [1, 3, 5], "case": [1, 2, 3, 4], "test_pagerduti": 1, "py": 1, "ensur": 1, "code": [1, 3, 4, 5], "coverag": 1, "": [1, 3, 4, 5], "pleas": [1, 3], "reproduc": 1, "along": 1, "themselv": 1, "includ": [1, 3, 4, 5], "github": [1, 2], "number": [1, 3, 5], "commit": 1, "messag": [1, 3, 5], "To": [1, 3, 5], "abl": 1, "rebuild": 1, "first": [1, 3, 4, 5], "sure": 1, "you": [1, 3], "pip": [1, 5], "your": [1, 5], "shell": 1, "environ": 1, "next": [1, 5], "python": [1, 4, 5], "depend": 1, "build": [1, 5], "well": [1, 5], "local": 1, "r": [1, 3, 5], "requir": [1, 3, 5], "txt": 1, "assum": [1, 3, 5], "all": [1, 3, 4, 5], "root": [1, 3, 5], "repositori": [1, 2], "suit": 1, "typic": [1, 3, 5], "kei": [1, 3, 5], "respons": [1, 2, 3], "schema": [1, 2, 3], "can": [1, 3, 5], "infer": [1, 3], "last": [1, 3], "second": [1, 3, 5], "node": [1, 3], "url": [1, 2], "singular": 1, "noun": 1, "an": [1, 3, 5], "individu": [1, 3], "resourc": [1, 3], "plural": [1, 3], "collect": [1, 3, 5], "when": [1, 3, 5], "v2": [1, 2, 3, 4], "don": 1, "t": [1, 3, 5], "follow": [1, 3, 4, 5], "thi": [1, 3, 4, 5], "orthodox": [1, 3], "pattern": [1, 3, 4], "pagin": [1, 2, 3], "wrap": [1, 2], "method": [1, 3, 4, 5], "priori": 1, "wai": [1, 3, 5], "them": [1, 3, 5], "becaus": [1, 3, 4, 5], "cannot": [1, 3], "grow": 1, "list": [1, 3, 5], "antipattern": [1, 3], "pagerduti": [1, 3, 4, 5], "product": [1, 3, 5], "system": [1, 3, 5], "wa": [1, 3, 4, 5], "creat": [1, 2, 3], "origin": [1, 4, 5], "5": [1, 3, 5], "work": [1, 3, 5], "around": [1, 3], "codifi": 1, "deviat": 1, "minim": 1, "hard": [1, 5], "identifi": [1, 2, 3], "accord": [1, 3, 5], "sai": [1, 5], "portion": 1, "placehold": 1, "variabl": [1, 3, 5], "us": [1, 2, 3, 4], "hash": 1, "lookup": 1, "handl": [1, 2], "two": [1, 4, 5], "global": [1, 3], "must": [1, 3, 5], "manual": [1, 5], "canonical_path": [1, 2, 3], "entity_wrapper_config": [1, 2, 3], "dictionari": [1, 3, 5], "except": [1, 2, 3, 5], "convent": [1, 3, 5], "There": [1, 3, 5], "three": [1, 3, 4, 5], "main": [1, 5], "categori": 1, "present": 1, "doesn": [1, 3, 5], "mai": [1, 3, 5], "implement": [1, 3], "standard": 1, "In": [1, 3, 4, 5], "still": [1, 3, 5], "classic": [1, 3, 5], "cursor": [1, 3, 5], "base": [1, 3, 5], "correctli": 1, "automat": [1, 3, 5], "also": [1, 3, 5], "onc": [1, 3, 5], "entri": [1, 3], "howev": [1, 5], "step": [1, 3, 5], "copi": 1, "refer": [1, 2, 5], "sourc": [1, 3, 4, 5], "privat": 1, "own": [1, 3], "org": 1, "script": 1, "get_path_list": 1, "gener": [1, 2, 3], "definit": 1, "cursor_based_pagination_path": [1, 2, 3], "replac": [1, 3, 4], "exist": [1, 3, 5], "take": [1, 3, 5], "one": [1, 3, 5], "argument": [1, 3, 5], "file": 1, "index": [1, 3, 5], "yaml": 1, "within": [1, 3], "look": [1, 4, 5], "each": [1, 3, 5], "ani": [1, 3, 5], "doe": [1, 3, 5], "logic": [1, 3, 5], "infer_entity_wrapp": [1, 3], "unwrap": [1, 3, 5], "where": [1, 3, 5], "compon": [1, 4], "separ": [1, 5], "forward": [1, 4], "slash": [1, 3, 5], "opaqu": 1, "correspond": [1, 3, 5], "both": [1, 3, 4, 5], "form": [1, 3], "exampl": [1, 2, 3], "put": [1, 3, 5], "escalation_polici": [1, 3, 5], "id": [1, 3, 5], "get": [1, 3, 5], "user": [1, 2, 3], "2": [1, 3, 5], "post": [1, 3, 5], "schedul": [1, 5], "3": [1, 3, 5], "otherwis": [1, 3, 5], "same": [1, 3, 5], "servic": [1, 2], "abov": [1, 3, 5], "appli": [1, 3], "need": [1, 3, 5], "virtu": 1, "preexist": [1, 3], "alreadi": [1, 3, 5], "do": [1, 5], "order": [1, 3, 4], "As": [1, 5], "describ": [1, 3], "attribut": [1, 3, 5], "combin": 1, "question": 1, "valu": [1, 3, 5], "string": [1, 3, 5], "bodi": [1, 3, 5], "none": [1, 3, 5], "applic": [1, 3, 5], "tupl": [1, 3], "differ": [1, 3, 4, 5], "between": [1, 3, 4, 5], "given": [1, 3, 5], "busi": [1, 5], "subscrib": [1, 5], "like": [1, 5], "business_servic": [1, 5], "subscript": [1, 5], "more": [1, 3, 4, 5], "overrid": [1, 3, 5], "rst": 1, "sphinx": 1, "most": [1, 3, 5], "live": 1, "html": 1, "doc": [1, 3], "forc": 1, "touch": 1, "changelog": [1, 2], "valid": [1, 3, 5], "account": [1, 3, 5], "pypi": [1, 2, 5], "role": 1, "project": [1, 2], "It": [1, 3, 5], "strongli": 1, "token": [1, 3, 5], "upload": 1, "packag": 1, "ha": [1, 3, 4, 5], "access": [1, 3, 5], "note": [1, 3, 5], "longer": [1, 3, 5], "possibl": 1, "even": [1, 3], "delet": [1, 2, 3], "reason": [1, 3], "good": 1, "idea": 1, "suffix": [1, 3], "e": [1, 3, 4, 5], "dev001": 1, "__version__": 1, "while": [1, 2], "enter": 1, "credenti": [1, 3, 5], "prompt": 1, "testpublish": 1, "target": [1, 3, 5], "egg": 1, "dist": 1, "librari": [1, 5], "temporari": [1, 3], "virtualenv": 1, "time": [1, 3, 5], "upgrad": 1, "error": [1, 2, 4], "encount": [1, 3, 5], "should": [1, 3, 4], "immedi": [1, 3, 5], "exit": 1, "investig": 1, "mitig": 1, "befor": [1, 3, 5], "again": 1, "temporarili": 1, "so": [1, 3, 4, 5], "count": [1, 3, 5], "desir": [1, 5], "actual": [1, 3], "A": [1, 3], "which": [1, 3, 5], "function": [1, 2], "least": 1, "item": [1, 3], "commun": 1, "parenthes": 1, "contributor": 1, "link": [1, 3], "semant": 1, "rebuilt": 1, "after": [1, 3, 5], "view": 1, "open": [1, 5], "web": [1, 3, 5], "browser": 1, "help": [1, 3], "review": 1, "tool": 1, "approv": 1, "Then": 1, "checkout": 1, "git": 1, "v": 1, "c": 1, "import": [1, 5], "print": [1, 3, 5], "push": 1, "clone": 1, "branch": 1, "check": [1, 3], "out": [1, 5], "latest": [1, 5], "avail": [1, 5], "tree": 1, "clean": 1, "uncommit": 1, "__token__": 1, "usernam": 1, "password": 1, "final": [1, 3, 5], "fill": 1, "some": [1, 3, 4, 5], "detail": [1, 3, 5], "select": 1, "choos": 1, "patch": [1, 3], "being": [1, 3, 5], "major": 1, "minor": 1, "veri": [1, 5], "brief": [1, 3], "summari": [1, 3, 5], "compos": [1, 3, 5], "descript": [1, 3], "whose": [1, 3, 5], "develop": [2, 3], "document": [2, 3, 5], "instal": 2, "authent": [2, 3], "non": [2, 3], "u": 2, "region": 2, "header": [2, 3], "basic": 2, "usag": [2, 3], "queri": [2, 3], "paramet": [2, 3], "data": [2, 3], "type": [2, 3], "entiti": 2, "endpoint": [2, 3], "awar": [2, 3], "special": [2, 3], "perform": [2, 3], "complet": [2, 3], "result": [2, 3], "updat": [2, 3], "multi": 2, "log": [2, 3], "proxi": 2, "server": [2, 3], "http": [2, 3], "retri": [2, 3], "configur": [2, 3], "default": 2, "behavior": [2, 3], "exponenti": 2, "cooldown": [2, 3], "modul": [2, 4, 5], "apicli": [2, 3, 4, 5], "restapiv2cli": [2, 3, 4, 5], "eventsapiv2cli": [2, 3, 4, 5], "httperror": [2, 3, 4, 5], "serverhttperror": [2, 3, 4], "urlerror": [2, 3, 4, 5], "iteration_limit": [2, 3], "text_len_limit": [2, 3], "timeout": [2, 3], "decor": 2, "helper": 2, "contribut": 2, "initi": [2, 3, 5], "setup": 2, "run": [2, 5], "unit": 2, "test": 2, "maintain": 2, "wrapper": [2, 3, 5], "introduct": 2, "limit": [2, 3, 5], "canon": [2, 3], "path": [2, 3, 5], "evalu": 2, "For": [2, 3, 5], "ad": [2, 3], "conform": 2, "releas": 2, "end": [2, 3, 5], "publish": 2, "merg": [2, 3, 4], "tag": 2, "cover": 3, "provid": 3, "api_kei": [3, 5], "str": 3, "debug": [3, 5], "fals": [3, 5], "opinion": 3, "session": [3, 5], "few": [3, 5], "addit": [3, 4, 5], "reattempt": 3, "auto": 3, "increas": [3, 5], "interv": 3, "attempt": [3, 5], "through": [3, 5], "specifi": [3, 5], "hoc": 3, "call": [3, 5], "verb": 3, "start": [3, 5], "prepend": 3, "onli": [3, 5], "permitted_method": 3, "rais": [3, 5], "other": [3, 5], "bool": 3, "print_debug": [3, 5], "true": [3, 5], "enabl": [3, 5], "verbos": 3, "command": [3, 5], "line": [3, 5], "output": [3, 5], "after_set_api_kei": 3, "setter": 3, "hook": 3, "child": 3, "properti": [3, 4, 5], "repres": [3, 5], "auth_head": 3, "dict": [3, 5], "logger": [3, 5], "object": [3, 5], "By": [3, 5], "without": [3, 5], "handler": [3, 5], "emit": 3, "max_http_attempt": [3, 5], "10": [3, 5], "status": [3, 5], "defin": [3, 5], "greater": 3, "than": [3, 5], "zero": 3, "max_network_attempt": [3, 5], "connect": 3, "treat": 3, "failur": 3, "transient": [3, 5], "happen": [3, 5], "normalize_param": 3, "param": [3, 5], "modifi": [3, 5], "suppli": [3, 5], "eas": 3, "current": [3, 5], "squar": [3, 5], "bracket": [3, 5], "append": [3, 5], "keep": [3, 5], "filter": [3, 5], "return": [3, 5], "modif": 3, "normalize_url": 3, "whether": [3, 5], "parent": [3, 5], "super": 3, "permit": 3, "instanc": [3, 4, 5], "accept": [3, 5], "postprocess": 3, "supplement": 3, "action": [3, 5], "receiv": [3, 5], "per": [3, 5], "extend": 3, "prepare_head": 3, "user_head": 3, "upper": 3, "flag": 3, "level": [3, 5], "sy": [3, 5], "stderr": [3, 5], "notset": [3, 5], "remov": 3, "thu": [3, 5], "toggl": 3, "disabl": [3, 5], "kwarg": 3, "insensit": 3, "keyword": [3, 5], "pass": [3, 5], "int": 3, "effect": [3, 4, 5], "n": [3, 5], "up": [3, 5], "total": [3, 5], "whichev": 3, "429": [3, 5], "401": [3, 5], "sleep_tim": [3, 5], "factor": [3, 5], "rate": 3, "network": [3, 5], "followup": 3, "delai": 3, "equal": 3, "sleep_timer_bas": [3, 5], "power": 3, "how": [3, 5], "mani": 3, "been": [3, 4], "made": [3, 4, 5], "far": 3, "unless": [3, 5], "stagger_cooldown": [3, 5], "nonzero": [3, 5], "sleep": [3, 5], "amount": 3, "float": 3, "random": [3, 5], "wait": [3, 5], "dure": 3, "success": [3, 5], "adjust": 3, "plu": [3, 5], "uniformli": 3, "distribut": 3, "top": 3, "timer": 3, "overal": [3, 5], "4": [3, 5], "wherea": 3, "just": 3, "avoid": [3, 4], "thunder": 3, "herd": 3, "potenti": 3, "caus": [3, 5], "simultan": 3, "concurr": 3, "consequ": 3, "consist": 3, "previou": 3, "60": 3, "sent": [3, 5], "determin": 3, "tcp": 3, "read": [3, 5], "trunc_kei": 3, "truncat": 3, "secur": 3, "displai": 3, "identif": 3, "purpos": 3, "default_from": [3, 5], "auth_typ": [3, 5], "oft": 3, "aspect": 3, "inherit": [3, 5], "email": [3, 5], "address": [3, 5], "oauth2": [3, 5], "bearer": 3, "member": 3, "api_call_count": 3, "record": [3, 5], "api_key_access": [3, 5], "memoiz": 3, "getter": 3, "Will": 3, "permiss": 3, "ui": 3, "administr": [3, 5], "api_tim": 3, "author": 3, "format": [3, 4], "default_page_s": 3, "100": [3, 5], "iter": [3, 5], "dict_al": [3, 5], "kw": 3, "represent": 3, "With": 3, "iter_al": [3, 5], "further": 3, "uniqu": [3, 5], "distinct": [3, 5], "omit": 3, "find": [3, 5], "exactli": [3, 5], "match": [3, 5], "expect": [3, 5], "ignor": [3, 5], "much": 3, "constrain": 3, "those": 3, "everi": 3, "download": 3, "compar": 3, "against": 3, "until": [3, 5], "found": [3, 5], "comparison": 3, "insenit": 3, "mostli": 3, "therefor": [3, 5], "similar": [3, 5], "charact": 3, "search": [3, 5], "reduc": 3, "pre": 3, "common": 3, "lowercas": 3, "interpret": 3, "said": [3, 5], "constraint": 3, "sensit": 3, "correct": 3, "term": 3, "querystr": 3, "lower": [3, 5], "exact": 3, "option": 3, "page_s": 3, "item_hook": 3, "content": [3, 5], "yield": [3, 5], "pagint": 3, "iter_cursor": [3, 5], "k": [3, 5], "numer": [3, 5], "arrai": [3, 5], "alter": 3, "preced": [3, 5], "dictat": 3, "callabl": 3, "invok": 3, "progress": 3, "seri": 3, "isn": 3, "knowabl": 3, "third": 3, "leav": 3, "confer": 3, "small": 3, "advantag": 3, "comput": 3, "posit": [3, 5], "jget": [3, 5], "json": [3, 5], "decod": [3, 5], "jpost": 3, "jput": 3, "list_al": [3, 5], "directli": [3, 5], "persist": [3, 5], "attr": 3, "idempot": [3, 5], "pair": [3, 5], "via": [3, 5], "underli": [3, 5], "ap": 3, "contain": [3, 5], "inform": 3, "metadata": [3, 5], "about": [3, 5], "rdelet": 3, "send": [3, 5], "self": [3, 5], "rget": [3, 5], "retriev": 3, "rpatch": 3, "workflow": 3, "integr": [3, 5], "integration_id": 3, "resource_url": 3, "rpost": [3, 5], "rput": [3, 5], "subdomain": 3, "total_call_count": 3, "total_call_tim": 3, "spent": 3, "trunc_token": 3, "com": [3, 5], "submit": [3, 5], "acknowledg": [3, 5], "dedup_kei": [3, 5], "dedupl": [3, 5], "state": [3, 5], "arg": 3, "routing_kei": [3, 5], "agent": 3, "resolv": [3, 5], "send_change_ev": 3, "payload": 3, "timestamp": 3, "custom_detail": 3, "href": 3, "text": 3, "deprec": 3, "rout": 3, "send_ev": 3, "trigger": [3, 5], "associ": [3, 5], "would": [3, 5], "human": 3, "readabl": 3, "iso8601": 3, "date": 3, "sever": 3, "critic": 3, "imag": 3, "wrong": 3, "affect": [3, 5], "conjunct": 3, "regard": 3, "impli": 3, "sole": 3, "experienc": 3, "4xx": 3, "descend": [3, 5], "backend": 3, "successfulli": 3, "strictli": 3, "easier": 3, "cleanli": 3, "guarante": 3, "its": [3, 5], "could": 3, "denot": 3, "thing": 3, "wherein": 3, "recevi": 3, "instead": [3, 5], "try": [3, 5], "pabc123": [3, 5], "status_cod": [3, 5], "els": [3, 5], "write": [3, 5], "fail": 3, "earli": 3, "ga": 3, "5xx": [3, 5], "unsupport": [3, 5], "malform": [3, 5], "input": [3, 5], "These": 3, "explicit": 3, "properli": 3, "capit": 3, "space": 3, "either": [3, 5], "marshal": 3, "unmarsh": 3, "under": [3, 5], "design": [3, 5], "transmit": 3, "apart": 3, "secondari": 3, "bear": [3, 5], "discard": [3, 5], "prevent": 3, "10000": 3, "maximum": [3, 5], "offset": [3, 5], "exce": 3, "enforc": 3, "side": 3, "someth": 3, "rather": 3, "short": [3, 5], "circuit": 3, "400": [3, 5], "longest": 3, "length": 3, "benefit": 3, "anyon": 3, "who": 3, "relat": [3, 5], "base_url": 3, "classifi": 3, "particular": [3, 5], "belong": 3, "explicitli": 3, "part": 3, "shown": [3, 4], "contact_method": 3, "contact": 3, "normal": [3, 5], "full": [3, 5], "endpoint_match": 3, "endpoint_pattern": 3, "uppercas": 3, "is_path_param": 3, "path_nod": 3, "arbitrari": 3, "rel": [3, 5], "exclud": 3, "trail": 3, "entity_wrapp": 3, "obtain": [3, 5], "element": 3, "signal": 3, "unmodifi": 3, "broadli": 3, "univers": 3, "predict": 3, "map": 3, "intend": 3, "subclass": [3, 5], "auto_json": 3, "requires_success": 3, "allow": [3, 5], "itself": [3, 5], "elimin": 3, "re": 3, "construct": [3, 5], "hold": 3, "wrapped_ent": 3, "encod": [3, 5], "catch": [3, 5], "reform": 3, "miscellan": 3, "deprecated_kwarg": 3, "deprecated_nam": 3, "warn": 3, "http_error_messag": 3, "context": [3, 5], "last_4": 3, "secret": [3, 5], "plural_nam": 3, "obj_typ": 3, "user_refer": [3, 5], "successful_respons": 3, "truncate_text": 3, "try_decod": 3, "renam": 4, "done": 4, "nomenclatur": 4, "clearli": 4, "reflect": 4, "hierarchi": 4, "relationship": 4, "respect": [4, 5], "clear": 4, "express": 4, "sed": 4, "style": 4, "substitut": 4, "g": [4, 5], "downstream": 4, "switch": 4, "overlap": 4, "changeeventsapisess": 4, "eventsapisess": 4, "apisess": 4, "pdsession": 4, "former": 4, "latter": 4, "trivial": 4, "enough": 4, "singl": [4, 5], "collis": 4, "pdclienterror": 4, "pdservererror": 4, "pdhttperror": 4, "topic": 5, "depth": 5, "constructor": 5, "client_oauth": 5, "oauth_token": 5, "events_cli": 5, "manag": 5, "do_appl": 5, "eu": 5, "outsid": 5, "instanti": 5, "admin": 5, "menu": 5, "certain": 5, "Its": 5, "tab": 5, "profil": 5, "deriv": 5, "necessari": 5, "unknown": 5, "ok": 5, "convert": 5, "sn": 5, "jane": 5, "example35": 5, "updated_us": 5, "user_data": 5, "user123": 5, "mcuserson": 5, "assign": 5, "user_id": 5, "phij789": 5, "5b": 5, "5d": 5, "updated_incid": 5, "fire": 5, "dusti": 5, "old": 5, "net": 5, "abc123": 5, "finish": 5, "head": 5, "autom": 5, "sinc": 5, "analog": 5, "j": 5, "though": 5, "lead": 5, "One": 5, "strip": 5, "place": 5, "everyth": 5, "simpli": 5, "serial": 5, "first_dan": 5, "dan": 5, "82": 5, "foo": 5, "foo_servic": 5, "team": 5, "50": 5, "plain": 5, "That": 5, "uuid": 5, "x": 5, "encapsul": 5, "insid": 5, "articl": 5, "analogu": 5, "structur": 5, "speak": 5, "consid": 5, "escal": 5, "polici": 5, "ep": 5, "escalation_rul": 5, "daili": 5, "engin": 5, "rotat": 5, "rule": 5, "new_rul": 5, "escalation_delay_in_minut": 5, "30": 5, "pam4fg": 5, "pi7dh85": 5, "schedule_refer": 5, "save": 5, "respond": 5, "anoth": 5, "usual": 5, "next_cursor": 5, "extract": 5, "specif": 5, "On": 5, "equival": 5, "left": 5, "moreov": 5, "lack": 5, "unusu": 5, "vice": 5, "versa": 5, "incient": 5, "status_upd": 5, "created_overrid": 5, "pghi789": 5, "2023": 5, "07": 5, "01t00": 5, "00": 5, "04": 5, "02t00": 5, "peysgva": 5, "time_zon": 5, "utc": 5, "03t00": 5, "peysgvf": 5, "201": 5, "indic": 5, "fetch": 5, "dav": 5, "dave": 5, "david": 5, "bob": 5, "synchron": 5, "multipl": 5, "thread": 5, "higher": 5, "larg": 5, "volum": 5, "partial": 5, "wise": 5, "oper": 5, "erron": 5, "condit": 5, "presenc": 5, "sort": 5, "real": 5, "recalcul": 5, "skip": 5, "repeat": 5, "accordingli": 5, "process": 5, "edit": 5, "elabor": 5, "let": 5, "notebook": 5, "essenti": 5, "go": 5, "101st": 5, "201st": 5, "etc": 5, "tear": 5, "At": 5, "shift": 5, "becom": 5, "hundr": 5, "over": 5, "similarli": 5, "500": 5, "601": 5, "700": 5, "attach": 5, "opposit": 5, "bump": 5, "pdef456": 5, "incident_refer": 5, "effici": 5, "scope": 5, "login": 5, "prior": 5, "transport": 5, "involv": 5, "httpservererror": 5, "unexpect": 5, "404": 5, "pjkl678": 5, "unconfigur": 5, "defer": 5, "discret": 5, "streamhandl": 5, "host": 5, "traffic": 5, "42": 5, "187": 5, "port": 5, "4012": 5, "protocol": 5, "unsuccess": 5, "loop": 5, "unlimit": 5, "unauthor": 5, "invalid": 5, "period": 5, "\u03c1": 5, "randomli": 5, "th": 5, "basi": 5, "abil": 5, "although": 5, "2xx": 5, "won": 5, "toward": 5, "supersed": 5, "low": 5, "reach": 5, "carri": 5, "four": 5, "8": 5, "16": 5, "paus": 5, "pnoexst": 5, "62": 5, "6": 5}, "objects": {"": [[3, 0, 0, "module-3", "pagerduty"]], "pagerduty": [[3, 1, 1, "", "ApiClient"], [3, 5, 1, "", "CANONICAL_PATHS"], [3, 5, 1, "", "CURSOR_BASED_PAGINATION_PATHS"], [3, 5, 1, "", "ENTITY_WRAPPER_CONFIG"], [3, 1, 1, "", "Error"], [3, 1, 1, "", "EventsApiV2Client"], [3, 1, 1, "", "HttpError"], [3, 5, 1, "", "ITERATION_LIMIT"], [3, 1, 1, "", "RestApiV2Client"], [3, 1, 1, "", "ServerHttpError"], [3, 5, 1, "", "TEXT_LEN_LIMIT"], [3, 5, 1, "", "TIMEOUT"], [3, 1, 1, "", "UrlError"], [3, 6, 1, "", "auto_json"], [3, 6, 1, "", "canonical_path"], [3, 6, 1, "", "deprecated_kwarg"], [3, 6, 1, "", "endpoint_matches"], [3, 6, 1, "", "entity_wrappers"], [3, 6, 1, "", "http_error_message"], [3, 6, 1, "", "infer_entity_wrapper"], [3, 6, 1, "", "is_path_param"], [3, 6, 1, "", "last_4"], [3, 6, 1, "", "normalize_url"], [3, 6, 1, "", "plural_name"], [3, 6, 1, "", "requires_success"], [3, 6, 1, "", "resource_url"], [3, 6, 1, "", "successful_response"], [3, 6, 1, "", "truncate_text"], [3, 6, 1, "", "try_decoding"], [3, 6, 1, "", "unwrap"], [3, 6, 1, "", "wrapped_entities"]], "pagerduty.ApiClient": [[3, 2, 1, "", "after_set_api_key"], [3, 3, 1, "", "api_key"], [3, 3, 1, "", "auth_header"], [3, 4, 1, "", "log"], [3, 4, 1, "", "max_http_attempts"], [3, 4, 1, "", "max_network_attempts"], [3, 2, 1, "", "normalize_params"], [3, 2, 1, "", "normalize_url"], [3, 4, 1, "", "parent"], [3, 4, 1, "", "permitted_methods"], [3, 2, 1, "", "postprocess"], [3, 2, 1, "", "prepare_headers"], [3, 3, 1, "", "print_debug"], [3, 2, 1, "", "request"], [3, 4, 1, "", "retry"], [3, 4, 1, "", "sleep_timer"], [3, 4, 1, "", "sleep_timer_base"], [3, 3, 1, "", "stagger_cooldown"], [3, 4, 1, "", "timeout"], [3, 3, 1, "", "trunc_key"]], "pagerduty.Error": [[3, 4, 1, "", "response"]], "pagerduty.EventsApiV2Client": [[3, 2, 1, "", "acknowledge"], [3, 2, 1, "", "post"], [3, 2, 1, "", "prepare_headers"], [3, 2, 1, "", "resolve"], [3, 2, 1, "", "send_change_event"], [3, 2, 1, "", "send_event"], [3, 2, 1, "", "submit"], [3, 2, 1, "", "trigger"]], "pagerduty.RestApiV2Client": [[3, 4, 1, "", "api_call_counts"], [3, 3, 1, "", "api_key_access"], [3, 4, 1, "", "api_time"], [3, 3, 1, "", "auth_type"], [3, 4, 1, "", "default_from"], [3, 4, 1, "", "default_page_size"], [3, 2, 1, "", "dict_all"], [3, 2, 1, "", "find"], [3, 2, 1, "", "iter_all"], [3, 2, 1, "", "iter_cursor"], [3, 2, 1, "", "jget"], [3, 2, 1, "", "jpost"], [3, 2, 1, "", "jput"], [3, 2, 1, "", "list_all"], [3, 2, 1, "", "persist"], [3, 2, 1, "", "postprocess"], [3, 2, 1, "", "rdelete"], [3, 2, 1, "", "rget"], [3, 2, 1, "", "rpatch"], [3, 2, 1, "", "rpost"], [3, 2, 1, "", "rput"], [3, 3, 1, "", "subdomain"], [3, 3, 1, "", "total_call_count"], [3, 3, 1, "", "total_call_time"], [3, 3, 1, "", "trunc_token"], [3, 4, 1, "", "url"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:attribute", "5": "py:data", "6": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "data", "Python data"], "6": ["py", "function", "Python function"]}, "titleterms": {"changelog": 0, "contribut": 1, "guid": [1, 4, 5], "initi": 1, "setup": 1, "run": 1, "unit": 1, "test": 1, "maintain": 1, "entiti": [1, 3, 5], "wrapper": 1, "configur": [1, 5], "introduct": 1, "limit": 1, "updat": [1, 5], "canon": 1, "path": 1, "set": 1, "evalu": 1, "new": 1, "endpoint": [1, 5], "For": 1, "support": 1, "ad": 1, "non": [1, 5], "conform": 1, "document": 1, "releas": 1, "version": 1, "perform": [1, 5], "end": 1, "publish": 1, "instal": [1, 5], "merg": 1, "chang": 1, "tag": 1, "python": 2, "pagerduti": 2, "client": [2, 3, 4, 5], "": 2, "api": [2, 3, 5], "extern": 2, "resourc": [2, 5], "tabl": 2, "content": 2, "modul": 3, "refer": 3, "class": [3, 4], "error": [3, 5], "default": [3, 5], "function": [3, 5], "url": [3, 5], "handl": [3, 5], "wrap": [3, 5], "decor": 3, "helper": 3, "pdpyra": 4, "migrat": 4, "except": 4, "user": 5, "authent": 5, "us": 5, "u": 5, "servic": 5, "region": 5, "The": 5, "from": 5, "header": 5, "basic": 5, "usag": 5, "exampl": 5, "rest": 5, "v2": 5, "event": 5, "gener": 5, "featur": 5, "queri": 5, "paramet": 5, "request": 5, "respons": 5, "data": 5, "type": 5, "schema": 5, "identifi": 5, "awar": 5, "special": 5, "case": 5, "pagin": 5, "complet": 5, "result": 5, "creat": 5, "delet": 5, "while": 5, "multi": 5, "log": 5, "proxi": 5, "server": 5, "http": 5, "retri": 5, "behavior": 5, "exponenti": 5, "cooldown": 5}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 58}, "alltitles": {"Contribution Guide": [[1, "contribution-guide"]], "Initial Setup": [[1, "initial-setup"]], "Running Unit Tests": [[1, "running-unit-tests"]], "Maintaining Entity Wrapper Configuration": [[1, "maintaining-entity-wrapper-configuration"]], "Introduction": [[1, "introduction"]], "Limitations": [[1, "limitations"]], "Updating the Canonical Path Set": [[1, "updating-the-canonical-path-set"]], "Evaluating New Endpoints For Support": [[1, "evaluating-new-endpoints-for-support"]], "Adding Support for Non-Conforming Endpoints": [[1, "adding-support-for-non-conforming-endpoints"]], "Updating Documentation": [[1, "updating-documentation"]], "Releasing a New Version": [[1, "releasing-a-new-version"]], "Perform end-to-end publish and installation testing": [[1, "perform-end-to-end-publish-and-installation-testing"]], "Merge changes and tag": [[1, "merge-changes-and-tag"]], "Publishing": [[1, "publishing"]], "python-pagerduty: Clients for PagerDuty\u2019s APIs": [[2, "python-pagerduty-clients-for-pagerduty-s-apis"]], "External Resources": [[2, "external-resources"]], "Table of Contents": [[2, "table-of-contents"]], "Module Reference": [[3, "module-reference"]], "API Client Classes": [[3, "api-client-classes"]], "Errors": [[3, "errors"]], "Client Defaults": [[3, "client-defaults"]], "Functions": [[3, "functions"]], "URL Handling": [[3, "url-handling"]], "Entity Wrapping": [[3, "entity-wrapping"], [5, "entity-wrapping"]], "Function Decorators": [[3, "function-decorators"]], "Helpers": [[3, "helpers"]], "Changelog": [[0, "changelog"]], "PDPYRAS Migration Guide": [[4, "pdpyras-migration-guide"]], "Client Classes": [[4, "client-classes"]], "Exception Classes": [[4, "exception-classes"]], "User Guide": [[5, "user-guide"]], "Installation": [[5, "installation"]], "Authentication": [[5, "authentication"]], "Using Non-US Service Regions": [[5, "using-non-us-service-regions"]], "The From header": [[5, "the-from-header"]], "Basic Usage Examples": [[5, "basic-usage-examples"]], "REST API v2": [[5, "rest-api-v2"]], "Events API v2": [[5, "events-api-v2"]], "Generic Client Features": [[5, "generic-client-features"]], "URLs": [[5, "urls"]], "Query Parameters": [[5, "query-parameters"]], "Requests and Responses": [[5, "requests-and-responses"]], "Data types": [[5, "data-types"]], "Resource Schemas": [[5, "resource-schemas"]], "Identifying Wrapped-entity Endpoints": [[5, "identifying-wrapped-entity-endpoints"]], "Wrapped-entity-aware Functions": [[5, "wrapped-entity-aware-functions"]], "Special Cases": [[5, "special-cases"]], "Examples": [[5, "examples"]], "Pagination": [[5, "pagination"]], "Performance and Completeness of Results": [[5, "performance-and-completeness-of-results"]], "Updating, creating or deleting while paginating": [[5, "updating-creating-or-deleting-while-paginating"]], "Multi-updating": [[5, "multi-updating"]], "Error Handling": [[5, "error-handling"]], "Logging": [[5, "logging"]], "Using a Proxy Server": [[5, "using-a-proxy-server"]], "HTTP Retry Configuration": [[5, "http-retry-configuration"]], "Default Behavior": [[5, "default-behavior"]], "Exponential Cooldown": [[5, "exponential-cooldown"]], "Configuring Retry Behavior": [[5, "configuring-retry-behavior"]]}, "indexentries": {"apiclient (class in pagerduty)": [[3, "pagerduty.ApiClient"]], "canonical_paths (in module pagerduty)": [[3, "pagerduty.CANONICAL_PATHS"]], "cursor_based_pagination_paths (in module pagerduty)": [[3, "pagerduty.CURSOR_BASED_PAGINATION_PATHS"]], "entity_wrapper_config (in module pagerduty)": [[3, "pagerduty.ENTITY_WRAPPER_CONFIG"]], "error (class in pagerduty)": [[3, "pagerduty.Error"]], "eventsapiv2client (class in pagerduty)": [[3, "pagerduty.EventsApiV2Client"]], "httperror (class in pagerduty)": [[3, "pagerduty.HttpError"]], "iteration_limit (in module pagerduty)": [[3, "pagerduty.ITERATION_LIMIT"]], "restapiv2client (class in pagerduty)": [[3, "pagerduty.RestApiV2Client"]], "serverhttperror (class in pagerduty)": [[3, "pagerduty.ServerHttpError"]], "text_len_limit (in module pagerduty)": [[3, "pagerduty.TEXT_LEN_LIMIT"]], "timeout (in module pagerduty)": [[3, "pagerduty.TIMEOUT"]], "urlerror (class in pagerduty)": [[3, "pagerduty.UrlError"]], "acknowledge() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.acknowledge"]], "after_set_api_key() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.after_set_api_key"]], "api_call_counts (pagerduty.restapiv2client attribute)": [[3, "pagerduty.RestApiV2Client.api_call_counts"]], "api_key (pagerduty.apiclient property)": [[3, "pagerduty.ApiClient.api_key"]], "api_key_access (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.api_key_access"]], "api_time (pagerduty.restapiv2client attribute)": [[3, "pagerduty.RestApiV2Client.api_time"]], "auth_header (pagerduty.apiclient property)": [[3, "pagerduty.ApiClient.auth_header"]], "auth_type (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.auth_type"]], "auto_json() (in module pagerduty)": [[3, "pagerduty.auto_json"]], "canonical_path() (in module pagerduty)": [[3, "pagerduty.canonical_path"]], "default_from (pagerduty.restapiv2client attribute)": [[3, "pagerduty.RestApiV2Client.default_from"]], "default_page_size (pagerduty.restapiv2client attribute)": [[3, "pagerduty.RestApiV2Client.default_page_size"]], "deprecated_kwarg() (in module pagerduty)": [[3, "pagerduty.deprecated_kwarg"]], "dict_all() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.dict_all"]], "endpoint_matches() (in module pagerduty)": [[3, "pagerduty.endpoint_matches"]], "entity_wrappers() (in module pagerduty)": [[3, "pagerduty.entity_wrappers"]], "find() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.find"]], "http_error_message() (in module pagerduty)": [[3, "pagerduty.http_error_message"]], "infer_entity_wrapper() (in module pagerduty)": [[3, "pagerduty.infer_entity_wrapper"]], "is_path_param() (in module pagerduty)": [[3, "pagerduty.is_path_param"]], "iter_all() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.iter_all"]], "iter_cursor() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.iter_cursor"]], "jget() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.jget"]], "jpost() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.jpost"]], "jput() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.jput"]], "last_4() (in module pagerduty)": [[3, "pagerduty.last_4"]], "list_all() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.list_all"]], "log (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.log"]], "max_http_attempts (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.max_http_attempts"]], "max_network_attempts (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.max_network_attempts"]], "module": [[3, "module-0"], [3, "module-1"], [3, "module-2"], [3, "module-3"], [3, "module-pagerduty"]], "normalize_params() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.normalize_params"]], "normalize_url() (in module pagerduty)": [[3, "pagerduty.normalize_url"]], "normalize_url() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.normalize_url"]], "pagerduty": [[3, "module-0"], [3, "module-1"], [3, "module-2"], [3, "module-3"], [3, "module-pagerduty"]], "parent (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.parent"]], "permitted_methods (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.permitted_methods"]], "persist() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.persist"]], "plural_name() (in module pagerduty)": [[3, "pagerduty.plural_name"]], "post() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.post"]], "postprocess() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.postprocess"]], "postprocess() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.postprocess"]], "prepare_headers() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.prepare_headers"]], "prepare_headers() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.prepare_headers"]], "print_debug (pagerduty.apiclient property)": [[3, "pagerduty.ApiClient.print_debug"]], "rdelete() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.rdelete"]], "request() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.request"]], "requires_success() (in module pagerduty)": [[3, "pagerduty.requires_success"]], "resolve() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.resolve"]], "resource_url() (in module pagerduty)": [[3, "pagerduty.resource_url"]], "response (pagerduty.error attribute)": [[3, "pagerduty.Error.response"]], "retry (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.retry"]], "rget() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.rget"]], "rpatch() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.rpatch"]], "rpost() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.rpost"]], "rput() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.rput"]], "send_change_event() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.send_change_event"]], "send_event() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.send_event"]], "sleep_timer (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.sleep_timer"]], "sleep_timer_base (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.sleep_timer_base"]], "stagger_cooldown (pagerduty.apiclient property)": [[3, "pagerduty.ApiClient.stagger_cooldown"]], "subdomain (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.subdomain"]], "submit() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.submit"]], "successful_response() (in module pagerduty)": [[3, "pagerduty.successful_response"]], "timeout (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.timeout"]], "total_call_count (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.total_call_count"]], "total_call_time (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.total_call_time"]], "trigger() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.trigger"]], "trunc_key (pagerduty.apiclient property)": [[3, "pagerduty.ApiClient.trunc_key"]], "trunc_token (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.trunc_token"]], "truncate_text() (in module pagerduty)": [[3, "pagerduty.truncate_text"]], "try_decoding() (in module pagerduty)": [[3, "pagerduty.try_decoding"]], "unwrap() (in module pagerduty)": [[3, "pagerduty.unwrap"]], "url (pagerduty.restapiv2client attribute)": [[3, "pagerduty.RestApiV2Client.url"]], "wrapped_entities() (in module pagerduty)": [[3, "pagerduty.wrapped_entities"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["changelog", "contributing", "index", "module_reference", "pdpyras_migration_guide", "user_guide"], "filenames": ["changelog.rst", "contributing.rst", "index.rst", "module_reference.rst", "pdpyras_migration_guide.rst", "user_guide.rst"], "titles": ["Changelog", "Contribution Guide", "python-pagerduty: Clients for PagerDuty\u2019s APIs", "Module Reference", "PDPYRAS Migration Guide", "User Guide"], "terms": {"2025": 0, "01": 0, "02": 0, "migrat": [0, 2], "from": [0, 1, 2, 3, 4], "pdpyra": [0, 1, 2], "version": [0, 2, 3, 4], "1": [0, 1, 3, 4, 5], "0": [0, 1, 3, 4, 5], "break": 0, "chang": [0, 2, 3, 4, 5], "class": [0, 1, 2, 5], "name": [0, 1, 3, 4, 5], "have": [0, 1, 3, 4, 5], "what": [0, 3, 5], "thei": [0, 1, 3, 5], "were": 0, "see": [0, 1, 3, 5], "guid": [0, 2, 3], "The": [0, 1, 2, 3, 4], "rest": [0, 1, 2, 3], "api": [0, 1, 4], "client": [0, 1], "now": 0, "support": [0, 2, 3, 4, 5], "new": [0, 2, 3, 5], "statu": [0, 3, 5], "page": [0, 2, 3, 5], "event": [0, 2, 3, 4], "orchestr": 0, "custom": [0, 3, 5], "incid": [0, 1, 3, 5], "field": [0, 3], "oauth": [0, 3], "deleg": 0, "alert": [0, 3, 5], "group": [0, 5], "set": [0, 2, 3, 5], "bug": [1, 3], "report": [1, 3], "pull": 1, "request": [1, 2, 3], "fix": [1, 3], "issu": [1, 3, 4, 5], "ar": [1, 3, 4, 5], "alwai": [1, 3, 5], "welcom": 1, "built": 1, "If": [1, 3, 5], "featur": [1, 2, 3], "make": [1, 3, 4, 5], "i": [1, 3, 4, 5], "recommend": [1, 3, 5], "add": [1, 3, 5], "assert": 1, "appropri": [1, 3, 5], "case": [1, 2, 3, 4], "test_pagerduti": 1, "py": 1, "ensur": 1, "code": [1, 3, 4, 5], "coverag": 1, "": [1, 3, 4, 5], "pleas": [1, 3], "reproduc": 1, "along": 1, "themselv": 1, "includ": [1, 3, 4, 5], "github": [1, 2], "number": [1, 3, 5], "commit": 1, "messag": [1, 3, 5], "To": [1, 3, 5], "abl": 1, "rebuild": 1, "first": [1, 3, 4, 5], "sure": 1, "you": [1, 3], "pip": [1, 5], "your": [1, 5], "shell": 1, "environ": 1, "next": [1, 5], "python": [1, 4, 5], "depend": 1, "build": [1, 5], "well": [1, 5], "local": 1, "r": [1, 3, 5], "requir": [1, 3, 5], "txt": 1, "assum": [1, 3, 5], "all": [1, 3, 4, 5], "root": [1, 3, 5], "repositori": [1, 2], "suit": 1, "typic": [1, 3, 5], "kei": [1, 3, 5], "respons": [1, 2, 3], "schema": [1, 2, 3], "can": [1, 3, 5], "infer": [1, 3], "last": [1, 3], "second": [1, 3, 5], "node": [1, 3], "url": [1, 2], "singular": 1, "noun": 1, "an": [1, 3, 5], "individu": [1, 3], "resourc": [1, 3], "plural": [1, 3], "collect": [1, 3, 5], "when": [1, 3, 5], "v2": [1, 2, 3, 4], "don": 1, "t": [1, 3, 5], "follow": [1, 3, 4, 5], "thi": [1, 3, 4, 5], "orthodox": [1, 3], "pattern": [1, 3, 4], "pagin": [1, 2, 3], "wrap": [1, 2], "method": [1, 3, 4, 5], "priori": 1, "wai": [1, 3, 5], "them": [1, 3, 5], "becaus": [1, 3, 4, 5], "cannot": [1, 3], "grow": 1, "list": [1, 3, 5], "antipattern": [1, 3], "pagerduti": [1, 3, 4, 5], "product": [1, 3, 5], "system": [1, 3, 5], "wa": [1, 3, 4, 5], "creat": [1, 2, 3], "origin": [1, 4, 5], "5": [1, 3, 5], "work": [1, 3, 5], "around": [1, 3], "codifi": 1, "deviat": 1, "minim": 1, "hard": [1, 5], "identifi": [1, 2, 3], "accord": [1, 3, 5], "sai": [1, 5], "portion": 1, "placehold": 1, "variabl": [1, 3, 5], "us": [1, 2, 3, 4], "hash": 1, "lookup": 1, "handl": [1, 2], "two": [1, 4, 5], "global": [1, 3], "must": [1, 3, 5], "manual": [1, 5], "canonical_path": [1, 2, 3], "entity_wrapper_config": [1, 2, 3], "dictionari": [1, 3, 5], "except": [1, 2, 3, 5], "convent": [1, 3, 5], "There": [1, 3, 5], "three": [1, 3, 4, 5], "main": [1, 5], "categori": 1, "present": 1, "doesn": [1, 3, 5], "mai": [1, 3, 5], "implement": [1, 3], "standard": 1, "In": [1, 3, 4, 5], "still": [1, 3, 5], "classic": [1, 3, 5], "cursor": [1, 3, 5], "base": [1, 3, 5], "correctli": 1, "automat": [1, 3, 5], "also": [1, 3, 5], "onc": [1, 3, 5], "entri": [1, 3], "howev": [1, 5], "step": [1, 3, 5], "copi": 1, "refer": [1, 2, 5], "sourc": [1, 3, 4, 5], "privat": 1, "own": [1, 3], "org": 1, "script": 1, "get_path_list": 1, "gener": [1, 2, 3], "definit": 1, "cursor_based_pagination_path": [1, 2, 3], "replac": [1, 3, 4], "exist": [1, 3, 5], "take": [1, 3, 5], "one": [1, 3, 5], "argument": [1, 3, 5], "file": 1, "index": [1, 3, 5], "yaml": 1, "within": [1, 3], "look": [1, 4, 5], "each": [1, 3, 5], "ani": [1, 3, 5], "doe": [1, 3, 5], "logic": [1, 3, 5], "infer_entity_wrapp": [1, 3], "unwrap": [1, 3, 5], "where": [1, 3, 5], "compon": [1, 4], "separ": [1, 5], "forward": [1, 4], "slash": [1, 3, 5], "opaqu": 1, "correspond": [1, 3, 5], "both": [1, 3, 4, 5], "form": [1, 3], "exampl": [1, 2, 3], "put": [1, 3, 5], "escalation_polici": [1, 3, 5], "id": [1, 3, 5], "get": [1, 3, 5], "user": [1, 2, 3], "2": [1, 3, 5], "post": [1, 3, 5], "schedul": [1, 5], "3": [1, 3, 5], "otherwis": [1, 3, 5], "same": [1, 3, 5], "servic": [1, 2], "abov": [1, 3, 5], "appli": [1, 3], "need": [1, 3, 5], "virtu": 1, "preexist": [1, 3], "alreadi": [1, 3, 5], "do": [1, 5], "order": [1, 3, 4], "As": [1, 5], "describ": [1, 3], "attribut": [1, 3, 5], "combin": 1, "question": 1, "valu": [1, 3, 5], "string": [1, 3, 5], "bodi": [1, 3, 5], "none": [1, 3, 5], "applic": [1, 3, 5], "tupl": [1, 3], "differ": [1, 3, 4, 5], "between": [1, 3, 4, 5], "given": [1, 3, 5], "busi": [1, 5], "subscrib": [1, 5], "like": [1, 5], "business_servic": [1, 5], "subscript": [1, 5], "more": [1, 3, 4, 5], "overrid": [1, 3, 5], "rst": 1, "sphinx": 1, "most": [1, 3, 5], "live": 1, "html": 1, "doc": [1, 3], "forc": 1, "touch": 1, "changelog": [1, 2], "valid": [1, 3, 5], "account": [1, 3, 5], "pypi": [1, 2], "role": 1, "project": [1, 2], "It": [1, 3, 5], "strongli": 1, "token": [1, 3, 5], "upload": 1, "packag": [1, 5], "ha": [1, 3, 4, 5], "access": [1, 3, 5], "note": [1, 3, 4, 5], "longer": [1, 3, 5], "possibl": 1, "even": [1, 3], "delet": [1, 2, 3], "reason": [1, 3], "good": 1, "idea": 1, "suffix": [1, 3], "e": [1, 3, 4, 5], "dev001": 1, "__version__": 1, "while": [1, 2], "enter": 1, "credenti": [1, 3, 5], "prompt": 1, "testpublish": 1, "target": [1, 3, 5], "egg": 1, "dist": 1, "librari": [1, 5], "temporari": [1, 3], "virtualenv": 1, "time": [1, 3, 5], "upgrad": 1, "error": [1, 2, 4], "encount": [1, 3, 5], "should": [1, 3, 4], "immedi": [1, 3, 5], "exit": 1, "investig": 1, "mitig": 1, "befor": [1, 3, 5], "again": 1, "temporarili": 1, "so": [1, 3, 4, 5], "count": [1, 3, 5], "desir": [1, 5], "actual": [1, 3], "A": [1, 3], "which": [1, 3, 5], "function": [1, 2], "least": 1, "item": [1, 3], "commun": 1, "parenthes": 1, "contributor": 1, "link": [1, 3], "semant": 1, "rebuilt": 1, "after": [1, 3, 5], "view": 1, "open": [1, 5], "web": [1, 3, 5], "browser": 1, "help": [1, 3], "review": 1, "tool": 1, "approv": 1, "Then": 1, "checkout": 1, "git": 1, "v": 1, "c": 1, "import": [1, 4, 5], "print": [1, 3, 5], "push": 1, "clone": 1, "branch": 1, "check": [1, 3], "out": [1, 5], "latest": [1, 5], "avail": [1, 5], "tree": 1, "clean": 1, "uncommit": 1, "__token__": 1, "usernam": 1, "password": 1, "final": [1, 3, 5], "fill": 1, "some": [1, 3, 4, 5], "detail": [1, 3, 5], "select": 1, "choos": 1, "patch": [1, 3], "being": [1, 3, 5], "major": 1, "minor": 1, "veri": [1, 5], "brief": [1, 3], "summari": [1, 3, 5], "compos": [1, 3, 5], "descript": [1, 3], "whose": [1, 3, 5], "develop": [2, 3], "document": [2, 3, 5], "instal": 2, "authent": [2, 3], "non": [2, 3], "u": 2, "region": 2, "header": [2, 3], "basic": 2, "usag": [2, 3], "queri": [2, 3], "paramet": [2, 3], "data": [2, 3], "type": [2, 3], "entiti": 2, "endpoint": [2, 3], "awar": [2, 3], "special": [2, 3], "perform": [2, 3], "complet": [2, 3], "result": [2, 3], "updat": [2, 3], "multi": 2, "log": [2, 3], "proxi": 2, "server": [2, 3], "http": [2, 3], "retri": [2, 3], "configur": [2, 3], "default": 2, "behavior": [2, 3], "exponenti": 2, "cooldown": [2, 3], "modul": [2, 4, 5], "apicli": [2, 3, 4, 5], "restapiv2cli": [2, 3, 4, 5], "eventsapiv2cli": [2, 3, 4, 5], "httperror": [2, 3, 4, 5], "serverhttperror": [2, 3, 4], "urlerror": [2, 3, 4, 5], "iteration_limit": [2, 3], "text_len_limit": [2, 3], "timeout": [2, 3], "decor": 2, "helper": 2, "contribut": 2, "initi": [2, 3, 5], "setup": 2, "run": [2, 5], "unit": 2, "test": 2, "maintain": 2, "wrapper": [2, 3, 5], "introduct": 2, "limit": [2, 3, 5], "canon": [2, 3], "path": [2, 3, 5], "evalu": 2, "For": [2, 3, 5], "ad": [2, 3], "conform": 2, "releas": 2, "end": [2, 3, 5], "publish": 2, "merg": [2, 3, 4], "tag": 2, "cover": 3, "provid": 3, "api_kei": [3, 5], "str": 3, "debug": [3, 5], "fals": [3, 5], "opinion": 3, "session": [3, 5], "few": [3, 5], "addit": [3, 4, 5], "reattempt": 3, "auto": 3, "increas": [3, 5], "interv": 3, "attempt": [3, 5], "through": [3, 5], "specifi": [3, 5], "hoc": 3, "call": [3, 5], "verb": 3, "start": [3, 5], "prepend": 3, "onli": [3, 5], "permitted_method": 3, "rais": [3, 5], "other": [3, 5], "bool": 3, "print_debug": [3, 5], "true": [3, 5], "enabl": [3, 5], "verbos": 3, "command": [3, 5], "line": [3, 5], "output": [3, 5], "after_set_api_kei": 3, "setter": 3, "hook": 3, "child": 3, "properti": [3, 4, 5], "repres": [3, 5], "auth_head": 3, "dict": [3, 5], "logger": [3, 5], "object": [3, 5], "By": [3, 5], "without": [3, 5], "handler": [3, 5], "emit": 3, "max_http_attempt": [3, 5], "10": [3, 5], "status": [3, 5], "defin": [3, 5], "greater": 3, "than": [3, 5], "zero": 3, "max_network_attempt": [3, 5], "connect": 3, "treat": 3, "failur": 3, "transient": [3, 5], "happen": [3, 5], "normalize_param": 3, "param": [3, 5], "modifi": [3, 5], "suppli": [3, 5], "eas": 3, "current": [3, 5], "squar": [3, 5], "bracket": [3, 5], "append": [3, 5], "keep": [3, 5], "filter": [3, 5], "return": [3, 5], "modif": 3, "normalize_url": 3, "whether": [3, 5], "parent": [3, 5], "super": 3, "permit": 3, "instanc": [3, 4, 5], "accept": [3, 5], "postprocess": 3, "supplement": 3, "action": [3, 5], "receiv": [3, 5], "per": [3, 5], "extend": 3, "prepare_head": 3, "user_head": 3, "upper": 3, "flag": 3, "level": [3, 5], "sy": [3, 5], "stderr": [3, 5], "notset": [3, 5], "remov": 3, "thu": [3, 5], "toggl": 3, "disabl": [3, 5], "kwarg": 3, "insensit": 3, "keyword": [3, 5], "pass": [3, 5], "int": 3, "effect": [3, 4, 5], "n": [3, 5], "up": [3, 5], "total": [3, 5], "whichev": 3, "429": [3, 5], "401": [3, 5], "sleep_tim": [3, 5], "factor": [3, 5], "rate": 3, "network": [3, 5], "followup": 3, "delai": 3, "equal": 3, "sleep_timer_bas": [3, 5], "power": 3, "how": [3, 5], "mani": 3, "been": [3, 4], "made": [3, 4, 5], "far": 3, "unless": [3, 5], "stagger_cooldown": [3, 5], "nonzero": [3, 5], "sleep": [3, 5], "amount": 3, "float": 3, "random": [3, 5], "wait": [3, 5], "dure": 3, "success": [3, 5], "adjust": 3, "plu": [3, 5], "uniformli": 3, "distribut": 3, "top": 3, "timer": [3, 5], "overal": [3, 5], "4": [3, 5], "wherea": 3, "just": 3, "avoid": [3, 4], "thunder": 3, "herd": 3, "potenti": 3, "caus": [3, 5], "simultan": 3, "concurr": 3, "consequ": 3, "consist": 3, "previou": 3, "60": 3, "sent": [3, 5], "determin": 3, "tcp": 3, "read": [3, 5], "trunc_kei": 3, "truncat": 3, "secur": 3, "displai": 3, "identif": 3, "purpos": 3, "default_from": [3, 5], "auth_typ": [3, 5], "oft": 3, "aspect": 3, "inherit": [3, 5], "email": [3, 5], "address": [3, 5], "oauth2": [3, 5], "bearer": 3, "member": 3, "api_call_count": 3, "record": [3, 5], "api_key_access": [3, 5], "memoiz": 3, "getter": 3, "Will": 3, "permiss": 3, "ui": 3, "administr": [3, 5], "api_tim": 3, "author": 3, "format": [3, 4], "default_page_s": 3, "100": [3, 5], "iter": [3, 5], "dict_al": [3, 5], "kw": 3, "represent": 3, "With": 3, "iter_al": [3, 5], "further": 3, "uniqu": [3, 5], "distinct": [3, 5], "omit": 3, "find": [3, 5], "exactli": [3, 5], "match": [3, 5], "expect": [3, 5], "ignor": [3, 5], "much": 3, "constrain": 3, "those": 3, "everi": 3, "download": 3, "compar": 3, "against": 3, "until": [3, 5], "found": [3, 5], "comparison": 3, "insenit": 3, "mostli": 3, "therefor": [3, 5], "similar": [3, 5], "charact": 3, "search": [3, 5], "reduc": 3, "pre": 3, "common": 3, "lowercas": 3, "interpret": 3, "said": [3, 5], "constraint": 3, "sensit": 3, "correct": 3, "term": 3, "querystr": 3, "lower": [3, 5], "exact": 3, "option": 3, "page_s": 3, "item_hook": 3, "content": [3, 5], "yield": [3, 5], "pagint": 3, "iter_cursor": [3, 5], "k": [3, 5], "numer": [3, 5], "arrai": [3, 5], "alter": 3, "preced": [3, 5], "dictat": 3, "callabl": 3, "invok": 3, "progress": 3, "seri": 3, "isn": 3, "knowabl": 3, "third": 3, "leav": 3, "confer": 3, "small": 3, "advantag": 3, "comput": 3, "posit": [3, 5], "jget": [3, 5], "json": [3, 5], "decod": [3, 5], "jpost": 3, "jput": 3, "list_al": [3, 5], "directli": [3, 5], "persist": [3, 5], "attr": 3, "idempot": [3, 5], "pair": [3, 5], "via": [3, 5], "underli": [3, 5], "ap": 3, "contain": [3, 5], "inform": 3, "metadata": [3, 5], "about": [3, 5], "rdelet": 3, "send": [3, 5], "self": [3, 5], "rget": [3, 5], "retriev": 3, "rpatch": 3, "workflow": 3, "integr": [3, 5], "integration_id": 3, "resource_url": 3, "rpost": [3, 5], "rput": [3, 5], "subdomain": 3, "total_call_count": 3, "total_call_tim": 3, "spent": 3, "trunc_token": 3, "com": [3, 5], "submit": [3, 5], "acknowledg": [3, 5], "dedup_kei": [3, 5], "dedupl": [3, 5], "state": [3, 5], "arg": 3, "routing_kei": [3, 5], "agent": 3, "resolv": [3, 5], "send_change_ev": 3, "payload": 3, "timestamp": 3, "custom_detail": 3, "href": 3, "text": 3, "deprec": 3, "rout": 3, "send_ev": 3, "trigger": [3, 5], "associ": [3, 5], "would": [3, 5], "human": 3, "readabl": 3, "iso8601": 3, "date": 3, "sever": 3, "critic": 3, "imag": 3, "wrong": 3, "affect": [3, 5], "conjunct": 3, "regard": 3, "impli": 3, "sole": 3, "experienc": 3, "4xx": 3, "descend": [3, 5], "backend": 3, "successfulli": 3, "strictli": 3, "easier": 3, "cleanli": 3, "guarante": 3, "its": [3, 5], "could": 3, "denot": 3, "thing": 3, "wherein": 3, "recevi": 3, "instead": [3, 5], "try": [3, 5], "pabc123": [3, 5], "status_cod": [3, 5], "els": [3, 5], "write": [3, 5], "fail": 3, "earli": 3, "ga": 3, "5xx": [3, 5], "unsupport": [3, 5], "malform": [3, 5], "input": [3, 5], "These": 3, "explicit": 3, "properli": 3, "capit": 3, "space": 3, "either": [3, 5], "marshal": 3, "unmarsh": 3, "under": [3, 5], "design": [3, 5], "transmit": 3, "apart": 3, "secondari": 3, "bear": [3, 5], "discard": [3, 5], "prevent": 3, "10000": 3, "maximum": [3, 5], "offset": [3, 5], "exce": 3, "enforc": 3, "side": 3, "someth": 3, "rather": 3, "short": [3, 5], "circuit": 3, "400": [3, 5], "longest": 3, "length": 3, "benefit": 3, "anyon": 3, "who": 3, "relat": [3, 5], "base_url": 3, "classifi": 3, "particular": [3, 5], "belong": 3, "explicitli": 3, "part": 3, "shown": [3, 4], "contact_method": 3, "contact": 3, "normal": [3, 5], "full": [3, 5], "endpoint_match": 3, "endpoint_pattern": 3, "uppercas": 3, "is_path_param": 3, "path_nod": 3, "arbitrari": 3, "rel": [3, 5], "exclud": 3, "trail": 3, "entity_wrapp": 3, "obtain": [3, 5], "element": 3, "signal": 3, "unmodifi": 3, "broadli": 3, "univers": 3, "predict": 3, "map": 3, "intend": 3, "subclass": [3, 5], "auto_json": 3, "requires_success": 3, "allow": [3, 5], "itself": [3, 5], "elimin": 3, "re": 3, "construct": [3, 5], "hold": 3, "wrapped_ent": 3, "encod": [3, 5], "catch": [3, 5], "reform": 3, "miscellan": 3, "deprecated_kwarg": 3, "deprecated_nam": 3, "warn": 3, "http_error_messag": 3, "context": [3, 5], "last_4": 3, "secret": [3, 5], "plural_nam": 3, "obj_typ": 3, "user_refer": [3, 5], "successful_respons": 3, "truncate_text": 3, "try_decod": 3, "renam": 4, "done": 4, "nomenclatur": 4, "clearli": 4, "reflect": 4, "hierarchi": 4, "relationship": 4, "respect": [4, 5], "clear": 4, "express": 4, "sed": 4, "style": 4, "substitut": 4, "g": [4, 5], "switch": 4, "equival": [4, 5], "overlap": 4, "changeeventsapisess": 4, "eventsapisess": 4, "apisess": 4, "pdsession": 4, "former": 4, "latter": 4, "trivial": 4, "enough": 4, "singl": [4, 5], "collis": 4, "pdclienterror": 4, "pdservererror": 4, "pdhttperror": 4, "topic": 5, "depth": 5, "constructor": 5, "client_oauth": 5, "oauth_token": 5, "events_cli": 5, "manag": 5, "do_appl": 5, "eu": 5, "outsid": 5, "instanti": 5, "admin": 5, "menu": 5, "certain": 5, "Its": 5, "tab": 5, "profil": 5, "deriv": 5, "necessari": 5, "unknown": 5, "ok": 5, "convert": 5, "sn": 5, "jane": 5, "example35": 5, "updated_us": 5, "user_data": 5, "user123": 5, "mcuserson": 5, "assign": 5, "user_id": 5, "phij789": 5, "5b": 5, "5d": 5, "updated_incid": 5, "fire": 5, "dusti": 5, "old": 5, "net": 5, "abc123": 5, "finish": 5, "head": 5, "autom": 5, "sinc": 5, "analog": 5, "j": 5, "though": 5, "lead": 5, "One": 5, "strip": 5, "place": 5, "everyth": 5, "simpli": 5, "serial": 5, "first_dan": 5, "dan": 5, "82": 5, "foo": 5, "foo_servic": 5, "team": 5, "50": 5, "plain": 5, "That": 5, "uuid": 5, "x": 5, "encapsul": 5, "insid": 5, "articl": 5, "analogu": 5, "structur": 5, "speak": 5, "consid": 5, "escal": 5, "polici": 5, "ep": 5, "escalation_rul": 5, "daili": 5, "engin": 5, "rotat": 5, "rule": 5, "new_rul": 5, "escalation_delay_in_minut": 5, "30": 5, "pam4fg": 5, "pi7dh85": 5, "schedule_refer": 5, "save": 5, "respond": 5, "anoth": 5, "usual": 5, "next_cursor": 5, "extract": 5, "specif": 5, "On": 5, "left": 5, "moreov": 5, "lack": 5, "unusu": 5, "vice": 5, "versa": 5, "incient": 5, "status_upd": 5, "created_overrid": 5, "pghi789": 5, "2023": 5, "07": 5, "01t00": 5, "00": 5, "04": 5, "02t00": 5, "peysgva": 5, "time_zon": 5, "utc": 5, "03t00": 5, "peysgvf": 5, "201": 5, "indic": 5, "fetch": 5, "dav": 5, "dave": 5, "david": 5, "bob": 5, "synchron": 5, "multipl": 5, "thread": 5, "higher": 5, "larg": 5, "volum": 5, "partial": 5, "wise": 5, "oper": 5, "erron": 5, "condit": 5, "presenc": 5, "sort": 5, "real": 5, "recalcul": 5, "skip": 5, "repeat": 5, "accordingli": 5, "process": 5, "edit": 5, "elabor": 5, "let": 5, "notebook": 5, "essenti": 5, "go": 5, "101st": 5, "201st": 5, "etc": 5, "tear": 5, "At": 5, "shift": 5, "becom": 5, "hundr": 5, "over": 5, "similarli": 5, "500": 5, "601": 5, "700": 5, "attach": 5, "opposit": 5, "bump": 5, "pdef456": 5, "incident_refer": 5, "effici": 5, "scope": 5, "login": 5, "prior": 5, "transport": 5, "involv": 5, "httpservererror": 5, "unexpect": 5, "404": 5, "pjkl678": 5, "unconfigur": 5, "defer": 5, "discret": 5, "streamhandl": 5, "host": 5, "traffic": 5, "42": 5, "187": 5, "port": 5, "4012": 5, "protocol": 5, "unsuccess": 5, "loop": 5, "unlimit": 5, "unauthor": 5, "invalid": 5, "period": 5, "expon": 5, "\u03c1": 5, "randomli": 5, "th": 5, "basi": 5, "abil": 5, "although": 5, "2xx": 5, "won": 5, "toward": 5, "supersed": 5, "low": 5, "reach": 5, "carri": 5, "four": 5, "8": 5, "16": 5, "paus": 5, "pnoexst": 5, "62": 5, "6": 5}, "objects": {"": [[3, 0, 0, "module-3", "pagerduty"]], "pagerduty": [[3, 1, 1, "", "ApiClient"], [3, 5, 1, "", "CANONICAL_PATHS"], [3, 5, 1, "", "CURSOR_BASED_PAGINATION_PATHS"], [3, 5, 1, "", "ENTITY_WRAPPER_CONFIG"], [3, 1, 1, "", "Error"], [3, 1, 1, "", "EventsApiV2Client"], [3, 1, 1, "", "HttpError"], [3, 5, 1, "", "ITERATION_LIMIT"], [3, 1, 1, "", "RestApiV2Client"], [3, 1, 1, "", "ServerHttpError"], [3, 5, 1, "", "TEXT_LEN_LIMIT"], [3, 5, 1, "", "TIMEOUT"], [3, 1, 1, "", "UrlError"], [3, 6, 1, "", "auto_json"], [3, 6, 1, "", "canonical_path"], [3, 6, 1, "", "deprecated_kwarg"], [3, 6, 1, "", "endpoint_matches"], [3, 6, 1, "", "entity_wrappers"], [3, 6, 1, "", "http_error_message"], [3, 6, 1, "", "infer_entity_wrapper"], [3, 6, 1, "", "is_path_param"], [3, 6, 1, "", "last_4"], [3, 6, 1, "", "normalize_url"], [3, 6, 1, "", "plural_name"], [3, 6, 1, "", "requires_success"], [3, 6, 1, "", "resource_url"], [3, 6, 1, "", "successful_response"], [3, 6, 1, "", "truncate_text"], [3, 6, 1, "", "try_decoding"], [3, 6, 1, "", "unwrap"], [3, 6, 1, "", "wrapped_entities"]], "pagerduty.ApiClient": [[3, 2, 1, "", "after_set_api_key"], [3, 3, 1, "", "api_key"], [3, 3, 1, "", "auth_header"], [3, 4, 1, "", "log"], [3, 4, 1, "", "max_http_attempts"], [3, 4, 1, "", "max_network_attempts"], [3, 2, 1, "", "normalize_params"], [3, 2, 1, "", "normalize_url"], [3, 4, 1, "", "parent"], [3, 4, 1, "", "permitted_methods"], [3, 2, 1, "", "postprocess"], [3, 2, 1, "", "prepare_headers"], [3, 3, 1, "", "print_debug"], [3, 2, 1, "", "request"], [3, 4, 1, "", "retry"], [3, 4, 1, "", "sleep_timer"], [3, 4, 1, "", "sleep_timer_base"], [3, 3, 1, "", "stagger_cooldown"], [3, 4, 1, "", "timeout"], [3, 3, 1, "", "trunc_key"]], "pagerduty.Error": [[3, 4, 1, "", "response"]], "pagerduty.EventsApiV2Client": [[3, 2, 1, "", "acknowledge"], [3, 2, 1, "", "post"], [3, 2, 1, "", "prepare_headers"], [3, 2, 1, "", "resolve"], [3, 2, 1, "", "send_change_event"], [3, 2, 1, "", "send_event"], [3, 2, 1, "", "submit"], [3, 2, 1, "", "trigger"]], "pagerduty.RestApiV2Client": [[3, 4, 1, "", "api_call_counts"], [3, 3, 1, "", "api_key_access"], [3, 4, 1, "", "api_time"], [3, 3, 1, "", "auth_type"], [3, 4, 1, "", "default_from"], [3, 4, 1, "", "default_page_size"], [3, 2, 1, "", "dict_all"], [3, 2, 1, "", "find"], [3, 2, 1, "", "iter_all"], [3, 2, 1, "", "iter_cursor"], [3, 2, 1, "", "jget"], [3, 2, 1, "", "jpost"], [3, 2, 1, "", "jput"], [3, 2, 1, "", "list_all"], [3, 2, 1, "", "persist"], [3, 2, 1, "", "postprocess"], [3, 2, 1, "", "rdelete"], [3, 2, 1, "", "rget"], [3, 2, 1, "", "rpatch"], [3, 2, 1, "", "rpost"], [3, 2, 1, "", "rput"], [3, 3, 1, "", "subdomain"], [3, 3, 1, "", "total_call_count"], [3, 3, 1, "", "total_call_time"], [3, 3, 1, "", "trunc_token"], [3, 4, 1, "", "url"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:attribute", "5": "py:data", "6": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "data", "Python data"], "6": ["py", "function", "Python function"]}, "titleterms": {"changelog": 0, "contribut": 1, "guid": [1, 4, 5], "initi": 1, "setup": 1, "run": 1, "unit": 1, "test": 1, "maintain": 1, "entiti": [1, 3, 5], "wrapper": 1, "configur": [1, 5], "introduct": 1, "limit": 1, "updat": [1, 5], "canon": 1, "path": 1, "set": 1, "evalu": 1, "new": 1, "endpoint": [1, 5], "For": 1, "support": 1, "ad": 1, "non": [1, 5], "conform": 1, "document": 1, "releas": 1, "version": 1, "perform": [1, 5], "end": 1, "publish": 1, "instal": [1, 5], "merg": 1, "chang": 1, "tag": 1, "python": 2, "pagerduti": 2, "client": [2, 3, 4, 5], "": 2, "api": [2, 3, 5], "extern": 2, "resourc": [2, 5], "tabl": 2, "content": 2, "modul": 3, "refer": 3, "class": [3, 4], "error": [3, 5], "default": [3, 5], "function": [3, 5], "url": [3, 5], "handl": [3, 5], "wrap": [3, 5], "decor": 3, "helper": 3, "pdpyra": 4, "migrat": 4, "except": 4, "user": 5, "authent": 5, "us": 5, "u": 5, "servic": 5, "region": 5, "The": 5, "from": 5, "header": 5, "basic": 5, "usag": 5, "exampl": 5, "rest": 5, "v2": 5, "event": 5, "gener": 5, "featur": 5, "queri": 5, "paramet": 5, "request": 5, "respons": 5, "data": 5, "type": 5, "schema": 5, "identifi": 5, "awar": 5, "special": 5, "case": 5, "pagin": 5, "complet": 5, "result": 5, "creat": 5, "delet": 5, "while": 5, "multi": 5, "log": 5, "proxi": 5, "server": 5, "http": 5, "retri": 5, "behavior": 5, "exponenti": 5, "cooldown": 5}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 58}, "alltitles": {"Contribution Guide": [[1, "contribution-guide"]], "Initial Setup": [[1, "initial-setup"]], "Running Unit Tests": [[1, "running-unit-tests"]], "Maintaining Entity Wrapper Configuration": [[1, "maintaining-entity-wrapper-configuration"]], "Introduction": [[1, "introduction"]], "Limitations": [[1, "limitations"]], "Updating the Canonical Path Set": [[1, "updating-the-canonical-path-set"]], "Evaluating New Endpoints For Support": [[1, "evaluating-new-endpoints-for-support"]], "Adding Support for Non-Conforming Endpoints": [[1, "adding-support-for-non-conforming-endpoints"]], "Updating Documentation": [[1, "updating-documentation"]], "Releasing a New Version": [[1, "releasing-a-new-version"]], "Perform end-to-end publish and installation testing": [[1, "perform-end-to-end-publish-and-installation-testing"]], "Merge changes and tag": [[1, "merge-changes-and-tag"]], "Publishing": [[1, "publishing"]], "python-pagerduty: Clients for PagerDuty\u2019s APIs": [[2, "python-pagerduty-clients-for-pagerduty-s-apis"]], "External Resources": [[2, "external-resources"]], "Table of Contents": [[2, "table-of-contents"]], "Module Reference": [[3, "module-reference"]], "API Client Classes": [[3, "api-client-classes"]], "Errors": [[3, "errors"]], "Client Defaults": [[3, "client-defaults"]], "Functions": [[3, "functions"]], "URL Handling": [[3, "url-handling"]], "Entity Wrapping": [[3, "entity-wrapping"], [5, "entity-wrapping"]], "Function Decorators": [[3, "function-decorators"]], "Helpers": [[3, "helpers"]], "Changelog": [[0, "changelog"]], "PDPYRAS Migration Guide": [[4, "pdpyras-migration-guide"]], "Client Classes": [[4, "client-classes"]], "Exception Classes": [[4, "exception-classes"]], "User Guide": [[5, "user-guide"]], "Installation": [[5, "installation"]], "Authentication": [[5, "authentication"]], "Using Non-US Service Regions": [[5, "using-non-us-service-regions"]], "The From header": [[5, "the-from-header"]], "Basic Usage Examples": [[5, "basic-usage-examples"]], "REST API v2": [[5, "rest-api-v2"]], "Events API v2": [[5, "events-api-v2"]], "Generic Client Features": [[5, "generic-client-features"]], "URLs": [[5, "urls"]], "Query Parameters": [[5, "query-parameters"]], "Requests and Responses": [[5, "requests-and-responses"]], "Data types": [[5, "data-types"]], "Resource Schemas": [[5, "resource-schemas"]], "Identifying Wrapped-entity Endpoints": [[5, "identifying-wrapped-entity-endpoints"]], "Wrapped-entity-aware Functions": [[5, "wrapped-entity-aware-functions"]], "Special Cases": [[5, "special-cases"]], "Examples": [[5, "examples"]], "Pagination": [[5, "pagination"]], "Performance and Completeness of Results": [[5, "performance-and-completeness-of-results"]], "Updating, creating or deleting while paginating": [[5, "updating-creating-or-deleting-while-paginating"]], "Multi-updating": [[5, "multi-updating"]], "Error Handling": [[5, "error-handling"]], "Logging": [[5, "logging"]], "Using a Proxy Server": [[5, "using-a-proxy-server"]], "HTTP Retry Configuration": [[5, "http-retry-configuration"]], "Default Behavior": [[5, "default-behavior"]], "Exponential Cooldown": [[5, "exponential-cooldown"]], "Configuring Retry Behavior": [[5, "configuring-retry-behavior"]]}, "indexentries": {"apiclient (class in pagerduty)": [[3, "pagerduty.ApiClient"]], "canonical_paths (in module pagerduty)": [[3, "pagerduty.CANONICAL_PATHS"]], "cursor_based_pagination_paths (in module pagerduty)": [[3, "pagerduty.CURSOR_BASED_PAGINATION_PATHS"]], "entity_wrapper_config (in module pagerduty)": [[3, "pagerduty.ENTITY_WRAPPER_CONFIG"]], "error (class in pagerduty)": [[3, "pagerduty.Error"]], "eventsapiv2client (class in pagerduty)": [[3, "pagerduty.EventsApiV2Client"]], "httperror (class in pagerduty)": [[3, "pagerduty.HttpError"]], "iteration_limit (in module pagerduty)": [[3, "pagerduty.ITERATION_LIMIT"]], "restapiv2client (class in pagerduty)": [[3, "pagerduty.RestApiV2Client"]], "serverhttperror (class in pagerduty)": [[3, "pagerduty.ServerHttpError"]], "text_len_limit (in module pagerduty)": [[3, "pagerduty.TEXT_LEN_LIMIT"]], "timeout (in module pagerduty)": [[3, "pagerduty.TIMEOUT"]], "urlerror (class in pagerduty)": [[3, "pagerduty.UrlError"]], "acknowledge() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.acknowledge"]], "after_set_api_key() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.after_set_api_key"]], "api_call_counts (pagerduty.restapiv2client attribute)": [[3, "pagerduty.RestApiV2Client.api_call_counts"]], "api_key (pagerduty.apiclient property)": [[3, "pagerduty.ApiClient.api_key"]], "api_key_access (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.api_key_access"]], "api_time (pagerduty.restapiv2client attribute)": [[3, "pagerduty.RestApiV2Client.api_time"]], "auth_header (pagerduty.apiclient property)": [[3, "pagerduty.ApiClient.auth_header"]], "auth_type (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.auth_type"]], "auto_json() (in module pagerduty)": [[3, "pagerduty.auto_json"]], "canonical_path() (in module pagerduty)": [[3, "pagerduty.canonical_path"]], "default_from (pagerduty.restapiv2client attribute)": [[3, "pagerduty.RestApiV2Client.default_from"]], "default_page_size (pagerduty.restapiv2client attribute)": [[3, "pagerduty.RestApiV2Client.default_page_size"]], "deprecated_kwarg() (in module pagerduty)": [[3, "pagerduty.deprecated_kwarg"]], "dict_all() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.dict_all"]], "endpoint_matches() (in module pagerduty)": [[3, "pagerduty.endpoint_matches"]], "entity_wrappers() (in module pagerduty)": [[3, "pagerduty.entity_wrappers"]], "find() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.find"]], "http_error_message() (in module pagerduty)": [[3, "pagerduty.http_error_message"]], "infer_entity_wrapper() (in module pagerduty)": [[3, "pagerduty.infer_entity_wrapper"]], "is_path_param() (in module pagerduty)": [[3, "pagerduty.is_path_param"]], "iter_all() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.iter_all"]], "iter_cursor() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.iter_cursor"]], "jget() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.jget"]], "jpost() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.jpost"]], "jput() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.jput"]], "last_4() (in module pagerduty)": [[3, "pagerduty.last_4"]], "list_all() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.list_all"]], "log (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.log"]], "max_http_attempts (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.max_http_attempts"]], "max_network_attempts (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.max_network_attempts"]], "module": [[3, "module-0"], [3, "module-1"], [3, "module-2"], [3, "module-3"], [3, "module-pagerduty"]], "normalize_params() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.normalize_params"]], "normalize_url() (in module pagerduty)": [[3, "pagerduty.normalize_url"]], "normalize_url() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.normalize_url"]], "pagerduty": [[3, "module-0"], [3, "module-1"], [3, "module-2"], [3, "module-3"], [3, "module-pagerduty"]], "parent (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.parent"]], "permitted_methods (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.permitted_methods"]], "persist() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.persist"]], "plural_name() (in module pagerduty)": [[3, "pagerduty.plural_name"]], "post() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.post"]], "postprocess() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.postprocess"]], "postprocess() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.postprocess"]], "prepare_headers() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.prepare_headers"]], "prepare_headers() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.prepare_headers"]], "print_debug (pagerduty.apiclient property)": [[3, "pagerduty.ApiClient.print_debug"]], "rdelete() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.rdelete"]], "request() (pagerduty.apiclient method)": [[3, "pagerduty.ApiClient.request"]], "requires_success() (in module pagerduty)": [[3, "pagerduty.requires_success"]], "resolve() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.resolve"]], "resource_url() (in module pagerduty)": [[3, "pagerduty.resource_url"]], "response (pagerduty.error attribute)": [[3, "pagerduty.Error.response"]], "retry (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.retry"]], "rget() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.rget"]], "rpatch() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.rpatch"]], "rpost() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.rpost"]], "rput() (pagerduty.restapiv2client method)": [[3, "pagerduty.RestApiV2Client.rput"]], "send_change_event() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.send_change_event"]], "send_event() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.send_event"]], "sleep_timer (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.sleep_timer"]], "sleep_timer_base (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.sleep_timer_base"]], "stagger_cooldown (pagerduty.apiclient property)": [[3, "pagerduty.ApiClient.stagger_cooldown"]], "subdomain (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.subdomain"]], "submit() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.submit"]], "successful_response() (in module pagerduty)": [[3, "pagerduty.successful_response"]], "timeout (pagerduty.apiclient attribute)": [[3, "pagerduty.ApiClient.timeout"]], "total_call_count (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.total_call_count"]], "total_call_time (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.total_call_time"]], "trigger() (pagerduty.eventsapiv2client method)": [[3, "pagerduty.EventsApiV2Client.trigger"]], "trunc_key (pagerduty.apiclient property)": [[3, "pagerduty.ApiClient.trunc_key"]], "trunc_token (pagerduty.restapiv2client property)": [[3, "pagerduty.RestApiV2Client.trunc_token"]], "truncate_text() (in module pagerduty)": [[3, "pagerduty.truncate_text"]], "try_decoding() (in module pagerduty)": [[3, "pagerduty.try_decoding"]], "unwrap() (in module pagerduty)": [[3, "pagerduty.unwrap"]], "url (pagerduty.restapiv2client attribute)": [[3, "pagerduty.RestApiV2Client.url"]], "wrapped_entities() (in module pagerduty)": [[3, "pagerduty.wrapped_entities"]]}})
\ No newline at end of file
diff --git a/docs/user_guide.html b/docs/user_guide.html
index 434199e..6d1799f 100644
--- a/docs/user_guide.html
+++ b/docs/user_guide.html
@@ -123,7 +123,7 @@
 has in-depth documentation on client classes and methods.

 

 
Installation

-
This library is available on PyPI as pagerduty, e.g.:

+
This library is available on the Python Package Index as pagerduty, e.g.:

 
pip install pagerduty
 

 

@@ -736,13 +736,13 @@ 
Exponential Cooldown
 
Let:

 
-
Assuming ρ = 0:

+
Assuming ρ = 0 (the default value):

 
tn = t0 an

 
If ρ is nonzero:

 
tn = a (1 + ρ rn) tn-1

diff --git a/sphinx/source/pdpyras_migration_guide.rst b/sphinx/source/pdpyras_migration_guide.rst
index 128fd4f..5051ccf 100644
--- a/sphinx/source/pdpyras_migration_guide.rst
+++ b/sphinx/source/pdpyras_migration_guide.rst
@@ -9,19 +9,22 @@ from the original `pdpyras`_ source code. This was done so that nomenclature
 clearly reflects the hierarchy of APIs and errors, and to make the relationship
 between API clients and their respective APIs more clear.
 
-The following replacements are expressed in `sed-style substitution format
+Replacements are expressed in `sed-style substitution format
 `_,
-i.e. if replacing all instances of ``{{pattern}}`` with ``{{replacement}}``:
+i.e. if replacing all instances of ``{{pattern}}`` with ``{{replacement}}``,
+the pattern is ``s/{{pattern}}/{{replacement}}/g``.
 
-::
+The first substitution that should be made is ``s/pdpyras/pagerduty/g``, i.e.
 
-   s/{{pattern}}/{{replacement}}/g
+::
 
+    - import pdpyras
+    + import pagerduty
 
 Client Classes
 --------------
-In downstream code that uses `pdpyras`_, the following name replacements
-should be made in order to switch to using `python-pagerduty`. **The first
+In code that uses `pdpyras`_, the following class name replacements should be
+made to switch to using their equivalents in `python-pagerduty`. **The first
 three should be done in the order shown, so as to avoid name overlap issues:**
 
 1. ``s/ChangeEventsAPISession/EventsApiV2Client/g``
@@ -29,7 +32,7 @@ three should be done in the order shown, so as to avoid name overlap issues:**
 3. ``s/APISession/RestApiV2Client/g``
 4. ``s/PDSession/ApiClient/g``
 
-The Change Events API client has been merged into the Events API v2 client
+Note, the Change Events API client has been merged into the Events API v2 client
 because the former API is effectively a component of the latter. The
 differences are trivial enough to support both use cases with a single client
 class, and there are no method or property name collisions between the two
diff --git a/sphinx/source/user_guide.rst b/sphinx/source/user_guide.rst
index e83c9ac..a598484 100644
--- a/sphinx/source/user_guide.rst
+++ b/sphinx/source/user_guide.rst
@@ -11,7 +11,7 @@ has in-depth documentation on client classes and methods.
 
 Installation
 ------------
-This library is available on PyPI as `pagerduty `_, e.g.: 
+This library is available on the Python Package Index as `pagerduty `_, e.g.: 
 
 .. code-block:: bash
 
@@ -705,13 +705,13 @@ increases exponentially with each retry.
 
 Let:
 
-* a = :attr:`pagerduty.ApiClient.sleep_timer_base`
-* t\ :sub:`0` = ``sleep_timer``
+* a = :attr:`pagerduty.ApiClient.sleep_timer_base` (base of the exponent, default value ``2``)
+* t\ :sub:`0` = :attr:`pagerduty.ApiClient.sleep_timer` (initial sleep timer, default value ``1.5``)
 * t\ :sub:`n` = Sleep time after n attempts
 * ρ = :attr:`pagerduty.ApiClient.stagger_cooldown`
 * r\ :sub:`n` = a randomly-generated real number between 0 and 1, distinct for each n-th request
 
-Assuming ρ = 0:
+Assuming ρ = 0 (the default value):
 
 t\ :sub:`n` = t\ :sub:`0` a\ :sup:`n`