Class: SignRequestClient::TeamMembersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/signrequest_client/api/team_members_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TeamMembersApi

Returns a new instance of TeamMembersApi.



19
20
21
 
# File 'lib/signrequest_client/api/team_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/signrequest_client/api/team_members_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#team_members_list(opts = {}) ⇒ InlineResponse2006

Retrieve a list of Team Members

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :is_active (String)
  • :is_owner (String)
  • :is_admin (String)
  • :user__email (String)
  • :user__first_name (String)
  • :user__last_name (String)
  • :page (Integer) —

    A page number within the paginated result set.

  • :limit (Integer) —

    Number of results to return per page.

Returns:



34
35
36
37
 
# File 'lib/signrequest_client/api/team_members_api.rb', line 34

def team_members_list(opts = {})
  data, _status_code, _headers = team_members_list_with_http_info(opts)
  data
end

#team_members_list_with_http_info(opts = {}) ⇒ Array<(InlineResponse2006, Fixnum, Hash)>

Retrieve a list of Team Members

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :is_active (String)
  • :is_owner (String)
  • :is_admin (String)
  • :user__email (String)
  • :user__first_name (String)
  • :user__last_name (String)
  • :page (Integer) —

    A page number within the paginated result set.

  • :limit (Integer) —

    Number of results to return per page.

Returns:

  • (Array<(InlineResponse2006, Fixnum, Hash)>) —

    InlineResponse2006 data, response status code and response headers



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
 
# File 'lib/signrequest_client/api/team_members_api.rb', line 51

def team_members_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamMembersApi.team_members_list ...'
  end
  # resource path
  local_var_path = '/team-members/'

  # query parameters
  query_params = {}
  query_params[:'is_active'] = opts[:'is_active'] if !opts[:'is_active'].nil?
  query_params[:'is_owner'] = opts[:'is_owner'] if !opts[:'is_owner'].nil?
  query_params[:'is_admin'] = opts[:'is_admin'] if !opts[:'is_admin'].nil?
  query_params[:'user__email'] = opts[:'user__email'] if !opts[:'user__email'].nil?
  query_params[:'user__first_name'] = opts[:'user__first_name'] if !opts[:'user__first_name'].nil?
  query_params[:'user__last_name'] = opts[:'user__last_name'] if !opts[:'user__last_name'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2006')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamMembersApi#team_members_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#team_members_read(uuid, opts = {}) ⇒ TeamMember

Retrieve a Team Member

Parameters:

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

    the optional parameters

Returns:



99
100
101
102
 
# File 'lib/signrequest_client/api/team_members_api.rb', line 99

def team_members_read(uuid, opts = {})
  data, _status_code, _headers = team_members_read_with_http_info(uuid, opts)
  data
end

#team_members_read_with_http_info(uuid, opts = {}) ⇒ Array<(TeamMember, Fixnum, Hash)>

Retrieve a Team Member

Parameters:

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

    the optional parameters

Returns:

  • (Array<(TeamMember, Fixnum, Hash)>) —

    TeamMember data, response status code and response headers



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/signrequest_client/api/team_members_api.rb', line 109

def team_members_read_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamMembersApi.team_members_read ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling TeamMembersApi.team_members_read"
  end
  # resource path
  local_var_path = '/team-members/{uuid}/'.sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TeamMember')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamMembersApi#team_members_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end