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.

Sign up for GitHub

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

Jump to bottom

fix: guardian-related code examples #499

Merged
merged 1 commit into from
Jun 19, 2020
Merged

fix: guardian-related code examples #499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions src/management/GuardianManager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ var GuardianManager = function(options) {
this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry);

/**
* Provides an abstraction layer for retrieving Guardian factors.
* Provides an abstraction layer for retrieving Guardian factor templates.
*
* @type {external:RestClient}
*/
Expand Down Expand Up @@ -167,6 +167,7 @@ utils.wrapPropertyMethod(GuardianManager, 'createEnrollmentTicket', 'tickets.cre
* @method getFactors
* @memberOf module:management.GuardianManager.prototype
*
* @example
* management.guardian.getFactors(function (err, factors) {
* console.log(factors.length);
* });
Expand All @@ -183,6 +184,7 @@ utils.wrapPropertyMethod(GuardianManager, 'getFactors', 'factors.getAll');
* @method getFactorProvider
* @memberOf module:management.GuardianManager.prototype
*
* @example
* management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
* });
Expand All @@ -200,12 +202,13 @@ utils.wrapPropertyMethod(GuardianManager, 'getFactorProvider', 'factorsProviders
* @method updateFactorProvider
* @memberOf module:management.GuardianManager.prototype
*
* @example
* management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
* messaging_service_sid: 'XXXXXXXXXXXXXX',
* auth_token: 'XXXXXXXXXXXXXX',
* sid: 'XXXXXXXXXXXXXX'
* }, function(err, provider) {
* console.log(provider);
* messaging_service_sid: 'XXXXXXXXXXXXXX',
* auth_token: 'XXXXXXXXXXXXXX',
* sid: 'XXXXXXXXXXXXXX'
* }, function (err, provider) {
* console.log(provider);
* });
*
* @param {Object} params Factor provider parameters.
Expand All @@ -222,6 +225,7 @@ utils.wrapPropertyMethod(GuardianManager, 'updateFactorProvider', 'factorsProvid
* @method getFactorTemplates
* @memberOf module:management.GuardianManager.prototype
*
* @example
* management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
* });
Expand All @@ -239,11 +243,12 @@ utils.wrapPropertyMethod(GuardianManager, 'getFactorTemplates', 'factorsTemplate
* @method updateFactorTemplates
* @memberOf module:management.GuardianManager.prototype
*
* @example
* management.guardian.updateFactorProvider({ name: 'sms' }, {
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
* verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
* }, function(err, templates) {
* console.log(templates);
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
* verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
* }, function (err, templates) {
* console.log(templates);
* });
*
* @param {Object} params Factor parameters.
Expand All @@ -260,10 +265,11 @@ utils.wrapPropertyMethod(GuardianManager, 'updateFactorTemplates', 'factorsTempl
* @method updateFactor
* @memberOf module:management.GuardianManager.prototype
*
* @example
* management.guardian.updateFactor({ name: 'sms' }, {
* enabled: true
* }, function(err, factor) {
* console.log(factor);
* enabled: true
* }, function (err, factor) {
* console.log(factor);
* });
*
* @param {Object} params Factor parameters.
Expand Down
30 changes: 18 additions & 12 deletions src/management/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2567,6 +2567,7 @@ utils.wrapPropertyMethod(
* @method getGuardianFactors
* @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getGuardianFactors(function (err, factors) {
* console.log(factors.length);
* });
Expand All @@ -2583,6 +2584,7 @@ utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.facto
* @method getGuardianFactorProvider
* @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
* });
Expand All @@ -2604,12 +2606,13 @@ utils.wrapPropertyMethod(
* @method updateFactorProvider
* @memberOf module:management.ManagementClient.prototype
*
* @example
* management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
* messaging_service_sid: 'XXXXXXXXXXXXXX',
* auth_token: 'XXXXXXXXXXXXXX',
* sid: 'XXXXXXXXXXXXXX'
* }, function(err, provider) {
* console.log(provider);
* messaging_service_sid: 'XXXXXXXXXXXXXX',
* auth_token: 'XXXXXXXXXXXXXX',
* sid: 'XXXXXXXXXXXXXX'
* }, function (err, provider) {
* console.log(provider);
* });
*
* @param {Object} params Factor provider parameters.
Expand All @@ -2630,6 +2633,7 @@ utils.wrapPropertyMethod(
* @method getGuardianFactorTemplates
* @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
* });
Expand All @@ -2651,11 +2655,12 @@ utils.wrapPropertyMethod(
* @method updateGuardianFactorTemplates
* @memberOf module:management.ManagementClient.prototype
*
* @example
* management.updateGuardianFactorTemplates({ name: 'sms' }, {
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
* verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
* }, function(err, templates) {
* console.log(templates);
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
* verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
* }, function (err, templates) {
* console.log(templates);
* });
*
* @param {Object} params Factor parameters.
Expand All @@ -2676,10 +2681,11 @@ utils.wrapPropertyMethod(
* @method updateGuardianFactor
* @memberOf module:management.ManagementClient.prototype
*
* @example
* management.updateGuardianFactor({ name: 'sms' }, {
* enabled: true
* }, function(err, factor) {
* console.log(factor);
* enabled: true
* }, function (err, factor) {
* console.log(factor);
* });
*
* @param {Object} params Factor parameters.
Expand Down