Profiles
- class terminusgps.authorizenet.profiles.base.AuthorizenetProfileBase(merchant_id: int | str, id: int | str | None = None, *args, **kwargs)[source]
- property id: str
An Authorizenet generated id.
- property merchantAuthentication: merchantAuthenticationType
Merchant authentication for Authorizenet API calls.
- property merchantCustomerId: str
An internally designated customer id.
- class terminusgps.authorizenet.profiles.base.AuthorizenetSubProfileBase(customer_profile_id: int | str, default: bool, *args, **kwargs)[source]
- property customerProfileId: str
An Authorizenet generated customer profile id.
- property default: str
Whether or not the sub profile is set as default in Authorizenet.
- property validationMode: str
The validation mode for Authorizenet API calls.
- class terminusgps.authorizenet.profiles.addresses.AddressProfile(customer_profile_id: int | str, default: bool, *args, **kwargs)[source]
An Authorizenet customer address profile.
- _authorizenet_create_shipping_address(addr: customerAddressType) dict [source]
Executes a
createCustomerShippingAddressRequest
using the Authorizenet API.- Raises:
AssertionError – If
id
wasn’t set.ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response.
- Return type:
- _authorizenet_delete_shipping_address() dict [source]
Executes a
deleteCustomerShippingAddressRequest
using the Authorizenet API.- Raises:
AssertionError – If
id
wasn’t set.ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response.
- Return type:
- _authorizenet_get_shipping_address() dict [source]
Executes a
getCustomerShippingAddressRequest
using the Authorizenet API.- Raises:
AssertionError – If
id
wasn’t set.ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response.
- Return type:
- _authorizenet_update_shipping_address(addr: customerAddressType) dict [source]
Executes a
updateCustomerShippingAddressRequest
using the Authorizenet API.- Raises:
AssertionError – If
id
wasn’t set.ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response.
- Return type:
- create(shipping_addr: customerAddressType) int [source]
Creates an Authorizenet address profile.
- Parameters:
shipping_addr (
customerAddressType
) – An Authorizenet customer address.- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
A new address profile id.
- Return type:
- delete() dict [source]
Deletes the Authorizenet address profile.
- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response, if any.
- Return type:
- update(shipping_addr: customerAddressType) dict [source]
Updates the Authorizenet address profile.
- Parameters:
shipping_addr (
customerAddressType
) – A customer shipping address.- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response.
- Return type:
- class terminusgps.authorizenet.profiles.customers.CustomerProfile(merchant_id: int | str, id: int | str | None = None, *args, **kwargs)[source]
An Authorizenet customer profile.
- _authorizenet_create_customer_profile(email: str, desc: str = '') dict | None [source]
Executes a
createCustomerProfileRequest
using the Authorizenet API.- Parameters:
- Raises:
AssertionError – If
id
wasn’t set.ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response, if any.
- Return type:
- _authorizenet_delete_customer_profile() dict | None [source]
Executes a
deleteCustomerProfileRequest
using the Authorizenet API.- Raises:
AssertionError – If
id
wasn’t set.ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response, if any.
- Return type:
- _authorizenet_get_customer_profile(issuer_info: bool = True) dict | None [source]
Executes a
getCustomerProfileRequest
using the Authorizenet API.- Parameters:
issuer_info (
bool
) – Whether or not to include issuer info in the response.- Raises:
AssertionError – If
id
was not set.ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response, if any.
- Return type:
- _authorizenet_get_customer_profile_ids() dict | None [source]
Executes a
getCustomerProfileIdsRequest
using the Authorizenet API.
- _authorizenet_update_customer_profile(email: str, desc: str = '') dict | None [source]
Executes an
updateCustomerProfileRequest
using the Authorizenet API.- Parameters:
- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
AssertionError – If
id
wasn’t set.
- Returns:
An Authorizenet API response, if any.
- Return type:
- create(email: str, desc: str | None = None) int [source]
Creates a customer profile using the Authorizenet API and returns its id.
- delete() None [source]
Deletes the customer profile.
- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
Nothing.
- Return type:
- property exists: bool
Whether or not the customer profile exists in Authorizenet.
- get_payment_profiles() list[dict] | None [source]
Returns a list of the customer’s payment profiles.
- class terminusgps.authorizenet.profiles.payments.PaymentProfile(customer_profile_id: int | str, default: bool, *args, **kwargs)[source]
An Authorizenet customer payment profile.
- _authorizenet_create_payment_profile(billing_addr: customerAddressType, payment: paymentType) dict [source]
Executes a
createCustomerPaymentProfileRequest
using the Authorizenet API.- Parameters:
billing_addr (
customerAddressType
) – A customer address.payment (
paymentType
) – A payment method.
- Raises:
AssertionError – If
id
wasn’t set.
:raises : If
id
wasn’t set. :returns: An Authorizenet API response. :rtype:dict
- _authorizenet_delete_payment_profile() dict [source]
Executes a
deleteCustomerPaymentProfileRequest
using the Authorizenet API.- Raises:
AssertionError – If
id
wasn’t set.- Returns:
An Authorizenet API response.
- Return type:
- _authorizenet_get_payment_profile(issuer_info: bool = False) dict [source]
Executes a
getCustomerPaymentProfileRequest
using the Authorizenet API.- Parameters:
issuer_info (
bool
) – Whether or not to include issuer information in the response.- Raises:
AssertionError – If
id
wasn’t set.- Returns:
An Authorizenet API response.
- Return type:
- _authorizenet_get_transaction_list_for_customer(limit: int = 100, ordering: str = 'submitTimeUTC', offset: int = 1, descending: bool = False) dict [source]
Executes a
getTransactionListForCustomerRequest
using the Authorizenet API.- Parameters:
- Raises:
ValueError – If
ordering
is invalid.AssertionError – If
id
wasn’t set.
- Returns:
An Authorizenet API response.
- Return type:
- _authorizenet_update_payment_profile(billing_addr: customerAddressType, payment: paymentType) dict [source]
Executes a
validateCustomerPaymentProfileRequest
using the Authorizenet API.- Parameters:
billing_addr (
customerAddressType
) – A customer address.payment (
paymentType
) – A payment method.
- Raises:
AssertionError – If
id
wasn’t set.- Returns:
An Authorizenet API response.
- Return type:
- _authorizenet_validate_payment_profile() dict [source]
Executes a
validateCustomerPaymentProfileRequest
using the Authorizenet API.- Raises:
AssertionError – If
id
wasn’t set.- Returns:
An Authorizenet API response.
- Return type: