Skip to content

Conversation

@tbedford
Copy link
Contributor

@tbedford tbedford commented May 28, 2020

Description

Initial version of Reports API v2 code snippets.

I have tried to keep the base code snippets as simple as possible. In addition, there are product-specific examples for "load report sync" and "generate report async". Each product has its own subdirectory in these code examples. For example, SMS specific samples can be found in ./reports/sms.

These code snippets are meant to be used in conjunction with the associated documentation.

Review

@tbedford tbedford self-assigned this May 28, 2020
@tbedford tbedford changed the title Initial versions Initial versions of Reports API v2 code snippets May 28, 2020
Copy link

@Alex-Momotov-BA Alex-Momotov-BA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code should be made more generic to support different products and product-specific parameters. I left comments where this would cause an issue. It would also be great to test the shell scripts for each product / product-specific parameter combination before merging

@tbedford
Copy link
Contributor Author

@Alex-Momotov - thanks for the feedback, you are quite right. I will rethink this and come back with a new set as soon as I can.

@tbedford tbedford added the WIP Work in Progress label Jun 1, 2020
@tbedford
Copy link
Contributor Author

tbedford commented Jun 8, 2020

@Alex-Momotov I have updated the PR description and included product-specific examples. In the associated main docs I have created tables to show which parameters apply to which calls/products. Each code snippet links to these tables. What I've tried to do is explain that some parameters are call/product-specific, while avoiding complexity in the scripts themselves.

@tbedford tbedford removed the WIP Work in Progress label Jun 11, 2020
@tbedford tbedford marked this pull request as ready for review June 11, 2020 12:51
@tbedford tbedford merged commit 6e160c3 into master Jun 11, 2020
@tbedford tbedford deleted the tony-reports-cs branch June 11, 2020 12:52
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