Class: Trycourier::Resources::Auth

Inherits:

Object

• Object
• Trycourier::Resources::Auth

Defined in:

lib/trycourier/resources/auth.rb

Instance Method Summary

• #initialize(client:) ⇒ Auth constructor private

  A new instance of Auth.

• #issue_token(expires_in: , scope: , request_options: {}) ⇒ Trycourier::Models::AuthIssueTokenResponse

  Returns a new access token.

Constructor Details

#initialize(client:) ⇒ Auth

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Auth.

Parameters:

• client (Trycourier::Client)

# File 'lib/trycourier/resources/auth.rb', line 31

def initialize(client:)
  @client = client
end

Instance Method Details

#issue_token(expires_in: , scope: , request_options: {}) ⇒ Trycourier::Models::AuthIssueTokenResponse

Returns a new access token.

Parameters:

• expires_in (String)
• scope (String)
• request_options (Trycourier::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Trycourier::Models::AuthIssueTokenResponse)

See Also:

• Models::AuthIssueTokenParams

# File 'lib/trycourier/resources/auth.rb', line 17

def issue_token(params)
  parsed, options = Trycourier::AuthIssueTokenParams.dump_request(params)
  @client.request(
    method: :post,
    path: "auth/issue-token",
    body: parsed,
    model: Trycourier::Models::AuthIssueTokenResponse,
    options: options
  )
end