Skip to content
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.

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

Provide examples of using the events API for the various use cases described in the documentation #62

Open
7 tasks
devraj opened this issue Nov 5, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@devraj
Copy link
Member

devraj commented Nov 5, 2024

Is your feature request related to a problem? Please describe.
The Events (or others where there is long poll available) are some of the more involved API endpoints, while it's great to provide documentation and full formed wrappers, it would assist the developers to provide elaborate examples with best practices (note: the documentation provides various written use cases).

Describe the solution you'd like

We should outline an example with the following use cases:

  • Downloading the entire event database
  • Downloading the most recent events
  • Reporting on events over a period
  • Receiving new events as they occur, starting from now
  • Receiving new events as they occur, starting from now, with no long polls
  • Receiving new events as they occur, starting in the past
  • Searching for events related to particular cardholders

These are all described in detail in the Event section of the documentation.

I am expecting these to provided as sample scripts in the examples folder along with some instructions on how to run these.

Describe alternatives you've considered
NA

Additional context
I am particularly interested in the Downloading the entire event database as a product idea so we can provide a commercial offering to customer.

@devraj devraj added the enhancement New feature or request label Nov 5, 2024
@devraj devraj self-assigned this Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant