-
Notifications
You must be signed in to change notification settings - Fork 69
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.
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
chore: [Hub Bot] Refresh metadata 2025-01-06 #1919
Conversation
✅ Deploy Preview for meltano-hub ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Testing plugin
Auto-generated README.md
|
Setting | Required | Default | Description |
---|---|---|---|
api_key | True | None | The token to authenticate against the API service |
start_date | False | None | The earliest record date to sync |
dc | True | None | Your Mailchimp DC |
stream_maps | False | None | Config object for stream maps capability. For more information check out Stream Maps. |
stream_map_config | False | None | User-defined config values to be used within map expressions. |
flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
flattening_max_depth | False | None | The max depth to flatten schemas. |
A full list of supported settings and capabilities is available by running: tap-mailchimp --about
Version info
tap-mailchimp v0.0.1, Meltano SDK v0.24.0
Usage info
melty-bot % tap-mailchimp --help
Usage: tap-mailchimp [OPTIONS]
Execute the Singer tap.
Options:
--state PATH Use a bookmarks file for incremental replication.
--catalog PATH Use a Singer catalog file with the tap.
--test TEXT Use --test to sync a single record for each
stream. Use --test=schema to test schema output
without syncing records.
--discover Run the tap in discovery mode.
--config TEXT Configuration file location or 'ENV' to use
environment variables.
--format [json|markdown] Specify output style for --about
--about Display package metadata and settings.
--version Display the package version.
--help Show this message and exit.
Detected capabilities
- ✅ 'discover'
- ✅ 'catalog'
- ✅ 'state'
- ✅ 'about'
JSON Metadata
{
"name": "tap-mailchimp",
"description": "Mailchimp tap class.",
"version": "0.0.1",
"sdk_version": "0.24.0",
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening"
],
"settings": {
"type": "object",
"properties": {
"api_key": {
"type": [
"string"
],
"description": "The token to authenticate against the API service",
"secret": true,
"writeOnly": true
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The earliest record date to sync"
},
"dc": {
"type": [
"string"
],
"description": "Your Mailchimp DC"
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html)."
},
"stream_map_config": {
"type": [
"object",
"null"
],
"properties": {},
"description": "User-defined config values to be used within map expressions."
},
"flattening_enabled": {
"type": [
"boolean",
"null"
],
"description": "'True' to enable schema flattening and automatically expand nested properties."
},
"flattening_max_depth": {
"type": [
"integer",
"null"
],
"description": "The max depth to flatten schemas."
}
},
"required": [
"api_key",
"dc"
]
}
}
Discovered streams
campaigns
lists
lists_members
reports_email_activity
reports_sent_to
reports_unsubscribes
Testing plugin
Version info
Usage info
Detected capabilities
JSON Metadata{
"name": "tap-totango",
"description": "totango tap class.",
"version": "0.5.0",
"sdk_version": "0.27.0",
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening"
],
"settings": {
"type": "object",
"properties": {
"api_url": {
"type": [
"string"
],
"default": "https://api.totango.com",
"description": "The url for the API services. https://api.totango.com is for US services, whereas https://api-eu1.totango.com is for EU services.",
"enum": [
"https://api.totango.com",
"https://api-eu1.totango.com "
]
},
"auth_token": {
"type": [
"string"
],
"description": "The token to authenticate against the API service",
"secret": true,
"writeOnly": true
},
"events_terms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "An array containing filter conditions to use for the events stream search.",
"examples": [
[
{
"type": "event_property",
"name": "event_type",
"eq": "note"
}
],
[
{
"type": "or",
"or": [
{
"type": "event_property",
"name": "event_type",
"eq": "note"
},
{
"type": "event_property",
"name": "event_type",
"eq": "campaign_touch"
}
]
}
],
[
{
"type": "date",
"term": "date",
"joker": "yesterday"
},
{
"type": "or",
"or": [
{
"type": "event_property",
"name": "event_type",
"eq": "note"
},
{
"type": "event_property",
"name": "event_type",
"eq": "campaign_touch"
}
]
}
],
[
{
"type": "date",
"term": "date",
"gte": 1587859200000
},
{
"type": "event_property",
"name": "event_type",
"eq": "note"
}
]
]
},
"events_count": {
"type": [
"integer"
],
"default": 1000,
"description": "The maximum number of accounts to return in the events result set. The max. value for count is 1000."
},
"events_offset": {
"type": [
"integer"
],
"default": 0,
"description": "Page number (0 is the 1st-page)."
},
"account_id": {
"type": [
"string",
"null"
],
"description": "Filter the events stream results for a specific account."
},
"accounts_terms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "An array containing filter conditions to use for the accounts stream search.",
"examples": [
[
{
"type": "string",
"term": "status_group",
"in_list": [
"paying"
]
}
]
]
},
"accounts_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "List of fields to return as results. Note that the account name and account-id are always returned as well.",
"examples": [
[
{
"type": "string",
"term": "health",
"field_display_name": "Health rank "
},
{
"type": "health_trend",
"field_display_name": "Health last change "
},
{
"type": "string_attribute",
"attribute": "Success Manager",
"field_display_name": "Success Manager"
}
]
]
},
"accounts_count": {
"type": [
"integer",
"null"
],
"default": 100,
"description": "The maximum number of accounts to return in the accounts result set. The max. value for count is 1000."
},
"accounts_offset": {
"type": [
"integer",
"null"
],
"default": 0,
"description": "Record number (0 states \"start at record 0\"). The record size can be defined using the count parameter (and limited to 1000). Tip: To page through results, ask for 1000 records (count: 1000). If you receive 1000 records, assume there\u2019s more, in which case you want to pull the next 1000 records (offset: 1000\u2026then 2000\u2026etc.). Repeat paging until the number of records returned is less than 1000."
},
"accounts_sort_by": {
"type": [
"string",
"null"
],
"default": "display_name",
"description": "Field name to sort the accounts stream results set by."
},
"accounts_sort_order": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC"
],
"default": "ASC",
"description": "Order to sort the accounts stream results set by."
},
"users_terms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "An array containing filter conditions to use for the users stream search.",
"examples": [
[
{
"type": "parent_account",
"terms": [
{
"type": "string",
"term": "status_group",
"in_list": [
"paying"
]
}
]
}
]
]
},
"users_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "List of fields to return as results. Note that the user name and id along with account name and account-id are always returned as well.",
"examples": [
[
{
"type": "date",
"term": "last_activity_time",
"field_display_name": "Last activity",
"desc": true
},
{
"type": "named_aggregation",
"aggregation": "total_activities",
"duration": 14,
"field_display_name": "Activities (14d)"
}
]
]
},
"users_count": {
"type": [
"integer",
"null"
],
"default": 1000,
"description": "The maximum number of users to return in the users result set. The max. value for count is 1000."
},
"users_offset": {
"type": [
"integer",
"null"
],
"default": 0,
"description": "Record number (0 states \"start at record 0\"). The record size can be defined using the count parameter (and limited to 1000). Tip: To page through results, ask for 1000 records (count: 1000). If you receive 1000 records, assume there\u2019s more, in which case you want to pull the next 1000 records (offset: 1000\u2026then 2000\u2026etc.). Repeat paging until the number of records returned is less than 1000."
},
"users_sort_by": {
"type": [
"string",
"null"
],
"default": "display_name",
"description": "Field name to sort the users stream results set by."
},
"users_sort_order": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC"
],
"default": "ASC",
"description": "Order to sort the users stream results set by."
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html)."
},
"stream_map_config": {
"type": [
"object",
"null"
],
"properties": {},
"description": "User-defined config values to be used within map expressions."
},
"flattening_enabled": {
"type": [
"boolean",
"null"
],
"description": "'True' to enable schema flattening and automatically expand nested properties."
},
"flattening_max_depth": {
"type": [
"integer",
"null"
],
"description": "The max depth to flatten schemas."
}
},
"required": [
"api_url",
"auth_token",
"events_terms",
"events_count",
"events_offset",
"accounts_terms",
"accounts_fields",
"users_terms",
"users_fields"
]
}
} Discovered streams
|
Updates Plugin Definitions