Class: DocuSign_Admin::ProductPermissionProfilesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_admin/api/product_permission_profiles_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ProductPermissionProfilesApi.default) ⇒ ProductPermissionProfilesApi

Returns a new instance of ProductPermissionProfilesApi.



20
21
22
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 20

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



18
19
20
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#add_user_product_permission_profiles(organization_id, account_id, user_id, product_permission_profiles_request) ⇒ UserProductPermissionProfilesResponse

Assign user to permission profiles for one or more products Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_id —

    The user ID GUID

  • product_permission_profiles_request —

    Request object

Returns:



31
32
33
34
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 31

def add_user_product_permission_profiles(organization_id, , user_id, product_permission_profiles_request)
  data, _status_code, _headers = add_user_product_permission_profiles_with_http_info(organization_id, , user_id,  product_permission_profiles_request)
  return data
end

#add_user_product_permission_profiles_with_http_info(organization_id, account_id, user_id, product_permission_profiles_request) ⇒ Array<(UserProductPermissionProfilesResponse, Fixnum, Hash)>

Assign user to permission profiles for one or more products Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_id —

    The user ID GUID

  • product_permission_profiles_request —

    Request object

Returns:



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
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 43

def add_user_product_permission_profiles_with_http_info(organization_id, , user_id, product_permission_profiles_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductPermissionProfilesApi.add_user_product_permission_profiles ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles" if user_id.nil?
  # verify the required parameter 'product_permission_profiles_request' is set
  fail ArgumentError, "Missing the required parameter 'product_permission_profiles_request' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles" if product_permission_profiles_request.nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profiles".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .to_s).sub('{' + 'userId' + '}', user_id.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(product_permission_profiles_request)
  auth_names = []
  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 => 'UserProductPermissionProfilesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductPermissionProfilesApi#add_user_product_permission_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_product_permission_profiles(organization_id, account_id) ⇒ ProductPermissionProfilesResponse

Get products associated with the account and the available permission profiles Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

Returns:



92
93
94
95
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 92

def get_product_permission_profiles(organization_id, )
  data, _status_code, _headers = get_product_permission_profiles_with_http_info(organization_id, )
  return data
end

#get_product_permission_profiles_with_http_info(organization_id, account_id) ⇒ Array<(ProductPermissionProfilesResponse, Fixnum, Hash)>

Get products associated with the account and the available permission profiles Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

Returns:



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
138
139
140
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 102

def get_product_permission_profiles_with_http_info(organization_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductPermissionProfilesApi.get_product_permission_profiles ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProductPermissionProfilesApi.get_product_permission_profiles" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ProductPermissionProfilesApi.get_product_permission_profiles" if .nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .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 = []
  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 => 'ProductPermissionProfilesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductPermissionProfilesApi#get_product_permission_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_product_permission_profiles(organization_id, account_id, user_id) ⇒ ProductPermissionProfilesResponse

Retrieve list of user’s permission profiles for each account’s product Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_id —

    The user ID GUID

Returns:



148
149
150
151
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 148

def get_user_product_permission_profiles(organization_id, , user_id)
  data, _status_code, _headers = get_user_product_permission_profiles_with_http_info(organization_id, , user_id)
  return data
end

#get_user_product_permission_profiles_with_http_info(organization_id, account_id, user_id) ⇒ Array<(ProductPermissionProfilesResponse, Fixnum, Hash)>

Retrieve list of user&#39;s permission profiles for each account&#39;s product Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_id —

    The user ID GUID

Returns:



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
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 159

def get_user_product_permission_profiles_with_http_info(organization_id, , user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductPermissionProfilesApi.get_user_product_permission_profiles ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProductPermissionProfilesApi.get_user_product_permission_profiles" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ProductPermissionProfilesApi.get_user_product_permission_profiles" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling ProductPermissionProfilesApi.get_user_product_permission_profiles" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profiles".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .to_s).sub('{' + 'userId' + '}', user_id.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 = []
  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 => 'ProductPermissionProfilesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductPermissionProfilesApi#get_user_product_permission_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end