Files
Stefan Pratter 5eb925e319 Support 202301 (#1329)
* fix next redirect when using U2F 2FA auth (#1191)

* Added self identifier to API

* fix migrations hierarchy after merging in previous support branch

* campus object

Co-authored-by: Stefan Pratter <stefan@20c.com>

* fix out of bound error message
add city / country to campus view

* fix tests

* relock poetry

* linting

* linting

* fix docs regen

* regen docs

* linting

* refactor self entity view to support carrier and campus object types and also make it easier to support additional object types in the future

* remove debug message

---------

Co-authored-by: Gajanan Patil <dipaksavaliya.python@gmail.com>
2023-02-15 07:55:01 +00:00

121 lines
2.1 KiB
Markdown

Generated from deskpro.py on 2023-02-14 15:33:37.135106
# 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.
---