Add tap-totango.

[edsoncezar16]

name: tap-totango
variant: indiciumtech
namespace: tap_totango
description: Totango is an agile Customer Success Software that helps you design, run, measure, and scale your SaaS customer journey to retain and grow customers.
docs: https://bitbucket.org/indiciumtech/tap-totango/src/main/README.md
repo: https://bitbucket.org/indiciumtech/tap-totango
executable: tap-totango
capabilities:
  - catalog
  - discover
  - state
  - about
  - stream-maps
pip_url: tap-totango
maintenance_status: active
definition: is a plugin that allows for Totango API data ingestion into data pipelines.
settings_preamble: |
  Each endpoint from the [Totango Search API](https://support.totango.com/hc/en-us/sections/360005893212-Totango-API) requires some parameters with the same name for the query, such as `terms`, `count`, and `offset`. In these cases, we provide settings namespaced by the stream name (e.g. `accounts_terms`,  `users_offset` , etc.).
next_steps: |
  You should create a [Totango API personal access token](https://support.totango.com/hc/en-us/articles/203036939-Personal-Access-Token-and-Service-ID) and provide it as the `auth_token` setting for the tap.

  We recommend passing it as an environment variable. For instance, when using the tap with Meltano you should add the following line to your `.env` file:

  `export TAP_TOTANGO_AUTH_TOKEN=< YOUR_PERSONAL_ACCESS_TOKEN >`
usage: |
  You can easily run `tap-totango` by itself or in a pipeline using [Meltano](https://meltano.com/).

  - Test invocation:
  `meltano invoke tap-totango --version`
  - run a test `elt` pipeline:
  `meltano elt tap-totango target-jsonl`
keywords:
  - api
  - meltano_sdk
  - totango
settings_group_validation:
- - api_url
  - auth_token
  - events_terms
  - events_count
  - events_offset
  - accounts_terms
  - accounts_fields
  - users_terms
  - users_fields
settings:
  - name: api_url
    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.
    documentation: https://support.totango.com/hc/en-us/articles/360048132792-Search-API-events-
    kind: string 
    value: https://api.totango.com
  - name: auth_token
    description: |
      The token to authenticate against the API service.
    documentation: https://support.totango.com/hc/en-us/articles/203036939-Personal-Access-Token-and-Service-ID
    kind: password
  - name: events_terms
    description: |
      An array containing filter conditions to use for the events stream search.
    documentation: https://support.totango.com/hc/en-us/articles/360048132792-Search-API-events-
    kind: array
    value: []
  - name: events_count
    description: |
      The maximum number of accounts to return in the events result set.

      The max. value for count is `1000`.
    documentation: https://support.totango.com/hc/en-us/articles/360048132792-Search-API-events-
    kind: integer
    value: 1000
  - name: events_offset
    description: |
      Page number (0 is the 1st-page).
    documentation: https://support.totango.com/hc/en-us/articles/360048132792-Search-API-events-
    kind: integer
    value: 0
  - name: account_id
    description: |
      Filter the events stream results for a specific account.
    documentation: https://support.totango.com/hc/en-us/articles/360048132792-Search-API-events-
    kind: string
  - name: accounts_terms
    description: |
      An array containing filter conditions to use for the accounts stream search.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: array
    value: []
  - name: accounts_fields
    description: |
      List of fields to return as results. 

      Note that the account name and account-id are always returned as well.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: array
    value: []
  - name: accounts_count
    description: |
      The maximum number of accounts to return in the accounts result set. 

      The max. value for count is 1000.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: integer
    value: 1000
  - name: accounts_offset
    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’s more, in which case you want to pull the next 1000 records (offset: 1000…then 2000…etc.). Repeat paging until the number of records returned is less than 1000.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: integer
    value: 0
  - name: accounts_sort_by
    description: |
      Field name to sort the accounts stream results set by.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: string
    value: "display_name"
  - name: accounts_sort_order
    description: |
      Order to sort the accounts stream results set by.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: string
    value: "ASC"
  - name: users_terms
    description: |
      An array containing filter conditions to use for the users stream search.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: array
    value: []
  - name: users_fields
    description: |
      List of fields to return as results. 

      Note that the account name and account-id are always returned as well.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: array
    value: []
  - name: users_count
    description: |
      The maximum number of accounts to return in the users result set. 

      The max. value for count is 1000.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: integer
    value: 1000
  - name: users_offset
    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’s more, in which case you want to pull the next 1000 records (offset: 1000…then 2000…etc.). Repeat paging until the number of records returned is less than 1000.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: integer
    value: 0
  - name: users_sort_by
    description: |
      Field name to sort the users stream results set by.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: string
    value: "display_name"
  - name: users_sort_order
    description: |
      Order to sort the users stream results set by.
    documentation: https://support.totango.com/hc/en-us/articles/204174135-Search-API-accounts-and-users-
    kind: string
    value: "ASC"

[pnadolny13]

@edsoncezar16 thanks for opening this! I'll get a PR open this week to add it.

[pnadolny13]

@edsoncezar16 we got a notification in #1337 that the totango repo is not available anymore. This is giving me a 404 https://bitbucket.org/indiciumtech/tap-totango. Is that expected?

[edsoncezar16]

Hi, there. That repo is in the workspace of the company I curently work on, and it was made private due to company policies. You can change the plugin .yml to pass 'tap-totango' as the pip url, since there is a PyPi project for the tap that I maintain and is up to date the original repo main branch. If a git url is mandatory, I can clone the repo to a personal workspace and change the .yml to the new location as soon as possible. I will wait for your feedback regarding which one is the best course of action. Sincerely, Edson. Em seg., 22 de mai. de 2023 11:28, Pat Nadolny ***@***.***> escreveu:

…

@edsoncezar16 <https://github.com/edsoncezar16> we got a notification in #1337 <#1337> that the totango repo is not available anymore. This is giving me a 404 https://bitbucket.org/indiciumtech/tap-totango. Is that expected? — Reply to this email directly, view it on GitHub <#1318 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AE7FU2QKZXQJEHSEJZS3R3DXHNZYLANCNFSM6AAAAAAYAVXREY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[edsoncezar16]

@pnadolny13 to complement the previous answer, the open repo for the tap is now:

https://github.com/edsoncezar16/tap-totango

To make things crystal clear, the current version of the plugin was done as a preparation for a company's client request. I did not anticipate possible issues in using the company's workspace for that because the original intention was not to publish it to Meltano Hub. But now the whole team is aware of the development of the public version of the plugin and the variant name.

[pnadolny13]

@edsoncezar16 totally understandable and thanks for the clarification! Not everyone is able to make their repos public. Thanks for following up, I'll update the hub definition to use your new github repo