Class: WhatpulseSdk::SubteamMembersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/whatpulse-sdk/api/subteam_members_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubteamMembersApi

Returns a new instance of SubteamMembersApi.



19
20
21
 
# File 'lib/whatpulse-sdk/api/subteam_members_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/whatpulse-sdk/api/subteam_members_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_teams_subteams_members(team_id, subteam_id, opts = {}) ⇒ V1TeamsSubteamsMembers200Response

Get subteam members Get a paginated list of users that are members of a specific subteam.

Parameters:

  • team_id (String) —

    Team ID, name or slug

  • subteam_id (Integer) —

    Subteam ID

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

    the optional parameters

Options Hash (opts):

  • :per_page (Integer)

Returns:



29
30
31
32
 
# File 'lib/whatpulse-sdk/api/subteam_members_api.rb', line 29

def v1_teams_subteams_members(team_id, subteam_id, opts = {})
  data, _status_code, _headers = v1_teams_subteams_members_with_http_info(team_id, subteam_id, opts)
  data
end

#v1_teams_subteams_members_with_http_info(team_id, subteam_id, opts = {}) ⇒ Array<(V1TeamsSubteamsMembers200Response, Integer, Hash)>

Get subteam members Get a paginated list of users that are members of a specific subteam.

Parameters:

  • team_id (String) —

    Team ID, name or slug

  • subteam_id (Integer) —

    Subteam ID

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

    the optional parameters

Options Hash (opts):

  • :per_page (Integer)

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/whatpulse-sdk/api/subteam_members_api.rb', line 41

def v1_teams_subteams_members_with_http_info(team_id, subteam_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubteamMembersApi.v1_teams_subteams_members ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling SubteamMembersApi.v1_teams_subteams_members"
  end
  # verify the required parameter 'subteam_id' is set
  if @api_client.config.client_side_validation && subteam_id.nil?
    fail ArgumentError, "Missing the required parameter 'subteam_id' when calling SubteamMembersApi.v1_teams_subteams_members"
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling SubteamMembersApi.v1_teams_subteams_members, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling SubteamMembersApi.v1_teams_subteams_members, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/teams/{team_id}/subteams/{subteam_id}/members'.sub('{' + 'team_id' + '}', CGI.escape(team_id.to_s)).sub('{' + 'subteam_id' + '}', CGI.escape(subteam_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V1TeamsSubteamsMembers200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['http']

  new_options = opts.merge(
    :operation => :"SubteamMembersApi.v1_teams_subteams_members",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubteamMembersApi#v1_teams_subteams_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end