docusign_monitor 1.0.0.pre.alpha
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +6 -0
- data/Gemfile +7 -0
- data/LICENSE +21 -0
- data/README.md +80 -0
- data/Rakefile +8 -0
- data/docusign_monitor.gemspec +46 -0
- data/git_push.sh +55 -0
- data/lib/docusign_monitor.rb +46 -0
- data/lib/docusign_monitor/api/data_set_api.rb +275 -0
- data/lib/docusign_monitor/client/api_client.rb +591 -0
- data/lib/docusign_monitor/client/api_error.rb +37 -0
- data/lib/docusign_monitor/client/auth/oauth.rb +1061 -0
- data/lib/docusign_monitor/configuration.rb +203 -0
- data/lib/docusign_monitor/models/aggregation.rb +183 -0
- data/lib/docusign_monitor/models/filter.rb +183 -0
- data/lib/docusign_monitor/models/raw_request.rb +235 -0
- data/lib/docusign_monitor/models/web_query.rb +248 -0
- data/lib/docusign_monitor/version.rb +14 -0
- data/tests/Gemfile +5 -0
- data/tests/docs/Test.pdf +0 -0
- data/tests/spec/unit_tests_using_jwt_spec.rb +128 -0
- metadata +286 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 2f7ee701e7e21458660d78df75bafd685c19a27849672ecad41cce915efa3f16
|
4
|
+
data.tar.gz: a0412fbfa9ffdd0e8548eea90bfddca8b8f610ba7fb903e0fc7b8081dfd1d9fd
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 301c5c6b2633963c4d5f6c39ba48dbd2b28629f93ffb7b9f93ef70a2846b6fd98bb52947f5a8435420fbf9c93e46d9bb8574f0b8141382e6e64d6e7739d52bb0
|
7
|
+
data.tar.gz: 7e0054f50320f8a88cc88f6b63c01afdf490c08bfa65adb1803c3782bc3405b545c8c6aa39c5158cc6397b1e50470afd582e8c5cac91a50ec16e1edd9a6cf08d
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,6 @@
|
|
1
|
+
# DocuSign Monitor Ruby Client Changelog
|
2
|
+
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
|
3
|
+
|
4
|
+
## [v1.0.0.alpha] - DocuSign Monitor API v1 - 02/25/2022
|
5
|
+
### Changed
|
6
|
+
- First GA version of Monitor API, supports DocuSign Monitor v1-1.0.0
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2022- 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,80 @@
|
|
1
|
+
# The Official DocuSign Monitor Client
|
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
|
+
|
9
|
+
- Ruby 1.9+
|
10
|
+
- Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
|
11
|
+
|
12
|
+
## Compatibility
|
13
|
+
|
14
|
+
- Ruby 1.9+
|
15
|
+
|
16
|
+
## Note
|
17
|
+
|
18
|
+
This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below.
|
19
|
+
|
20
|
+
## Installation
|
21
|
+
|
22
|
+
### Install via your application's **Gemfile**:
|
23
|
+
|
24
|
+
1. In your application's **Gemfile**, add:
|
25
|
+
**gem 'docusign_monitor'**
|
26
|
+
2. Open your preferred console.
|
27
|
+
3. In your project directory, execute the installer by typing:
|
28
|
+
**bundle install**
|
29
|
+
|
30
|
+
### Manual install:
|
31
|
+
|
32
|
+
1. Open your preferred console.
|
33
|
+
2. In the console, type:
|
34
|
+
**gem install docusign_monitor**
|
35
|
+
|
36
|
+
### Dependencies
|
37
|
+
|
38
|
+
This client has the following external dependencies:
|
39
|
+
|
40
|
+
- Jwt>=1.5.2
|
41
|
+
- Json>=2.1.0
|
42
|
+
- Typhoeus>=1.0.1
|
43
|
+
|
44
|
+
## Code Examples
|
45
|
+
|
46
|
+
### Launchers
|
47
|
+
|
48
|
+
DocuSign provides a sample application code referred to as a [Launcher](https://github.com/docusign/code-examples-ruby). The Launcher contains a set of 31 common use cases and associated source files. These examples use either DocuSign's [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Tokens (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) flows.
|
49
|
+
|
50
|
+
### Proof-of-concept applications
|
51
|
+
|
52
|
+
If your goal is to create a proof-of-concept application, DocuSign provides a set of [Quick Start](https://github.com/docusign/qs-ruby) examples. The Quick Start examples are meant to be used with DocuSign's [OAuth Token Generator](https://developers.docusign.com/oauth-token-generator), which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.
|
53
|
+
|
54
|
+
## OAuth Implementations
|
55
|
+
|
56
|
+
For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/esign-rest-api/guides/authentication).
|
57
|
+
|
58
|
+
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
|
59
|
+
|
60
|
+
|
61
|
+
## Support
|
62
|
+
|
63
|
+
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
|
64
|
+
|
65
|
+
## License
|
66
|
+
|
67
|
+
The DocuSign Ruby Client is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
|
68
|
+
|
69
|
+
[rubygems-image]: https://img.shields.io/gem/v/docusign_monitor.svg?style=flat
|
70
|
+
[rubygems-url]: https://rubygems.org/gems/docusign_monitor
|
71
|
+
[downloads-image]: https://img.shields.io/gem/dt/docusign_monitor.svg?style=flat
|
72
|
+
[downloads-url]: https://rubygems.org/gems/docusign_monitor
|
73
|
+
[travis-image]: https://img.shields.io/travis/docusign/docusign-monitor-ruby-client.svg?style=flat
|
74
|
+
[travis-url]: https://travis-ci.org/docusign/docusign-monitor-ruby-client
|
75
|
+
|
76
|
+
### Additional Resources
|
77
|
+
* [DocuSign Developer Center](https://developers.docusign.com)
|
78
|
+
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
|
79
|
+
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
|
80
|
+
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
|
data/Rakefile
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#DocuSign Monitor API
|
5
|
+
|
6
|
+
#An API for an integrator to access the features of DocuSign Monitor
|
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_monitor/version"
|
16
|
+
|
17
|
+
Gem::Specification.new do |s|
|
18
|
+
s.name = "docusign_monitor"
|
19
|
+
s.version = DocuSign_Monitor::VERSION
|
20
|
+
s.platform = Gem::Platform::RUBY
|
21
|
+
s.authors = ["DocuSign"]
|
22
|
+
s.email = ["devcenter@docusign.com"]
|
23
|
+
s.homepage = "https://github.com/docusign/docusign-monitor-ruby-client"
|
24
|
+
s.summary = "DocuSign Monitor API Ruby Gem"
|
25
|
+
s.description = "The DocuSign package makes integrating DocuSign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-monitor-ruby-client repository."
|
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 'addressable', '~> 2.7', '>= 2.7.0'
|
31
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
32
|
+
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
33
|
+
|
34
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
35
|
+
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
36
|
+
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
37
|
+
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
38
|
+
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
39
|
+
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
40
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
|
41
|
+
|
42
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
43
|
+
s.test_files = `find spec/*`.split("\n")
|
44
|
+
s.executables = []
|
45
|
+
s.require_paths = ["lib"]
|
46
|
+
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 crediential 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
|
+
|
@@ -0,0 +1,46 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign Monitor API - v2
|
3
|
+
|
4
|
+
#An API for an integrator to access the features of DocuSign Monitor
|
5
|
+
|
6
|
+
OpenAPI spec version: v2.0
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
# Common files
|
13
|
+
require 'docusign_monitor/client/api_client'
|
14
|
+
require 'docusign_monitor/client/api_error'
|
15
|
+
require 'docusign_monitor/version'
|
16
|
+
require 'docusign_monitor/configuration'
|
17
|
+
|
18
|
+
# Client Files
|
19
|
+
require 'docusign_monitor/client/auth/oauth'
|
20
|
+
|
21
|
+
# Models
|
22
|
+
require 'docusign_monitor/models/aggregation'
|
23
|
+
require 'docusign_monitor/models/filter'
|
24
|
+
require 'docusign_monitor/models/raw_request'
|
25
|
+
require 'docusign_monitor/models/web_query'
|
26
|
+
|
27
|
+
# APIs
|
28
|
+
require 'docusign_monitor/api/data_set_api'
|
29
|
+
|
30
|
+
module DocuSign_Monitor
|
31
|
+
class << self
|
32
|
+
# Customize default settings for the SDK using block.
|
33
|
+
# DocuSign_Monitor.configure do |config|
|
34
|
+
# config.username = "xxx"
|
35
|
+
# config.password = "xxx"
|
36
|
+
# end
|
37
|
+
# If no block given, return the default Configuration object.
|
38
|
+
def configure
|
39
|
+
if block_given?
|
40
|
+
yield(Configuration.default)
|
41
|
+
else
|
42
|
+
Configuration.default
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,275 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign Monitor API - v2
|
3
|
+
|
4
|
+
#An API for an integrator to access the features of DocuSign Monitor
|
5
|
+
|
6
|
+
OpenAPI spec version: v2.0
|
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_Monitor
|
15
|
+
|
16
|
+
class GetStreamForDatasetOptions
|
17
|
+
# Starting cursor position
|
18
|
+
attr_accessor :cursor
|
19
|
+
|
20
|
+
# Max number of results to return
|
21
|
+
attr_accessor :limit
|
22
|
+
|
23
|
+
def self.default
|
24
|
+
@@default ||= GetStreamForDatasetOptions.new
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
class GetWebQueryForDatasetOptions
|
29
|
+
# A JSON list of filters to apply to the underlying dataset
|
30
|
+
attr_accessor :filters
|
31
|
+
|
32
|
+
# A JSON list of aggregations to apply to the filtered dataset
|
33
|
+
attr_accessor :aggregations
|
34
|
+
|
35
|
+
# The scope to limit the query by. If omitted, defaults to the QueryScope of the DataSet. DocuSign.API.Lens.Common.QueryScope
|
36
|
+
attr_accessor :query_scope
|
37
|
+
|
38
|
+
# The AccountId or OrganizationId for this query, which will be double-checked against the User JWT. If QueryScope==AccountId, this is required. If QueryScope==OrganizationId, this is optional.
|
39
|
+
attr_accessor :query_scope_id
|
40
|
+
|
41
|
+
def self.default
|
42
|
+
@@default ||= GetWebQueryForDatasetOptions.new
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
|
47
|
+
class DataSetApi
|
48
|
+
attr_accessor :api_client
|
49
|
+
|
50
|
+
def initialize(api_client = DataSetApi.default)
|
51
|
+
@api_client = api_client
|
52
|
+
end
|
53
|
+
|
54
|
+
#
|
55
|
+
#
|
56
|
+
# @param data_set_name The name of the dataset to stream
|
57
|
+
# @param version The requested API version
|
58
|
+
# @param DocuSign_Monitor::GetStreamForDatasetOptions Options for modifying the behavior of the function.
|
59
|
+
# @return [nil]
|
60
|
+
def get_stream_for_dataset(data_set_name, version, options = DocuSign_Monitor::GetStreamForDatasetOptions.default)
|
61
|
+
get_stream_for_dataset_with_http_info(data_set_name, version, options)
|
62
|
+
return nil
|
63
|
+
end
|
64
|
+
|
65
|
+
#
|
66
|
+
#
|
67
|
+
# @param data_set_name The name of the dataset to stream
|
68
|
+
# @param version The requested API version
|
69
|
+
# @param DocuSign_Monitor::GetStreamForDatasetOptions Options for modifying the behavior of the function.
|
70
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
71
|
+
def get_stream_for_dataset_with_http_info(data_set_name, version, options = DocuSign_Monitor::GetStreamForDatasetOptions.default)
|
72
|
+
if @api_client.config.debugging
|
73
|
+
@api_client.config.logger.debug "Calling API: DataSetApi.get_stream_for_dataset ..."
|
74
|
+
end
|
75
|
+
# verify the required parameter 'data_set_name' is set
|
76
|
+
fail ArgumentError, "Missing the required parameter 'data_set_name' when calling DataSetApi.get_stream_for_dataset" if data_set_name.nil?
|
77
|
+
# verify the required parameter 'version' is set
|
78
|
+
fail ArgumentError, "Missing the required parameter 'version' when calling DataSetApi.get_stream_for_dataset" if version.nil?
|
79
|
+
# resource path
|
80
|
+
local_var_path = "/api/v{version}/datasets/{dataSetName}/stream".sub('{format}','json').sub('{' + 'dataSetName' + '}', data_set_name.to_s).sub('{' + 'version' + '}', version.to_s)
|
81
|
+
|
82
|
+
# query parameters
|
83
|
+
query_params = {}
|
84
|
+
query_params[:'cursor'] = options.cursor if !options.cursor.nil?
|
85
|
+
query_params[:'limit'] = options.limit if !options.limit.nil?
|
86
|
+
|
87
|
+
# header parameters
|
88
|
+
header_params = {}
|
89
|
+
|
90
|
+
# form parameters
|
91
|
+
form_params = {}
|
92
|
+
|
93
|
+
# http body (model)
|
94
|
+
post_body = nil
|
95
|
+
auth_names = []
|
96
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
97
|
+
:header_params => header_params,
|
98
|
+
:query_params => query_params,
|
99
|
+
:form_params => form_params,
|
100
|
+
:body => post_body,
|
101
|
+
:auth_names => auth_names)
|
102
|
+
if @api_client.config.debugging
|
103
|
+
@api_client.config.logger.debug "API called: DataSetApi#get_stream_for_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
104
|
+
end
|
105
|
+
return data, status_code, headers
|
106
|
+
end
|
107
|
+
|
108
|
+
# Supplies secured, processed data for web-based dashboards
|
109
|
+
#
|
110
|
+
# @param data_set_name The name of the dataset to query
|
111
|
+
# @param version The requested API version
|
112
|
+
# @param DocuSign_Monitor::GetWebQueryForDatasetOptions Options for modifying the behavior of the function.
|
113
|
+
# @return [nil]
|
114
|
+
def get_web_query_for_dataset(data_set_name, version, options = DocuSign_Monitor::GetWebQueryForDatasetOptions.default)
|
115
|
+
get_web_query_for_dataset_with_http_info(data_set_name, version, options)
|
116
|
+
return nil
|
117
|
+
end
|
118
|
+
|
119
|
+
# Supplies secured, processed data for web-based dashboards
|
120
|
+
#
|
121
|
+
# @param data_set_name The name of the dataset to query
|
122
|
+
# @param version The requested API version
|
123
|
+
# @param DocuSign_Monitor::GetWebQueryForDatasetOptions Options for modifying the behavior of the function.
|
124
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
125
|
+
def get_web_query_for_dataset_with_http_info(data_set_name, version, options = DocuSign_Monitor::GetWebQueryForDatasetOptions.default)
|
126
|
+
if @api_client.config.debugging
|
127
|
+
@api_client.config.logger.debug "Calling API: DataSetApi.get_web_query_for_dataset ..."
|
128
|
+
end
|
129
|
+
# verify the required parameter 'data_set_name' is set
|
130
|
+
fail ArgumentError, "Missing the required parameter 'data_set_name' when calling DataSetApi.get_web_query_for_dataset" if data_set_name.nil?
|
131
|
+
# verify the required parameter 'version' is set
|
132
|
+
fail ArgumentError, "Missing the required parameter 'version' when calling DataSetApi.get_web_query_for_dataset" if version.nil?
|
133
|
+
if options.query_scope && !['AccountId', 'OrganizationId', 'None'].include?(options.query_scope)
|
134
|
+
fail ArgumentError, 'invalid value for "query_scope", must be one of AccountId, OrganizationId, None'
|
135
|
+
end
|
136
|
+
# resource path
|
137
|
+
local_var_path = "/api/v{version}/datasets/{dataSetName}/web_query".sub('{format}','json').sub('{' + 'dataSetName' + '}', data_set_name.to_s).sub('{' + 'version' + '}', version.to_s)
|
138
|
+
|
139
|
+
# query parameters
|
140
|
+
query_params = {}
|
141
|
+
query_params[:'filters'] = options.filters if !options.filters.nil?
|
142
|
+
query_params[:'aggregations'] = options.aggregations if !options.aggregations.nil?
|
143
|
+
query_params[:'queryScope'] = options.query_scope if !options.query_scope.nil?
|
144
|
+
query_params[:'queryScopeId'] = options.query_scope_id if !options.query_scope_id.nil?
|
145
|
+
|
146
|
+
# header parameters
|
147
|
+
header_params = {}
|
148
|
+
|
149
|
+
# form parameters
|
150
|
+
form_params = {}
|
151
|
+
|
152
|
+
# http body (model)
|
153
|
+
post_body = nil
|
154
|
+
auth_names = []
|
155
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
156
|
+
:header_params => header_params,
|
157
|
+
:query_params => query_params,
|
158
|
+
:form_params => form_params,
|
159
|
+
:body => post_body,
|
160
|
+
:auth_names => auth_names)
|
161
|
+
if @api_client.config.debugging
|
162
|
+
@api_client.config.logger.debug "API called: DataSetApi#get_web_query_for_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
163
|
+
end
|
164
|
+
return data, status_code, headers
|
165
|
+
end
|
166
|
+
|
167
|
+
# Provides a raw kusto query capability to internal Docusign services
|
168
|
+
#
|
169
|
+
# @param data_set_name The name of the dataset to query
|
170
|
+
# @param version The requested API version
|
171
|
+
# @param raw_request The request body DocuSign.API.Lens.Common.RawRequest (optional parameter)
|
172
|
+
# @return [nil]
|
173
|
+
def post_raw_for_dataset(data_set_name, version, raw_request)
|
174
|
+
post_raw_for_dataset_with_http_info(data_set_name, version, raw_request)
|
175
|
+
return nil
|
176
|
+
end
|
177
|
+
|
178
|
+
# Provides a raw kusto query capability to internal Docusign services
|
179
|
+
#
|
180
|
+
# @param data_set_name The name of the dataset to query
|
181
|
+
# @param version The requested API version
|
182
|
+
# @param raw_request The request body DocuSign.API.Lens.Common.RawRequest (optional parameter)
|
183
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
184
|
+
def post_raw_for_dataset_with_http_info(data_set_name, version, raw_request)
|
185
|
+
if @api_client.config.debugging
|
186
|
+
@api_client.config.logger.debug "Calling API: DataSetApi.post_raw_for_dataset ..."
|
187
|
+
end
|
188
|
+
# verify the required parameter 'data_set_name' is set
|
189
|
+
fail ArgumentError, "Missing the required parameter 'data_set_name' when calling DataSetApi.post_raw_for_dataset" if data_set_name.nil?
|
190
|
+
# verify the required parameter 'version' is set
|
191
|
+
fail ArgumentError, "Missing the required parameter 'version' when calling DataSetApi.post_raw_for_dataset" if version.nil?
|
192
|
+
# resource path
|
193
|
+
local_var_path = "/api/v{version}/datasets/{dataSetName}/raw".sub('{format}','json').sub('{' + 'dataSetName' + '}', data_set_name.to_s).sub('{' + 'version' + '}', version.to_s)
|
194
|
+
|
195
|
+
# query parameters
|
196
|
+
query_params = {}
|
197
|
+
|
198
|
+
# header parameters
|
199
|
+
header_params = {}
|
200
|
+
# HTTP header 'Content-Type'
|
201
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
202
|
+
|
203
|
+
# form parameters
|
204
|
+
form_params = {}
|
205
|
+
|
206
|
+
# http body (model)
|
207
|
+
post_body = @api_client.object_to_http_body(raw_request)
|
208
|
+
auth_names = []
|
209
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
210
|
+
:header_params => header_params,
|
211
|
+
:query_params => query_params,
|
212
|
+
:form_params => form_params,
|
213
|
+
:body => post_body,
|
214
|
+
:auth_names => auth_names)
|
215
|
+
if @api_client.config.debugging
|
216
|
+
@api_client.config.logger.debug "API called: DataSetApi#post_raw_for_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
217
|
+
end
|
218
|
+
return data, status_code, headers
|
219
|
+
end
|
220
|
+
|
221
|
+
#
|
222
|
+
#
|
223
|
+
# @param data_set_name
|
224
|
+
# @param version The requested API version
|
225
|
+
# @param web_query (optional parameter)
|
226
|
+
# @return [nil]
|
227
|
+
def post_web_query_for_dataset(data_set_name, version, web_query)
|
228
|
+
post_web_query_for_dataset_with_http_info(data_set_name, version, web_query)
|
229
|
+
return nil
|
230
|
+
end
|
231
|
+
|
232
|
+
#
|
233
|
+
#
|
234
|
+
# @param data_set_name
|
235
|
+
# @param version The requested API version
|
236
|
+
# @param web_query (optional parameter)
|
237
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
238
|
+
def post_web_query_for_dataset_with_http_info(data_set_name, version, web_query)
|
239
|
+
if @api_client.config.debugging
|
240
|
+
@api_client.config.logger.debug "Calling API: DataSetApi.post_web_query_for_dataset ..."
|
241
|
+
end
|
242
|
+
# verify the required parameter 'data_set_name' is set
|
243
|
+
fail ArgumentError, "Missing the required parameter 'data_set_name' when calling DataSetApi.post_web_query_for_dataset" if data_set_name.nil?
|
244
|
+
# verify the required parameter 'version' is set
|
245
|
+
fail ArgumentError, "Missing the required parameter 'version' when calling DataSetApi.post_web_query_for_dataset" if version.nil?
|
246
|
+
# resource path
|
247
|
+
local_var_path = "/api/v{version}/datasets/{dataSetName}/web_query".sub('{format}','json').sub('{' + 'dataSetName' + '}', data_set_name.to_s).sub('{' + 'version' + '}', version.to_s)
|
248
|
+
|
249
|
+
# query parameters
|
250
|
+
query_params = {}
|
251
|
+
|
252
|
+
# header parameters
|
253
|
+
header_params = {}
|
254
|
+
# HTTP header 'Content-Type'
|
255
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])
|
256
|
+
|
257
|
+
# form parameters
|
258
|
+
form_params = {}
|
259
|
+
|
260
|
+
# http body (model)
|
261
|
+
post_body = @api_client.object_to_http_body(web_query)
|
262
|
+
auth_names = []
|
263
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
264
|
+
:header_params => header_params,
|
265
|
+
:query_params => query_params,
|
266
|
+
:form_params => form_params,
|
267
|
+
:body => post_body,
|
268
|
+
:auth_names => auth_names)
|
269
|
+
if @api_client.config.debugging
|
270
|
+
@api_client.config.logger.debug "API called: DataSetApi#post_web_query_for_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
271
|
+
end
|
272
|
+
return data, status_code, headers
|
273
|
+
end
|
274
|
+
end
|
275
|
+
end
|