Skip to content

HelpDeskApi.md

Latest commit

 

History

History
221 lines (148 loc) · 6.61 KB

HelpDeskApi.md

File metadata and controls

221 lines (148 loc) · 6.61 KB
Raw

wallet.HelpDeskApi

All URIs are relative to https://api.wall.et

Method HTTP request Description
fetch_help_desk_requests GET /v2/merchant/helpDeskRequests/{phoneNumberID} Get help desk requests
send_help_desk_response POST /v2/employee/helpDesk/response Send help desk response
set_help_desk_request_resolved PATCH /v2/employee/helpDesk/request/{helpDeskRequestID} Resolve help desk request

fetch_help_desk_requests

List[HelpDeskRequest] fetch_help_desk_requests(phone_number_id, is_resolved=is_resolved)

Get help desk requests

Example

import wallet
from wallet.models.help_desk_request import HelpDeskRequest
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.HelpDeskApi(api_client)
    phone_number_id = 'phone_number_id_example' # str | 
    is_resolved = True # bool |  (optional)

    try:
        # Get help desk requests
        api_response = api_instance.fetch_help_desk_requests(phone_number_id, is_resolved=is_resolved)
        print("The response of HelpDeskApi->fetch_help_desk_requests:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HelpDeskApi->fetch_help_desk_requests: %s\n" % e)

Parameters

Name Type Description Notes
phone_number_id str
is_resolved bool [optional]

Return type

List[HelpDeskRequest]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

send_help_desk_response

OutboundSMS send_help_desk_response(wt_employee_send_help_desk_response)

Send help desk response

Example

import wallet
from wallet.models.outbound_sms import OutboundSMS
from wallet.models.wt_employee_send_help_desk_response import WTEmployeeSendHelpDeskResponse
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.HelpDeskApi(api_client)
    wt_employee_send_help_desk_response = wallet.WTEmployeeSendHelpDeskResponse() # WTEmployeeSendHelpDeskResponse | 

    try:
        # Send help desk response
        api_response = api_instance.send_help_desk_response(wt_employee_send_help_desk_response)
        print("The response of HelpDeskApi->send_help_desk_response:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HelpDeskApi->send_help_desk_response: %s\n" % e)

Parameters

Name Type Description Notes
wt_employee_send_help_desk_response WTEmployeeSendHelpDeskResponse

Return type

OutboundSMS

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_help_desk_request_resolved

HelpDeskRequest set_help_desk_request_resolved(help_desk_request_id)

Resolve help desk request

Example

import wallet
from wallet.models.help_desk_request import HelpDeskRequest
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.HelpDeskApi(api_client)
    help_desk_request_id = 'help_desk_request_id_example' # str | 

    try:
        # Resolve help desk request
        api_response = api_instance.set_help_desk_request_resolved(help_desk_request_id)
        print("The response of HelpDeskApi->set_help_desk_request_resolved:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HelpDeskApi->set_help_desk_request_resolved: %s\n" % e)

Parameters

Name Type Description Notes
help_desk_request_id str

Return type

HelpDeskRequest

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]