diff --git a/airbyte-integrations/connectors/source-recurly/metadata.yaml b/airbyte-integrations/connectors/source-recurly/metadata.yaml index 7bcf01d74add8..13fa5ff2a8c9b 100644 --- a/airbyte-integrations/connectors/source-recurly/metadata.yaml +++ b/airbyte-integrations/connectors/source-recurly/metadata.yaml @@ -7,7 +7,7 @@ data: connectorSubtype: api connectorType: source definitionId: cd42861b-01fc-4658-a8ab-5d11d0510f01 - dockerImageTag: 1.0.1 + dockerImageTag: 1.0.3 dockerRepository: airbyte/source-recurly documentationUrl: https://docs.airbyte.com/integrations/sources/recurly githubIssueLabel: source-recurly @@ -23,8 +23,9 @@ data: breakingChanges: 1.0.0: message: - Version 1.0.0 introduces a number of schema updates to the Recurly connector. - To ensure a smooth upgrade, please refresh your schemas and reset your data before resuming syncs. + Version 1.0.0 introduces a number of schema updates to the Recurly + connector. To ensure a smooth upgrade, please refresh your schemas and reset + your data before resuming syncs. upgradeDeadline: "2024-03-05" releaseStage: alpha remoteRegistries: diff --git a/airbyte-integrations/connectors/source-recurly/poetry.lock b/airbyte-integrations/connectors/source-recurly/poetry.lock index e3d56310c9316..e2a36d07fb072 100644 --- a/airbyte-integrations/connectors/source-recurly/poetry.lock +++ b/airbyte-integrations/connectors/source-recurly/poetry.lock @@ -1,40 +1,39 @@ -# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. [[package]] name = "airbyte-cdk" -version = "0.67.0" +version = "0.80.0" description = "A framework for writing Airbyte Connectors." optional = false -python-versions = ">=3.8" +python-versions = "<4.0,>=3.9" files = [ - {file = "airbyte-cdk-0.67.0.tar.gz", hash = "sha256:cbbff1b3895c89313764a721870bb293a396c74bad8dd6e5c36a0c3b0a2f6a10"}, - {file = "airbyte_cdk-0.67.0-py3-none-any.whl", hash = "sha256:2082c859536a2450c03b89dba1bbdab21bad314fbf5ef6d2e86fefc4ba935373"}, + {file = "airbyte_cdk-0.80.0-py3-none-any.whl", hash = "sha256:060e92323a73674fa4e9e2e4a1eb312b9b9d072c9bbe5fa28f54ef21cb4974f3"}, + {file = "airbyte_cdk-0.80.0.tar.gz", hash = "sha256:1383512a83917fecca5b24cea4c72aa5c561cf96dd464485fbcefda48fe574c5"}, ] [package.dependencies] airbyte-protocol-models = "0.5.1" backoff = "*" cachetools = "*" -Deprecated = ">=1.2,<2.0" +Deprecated = ">=1.2,<1.3" dpath = ">=2.0.1,<2.1.0" genson = "1.2.2" isodate = ">=0.6.1,<0.7.0" Jinja2 = ">=3.1.2,<3.2.0" -jsonref = ">=0.2,<1.0" +jsonref = ">=0.2,<0.3" jsonschema = ">=3.2.0,<3.3.0" pendulum = "<3.0.0" pydantic = ">=1.10.8,<2.0.0" pyrate-limiter = ">=3.1.0,<3.2.0" python-dateutil = "*" -PyYAML = ">=6.0.1" +PyYAML = ">=6.0.1,<7.0.0" requests = "*" -requests-cache = "*" +requests_cache = "*" wcmatch = "8.4" [package.extras] -dev = ["avro (>=1.11.2,<1.12.0)", "cohere (==4.21)", "fastavro (>=1.8.0,<1.9.0)", "freezegun", "langchain (==0.0.271)", "markdown", "mypy", "openai[embeddings] (==0.27.9)", "pandas (==2.0.3)", "pdf2image (==1.16.3)", "pdfminer.six (==20221105)", "pyarrow (==12.0.1)", "pytesseract (==0.3.10)", "pytest", "pytest-cov", "pytest-httpserver", "pytest-mock", "requests-mock", "tiktoken (==0.4.0)", "unstructured (==0.10.27)", "unstructured.pytesseract (>=0.3.12)", "unstructured[docx,pptx] (==0.10.27)"] -file-based = ["avro (>=1.11.2,<1.12.0)", "fastavro (>=1.8.0,<1.9.0)", "markdown", "pdf2image (==1.16.3)", "pdfminer.six (==20221105)", "pyarrow (==12.0.1)", "pytesseract (==0.3.10)", "unstructured (==0.10.27)", "unstructured.pytesseract (>=0.3.12)", "unstructured[docx,pptx] (==0.10.27)"] -sphinx-docs = ["Sphinx (>=4.2,<5.0)", "sphinx-rtd-theme (>=1.0,<2.0)"] +file-based = ["avro (>=1.11.2,<1.12.0)", "fastavro (>=1.8.0,<1.9.0)", "markdown", "pdf2image (==1.16.3)", "pdfminer.six (==20221105)", "pyarrow (>=15.0.0,<15.1.0)", "pytesseract (==0.3.10)", "unstructured.pytesseract (>=0.3.12)", "unstructured[docx,pptx] (==0.10.27)"] +sphinx-docs = ["Sphinx (>=4.2,<4.3)", "sphinx-rtd-theme (>=1.0,<1.1)"] vector-db-based = ["cohere (==4.21)", "langchain (==0.0.271)", "openai[embeddings] (==0.27.9)", "tiktoken (==0.4.0)"] [[package]] @@ -366,13 +365,13 @@ i18n = ["Babel (>=2.7)"] [[package]] name = "jsonref" -version = "0.3.0" -description = "jsonref is a library for automatic dereferencing of JSON Reference objects for Python." +version = "0.2" +description = "An implementation of JSON Reference for Python" optional = false -python-versions = ">=3.3,<4.0" +python-versions = "*" files = [ - {file = "jsonref-0.3.0-py3-none-any.whl", hash = "sha256:9480ad1b500f7e795daeb0ef29f9c55ae3a9ab38fb8d6659b6f4868acb5a5bc8"}, - {file = "jsonref-0.3.0.tar.gz", hash = "sha256:68b330c6815dc0d490dbb3d65ccda265ddde9f7856fd2f3322f971d456ea7549"}, + {file = "jsonref-0.2-py3-none-any.whl", hash = "sha256:b1e82fa0b62e2c2796a13e5401fe51790b248f6d9bf9d7212a3e31a3501b291f"}, + {file = "jsonref-0.2.tar.gz", hash = "sha256:f3c45b121cf6257eafabdc3a8008763aed1cd7da06dbabc59a9e4d2a5e4e6697"}, ] [[package]] @@ -1042,4 +1041,4 @@ files = [ [metadata] lock-version = "2.0" python-versions = "^3.9,<3.12" -content-hash = "f37d79c9bfb96e8cbd4ac45629e6df6fbdcc4afc2854ece9f0711a7a561dc5b8" +content-hash = "4843eceb07967beaffe917740b8353dfbd8fcfdfa662940ae76db251b0ff6a4f" diff --git a/airbyte-integrations/connectors/source-recurly/pyproject.toml b/airbyte-integrations/connectors/source-recurly/pyproject.toml index 5083827e29d23..2dea25c3d3ef0 100644 --- a/airbyte-integrations/connectors/source-recurly/pyproject.toml +++ b/airbyte-integrations/connectors/source-recurly/pyproject.toml @@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",] build-backend = "poetry.core.masonry.api" [tool.poetry] -version = "1.0.1" +version = "1.0.3" name = "source-recurly" description = "Source implementation for Recurly." authors = [ "Airbyte ",] @@ -17,7 +17,7 @@ include = "source_recurly" [tool.poetry.dependencies] python = "^3.9,<3.12" -airbyte-cdk = "==0.67.0" +airbyte-cdk = "0.80.0" recurly = "==4.10.0" [tool.poetry.scripts] diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/account_coupon_redemptions.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/account_coupon_redemptions.json index d9e894d584d32..3784caa1730c4 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/account_coupon_redemptions.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/account_coupon_redemptions.json @@ -3,42 +3,53 @@ "type": "object", "properties": { "id": { + "description": "The unique identifier for the redemption", "type": ["null", "string"], "maxLength": 13 }, "object": { + "description": "The type of object this represents", "type": ["null", "string"] }, "account": { + "description": "The account associated with the coupon redemption", "$ref": "account_details.json" }, "subscription_id": { + "description": "The subscription associated with the redemption", "type": ["null", "string"], "maxLength": 13 }, "coupon": { + "description": "The coupon being redeemed", "$ref": "coupons.json" }, "state": { + "description": "The current state of the redemption", "type": ["null", "string"], "maxLength": 256 }, "currency": { + "description": "The currency in which the redemption was made", "type": ["null", "string"], "maxLength": 3 }, "discounted": { + "description": "The amount discounted by the coupon", "type": ["null", "number"] }, "created_at": { + "description": "The date and time when the redemption was created", "type": ["null", "string"], "format": "date-time" }, "updated_at": { + "description": "The date and time when the redemption was last updated", "type": ["null", "string"], "format": "date-time" }, "removed_at": { + "description": "The date and time when the redemption was removed (if applicable)", "type": ["null", "string"], "format": "date-time" } diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/account_notes.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/account_notes.json index ee68e82c89736..04e7700ac738e 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/account_notes.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/account_notes.json @@ -3,25 +3,31 @@ "type": "object", "properties": { "id": { + "description": "The unique identifier for this note.", "type": "string", "maxLength": 13, "readOnly": true }, "object": { + "description": "Represents the object type, in this case, 'note'.", "type": ["null", "string"] }, "account_id": { + "description": "The unique identifier of the account associated with this note.", "type": "string", "maxLength": 13 }, "user": { + "description": "The user who created the note.", "$ref": "users.json" }, "message": { + "description": "The content or message of the note.", "type": ["null", "string"], "maxLength": 2048 }, "created_at": { + "description": "The date and time when the note was created.", "type": "string", "format": "date-time", "readOnly": true diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/accounts.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/accounts.json index c9f1c5b84953f..9d2dbb62b0994 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/accounts.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/accounts.json @@ -3,89 +3,111 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier of the account", "type": ["null", "string"], "maxLength": 13 }, "object": { + "description": "Type of object", "type": ["null", "string"] }, "hosted_login_token": { + "description": "Token for hosted login functionality", "type": ["null", "string"] }, "code": { + "description": "Unique code assigned to the account", "type": ["null", "string"], "maxLength": 256 }, "parent_account_id": { + "description": "ID of the parent account", "type": ["null", "string"], "maxLength": 13 }, "bill_to": { + "description": "The billing details", "type": ["null", "string"], "maxLength": 6 }, "state": { + "description": "State/province of the account address", "type": ["null", "string"], "maxLength": 256 }, "username": { + "description": "Username of the account holder", "type": ["null", "string"], "maxLength": 256 }, "email": { + "description": "Email address of the account holder", "type": ["null", "string"], "maxLength": 256 }, "cc_emails": { + "description": "Email addresses for carbon copy (CC)", "type": ["null", "string"], "maxLength": 256 }, "preferred_locale": { + "description": "Preferred language/locale of the account holder", "type": ["null", "string"], "maxLength": 12 }, "first_name": { + "description": "First name of the account holder", "type": ["null", "string"], "maxLength": 256 }, "last_name": { + "description": "Last name of the account holder", "type": ["null", "string"], "maxLength": 256 }, "company": { + "description": "Company associated with the account", "type": ["null", "string"], "maxLength": 50 }, "vat_number": { + "description": "VAT (Value Added Tax) number of the account", "type": ["null", "string"], "maxLength": 20 }, "tax_exempt": { + "description": "Flag indicating if the account is tax exempt", "type": ["null", "boolean"] }, "exemption_certificate": { + "description": "Exemption certificate details", "type": ["null", "string"], "maxLength": 30 }, "address": { + "description": "The address details of the account", "type": "object", "properties": { "phone": { + "description": "Phone number associated with the address", "type": "string", "title": "Phone number", "maxLength": 256 }, "street1": { + "description": "First line of the street address", "type": "string", "title": "Street 1", "maxLength": 256 }, "street2": { + "description": "Second line of the street address", "type": "string", "title": "Street 2", "maxLength": 256 }, "city": { + "description": "City of the address", "type": "string", "title": "City", "maxLength": 256 @@ -109,11 +131,13 @@ "maxLength": 2 }, "geo_code": { + "description": "Geographical coordinates of the address", "type": ["null", "string"] } } }, "custom_fields": { + "description": "Custom fields associated with the account", "type": ["null", "array"], "items": { "type": ["null", "object"], @@ -121,58 +145,74 @@ } }, "has_live_subscription": { + "description": "Flag indicating if the account has a live subscription", "type": ["null", "boolean"] }, "has_active_subscription": { + "description": "Flag indicating if the account has an active subscription", "type": ["null", "boolean"] }, "has_future_subscription": { + "description": "Flag indicating if the account has a future subscription", "type": ["null", "boolean"] }, "has_canceled_subscription": { + "description": "Flag indicating if the account has a canceled subscription", "type": ["null", "boolean"] }, "has_paused_subscription": { + "description": "Flag indicating if the account has a paused subscription", "type": ["null", "boolean"] }, "has_past_due_invoice": { + "description": "Flag indicating if the account has a past due invoice", "type": ["null", "boolean"] }, "dunning_campaign_id": { + "description": "Campaign ID for dunning management", "type": ["null", "string"], "maxLength": 256 }, "created_at": { + "description": "Date and time when the account was created", "type": ["null", "string"], "format": "date-time" }, "updated_at": { + "description": "Date and time when the account was last updated", "type": ["null", "string"], "format": "date-time" }, "deleted_at": { + "description": "Date and time when the account was deleted", "type": ["null", "string"], "format": "date-time" }, "billing_info": { + "description": "Billing information", "$ref": "billing_infos.json" }, "external_accounts": { + "description": "External accounts associated with the account", "type": ["null", "array"], "items": { "$ref": "external_accounts.json" } }, "invoice_template_id": { + "description": "ID of the invoice template used", "type": ["null", "string"] }, "override_business_entity_id": { + "description": "ID for overriding business entity", "type": ["null", "string"] }, "preferred_time_zone": { + "description": "Preferred time zone of the account holder", "type": ["null", "string"] }, "shipping_addresses": { + "description": "Addresses for shipping", "type": ["null", "array"], "items": { "$ref": "shipping_addresses.json" diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/add_ons.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/add_ons.json index ffeea5d2f1bef..495b67048015d 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/add_ons.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/add_ons.json @@ -3,12 +3,14 @@ "type": "object", "properties": { "id": { + "description": "The unique identifier for the add-on.", "type": "string", "title": "Add-on ID", "maxLength": 13, "readOnly": true }, "plan_id": { + "description": "The ID of the plan to which the add-on is associated.", "type": "string", "title": "Plan ID", "maxLength": 13, @@ -130,18 +132,21 @@ "maxLength": 256 }, "created_at": { + "description": "The date and time when the add-on was created.", "type": "string", "format": "date-time", "title": "Created at", "readOnly": true }, "updated_at": { + "description": "The date and time when the add-on was last updated.", "type": "string", "format": "date-time", "title": "Last updated at", "readOnly": true }, "deleted_at": { + "description": "The date and time when the add-on was deleted, if applicable.", "type": "string", "format": "date-time", "title": "Deleted at", diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/credit_payments.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/credit_payments.json index 98d827bb6074e..ad04abff79d00 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/credit_payments.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/credit_payments.json @@ -3,6 +3,7 @@ "type": "object", "properties": { "id": { + "description": "The unique identifier of the credit payment.", "type": "string", "title": "Credit Payment ID", "maxLength": 13 @@ -20,10 +21,12 @@ "maxLength": 256 }, "account": { + "description": "Details about the account associated with the credit payment.", "type": "object", "title": "Account mini details", "properties": { "id": { + "description": "The ID of the account associated with the credit payment.", "type": "string", "maxLength": 13, "readOnly": true @@ -36,15 +39,18 @@ } }, "applied_to_invoice": { + "description": "Details about the invoice to which the credit payment is applied.", "type": ["null", "object"], "title": "Invoice mini details", "properties": { "id": { + "description": "The ID of the invoice to which the credit payment is applied.", "type": "string", "title": "Invoice ID", "maxLength": 13 }, "number": { + "description": "The number of the invoice to which the credit payment is applied.", "type": "string", "title": "Invoice number", "maxLength": 256 @@ -52,15 +58,18 @@ } }, "original_invoice": { + "description": "Details about the original invoice for which the credit payment is made.", "type": ["null", "object"], "title": "Invoice mini details", "properties": { "id": { + "description": "The ID of the original invoice for which the credit payment was made.", "type": "string", "title": "Invoice ID", "maxLength": 13 }, "number": { + "description": "The number of the original invoice for which the credit payment was made.", "type": "string", "title": "Invoice number", "maxLength": 256 @@ -86,9 +95,11 @@ "maxLength": 13 }, "refund_transaction": { + "description": "Details about the refund transaction associated with the credit payment.", "type": ["null", "object"], "properties": { "id": { + "description": "The ID of the refund transaction associated with the credit payment.", "type": "string", "title": "Transaction ID", "maxLength": 13 @@ -102,18 +113,21 @@ } }, "created_at": { + "description": "The date and time when the credit payment was created.", "type": "string", "title": "Created at", "format": "date-time", "readOnly": true }, "updated_at": { + "description": "The date and time when the credit payment was last updated.", "type": "string", "title": "Last updated at", "format": "date-time", "readOnly": true }, "voided_at": { + "description": "The date and time when the credit payment was voided.", "type": ["null", "string"], "title": "Voided at", "format": "date-time", diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/export_dates.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/export_dates.json index f63e37989deaa..2bb3e50df215a 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/export_dates.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/export_dates.json @@ -3,8 +3,10 @@ "type": "object", "properties": { "dates": { + "description": "List of export dates", "type": ["null", "array"], "items": { + "description": "Date of the export", "type": ["null", "string"], "maxLength": 256 } diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/invoices.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/invoices.json index 6e5f4732e0798..8657b0d35fae3 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/invoices.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/invoices.json @@ -3,15 +3,18 @@ "type": "object", "properties": { "id": { + "description": "The unique ID of the invoice.", "type": ["null", "string"], "title": "Invoice ID", "readOnly": true, "maxLength": 13 }, "uuid": { + "description": "The universally unique identifier (UUID) of the invoice.", "type": ["null", "string"] }, "object": { + "description": "The type of object, in this case, an invoice.", "type": ["null", "string"] }, "type": { @@ -27,11 +30,13 @@ "maxLength": 256 }, "state": { + "description": "The current state of the invoice.", "title": "Invoice state", "type": ["null", "string"], "maxLength": 256 }, "account": { + "description": "The account associated with the invoice.", "$ref": "account_details.json" }, "billing_info_id": { @@ -82,34 +87,41 @@ "default": 0 }, "address": { + "description": "The address details related to the invoice recipient.", "type": ["null", "object"], "properties": { "name_on_account": { + "description": "The name on the account.", "type": ["null", "string"], "title": "Name on account", "maxLength": 256 }, "company": { + "description": "The company name in the address.", "type": ["null", "string"], "title": "Company", "maxLength": 256 }, "phone": { + "description": "The phone number associated with the address.", "type": ["null", "string"], "title": "Phone number", "maxLength": 256 }, "street1": { + "description": "The first line of the street address.", "type": ["null", "string"], "title": "Street 1", "maxLength": 256 }, "street2": { + "description": "The second line of the street address.", "type": ["null", "string"], "title": "Street 2", "maxLength": 256 }, "city": { + "description": "The city in the address.", "type": ["null", "string"], "title": "City", "maxLength": 256 @@ -133,19 +145,23 @@ "maxLength": 2 }, "first_name": { + "description": "The first name of the recipient.", "type": ["null", "string"], "maxLength": 256 }, "last_name": { + "description": "The last name of the recipient.", "type": ["null", "string"], "maxLength": 256 } } }, "shipping_address": { + "description": "The shipping address details for the invoice delivery.", "type": ["null", "object"], "properties": { "id": { + "description": "The ID of the shipping address.", "type": ["null", "string"], "title": "Shipping Address ID", "maxLength": 13, @@ -202,6 +218,7 @@ "description": "The outstanding balance remaining on this invoice." }, "tax_info": { + "description": "Tax information related to the invoice.", "type": ["null", "object"], "title": "Tax info", "properties": { @@ -217,6 +234,7 @@ "description": "Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST." }, "rate": { + "description": "The tax rate applied to the invoice.", "type": ["null", "number"], "format": "float", "title": "Rate" @@ -258,6 +276,7 @@ } }, "used_tax_service": { + "description": "Indicates if a tax service was used for the invoice.", "type": ["null", "boolean"] }, "vat_number": { @@ -285,6 +304,7 @@ "maxLength": 2048 }, "line_items": { + "description": "The line items included in the invoice.", "type": ["null", "array"], "title": "Line Items", "items": { @@ -292,15 +312,18 @@ } }, "has_more_line_items": { + "description": "Indicates if there are more line items in the invoice.", "type": ["null", "boolean"] }, "transactions": { + "description": "The transactions associated with the invoice.", "type": ["null", "array"], "title": "Transactions", "items": { "type": ["null", "object"], "properties": { "id": { + "description": "The ID of a transaction linked to the invoice.", "type": "string", "title": "Transaction ID", "maxLength": 13 @@ -315,12 +338,14 @@ } }, "credit_payments": { + "description": "The credit payments related to the invoice.", "type": ["null", "array"], "title": "Credit payments", "items": { "type": ["null", "object"], "properties": { "id": { + "description": "The ID of a credit payment associated with the invoice.", "type": "string", "title": "Credit Payment ID", "maxLength": 13 @@ -335,12 +360,14 @@ } }, "created_at": { + "description": "The date and time when the invoice was created.", "type": ["null", "string"], "format": "date-time", "title": "Created at", "readOnly": true }, "updated_at": { + "description": "The date and time when the invoice was last updated.", "type": ["null", "string"], "format": "date-time", "title": "Last updated at", @@ -365,12 +392,15 @@ "maxLength": 256 }, "dunning_events_sent": { + "description": "The number of dunning events sent for the invoice.", "type": ["null", "integer"] }, "final_dunning_event": { + "description": "The final dunning event related to the invoice if applicable.", "type": ["null", "boolean"] }, "business_entity_id": { + "description": "The business entity ID linked to the invoice.", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/measured_units.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/measured_units.json index 7865d44d30797..9ec9cd1f354d5 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/measured_units.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/measured_units.json @@ -3,37 +3,46 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the measured unit", "type": ["null", "string"], "maxLength": 13 }, "object": { + "description": "Type of object, in this case, 'measured_unit'", "type": ["null", "string"] }, "name": { + "description": "Internal name used to identify the measured unit", "type": ["null", "string"], "maxLength": 256 }, "display_name": { + "description": "Human-readable name used for display purposes", "type": ["null", "string"], "maxLength": 255 }, "state": { + "description": "Current state of the measured unit", "type": ["null", "string"], "maxLength": 255 }, "description": { + "description": "Description of the measured unit", "type": ["null", "string"], "maxLength": 1024 }, "created_at": { + "description": "Timestamp indicating when the measured unit was created", "type": ["null", "string"], "format": "date-time" }, "updated_at": { + "description": "Timestamp indicating when the measured unit was last updated", "type": ["null", "string"], "format": "date-time" }, "deleted_at": { + "description": "Timestamp indicating when the measured unit was deleted (if applicable)", "type": ["null", "string"], "format": "date-time" } diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/plans.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/plans.json index aabac321be539..53b9f3eb9c9ab 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/plans.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/plans.json @@ -3,71 +3,90 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier of the plan.", "type": ["null", "string"], "maxLength": 13 }, "object": { + "description": "Indicates the type of object which in this case is 'plan'.", "type": ["null", "string"] }, "code": { + "description": "Unique identifier code for the plan.", "type": ["null", "string"], "maxLength": 256 }, "state": { + "description": "The current state of the plan.", "type": ["null", "string"], "maxLength": 256 }, "name": { + "description": "Name of the plan.", "type": ["null", "string"], "maxLength": 256 }, "description": { + "description": "Description of the plan.", "type": ["null", "string"], "maxLength": 1024 }, "interval_unit": { + "description": "Unit of the billing interval for the plan.", "type": ["null", "string"], "maxLength": 256 }, "interval_length": { + "description": "Length of the billing interval for the plan.", "type": ["null", "number"] }, "trial_unit": { + "description": "Unit of the trial period for the plan.", "type": ["null", "string"], "maxLength": 256 }, "trial_length": { + "description": "Length of the trial period for the plan.", "type": ["null", "number"] }, "trial_requires_billing_info": { + "description": "Determines if billing information is required for the trial.", "type": ["null", "boolean"] }, "total_billing_cycles": { + "description": "Total number of billing cycles the plan will run for.", "type": ["null", "number"] }, "auto_renew": { + "description": "Indicates whether the plan should automatically renew.", "type": ["null", "boolean"] }, "pricing_model": { + "description": "The pricing model used for the plan.", "type": ["null", "string"] }, "ramp_intervals": { + "description": "Specifies ramp intervals for the plan.", "type": ["null", "array"], "items": { "type": ["null", "object"], "properties": { "starting_billing_cycle": { + "description": "The starting billing cycle for the ramp interval.", "type": ["null", "integer"] }, "currencies": { + "description": "Contains currencies information within the ramp intervals.", "type": ["null", "array"], "items": { "type": ["null", "object"], "properties": { "currency": { + "description": "Currency code for the interval.", "type": ["null", "string"] }, "unit_amount": { + "description": "Unit amount for the currency in the interval.", "type": ["null", "number"] } } @@ -77,49 +96,61 @@ } }, "custom_fields": { + "description": "Includes any custom fields associated with the plan.", "type": ["null", "array"], "items": { "type": ["null", "object"], "properties": { "name": { + "description": "Name of the custom field.", "type": ["null", "string"] }, "value": { + "description": "Value of the custom field.", "type": ["null", "string"] } } } }, "accounting_code": { + "description": "The accounting code associated with the plan.", "type": ["null", "string"], "maxLength": 256 }, "revenue_schedule_type": { + "description": "Type of revenue schedule for the plan.", "type": ["null", "string"], "maxLength": 256 }, "setup_fee_revenue_schedule_type": { + "description": "Revenue schedule type for the setup fee.", "type": ["null", "string"], "maxLength": 256 }, "setup_fee_accounting_code": { + "description": "The accounting code associated with the setup fee.", "type": ["null", "string"], "maxLength": 256 }, "avalara_transaction_type": { + "description": "The Avalara transaction type used for tax calculation.", "type": ["null", "number"] }, "avalara_service_type": { + "description": "The Avalara service type used for tax calculation.", "type": ["null", "number"] }, "tax_code": { + "description": "Tax code used for the plan.", "type": ["null", "string"], "maxLength": 256 }, "tax_exempt": { + "description": "Determines if the plan is tax exempt.", "type": ["null", "boolean"] }, "currencies": { + "description": "Contains information about the currencies supported by the plan.", "type": "array", "title": "Pricing", "items": { @@ -140,6 +171,7 @@ "maximum": 1000000 }, "unit_amount": { + "description": "Unit amount for the currency in the plan.", "type": "number", "format": "float", "title": "Unit price", @@ -150,40 +182,50 @@ } }, "hosted_pages": { + "description": "Provides details about hosted pages related to the plan.", "type": "object", "properties": { "success_url": { + "description": "URL to redirect when a user successfully completes hosted page process.", "type": ["null", "string"], "maxLength": 2048 }, "cancel_url": { + "description": "URL to redirect when a user cancels during hosted page process.", "type": ["null", "string"], "maxLength": 2048 }, "bypass_confirmation": { + "description": "Determines if confirmation is bypassed on hosted pages.", "type": ["null", "boolean"] }, "display_quantity": { + "description": "Determines if quantity is displayed on hosted pages.", "type": ["null", "boolean"] } } }, "allow_any_item_on_subscriptions": { + "description": "Determines if any item can be added to subscriptions using this plan.", "type": ["null", "boolean"] }, "dunning_campaign_id": { + "description": "ID of the dunning campaign associated with the plan.", "type": ["null", "string"], "maxLength": 256 }, "created_at": { + "description": "Timestamp indicating when the plan was created.", "type": ["null", "string"], "format": "date-time" }, "updated_at": { + "description": "Timestamp indicating when the plan was last updated.", "type": ["null", "string"], "format": "date-time" }, "deleted_at": { + "description": "Timestamp indicating when the plan was deleted.", "type": ["null", "string"], "format": "date-time" } diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/shipping_methods.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/shipping_methods.json index 23ba22deb2a26..b31a6bb521ef9 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/shipping_methods.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/shipping_methods.json @@ -3,6 +3,7 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the shipping method", "type": "string", "title": "Shipping Method ID", "readOnly": true, @@ -33,18 +34,21 @@ "maxLength": 50 }, "created_at": { + "description": "Timestamp indicating when the shipping method was created", "type": "string", "format": "date-time", "title": "Created at", "readOnly": true }, "updated_at": { + "description": "Timestamp indicating when the shipping method was last updated", "type": "string", "format": "date-time", "title": "Last updated at", "readOnly": true }, "deleted_at": { + "description": "Timestamp indicating when the shipping method was deleted", "type": "string", "format": "date-time", "title": "Deleted at", diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/subscriptions.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/subscriptions.json index 27c3b0ad4ea1a..07cbe6de2ecdb 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/subscriptions.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/subscriptions.json @@ -3,17 +3,21 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the subscription.", "type": ["null", "string"], "maxLength": 13 }, "object": { + "description": "Indicates the type of object (subscription).", "type": ["null", "string"] }, "uuid": { + "description": "Universally unique identifier for the subscription.", "type": ["null", "string"], "maxLength": 32 }, "account": { + "description": "Information about the associated account for the subscription", "type": ["null", "object"], "properties": { "id": { @@ -52,6 +56,7 @@ } }, "plan": { + "description": "Information about the plan associated with the subscription", "type": "object", "properties": { "id": { @@ -71,10 +76,12 @@ } }, "state": { + "description": "Current state of the subscription (e.g., active, cancelled).", "type": ["null", "string"], "maxLength": 256 }, "shipping": { + "description": "Information about the shipping associated with the subscription", "type": ["null", "object"], "properties": { "object": { @@ -84,6 +91,7 @@ "$ref": "shipping_addresses.json" }, "method": { + "description": "Information about the shipping method", "type": ["null", "object"], "properties": { "id": { @@ -108,8 +116,12 @@ } } }, - "coupon_redemptions": { "$ref": "coupon_redemptions.json" }, + "coupon_redemptions": { + "description": "Details of any coupons redeemed for the subscription.", + "$ref": "coupon_redemptions.json" + }, "pending_change": { + "description": "Information about any pending changes to the subscription", "type": ["null", "object"], "title": "Subscription Change", "properties": { @@ -126,6 +138,7 @@ "maxLength": 13 }, "activate_at": { + "description": "Timestamp when the pending change will be activated", "type": "string", "format": "date-time", "title": "Activated at", @@ -137,18 +150,21 @@ "description": "Returns `true` if the subscription change is activated." }, "created_at": { + "description": "Timestamp when the pending change was created", "type": "string", "format": "date-time", "title": "Created at", "readOnly": true }, "updated_at": { + "description": "Timestamp when the pending change was last updated", "type": "string", "format": "date-time", "title": "Updated at", "readOnly": true }, "deleted_at": { + "description": "Timestamp when the pending change was deleted", "type": "string", "format": "date-time", "title": "Deleted at", @@ -157,42 +173,53 @@ } }, "current_period_started_at": { + "description": "Timestamp when the current period started", "type": ["null", "string"], "format": "date-time" }, "current_period_ends_at": { + "description": "Timestamp when the current period ends", "type": ["null", "string"], "format": "date-time" }, "current_term_started_at": { + "description": "Timestamp when the current term started", "type": ["null", "string"], "format": "date-time" }, "current_term_ends_at": { + "description": "Timestamp when the current term ends", "type": ["null", "string"], "format": "date-time" }, "trial_started_at": { + "description": "Timestamp when the trial period started", "type": ["null", "string"], "format": "date-time" }, "trial_ends_at": { + "description": "Timestamp when the trial period ends", "type": ["null", "string"], "format": "date-time" }, "remaining_billing_cycles": { + "description": "Number of billing cycles remaining before subscription ends.", "type": ["null", "number"] }, "total_billing_cycles": { + "description": "Total number of billing cycles for the subscription.", "type": ["null", "number"] }, "renewal_billing_cycles": { + "description": "Number of billing cycles in the renewal period.", "type": ["null", "number"] }, "auto_renew": { + "description": "Flag indicating whether the subscription auto renews.", "type": ["null", "boolean"] }, "ramp_intervals": { + "description": "Information about any ramp intervals associated with the subscription", "type": ["null", "array"], "items": { "type": ["null", "object"], @@ -204,10 +231,12 @@ "type": ["null", "integer"] }, "starting_on": { + "description": "Timestamp when the ramp interval starts", "type": ["null", "string"], "format": "date-time" }, "ending_on": { + "description": "Timestamp when the ramp interval ends", "type": ["null", "string"], "format": "date-time" }, @@ -218,30 +247,38 @@ } }, "paused_at": { + "description": "Timestamp when the subscription was paused", "type": ["null", "string"], "format": "date-time" }, "remaining_pause_cycles": { + "description": "Number of pause cycles remaining for the subscription.", "type": ["null", "number"] }, "currency": { + "description": "Currency used for billing the subscription.", "type": ["null", "string"], "maxLength": 3 }, "revenue_schedule_type": { + "description": "Type of revenue schedule for the subscription.", "type": ["null", "string"], "maxLength": 256 }, "unit_amount": { + "description": "Amount charged per unit for the subscription.", "type": ["null", "number"] }, "tax_inclusive": { + "description": "Flag indicating if taxes are included in the total amount.", "type": ["null", "boolean"] }, "quantity": { + "description": "Number of units or items included in the subscription.", "type": ["null", "number"] }, "add_ons": { + "description": "Any additional services or items added to the subscription.", "type": ["null", "array"], "title": "Add-ons", "items": { @@ -264,47 +301,60 @@ } }, "add_ons_total": { + "description": "Total amount charged for the additional services or items.", "type": ["null", "number"] }, "subtotal": { + "description": "Subtotal amount before taxes and additional charges.", "type": ["null", "number"] }, "tax": { + "description": "Total tax amount applied to the subscription.", "type": ["null", "number"] }, "tax_info": { + "description": "Details of the tax information for the subscription.", "$ref": "tax_info.json" }, "total": { + "description": "Total amount including taxes and additional charges.", "type": ["null", "number"] }, "collection_method": { + "description": "Method used for collecting payments for the subscription.", "type": ["null", "string"], "maxLength": 256 }, "po_number": { + "description": "Purchase order number associated with the subscription.", "type": ["null", "string"], "maxLength": 256 }, "net_terms": { + "description": "Number of net terms for payment.", "type": ["null", "number"] }, "net_terms_type": { + "description": "Type of net terms (e.g., days).", "type": ["null", "string"] }, "terms_and_conditions": { + "description": "Terms and conditions agreed upon for the subscription.", "type": ["null", "string"], "maxLength": 16384 }, "customer_notes": { + "description": "Any notes or comments added by the customer.", "type": ["null", "string"], "maxLength": 1024 }, "expiration_reason": { + "description": "Reason for the subscription expiration.", "type": ["null", "string"], "maxLength": 1024 }, "custom_fields": { + "description": "Custom fields associated with the subscription", "type": ["null", "array"], "items": { "type": ["null", "object"], @@ -319,48 +369,60 @@ } }, "created_at": { + "description": "Timestamp when the subscription was created", "type": ["null", "string"], "format": "date-time" }, "updated_at": { + "description": "Timestamp when the subscription was last updated", "type": ["null", "string"], "format": "date-time" }, "activated_at": { + "description": "Timestamp when the subscription was activated", "type": ["null", "string"], "format": "date-time" }, "canceled_at": { + "description": "Timestamp when the subscription was canceled", "type": ["null", "string"], "format": "date-time" }, "expires_at": { + "description": "Timestamp when the subscription expires", "type": ["null", "string"], "format": "date-time" }, "bank_account_authorized_at": { + "description": "Timestamp when bank account authorization occurred", "type": ["null", "string"], "format": "date-time" }, "gateway_code": { + "description": "Code associated with the payment gateway used for processing payments.", "type": ["null", "string"], "maxLength": 256 }, "billing_info_id": { + "description": "ID of the billing information associated with the subscription.", "type": ["null", "string"], "maxLength": 13 }, "active_invoice_id": { + "description": "ID of the active invoice associated with the subscription.", "type": ["null", "string"] }, "started_with_gift": { + "description": "Indicates if the subscription started with a gift or promotion.", "type": ["null", "boolean"] }, "converted_at": { + "description": "Timestamp when the subscription was converted", "type": ["null", "string"], "format": "date-time" }, "action_result": { + "description": "Result of the action performed on the subscription.", "type": ["null", "object"], "additionalProperties": true } diff --git a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/transactions.json b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/transactions.json index 7b06e0d76cb53..b242a04df67a1 100644 --- a/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/transactions.json +++ b/airbyte-integrations/connectors/source-recurly/source_recurly/schemas/transactions.json @@ -4,24 +4,30 @@ "additionalProperties": true, "properties": { "id": { + "description": "Unique identifier for the transaction", "type": ["null", "string"], "maxLength": 13 }, "object": { + "description": "Type of object (transaction)", "type": ["null", "string"] }, "uuid": { + "description": "Universally unique identifier for the transaction", "type": ["null", "string"], "maxLength": 32 }, "original_transaction_id": { + "description": "ID of the original transaction, if applicable", "type": ["null", "string"], "maxLength": 13 }, "account": { + "description": "Details of the account associated with the transaction", "$ref": "account_details.json" }, "invoice": { + "description": "Details of the invoice associated with the transaction", "type": ["null", "object"], "properties": { "id": { @@ -44,6 +50,7 @@ } }, "voided_by_invoice": { + "description": "Details of the invoice that voided the transaction", "type": ["null", "object"], "properties": { "id": { @@ -69,6 +76,7 @@ } }, "subscription_ids": { + "description": "List of subscription IDs associated with the transaction", "type": "array", "items": { "type": ["null", "string"], @@ -76,34 +84,43 @@ } }, "type": { + "description": "Type of transaction", "type": ["null", "string"], "maxLength": 256 }, "origin": { + "description": "Source or origin of the transaction", "type": ["null", "string"], "maxLength": 256 }, "currency": { + "description": "Currency used for the transaction", "type": ["null", "string"], "maxLength": 3 }, "amount": { + "description": "Amount of the transaction", "type": ["null", "number"] }, "status": { + "description": "Current status of the transaction", "type": ["null", "string"], "maxLength": 256 }, "success": { + "description": "Indicates the success status of the transaction", "type": ["null", "boolean"] }, "backup_payment_method_used": { + "description": "Indicates whether a backup payment method was used", "type": ["null", "boolean"] }, "refunded": { + "description": "Indicates whether the transaction has been refunded", "type": ["null", "boolean"] }, "billing_address": { + "description": "Billing address details of the transaction", "type": "object", "properties": { "first_name": { @@ -148,10 +165,12 @@ } }, "collection_method": { + "description": "Method used to collect the transaction", "type": ["null", "string"], "maxLength": 256 }, "payment_method": { + "description": "Details of the payment method used for the transaction", "type": "object", "properties": { "object": { @@ -216,30 +235,37 @@ } }, "ip_address_v4": { + "description": "IPv4 address of the transaction", "type": ["null", "string"], "maxLength": 256 }, "ip_address_country": { + "description": "Country of the IP address used for the transaction", "type": ["null", "string"], "maxLength": 256 }, "status_code": { + "description": "Status code of the transaction", "type": ["null", "string"], "maxLength": 256 }, "status_message": { + "description": "Message related to the status of the transaction", "type": ["null", "string"], "maxLength": 1024 }, "customer_message": { + "description": "Message for the customer related to the transaction", "type": ["null", "string"], "maxLength": 1024 }, "customer_message_locale": { + "description": "Locale of the customer message", "type": ["null", "string"], "maxLength": 12 }, "payment_gateway": { + "description": "Details of the payment gateway used for the transaction", "type": "object", "properties": { "id": { @@ -258,59 +284,74 @@ } }, "gateway_message": { + "description": "Message returned by the payment gateway", "type": ["null", "string"], "maxLength": 256 }, "gateway_reference": { + "description": "Reference number provided by the payment gateway", "type": ["null", "string"], "maxLength": 256 }, "gateway_approval_code": { + "description": "Approval code provided by the payment gateway", "type": ["null", "string"], "maxLength": 256 }, "gateway_response_code": { + "description": "Response code from the payment gateway", "type": ["null", "string"], "maxLength": 256 }, "gateway_response_time": { + "description": "Time taken for the payment gateway to respond", "type": ["null", "number"] }, "gateway_response_values": { + "description": "Additional values in the gateway response", "type": "object" }, "cvv_check": { + "description": "Result of the CVV check", "type": ["null", "string"], "maxLength": 256 }, "avs_check": { + "description": "Result of the Address Verification System check", "type": ["null", "string"], "maxLength": 256 }, "created_at": { + "description": "Date and time when the transaction was created", "type": ["null", "string"], "format": "date-time" }, "updated_at": { + "description": "Date and time of the last update to the transaction", "type": ["null", "string"], "format": "date-time" }, "voided_at": { + "description": "Date and time when the transaction was voided", "type": ["null", "string"], "format": "date-time" }, "collected_at": { + "description": "Date and time when the transaction was collected", "type": ["null", "string"], "format": "date-time" }, "action_result": { + "description": "Result of the action taken for the transaction", "type": ["null", "object"], "additionalProperties": true }, "vat_number": { + "description": "VAT number associated with the transaction", "type": ["null", "string"] }, "fraud_info": { + "description": "Information related to fraud check for the transaction", "type": ["null", "object"], "properties": { "object": { @@ -328,6 +369,7 @@ "risk_rules_triggered": { "type": ["null", "array"], "items": { + "description": "Details of individual risk rules triggered", "type": ["null", "object"], "properties": { "code": { diff --git a/docs/integrations/sources/recurly.md b/docs/integrations/sources/recurly.md index 2e31f5d9c71b2..26d9af6bc5717 100644 --- a/docs/integrations/sources/recurly.md +++ b/docs/integrations/sources/recurly.md @@ -64,6 +64,8 @@ We recommend creating a restricted, read-only key specifically for Airbyte acces | Version | Date | Pull Request | Subject | |:--------|:-----------| :--------------------------------------------------------| :--------------------------------------------------------------------------------------- | +| 1.0.3 | 2024-04-19 | [37246](https://github.com/airbytehq/airbyte/pull/37246) | Updating to 0.80.0 CDK | +| 1.0.2 | 2024-04-12 | [37246](https://github.com/airbytehq/airbyte/pull/37246) | schema descriptions | | 1.0.1 | 2024-03-05 | [35828](https://github.com/airbytehq/airbyte/pull/35828) | Bump version to unarchive supportLevel in Cloud productionDB | | 1.0.0 | 2024-03-01 | [35763](https://github.com/airbytehq/airbyte/pull/35763) | Re-introduce updated connector to catalog from archival repo | | 0.5.0 | 2024-02-22 | [34622](https://github.com/airbytehq/airbyte/pull/34622) | Republish connector using base image/Poetry, update schemas |