Class: Infrawrench::SlackNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.slack

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ SlackNamespace

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 SlackNamespace.

Parameters:



3379
3380
3381
3382
3383
 
# File 'lib/infrawrench/client.rb', line 3379

def initialize(transport)
  @transport = transport
  @channels = SlackChannelsNamespace.new(@transport)
  @installations = SlackInstallationsNamespace.new(@transport)
end

Instance Attribute Details

#channels ⇒ SlackChannelsNamespace (readonly)

Returns client.slack.channels.

Returns:



3373
3374
3375
 
# File 'lib/infrawrench/client.rb', line 3373

def channels
  @channels
end

#installations ⇒ SlackInstallationsNamespace (readonly)

Returns client.slack.installations.

Returns:



3375
3376
3377
 
# File 'lib/infrawrench/client.rb', line 3375

def installations
  @installations
end

Instance Method Details

#install_url(org_id: nil, request_options: nil) ⇒ Hash

Get the Add to Slack URL

Returns a slack.com/oauth/v2/authorize URL carrying a signed state that binds the resulting install to this organization. Send the user's browser there; Slack redirects back to /api/slack/oauth/callback.

GET /api/org/orgId/slack/install-url

Raises on 400: Bad request

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as Hash — see sig/infrawrench/sdk.rbs.

Raises:



3400
3401
3402
3403
3404
3405
3406
3407
 
# File 'lib/infrawrench/client.rb', line 3400

def install_url(org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/slack/install-url",
    path_params: { "orgId" => org_id },
    request_options: request_options
  )
end

#status(org_id: nil, request_options: nil) ⇒ Hash

Get the organization's Slack connection

Reports whether the server has a Slack app registered, which workspaces this organization has connected, and which channels alerts are routed to.

GET /api/org/orgId/slack/status

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as SlackStatus — see sig/infrawrench/sdk.rbs.

Raises:



3421
3422
3423
3424
3425
3426
3427
3428
 
# File 'lib/infrawrench/client.rb', line 3421

def status(org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/slack/status",
    path_params: { "orgId" => org_id },
    request_options: request_options
  )
end

#test(org_id: nil, request_options: nil) ⇒ Hash

Post a test message to every configured channel

Ignores trigger opt-ins — every channel gets the test. Fails with the Slack error when nothing could be delivered (not_in_channel means the bot needs inviting to a private channel).

POST /api/org/orgId/slack/test

Raises on 400: Bad request

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as Hash — see sig/infrawrench/sdk.rbs.

Raises:



3445
3446
3447
3448
3449
3450
3451
3452
 
# File 'lib/infrawrench/client.rb', line 3445

def test(org_id: nil, request_options: nil)
  @transport.request(
    http_method: "POST",
    path: "/api/org/{orgId}/slack/test",
    path_params: { "orgId" => org_id },
    request_options: request_options
  )
end