Class: Infrawrench::MsteamsNamespace

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

Overview

client.msteams

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ MsteamsNamespace

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

Parameters:



1980
1981
1982
1983
 
# File 'lib/infrawrench/client.rb', line 1980

def initialize(transport)
  @transport = transport
  @webhooks = MsteamsWebhooksNamespace.new(@transport)
end

Instance Attribute Details

#webhooks ⇒ MsteamsWebhooksNamespace (readonly)

Returns client.msteams.webhooks.

Returns:



1976
1977
1978
 
# File 'lib/infrawrench/client.rb', line 1976

def webhooks
  @webhooks
end

Instance Method Details

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

List the organization's Teams channels

Returns the Teams channels alerts are routed to and which triggers each takes. Webhook URLs are never included.

GET /api/org/orgId/msteams/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 MsTeamsStatus — see sig/infrawrench/sdk.rbs.

Raises:



1997
1998
1999
2000
2001
2002
2003
2004
 
# File 'lib/infrawrench/client.rb', line 1997

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

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

Post a test card to every configured Teams channel

Ignores trigger opt-ins — every channel gets the test. Fails with the error Microsoft returned when nothing could be delivered (HTTP 404 usually means the Workflow was deleted or turned off).

POST /api/org/orgId/msteams/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:



2021
2022
2023
2024
2025
2026
2027
2028
 
# File 'lib/infrawrench/client.rb', line 2021

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