blueprint_ruby_client 0.4.1 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +65 -0
- data/LICENSE +201 -0
- data/README.md +25 -11
- data/docs/AssetTypeConfigsApi.md +63 -0
- data/docs/AssetTypeTemplatesApi.md +179 -0
- data/docs/AssetsApi.md +19 -19
- data/docs/HierarchyApi.md +35 -35
- data/docs/Integration.md +10 -0
- data/docs/IntegrationBody.md +9 -0
- data/docs/IntegrationTransform.md +11 -0
- data/docs/IntegrationTransformExample.md +9 -0
- data/docs/IntegrationsApi.md +329 -0
- data/docs/LTIApi.md +98 -0
- data/docs/Lti1IntegrationAttributes.md +11 -0
- data/docs/NodeAttributes.md +2 -0
- data/docs/SecurityApi.md +48 -0
- data/docs/Template.md +10 -0
- data/docs/TemplateAttributes.md +9 -0
- data/docs/TemplateBody.md +9 -0
- data/docs/{AssetAttributes.md → TemplateVariables.md} +3 -2
- data/generate.sh +1 -2
- data/git_push.sh +16 -1
- data/lib/blueprint_ruby_client/api/asset_type_configs_api.rb +84 -0
- data/lib/blueprint_ruby_client/api/asset_type_templates_api.rb +214 -0
- data/lib/blueprint_ruby_client/api/assets_api.rb +23 -191
- data/lib/blueprint_ruby_client/api/hierarchy_api.rb +49 -409
- data/lib/blueprint_ruby_client/api/integrations_api.rb +415 -0
- data/lib/blueprint_ruby_client/api/lti_api.rb +156 -0
- data/lib/blueprint_ruby_client/api/security_api.rb +75 -0
- data/lib/blueprint_ruby_client/api_client.rb +0 -2
- data/lib/blueprint_ruby_client/models/asset.rb +2 -59
- data/lib/blueprint_ruby_client/models/asset_body.rb +2 -42
- data/lib/blueprint_ruby_client/models/asset_relationship.rb +2 -57
- data/lib/blueprint_ruby_client/models/asset_result_set.rb +2 -57
- data/lib/blueprint_ruby_client/models/error.rb +2 -59
- data/lib/blueprint_ruby_client/models/errors.rb +2 -25
- data/lib/blueprint_ruby_client/models/integration.rb +225 -0
- data/lib/blueprint_ruby_client/models/{mixed_resource_result_set.rb → integration_body.rb} +27 -12
- data/lib/blueprint_ruby_client/models/integration_transform.rb +221 -0
- data/lib/blueprint_ruby_client/models/integration_transform_example.rb +197 -0
- data/lib/blueprint_ruby_client/models/links.rb +2 -57
- data/lib/blueprint_ruby_client/models/lti1_integration_attributes.rb +225 -0
- data/lib/blueprint_ruby_client/models/meta.rb +2 -57
- data/lib/blueprint_ruby_client/models/namespace.rb +2 -43
- data/lib/blueprint_ruby_client/models/namespace_relationship.rb +2 -25
- data/lib/blueprint_ruby_client/models/node.rb +2 -75
- data/lib/blueprint_ruby_client/models/node_attributes.rb +26 -109
- data/lib/blueprint_ruby_client/models/node_body.rb +2 -42
- data/lib/blueprint_ruby_client/models/node_relationship.rb +2 -57
- data/lib/blueprint_ruby_client/models/node_relationships.rb +2 -73
- data/lib/blueprint_ruby_client/models/node_result_set.rb +2 -57
- data/lib/blueprint_ruby_client/models/resource.rb +2 -59
- data/lib/blueprint_ruby_client/models/template.rb +215 -0
- data/lib/blueprint_ruby_client/models/template_attributes.rb +217 -0
- data/lib/blueprint_ruby_client/models/{asset_attributes.rb → template_body.rb} +23 -33
- data/lib/blueprint_ruby_client/models/template_variables.rb +237 -0
- data/lib/blueprint_ruby_client/version.rb +1 -1
- data/lib/blueprint_ruby_client.rb +14 -0
- data/spec/api/asset_type_configs_api_spec.rb +52 -0
- data/spec/api/asset_type_templates_api_spec.rb +88 -0
- data/spec/api/assets_api_spec.rb +9 -9
- data/spec/api/hierarchy_api_spec.rb +17 -17
- data/spec/api/integrations_api_spec.rb +141 -0
- data/spec/api/lti_api_spec.rb +69 -0
- data/spec/api/security_api_spec.rb +50 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/integration_body_spec.rb +56 -0
- data/spec/models/integration_spec.rb +66 -0
- data/spec/models/integration_transform_example_spec.rb +56 -0
- data/spec/models/integration_transform_spec.rb +76 -0
- data/spec/models/lti1_integration_attributes_spec.rb +76 -0
- data/spec/models/node_attributes_spec.rb +20 -0
- data/spec/models/template_attributes_spec.rb +56 -0
- data/spec/models/{asset_attributes_spec.rb → template_body_spec.rb} +17 -7
- data/spec/models/template_spec.rb +66 -0
- data/spec/models/template_variables_spec.rb +56 -0
- data/spec/spec_helper.rb +111 -0
- data/swagger-codegen-cli.jar +0 -0
- data/templates/model.mustache +5 -5
- metadata +67 -12
- data/docs/MixedResourceResultSet.md +0 -7
- data/spec/models/mixed_resource_result_set_spec.rb +0 -36
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4ae5f091fb9a5ecdf9025c1b761a123e91fef1c6
|
4
|
+
data.tar.gz: 5c8b669e3f6dc2c4feec20fd9aea773ca26ea285
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 27b49ca3eee85cb6d58c67d1224689be0de592e491f09c051935f6317d86ec3b3aab36661bf9840d0909fbb99278985582c6d932dbe785e5984f4d51b6227049
|
7
|
+
data.tar.gz: 050d6686492b18c46ce5ec77d9c8032f07af09850b547893561c58641724e363f57703b7da20324550d54e7b1e5f4cb4a2bda71240da3a32087abf22a3fbba14
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
blueprint_ruby_client (0.4.1)
|
5
|
+
json (~> 1.8, >= 1.8.3)
|
6
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
ZenTest (4.11.1)
|
12
|
+
addressable (2.4.0)
|
13
|
+
autotest (4.4.6)
|
14
|
+
ZenTest (>= 4.4.1)
|
15
|
+
autotest-fsevent (0.2.12)
|
16
|
+
sys-uname
|
17
|
+
autotest-growl (0.2.16)
|
18
|
+
autotest-rails-pure (4.1.2)
|
19
|
+
crack (0.4.3)
|
20
|
+
safe_yaml (~> 1.0.0)
|
21
|
+
diff-lcs (1.2.5)
|
22
|
+
ethon (0.9.1)
|
23
|
+
ffi (>= 1.3.0)
|
24
|
+
ffi (1.9.14)
|
25
|
+
hashdiff (0.3.0)
|
26
|
+
json (1.8.3)
|
27
|
+
rspec (3.5.0)
|
28
|
+
rspec-core (~> 3.5.0)
|
29
|
+
rspec-expectations (~> 3.5.0)
|
30
|
+
rspec-mocks (~> 3.5.0)
|
31
|
+
rspec-core (3.5.4)
|
32
|
+
rspec-support (~> 3.5.0)
|
33
|
+
rspec-expectations (3.5.0)
|
34
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
35
|
+
rspec-support (~> 3.5.0)
|
36
|
+
rspec-mocks (3.5.0)
|
37
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
38
|
+
rspec-support (~> 3.5.0)
|
39
|
+
rspec-support (3.5.0)
|
40
|
+
safe_yaml (1.0.4)
|
41
|
+
sys-uname (1.0.2)
|
42
|
+
ffi (>= 1.0.0)
|
43
|
+
typhoeus (1.1.0)
|
44
|
+
ethon (>= 0.9.0)
|
45
|
+
vcr (3.0.3)
|
46
|
+
webmock (1.24.6)
|
47
|
+
addressable (>= 2.3.6)
|
48
|
+
crack (>= 0.3.2)
|
49
|
+
hashdiff
|
50
|
+
|
51
|
+
PLATFORMS
|
52
|
+
ruby
|
53
|
+
|
54
|
+
DEPENDENCIES
|
55
|
+
autotest (~> 4.4, >= 4.4.6)
|
56
|
+
autotest-fsevent (~> 0.2, >= 0.2.11)
|
57
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
58
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
59
|
+
blueprint_ruby_client!
|
60
|
+
rspec (~> 3.4, >= 3.4.0)
|
61
|
+
vcr (~> 3.0, >= 3.0.1)
|
62
|
+
webmock (~> 1.24, >= 1.24.3)
|
63
|
+
|
64
|
+
BUNDLED WITH
|
65
|
+
1.13.6
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
CHANGED
@@ -8,7 +8,7 @@ This SDK is automatically generated by the [Swagger Codegen](https://github.com/
|
|
8
8
|
|
9
9
|
- API version: 1.0.0
|
10
10
|
- Package version: 0.4.1
|
11
|
-
- Build date: 2016-
|
11
|
+
- Build date: 2016-10-27T15:57:57.768-04:00
|
12
12
|
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
13
13
|
|
14
14
|
## Installation
|
@@ -71,24 +71,18 @@ BlueprintClient.configure do |config|
|
|
71
71
|
config.access_token = 'YOUR ACCESS TOKEN'
|
72
72
|
end
|
73
73
|
|
74
|
-
api_instance = BlueprintClient::
|
74
|
+
api_instance = BlueprintClient::AssetTypeConfigsApi.new
|
75
75
|
|
76
76
|
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
77
77
|
|
78
|
-
|
79
|
-
|
80
|
-
id = "id_example" # String | id identifying a domain model
|
81
|
-
|
82
|
-
asset_type = "asset_type_example" # String | Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals
|
83
|
-
|
84
|
-
asset_id = "asset_id_example" # String | id of an asset
|
78
|
+
asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
85
79
|
|
86
80
|
|
87
81
|
begin
|
88
|
-
result = api_instance.
|
82
|
+
result = api_instance.get(namespace, asset_type, )
|
89
83
|
p result
|
90
84
|
rescue BlueprintClient::ApiError => e
|
91
|
-
puts "Exception when calling
|
85
|
+
puts "Exception when calling AssetTypeConfigsApi->get: #{e}"
|
92
86
|
end
|
93
87
|
|
94
88
|
```
|
@@ -99,6 +93,10 @@ All URIs are relative to *http://localhost:10010/1*
|
|
99
93
|
|
100
94
|
Class | Method | HTTP request | Description
|
101
95
|
------------ | ------------- | ------------- | -------------
|
96
|
+
*BlueprintClient::AssetTypeConfigsApi* | [**get**](docs/AssetTypeConfigsApi.md#get) | **GET** /{namespace}/assets/{assetType}/templates |
|
97
|
+
*BlueprintClient::AssetTypeTemplatesApi* | [**add**](docs/AssetTypeTemplatesApi.md#add) | **POST** /{namespace}/assets/{assetType}/templates |
|
98
|
+
*BlueprintClient::AssetTypeTemplatesApi* | [**delete**](docs/AssetTypeTemplatesApi.md#delete) | **DELETE** /{namespace}/assets/{assetType}/templates |
|
99
|
+
*BlueprintClient::AssetTypeTemplatesApi* | [**put**](docs/AssetTypeTemplatesApi.md#put) | **PUT** /{namespace}/assets/{assetType}/templates |
|
102
100
|
*BlueprintClient::AssetsApi* | [**add_asset_to_node**](docs/AssetsApi.md#add_asset_to_node) | **PUT** /{namespace}/nodes/{type}/{id}/assets/{assetType}/{assetId} |
|
103
101
|
*BlueprintClient::AssetsApi* | [**delete_asset**](docs/AssetsApi.md#delete_asset) | **DELETE** /{namespace}/assets/{assetType}/{assetId} |
|
104
102
|
*BlueprintClient::AssetsApi* | [**get_asset**](docs/AssetsApi.md#get_asset) | **GET** /{namespace}/assets/{assetType}/{assetId} |
|
@@ -117,6 +115,13 @@ Class | Method | HTTP request | Description
|
|
117
115
|
*BlueprintClient::HierarchyApi* | [**replace_node**](docs/HierarchyApi.md#replace_node) | **PUT** /{namespace}/nodes/{type}/{id} |
|
118
116
|
*BlueprintClient::HierarchyApi* | [**search_nodes**](docs/HierarchyApi.md#search_nodes) | **GET** /{namespaceIncGlobal}/nodes | Search nodes
|
119
117
|
*BlueprintClient::HierarchyApi* | [**update_node**](docs/HierarchyApi.md#update_node) | **PATCH** /{namespace}/nodes/{type}/{id} |
|
118
|
+
*BlueprintClient::IntegrationsApi* | [**add_integration**](docs/IntegrationsApi.md#add_integration) | **POST** /{namespace}/integrations |
|
119
|
+
*BlueprintClient::IntegrationsApi* | [**delete_integration**](docs/IntegrationsApi.md#delete_integration) | **DELETE** /{namespace}/integrations/{integrationType}/{integrationId} |
|
120
|
+
*BlueprintClient::IntegrationsApi* | [**get_integration**](docs/IntegrationsApi.md#get_integration) | **GET** /{namespace}/integrations/{integrationType}/{integrationId} |
|
121
|
+
*BlueprintClient::IntegrationsApi* | [**namespace_integrations_lti1_integration_id_assets_asset_type_asset_id_post**](docs/IntegrationsApi.md#namespace_integrations_lti1_integration_id_assets_asset_type_asset_id_post) | **POST** /{namespace}/integrations/lti1/{integrationId}/assets/{assetType}/{assetId} |
|
122
|
+
*BlueprintClient::IntegrationsApi* | [**replace_integration**](docs/IntegrationsApi.md#replace_integration) | **PUT** /{namespace}/integrations/{integrationType}/{integrationId} |
|
123
|
+
*BlueprintClient::LTIApi* | [**namespace_integrations_lti1_integration_id_assets_asset_type_asset_id_post**](docs/LTIApi.md#namespace_integrations_lti1_integration_id_assets_asset_type_asset_id_post) | **POST** /{namespace}/integrations/lti1/{integrationId}/assets/{assetType}/{assetId} |
|
124
|
+
*BlueprintClient::SecurityApi* | [**get_public_certificate**](docs/SecurityApi.md#get_public_certificate) | **GET** /keys/public |
|
120
125
|
|
121
126
|
|
122
127
|
## Documentation for Models
|
@@ -127,7 +132,12 @@ Class | Method | HTTP request | Description
|
|
127
132
|
- [BlueprintClient::AssetResultSet](docs/AssetResultSet.md)
|
128
133
|
- [BlueprintClient::Error](docs/Error.md)
|
129
134
|
- [BlueprintClient::Errors](docs/Errors.md)
|
135
|
+
- [BlueprintClient::Integration](docs/Integration.md)
|
136
|
+
- [BlueprintClient::IntegrationBody](docs/IntegrationBody.md)
|
137
|
+
- [BlueprintClient::IntegrationTransform](docs/IntegrationTransform.md)
|
138
|
+
- [BlueprintClient::IntegrationTransformExample](docs/IntegrationTransformExample.md)
|
130
139
|
- [BlueprintClient::Links](docs/Links.md)
|
140
|
+
- [BlueprintClient::Lti1IntegrationAttributes](docs/Lti1IntegrationAttributes.md)
|
131
141
|
- [BlueprintClient::Meta](docs/Meta.md)
|
132
142
|
- [BlueprintClient::Namespace](docs/Namespace.md)
|
133
143
|
- [BlueprintClient::NamespaceRelationship](docs/NamespaceRelationship.md)
|
@@ -138,6 +148,10 @@ Class | Method | HTTP request | Description
|
|
138
148
|
- [BlueprintClient::NodeRelationships](docs/NodeRelationships.md)
|
139
149
|
- [BlueprintClient::NodeResultSet](docs/NodeResultSet.md)
|
140
150
|
- [BlueprintClient::Resource](docs/Resource.md)
|
151
|
+
- [BlueprintClient::Template](docs/Template.md)
|
152
|
+
- [BlueprintClient::TemplateAttributes](docs/TemplateAttributes.md)
|
153
|
+
- [BlueprintClient::TemplateBody](docs/TemplateBody.md)
|
154
|
+
- [BlueprintClient::TemplateVariables](docs/TemplateVariables.md)
|
141
155
|
|
142
156
|
|
143
157
|
## Documentation for Authorization
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# BlueprintClient::AssetTypeConfigsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost:10010/1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get**](AssetTypeConfigsApi.md#get) | **GET** /{namespace}/assets/{assetType}/templates |
|
8
|
+
|
9
|
+
|
10
|
+
# **get**
|
11
|
+
> TemplateBody get(namespace, asset_type, )
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
get a template for a given asset type
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'blueprint_ruby_client'
|
21
|
+
# setup authorization
|
22
|
+
BlueprintClient.configure do |config|
|
23
|
+
# Configure OAuth2 access token for authorization: oauth2
|
24
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
25
|
+
end
|
26
|
+
|
27
|
+
api_instance = BlueprintClient::AssetTypeConfigsApi.new
|
28
|
+
|
29
|
+
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
30
|
+
|
31
|
+
asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
32
|
+
|
33
|
+
|
34
|
+
begin
|
35
|
+
result = api_instance.get(namespace, asset_type, )
|
36
|
+
p result
|
37
|
+
rescue BlueprintClient::ApiError => e
|
38
|
+
puts "Exception when calling AssetTypeConfigsApi->get: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
### Parameters
|
43
|
+
|
44
|
+
Name | Type | Description | Notes
|
45
|
+
------------- | ------------- | ------------- | -------------
|
46
|
+
**namespace** | **String**| identifier namespacing the blueprint. |
|
47
|
+
**asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**TemplateBody**](TemplateBody.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
[oauth2](../README.md#oauth2)
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: application/json
|
60
|
+
- **Accept**: application/vnd.api+json
|
61
|
+
|
62
|
+
|
63
|
+
|
@@ -0,0 +1,179 @@
|
|
1
|
+
# BlueprintClient::AssetTypeTemplatesApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost:10010/1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add**](AssetTypeTemplatesApi.md#add) | **POST** /{namespace}/assets/{assetType}/templates |
|
8
|
+
[**delete**](AssetTypeTemplatesApi.md#delete) | **DELETE** /{namespace}/assets/{assetType}/templates |
|
9
|
+
[**put**](AssetTypeTemplatesApi.md#put) | **PUT** /{namespace}/assets/{assetType}/templates |
|
10
|
+
|
11
|
+
|
12
|
+
# **add**
|
13
|
+
> TemplateBody add(namespace, asset_type, template_body)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
Configure a template for a given asset type
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'blueprint_ruby_client'
|
23
|
+
# setup authorization
|
24
|
+
BlueprintClient.configure do |config|
|
25
|
+
# Configure OAuth2 access token for authorization: oauth2
|
26
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = BlueprintClient::AssetTypeTemplatesApi.new
|
30
|
+
|
31
|
+
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
32
|
+
|
33
|
+
asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
34
|
+
|
35
|
+
template_body = BlueprintClient::TemplateBody.new # TemplateBody | template body
|
36
|
+
|
37
|
+
|
38
|
+
begin
|
39
|
+
result = api_instance.add(namespace, asset_type, template_body)
|
40
|
+
p result
|
41
|
+
rescue BlueprintClient::ApiError => e
|
42
|
+
puts "Exception when calling AssetTypeTemplatesApi->add: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
### Parameters
|
47
|
+
|
48
|
+
Name | Type | Description | Notes
|
49
|
+
------------- | ------------- | ------------- | -------------
|
50
|
+
**namespace** | **String**| identifier namespacing the blueprint. |
|
51
|
+
**asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
|
52
|
+
**template_body** | [**TemplateBody**](TemplateBody.md)| template body |
|
53
|
+
|
54
|
+
### Return type
|
55
|
+
|
56
|
+
[**TemplateBody**](TemplateBody.md)
|
57
|
+
|
58
|
+
### Authorization
|
59
|
+
|
60
|
+
[oauth2](../README.md#oauth2)
|
61
|
+
|
62
|
+
### HTTP request headers
|
63
|
+
|
64
|
+
- **Content-Type**: application/json
|
65
|
+
- **Accept**: application/vnd.api+json
|
66
|
+
|
67
|
+
|
68
|
+
|
69
|
+
# **delete**
|
70
|
+
> TemplateBody delete(namespace, asset_type, )
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
Delete a template for a given asset type
|
75
|
+
|
76
|
+
### Example
|
77
|
+
```ruby
|
78
|
+
# load the gem
|
79
|
+
require 'blueprint_ruby_client'
|
80
|
+
# setup authorization
|
81
|
+
BlueprintClient.configure do |config|
|
82
|
+
# Configure OAuth2 access token for authorization: oauth2
|
83
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
84
|
+
end
|
85
|
+
|
86
|
+
api_instance = BlueprintClient::AssetTypeTemplatesApi.new
|
87
|
+
|
88
|
+
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
89
|
+
|
90
|
+
asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
91
|
+
|
92
|
+
|
93
|
+
begin
|
94
|
+
result = api_instance.delete(namespace, asset_type, )
|
95
|
+
p result
|
96
|
+
rescue BlueprintClient::ApiError => e
|
97
|
+
puts "Exception when calling AssetTypeTemplatesApi->delete: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
Name | Type | Description | Notes
|
104
|
+
------------- | ------------- | ------------- | -------------
|
105
|
+
**namespace** | **String**| identifier namespacing the blueprint. |
|
106
|
+
**asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
|
107
|
+
|
108
|
+
### Return type
|
109
|
+
|
110
|
+
[**TemplateBody**](TemplateBody.md)
|
111
|
+
|
112
|
+
### Authorization
|
113
|
+
|
114
|
+
[oauth2](../README.md#oauth2)
|
115
|
+
|
116
|
+
### HTTP request headers
|
117
|
+
|
118
|
+
- **Content-Type**: application/json
|
119
|
+
- **Accept**: application/vnd.api+json
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
# **put**
|
124
|
+
> TemplateBody put(namespace, asset_type, template_body)
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
update a template for a given asset type
|
129
|
+
|
130
|
+
### Example
|
131
|
+
```ruby
|
132
|
+
# load the gem
|
133
|
+
require 'blueprint_ruby_client'
|
134
|
+
# setup authorization
|
135
|
+
BlueprintClient.configure do |config|
|
136
|
+
# Configure OAuth2 access token for authorization: oauth2
|
137
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
138
|
+
end
|
139
|
+
|
140
|
+
api_instance = BlueprintClient::AssetTypeTemplatesApi.new
|
141
|
+
|
142
|
+
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
143
|
+
|
144
|
+
asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
145
|
+
|
146
|
+
template_body = BlueprintClient::TemplateBody.new # TemplateBody | template body
|
147
|
+
|
148
|
+
|
149
|
+
begin
|
150
|
+
result = api_instance.put(namespace, asset_type, template_body)
|
151
|
+
p result
|
152
|
+
rescue BlueprintClient::ApiError => e
|
153
|
+
puts "Exception when calling AssetTypeTemplatesApi->put: #{e}"
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
### Parameters
|
158
|
+
|
159
|
+
Name | Type | Description | Notes
|
160
|
+
------------- | ------------- | ------------- | -------------
|
161
|
+
**namespace** | **String**| identifier namespacing the blueprint. |
|
162
|
+
**asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
|
163
|
+
**template_body** | [**TemplateBody**](TemplateBody.md)| template body |
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
[**TemplateBody**](TemplateBody.md)
|
168
|
+
|
169
|
+
### Authorization
|
170
|
+
|
171
|
+
[oauth2](../README.md#oauth2)
|
172
|
+
|
173
|
+
### HTTP request headers
|
174
|
+
|
175
|
+
- **Content-Type**: application/json
|
176
|
+
- **Accept**: application/vnd.api+json
|
177
|
+
|
178
|
+
|
179
|
+
|