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

Reorganize examples into client specific folders and add new examples for Accounts and Auth APIs #247

Closed
wants to merge 16 commits into from

Conversation

MarkTripod-Duo
Copy link
Contributor

Description

Created new folders for Admin API, Auth API and Accounts API within the examples directory. Added new README files for each new folder to provide a small bit of context for the specific API separations.

Motivation and Context

With the desire to increase the number of examples provided, taking the time to organize them by API now rather than later helps to ensure less confusion and hopefully makes identify specific examples much easier to begin with.

How Has This Been Tested?

Manual execution of changed files and syntax validation via PyCharm IDE

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation and organization

MarkTripod-Duo and others added 16 commits November 29, 2023 13:42
doc: add report_user_by_email.py to examples
doc: add report_user_by_email.py to examples
…) method instead of generic json_api_call() method.
… examples for user authentication and Accounts API examples for managing child accounts
… new examples for Accounts and Auth APIs"

This reverts commit abde747.

To run an example query, execute a command like the following from the repo root:
```python
$ python3 examples/Auth/get_billing_and_telephony_credits.py
Copy link
Contributor

Choose a reason for hiding this comment

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

AFAICT the path is actually examples/Accounts API/get_billing...?

Should we dispense with the spaces in the directory name though? path spaces can be problematic


To run an example query, execute a command like the following from the repo root:
```python
$ python3 examples/Admin/report_users_and_phones.py
Copy link
Contributor

Choose a reason for hiding this comment

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

similar path correction and question as for Accounts


To run an example query, execute a command like the following from the repo root:
```python
$ python3 examples/Auth/basic_user_mfa.py
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto path name and spaces question as Accounts

Copy link
Contributor

@AaronAtDuo AaronAtDuo left a comment

Choose a reason for hiding this comment

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

Either adjust the paths in the READMEs and/or change the directory names

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.

2 participants