wepay.calls.user
Module¶
-
class
wepay.calls.user.
User
(api)[source]¶ The /user API calls
-
mfa
[source]¶ Membership
call instance
-
__call__
(**kwargs)[source]¶ Call documentation: /user, plus extra keyword parameters:
Parameters: - access_token (str) – will be used instead of instance’s
access_token
, withbatch_mode=True
will set authorization param to it’s value. - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
- access_token (str) – will be used instead of instance’s
-
modify
(**kwargs)¶ Call documentation: /user/modify, plus extra keyword parameters:
Parameters: - access_token (str) – will be used instead of instance’s
access_token
, withbatch_mode=True
will set authorization param to it’s value. - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
- access_token (str) – will be used instead of instance’s
-
register
(client_id, client_secret, email, scope, first_name, last_name, original_ip, original_device, **kwargs)¶ Call documentation: /user/register, plus extra keyword parameter:
Parameters: - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
Note
This call is NOT supported by API versions older then ‘2014-01-08’.
- batch_mode (bool) – turn on/off the batch_mode, see
-
send_confirmation
(**kwargs)¶ Call documentation: /user/resend_confirmation, plus extra keyword parameter:
Parameters: - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
Note
This call is NOT supported by API versions older then ‘2014-01-08’.
- batch_mode (bool) – turn on/off the batch_mode, see
-
-
class
wepay.calls.user.
MFA
(api)[source]¶ The /user/mfa API calls
-
create
(type, **kwargs)¶ Call documentation: /user/mfa/create, plus extra keyword parameter:
Parameters: - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
- batch_mode (bool) – turn on/off the batch_mode, see
Call documentation: /user/mfa/validate_cookie, plus extra keyword parameter:
Parameters: - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
- batch_mode (bool) – turn on/off the batch_mode, see
-
send_challenge
(mfa_id, **kwargs)¶ Call documentation: /user/mfa/send_challenge, plus extra keyword parameter:
Parameters: - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
- batch_mode (bool) – turn on/off the batch_mode, see
-
send_default_challenge
(**kwargs)¶ Call documentation: /user/mfa/send_default_challenge, plus extra keyword parameter:
Parameters: - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
- batch_mode (bool) – turn on/off the batch_mode, see
-
confirm
(mfa_id, challenge, **kwargs)¶ Call documentation: /user/mfa/confirm, plus extra keyword parameter:
Parameters: - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
- batch_mode (bool) – turn on/off the batch_mode, see
-
find
(**kwargs)¶ Call documentation: /user/mfa/find, plus extra keyword parameter:
Parameters: - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
- batch_mode (bool) – turn on/off the batch_mode, see
-
modify
(mfa_id, **kwargs)¶ Call documentation: /user/mfa/modify, plus extra keyword parameter:
Parameters: - batch_mode (bool) – turn on/off the batch_mode, see
wepay.api.WePay
- batch_reference_id (str) – reference_id param for batch call,
see
wepay.api.WePay
- api_version (str) – WePay API version, see
wepay.api.WePay
- batch_mode (bool) – turn on/off the batch_mode, see
-