wallet.CustomerApi

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

Method	HTTP request	Description
fetch_active_vouchers	GET /v2/customer/vouchers/active	Fetch active static vouchers
fetch_all_vouchers	GET /v2/customer/vouchers/all	Fetch all static vouchers
fetch_expired_vouchers	GET /v2/customer/vouchers/expired	Fetch expired static vouchers
fetch_redeemed_vouchers	GET /v2/customer/vouchers/redeemed	Fetch redeemed static vouchers
fetch_refunded_vouchers	GET /v2/customer/vouchers/refunded	Fetch refunded static vouchers
fetch_upcoming_vouchers	GET /v2/customer/vouchers/upcoming	Fetch upcoming static vouchers
fetch_wallet_views_for_session	GET /v2/customer/walletViews/session/{id}	Fetch Wallet Views for Session
search_by_member_id	POST /v2/customer/search/memberID	Find members with memberID
search_by_phone_number	POST /v2/customer/search/phoneNumber	Find members with phone number

fetch_active_vouchers

List[StaticVoucher] fetch_active_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)

Fetch active static vouchers

Example

import wallet
from wallet.models.static_voucher import StaticVoucher
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.CustomerApi(api_client)
    member_id = 'member_id_example' # str |  (optional)
    cell_phone_number = 'cell_phone_number_example' # str |  (optional)

    try:
        # Fetch active static vouchers
        api_response = api_instance.fetch_active_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)
        print("The response of CustomerApi->fetch_active_vouchers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomerApi->fetch_active_vouchers: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_id	str		[optional]
cell_phone_number	str		[optional]

Return type

List[StaticVoucher]

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]

fetch_all_vouchers

List[StaticVoucher] fetch_all_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)

Fetch all static vouchers

Example

import wallet
from wallet.models.static_voucher import StaticVoucher
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.CustomerApi(api_client)
    member_id = 'member_id_example' # str |  (optional)
    cell_phone_number = 'cell_phone_number_example' # str |  (optional)

    try:
        # Fetch all static vouchers
        api_response = api_instance.fetch_all_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)
        print("The response of CustomerApi->fetch_all_vouchers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomerApi->fetch_all_vouchers: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_id	str		[optional]
cell_phone_number	str		[optional]

Return type

List[StaticVoucher]

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]

fetch_expired_vouchers

List[StaticVoucher] fetch_expired_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)

Fetch expired static vouchers

Example

import wallet
from wallet.models.static_voucher import StaticVoucher
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.CustomerApi(api_client)
    member_id = 'member_id_example' # str |  (optional)
    cell_phone_number = 'cell_phone_number_example' # str |  (optional)

    try:
        # Fetch expired static vouchers
        api_response = api_instance.fetch_expired_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)
        print("The response of CustomerApi->fetch_expired_vouchers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomerApi->fetch_expired_vouchers: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_id	str		[optional]
cell_phone_number	str		[optional]

Return type

List[StaticVoucher]

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]

fetch_redeemed_vouchers

List[StaticVoucher] fetch_redeemed_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)

Fetch redeemed static vouchers

Example

import wallet
from wallet.models.static_voucher import StaticVoucher
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.CustomerApi(api_client)
    member_id = 'member_id_example' # str |  (optional)
    cell_phone_number = 'cell_phone_number_example' # str |  (optional)

    try:
        # Fetch redeemed static vouchers
        api_response = api_instance.fetch_redeemed_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)
        print("The response of CustomerApi->fetch_redeemed_vouchers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomerApi->fetch_redeemed_vouchers: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_id	str		[optional]
cell_phone_number	str		[optional]

Return type

List[StaticVoucher]

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]

fetch_refunded_vouchers

List[StaticVoucher] fetch_refunded_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)

Fetch refunded static vouchers

Example

import wallet
from wallet.models.static_voucher import StaticVoucher
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.CustomerApi(api_client)
    member_id = 'member_id_example' # str |  (optional)
    cell_phone_number = 'cell_phone_number_example' # str |  (optional)

    try:
        # Fetch refunded static vouchers
        api_response = api_instance.fetch_refunded_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)
        print("The response of CustomerApi->fetch_refunded_vouchers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomerApi->fetch_refunded_vouchers: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_id	str		[optional]
cell_phone_number	str		[optional]

Return type

List[StaticVoucher]

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]

fetch_upcoming_vouchers

List[StaticVoucher] fetch_upcoming_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)

Fetch upcoming static vouchers

Example

import wallet
from wallet.models.static_voucher import StaticVoucher
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.CustomerApi(api_client)
    member_id = 'member_id_example' # str |  (optional)
    cell_phone_number = 'cell_phone_number_example' # str |  (optional)

    try:
        # Fetch upcoming static vouchers
        api_response = api_instance.fetch_upcoming_vouchers(member_id=member_id, cell_phone_number=cell_phone_number)
        print("The response of CustomerApi->fetch_upcoming_vouchers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomerApi->fetch_upcoming_vouchers: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_id	str		[optional]
cell_phone_number	str		[optional]

Return type

List[StaticVoucher]

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]

fetch_wallet_views_for_session

List[WalletPageView] fetch_wallet_views_for_session(id)

Fetch Wallet Views for Session

Example

import wallet
from wallet.models.wallet_page_view import WalletPageView
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.CustomerApi(api_client)
    id = 'id_example' # str | 

    try:
        # Fetch Wallet Views for Session
        api_response = api_instance.fetch_wallet_views_for_session(id)
        print("The response of CustomerApi->fetch_wallet_views_for_session:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomerApi->fetch_wallet_views_for_session: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

List[WalletPageView]

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]

search_by_member_id

object search_by_member_id(wt_customer_search_by_member_id)

Find members with memberID

Example

import wallet
from wallet.models.wt_customer_search_by_member_id import WTCustomerSearchByMemberID
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.CustomerApi(api_client)
    wt_customer_search_by_member_id = wallet.WTCustomerSearchByMemberID() # WTCustomerSearchByMemberID | 

    try:
        # Find members with memberID
        api_response = api_instance.search_by_member_id(wt_customer_search_by_member_id)
        print("The response of CustomerApi->search_by_member_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomerApi->search_by_member_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
wt_customer_search_by_member_id	WTCustomerSearchByMemberID

Return type

object

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]

search_by_phone_number

object search_by_phone_number(wt_customer_search_by_phone_number)

Find members with phone number

Example

import wallet
from wallet.models.wt_customer_search_by_phone_number import WTCustomerSearchByPhoneNumber
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.CustomerApi(api_client)
    wt_customer_search_by_phone_number = wallet.WTCustomerSearchByPhoneNumber() # WTCustomerSearchByPhoneNumber | 

    try:
        # Find members with phone number
        api_response = api_instance.search_by_phone_number(wt_customer_search_by_phone_number)
        print("The response of CustomerApi->search_by_phone_number:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomerApi->search_by_phone_number: %s\n" % e)

Parameters

Name	Type	Description	Notes
wt_customer_search_by_phone_number	WTCustomerSearchByPhoneNumber

Return type

object

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]

Files

CustomerApi.md

Latest commit

History

CustomerApi.md

File metadata and controls

wallet.CustomerApi

fetch_active_vouchers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_all_vouchers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_expired_vouchers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_redeemed_vouchers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_refunded_vouchers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_upcoming_vouchers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_wallet_views_for_session

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

search_by_member_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

search_by_phone_number

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details