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.

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-02-03 #1935

Merged
merged 3 commits into from
Feb 4, 2025

Conversation

MeltyBot
Copy link
Contributor

@MeltyBot MeltyBot commented Feb 3, 2025

Updates Plugin Definitions

Copy link

github-actions bot commented Feb 3, 2025

Testing plugin tap-capsulecrm (matatika variant):

Starting test job...
...
Job completed.

Auto-generated README.md

tap-capsulecrm

Capsulecrm tap class.

Built with the Meltano Singer SDK.

Capabilities

  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening
  • batch

Settings

Setting Required Default Description
client_id False None
client_secret False None
refresh_token False None
expires_in False None
access_token False None
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.
faker_config False None Config for the Faker instance variable fake used within map expressions. Only applicable if the plugin specifies faker as an additional dependency (through the singer-sdk faker extra or directly).
faker_config.seed False None Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
faker_config.locale False None One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
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.
batch_config False None Configuration for BATCH message capabilities.
batch_config.encoding False None Specifies the format and compression of the batch files.
batch_config.encoding.format False None Format to use for batch files.
batch_config.encoding.compression False None Compression format to use for batch files.
batch_config.storage False None Defines the storage layer to use when writing batch files
batch_config.storage.root False None Root path to use when writing batch files.
batch_config.storage.prefix False None Prefix to use when writing batch files.

A full list of supported settings and capabilities is available by running: tap-capsulecrm --about

Version info
tap-capsulecrm v0.5.1, Meltano SDK v0.44.2
Usage info
melty-bot % tap-capsulecrm --help
Usage: tap-capsulecrm [OPTIONS]

  Execute the Singer tap.

Options:
  --version                 Display the package version.
  --about                   Display package metadata and settings.
  --format [json|markdown]  Specify output style for --about
  --config TEXT             Configuration file location or 'ENV' to use
                            environment variables.
  --discover                Run the tap in discovery mode.
  --test TEXT               Use --test to sync a single record for each
                            stream. Use --test=schema to test schema output
                            without syncing records.
  --catalog FILE            Use a Singer catalog file with the tap.
  --state FILE              Use a bookmarks file for incremental replication.
  --help                    Show this message and exit.
Detected capabilities
  • ✅ 'discover'
  • ✅ 'catalog'
  • ✅ 'state'
  • ✅ 'about'
JSON Metadata
{
  "name": "tap-capsulecrm",
  "description": "Capsulecrm tap class.",
  "version": "0.5.1",
  "sdk_version": "0.44.2",
  "supported_python_versions": [],
  "capabilities": [
    "catalog",
    "state",
    "discover",
    "about",
    "stream-maps",
    "schema-flattening",
    "batch"
  ],
  "settings": {
    "type": "object",
    "properties": {
      "client_id": {
        "type": [
          "string",
          "null"
        ]
      },
      "client_secret": {
        "type": [
          "string",
          "null"
        ]
      },
      "refresh_token": {
        "type": [
          "string",
          "null"
        ]
      },
      "expires_in": {
        "type": [
          "integer",
          "null"
        ]
      },
      "access_token": {
        "type": [
          "string",
          "null"
        ]
      },
      "stream_maps": {
        "type": [
          "object",
          "null"
        ],
        "properties": {},
        "title": "Stream Maps",
        "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": {},
        "title": "User Stream Map Configuration",
        "description": "User-defined config values to be used within map expressions."
      },
      "faker_config": {
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "seed": {
            "oneOf": [
              {
                "type": [
                  "number"
                ]
              },
              {
                "type": [
                  "string"
                ]
              },
              {
                "type": [
                  "boolean"
                ]
              },
              {
                "type": "null"
              }
            ],
            "title": "Faker Seed",
            "description": "Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator"
          },
          "locale": {
            "oneOf": [
              {
                "type": [
                  "string"
                ]
              },
              {
                "type": "array",
                "items": {
                  "type": [
                    "string"
                  ]
                }
              },
              {
                "type": "null"
              }
            ],
            "title": "Faker Locale",
            "description": "One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization"
          }
        },
        "title": "Faker Configuration",
        "description": "Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an additional dependency (through the `singer-sdk` `faker` extra or directly)."
      },
      "flattening_enabled": {
        "type": [
          "boolean",
          "null"
        ],
        "title": "Enable Schema Flattening",
        "description": "'True' to enable schema flattening and automatically expand nested properties."
      },
      "flattening_max_depth": {
        "type": [
          "integer",
          "null"
        ],
        "title": "Max Flattening Depth",
        "description": "The max depth to flatten schemas."
      },
      "batch_config": {
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "encoding": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "format": {
                "type": [
                  "string",
                  "null"
                ],
                "title": "Batch Encoding Format",
                "description": "Format to use for batch files.",
                "enum": [
                  "jsonl",
                  "parquet"
                ]
              },
              "compression": {
                "type": [
                  "string",
                  "null"
                ],
                "title": "Batch Compression Format",
                "description": "Compression format to use for batch files.",
                "enum": [
                  "gzip",
                  "none"
                ]
              }
            },
            "title": "Batch Encoding Configuration",
            "description": "Specifies the format and compression of the batch files."
          },
          "storage": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "root": {
                "type": [
                  "string",
                  "null"
                ],
                "title": "Batch Storage Root",
                "description": "Root path to use when writing batch files."
              },
              "prefix": {
                "type": [
                  "string",
                  "null"
                ],
                "title": "Batch Storage Prefix",
                "description": "Prefix to use when writing batch files."
              }
            },
            "title": "Batch Storage Configuration",
            "description": "Defines the storage layer to use when writing batch files"
          }
        },
        "title": "Batch Configuration",
        "description": "Configuration for BATCH message capabilities."
      }
    },
    "$schema": "https://json-schema.org/draft/2020-12/schema"
  }
}
Discovered streams
  • opportunities
  • opportunity_parties
  • parties
  • project_parties
  • projects

Copy link

github-actions bot commented Feb 3, 2025

Testing plugin tap-mailchimp (acarter24 variant):

Starting test job...
...
Job completed.

Auto-generated README.md

tap-mailchimp

Mailchimp tap class.

Built with the Meltano Singer SDK.

Capabilities

  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening

Settings

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

Copy link

netlify bot commented Feb 3, 2025

Deploy Preview for meltano-hub ready!

Name Link
🔨 Latest commit 527d01a
🔍 Latest deploy log https://app.netlify.com/sites/meltano-hub/deploys/67a24b2b6ac514000878ea32
😎 Deploy Preview https://deploy-preview-1935--meltano-hub.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Feb 3, 2025

Testing plugin tap-mysql (meltanolabs variant):

Starting test job...
...
Job completed.

Auto-generated README.md

tap-mysql

Singer tap for MySQL.

Built with the Meltano Singer SDK.

Capabilities

  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening
  • batch

Settings

Setting Required Default Description
host False None Hostname for mysql instance. Note if sqlalchemy_url is set this will be ignored.
port False 3306 The port on which mysql is awaiting connection. Note if sqlalchemy_url is set this will be ignored.
user False None User name used to authenticate. Note if sqlalchemy_url is set this will be ignored.
password False None Password used to authenticate. Note if sqlalchemy_url is set this will be ignored.
database False None Database name. Note if sqlalchemy_url is set this will be ignored.
sqlalchemy_options False None sqlalchemy_url options (also called the query), to connect to PlanetScale you must turn on SSL see PlanetScale information below. Note if sqlalchemy_url is set this will be ignored.
sqlalchemy_url False None Example pymysql://[username]:[password]@localhost:3306/[db_name][?options] see https://docs.sqlalchemy.org/en/20/dialects/mysql.html#module-sqlalchemy.dialects.mysql.pymysql for more information
filter_schemas False None If an array of schema names is provided, the tap will only process the specified MySQL schemas and ignore others. If left blank, the tap automatically determines ALL available MySQL schemas.
is_vitess False None By default we'll check if the database is a Vitess instance. If you would rather not automatically check, set this to False. See Vitess/PlanetScale documentation below for more information.
ssh_tunnel False None SSH Tunnel Configuration, this is a json object
ssh_tunnel.enable True 0 Enable an ssh tunnel (also known as bastion host), see the other ssh_tunnel.* properties for more details
ssh_tunnel.host True None Host of the bastion host, this is the host we'll connect to via ssh
ssh_tunnel.username True None Username to connect to bastion host
ssh_tunnel.port True 22 Port to connect to bastion host
ssh_tunnel.private_key True None Private Key for authentication to the bastion host
ssh_tunnel.private_key_password False None Private Key Password, leave None if no password is set
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.
faker_config False None Config for the Faker instance variable fake used within map expressions. Only applicable if the plugin specifies faker as an addtional dependency (through the singer-sdk faker extra or directly).
faker_config.seed False None Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
faker_config.locale False None One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
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.
batch_config False None Configuration for BATCH message capabilities.
batch_config.encoding False None Specifies the format and compression of the batch files.
batch_config.encoding.format False None Format to use for batch files.
batch_config.encoding.compression False None Compression format to use for batch files.
batch_config.storage False None Defines the storage layer to use when writing batch files
batch_config.storage.root False None Root path to use when writing batch files.
batch_config.storage.prefix False None Prefix to use when writing batch files.

A full list of supported settings and capabilities is available by running: tap-mysql --about

Version info
tap-mysql v[could not be detected], Meltano SDK v0.43.1
Usage info
melty-bot % tap-mysql --help
Usage: tap-mysql [OPTIONS]

  Execute the Singer tap.

Options:
  --version                 Display the package version.
  --about                   Display package metadata and settings.
  --format [json|markdown]  Specify output style for --about
  --config TEXT             Configuration file location or 'ENV' to use
                            environment variables.
  --discover                Run the tap in discovery mode.
  --test TEXT               Use --test to sync a single record for each
                            stream. Use --test=schema to test schema output
                            without syncing records.
  --catalog FILE            Use a Singer catalog file with the tap.
  --state FILE              Use a bookmarks file for incremental replication.
  --help                    Show this message and exit.
Detected capabilities
  • ✅ 'discover'
  • ✅ 'catalog'
  • ✅ 'state'
  • ✅ 'about'
JSON Metadata
{
  "name": "tap-mysql",
  "description": "Singer tap for MySQL.",
  "version": "[could not be detected]",
  "sdk_version": "0.43.1",
  "supported_python_versions": null,
  "capabilities": [
    "catalog",
    "state",
    "discover",
    "about",
    "stream-maps",
    "schema-flattening",
    "batch"
  ],
  "settings": {
    "type": "object",
    "properties": {
      "host": {
        "type": [
          "string",
          "null"
        ],
        "description": "Hostname for mysql instance. Note if sqlalchemy_url is set this will be ignored."
      },
      "port": {
        "type": [
          "integer",
          "null"
        ],
        "default": 3306,
        "description": "The port on which mysql is awaiting connection. Note if sqlalchemy_url is set this will be ignored."
      },
      "user": {
        "type": [
          "string",
          "null"
        ],
        "description": "User name used to authenticate. Note if sqlalchemy_url is set this will be ignored."
      },
      "password": {
        "type": [
          "string",
          "null"
        ],
        "description": "Password used to authenticate. Note if sqlalchemy_url is set this will be ignored.",
        "secret": true,
        "writeOnly": true
      },
      "database": {
        "type": [
          "string",
          "null"
        ],
        "description": "Database name. Note if sqlalchemy_url is set this will be ignored."
      },
      "sqlalchemy_options": {
        "type": [
          "object",
          "null"
        ],
        "properties": {},
        "additionalProperties": {
          "type": [
            "string"
          ]
        },
        "description": "sqlalchemy_url options (also called the query), to connect to PlanetScale you must turn on SSL see PlanetScale information below. Note if sqlalchemy_url is set this will be ignored."
      },
      "sqlalchemy_url": {
        "type": [
          "string",
          "null"
        ],
        "description": "Example pymysql://[username]:[password]@localhost:3306/[db_name][?options] see https://docs.sqlalchemy.org/en/20/dialects/mysql.html#module-sqlalchemy.dialects.mysql.pymysql for more information",
        "secret": true,
        "writeOnly": true
      },
      "filter_schemas": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": [
            "string"
          ]
        },
        "description": "If an array of schema names is provided, the tap will only process the specified MySQL schemas and ignore others. If left blank, the tap automatically determines ALL available MySQL schemas."
      },
      "is_vitess": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "By default we'll check if the database is a Vitess instance. If you would rather not automatically check, set this to `False`. See Vitess/PlanetScale documentation below for more information."
      },
      "ssh_tunnel": {
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "enable": {
            "type": [
              "boolean"
            ],
            "default": false,
            "description": "Enable an ssh tunnel (also known as bastion host), see the other ssh_tunnel.* properties for more details"
          },
          "host": {
            "type": [
              "string"
            ],
            "description": "Host of the bastion host, this is the host we'll connect to via ssh"
          },
          "username": {
            "type": [
              "string"
            ],
            "description": "Username to connect to bastion host"
          },
          "port": {
            "type": [
              "integer"
            ],
            "default": 22,
            "description": "Port to connect to bastion host"
          },
          "private_key": {
            "type": [
              "string"
            ],
            "description": "Private Key for authentication to the bastion host",
            "secret": true,
            "writeOnly": true
          },
          "private_key_password": {
            "type": [
              "string",
              "null"
            ],
            "description": "Private Key Password, leave None if no password is set",
            "secret": true,
            "writeOnly": true
          }
        },
        "required": [
          "enable",
          "host",
          "username",
          "port",
          "private_key"
        ],
        "description": "SSH Tunnel Configuration, this is a json object"
      },
      "stream_maps": {
        "type": [
          "object",
          "null"
        ],
        "properties": {},
        "title": "Stream Maps",
        "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": {},
        "title": "User Stream Map Configuration",
        "description": "User-defined config values to be used within map expressions."
      },
      "faker_config": {
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "seed": {
            "oneOf": [
              {
                "type": [
                  "number"
                ]
              },
              {
                "type": [
                  "string"
                ]
              },
              {
                "type": [
                  "boolean"
                ]
              },
              {
                "type": "null"
              }
            ],
            "title": "Faker Seed",
            "description": "Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator"
          },
          "locale": {
            "oneOf": [
              {
                "type": [
                  "string"
                ]
              },
              {
                "type": "array",
                "items": {
                  "type": [
                    "string"
                  ]
                }
              },
              {
                "type": "null"
              }
            ],
            "title": "Faker Locale",
            "description": "One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization"
          }
        },
        "title": "Faker Configuration",
        "description": "Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra or directly)."
      },
      "flattening_enabled": {
        "type": [
          "boolean",
          "null"
        ],
        "title": "Enable Schema Flattening",
        "description": "'True' to enable schema flattening and automatically expand nested properties."
      },
      "flattening_max_depth": {
        "type": [
          "integer",
          "null"
        ],
        "title": "Max Flattening Depth",
        "description": "The max depth to flatten schemas."
      },
      "batch_config": {
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "encoding": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "format": {
                "type": [
                  "string",
                  "null"
                ],
                "title": "Batch Encoding Format",
                "description": "Format to use for batch files.",
                "enum": [
                  "jsonl",
                  "parquet"
                ]
              },
              "compression": {
                "type": [
                  "string",
                  "null"
                ],
                "title": "Batch Compression Format",
                "description": "Compression format to use for batch files.",
                "enum": [
                  "gzip",
                  "none"
                ]
              }
            },
            "title": "Batch Encoding Configuration",
            "description": "Specifies the format and compression of the batch files."
          },
          "storage": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "root": {
                "type": [
                  "string",
                  "null"
                ],
                "title": "Batch Storage Root",
                "description": "Root path to use when writing batch files."
              },
              "prefix": {
                "type": [
                  "string",
                  "null"
                ],
                "title": "Batch Storage Prefix",
                "description": "Prefix to use when writing batch files."
              }
            },
            "title": "Batch Storage Configuration",
            "description": "Defines the storage layer to use when writing batch files"
          }
        },
        "title": "Batch Configuration",
        "description": "Configuration for BATCH message capabilities."
      }
    },
    "$schema": "https://json-schema.org/draft/2020-12/schema"
  }
}

Copy link

github-actions bot commented Feb 3, 2025

Testing plugin tap-totango (edsoncezar16 variant):

Starting test job...
...
Job completed.

Version info
tap-totango v0.5.0, Meltano SDK v0.27.0
Usage info
melty-bot % tap-totango --help
Usage: tap-totango [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-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
  • accounts
  • events
  • users

@edgarrmondragon edgarrmondragon added this pull request to the merge queue Feb 4, 2025
Merged via the queue into main with commit dd5a1cb Feb 4, 2025
15 of 16 checks passed
@edgarrmondragon edgarrmondragon deleted the hub-bot-metadata-2025-02-03-13113075521-118-1 branch February 4, 2025 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants