Class: SignRequestClient::TeamsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TeamsApi

Returns a new instance of TeamsApi.



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

def api_client
  @api_client
end

Instance Method Details

#teams_create(data, opts = {}) ⇒ Team

Create a Team Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST "email":"**[email protected]**","is_admin":false,"is_owner":false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/signrequest_client/api/teams_api.rb', line 27

def teams_create(data, opts = {})
  data, _status_code, _headers = teams_create_with_http_info(data, opts)
  data
end

#teams_create_with_http_info(data, opts = {}) ⇒ Array<(Team, Fixnum, Hash)>

Create a Team Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST &quot;email&quot;:&quot;**[email protected]**&quot;,&quot;is_admin&quot;:false,&quot;is_owner&quot;:false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • Team data, response status code and response headers



37
38
39
40
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
 
# File 'lib/signrequest_client/api/teams_api.rb', line 37

def teams_create_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamsApi.teams_create ...'
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling TeamsApi.teams_create"
  end
  # resource path
  local_var_path = '/teams/'

  # 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 = @api_client.object_to_http_body(data)
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Team')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#teams_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#teams_delete(subdomain, opts = {}) ⇒ nil

Delete a Team Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST "email":"**[email protected]**","is_admin":false,"is_owner":false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/signrequest_client/api/teams_api.rb', line 81

def teams_delete(subdomain, opts = {})
  teams_delete_with_http_info(subdomain, opts)
  nil
end

#teams_delete_with_http_info(subdomain, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Team Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST &quot;email&quot;:&quot;**[email protected]**&quot;,&quot;is_admin&quot;:false,&quot;is_owner&quot;:false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • nil, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/signrequest_client/api/teams_api.rb', line 91

def teams_delete_with_http_info(subdomain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamsApi.teams_delete ...'
  end
  # verify the required parameter 'subdomain' is set
  if @api_client.config.client_side_validation && subdomain.nil?
    fail ArgumentError, "Missing the required parameter 'subdomain' when calling TeamsApi.teams_delete"
  end
  # resource path
  local_var_path = '/teams/{subdomain}/'.sub('{' + 'subdomain' + '}', subdomain.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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#teams_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#teams_invite_member(subdomain, data, opts = {}) ⇒ InviteMember

Invite a Team Member Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST "email":"**[email protected]**","is_admin":false,"is_owner":false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/signrequest_client/api/teams_api.rb', line 135

def teams_invite_member(subdomain, data, opts = {})
  data, _status_code, _headers = teams_invite_member_with_http_info(subdomain, data, opts)
  data
end

#teams_invite_member_with_http_info(subdomain, data, opts = {}) ⇒ Array<(InviteMember, Fixnum, Hash)>

Invite a Team Member Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST &quot;email&quot;:&quot;**[email protected]**&quot;,&quot;is_admin&quot;:false,&quot;is_owner&quot;:false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • InviteMember data, response status code and response headers



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/signrequest_client/api/teams_api.rb', line 146

def teams_invite_member_with_http_info(subdomain, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamsApi.teams_invite_member ...'
  end
  # verify the required parameter 'subdomain' is set
  if @api_client.config.client_side_validation && subdomain.nil?
    fail ArgumentError, "Missing the required parameter 'subdomain' when calling TeamsApi.teams_invite_member"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling TeamsApi.teams_invite_member"
  end
  # resource path
  local_var_path = '/teams/{subdomain}/invite_member/'.sub('{' + 'subdomain' + '}', subdomain.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 = @api_client.object_to_http_body(data)
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InviteMember')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#teams_invite_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#teams_list(opts = {}) ⇒ InlineResponse2007

Retrieve a list of Teams Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST "email":"**[email protected]**","is_admin":false,"is_owner":false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :limit (Integer) —

    Number of results to return per page.

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:



195
196
197
198
 
# File 'lib/signrequest_client/api/teams_api.rb', line 195

def teams_list(opts = {})
  data, _status_code, _headers = teams_list_with_http_info(opts)
  data
end

#teams_list_with_http_info(opts = {}) ⇒ Array<(InlineResponse2007, Fixnum, Hash)>

Retrieve a list of Teams Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST &quot;email&quot;:&quot;**[email protected]**&quot;,&quot;is_admin&quot;:false,&quot;is_owner&quot;:false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :limit (Integer) —

    Number of results to return per page.

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • InlineResponse2007 data, response status code and response headers



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/signrequest_client/api/teams_api.rb', line 206

def teams_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamsApi.teams_list ...'
  end
  # resource path
  local_var_path = '/teams/'

  # query parameters
  query_params = {}
  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 => 'InlineResponse2007')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#teams_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#teams_partial_update(subdomain, data, opts = {}) ⇒ Team

Update a Team Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST "email":"**[email protected]**","is_admin":false,"is_owner":false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:



249
250
251
252
 
# File 'lib/signrequest_client/api/teams_api.rb', line 249

def teams_partial_update(subdomain, data, opts = {})
  data, _status_code, _headers = teams_partial_update_with_http_info(subdomain, data, opts)
  data
end

#teams_partial_update_with_http_info(subdomain, data, opts = {}) ⇒ Array<(Team, Fixnum, Hash)>

Update a Team Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST &quot;email&quot;:&quot;**[email protected]**&quot;,&quot;is_admin&quot;:false,&quot;is_owner&quot;:false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • Team data, response status code and response headers



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/signrequest_client/api/teams_api.rb', line 260

def teams_partial_update_with_http_info(subdomain, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamsApi.teams_partial_update ...'
  end
  # verify the required parameter 'subdomain' is set
  if @api_client.config.client_side_validation && subdomain.nil?
    fail ArgumentError, "Missing the required parameter 'subdomain' when calling TeamsApi.teams_partial_update"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling TeamsApi.teams_partial_update"
  end
  # resource path
  local_var_path = '/teams/{subdomain}/'.sub('{' + 'subdomain' + '}', subdomain.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 = @api_client.object_to_http_body(data)
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Team')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#teams_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#teams_read(subdomain, opts = {}) ⇒ Team

Retrieve a Team Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST "email":"**[email protected]**","is_admin":false,"is_owner":false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:



308
309
310
311
 
# File 'lib/signrequest_client/api/teams_api.rb', line 308

def teams_read(subdomain, opts = {})
  data, _status_code, _headers = teams_read_with_http_info(subdomain, opts)
  data
end

#teams_read_with_http_info(subdomain, opts = {}) ⇒ Array<(Team, Fixnum, Hash)>

Retrieve a Team Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://*subdomain }*.signrequest.com/api/v1/… To invite new team members you can use POST &quot;email&quot;:&quot;**[email protected]**&quot;,&quot;is_admin&quot;:false,&quot;is_owner&quot;:false to: https://signrequest.com/api/v1/teams/*subdomain }*/invite_member/

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • Team data, response status code and response headers



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/signrequest_client/api/teams_api.rb', line 318

def teams_read_with_http_info(subdomain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamsApi.teams_read ...'
  end
  # verify the required parameter 'subdomain' is set
  if @api_client.config.client_side_validation && subdomain.nil?
    fail ArgumentError, "Missing the required parameter 'subdomain' when calling TeamsApi.teams_read"
  end
  # resource path
  local_var_path = '/teams/{subdomain}/'.sub('{' + 'subdomain' + '}', subdomain.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 => 'Team')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#teams_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end