everyaction.services.Commitments

class everyaction.services.Commitments(ea: EAClient)

Represents the Commitments service.

Methods

update(commitment_id, /, **kwargs)

See PATCH /commitments/{commitmentId}.

update(commitment_id: int, /, **kwargs: EAValue) → Commitment

See PATCH /commitments/{commitmentId}.

Parameters

• commitment_id – The commitmentId path parameter.

• kwargs – The applicable query arguments and JSON data for the request. A Commitment is appropriate to unpack here.

Returns

The resulting Commitment object.

Keyword Arguments

• amount

• ccExpirationMonth (cc_expiration_month, cc_exp_month)

• ccExpirationYear (cc_expiration_year, cc_exp_year)

• commitmentId (commitment_id, id)

• creditCardLast4 (credit_card_last4, cc_last4, last4)

• currency

• designationId (designation_id, designation)

• endDate (end_date, end)

• frequency

• nextTransactionDate (next_transaction_date, next_transaction, next)

• paymentType (payment_type)

• startDate (start_date, start)

• status