Skip to content

[DE-1079] Organize events #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maciej-nedza merged 1 commit into from
Dec 11, 2024
Merged

[DE-1079] Organize events #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions doc/controllers/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,17 @@ The following keys are no longer supported.
+ `zferral_revenue_post_failure` - (Specific to the deprecated Zferral integration)
+ `zferral_revenue_post_success` - (Specific to the deprecated Zferral integration)

## Event Key

The event type is identified by the key property. You can check supported keys [here](../../doc/models/event-key.md).

## Event Specific Data

Event Specific Data
Different event types may include additional data in `event_specific_data` property.
While some events share the same schema for `event_specific_data`, others may not include it at all.
For precise mappings from key to event_specific_data, refer to [Event](../../doc/models/event.md).

Each event type has its own `event_specific_data` specified.
### Example

Here’s an example event for the `subscription_product_change` event:

Expand Down Expand Up @@ -196,7 +202,15 @@ try {

The following request will return a list of events for a subscription.

Each event type has its own `event_specific_data` specified.
## Event Key

The event type is identified by the key property. You can check supported keys [here](../../doc/models/event-key.md).

## Event Specific Data

Different event types may include additional data in `event_specific_data` property.
While some events share the same schema for `event_specific_data`, others may not include it at all.
For precise mappings from key to event_specific_data, refer to [Event](../../doc/models/event.md).

```java
List<EventResponse> listSubscriptionEvents(
Expand Down
3 changes: 1 addition & 2 deletions doc/models/containers/event-event-specific-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
| [`PendingCancellationChange`](../../../doc/models/pending-cancellation-change.md) | EventEventSpecificData.fromPendingCancellationChange(PendingCancellationChange pendingCancellationChange) |
| [`PrepaidSubscriptionBalanceChanged`](../../../doc/models/prepaid-subscription-balance-changed.md) | EventEventSpecificData.fromPrepaidSubscriptionBalanceChanged(PrepaidSubscriptionBalanceChanged prepaidSubscriptionBalanceChanged) |
| [`ProformaInvoiceIssued`](../../../doc/models/proforma-invoice-issued.md) | EventEventSpecificData.fromProformaInvoiceIssued(ProformaInvoiceIssued proformaInvoiceIssued) |
| [`SubscriptionGroupSignupSuccess`](../../../doc/models/subscription-group-signup-success.md) | EventEventSpecificData.fromSubscriptionGroupSignupSuccess(SubscriptionGroupSignupSuccess subscriptionGroupSignupSuccess) |
| [`SubscriptionGroupSignupFailure`](../../../doc/models/subscription-group-signup-failure.md) | EventEventSpecificData.fromSubscriptionGroupSignupFailure(SubscriptionGroupSignupFailure subscriptionGroupSignupFailure) |
| [`SubscriptionGroupSignupEventData`](../../../doc/models/subscription-group-signup-event-data.md) | EventEventSpecificData.fromSubscriptionGroupSignupEventData(SubscriptionGroupSignupEventData subscriptionGroupSignupEventData) |
| [`CreditAccountBalanceChanged`](../../../doc/models/credit-account-balance-changed.md) | EventEventSpecificData.fromCreditAccountBalanceChanged(CreditAccountBalanceChanged creditAccountBalanceChanged) |
| [`PrepaymentAccountBalanceChanged`](../../../doc/models/prepayment-account-balance-changed.md) | EventEventSpecificData.fromPrepaymentAccountBalanceChanged(PrepaymentAccountBalanceChanged prepaymentAccountBalanceChanged) |
| [`PaymentCollectionMethodChanged`](../../../doc/models/payment-collection-method-changed.md) | EventEventSpecificData.fromPaymentCollectionMethodChanged(PaymentCollectionMethodChanged paymentCollectionMethodChanged) |
Expand Down
59 changes: 59 additions & 0 deletions doc/models/event-key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@

# Event Key

## Enumeration

`EventKey`

## Fields

| Name |
| --- |
| `PaymentSuccess` |
| `PaymentFailure` |
| `SignupSuccess` |
| `SignupFailure` |
| `DelayedSignupCreationSuccess` |
| `DelayedSignupCreationFailure` |
| `BillingDateChange` |
| `ExpirationDateChange` |
| `RenewalSuccess` |
| `RenewalFailure` |
| `SubscriptionStateChange` |
| `SubscriptionProductChange` |
| `PendingCancellationChange` |
| `ExpiringCard` |
| `CustomerUpdate` |
| `CustomerCreate` |
| `CustomerDelete` |
| `ComponentAllocationChange` |
| `MeteredUsage` |
| `PrepaidUsage` |
| `UpgradeDowngradeSuccess` |
| `UpgradeDowngradeFailure` |
| `StatementClosed` |
| `StatementSettled` |
| `SubscriptionCardUpdate` |
| `SubscriptionGroupCardUpdate` |
| `SubscriptionBankAccountUpdate` |
| `RefundSuccess` |
| `RefundFailure` |
| `UpcomingRenewalNotice` |
| `TrialEndNotice` |
| `DunningStepReached` |
| `InvoiceIssued` |
| `PrepaidSubscriptionBalanceChanged` |
| `SubscriptionGroupSignupSuccess` |
| `SubscriptionGroupSignupFailure` |
| `DirectDebitPaymentPaidOut` |
| `DirectDebitPaymentRejected` |
| `DirectDebitPaymentPending` |
| `PendingPaymentCreated` |
| `PendingPaymentFailed` |
| `PendingPaymentCompleted` |
| `ProformaInvoiceIssued` |
| `SubscriptionPrepaymentAccountBalanceChanged` |
| `SubscriptionServiceCreditAccountBalanceChanged` |
| `CustomFieldValueChange` |
| `ItemPricePointChanged` |

2 changes: 1 addition & 1 deletion doc/models/event-response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
{
"event": {
"id": 242,
"key": "key0",
"key": "custom_field_value_change",
"message": "message0",
"subscription_id": 96,
"customer_id": 24,
Expand Down
4 changes: 2 additions & 2 deletions doc/models/event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `Id` | `long` | Required | - | long getId() | setId(long id) |
| `Key` | `String` | Required | **Constraints**: *Minimum Length*: `1` | String getKey() | setKey(String key) |
| `Key` | [`EventKey`](../../doc/models/event-key.md) | Required | - | EventKey getKey() | setKey(EventKey key) |
| `Message` | `String` | Required | **Constraints**: *Minimum Length*: `1` | String getMessage() | setMessage(String message) |
| `SubscriptionId` | `Integer` | Required | - | Integer getSubscriptionId() | setSubscriptionId(Integer subscriptionId) |
| `CustomerId` | `Integer` | Required | - | Integer getCustomerId() | setCustomerId(Integer customerId) |
Expand All @@ -22,7 +22,7 @@
```json
{
"id": 40,
"key": "key2",
"key": "subscription_group_signup_failure",
"message": "message8",
"subscription_id": 150,
"customer_id": 78,
Expand Down
14 changes: 10 additions & 4 deletions ...dels/subscription-group-signup-failure.md → ...s/subscription-group-signup-event-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@

# Subscription Group Signup Failure
# Subscription Group Signup Event Data

## Structure

`SubscriptionGroupSignupFailure`
`SubscriptionGroupSignupEventData`

## Fields

| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `SubscriptionGroup` | [`SubscriptionGroupSignupFailureData`](../../doc/models/subscription-group-signup-failure-data.md) | Required | - | SubscriptionGroupSignupFailureData getSubscriptionGroup() | setSubscriptionGroup(SubscriptionGroupSignupFailureData subscriptionGroup) |
| `Customer` | `String` | Required | - | String getCustomer() | setCustomer(String customer) |
| `Customer` | [`Customer`](../../doc/models/customer.md) | Required | - | Customer getCustomer() | setCustomer(Customer customer) |

## Example (as JSON)

Expand All @@ -29,7 +29,13 @@
"organization": "organization6"
}
},
"customer": "customer8"
"customer": {
"first_name": "first_name0",
"last_name": "last_name8",
"email": "email6",
"cc_emails": "cc_emails0",
"organization": "organization6"
}
}
```

40 changes: 0 additions & 40 deletions doc/models/subscription-group-signup-success-data.md
View file
Open in desktop

This file was deleted.

42 changes: 0 additions & 42 deletions doc/models/subscription-group-signup-success.md
View file
Open in desktop

This file was deleted.

17 changes: 12 additions & 5 deletions src/main/java/com/maxio/advancedbilling/controllers/EventsController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,12 @@ public EventsController(GlobalConfiguration globalConfig) {
* `payment_failure_recreated` + `payment_success_recreated` + `renewal_failure_recreated` +
* `renewal_success_recreated` + `zferral_revenue_post_failure` - (Specific to the deprecated
* Zferral integration) + `zferral_revenue_post_success` - (Specific to the deprecated Zferral
* integration) ## Event Specific Data Event Specific Data Each event type has its own
* `event_specific_data` specified. Here’s an example event for the
* `subscription_product_change` event: ``` { "event": { "id": 351, "key":
* integration) ## Event Key The event type is identified by the key property. You can check
* supported keys [here]($m/Event%20Key). ## Event Specific Data Different event types may
* include additional data in `event_specific_data` property. While some events share the same
* schema for `event_specific_data`, others may not include it at all. For precise mappings from
* key to event_specific_data, refer to [Event]($m/Event). ### Example Here’s an example event
* for the `subscription_product_change` event: ``` { "event": { "id": 351, "key":
* "subscription_product_change", "message": "Product changed on Marky Mark's subscription from
* 'Basic' to 'Pro'", "subscription_id": 205, "event_specific_data": { "new_product_id": 3,
* "previous_product_id": 2 }, "created_at": "2012-01-30T10:43:31-05:00" } } ``` Here’s an
Expand Down Expand Up @@ -116,8 +119,12 @@ private ApiCall<List<EventResponse>, ApiException> prepareListEventsRequest(
}

/**
* The following request will return a list of events for a subscription. Each event type has
* its own `event_specific_data` specified.
* The following request will return a list of events for a subscription. ## Event Key The event
* type is identified by the key property. You can check supported keys [here]($m/Event%20Key).
* ## Event Specific Data Different event types may include additional data in
* `event_specific_data` property. While some events share the same schema for
* `event_specific_data`, others may not include it at all. For precise mappings from key to
* event_specific_data, refer to [Event]($m/Event).
* @param input ListSubscriptionEventsInput object containing request parameters
* @return Returns the List of EventResponse response from the API call
* @throws ApiException Represents error response from the server.
Expand Down
Loading
Loading