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>
64 lines
2.4 KiB
JSON
64 lines
2.4 KiB
JSON
{
|
|
"documentationUrl": "https://docs.withorb.com/",
|
|
"connectionSpecification": {
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"title": "Orb Spec",
|
|
"type": "object",
|
|
"required": ["api_key", "start_date"],
|
|
"additionalProperties": true,
|
|
"properties": {
|
|
"api_key": {
|
|
"type": "string",
|
|
"title": "Orb API Key",
|
|
"description": "Orb API Key, issued from the Orb admin console.",
|
|
"airbyte_secret": true,
|
|
"order": 1
|
|
},
|
|
"start_date": {
|
|
"type": "string",
|
|
"title": "Start Date",
|
|
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
|
|
"description": "UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the `timeframe_start` API parameter.",
|
|
"examples": ["2022-03-01T00:00:00Z"],
|
|
"order": 2
|
|
},
|
|
"lookback_window_days": {
|
|
"type": "integer",
|
|
"title": "Lookback Window (in days)",
|
|
"default": 0,
|
|
"minimum": 0,
|
|
"description": "When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced.",
|
|
"order": 3
|
|
},
|
|
"string_event_properties_keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Event properties keys (string values)",
|
|
"description": "Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.",
|
|
"order": 4
|
|
},
|
|
"numeric_event_properties_keys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Event properties keys (numeric values)",
|
|
"description": "Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.",
|
|
"order": 5
|
|
},
|
|
"subscription_usage_grouping_key": {
|
|
"type": "string",
|
|
"title": "Subscription usage grouping key (string value)",
|
|
"description": "Property key name to group subscription usage by."
|
|
},
|
|
"plan_id": {
|
|
"type": "string",
|
|
"title": "Orb Plan ID for Subscription Usage (string value)",
|
|
"description": "Orb Plan ID to filter subscriptions that should have usage fetched."
|
|
}
|
|
}
|
|
}
|
|
}
|