zuora-aqua-client-cli 1.2.0

Run ZOQL queries through AQuA from the command line

zuora-aqua-client-cli

Run ZOQL queries through AQuA from the command line

Installation

Mac

pip3 install zuora-aqua-client-cli The executable will be installed to /usr/local/bin/zacc

Linux

pip3 install zuora-aqua-client-cli The executable will be installed to ~/.local/bin/zacc

Make sure ~/.local/bin/ is added to your $PATH

Configuration

Configuration should be provided by the -c /path/to/file option.

If option is not provided, will be read from ~/.zacc.ini

Example config

[zacc]
# When environement option is ommited the default environment will be used
default_environment = preprod

[prod]
# Use production Zuora endpoints, defaults to `false`
production = true                                            
client_id = <oauth_client_id>
client_secret = <oauth_client_secret>

[mysandbox]
client_id = <oauth_client_id>
client_secret = <oauth_client_secret>

Usage

Cheatsheet

# List fiels for resource
$ zacc describe Account
Account
  AccountNumber - Account Number
  AdditionalEmailAddresses - Additional Email Addresses
  AllowInvoiceEdit - Allow Invoice Editing
  AutoPay - Auto Pay
  Balance - Account Balance
  ...
Related Objects
  BillToContact<Contact> - Bill To
  DefaultPaymentMethod<PaymentMethod> - Default Payment Method
  ParentAccount<Account> - Parent Account
  SoldToContact<Contact> - Sold To

# Request a bearer token, then exit
$ zacc bearer
Bearer aaaaaaaaaaaaaaaaaaaaaaaaaaa

# Execute an AQuA job
$ zacc query -z "select Account.Name from Account where Account.CreatedDate > '2019-01-10'"
Account.Name
John Doe
Jane Doe

# Save results to CSV file instead of printing it
$ zacc query -z ~/query_names.zoql -o account_names.csv

# Execute an AQuA job from a ZOQL query file
$ zacc query -z ~/query_names.zoql
Account.Name
John Doe
Jane Doe

# Use different configurations than default
$ zacc -c ~/.myotherzaccconfig.ini -e notdefualtenv query -z ~/query_names.zoql

Commands

zacc

Usage: zacc [OPTIONS] COMMAND [ARGS]...

  Sets up an API client, passes to commands in context

Options:
  -c, --config-filename PATH  Config file containing Zuora ouath credentials
                              [default: /Users/prezi/.zacc.ini]
  -e, --environment TEXT      Zuora environment to execute on
  --help                      Show this message and exit.

Commands:
  bearer    Prints bearer than exits
  describe  List available fields of Zuora resource
  query     Run ZOQL Query

zacc query

Usage: zacc query [OPTIONS]

  Run ZOQL Query

Options:
  -z, --zoql TEXT          ZOQL file or query to be executed
  -o, --output PATH        Where to write the output to, default is STDOUT
  -m, --max-retries FLOAT  Maximum retries for query
  --help                   Show this message and exit.

zacc describe

zacc describe --help                                                                                                                      932ms  Thu Feb  6 14:58:13 2020
Usage: zacc describe [OPTIONS] RESOURCE

  List available fields of Zuora resource

Options:
  --help  Show this message and exit.

zacc bearer

Usage: zacc bearer [OPTIONS]

  Prints bearer than exits

Options:
  --help  Show this message and exit.

Useful stuff

Has a lot of graphs on Resource relationships: https://community.zuora.com/t5/Engineering-Blog/AQUA-An-Introduction-to-Join-Processing/ba-p/13262