🎉 Source Chargebee: add event model stream(#10143)

* feat(chargebee): add event model

* fix(airbyte): update version Dockerfile

* docs(chargebee): update changelog

* bump connector version

* correct source seed

Co-authored-by: Marcos Marx <[email protected]>

Author: joelluijmes

airbyte-config/init/src/main/resources/config/STANDARD_SOURCE_DEFINITION/686473f1-76d9-4994-9cc7-9b13da46147c.json

@@ -2,7 +2,7 @@
   "sourceDefinitionId": "686473f1-76d9-4994-9cc7-9b13da46147c",
   "name": "Chargebee",
   "dockerRepository": "airbyte/source-chargebee",
-  "dockerImageTag": "0.1.4",
+  "dockerImageTag": "0.1.6",
   "documentationUrl": "https://docs.airbyte.io/integrations/sources/chargebee",
   "icon": "chargebee.svg"
 }

airbyte-config/init/src/main/resources/seed/source_definitions.yaml

@@ -112,7 +112,7 @@
 - name: Chargebee
   sourceDefinitionId: 686473f1-76d9-4994-9cc7-9b13da46147c
   dockerRepository: airbyte/source-chargebee
-  dockerImageTag: 0.1.5
+  dockerImageTag: 0.1.6
   documentationUrl: https://docs.airbyte.io/integrations/sources/chargebee
   icon: chargebee.svg
   sourceType: api

airbyte-config/init/src/main/resources/seed/source_specs.yaml

@@ -952,7 +952,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-chargebee:0.1.5"
+- dockerImage: "airbyte/source-chargebee:0.1.6"
   spec:
     documentationUrl: "https://apidocs.chargebee.com/docs/api"
     connectionSpecification:

airbyte-integrations/connectors/source-chargebee/Dockerfile

@@ -13,5 +13,5 @@ RUN pip install .
 
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.1.5
+LABEL io.airbyte.version=0.1.6
 LABEL io.airbyte.name=airbyte/source-chargebee

airbyte-integrations/connectors/source-chargebee/integration_tests/configured_catalog.json

@@ -103,6 +103,19 @@
       "sync_mode": "incremental",
       "destination_sync_mode": "append",
       "cursor_field": ["updated_at"]
+    },
+    {
+      "stream": {
+        "name": "event",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh", "incremental"],
+        "source_defined_cursor": true,
+        "default_cursor_field": ["occurred_at"],
+        "source_defined_primary_key": [["id"]]
+      },
+      "sync_mode": "incremental",
+      "destination_sync_mode": "append",
+      "cursor_field": ["occurred_at"]
     }
   ]
 }

airbyte-integrations/connectors/source-chargebee/source_chargebee/schemas/event.json

@@ -0,0 +1,80 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "name": "Item",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": ["string", "null"],
+      "maxLength": 40
+    },
+    "occurred_at": {
+      "type": ["integer", "null"]
+    },
+    "source": {
+      "type": ["string", "null"],
+      "enum": [
+        "admin_console",
+        "api",
+        "scheduled_job",
+        "hosted_page",
+        "portal",
+        "system",
+        "none",
+        "js_api",
+        "migration",
+        "bulk_operation",
+        "external_service"
+      ]
+    },
+    "user": {
+      "type": ["string", "null"],
+      "maxLength": 150
+    },
+    "event_type": {
+      "type": ["string", "null"]
+    },
+    "api_version": {
+      "type": ["string", "null"],
+      "enum": ["v1", "v2"]
+    },
+    "webhook_status": {
+      "type": ["string", "null"],
+      "enum": [
+        "not_configured",
+        "scheduled",
+        "succeeded",
+        "re_scheduled",
+        "failed",
+        "skipped",
+        "not_applicable"
+      ]
+    },
+    "content": {
+      "type": ["object", "null"]
+    },
+    "webhooks": {
+      "type": ["array", "null"],
+      "items": {
+        "type": ["object", "null"],
+        "properties": {
+          "id": {
+            "type": ["string", "null"],
+            "maxLength": 40
+          },
+          "webhook_status": {
+            "type": ["string", "null"],
+            "enum": [
+              "not_configured",
+              "scheduled",
+              "succeeded",
+              "re_scheduled",
+              "failed",
+              "skipped",
+              "not_applicable"
+            ]
+          }
+        }
+      }
+    }
+  }
+}

airbyte-integrations/connectors/source-chargebee/source_chargebee/source.py

@@ -9,7 +9,7 @@
 from airbyte_cdk.sources import AbstractSource
 from airbyte_cdk.sources.streams import Stream
 
-from .streams import Addon, AttachedItem, Customer, Invoice, Item, ItemPrice, Order, Plan, Subscription
+from .streams import Addon, AttachedItem, Customer, Event, Invoice, Item, ItemPrice, Order, Plan, Subscription
 
 
 class SourceChargebee(AbstractSource):
@@ -35,6 +35,7 @@ def streams(self, config) -> List[Stream]:
         # Below streams are suitable for both `Product Catalog 1.0` and `Product Catalog 2.0`.
         common_streams = [
             Customer(**kwargs),
+            Event(**kwargs),
             Invoice(**kwargs),
             Order(**kwargs),
             Subscription(**kwargs),

airbyte-integrations/connectors/source-chargebee/source_chargebee/streams.py

@@ -13,6 +13,7 @@
 from chargebee.models import Addon as AddonModel
 from chargebee.models import AttachedItem as AttachedItemModel
 from chargebee.models import Customer as CustomerModel
+from chargebee.models import Event as EventModel
 from chargebee.models import Invoice as InvoiceModel
 from chargebee.models import Item as ItemModel
 from chargebee.models import ItemPrice as ItemPriceModel
@@ -276,3 +277,13 @@ def _send_request(
         """
         params = self.request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token)
         return self.api.list(id=stream_slice["item_id"], params=params)
+
+
+class Event(IncrementalChargebeeStream):
+    """
+    API docs: https://apidocs.eu.chargebee.com/docs/api/events?prod_cat_ver=2#list_events
+    """
+
+    cursor_field = "occurred_at"
+
+    api = EventModel

docs/integrations/sources/chargebee.md

@@ -25,10 +25,11 @@ This connector outputs the following streams:
 Some streams may depend on Product Catalog version and be accessible only on sites with specific Product Catalog version. This means that we have following streams:
 
 1. presented in both `Product Catalog 1.0` and `Product Catalog 2.0`:
-   * Subscriptions
    * Customers
+   * Events
    * Invoices
    * Orders
+   * Subscriptions
 2. presented only in `Product Catalog 1.0`:
    * Plans
    * Addons
@@ -37,7 +38,7 @@ Some streams may depend on Product Catalog version and be accessible only on sit
    * Item Prices
    * Attached Items
 
-Also, 8 streams from the above 9 incremental streams are pure incremental meaning that they:
+Also, 9 streams from the above 10 incremental streams are pure incremental meaning that they:
 
 * read only new records;
 * output only new records.
@@ -81,6 +82,7 @@ Log into Chargebee and then generate an [API Key](https://apidocs.chargebee.com/
 
 | Version | Date | Pull Request | Subject |
 | :--- | :--- | :--- | :--- |
+| 0.1.6 | 2022-02-10 | [10143](https://github.com/airbytehq/airbyte/pull/10143) | Add support for Event stream |
 | 0.1.5 | 2021-12-23 | [8434](https://github.com/airbytehq/airbyte/pull/8434) | Update fields in source-connectors specifications |
 | 0.1.4 | 2021-09-27 | [6454](https://github.com/airbytehq/airbyte/pull/6454) | Fix examples in spec file |
 | 0.1.3 | 2021-08-17 | [5421](https://github.com/airbytehq/airbyte/pull/5421) | Add support for "Product Catalog 2.0" specific streams: `Items`, `Item prices` and `Attached Items` |