Profiles
- class terminusgps.authorizenet.profiles.base.AuthorizenetProfileBase(merchant_id: int | str, id: int | str | None = None, *args, **kwargs)[source]
Public Data Attributes:
An internally designated customer id.
An Authorizenet generated id.
Merchant authentication for Authorizenet API calls.
Public Methods:
__init__
(merchant_id[, id])__str__
()Return str(self).
create
(*args, **kwargs)update
(*args, **kwargs)delete
(*args, **kwargs)Inherited from
ControllerExecutionMixin
execute_controller
(controller)Executes an Authorizenet controller and returns its response.
- 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]
Public Data Attributes:
The validation mode for Authorizenet API calls.
Whether or not the sub profile is set as default in Authorizenet.
An Authorizenet generated customer profile id.
Inherited from
AuthorizenetProfileBase
An internally designated customer id.
An Authorizenet generated id.
Merchant authentication for Authorizenet API calls.
Public Methods:
__init__
(customer_profile_id, default, ...)Inherited from
AuthorizenetProfileBase
__init__
(merchant_id[, id])__str__
()Return str(self).
create
(*args, **kwargs)update
(*args, **kwargs)delete
(*args, **kwargs)Inherited from
ControllerExecutionMixin
execute_controller
(controller)Executes an Authorizenet controller and returns its response.
- 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.
Public Data Attributes:
Inherited from
AuthorizenetSubProfileBase
The validation mode for Authorizenet API calls.
Whether or not the sub profile is set as default in Authorizenet.
An Authorizenet generated customer profile id.
Inherited from
AuthorizenetProfileBase
An internally designated customer id.
An Authorizenet generated id.
Merchant authentication for Authorizenet API calls.
Public Methods:
create
(address)Creates an Authorizenet address profile.
update
(address)Updates the Authorizenet address profile.
delete
()Deletes the Authorizenet address profile.
Gets details for the Authorizenet address profile.
Inherited from
AuthorizenetSubProfileBase
__init__
(customer_profile_id, default, ...)Inherited from
AuthorizenetProfileBase
__init__
(merchant_id[, id])__str__
()Return str(self).
create
(*args, **kwargs)update
(*args, **kwargs)delete
(*args, **kwargs)Inherited from
ControllerExecutionMixin
execute_controller
(controller)Executes an Authorizenet controller and returns its response.
Private Methods:
Executes a
getCustomerShippingAddressRequest
using the Authorizenet API.Executes a
createCustomerShippingAddressRequest
using the Authorizenet API.Executes a
updateCustomerShippingAddressRequest
using the Authorizenet API.Executes a
deleteCustomerShippingAddressRequest
using the Authorizenet API.
- _authorizenet_create_shipping_address(address: customerAddressType) dict | None [source]
Executes a
createCustomerShippingAddressRequest
using the Authorizenet API.createCustomerShippingAddressRequest
- 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_shipping_address() dict | None [source]
Executes a
deleteCustomerShippingAddressRequest
using the Authorizenet API.deleteCustomerShippingAddressRequest
- 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_shipping_address() dict | None [source]
Executes a
getCustomerShippingAddressRequest
using the Authorizenet API.getCustomerShippingAddressRequest
- 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_update_shipping_address(address: customerAddressType) dict | None [source]
Executes a
updateCustomerShippingAddressRequest
using the Authorizenet API.updateCustomerShippingAddressRequest
- 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:
- create(address: customerAddressType) int [source]
Creates an Authorizenet address profile.
- Parameters:
address (
customerAddressType
) – A customer address.- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
ValueError – If the Authorizenet API response was not retrieved.
- Returns:
A new address profile id.
- Return type:
- delete() dict | None [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(address: customerAddressType) dict | None [source]
Updates the Authorizenet address profile.
- Parameters:
address (
customerAddressType
) – A customer shipping address.- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response, if any.
- Return type:
- class terminusgps.authorizenet.profiles.customers.CustomerProfile(merchant_id: int | str, id: int | str | None = None, *args, **kwargs)[source]
An Authorizenet customer profile.
Public Data Attributes:
A list of the customer's payment profiles, if any.
A list of the customer's address profiles, if any.
Whether or not the customer profile exists in Authorizenet.
Inherited from
AuthorizenetProfileBase
An internally designated customer id.
An Authorizenet generated id.
Merchant authentication for Authorizenet API calls.
Public Methods:
create
(email[, desc])Creates a customer profile and returns its id.
update
(email[, desc])Updates the customer profile.
delete
()Deletes the customer profile.
Inherited from
AuthorizenetProfileBase
__init__
(merchant_id[, id])__str__
()Return str(self).
create
(*args, **kwargs)update
(*args, **kwargs)delete
(*args, **kwargs)Inherited from
ControllerExecutionMixin
execute_controller
(controller)Executes an Authorizenet controller and returns its response.
Private Methods:
Executes a
getCustomerProfileIdsRequest
using the Authorizenet API.Executes a
createCustomerProfileRequest
using the Authorizenet API._authorizenet_get_customer_profile
([issuer_info])Executes a
getCustomerProfileRequest
using the Authorizenet API.Executes an
updateCustomerProfileRequest
using the Authorizenet API.Executes a
deleteCustomerProfileRequest
using the Authorizenet API.
- _authorizenet_create_customer_profile(email: str, desc: str = '') dict | None [source]
Executes a
createCustomerProfileRequest
using the Authorizenet API.- Parameters:
- Raises:
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.- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response, if any.
- Return type:
- _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 = '') int [source]
Creates a customer profile and returns its id.
- Parameters:
- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
ValueError – If the Authorizenet API response was not retrieved.
- Returns:
The new customer profile id.
- Return type:
- 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.
- class terminusgps.authorizenet.profiles.payments.PaymentProfile(customer_profile_id: int | str, default: bool, *args, **kwargs)[source]
An Authorizenet customer payment profile.
Public Data Attributes:
Inherited from
AuthorizenetSubProfileBase
The validation mode for Authorizenet API calls.
Whether or not the sub profile is set as default in Authorizenet.
An Authorizenet generated customer profile id.
Inherited from
AuthorizenetProfileBase
An internally designated customer id.
An Authorizenet generated id.
Merchant authentication for Authorizenet API calls.
Public Methods:
create
(address, payment)Creates an Authorizenet payment profile and returns its id.
update
(address, payment)Updates the Authorizenet payment profile.
delete
()Deletes the Authorizenet payment profile.
get_details
([issuer_info])Inherited from
AuthorizenetSubProfileBase
__init__
(customer_profile_id, default, ...)Inherited from
AuthorizenetProfileBase
__init__
(merchant_id[, id])__str__
()Return str(self).
create
(*args, **kwargs)update
(*args, **kwargs)delete
(*args, **kwargs)Inherited from
ControllerExecutionMixin
execute_controller
(controller)Executes an Authorizenet controller and returns its response.
Private Methods:
Executes a
getTransactionListForCustomerRequest
using the Authorizenet API.Executes a
createCustomerPaymentProfileRequest
using the Authorizenet API._authorizenet_get_payment_profile
([issuer_info])Executes a
getCustomerPaymentProfileRequest
using the Authorizenet API.Executes a
updateCustomerPaymentProfileRequest
using the Authorizenet API.Executes a
validateCustomerPaymentProfileRequest
using the Authorizenet API.Executes a
deleteCustomerPaymentProfileRequest
using the Authorizenet API.
- _authorizenet_create_payment_profile(address: customerAddressType, payment: paymentType) dict | None [source]
Executes a
createCustomerPaymentProfileRequest
using the Authorizenet API.createCustomerPaymentProfileRequest
- Parameters:
address (
customerAddressType
) – A billing address.payment (
paymentType
) – A payment method.
- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response, if any.
- Return type:
- _authorizenet_delete_payment_profile() dict | None [source]
Executes a
deleteCustomerPaymentProfileRequest
using the Authorizenet API.deleteCustomerPaymentProfileRequest
- 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_payment_profile(issuer_info: bool = False) dict | None [source]
Executes a
getCustomerPaymentProfileRequest
using the Authorizenet API.getCustomerPaymentProfileRequest
- Parameters:
issuer_info (
bool
) – Whether or not to include issuer information in the response.- 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_transaction_list_for_customer(limit: int = 100, ordering: str = 'submitTimeUTC', offset: int = 1, descending: bool = False) dict | None [source]
Executes a
getTransactionListForCustomerRequest
using the Authorizenet API.getTransactionListForCustomerRequest
- Parameters:
- Raises:
ValueError – If
ordering
is invalid.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_update_payment_profile(address: customerAddressType, payment: paymentType) dict | None [source]
Executes a
updateCustomerPaymentProfileRequest
using the Authorizenet API.updateCustomerPaymentProfileRequest
- Parameters:
address (
customerAddressType
) – A customer address.payment (
paymentType
) – A payment method.
- 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_validate_payment_profile() dict | None [source]
Executes a
validateCustomerPaymentProfileRequest
using the Authorizenet API.validateCustomerPaymentProfileRequest
- 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:
- create(address: customerAddressType, payment: paymentType) int [source]
Creates an Authorizenet payment profile and returns its id.
- Parameters:
address (
customerAddressType
) – A billing address.payment (
paymentType
) – A payment object.
- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
ValueError – If the Authorizenet API response was not retrieved.
- Returns:
The new payment profile’s id.
- Return type:
- delete() dict | None [source]
Deletes the Authorizenet payment profile.
- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API response, if any.
- Return type:
- update(address: customerAddressType, payment: paymentType) dict | None [source]
Updates the Authorizenet payment profile.
- Parameters:
address (
customerAddressType
) – A billing address.payment (
paymentType
) – A payment method.
- Raises:
ControllerExecutionError – If something goes wrong during an Authorizenet API call.
- Returns:
An Authorizenet API reponse, if any.
- Return type: