1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Files
peeringdb-peeringdb/docs/dev/modules/deskpro.py.md
Matt Griswold 505760aa8d Support 202203 (#1144)
* Do not show objects in status "pending" on the UI #784

* Fix peeringdb.js bug introduced in #784

* 500 Error during login for 2FA enabled accounts with unverified email address #996

* Django-Admin: adding a network with existing asn fails with internal error #1035

* Some command-line-tool executions are not logged #1119

* Ops: API throttling of repeated requests #1126

* Ops: response header X-Auth-ID to augment logging #1120

* Allow rate-limiting of melissa enabled api functionality. #1124

* State / Province normalization #1079

* Log melissa requests #1122

* remove debug messages

* bump django-handleref to 1.0.2

* Need consolidated app logs #845

* pin django peeringdb to 2.13 and relock poetry

* pin django-restframework-apikey to 2.1.0

* linting

* migrations

* docs regenerate

* docs

* linting

Co-authored-by: David Poarch <dpoarch@20c.com>
Co-authored-by: Stefan Pratter <stefan@20c.com>
2022-04-12 15:39:19 -05:00

121 lines
2.1 KiB
Markdown

Generated from deskpro.py on 2022-04-12 16:41:02.631987
# peeringdb_server.deskpro
DeskPro API Client used to post and retrieve support ticket information
from the deskpro API.
# Functions
---
## ticket_queue
`def ticket_queue(subject, body, user)`
Queue a deskpro ticket for creation.
---
## ticket_queue_asnauto_affil
`def ticket_queue_asnauto_affil(user, org, net, rir_data)`
Queue deskro ticket creation for asn automation action: affil.
---
## ticket_queue_asnauto_create
`def ticket_queue_asnauto_create(user, org, net, rir_data, asn, org_created=False, net_created=False)`
Queue deskro ticket creation for asn automation action: create.
---
## ticket_queue_asnauto_skipvq
`def ticket_queue_asnauto_skipvq(request, org, net, rir_data)`
Queue deskro ticket creation for asn automation action: skip vq.
---
## ticket_queue_deletion_prevented
`def ticket_queue_deletion_prevented(request, instance)`
Queue deskpro ticket to notify the prevented
deletion of an object #696.
---
## ticket_queue_email_only
`def ticket_queue_email_only(subject, body, email)`
Queue a deskpro ticket for creation.
---
# Classes
---
## APIError
```
APIError(builtins.OSError)
```
Base class for I/O related errors.
### Methods
#### \__init__
`def __init__(self, msg, data)`
Initialize self. See help(type(self)) for accurate signature.
---
## FailingMockAPIClient
```
FailingMockAPIClient(peeringdb_server.deskpro.MockAPIClient)
```
A mock API client for the deskpro API
that returns an error on post.
Use in tests, for example
with issue 856.
### Methods
#### \__init__
`def __init__(self, *args, **kwargs)`
Initialize self. See help(type(self)) for accurate signature.
---
#### create_ticket
`def create_ticket(self, ticket=None)`
Create a deskpro ticket using the deskpro API.
Arguments:
- ticket (`DeskProTicket`)
---
## MockAPIClient
```
MockAPIClient(peeringdb_server.deskpro.APIClient)
```
A mock API client for the deskpro API.
The IX-F importer uses this when
IXF_SEND_TICKETS=False
### Methods
#### \__init__
`def __init__(self, *args, **kwargs)`
Initialize self. See help(type(self)) for accurate signature.
---