-
Notifications
You must be signed in to change notification settings - Fork 20
/
group_users.ex
137 lines (114 loc) · 4.41 KB
/
group_users.ex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
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
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
129
130
131
132
133
134
135
136
137
# NOTE: This file is auto generated by OpenAPI Generator 6.4.0 (https://openapi-generator.tech).
# Do not edit this file manually.
defmodule DocuSign.Api.GroupUsers do
@moduledoc """
API calls for all endpoints tagged `GroupUsers`.
"""
alias DocuSign.Connection
import DocuSign.RequestBuilder
@doc """
Deletes one or more users from a group
Deletes one or more users from a group. This request takes a `userInfoList` that contains the users that you want to delete.
### Parameters
- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `group_id` (String.t): The ID of the group being accessed.
- `opts` (keyword): Optional parameters
- `:body` (UserInfoList):
### Returns
- `{:ok, DocuSign.Model.UsersResponse.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec groups_delete_group_users(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
{:ok, DocuSign.Model.UsersResponse.t()}
| {:ok, DocuSign.Model.ErrorDetails.t()}
| {:error, Tesla.Env.t()}
def groups_delete_group_users(connection, account_id, group_id, opts \\ []) do
optional_params = %{
:body => :body
}
request =
%{}
|> method(:delete)
|> url("/v2.1/accounts/#{account_id}/groups/#{group_id}/users")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, %DocuSign.Model.UsersResponse{}},
{400, %DocuSign.Model.ErrorDetails{}}
])
end
@doc """
Gets a list of users in a group.
Retrieves a list of users in a group.
### Parameters
- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `group_id` (String.t): The ID of the group being accessed.
- `opts` (keyword): Optional parameters
- `:count` (String.t): The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`
- `:start_position` (String.t): The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.
### Returns
- `{:ok, DocuSign.Model.UsersResponse.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec groups_get_group_users(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
{:ok, DocuSign.Model.UsersResponse.t()}
| {:ok, DocuSign.Model.ErrorDetails.t()}
| {:error, Tesla.Env.t()}
def groups_get_group_users(connection, account_id, group_id, opts \\ []) do
optional_params = %{
:count => :query,
:start_position => :query
}
request =
%{}
|> method(:get)
|> url("/v2.1/accounts/#{account_id}/groups/#{group_id}/users")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, %DocuSign.Model.UsersResponse{}},
{400, %DocuSign.Model.ErrorDetails{}}
])
end
@doc """
Adds one or more users to an existing group.
Adds one or more existing DocuSign users to an existing group.
### Parameters
- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `group_id` (String.t): The ID of the group being accessed.
- `opts` (keyword): Optional parameters
- `:body` (UserInfoList):
### Returns
- `{:ok, DocuSign.Model.UsersResponse.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec groups_put_group_users(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
{:ok, DocuSign.Model.UsersResponse.t()}
| {:ok, DocuSign.Model.ErrorDetails.t()}
| {:error, Tesla.Env.t()}
def groups_put_group_users(connection, account_id, group_id, opts \\ []) do
optional_params = %{
:body => :body
}
request =
%{}
|> method(:put)
|> url("/v2.1/accounts/#{account_id}/groups/#{group_id}/users")
|> add_optional_params(optional_params, opts)
|> ensure_body()
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, %DocuSign.Model.UsersResponse{}},
{400, %DocuSign.Model.ErrorDetails{}}
])
end
end