Skip to content

bind-com/xprizo-sdk-py

BranchesTags

Repository files navigation

xprizo-sdk-py

Xprizo api endpoints

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.1
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.7

Migration from other generators like python and python-legacy

Changes

  1. This generator uses spec case for all (object) property names and parameter names.
    • So if the spec has a property name like camelCase, it will use camelCase rather than camel_case
    • So you will need to update how you input and read properties to use spec case
  2. Endpoint parameters are stored in dictionaries to prevent collisions (explanation below)
    • So you will need to update how you pass data in to endpoints
  3. Endpoint responses now include the original response, the deserialized response body, and (todo)the deserialized headers
    • So you will need to update your code to use response.body to access deserialized data
  4. All validated data is instantiated in an instance that subclasses all validated Schema classes and Decimal/str/list/tuple/frozendict/NoneClass/BoolClass/bytes/io.FileIO
    • This means that you can use isinstance to check if a payload validated against a schema class
    • This means that no data will be of type None/True/False
      • ingested None will subclass NoneClass
      • ingested True will subclass BoolClass
      • ingested False will subclass BoolClass
      • So if you need to check is True/False/None, instead use instance.is_true_oapg()/.is_false_oapg()/.is_none_oapg()
  5. All validated class instances are immutable except for ones based on io.File
    • This is because if properties were changed after validation, that validation would no longer apply
    • So no changing values or property values after a class has been instantiated
  6. String + Number types with formats
    • String type data is stored as a string and if you need to access types based on its format like date, date-time, uuid, number etc then you will need to use accessor functions on the instance
    • type string + format: See .as_date_oapg, .as_datetime_oapg, .as_decimal_oapg, .as_uuid_oapg
    • type number + format: See .as_float_oapg, .as_int_oapg
    • this was done because openapi/json-schema defines constraints. string data may be type string with no format keyword in one schema, and include a format constraint in another schema
    • So if you need to access a string format based type, use as_date_oapg/as_datetime_oapg/as_decimal_oapg/as_uuid_oapg
    • So if you need to access a number format based type, use as_int_oapg/as_float_oapg
  7. Property access on AnyType(type unset) or object(dict) schemas
    • Only required keys with valid python names are properties like .someProp and have type hints
    • All optional keys may not exist, so properties are not defined for them
    • One can access optional values with dict_instance['optionalProp'] and KeyError will be raised if it does not exist
    • Use get_item_oapg if you need a way to always get a value whether or not the key exists
      • If the key does not exist, schemas.unset is returned from calling dict_instance.get_item_oapg('optionalProp')
      • All required and optional keys have type hints for this method, and @typing.overload is used
      • A type hint is also generated for additionalProperties accessed using this method
    • So you will need to update you code to use some_instance['optionalProp'] to access optional property and additionalProperty values
  8. The location of the api classes has changed
    • Api classes are located in your_package.apis.tags.some_api
    • This change was made to eliminate redundant code generation
    • Legacy generators generated the same endpoint twice if it had > 1 tag on it
    • This generator defines an endpoint in one class, then inherits that class to generate apis by tags and by paths
    • This change reduces code and allows quicker run time if you use the path apis
      • path apis are at your_package.apis.paths.some_path
    • Those apis will only load their needed models, which is less to load than all of the resources needed in a tag api
    • So you will need to update your import paths to the api classes

Why are Oapg and _oapg used in class and method names?

Classes can have arbitrarily named properties set on them Endpoints can have arbitrary operationId method names set For those reasons, I use the prefix Oapg and _oapg to greatly reduce the likelihood of collisions on protected + public classes/methods. oapg stands for OpenApi Python Generator.

Object property spec case

This was done because when payloads are ingested, they can be validated against N number of schemas. If the input signature used a different property name then that has mutated the payload. So SchemaA and SchemaB must both see the camelCase spec named variable. Also it is possible to send in two properties, named camelCase and camel_case in the same payload. That use case should be support so spec case is used.

Parameter spec case

Parameters can be included in different locations including:

  • query
  • path
  • header
  • cookie

Any of those parameters could use the same parameter names, so if every parameter was included as an endpoint parameter in a function signature, they would collide. For that reason, each of those inputs have been separated out into separate typed dictionaries:

  • query_params
  • path_params
  • header_params
  • cookie_params

So when updating your code, you will need to pass endpoint parameters in using those dictionaries.

Endpoint responses

Endpoint responses have been enriched to now include more information. Any response reom an endpoint will now include the following properties: response: urllib3.HTTPResponse body: typing.Union[Unset, Schema] headers: typing.Union[Unset, TODO] Note: response header deserialization has not yet been added

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import xprizo_sdk_py

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import xprizo_sdk_py

Getting Started

Please follow the installation procedure and then run the following:

import time
import xprizo_sdk_py
from pprint import pprint
from xprizo_sdk_py.apis.tags import agent_api
from xprizo_sdk_py.model.agent_bank_withdrawal_transaction_model import AgentBankWithdrawalTransactionModel
from xprizo_sdk_py.model.agent_request_payment_transaction_model import AgentRequestPaymentTransactionModel
from xprizo_sdk_py.model.agent_send_payment_transaction_model import AgentSendPaymentTransactionModel
from xprizo_sdk_py.model.approval_model import ApprovalModel
from xprizo_sdk_py.model.error_model import ErrorModel
from xprizo_sdk_py.model.problem_details import ProblemDetails
from xprizo_sdk_py.model.profile_agent_location_model import ProfileAgentLocationModel
from xprizo_sdk_py.model.relationship_model import RelationshipModel
from xprizo_sdk_py.model.sub_agent_model import SubAgentModel
from xprizo_sdk_py.model.wallet_account_model import WalletAccountModel
from xprizo_sdk_py.model.wallet_transaction_model import WalletTransactionModel
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = xprizo_sdk_py.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with xprizo_sdk_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = agent_api.AgentApi(api_client)
    agent_id = 1 # int | the id of the agent to become a sub agent of (optional)

    try:
        # Send a request to become a subagent
        api_instance.api_agent_add_sub_agent_request_post(agent_id=agent_id)
    except xprizo_sdk_py.ApiException as e:
        print("Exception when calling AgentApi->api_agent_add_sub_agent_request_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AgentApi api_agent_add_sub_agent_request_post post /api/Agent/AddSubAgentRequest Send a request to become a subagent
AgentApi api_agent_agent_request_payment_post post /api/Agent/AgentRequestPayment Create a payment request from another agent
AgentApi api_agent_agent_send_payment_post post /api/Agent/AgentSendPayment Create a payment from one agent to another
AgentApi api_agent_cash_request_post post /api/Agent/CashRequest Agent Requests to transfer money to their account (Agent Only)
AgentApi api_agent_delete_sub_agent_delete delete /api/Agent/DeleteSubAgent Remove a sub agent.
AgentApi api_agent_locations_get get /api/Agent/Locations Get the locations of all active agents
AgentApi api_agent_reference_endorse_put put /api/Agent/ReferenceEndorse Endose a user and a suitable candidate to become an agent
AgentApi api_agent_reference_request_put put /api/Agent/ReferenceRequest Request a reference from another agent (a user needs references to become an agent)
AgentApi api_agent_set_sub_agent_commission_put put /api/Agent/SetSubAgentCommission Set sub-agent Commission
AgentApi api_agent_set_wallet_access_put put /api/Agent/SetWalletAccess Grant/Deny agent wallet access to sub-agent
AgentApi api_agent_sub_agent_approved_put put /api/Agent/SubAgentApproved Approve the subagent request (BackOffice)
AgentApi api_agent_sub_agent_list_get get /api/Agent/SubAgentList Get a list of all subagents
AgentApi api_agent_trade_limit_request_post post /api/Agent/TradeLimitRequest Request an increase in the trade limit (Agent Only)
AgentApi api_agent_transactions_account_id_get get /api/Agent/Transactions/{accountId} Get transactions for a wallet
AgentApi api_agent_wallet_account_id_get get /api/Agent/Wallet/{accountId} Get a agent wallet
CategoryApi api_category_add_item_post post /api/Category/AddItem Add Category
CategoryApi api_category_add_property_put put /api/Category/AddProperty Add Property
CategoryApi api_category_delete_hash_id_delete delete /api/Category/Delete/{hashId} Delete Category
CategoryApi api_category_delete_property_hash_id_delete delete /api/Category/DeleteProperty/{hashId} Delete Category Property
CategoryApi api_category_get_model_get get /api/Category/GetModel Get Item
CategoryApi api_category_get_properties_get get /api/Category/GetProperties Get Category properties
CategoryApi api_category_list_all_get get /api/Category/ListAll Get all Category
CategoryApi api_category_list_get get /api/Category/List Get all Category
CategoryApi api_category_set_data_hash_id_put put /api/Category/SetData/{hashId} Set Category Description
CategoryApi api_category_set_description_put put /api/Category/SetDescription Set Category Description
CategoryApi api_category_set_name_put put /api/Category/SetName Set Item Name
CategoryApi api_category_set_pdf_attachment_post post /api/Category/SetPdfAttachment Set Pdf Attachment
CategoryApi api_category_set_public_put put /api/Category/SetPublic Make Category public
CategoryApi api_category_update_property_put put /api/Category/UpdateProperty Update Property
ContactApi api_contact_add_ticket_post post /api/Contact/AddTicket Add a new support ticket
ContactApi api_contact_banks_get get /api/Contact/Banks
ContactApi api_contact_get_business_hash_id_get get /api/Contact/GetBusiness/{hashId} Get contact information
ContactApi api_contact_get_id_get get /api/Contact/Get/{id} Get contact information
ContactApi api_contact_messages_get get /api/Contact/Messages Get messages for a user
ContactApi api_contact_messages_set_read_put put /api/Contact/MessagesSetRead Mark messages read for an specific users contact
ContactApi api_contact_messages_unread_count_get get /api/Contact/MessagesUnreadCount Get the total number of unread messages
ContactApi api_contact_name_id_get get /api/Contact/Name/{id}
ContactApi api_contact_search_get get /api/Contact/Search Get a users Id. Only users that have enabled visibility can be found
ContactApi api_contact_send_message_post post /api/Contact/SendMessage Send a message to a contact
ContactApi api_contact_set_email_put put /api/Contact/SetEmail Update email address - Only the
ContactApi api_contact_set_mobile_put put /api/Contact/SetMobile Update mobile number
ContactApi api_contact_set_tax_country_code_put put /api/Contact/SetTaxCountryCode Set Tax Country
ContactApi api_contact_tasks_id_get get /api/Contact/Tasks/{id} Get all tasks for a contact
ContactApi api_contact_tax_country_code_get get /api/Contact/TaxCountryCode Get Tax Country Code
ContactApi api_contact_updat_business_put put /api/Contact/UpdatBusiness Update contact business information
ContactApi api_contact_update_put put /api/Contact/Update Update contact information
DocumentApi api_document_add_contact_id_post post /api/Document/Add/{contactId} Upload a new document
DocumentApi api_document_delete_id_delete delete /api/Document/Delete/{id} Delete a document
DocumentApi api_document_list_contact_id_get get /api/Document/List/{contactId} List documents for a contact
DocumentApi api_document_types_get get /api/Document/Types Get a list of document types
ISGPayApi api_isg_pay_card_deposit_post post /api/ISGPay/CardDeposit Create Data For Card Form Redirect
ISGPayApi api_isg_pay_card_deposit_response_post post /api/ISGPay/CardDepositResponse
ISGPayApi api_isg_pay_check_status_get get /api/ISGPay/CheckStatus
ISGPayApi api_isg_pay_request_payment_post post /api/ISGPay/RequestPayment Make deposit and pay request
ISGPayApi api_isg_pay_request_payment_response_post post /api/ISGPay/RequestPaymentResponse
ISGPayApi api_isg_pay_send_post post /api/ISGPay/Send
ISGPayApi api_isg_pay_send_response_post post /api/ISGPay/SendResponse
ItemApi api_item_add_post post /api/Item/Add Add Item
ItemApi api_item_deletehash_id_delete delete /api/Item/Delete{hashId} Delete Item
ItemApi api_item_list_get get /api/Item/List Get all items
ItemApi api_item_merge_template_get get /api/Item/MergeTemplate Get Form
ItemApi api_item_model_get get /api/Item/Model Get Item
ItemApi api_item_pin_subscription_put put /api/Item/PinSubscription Subscribe
ItemApi api_item_set_amount_put put /api/Item/SetAmount Set Item Amount
ItemApi api_item_set_description_put put /api/Item/SetDescription Set Item Description
ItemApi api_item_set_detail_put put /api/Item/SetDetail Set Item Detail
ItemApi api_item_set_image_put put /api/Item/SetImage Set Image
ItemApi api_item_set_name_put put /api/Item/SetName Set Item Name
ItemApi api_item_set_property_image_put put /api/Item/SetPropertyImage Set Item Image
ItemApi api_item_set_property_put put /api/Item/SetProperty Set Item Property Value
ItemApi api_item_subscribe_hash_id_put put /api/Item/Subscribe/{hashId} Subscribe
ItemApi api_item_subscriptions_put put /api/Item/Subscriptions Subscriptions
ItemApi api_item_transaction_report_transaction_id_get get /api/Item/TransactionReport/{transactionId} Generate a receipts for a transaction
ItemApi api_item_unpin_subscription_put put /api/Item/UnpinSubscription Subscribe
ItemApi api_item_unsubscribe_hash_id_delete delete /api/Item/Unsubscribe/{hashId} Delete Category Property
MerchantApi api_merchant_add_post post /api/Merchant/Add
MerchantApi api_merchant_get_data_get get /api/Merchant/GetData
MerchantApi api_merchant_request_payment_post post /api/Merchant/RequestPayment Request Payment From a user
PreferenceApi api_preference_get get /api/Preference Get current user preference
PreferenceApi api_preference_notification_count_clear_delete delete /api/Preference/NotificationCountClear Mark tasks as read
PreferenceApi api_preference_notification_count_get get /api/Preference/NotificationCount //Get a count of the unread tasks
PreferenceApi api_preference_profile_picture_get get /api/Preference/ProfilePicture Get Profile Picture
PreferenceApi api_preference_set_allow_marketing_emails_put put /api/Preference/SetAllowMarketingEmails Allow exprizo to send marketing emails and messages
PreferenceApi api_preference_set_approval_webhook_put put /api/Preference/SetApprovalWebhook Set a url that that can be used to receive callbacks when transaction you create are approved or rejected
PreferenceApi api_preference_set_default_otp_type_put put /api/Preference/SetDefaultOTPType Set the 2FA Access type
PreferenceApi api_preference_set_find_option_put put /api/Preference/SetFindOption Set Find Option
PreferenceApi api_preference_set_language_put put /api/Preference/SetLanguage Set language
PreferenceApi api_preference_set_lat_lng_put put /api/Preference/SetLatLng Set location
PreferenceApi api_preference_set_location_visible_put put /api/Preference/SetLocationVisible Allow users to see your location
PreferenceApi api_preference_set_notification_push_token_put put /api/Preference/SetNotificationPushToken If a token is set then messages can be sent to the mobile
PreferenceApi api_preference_set_notify_on_new_approval_put put /api/Preference/SetNotifyOnNewApproval Get a notification if there is a new approval
PreferenceApi api_preference_set_notify_on_new_transaction_put put /api/Preference/SetNotifyOnNewTransaction Get a notification when a new transaction is created
PreferenceApi api_preference_set_notify_via_email_put put /api/Preference/SetNotifyViaEmail Send notifications via email
PreferenceApi api_preference_set_pay_fees_from_savings_put put /api/Preference/SetPayFeesFromSavings When set, fees will be be taken from the savings account
PreferenceApi api_preference_set_payment_webhook_put put /api/Preference/SetPaymentWebhook Set a url that that can be used to receive callbacks when payment is made
PreferenceApi api_preference_set_profile_picture_put put /api/Preference/SetProfilePicture Set profile picture
PreferenceApi api_preference_set_request_payment_webhook_put put /api/Preference/SetRequestPaymentWebhook Set a url that that can be used to receive callbacks when request payment is made
PreferenceApi api_preference_set_visible_by_email_put put /api/Preference/SetVisibleByEmail Allow users to find you by your email
PreferenceApi api_preference_set_visible_by_phone_put put /api/Preference/SetVisibleByPhone Allow users to find you by your mobile number
PreferenceApi api_preference_set_visible_by_user_name_put put /api/Preference/SetVisibleByUserName Allow users to find you by your user name
ProfileApi api_profile_clear_pin_put put /api/Profile/ClearPin Clear pin. NOTE: If you have forgotten your pin first set your pin to a new pin
ProfileApi api_profile_get_full_get get /api/Profile/GetFull Get a users profile
ProfileApi api_profile_get_get get /api/Profile/Get Get a users profile
ProfileApi api_profile_lock_put put /api/Profile/Lock Lock profile so email, mobile and pin cannot be changed
ProfileApi api_profile_log_get get /api/Profile/Log
ProfileApi api_profile_set_password_put put /api/Profile/SetPassword
ProfileApi api_profile_set_pin_put put /api/Profile/SetPin
ProfileApi api_profile_set_user_name_put put /api/Profile/SetUserName Change user name
ProfileApi api_profile_unlock_put put /api/Profile/Unlock UnLock profile so email, mobile and pin can be changed. Profile remains unlocked for 5 minutes
RelationshipApi api_relationship_add_post post /api/Relationship/Add Add a contact to your contact list and send a friend request to the contact
RelationshipApi api_relationship_default_wallet_get get /api/Relationship/DefaultWallet Get contacts default wallet
RelationshipApi api_relationship_default_wallets_get get /api/Relationship/DefaultWallets Get Contacts Default Wallet
RelationshipApi api_relationship_get_model_get get /api/Relationship/GetModel
RelationshipApi api_relationship_get_wallet_access_get get /api/Relationship/GetWalletAccess Get type of wallet access
RelationshipApi api_relationship_linked_wallets_get get /api/Relationship/LinkedWallets Get a list wallets that have been shared with you
RelationshipApi api_relationship_list_get get /api/Relationship/List
RelationshipApi api_relationship_set_access_put put /api/Relationship/SetAccess Give or Revoke access to account
RelationshipApi api_relationship_set_status_active_put put /api/Relationship/SetStatusActive
RelationshipApi api_relationship_set_status_blocked_put put /api/Relationship/SetStatusBlocked
RelationshipApi api_relationship_set_status_hidden_put put /api/Relationship/SetStatusHidden
RelationshipApi api_relationship_transactions_get get /api/Relationship/Transactions
RelationshipApi api_relationship_wallets_get get /api/Relationship/Wallets Get Related Contact Wallets
ReportApi api_report_get_get get /api/Report/Get Get contact information
ReportApi api_report_save_put put /api/Report/Save
SecurityApi api_security_activate_account_put put /api/Security/ActivateAccount Activate account
SecurityApi api_security_apple_login_post post /api/Security/AppleLogin Login with apple token
SecurityApi api_security_check_otp_post post /api/Security/CheckOtp Send one time password to user
SecurityApi api_security_firebase_login_post post /api/Security/FirebaseLogin Login with firebase credentials
SecurityApi api_security_get_captcha_get get /api/Security/GetCaptcha Get a Capture Image
SecurityApi api_security_get_reset_key_get get /api/Security/GetResetKey Get Reset Key
SecurityApi api_security_get_token_post post /api/Security/GetToken Login to the system
SecurityApi api_security_google_login_post post /api/Security/GoogleLogin Login with google token
SecurityApi api_security_logout_post post /api/Security/Logout Logout of the system
SecurityApi api_security_register_post post /api/Security/Register Register an new user
SecurityApi api_security_reset_password_put put /api/Security/ResetPassword Reset users password
SecurityApi api_security_send_new_otp_post post /api/Security/SendNewOtp Send one time password to user
SecurityApi api_security_send_otp_post post /api/Security/SendOtp Send one time password to user
SecurityApi api_security_send_otp_to_email_get get /api/Security/SendOtpToEmail Send one time password to email address
SecurityApi api_security_send_otp_to_sms_get get /api/Security/SendOtpToSMS Send one time password to users mobile number
SecurityApi api_security_validate_user_post post /api/Security/ValidateUser Validate new user
SystemApi api_system_bank_count_get get /api/System/BankCount
SystemApi api_system_bank_get get /api/System/Bank
SystemApi api_system_banks_get get /api/System/Banks
SystemApi api_system_country_list_get get /api/System/CountryList List of countries and codes
SystemApi api_system_currencies_get get /api/System/Currencies
SystemApi api_system_info_get get /api/System/Info Name and version data
SystemApi api_system_merchants_get get /api/System/Merchants
TaskApi api_task_add_attachment_id_post post /api/Task/AddAttachment/{id}
TaskApi api_task_add_comment_id_post post /api/Task/AddComment/{id}
TaskApi api_task_cancel_id_put put /api/Task/Cancel/{id}
TaskApi api_task_daily_withdrawal_limit_request_account_id_post post /api/Task/DailyWithdrawalLimitRequest/{accountId} Request an increase in the daily limit
TaskApi api_task_get_id_get get /api/Task/Get/{id}
TaskApi api_task_hide_id_put put /api/Task/Hide/{id}
TaskApi api_task_one_off_withdrawal_amount_request_account_id_post post /api/Task/OneOffWithdrawalAmountRequest/{accountId} Request an increase in the once off limit
TaskApi api_task_show_id_put put /api/Task/Show/{id}
TransactionApi api_transaction_agent_deposit_post post /api/Transaction/AgentDeposit Create a deposit from an agent
TransactionApi api_transaction_agent_withdrawal_post post /api/Transaction/AgentWithdrawal Create a withdrawal from an agent
TransactionApi api_transaction_approval_accept_get get /api/Transaction/ApprovalAccept Approve a pending transaction
TransactionApi api_transaction_approval_cancel_get get /api/Transaction/ApprovalCancel Cancel a pending transaction
TransactionApi api_transaction_approval_reject_get get /api/Transaction/ApprovalReject Reject/cancel a pending transaction
TransactionApi api_transaction_bank_deposit_post post /api/Transaction/BankDeposit Create a user bank deposit
TransactionApi api_transaction_instant_payment_qr_code_post post /api/Transaction/InstantPaymentQRCode Get instantPayment QRCode
TransactionApi api_transaction_request_payment_post post /api/Transaction/RequestPayment Create a payment request from another user
TransactionApi api_transaction_savings_deposit_post post /api/Transaction/SavingsDeposit Deposit to savings
TransactionApi api_transaction_savings_withdrawal_post post /api/Transaction/SavingsWithdrawal Withdrawal from savings
TransactionApi api_transaction_send_payment_post post /api/Transaction/SendPayment Create a payment to another user
TransactionApi api_transaction_status_by_reference_account_id_get get /api/Transaction/StatusByReference/{accountId} Get a transaction status by reference Statuses (Active,Pending,Hold,Void,NotFound)
TransactionApi api_transaction_wallet_exchange_post post /api/Transaction/WalletExchange Create a transfer between users wallets
WalletApi api_wallet_account_id_get get /api/Wallet/{accountId} Get a user wallet
WalletApi api_wallet_add_post post /api/Wallet/Add Add a new wallet
WalletApi api_wallet_approval_status_get get /api/Wallet/ApprovalStatus Dummy function to return structure
WalletApi api_wallet_clear_new_transaction_count_account_id_delete delete /api/Wallet/ClearNewTransactionCount/{accountId} Remove the notification count of new transactions
WalletApi api_wallet_id_delete delete /api/Wallet/{id} Delete the wallet - Note. It will only be deleted if it has no transactions associated with it.
WalletApi api_wallet_info_get get /api/Wallet/Info Get information about a user wallet
WalletApi api_wallet_info_list_get get /api/Wallet/InfoList Get a basic list of wallets for a user.
WalletApi api_wallet_list_get get /api/Wallet/List Get all wallets for a user
WalletApi api_wallet_monthly_balances_get get /api/Wallet/MonthlyBalances Get wallet balances for months that had transactions
WalletApi api_wallet_options_get get /api/Wallet/Options Get information about options available for this type of wallet
WalletApi api_wallet_owner_get get /api/Wallet/Owner Get owner of a wallet.
WalletApi api_wallet_savings_list_get get /api/Wallet/SavingsList Get savings wallets for a user
WalletApi api_wallet_set_default_account_id_put put /api/Wallet/SetDefault/{accountId} Set the default wallet
WalletApi api_wallet_statement_report_account_id_get get /api/Wallet/StatementReport/{accountId} Generate a statement from wallet transactions
WalletApi api_wallet_total_withdrawals_get get /api/Wallet/TotalWithdrawals Get wallet monthly deposit total
WalletApi api_wallet_transaction_by_reference_account_id_get get /api/Wallet/TransactionByReference/{accountId} Get a users transaction by reference
WalletApi api_wallet_transaction_report_transaction_id_get get /api/Wallet/TransactionReport/{transactionId} Generate a receipts for a transaction
WalletApi api_wallet_transaction_summary_get get /api/Wallet/TransactionSummary Get wallet transaction summary in Base Currency Data will be grouped by Year, Month, Date, Hour or Minute depending on the date period Transactions will be summarised as follows eg range greater than a year then by year range greater than a month and less than a year then months range greater than a month and less than a year then months
WalletApi api_wallet_transaction_transaction_id_get get /api/Wallet/Transaction/{transactionId} Get a single transaction
WalletApi api_wallet_transactions_account_id_get get /api/Wallet/Transactions/{accountId} Get transactions for a wallet

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

[email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected]

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in xprizo_sdk_py.apis and xprizo_sdk_py.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from xprizo_sdk_py.apis.default_api import DefaultApi
  • from xprizo_sdk_py.model.pet import Pet

Solution 1: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import xprizo_sdk_py
from xprizo_sdk_py.apis import *
from xprizo_sdk_py.models import *

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages