Skip to content

Commit

Permalink
Include docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
jcook-stytch committed Jul 24, 2024
1 parent 2b16581 commit b0b4ccc
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 26 deletions.
1 change: 0 additions & 1 deletion lib/stytch/b2b_magic_links.rb
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,6 @@ def login_or_signup(
# Send an invite email to a new Member to join an Organization. The Member will be created with an `invited` status until they successfully authenticate. Sending invites to `pending` Members will update their status to `invited`. Sending invites to already `active` Members will return an error.
#
# The magic link invite will be valid for 1 week.
# /%}
#
# == Parameters:
# organization_id::
Expand Down
15 changes: 5 additions & 10 deletions lib/stytch/b2b_organizations.rb
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,6 @@ def get(
# Updates an Organization specified by `organization_id`. An Organization must always have at least one auth setting set to either `RESTRICTED` or `ALL_ALLOWED` in order to provision new Members.
#
# *See the [Organization authentication settings](https://stytch.com/docs/b2b/api/org-auth-settings) resource to learn more about fields like `email_jit_provisioning`, `email_invites`, `sso_jit_provisioning`, etc., and their behaviors.
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -418,7 +417,7 @@ def update(
put_request("/v1/b2b/organizations/#{organization_id}", request, headers)
end

# Deletes an Organization specified by `organization_id`. All Members of the Organization will also be deleted. /%}
# Deletes an Organization specified by `organization_id`. All Members of the Organization will also be deleted.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -680,7 +679,6 @@ def initialize(connection)
end

# Updates a Member specified by `organization_id` and `member_id`.
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -803,7 +801,7 @@ def update(
put_request("/v1/b2b/organizations/#{organization_id}/members/#{member_id}", request, headers)
end

# Deletes a Member specified by `organization_id` and `member_id`. /%}
# Deletes a Member specified by `organization_id` and `member_id`.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -837,7 +835,7 @@ def delete(
delete_request("/v1/b2b/organizations/#{organization_id}/members/#{member_id}", headers)
end

# Reactivates a deleted Member's status and its associated email status (if applicable) to active, specified by `organization_id` and `member_id`. /%}
# Reactivates a deleted Member's status and its associated email status (if applicable) to active, specified by `organization_id` and `member_id`.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -886,7 +884,6 @@ def reactivate(
# Existing Member Sessions that include a phone number authentication factor will not be revoked if the phone number is deleted, and MFA will not be enforced until the Member logs in again.
# If you wish to enforce MFA immediately after a phone number is deleted, you can do so by prompting the Member to enter a new phone number
# and calling the [OTP SMS send](https://stytch.com/docs/b2b/api/otp-sms-send) endpoint, then calling the [OTP SMS Authenticate](https://stytch.com/docs/b2b/api/authenticate-otp-sms) endpoint.
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -931,7 +928,6 @@ def delete_mfa_phone_number(
# To mint a new registration for a Member, you must first call this endpoint to delete the existing registration.
#
# Existing Member Sessions that include the TOTP authentication factor will not be revoked if the registration is deleted, and MFA will not be enforced until the Member logs in again.
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -974,7 +970,6 @@ def delete_totp(
# Search for Members within specified Organizations. An array with at least one `organization_id` is required. Submitting an empty `query` returns all non-deleted Members within the specified Organizations.
#
# *All fuzzy search filters require a minimum of three characters.
# /%}
#
# == Parameters:
# organization_ids::
Expand Down Expand Up @@ -1029,7 +1024,7 @@ def search(
post_request('/v1/b2b/organizations/members/search', request, headers)
end

# Delete a Member's password. /%}
# Delete a Member's password.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -1170,7 +1165,7 @@ def unlink_retired_email(
post_request("/v1/b2b/organizations/#{organization_id}/members/#{member_id}/unlink_retired_email", request, headers)
end

# Creates a Member. An `organization_id` and `email_address` are required. /%}
# Creates a Member. An `organization_id` and `email_address` are required.
#
# == Parameters:
# organization_id::
Expand Down
14 changes: 7 additions & 7 deletions lib/stytch/b2b_scim.rb
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ def initialize(connection)
@connection = connection
end

# Update a SCIM Connection. /%}
# Update a SCIM Connection.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -229,7 +229,7 @@ def update(
put_request("/v1/b2b/scim/#{organization_id}/connection/#{connection_id}", request, headers)
end

# Deletes a SCIM Connection. /%}
# Deletes a SCIM Connection.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -263,7 +263,7 @@ def delete(
delete_request("/v1/b2b/scim/#{organization_id}/connection/#{connection_id}", headers)
end

# Start a SCIM token rotation. /%}
# Start a SCIM token rotation.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -299,7 +299,7 @@ def rotate_start(
post_request("/v1/b2b/scim/#{organization_id}/connection/#{connection_id}/rotate/start", request, headers)
end

# Completes a SCIM token rotation. This will complete the current token rotation process and update the active token to be the new token supplied in the [start SCIM token rotation](https://stytch.com/docs/b2b/api/scim-rotate-token-start) response. /%}
# Completes a SCIM token rotation. This will complete the current token rotation process and update the active token to be the new token supplied in the [start SCIM token rotation](https://stytch.com/docs/b2b/api/scim-rotate-token-start) response.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -335,7 +335,7 @@ def rotate_complete(
post_request("/v1/b2b/scim/#{organization_id}/connection/#{connection_id}/rotate/complete", request, headers)
end

# Cancel a SCIM token rotation. This will cancel the current token rotation process, keeping the original token active. /%}
# Cancel a SCIM token rotation. This will cancel the current token rotation process, keeping the original token active.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -418,7 +418,7 @@ def get_groups(
get_request(request, headers)
end

# Create a new SCIM Connection. /%}
# Create a new SCIM Connection.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -460,7 +460,7 @@ def create(
post_request("/v1/b2b/scim/#{organization_id}/connection", request, headers)
end

# Get SCIM Connections. /%}
# Get SCIM Connections.
#
# == Parameters:
# organization_id::
Expand Down
12 changes: 4 additions & 8 deletions lib/stytch/b2b_sso.rb
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def initialize(connection)
@saml = StytchB2B::SSO::SAML.new(@connection)
end

# Get all SSO Connections owned by the organization. /%}
# Get all SSO Connections owned by the organization.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -96,7 +96,7 @@ def get_connections(
get_request(request, headers)
end

# Delete an existing SSO connection. /%}
# Delete an existing SSO connection.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -300,7 +300,7 @@ def initialize(connection)
@connection = connection
end

# Create a new OIDC Connection. /%}
# Create a new OIDC Connection.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -360,7 +360,6 @@ def create_connection(
# * `token_url`
# * `userinfo_url`
# * `jwks_url`
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -528,7 +527,7 @@ def initialize(connection)
@connection = connection
end

# Create a new SAML Connection. /%}
# Create a new SAML Connection.
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -577,7 +576,6 @@ def create_connection(
# * `attribute_mapping`
# * `idp_entity_id`
# * `x509_certificate`
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -670,7 +668,6 @@ def update_connection(
# * `idp_entity_id`
# * `x509_certificate`
# * `attribute_mapping` (must be supplied using [Update SAML Connection](update-saml-connection))
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -715,7 +712,6 @@ def update_by_url(
# Delete a SAML verification certificate.
#
# You may need to do this when rotating certificates from your IdP, since Stytch allows a maximum of 5 certificates per connection. There must always be at least one certificate per active connection.
# /%}
#
# == Parameters:
# organization_id::
Expand Down

0 comments on commit b0b4ccc

Please sign in to comment.