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.

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

Jump to bottom

🎉 Source Chargebee: add "custom fields" to the relevant data streams #17056

Merged
merged 4 commits into from
Sep 26, 2022
Merged

🎉 Source Chargebee: add "custom fields" to the relevant data streams #17056

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a29d336
Chargebee: added custom fields
darynaishchenko Sep 22, 2022
2dc3cb1
Chargebee: added value types json schema
darynaishchenko Sep 23, 2022
3d00a69
Chargebee: added docs, updated docker label, refactored utils
darynaishchenko Sep 23, 2022
9980e8c
auto-bump connector version [ci skip]
octavia-squidington-iii Sep 26, 2022
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
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/addon.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,20 @@
}
}
}
},
"custom_fields": {
"type": ["null", "array"],
"items" : {
"type" : ["null", "object"],
"properties": {
"name" : {
"type" : ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/attached_item.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,19 @@
"object": {
"type": ["string", "null"]
}
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties" : {
"name" : {
"type" : ["null", "string"]
},
"value" : {
"type" : ["null", "string"]
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/coupon.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,20 @@
}
}
}
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/credit_note.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,6 +507,20 @@
}
}
}
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/customer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,20 @@
"meta_data": {
"type": ["object", "null"],
"properties": {}
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/event.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,20 @@
}
}
}
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/invoice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -867,6 +867,20 @@
"enum": ["not_validated", "valid", "partially_valid", "invalid"]
}
}
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/item.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,20 @@
},
"object": {
"type": ["string", "null"]
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/item_price.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,20 @@
},
"object": {
"type": ["string", "null"]
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/order.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,20 @@
}
}
}
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/plan.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,20 @@
}
}
}
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/subscription.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -668,6 +668,20 @@
}
}
}
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/transaction.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,20 @@
}
}
}
},
"custom_fields": {
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"name": {
"type": ["null", "string"]
},
"value": {
"type": ["null", "string"]
}
}
}
}
}
}
7 changes: 4 additions & 3 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/streams.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
from chargebee.models import Transaction as TransactionModel

from .rate_limiting import default_backoff_handler
from .utils import transform_custom_fields

# Backoff params below according to Chargebee's guidance on rate limit.
# https://apidocs.chargebee.com/docs/api?prod_cat_ver=2#api_rate_limits
Expand Down Expand Up @@ -59,7 +60,7 @@ def request_params(

def parse_response(self, list_result: ListResult, **kwargs) -> Iterable[Mapping]:
for message in list_result:
yield message._response[self.name]
yield from transform_custom_fields(message._response[self.name])

@default_backoff_handler(max_tries=MAX_TRIES, factor=MAX_TIME)
def _send_request(self, **kwargs) -> ListResult:
Expand Down Expand Up @@ -133,7 +134,7 @@ def parse_response(
for message in list_result:
record = message._response[self.name]
if record[self.cursor_field] > starting_point:
yield record
yield from transform_custom_fields(record)

def get_updated_state(self, current_stream_state: MutableMapping[str, Any], latest_record: Mapping[str, Any]):
"""
Expand Down Expand Up @@ -179,7 +180,7 @@ def request_params(

def parse_response(self, list_result: ListResult, **kwargs) -> Iterable[Mapping]:
for message in list_result:
yield message._response[self.name]
yield from transform_custom_fields(message._response[self.name])

def get_updated_state(self, current_stream_state: MutableMapping[str, Any], latest_record: Mapping[str, Any]):
"""
Expand Down
36 changes: 36 additions & 0 deletions airbyte-integrations/connectors/source-chargebee/source_chargebee/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
from typing import Any, Dict


def transform_custom_fields(record: Dict[str, Any]) -> Dict[str, Any]:
"""
Method to detect custom fields that start with 'cf_' from chargbee models.
Args:
record:
{
...
'cf_custom_fields': 'some_value',
...
}

Returns:
record:
{
...
'custom_fields': [{
'name': 'cf_custom_fields',
'value': some_value'
}],
...
}
"""

custom_fields = [key for key in record.keys() if key.startswith('cf_')]
new_custom_fields = []

if custom_fields:
for custom_field in custom_fields:
new_custom_fields.append({"name": custom_field, "value": record[custom_field]})

record['custom_fields'] = new_custom_fields

yield record