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

Documentation missing empty params object #656

Closed
KristenLeach opened this issue Sep 22, 2021 · 2 comments · Fixed by #712
Closed

Documentation missing empty params object #656

KristenLeach opened this issue Sep 22, 2021 · 2 comments · Fixed by #712
Labels
closed:stale Issue or PR has not seen activity recently documentation This adds, fixes or improves documentation

Comments

@KristenLeach
Copy link

Describe the problem

Related to this previous issue

In the ManagementClient section of the documentation there is the setBrandingUniversalLoginTemplate() function; I am getting the same argument error as the issue linked above ('ArgumentError: The data must be an object'). The docs here are a bit confusing, as A. while the documentation says to leave the params empty, in the example there is no empty object being passed to the function in the params place. And B. the description of this function is "Get the new universal login template," though this is a setter it seems.
Screen Shot 2021-09-22 at 10 49 57 AM

What was the expected behavior?

Running the code based on the documentation should update the login template

Reproduction

If you call the function without an empty params object (as shown in the docs) you will get the error 'ArgumentError: The data must be an object'.

 async updatePageTemplate() {
    const template = '<template code here>'
    return await this.managementApi.setBrandingUniversalLoginTemplate({
       template: template 
      }).then((temp) => {
        console.log(temp)
        return true
      }).catch((err) => {
        console.log(err)
        return false
      })
  }

Environment

version:
"auth0": "^2.36.1"

@adamjmcgrath
Copy link
Contributor

Thanks for raising this @KristenLeach - we'll raise some work to fix it

@adamjmcgrath adamjmcgrath added the documentation This adds, fixes or improves documentation label Sep 27, 2021
@stale
Copy link

stale bot commented Mar 2, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If you have not received a response for our team (apologies for the delay) and this is still a blocker, please reply with additional information or just a ping. Thank you for your contribution! 🙇‍♂️

@stale stale bot added the closed:stale Issue or PR has not seen activity recently label Mar 2, 2022
@stale stale bot closed this as completed Apr 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed:stale Issue or PR has not seen activity recently documentation This adds, fixes or improves documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants