9709adf41e
* wip * mvp * big rework to make incremental possibly work * incremental might be working * add external_customer_id to subscriptions stream * keep state indexed by subscription_id * add a source defined primary key * move super call after assignments * start work on integration tests * format and more test setup * tests and cleanup * fix yield from * format fixes * fix type of new subscriptions property * add subscription with actual usage for integration test config * fix start date parsing and use correct keys in integration test * update docs * bump version from 0.1.4 to 0.1.5 and update changelog * make start_date a required field and set version 0.2.0 instead of 0.1.5 * major version bump from 0.1.4 to 1.0.0 to reflect backwards-incompatible change making start_date a required field * pass start_date in unit test * add sample start_date * start_date already converted * add start_date to sample_config * remove accidental char * auto-bump connector version --------- Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
3.1 KiB
Orb
Overview
The Orb source supports both Full Refresh and Incremental syncs. For incremental syncs, this source
will only read and output new records based on their created_at timestamp.
Output schema
This Source is capable of syncing the following core resources, each of which has a separate Stream. Note that all of the streams are incremental:
As a caveat, the Credits Ledger Entries must read all Customers for an incremental sync, but will only incrementally return new ledger entries for each customers.
Similarily, the Subscription Usage stream must read all Subscriptions for an incremental sync (and all Plans if using the optional subscription_usage_grouping_key), but will only incrementally return new usage entries for each subscription.
Note on Incremental Syncs
The Orb API does not allow querying objects based on an updated_at time. Therefore, this connector uses the created_at field (or the timeframe_start field in the Subscription Usage stream) to query for new data since the last sync.
In order to capture data that has been updated after creation, please run a periodic Full Refresh.
Features
| Feature | Supported? |
|---|---|
| Full Refresh Sync | Yes |
| Incremental - Append Sync | Yes |
| Incremental - Dedupe Sync | Yes |
| SSL connection | Yes |
Performance considerations
The Orb connector should not run into Orb API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.
Getting started
Requirements
- Orb Account
- Orb API Key
Setup guide
Please reach out to the Orb team at team@withorb.com to request an Orb Account and API Key.
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 1.0.0 | 2023-02-02 | 21951 | Add SubscriptionUsage stream, and made start_date a required field |
| 0.1.4 | 2022-10-07 | 17761 | Fix bug with enriching ledger entries with multiple credit blocks |
| 0.1.3 | 2022-08-26 | 16017 | Add credit block id to ledger entries |
| 0.1.2 | 2022-04-20 | 11528 | Add cost basis to ledger entries, update expiration date, sync only committed entries |
| 0.1.1 | 2022-03-03 | 10839 | Support ledger entries with numeric properties + schema fixes |
| 0.1.0 | 2022-02-01 | New Source: Orb | |
| :--- | :--- | :--- | :--- |