Module: Slack::Web::Api::Endpoints::Team

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/team.rb

Instance Method Summary collapse

Instance Method Details

#team_accessLogs(options = {}) ⇒ Object

Gets the access logs for the current team.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :before (string) —

    End of time range of logs to include in results (inclusive).

  • :cursor (string) —

    Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request’s response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first “page” of the collection. See pagination for more details.

  • :limit (integer) —

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn’t been reached. If specified, result is returned using a cursor-based approach instead of a classic one.

  • :team_id (string) —

    encoded team id to get logs from, required if org token is used.

See Also:



22
23
24
25
26
27
28
29
30
 
# File 'lib/slack/web/api/endpoints/team.rb', line 22

def team_accessLogs(options = {})
  if block_given?
    Pagination::Cursor.new(self, :team_accessLogs, options).each do |page|
      yield page
    end
  else
    post('team.accessLogs', options)
  end
end

#team_billableInfo(options = {}) ⇒ Object

Gets billable users information for the current team.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :cursor (string) —

    Set cursor to next_cursor returned by previous call, to indicate from where you want to list next page of users list. Default value fetches the first page.

  • :limit (integer) —

    The maximum number of items to return.

  • :team_id (string) —

    encoded team id to get the billable information from, required if org token is used.

  • :user (user) —

    A user to retrieve the billable information for. Defaults to all users.

See Also:



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/slack/web/api/endpoints/team.rb', line 45

def team_billableInfo(options = {})
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  if block_given?
    Pagination::Cursor.new(self, :team_billableInfo, options).each do |page|
      yield page
    end
  else
    post('team.billableInfo', options)
  end
end

#team_info(options = {}) ⇒ Object

Gets information about the current team.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :domain (string) —

    Query by domain instead of team (only when team is null). This only works for domains in the same enterprise as the querying team token. This also expects the domain to belong to a team and not the enterprise itself. This is the value set up for the ‘Joining This Workspace’ workspace setting. If it contains more than one domain, the field will contain multiple comma-separated domain values. If no domain is set, the field is empty.

  • :team (string) —

    Team to get info about; if omitted, will return information about the current team.

See Also:



65
66
67
 
# File 'lib/slack/web/api/endpoints/team.rb', line 65

def team_info(options = {})
  post('team.info', options)
end

#team_integrationLogs(options = {}) ⇒ Object

Gets the integration logs for the current team.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :app_id (string) —

    Filter logs to this Slack app. Defaults to all logs.

  • :change_type (enum) —

    Filter logs with this change type. Possible values are added, removed, enabled, disabled, and updated. Defaults to all logs.

  • :service_id (string) —

    Filter logs to this service. Defaults to all logs.

  • :team_id (string) —

    encoded team id to get logs from, required if org token is used.

  • :user (user) —

    Filter logs generated by this user’s actions. Defaults to all logs.

See Also:



84
85
86
87
 
# File 'lib/slack/web/api/endpoints/team.rb', line 84

def team_integrationLogs(options = {})
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  post('team.integrationLogs', options)
end