Module: SmbCloud::Auth

Defined in:

lib/auth.rb,
sig/auth.rbs

Defined Under Namespace

Modules: Environment Classes: Client, Error

Class Method Summary

• .client(environment:, app_id:, app_secret:) ⇒ Client
• .login_with_client(environment:, app_id:, app_secret:, email:, password:) ⇒ Hash[Symbol, untyped]
• .logout_with_client(environment:, app_id:, app_secret:, access_token:) ⇒ Boolean
• .me_with_client(environment:, app_id:, app_secret:, access_token:) ⇒ Hash[Symbol, untyped]
• .remove_with_client(environment:, app_id:, app_secret:, access_token:) ⇒ Boolean
• .reset_password_with_client(environment:, app_id:, app_secret:, email:) ⇒ Object
• .signup_with_client(environment:, app_id:, app_secret:, email:, password:) ⇒ Hash[Symbol, untyped]

Class Method Details

.client(environment:, app_id:, app_secret:) ⇒ Client

Parameters:

• environment: (String)
• app_id: (String)
• app_secret: (String)

Returns:

• (Client)

# File 'lib/auth.rb', line 78

def client(environment:, app_id:, app_secret:)
  Client.new(environment:, app_id:, app_secret:)
end

.login_with_client(environment:, app_id:, app_secret:, email:, password:) ⇒ Hash[Symbol, untyped]

Parameters:

• environment: (String)
• app_id: (String)
• app_secret: (String)
• email: (String)
• password: (String)

Returns:

• (Hash[Symbol, untyped])

# File 'lib/auth.rb', line 86

def login_with_client(environment:, app_id:, app_secret:, email:, password:)
  client(environment:, app_id:, app_secret:).login(email:, password:)
end

.logout_with_client(environment:, app_id:, app_secret:, access_token:) ⇒ Boolean

Parameters:

• environment: (String)
• app_id: (String)
• app_secret: (String)
• access_token: (String)

Returns:

• (Boolean)

# File 'lib/auth.rb', line 98

def logout_with_client(environment:, app_id:, app_secret:, access_token:)
  client(environment:, app_id:, app_secret:).logout(access_token:)
end

.me_with_client(environment:, app_id:, app_secret:, access_token:) ⇒ Hash[Symbol, untyped]

Parameters:

• environment: (String)
• app_id: (String)
• app_secret: (String)
• access_token: (String)

Returns:

• (Hash[Symbol, untyped])

# File 'lib/auth.rb', line 94

def me_with_client(environment:, app_id:, app_secret:, access_token:)
  client(environment:, app_id:, app_secret:).me(access_token:)
end

.remove_with_client(environment:, app_id:, app_secret:, access_token:) ⇒ Boolean

Parameters:

• environment: (String)
• app_id: (String)
• app_secret: (String)
• access_token: (String)

Returns:

• (Boolean)

# File 'lib/auth.rb', line 102

def remove_with_client(environment:, app_id:, app_secret:, access_token:)
  client(environment:, app_id:, app_secret:).remove(access_token:)
end

.reset_password_with_client(environment:, app_id:, app_secret:, email:) ⇒ Object

# File 'lib/auth.rb', line 90

def reset_password_with_client(environment:, app_id:, app_secret:, email:)
  client(environment:, app_id:, app_secret:).reset_password(email:)
end

.signup_with_client(environment:, app_id:, app_secret:, email:, password:) ⇒ Hash[Symbol, untyped]

Parameters:

• environment: (String)
• app_id: (String)
• app_secret: (String)
• email: (String)
• password: (String)

Returns:

• (Hash[Symbol, untyped])

# File 'lib/auth.rb', line 82

def signup_with_client(environment:, app_id:, app_secret:, email:, password:)
  client(environment:, app_id:, app_secret:).signup(email:, password:)
end