docusign_admin 1.0.0.beta
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE +21 -0
- data/README.md +51 -0
- data/Rakefile +8 -0
- data/docusign_admin.gemspec +45 -0
- data/git_push.sh +55 -0
- data/lib/docusign_admin/.DS_Store +0 -0
- data/lib/docusign_admin/api/accounts_api.rb +213 -0
- data/lib/docusign_admin/api/bulk_exports_api.rb +456 -0
- data/lib/docusign_admin/api/bulk_imports_api.rb +785 -0
- data/lib/docusign_admin/api/ds_groups_api.rb +472 -0
- data/lib/docusign_admin/api/identity_providers_api.rb +75 -0
- data/lib/docusign_admin/api/product_permission_profiles_api.rb +201 -0
- data/lib/docusign_admin/api/reserved_domains_api.rb +75 -0
- data/lib/docusign_admin/api/users_api.rb +650 -0
- data/lib/docusign_admin/client/.DS_Store +0 -0
- data/lib/docusign_admin/client/api_client.rb +597 -0
- data/lib/docusign_admin/client/api_error.rb +37 -0
- data/lib/docusign_admin/client/auth/oauth.rb +1061 -0
- data/lib/docusign_admin/configuration.rb +202 -0
- data/lib/docusign_admin/models/add_ds_group_and_users_response.rb +192 -0
- data/lib/docusign_admin/models/add_ds_group_users_response.rb +203 -0
- data/lib/docusign_admin/models/add_user_response.rb +257 -0
- data/lib/docusign_admin/models/add_user_response_account_properties.rb +232 -0
- data/lib/docusign_admin/models/certificate_response.rb +230 -0
- data/lib/docusign_admin/models/delete_membership_request.rb +188 -0
- data/lib/docusign_admin/models/delete_membership_response.rb +192 -0
- data/lib/docusign_admin/models/delete_memberships_request.rb +190 -0
- data/lib/docusign_admin/models/delete_memberships_response.rb +194 -0
- data/lib/docusign_admin/models/delete_response.rb +194 -0
- data/lib/docusign_admin/models/delete_user_identity_request.rb +190 -0
- data/lib/docusign_admin/models/domain_response.rb +241 -0
- data/lib/docusign_admin/models/domains_response.rb +185 -0
- data/lib/docusign_admin/models/ds_group_add_request.rb +197 -0
- data/lib/docusign_admin/models/ds_group_and_users_response.rb +192 -0
- data/lib/docusign_admin/models/ds_group_list_response.rb +221 -0
- data/lib/docusign_admin/models/ds_group_request.rb +188 -0
- data/lib/docusign_admin/models/ds_group_response.rb +273 -0
- data/lib/docusign_admin/models/ds_group_user_response.rb +246 -0
- data/lib/docusign_admin/models/ds_group_users_add_request.rb +190 -0
- data/lib/docusign_admin/models/ds_group_users_remove_request.rb +190 -0
- data/lib/docusign_admin/models/ds_group_users_response.rb +212 -0
- data/lib/docusign_admin/models/error_details.rb +192 -0
- data/lib/docusign_admin/models/force_activate_membership_request.rb +188 -0
- data/lib/docusign_admin/models/group_request.rb +206 -0
- data/lib/docusign_admin/models/identity_provider_response.rb +230 -0
- data/lib/docusign_admin/models/identity_providers_response.rb +185 -0
- data/lib/docusign_admin/models/link_response.rb +192 -0
- data/lib/docusign_admin/models/member_group_response.rb +201 -0
- data/lib/docusign_admin/models/member_groups_response.rb +194 -0
- data/lib/docusign_admin/models/membership_response.rb +266 -0
- data/lib/docusign_admin/models/new_account_user_request.rb +289 -0
- data/lib/docusign_admin/models/new_multi_product_user_add_request.rb +287 -0
- data/lib/docusign_admin/models/new_user_request.rb +285 -0
- data/lib/docusign_admin/models/new_user_request_account_properties.rb +226 -0
- data/lib/docusign_admin/models/new_user_response.rb +257 -0
- data/lib/docusign_admin/models/new_user_response_account_properties.rb +230 -0
- data/lib/docusign_admin/models/oasirr_error_details.rb +192 -0
- data/lib/docusign_admin/models/oasirr_organization_account_settings_error_data_response.rb +219 -0
- data/lib/docusign_admin/models/oetr_error_details.rb +192 -0
- data/lib/docusign_admin/models/org_export_selected_account.rb +183 -0
- data/lib/docusign_admin/models/org_export_selected_domain.rb +183 -0
- data/lib/docusign_admin/models/org_report_configuration_response.rb +203 -0
- data/lib/docusign_admin/models/org_report_create_response.rb +183 -0
- data/lib/docusign_admin/models/org_report_list_response.rb +185 -0
- data/lib/docusign_admin/models/org_report_list_response_org_report.rb +282 -0
- data/lib/docusign_admin/models/org_report_list_response_requestor.rb +192 -0
- data/lib/docusign_admin/models/org_report_request.rb +221 -0
- data/lib/docusign_admin/models/organization_account_request.rb +188 -0
- data/lib/docusign_admin/models/organization_account_response.rb +210 -0
- data/lib/docusign_admin/models/organization_account_settings_import_requestor_response.rb +210 -0
- data/lib/docusign_admin/models/organization_account_settings_import_response.rb +313 -0
- data/lib/docusign_admin/models/organization_account_settings_import_result_response.rb +239 -0
- data/lib/docusign_admin/models/organization_accounts_request.rb +185 -0
- data/lib/docusign_admin/models/organization_export_account.rb +183 -0
- data/lib/docusign_admin/models/organization_export_domain.rb +183 -0
- data/lib/docusign_admin/models/organization_export_request.rb +205 -0
- data/lib/docusign_admin/models/organization_export_requestor_response.rb +210 -0
- data/lib/docusign_admin/models/organization_export_response.rb +324 -0
- data/lib/docusign_admin/models/organization_export_task_response.rb +228 -0
- data/lib/docusign_admin/models/organization_exports_response.rb +185 -0
- data/lib/docusign_admin/models/organization_import_response.rb +414 -0
- data/lib/docusign_admin/models/organization_import_response_error_rollup.rb +192 -0
- data/lib/docusign_admin/models/organization_import_response_requestor.rb +210 -0
- data/lib/docusign_admin/models/organization_import_response_warning_rollup.rb +192 -0
- data/lib/docusign_admin/models/organization_imports_response.rb +185 -0
- data/lib/docusign_admin/models/organization_response.rb +310 -0
- data/lib/docusign_admin/models/organization_salesforce_account_managers_response.rb +228 -0
- data/lib/docusign_admin/models/organization_simple_id_object.rb +183 -0
- data/lib/docusign_admin/models/organization_user_response.rb +275 -0
- data/lib/docusign_admin/models/organization_users_response.rb +194 -0
- data/lib/docusign_admin/models/organizations_response.rb +185 -0
- data/lib/docusign_admin/models/osamr_contact.rb +201 -0
- data/lib/docusign_admin/models/paging_response_properties.rb +228 -0
- data/lib/docusign_admin/models/permission_profile_request.rb +197 -0
- data/lib/docusign_admin/models/permission_profile_response.rb +192 -0
- data/lib/docusign_admin/models/permission_profile_response2_1.rb +192 -0
- data/lib/docusign_admin/models/permissions_response.rb +185 -0
- data/lib/docusign_admin/models/product_permission_profile_request.rb +202 -0
- data/lib/docusign_admin/models/product_permission_profile_response.rb +212 -0
- data/lib/docusign_admin/models/product_permission_profiles_request.rb +190 -0
- data/lib/docusign_admin/models/product_permission_profiles_response.rb +185 -0
- data/lib/docusign_admin/models/remove_ds_group_users_response.rb +194 -0
- data/lib/docusign_admin/models/required_attribute_mapping_response.rb +210 -0
- data/lib/docusign_admin/models/saml2_identity_provider_response.rb +216 -0
- data/lib/docusign_admin/models/setting_response.rb +201 -0
- data/lib/docusign_admin/models/update_membership_request.rb +244 -0
- data/lib/docusign_admin/models/update_response.rb +183 -0
- data/lib/docusign_admin/models/update_user_email_request.rb +216 -0
- data/lib/docusign_admin/models/update_user_request.rb +303 -0
- data/lib/docusign_admin/models/update_users_email_request.rb +185 -0
- data/lib/docusign_admin/models/update_users_request.rb +185 -0
- data/lib/docusign_admin/models/user_drilldown_response.rb +340 -0
- data/lib/docusign_admin/models/user_identity_request.rb +183 -0
- data/lib/docusign_admin/models/user_identity_response.rb +219 -0
- data/lib/docusign_admin/models/user_product_permission_profiles_response.rb +203 -0
- data/lib/docusign_admin/models/user_update_response.rb +210 -0
- data/lib/docusign_admin/models/users_drilldown_response.rb +185 -0
- data/lib/docusign_admin/models/users_update_response.rb +194 -0
- data/lib/docusign_admin/version.rb +14 -0
- data/lib/docusign_admin.rb +148 -0
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile +5 -0
- data/tests/docs/Test.pdf +0 -0
- data/tests/docs/organization_user_import.csv +2 -0
- data/tests/spec/unit_tests_using_jwt_spec.rb +231 -0
- metadata +370 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ac88fd3e8cead65c3aa5853b57ff1444f33d343da27b1f67388a1091c3bbe215
|
4
|
+
data.tar.gz: 47fa3514f9588253c07c1b0522b07c15cbd110a0b172789fb23d1232094f7f45
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c2f4946134c62178b605bb9640028a0090f87a0502f8308ad1bbf1e4931d8f2ea0dea5def9aa6967c1b00fd7fb14b8f54a7be5970bcaa1dc36d0f1ff7d66ab59
|
7
|
+
data.tar.gz: e572a83554a3bbd0a62a1a77e3f97bfbcd20f2afb5d78cf2e8eec132cbb6f9c05c0b7a143cc6221913d578e33147f91cb446ec3c7ee77a5548399aad72a7261d
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2017- DocuSign, Inc. (https://www.docusign.com)
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
# The Official DocuSign Admin Ruby Client SDK
|
2
|
+
|
3
|
+
[![RubyGems version][rubygems-image]][rubygems-url]
|
4
|
+
[![RubyGems downloads][downloads-image]][downloads-url]
|
5
|
+
[![Build status][travis-image]][travis-url]
|
6
|
+
|
7
|
+
## Requirements
|
8
|
+
* Ruby 1.9+
|
9
|
+
* Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
|
10
|
+
|
11
|
+
## Compatibility
|
12
|
+
* Ruby 1.9+
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/admin-api/how-to/) from the [DocuSign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.
|
16
|
+
|
17
|
+
### Installation via your application's Gemfile:
|
18
|
+
1. In your application's Gemfile, add:
|
19
|
+
`gem 'docusign_admin'`
|
20
|
+
2. Open your preferred console.
|
21
|
+
3. In your project directory, execute the installer by typing: **bundle install**
|
22
|
+
|
23
|
+
### Manual installation:
|
24
|
+
1. Open your preferred console.
|
25
|
+
2. In the console, type: **gem install docusign_admin**
|
26
|
+
|
27
|
+
### Dependencies
|
28
|
+
This client has the following external dependencies:
|
29
|
+
* Jwt>=1.5.2
|
30
|
+
* Json>=2.1.0
|
31
|
+
* Typhoeus>=1.0.1
|
32
|
+
|
33
|
+
## Code examples
|
34
|
+
You can find on our GitHub a self-executing package of code examples for the DocuSign Admin C# SDK, called a [Launcher](https://github.com/docusign/code-examples-ruby/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/admin-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/docs/admin-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/docs/admin-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows.
|
35
|
+
|
36
|
+
## OAuth implementations
|
37
|
+
For details regarding which type of OAuth grant will work best for your DocuSign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [DocuSign Developer Center](https://developers.docusign.com/).
|
38
|
+
|
39
|
+
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/docs/admin-api/guides/authentication/oauth2-code-grant) flow.
|
40
|
+
|
41
|
+
## Support
|
42
|
+
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
|
43
|
+
|
44
|
+
## License
|
45
|
+
The DocuSign Admin Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
|
46
|
+
|
47
|
+
### Additional resources
|
48
|
+
* [DocuSign Developer Center](https://developers.docusign.com/)
|
49
|
+
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
|
50
|
+
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
|
51
|
+
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
|
data/Rakefile
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#DocuSign Admin API
|
5
|
+
|
6
|
+
#An API for an organization administrator to manage organizations, accounts and users
|
7
|
+
|
8
|
+
OpenAPI spec version: v2
|
9
|
+
Contact: devcenter@docusign.com
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
|
+
|
12
|
+
=end
|
13
|
+
|
14
|
+
$:.push File.expand_path("../lib", __FILE__)
|
15
|
+
require "docusign_admin/version"
|
16
|
+
|
17
|
+
Gem::Specification.new do |s|
|
18
|
+
s.name = "docusign_admin"
|
19
|
+
s.version = DocuSign_Admin::VERSION
|
20
|
+
s.platform = Gem::Platform::RUBY
|
21
|
+
s.authors = ["Swagger-Codegen"]
|
22
|
+
s.email = ["devcenter@docusign.com"]
|
23
|
+
s.homepage = "https://github.com/docusign/docusign-admin-ruby-client"
|
24
|
+
s.summary = "DocuSign Admin API Ruby Gem"
|
25
|
+
s.description = "The DocuSign Admin API enables you to automate user management with your existing systems while ensuring governance and compliance."
|
26
|
+
s.license = "MIT"
|
27
|
+
s.required_ruby_version = ">= 1.9"
|
28
|
+
|
29
|
+
s.add_runtime_dependency 'jwt', '~> 2.2', '>= 2.2.1'
|
30
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
|
+
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
32
|
+
|
33
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
34
|
+
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
35
|
+
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
36
|
+
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
37
|
+
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
38
|
+
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
39
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
|
40
|
+
|
41
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
42
|
+
s.test_files = `find spec/*`.split("\n")
|
43
|
+
s.executables = []
|
44
|
+
s.require_paths = ["lib"]
|
45
|
+
end
|
data/git_push.sh
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# Generated by: https://github.com/swagger-api/swagger-codegen.git
|
4
|
+
#
|
5
|
+
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
|
6
|
+
#
|
7
|
+
# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
|
8
|
+
|
9
|
+
git_user_id=$1
|
10
|
+
git_repo_id=$2
|
11
|
+
release_note=$3
|
12
|
+
|
13
|
+
if [ "$git_user_id" = "" ]; then
|
14
|
+
git_user_id="GIT_USER_ID"
|
15
|
+
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
|
16
|
+
fi
|
17
|
+
|
18
|
+
if [ "$git_repo_id" = "" ]; then
|
19
|
+
git_repo_id="GIT_REPO_ID"
|
20
|
+
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
|
21
|
+
fi
|
22
|
+
|
23
|
+
if [ "$release_note" = "" ]; then
|
24
|
+
release_note="Minor update"
|
25
|
+
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
|
26
|
+
fi
|
27
|
+
|
28
|
+
# Initialize the local directory as a Git repository
|
29
|
+
git init
|
30
|
+
|
31
|
+
# Adds the files in the local repository and stages them for commit.
|
32
|
+
git add .
|
33
|
+
|
34
|
+
# Commits the tracked changes and prepares them to be pushed to a remote repository.
|
35
|
+
git commit -m "$release_note"
|
36
|
+
|
37
|
+
# Sets the new remote
|
38
|
+
git_remote=`git remote`
|
39
|
+
if [ "$git_remote" = "" ]; then # git remote not defined
|
40
|
+
|
41
|
+
if [ "$GIT_TOKEN" = "" ]; then
|
42
|
+
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
|
43
|
+
git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
|
44
|
+
else
|
45
|
+
git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
|
46
|
+
fi
|
47
|
+
|
48
|
+
fi
|
49
|
+
|
50
|
+
git pull origin master
|
51
|
+
|
52
|
+
# Pushes (Forces) the changes in the local repository up to the remote repository
|
53
|
+
echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
|
54
|
+
git push origin master 2>&1 | grep -v 'To https'
|
55
|
+
|
Binary file
|
@@ -0,0 +1,213 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign Admin API
|
3
|
+
|
4
|
+
#An API for an organization administrator to manage organizations, accounts and users
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require "uri"
|
13
|
+
|
14
|
+
module DocuSign_Admin
|
15
|
+
|
16
|
+
class GetGroupsOptions
|
17
|
+
# Index of first item to include in the response Default value: 0
|
18
|
+
attr_accessor :start
|
19
|
+
|
20
|
+
# Page size of the response Default value: 20
|
21
|
+
attr_accessor :take
|
22
|
+
|
23
|
+
# Index of the last item to include in the response. Ignored if 'take' parameter is specfied
|
24
|
+
attr_accessor :_end
|
25
|
+
|
26
|
+
def self.default
|
27
|
+
@@default ||= GetGroupsOptions.new
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
class GetOrganizationsOptions
|
32
|
+
# Specifies how to select the organizations. Values: org_admin - will return organizations for which the user is an admin; account_membership: will return organizations that contain an account of which the user is a member Default value: org_admin
|
33
|
+
attr_accessor :mode
|
34
|
+
|
35
|
+
def self.default
|
36
|
+
@@default ||= GetOrganizationsOptions.new
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
|
41
|
+
class AccountsApi
|
42
|
+
attr_accessor :api_client
|
43
|
+
|
44
|
+
def initialize(api_client = AccountsApi.default)
|
45
|
+
@api_client = api_client
|
46
|
+
end
|
47
|
+
|
48
|
+
# Returns the list of groups in an account.
|
49
|
+
# Required scopes: group_read
|
50
|
+
# @param organization_id The organization ID Guid
|
51
|
+
# @param account_id The account ID Guid
|
52
|
+
# @param DocuSign_Admin::GetGroupsOptions Options for modifying the behavior of the function.
|
53
|
+
# @return [MemberGroupsResponse]
|
54
|
+
def get_groups(organization_id, account_id, options = DocuSign_Admin::GetGroupsOptions.default)
|
55
|
+
data, _status_code, _headers = get_groups_with_http_info(organization_id, account_id, options)
|
56
|
+
return data
|
57
|
+
end
|
58
|
+
|
59
|
+
# Returns the list of groups in an account.
|
60
|
+
# Required scopes: group_read
|
61
|
+
# @param organization_id The organization ID Guid
|
62
|
+
# @param account_id The account ID Guid
|
63
|
+
# @param DocuSign_Admin::GetGroupsOptions Options for modifying the behavior of the function.
|
64
|
+
# @return [Array<(MemberGroupsResponse, Fixnum, Hash)>] MemberGroupsResponse data, response status code and response headers
|
65
|
+
def get_groups_with_http_info(organization_id, account_id, options = DocuSign_Admin::GetGroupsOptions.default)
|
66
|
+
if @api_client.config.debugging
|
67
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_groups ..."
|
68
|
+
end
|
69
|
+
# verify the required parameter 'organization_id' is set
|
70
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling AccountsApi.get_groups" if organization_id.nil?
|
71
|
+
# verify the required parameter 'account_id' is set
|
72
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_groups" if account_id.nil?
|
73
|
+
# resource path
|
74
|
+
local_var_path = "/v2/organizations/{organizationId}/accounts/{accountId}/groups".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
75
|
+
|
76
|
+
# query parameters
|
77
|
+
query_params = {}
|
78
|
+
query_params[:'start'] = options.start if !options.start.nil?
|
79
|
+
query_params[:'take'] = options.take if !options.take.nil?
|
80
|
+
query_params[:'end'] = options._end if !options._end.nil?
|
81
|
+
|
82
|
+
# header parameters
|
83
|
+
header_params = {}
|
84
|
+
# HTTP header 'Accept' (if needed)
|
85
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
86
|
+
# HTTP header 'Content-Type'
|
87
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
88
|
+
|
89
|
+
# form parameters
|
90
|
+
form_params = {}
|
91
|
+
|
92
|
+
# http body (model)
|
93
|
+
post_body = nil
|
94
|
+
auth_names = []
|
95
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
96
|
+
:header_params => header_params,
|
97
|
+
:query_params => query_params,
|
98
|
+
:form_params => form_params,
|
99
|
+
:body => post_body,
|
100
|
+
:auth_names => auth_names,
|
101
|
+
:return_type => 'MemberGroupsResponse')
|
102
|
+
if @api_client.config.debugging
|
103
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
104
|
+
end
|
105
|
+
return data, status_code, headers
|
106
|
+
end
|
107
|
+
|
108
|
+
# Returns the list of organizations of which the authenticated user is a member.
|
109
|
+
# Required scopes: organization_read
|
110
|
+
# @param DocuSign_Admin::GetOrganizationsOptions Options for modifying the behavior of the function.
|
111
|
+
# @return [OrganizationsResponse]
|
112
|
+
def get_organizations(options = DocuSign_Admin::GetOrganizationsOptions.default)
|
113
|
+
data, _status_code, _headers = get_organizations_with_http_info(options)
|
114
|
+
return data
|
115
|
+
end
|
116
|
+
|
117
|
+
# Returns the list of organizations of which the authenticated user is a member.
|
118
|
+
# Required scopes: organization_read
|
119
|
+
# @param DocuSign_Admin::GetOrganizationsOptions Options for modifying the behavior of the function.
|
120
|
+
# @return [Array<(OrganizationsResponse, Fixnum, Hash)>] OrganizationsResponse data, response status code and response headers
|
121
|
+
def get_organizations_with_http_info(options = DocuSign_Admin::GetOrganizationsOptions.default)
|
122
|
+
if @api_client.config.debugging
|
123
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_organizations ..."
|
124
|
+
end
|
125
|
+
# resource path
|
126
|
+
local_var_path = "/v2/organizations".sub('{format}','json')
|
127
|
+
|
128
|
+
# query parameters
|
129
|
+
query_params = {}
|
130
|
+
query_params[:'mode'] = options.mode if !options.mode.nil?
|
131
|
+
|
132
|
+
# header parameters
|
133
|
+
header_params = {}
|
134
|
+
# HTTP header 'Accept' (if needed)
|
135
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
136
|
+
# HTTP header 'Content-Type'
|
137
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
138
|
+
|
139
|
+
# form parameters
|
140
|
+
form_params = {}
|
141
|
+
|
142
|
+
# http body (model)
|
143
|
+
post_body = nil
|
144
|
+
auth_names = []
|
145
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
146
|
+
:header_params => header_params,
|
147
|
+
:query_params => query_params,
|
148
|
+
:form_params => form_params,
|
149
|
+
:body => post_body,
|
150
|
+
:auth_names => auth_names,
|
151
|
+
:return_type => 'OrganizationsResponse')
|
152
|
+
if @api_client.config.debugging
|
153
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_organizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
154
|
+
end
|
155
|
+
return data, status_code, headers
|
156
|
+
end
|
157
|
+
|
158
|
+
# Returns the list of permission profiles in an account.
|
159
|
+
# Required scopes: permission_read
|
160
|
+
# @param organization_id The organization ID Guid
|
161
|
+
# @param account_id The account ID Guid
|
162
|
+
# @return [PermissionsResponse]
|
163
|
+
def get_permissions(organization_id, account_id)
|
164
|
+
data, _status_code, _headers = get_permissions_with_http_info(organization_id, account_id)
|
165
|
+
return data
|
166
|
+
end
|
167
|
+
|
168
|
+
# Returns the list of permission profiles in an account.
|
169
|
+
# Required scopes: permission_read
|
170
|
+
# @param organization_id The organization ID Guid
|
171
|
+
# @param account_id The account ID Guid
|
172
|
+
# @return [Array<(PermissionsResponse, Fixnum, Hash)>] PermissionsResponse data, response status code and response headers
|
173
|
+
def get_permissions_with_http_info(organization_id, account_id)
|
174
|
+
if @api_client.config.debugging
|
175
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_permissions ..."
|
176
|
+
end
|
177
|
+
# verify the required parameter 'organization_id' is set
|
178
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling AccountsApi.get_permissions" if organization_id.nil?
|
179
|
+
# verify the required parameter 'account_id' is set
|
180
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_permissions" if account_id.nil?
|
181
|
+
# resource path
|
182
|
+
local_var_path = "/v2/organizations/{organizationId}/accounts/{accountId}/permissions".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
|
183
|
+
|
184
|
+
# query parameters
|
185
|
+
query_params = {}
|
186
|
+
|
187
|
+
# header parameters
|
188
|
+
header_params = {}
|
189
|
+
# HTTP header 'Accept' (if needed)
|
190
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
191
|
+
# HTTP header 'Content-Type'
|
192
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
193
|
+
|
194
|
+
# form parameters
|
195
|
+
form_params = {}
|
196
|
+
|
197
|
+
# http body (model)
|
198
|
+
post_body = nil
|
199
|
+
auth_names = []
|
200
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
201
|
+
:header_params => header_params,
|
202
|
+
:query_params => query_params,
|
203
|
+
:form_params => form_params,
|
204
|
+
:body => post_body,
|
205
|
+
:auth_names => auth_names,
|
206
|
+
:return_type => 'PermissionsResponse')
|
207
|
+
if @api_client.config.debugging
|
208
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
209
|
+
end
|
210
|
+
return data, status_code, headers
|
211
|
+
end
|
212
|
+
end
|
213
|
+
end
|
@@ -0,0 +1,456 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign Admin API
|
3
|
+
|
4
|
+
#An API for an organization administrator to manage organizations, accounts and users
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require "uri"
|
13
|
+
|
14
|
+
module DocuSign_Admin
|
15
|
+
|
16
|
+
|
17
|
+
class BulkExportsApi
|
18
|
+
attr_accessor :api_client
|
19
|
+
|
20
|
+
def initialize(api_client = BulkExportsApi.default)
|
21
|
+
@api_client = api_client
|
22
|
+
end
|
23
|
+
|
24
|
+
# Creates a new Account Setting Export request.
|
25
|
+
# Required scopes: account_read
|
26
|
+
# @param organization_id The organization ID Guid
|
27
|
+
# @param request Request body containing details about the accounts be compared
|
28
|
+
# @return [OrganizationExportResponse]
|
29
|
+
def create_account_settings_export(organization_id, request)
|
30
|
+
data, _status_code, _headers = create_account_settings_export_with_http_info(organization_id, request)
|
31
|
+
return data
|
32
|
+
end
|
33
|
+
|
34
|
+
# Creates a new Account Setting Export request.
|
35
|
+
# Required scopes: account_read
|
36
|
+
# @param organization_id The organization ID Guid
|
37
|
+
# @param request Request body containing details about the accounts be compared
|
38
|
+
# @return [Array<(OrganizationExportResponse, Fixnum, Hash)>] OrganizationExportResponse data, response status code and response headers
|
39
|
+
def create_account_settings_export_with_http_info(organization_id, request)
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug "Calling API: BulkExportsApi.create_account_settings_export ..."
|
42
|
+
end
|
43
|
+
# verify the required parameter 'organization_id' is set
|
44
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.create_account_settings_export" if organization_id.nil?
|
45
|
+
# verify the required parameter 'request' is set
|
46
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling BulkExportsApi.create_account_settings_export" if request.nil?
|
47
|
+
# resource path
|
48
|
+
local_var_path = "/v2/organizations/{organizationId}/exports/account_settings".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
|
49
|
+
|
50
|
+
# query parameters
|
51
|
+
query_params = {}
|
52
|
+
|
53
|
+
# header parameters
|
54
|
+
header_params = {}
|
55
|
+
# HTTP header 'Accept' (if needed)
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
|
+
# HTTP header 'Content-Type'
|
58
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
59
|
+
|
60
|
+
# form parameters
|
61
|
+
form_params = {}
|
62
|
+
|
63
|
+
# http body (model)
|
64
|
+
post_body = @api_client.object_to_http_body(request)
|
65
|
+
auth_names = []
|
66
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
67
|
+
:header_params => header_params,
|
68
|
+
:query_params => query_params,
|
69
|
+
:form_params => form_params,
|
70
|
+
:body => post_body,
|
71
|
+
:auth_names => auth_names,
|
72
|
+
:return_type => 'OrganizationExportResponse')
|
73
|
+
if @api_client.config.debugging
|
74
|
+
@api_client.config.logger.debug "API called: BulkExportsApi#create_account_settings_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
75
|
+
end
|
76
|
+
return data, status_code, headers
|
77
|
+
end
|
78
|
+
|
79
|
+
# Creates a new User List Export request.
|
80
|
+
# Required scopes: user_read
|
81
|
+
# @param organization_id The organization ID Guid
|
82
|
+
# @param request Request body containing details about what is to be exported
|
83
|
+
# @return [OrganizationExportResponse]
|
84
|
+
def create_user_list_export(organization_id, request)
|
85
|
+
data, _status_code, _headers = create_user_list_export_with_http_info(organization_id, request)
|
86
|
+
return data
|
87
|
+
end
|
88
|
+
|
89
|
+
# Creates a new User List Export request.
|
90
|
+
# Required scopes: user_read
|
91
|
+
# @param organization_id The organization ID Guid
|
92
|
+
# @param request Request body containing details about what is to be exported
|
93
|
+
# @return [Array<(OrganizationExportResponse, Fixnum, Hash)>] OrganizationExportResponse data, response status code and response headers
|
94
|
+
def create_user_list_export_with_http_info(organization_id, request)
|
95
|
+
if @api_client.config.debugging
|
96
|
+
@api_client.config.logger.debug "Calling API: BulkExportsApi.create_user_list_export ..."
|
97
|
+
end
|
98
|
+
# verify the required parameter 'organization_id' is set
|
99
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.create_user_list_export" if organization_id.nil?
|
100
|
+
# verify the required parameter 'request' is set
|
101
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling BulkExportsApi.create_user_list_export" if request.nil?
|
102
|
+
# resource path
|
103
|
+
local_var_path = "/v2/organizations/{organizationId}/exports/user_list".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
|
104
|
+
|
105
|
+
# query parameters
|
106
|
+
query_params = {}
|
107
|
+
|
108
|
+
# header parameters
|
109
|
+
header_params = {}
|
110
|
+
# HTTP header 'Accept' (if needed)
|
111
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
112
|
+
# HTTP header 'Content-Type'
|
113
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
114
|
+
|
115
|
+
# form parameters
|
116
|
+
form_params = {}
|
117
|
+
|
118
|
+
# http body (model)
|
119
|
+
post_body = @api_client.object_to_http_body(request)
|
120
|
+
auth_names = []
|
121
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
122
|
+
:header_params => header_params,
|
123
|
+
:query_params => query_params,
|
124
|
+
:form_params => form_params,
|
125
|
+
:body => post_body,
|
126
|
+
:auth_names => auth_names,
|
127
|
+
:return_type => 'OrganizationExportResponse')
|
128
|
+
if @api_client.config.debugging
|
129
|
+
@api_client.config.logger.debug "API called: BulkExportsApi#create_user_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
130
|
+
end
|
131
|
+
return data, status_code, headers
|
132
|
+
end
|
133
|
+
|
134
|
+
# Deletes a single Account Settings Export request
|
135
|
+
# Required scopes: account_read
|
136
|
+
# @param organization_id The organization ID Guid
|
137
|
+
# @param export_id The export ID Guid for the request
|
138
|
+
# @return [Object]
|
139
|
+
def delete_account_settings_export(organization_id, export_id)
|
140
|
+
data, _status_code, _headers = delete_account_settings_export_with_http_info(organization_id, export_id)
|
141
|
+
return data
|
142
|
+
end
|
143
|
+
|
144
|
+
# Deletes a single Account Settings Export request
|
145
|
+
# Required scopes: account_read
|
146
|
+
# @param organization_id The organization ID Guid
|
147
|
+
# @param export_id The export ID Guid for the request
|
148
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
149
|
+
def delete_account_settings_export_with_http_info(organization_id, export_id)
|
150
|
+
if @api_client.config.debugging
|
151
|
+
@api_client.config.logger.debug "Calling API: BulkExportsApi.delete_account_settings_export ..."
|
152
|
+
end
|
153
|
+
# verify the required parameter 'organization_id' is set
|
154
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.delete_account_settings_export" if organization_id.nil?
|
155
|
+
# verify the required parameter 'export_id' is set
|
156
|
+
fail ArgumentError, "Missing the required parameter 'export_id' when calling BulkExportsApi.delete_account_settings_export" if export_id.nil?
|
157
|
+
# resource path
|
158
|
+
local_var_path = "/v2/organizations/{organizationId}/exports/account_settings/{exportId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'exportId' + '}', export_id.to_s)
|
159
|
+
|
160
|
+
# query parameters
|
161
|
+
query_params = {}
|
162
|
+
|
163
|
+
# header parameters
|
164
|
+
header_params = {}
|
165
|
+
# HTTP header 'Accept' (if needed)
|
166
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
167
|
+
# HTTP header 'Content-Type'
|
168
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
169
|
+
|
170
|
+
# form parameters
|
171
|
+
form_params = {}
|
172
|
+
|
173
|
+
# http body (model)
|
174
|
+
post_body = nil
|
175
|
+
auth_names = []
|
176
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
177
|
+
:header_params => header_params,
|
178
|
+
:query_params => query_params,
|
179
|
+
:form_params => form_params,
|
180
|
+
:body => post_body,
|
181
|
+
:auth_names => auth_names,
|
182
|
+
:return_type => 'Object')
|
183
|
+
if @api_client.config.debugging
|
184
|
+
@api_client.config.logger.debug "API called: BulkExportsApi#delete_account_settings_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
185
|
+
end
|
186
|
+
return data, status_code, headers
|
187
|
+
end
|
188
|
+
|
189
|
+
# Deletes a single User List Export request
|
190
|
+
# Required scopes: user_read
|
191
|
+
# @param organization_id The organization ID Guid
|
192
|
+
# @param export_id The export ID Guid for the request
|
193
|
+
# @return [Object]
|
194
|
+
def delete_user_list_export(organization_id, export_id)
|
195
|
+
data, _status_code, _headers = delete_user_list_export_with_http_info(organization_id, export_id)
|
196
|
+
return data
|
197
|
+
end
|
198
|
+
|
199
|
+
# Deletes a single User List Export request
|
200
|
+
# Required scopes: user_read
|
201
|
+
# @param organization_id The organization ID Guid
|
202
|
+
# @param export_id The export ID Guid for the request
|
203
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
204
|
+
def delete_user_list_export_with_http_info(organization_id, export_id)
|
205
|
+
if @api_client.config.debugging
|
206
|
+
@api_client.config.logger.debug "Calling API: BulkExportsApi.delete_user_list_export ..."
|
207
|
+
end
|
208
|
+
# verify the required parameter 'organization_id' is set
|
209
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.delete_user_list_export" if organization_id.nil?
|
210
|
+
# verify the required parameter 'export_id' is set
|
211
|
+
fail ArgumentError, "Missing the required parameter 'export_id' when calling BulkExportsApi.delete_user_list_export" if export_id.nil?
|
212
|
+
# resource path
|
213
|
+
local_var_path = "/v2/organizations/{organizationId}/exports/user_list/{exportId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'exportId' + '}', export_id.to_s)
|
214
|
+
|
215
|
+
# query parameters
|
216
|
+
query_params = {}
|
217
|
+
|
218
|
+
# header parameters
|
219
|
+
header_params = {}
|
220
|
+
# HTTP header 'Accept' (if needed)
|
221
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
222
|
+
# HTTP header 'Content-Type'
|
223
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
224
|
+
|
225
|
+
# form parameters
|
226
|
+
form_params = {}
|
227
|
+
|
228
|
+
# http body (model)
|
229
|
+
post_body = nil
|
230
|
+
auth_names = []
|
231
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
232
|
+
:header_params => header_params,
|
233
|
+
:query_params => query_params,
|
234
|
+
:form_params => form_params,
|
235
|
+
:body => post_body,
|
236
|
+
:auth_names => auth_names,
|
237
|
+
:return_type => 'Object')
|
238
|
+
if @api_client.config.debugging
|
239
|
+
@api_client.config.logger.debug "API called: BulkExportsApi#delete_user_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
240
|
+
end
|
241
|
+
return data, status_code, headers
|
242
|
+
end
|
243
|
+
|
244
|
+
# Returns the details/metadata for a single Account Setting Export request
|
245
|
+
# Required scopes: account_read
|
246
|
+
# @param organization_id The organization ID Guid
|
247
|
+
# @param export_id The export ID Guid for the request
|
248
|
+
# @return [OrganizationExportResponse]
|
249
|
+
def get_account_settings_export(organization_id, export_id)
|
250
|
+
data, _status_code, _headers = get_account_settings_export_with_http_info(organization_id, export_id)
|
251
|
+
return data
|
252
|
+
end
|
253
|
+
|
254
|
+
# Returns the details/metadata for a single Account Setting Export request
|
255
|
+
# Required scopes: account_read
|
256
|
+
# @param organization_id The organization ID Guid
|
257
|
+
# @param export_id The export ID Guid for the request
|
258
|
+
# @return [Array<(OrganizationExportResponse, Fixnum, Hash)>] OrganizationExportResponse data, response status code and response headers
|
259
|
+
def get_account_settings_export_with_http_info(organization_id, export_id)
|
260
|
+
if @api_client.config.debugging
|
261
|
+
@api_client.config.logger.debug "Calling API: BulkExportsApi.get_account_settings_export ..."
|
262
|
+
end
|
263
|
+
# verify the required parameter 'organization_id' is set
|
264
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.get_account_settings_export" if organization_id.nil?
|
265
|
+
# verify the required parameter 'export_id' is set
|
266
|
+
fail ArgumentError, "Missing the required parameter 'export_id' when calling BulkExportsApi.get_account_settings_export" if export_id.nil?
|
267
|
+
# resource path
|
268
|
+
local_var_path = "/v2/organizations/{organizationId}/exports/account_settings/{exportId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'exportId' + '}', export_id.to_s)
|
269
|
+
|
270
|
+
# query parameters
|
271
|
+
query_params = {}
|
272
|
+
|
273
|
+
# header parameters
|
274
|
+
header_params = {}
|
275
|
+
# HTTP header 'Accept' (if needed)
|
276
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
277
|
+
# HTTP header 'Content-Type'
|
278
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
279
|
+
|
280
|
+
# form parameters
|
281
|
+
form_params = {}
|
282
|
+
|
283
|
+
# http body (model)
|
284
|
+
post_body = nil
|
285
|
+
auth_names = []
|
286
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
287
|
+
:header_params => header_params,
|
288
|
+
:query_params => query_params,
|
289
|
+
:form_params => form_params,
|
290
|
+
:body => post_body,
|
291
|
+
:auth_names => auth_names,
|
292
|
+
:return_type => 'OrganizationExportResponse')
|
293
|
+
if @api_client.config.debugging
|
294
|
+
@api_client.config.logger.debug "API called: BulkExportsApi#get_account_settings_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
295
|
+
end
|
296
|
+
return data, status_code, headers
|
297
|
+
end
|
298
|
+
|
299
|
+
# Returns the details/metadata for Account Setting Export requests
|
300
|
+
# Required scopes: account_read
|
301
|
+
# @param organization_id The organization ID Guid
|
302
|
+
# @return [OrganizationExportsResponse]
|
303
|
+
def get_account_settings_exports(organization_id)
|
304
|
+
data, _status_code, _headers = get_account_settings_exports_with_http_info(organization_id)
|
305
|
+
return data
|
306
|
+
end
|
307
|
+
|
308
|
+
# Returns the details/metadata for Account Setting Export requests
|
309
|
+
# Required scopes: account_read
|
310
|
+
# @param organization_id The organization ID Guid
|
311
|
+
# @return [Array<(OrganizationExportsResponse, Fixnum, Hash)>] OrganizationExportsResponse data, response status code and response headers
|
312
|
+
def get_account_settings_exports_with_http_info(organization_id)
|
313
|
+
if @api_client.config.debugging
|
314
|
+
@api_client.config.logger.debug "Calling API: BulkExportsApi.get_account_settings_exports ..."
|
315
|
+
end
|
316
|
+
# verify the required parameter 'organization_id' is set
|
317
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.get_account_settings_exports" if organization_id.nil?
|
318
|
+
# resource path
|
319
|
+
local_var_path = "/v2/organizations/{organizationId}/exports/account_settings".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
|
320
|
+
|
321
|
+
# query parameters
|
322
|
+
query_params = {}
|
323
|
+
|
324
|
+
# header parameters
|
325
|
+
header_params = {}
|
326
|
+
# HTTP header 'Accept' (if needed)
|
327
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
328
|
+
# HTTP header 'Content-Type'
|
329
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
330
|
+
|
331
|
+
# form parameters
|
332
|
+
form_params = {}
|
333
|
+
|
334
|
+
# http body (model)
|
335
|
+
post_body = nil
|
336
|
+
auth_names = []
|
337
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
338
|
+
:header_params => header_params,
|
339
|
+
:query_params => query_params,
|
340
|
+
:form_params => form_params,
|
341
|
+
:body => post_body,
|
342
|
+
:auth_names => auth_names,
|
343
|
+
:return_type => 'OrganizationExportsResponse')
|
344
|
+
if @api_client.config.debugging
|
345
|
+
@api_client.config.logger.debug "API called: BulkExportsApi#get_account_settings_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
346
|
+
end
|
347
|
+
return data, status_code, headers
|
348
|
+
end
|
349
|
+
|
350
|
+
# Returns the details/metadata for a single User List Export request
|
351
|
+
# Required scopes: user_read
|
352
|
+
# @param organization_id The organization ID Guid
|
353
|
+
# @param export_id The export ID Guid for the request
|
354
|
+
# @return [OrganizationExportResponse]
|
355
|
+
def get_user_list_export(organization_id, export_id)
|
356
|
+
data, _status_code, _headers = get_user_list_export_with_http_info(organization_id, export_id)
|
357
|
+
return data
|
358
|
+
end
|
359
|
+
|
360
|
+
# Returns the details/metadata for a single User List Export request
|
361
|
+
# Required scopes: user_read
|
362
|
+
# @param organization_id The organization ID Guid
|
363
|
+
# @param export_id The export ID Guid for the request
|
364
|
+
# @return [Array<(OrganizationExportResponse, Fixnum, Hash)>] OrganizationExportResponse data, response status code and response headers
|
365
|
+
def get_user_list_export_with_http_info(organization_id, export_id)
|
366
|
+
if @api_client.config.debugging
|
367
|
+
@api_client.config.logger.debug "Calling API: BulkExportsApi.get_user_list_export ..."
|
368
|
+
end
|
369
|
+
# verify the required parameter 'organization_id' is set
|
370
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.get_user_list_export" if organization_id.nil?
|
371
|
+
# verify the required parameter 'export_id' is set
|
372
|
+
fail ArgumentError, "Missing the required parameter 'export_id' when calling BulkExportsApi.get_user_list_export" if export_id.nil?
|
373
|
+
# resource path
|
374
|
+
local_var_path = "/v2/organizations/{organizationId}/exports/user_list/{exportId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'exportId' + '}', export_id.to_s)
|
375
|
+
|
376
|
+
# query parameters
|
377
|
+
query_params = {}
|
378
|
+
|
379
|
+
# header parameters
|
380
|
+
header_params = {}
|
381
|
+
# HTTP header 'Accept' (if needed)
|
382
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
383
|
+
# HTTP header 'Content-Type'
|
384
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
385
|
+
|
386
|
+
# form parameters
|
387
|
+
form_params = {}
|
388
|
+
|
389
|
+
# http body (model)
|
390
|
+
post_body = nil
|
391
|
+
auth_names = []
|
392
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
393
|
+
:header_params => header_params,
|
394
|
+
:query_params => query_params,
|
395
|
+
:form_params => form_params,
|
396
|
+
:body => post_body,
|
397
|
+
:auth_names => auth_names,
|
398
|
+
:return_type => 'OrganizationExportResponse')
|
399
|
+
if @api_client.config.debugging
|
400
|
+
@api_client.config.logger.debug "API called: BulkExportsApi#get_user_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
401
|
+
end
|
402
|
+
return data, status_code, headers
|
403
|
+
end
|
404
|
+
|
405
|
+
# Returns a list of existing User List Exports (requests and completed exports) and their details/metadata
|
406
|
+
# Required scopes: user_read
|
407
|
+
# @param organization_id The organization ID Guid
|
408
|
+
# @return [OrganizationExportsResponse]
|
409
|
+
def get_user_list_exports(organization_id)
|
410
|
+
data, _status_code, _headers = get_user_list_exports_with_http_info(organization_id)
|
411
|
+
return data
|
412
|
+
end
|
413
|
+
|
414
|
+
# Returns a list of existing User List Exports (requests and completed exports) and their details/metadata
|
415
|
+
# Required scopes: user_read
|
416
|
+
# @param organization_id The organization ID Guid
|
417
|
+
# @return [Array<(OrganizationExportsResponse, Fixnum, Hash)>] OrganizationExportsResponse data, response status code and response headers
|
418
|
+
def get_user_list_exports_with_http_info(organization_id)
|
419
|
+
if @api_client.config.debugging
|
420
|
+
@api_client.config.logger.debug "Calling API: BulkExportsApi.get_user_list_exports ..."
|
421
|
+
end
|
422
|
+
# verify the required parameter 'organization_id' is set
|
423
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.get_user_list_exports" if organization_id.nil?
|
424
|
+
# resource path
|
425
|
+
local_var_path = "/v2/organizations/{organizationId}/exports/user_list".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)
|
426
|
+
|
427
|
+
# query parameters
|
428
|
+
query_params = {}
|
429
|
+
|
430
|
+
# header parameters
|
431
|
+
header_params = {}
|
432
|
+
# HTTP header 'Accept' (if needed)
|
433
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
434
|
+
# HTTP header 'Content-Type'
|
435
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
436
|
+
|
437
|
+
# form parameters
|
438
|
+
form_params = {}
|
439
|
+
|
440
|
+
# http body (model)
|
441
|
+
post_body = nil
|
442
|
+
auth_names = []
|
443
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
444
|
+
:header_params => header_params,
|
445
|
+
:query_params => query_params,
|
446
|
+
:form_params => form_params,
|
447
|
+
:body => post_body,
|
448
|
+
:auth_names => auth_names,
|
449
|
+
:return_type => 'OrganizationExportsResponse')
|
450
|
+
if @api_client.config.debugging
|
451
|
+
@api_client.config.logger.debug "API called: BulkExportsApi#get_user_list_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
452
|
+
end
|
453
|
+
return data, status_code, headers
|
454
|
+
end
|
455
|
+
end
|
456
|
+
end
|