metatron_ruby_client 0.0.1 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +28 -28
- data/config.json +1 -1
- data/docs/Asset.md +1 -1
- data/docs/AssetResultSet.md +1 -1
- data/docs/DefaultApi.md +159 -145
- data/docs/WorkAttributes.md +3 -1
- data/lib/metatron_ruby_client.rb +8 -3
- data/lib/metatron_ruby_client/api/default_api.rb +439 -241
- data/lib/metatron_ruby_client/api_client.rb +6 -2
- data/lib/metatron_ruby_client/api_error.rb +4 -2
- data/lib/metatron_ruby_client/configuration.rb +3 -3
- data/lib/metatron_ruby_client/models/asset.rb +45 -3
- data/lib/metatron_ruby_client/models/asset_data.rb +61 -2
- data/lib/metatron_ruby_client/models/asset_meta.rb +23 -0
- data/lib/metatron_ruby_client/models/asset_result_set.rb +60 -3
- data/lib/metatron_ruby_client/models/error.rb +61 -2
- data/lib/metatron_ruby_client/models/errors.rb +27 -2
- data/lib/metatron_ruby_client/models/item.rb +40 -0
- data/lib/metatron_ruby_client/models/item_data.rb +28 -2
- data/lib/metatron_ruby_client/models/item_result_set.rb +60 -2
- data/lib/metatron_ruby_client/models/links.rb +60 -2
- data/lib/metatron_ruby_client/models/manifestation.rb +40 -0
- data/lib/metatron_ruby_client/models/manifestation_attributes.rb +75 -2
- data/lib/metatron_ruby_client/models/manifestation_data.rb +78 -2
- data/lib/metatron_ruby_client/models/manifestation_relationships.rb +59 -2
- data/lib/metatron_ruby_client/models/manifestation_result_set.rb +62 -2
- data/lib/metatron_ruby_client/models/one_to_many_relationship.rb +60 -2
- data/lib/metatron_ruby_client/models/one_to_one_relationship.rb +60 -2
- data/lib/metatron_ruby_client/models/resource_data.rb +78 -2
- data/lib/metatron_ruby_client/models/resource_link.rb +45 -2
- data/lib/metatron_ruby_client/models/result_set_meta.rb +59 -2
- data/lib/metatron_ruby_client/models/work.rb +40 -0
- data/lib/metatron_ruby_client/models/work_attributes.rb +90 -10
- data/lib/metatron_ruby_client/models/work_data.rb +78 -2
- data/lib/metatron_ruby_client/models/work_relationships.rb +27 -2
- data/lib/metatron_ruby_client/models/work_result_set.rb +75 -2
- data/lib/metatron_ruby_client/version.rb +5 -3
- data/metatron_ruby_client-0.0.1.gem +0 -0
- data/spec/api/default_api_spec.rb +11 -0
- data/spec/models/work_attributes_spec.rb +21 -1
- data/stub-service/.idea/.name +1 -0
- data/stub-service/.idea/encodings.xml +5 -0
- data/stub-service/.idea/metatron-dummy-server.iml +11 -0
- data/stub-service/.idea/misc.xml +5 -0
- data/stub-service/.idea/modules.xml +9 -0
- data/stub-service/.idea/scopes/scope_settings.xml +5 -0
- data/stub-service/.idea/vcs.xml +7 -0
- data/stub-service/.idea/workspace.xml +534 -0
- metadata +32 -24
- data/swagger-codegen-cli.jar +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8198948a7f1e4e3fba6e7209a9239ef5510dacbd
|
4
|
+
data.tar.gz: ccab85273cd172eb3eaf475b3e255851e7ec02d3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4a149717d110fc127bf3519f2b8ad23f4733e00a6001fa1f9fe1892fbf118ea64239e7009046310f29e3d25d77dcf0929bb628713444b70409996082619f173f
|
7
|
+
data.tar.gz: 1e62a1b10148d6a54f33f2eda6f80f00316ca45c19a8adba634a886ccac5665dfdb0ad320deb12b53ae2db57c571a91c447b0e60b524e898351cc42cf288371d
|
data/README.md
CHANGED
@@ -6,9 +6,9 @@ A primitive modelling bibliographic metadata
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
|
-
- API version:
|
9
|
+
- API version: 2.0.0
|
10
10
|
- Package version: 0.0.1
|
11
|
-
- Build date: 2016-
|
11
|
+
- Build date: 2016-08-23T13:47:51.030-04:00
|
12
12
|
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
13
13
|
|
14
14
|
## Installation
|
@@ -65,51 +65,54 @@ end
|
|
65
65
|
|
66
66
|
api_instance = MetatronClient::DefaultApi.new
|
67
67
|
|
68
|
-
|
68
|
+
authorization = "authorization_example" # String | Bearer token
|
69
69
|
|
70
|
-
|
70
|
+
manifestation_id = "manifestation_id_example" # String |
|
71
71
|
|
72
|
-
|
72
|
+
body = MetatronClient::Asset.new # Asset | node
|
73
73
|
|
74
74
|
|
75
75
|
begin
|
76
|
-
api_instance.
|
76
|
+
result = api_instance.add_manifestation_asset(authorization, manifestation_idbody)
|
77
|
+
p result
|
77
78
|
rescue MetatronClient::ApiError => e
|
78
|
-
puts "Exception when calling DefaultApi->
|
79
|
+
puts "Exception when calling DefaultApi->add_manifestation_asset: #{e}"
|
79
80
|
end
|
80
81
|
|
81
82
|
```
|
82
83
|
|
83
84
|
## Documentation for API Endpoints
|
84
85
|
|
85
|
-
All URIs are relative to *
|
86
|
+
All URIs are relative to *http://localhost:3000/2*
|
86
87
|
|
87
88
|
Class | Method | HTTP request | Description
|
88
89
|
------------ | ------------- | ------------- | -------------
|
89
|
-
*MetatronClient::DefaultApi* | [**
|
90
|
-
*MetatronClient::DefaultApi* | [**
|
91
|
-
*MetatronClient::DefaultApi* | [**
|
92
|
-
*MetatronClient::DefaultApi* | [**
|
93
|
-
*MetatronClient::DefaultApi* | [**
|
94
|
-
*MetatronClient::DefaultApi* | [**
|
95
|
-
*MetatronClient::DefaultApi* | [**
|
96
|
-
*MetatronClient::DefaultApi* | [**
|
97
|
-
*MetatronClient::DefaultApi* | [**
|
98
|
-
*MetatronClient::DefaultApi* | [**
|
99
|
-
*MetatronClient::DefaultApi* | [**
|
90
|
+
*MetatronClient::DefaultApi* | [**add_manifestation_asset**](docs/DefaultApi.md#add_manifestation_asset) | **POST** /manifestations/{manifestationId}/assets |
|
91
|
+
*MetatronClient::DefaultApi* | [**get_holdings**](docs/DefaultApi.md#get_holdings) | **GET** /manifestations/{manifestationId}/items/{tenantCode} | Get local holdings for a given manifestation
|
92
|
+
*MetatronClient::DefaultApi* | [**get_manifestation**](docs/DefaultApi.md#get_manifestation) | **GET** /manifestations/{manifestationId} | Get a specific Manifestation from the dataset
|
93
|
+
*MetatronClient::DefaultApi* | [**get_manifestation_assets**](docs/DefaultApi.md#get_manifestation_assets) | **GET** /manifestations/{manifestationId}/assets | Get a set of Assets that are associated with a specific Manifestation
|
94
|
+
*MetatronClient::DefaultApi* | [**get_manifestation_works**](docs/DefaultApi.md#get_manifestation_works) | **GET** /manifestations/{manifestationId}/works | Get a set of Works relating to a given Manifestation. Usually there will be one current work, but due to previous titles there might be more than one Work.
|
95
|
+
*MetatronClient::DefaultApi* | [**get_work**](docs/DefaultApi.md#get_work) | **GET** /works/{workId}/similar | Get a set of Works that are similar to a specific Work
|
96
|
+
*MetatronClient::DefaultApi* | [**get_work_assets**](docs/DefaultApi.md#get_work_assets) | **GET** /works/{workId}/assets | Get a set of Assets that are associated with a specific Work
|
97
|
+
*MetatronClient::DefaultApi* | [**get_work_manifestations**](docs/DefaultApi.md#get_work_manifestations) | **GET** /works/{workId}/manifestations | Get a set of Manifestations that encompass a specific Work
|
98
|
+
*MetatronClient::DefaultApi* | [**manifestation**](docs/DefaultApi.md#manifestation) | **GET** /manifestations |
|
99
|
+
*MetatronClient::DefaultApi* | [**remove_asset**](docs/DefaultApi.md#remove_asset) | **DELETE** /assets/{assetType}/{assetId} |
|
100
|
+
*MetatronClient::DefaultApi* | [**work**](docs/DefaultApi.md#work) | **GET** /works | Get the work best matching the given bibliographic data
|
100
101
|
|
101
102
|
|
102
103
|
## Documentation for Models
|
103
104
|
|
104
105
|
- [MetatronClient::Asset](docs/Asset.md)
|
105
106
|
- [MetatronClient::AssetData](docs/AssetData.md)
|
107
|
+
- [MetatronClient::AssetMeta](docs/AssetMeta.md)
|
106
108
|
- [MetatronClient::AssetResultSet](docs/AssetResultSet.md)
|
107
|
-
- [MetatronClient::AssetResultSetMeta](docs/AssetResultSetMeta.md)
|
108
109
|
- [MetatronClient::Error](docs/Error.md)
|
109
110
|
- [MetatronClient::Errors](docs/Errors.md)
|
111
|
+
- [MetatronClient::Item](docs/Item.md)
|
110
112
|
- [MetatronClient::ItemData](docs/ItemData.md)
|
111
113
|
- [MetatronClient::ItemResultSet](docs/ItemResultSet.md)
|
112
114
|
- [MetatronClient::Links](docs/Links.md)
|
115
|
+
- [MetatronClient::Manifestation](docs/Manifestation.md)
|
113
116
|
- [MetatronClient::ManifestationAttributes](docs/ManifestationAttributes.md)
|
114
117
|
- [MetatronClient::ManifestationData](docs/ManifestationData.md)
|
115
118
|
- [MetatronClient::ManifestationRelationships](docs/ManifestationRelationships.md)
|
@@ -119,6 +122,7 @@ Class | Method | HTTP request | Description
|
|
119
122
|
- [MetatronClient::ResourceData](docs/ResourceData.md)
|
120
123
|
- [MetatronClient::ResourceLink](docs/ResourceLink.md)
|
121
124
|
- [MetatronClient::ResultSetMeta](docs/ResultSetMeta.md)
|
125
|
+
- [MetatronClient::Work](docs/Work.md)
|
122
126
|
- [MetatronClient::WorkAttributes](docs/WorkAttributes.md)
|
123
127
|
- [MetatronClient::WorkData](docs/WorkData.md)
|
124
128
|
- [MetatronClient::WorkRelationships](docs/WorkRelationships.md)
|
@@ -128,13 +132,9 @@ Class | Method | HTTP request | Description
|
|
128
132
|
## Documentation for Authorization
|
129
133
|
|
130
134
|
|
131
|
-
###
|
135
|
+
### Authorizer
|
132
136
|
|
133
|
-
- **Type**:
|
134
|
-
- **
|
135
|
-
- **
|
136
|
-
- **Scopes**:
|
137
|
-
- su: Talis super user
|
138
|
-
- metatron:read: Read only access
|
139
|
-
- metatron:write: Write only access
|
137
|
+
- **Type**: API key
|
138
|
+
- **API key parameter name**: Authorization
|
139
|
+
- **Location**: HTTP header
|
140
140
|
|
data/config.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"gemName": "metatron_ruby_client",
|
3
3
|
"moduleName": "MetatronClient",
|
4
|
-
"gemVersion": "0.
|
4
|
+
"gemVersion": "0.1.1",
|
5
5
|
"gemLicense": "Copyright Talis Education Ltd",
|
6
6
|
"gemHomepage": "https://github.com/talis/metatron_rb",
|
7
7
|
"gemSummary": "A ruby API wrapper for Metatron",
|
data/docs/Asset.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**meta** | [**
|
6
|
+
**meta** | [**AssetMeta**](AssetMeta.md) | | [optional]
|
7
7
|
**data** | [**AssetData**](AssetData.md) | |
|
8
8
|
|
9
9
|
|
data/docs/AssetResultSet.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**links** | [**Links**](Links.md) | | [optional]
|
7
|
-
**meta** | [**
|
7
|
+
**meta** | [**AssetMeta**](AssetMeta.md) | | [optional]
|
8
8
|
**data** | [**Array<AssetData>**](AssetData.md) | | [optional]
|
9
9
|
|
10
10
|
|
data/docs/DefaultApi.md
CHANGED
@@ -1,27 +1,29 @@
|
|
1
1
|
# MetatronClient::DefaultApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *http://localhost:3000/2*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
8
|
-
[**
|
9
|
-
[**
|
10
|
-
[**
|
11
|
-
[**
|
12
|
-
[**
|
13
|
-
[**
|
14
|
-
[**
|
15
|
-
[**
|
16
|
-
[**
|
17
|
-
[**
|
7
|
+
[**add_manifestation_asset**](DefaultApi.md#add_manifestation_asset) | **POST** /manifestations/{manifestationId}/assets |
|
8
|
+
[**get_holdings**](DefaultApi.md#get_holdings) | **GET** /manifestations/{manifestationId}/items/{tenantCode} | Get local holdings for a given manifestation
|
9
|
+
[**get_manifestation**](DefaultApi.md#get_manifestation) | **GET** /manifestations/{manifestationId} | Get a specific Manifestation from the dataset
|
10
|
+
[**get_manifestation_assets**](DefaultApi.md#get_manifestation_assets) | **GET** /manifestations/{manifestationId}/assets | Get a set of Assets that are associated with a specific Manifestation
|
11
|
+
[**get_manifestation_works**](DefaultApi.md#get_manifestation_works) | **GET** /manifestations/{manifestationId}/works | Get a set of Works relating to a given Manifestation. Usually there will be one current work, but due to previous titles there might be more than one Work.
|
12
|
+
[**get_work**](DefaultApi.md#get_work) | **GET** /works/{workId}/similar | Get a set of Works that are similar to a specific Work
|
13
|
+
[**get_work_assets**](DefaultApi.md#get_work_assets) | **GET** /works/{workId}/assets | Get a set of Assets that are associated with a specific Work
|
14
|
+
[**get_work_manifestations**](DefaultApi.md#get_work_manifestations) | **GET** /works/{workId}/manifestations | Get a set of Manifestations that encompass a specific Work
|
15
|
+
[**manifestation**](DefaultApi.md#manifestation) | **GET** /manifestations |
|
16
|
+
[**remove_asset**](DefaultApi.md#remove_asset) | **DELETE** /assets/{assetType}/{assetId} |
|
17
|
+
[**work**](DefaultApi.md#work) | **GET** /works | Get the work best matching the given bibliographic data
|
18
18
|
|
19
19
|
|
20
|
-
# **
|
21
|
-
>
|
20
|
+
# **add_manifestation_asset**
|
21
|
+
> Asset add_manifestation_asset(authorization, manifestation_idbody)
|
22
22
|
|
23
23
|
|
24
24
|
|
25
|
+
Add an asset to the relevant manifestation
|
26
|
+
|
25
27
|
### Example
|
26
28
|
```ruby
|
27
29
|
# load the gem
|
@@ -36,17 +38,18 @@ end
|
|
36
38
|
|
37
39
|
api_instance = MetatronClient::DefaultApi.new
|
38
40
|
|
39
|
-
|
41
|
+
authorization = "authorization_example" # String | Bearer token
|
40
42
|
|
41
|
-
|
43
|
+
manifestation_id = "manifestation_id_example" # String |
|
42
44
|
|
43
|
-
|
45
|
+
body = MetatronClient::Asset.new # Asset | node
|
44
46
|
|
45
47
|
|
46
48
|
begin
|
47
|
-
api_instance.
|
49
|
+
result = api_instance.add_manifestation_asset(authorization, manifestation_idbody)
|
50
|
+
p result
|
48
51
|
rescue MetatronClient::ApiError => e
|
49
|
-
puts "Exception when calling DefaultApi->
|
52
|
+
puts "Exception when calling DefaultApi->add_manifestation_asset: #{e}"
|
50
53
|
end
|
51
54
|
```
|
52
55
|
|
@@ -54,13 +57,13 @@ end
|
|
54
57
|
|
55
58
|
Name | Type | Description | Notes
|
56
59
|
------------- | ------------- | ------------- | -------------
|
57
|
-
**
|
58
|
-
**
|
59
|
-
**
|
60
|
+
**authorization** | **String**| Bearer token |
|
61
|
+
**manifestation_id** | **String**| |
|
62
|
+
**body** | [**Asset**](Asset.md)| node |
|
60
63
|
|
61
64
|
### Return type
|
62
65
|
|
63
|
-
|
66
|
+
[**Asset**](Asset.md)
|
64
67
|
|
65
68
|
### Authorization
|
66
69
|
|
@@ -69,14 +72,14 @@ nil (empty response body)
|
|
69
72
|
### HTTP request headers
|
70
73
|
|
71
74
|
- **Content-Type**: application/json
|
72
|
-
- **Accept**: application/vnd.api+json
|
73
|
-
|
75
|
+
- **Accept**: application/vnd.api+json
|
74
76
|
|
75
77
|
|
76
|
-
# **2_manifestations_get**
|
77
|
-
> ManifestationResultSet 2_manifestations_get(authorization, opts)
|
78
78
|
|
79
|
+
# **get_holdings**
|
80
|
+
> ItemResultSet get_holdings(authorization, manifestation_idtenant_code)
|
79
81
|
|
82
|
+
Get local holdings for a given manifestation
|
80
83
|
|
81
84
|
### Example
|
82
85
|
```ruby
|
@@ -92,18 +95,19 @@ end
|
|
92
95
|
|
93
96
|
api_instance = MetatronClient::DefaultApi.new
|
94
97
|
|
95
|
-
authorization = "authorization_example" # String |
|
98
|
+
authorization = "authorization_example" # String | Bearer token
|
99
|
+
|
100
|
+
manifestation_id = "manifestation_id_example" # String |
|
101
|
+
|
102
|
+
tenant_code = "tenant_code_example" # String |
|
96
103
|
|
97
|
-
opts = {
|
98
|
-
work_id: "work_id_example", # String |
|
99
|
-
isbn: "isbn_example" # String |
|
100
|
-
}
|
101
104
|
|
102
105
|
begin
|
103
|
-
|
106
|
+
#Get local holdings for a given manifestation
|
107
|
+
result = api_instance.get_holdings(authorization, manifestation_idtenant_code)
|
104
108
|
p result
|
105
109
|
rescue MetatronClient::ApiError => e
|
106
|
-
puts "Exception when calling DefaultApi->
|
110
|
+
puts "Exception when calling DefaultApi->get_holdings: #{e}"
|
107
111
|
end
|
108
112
|
```
|
109
113
|
|
@@ -111,13 +115,13 @@ end
|
|
111
115
|
|
112
116
|
Name | Type | Description | Notes
|
113
117
|
------------- | ------------- | ------------- | -------------
|
114
|
-
**authorization** | **String**|
|
115
|
-
**
|
116
|
-
**
|
118
|
+
**authorization** | **String**| Bearer token |
|
119
|
+
**manifestation_id** | **String**| |
|
120
|
+
**tenant_code** | **String**| |
|
117
121
|
|
118
122
|
### Return type
|
119
123
|
|
120
|
-
[**
|
124
|
+
[**ItemResultSet**](ItemResultSet.md)
|
121
125
|
|
122
126
|
### Authorization
|
123
127
|
|
@@ -126,14 +130,14 @@ Name | Type | Description | Notes
|
|
126
130
|
### HTTP request headers
|
127
131
|
|
128
132
|
- **Content-Type**: application/json
|
129
|
-
- **Accept**: application/vnd.api+json
|
130
|
-
|
133
|
+
- **Accept**: application/vnd.api+json
|
131
134
|
|
132
135
|
|
133
|
-
# **2_manifestations_manifestation_id_assets_get**
|
134
|
-
> AssetResultSet 2_manifestations_manifestation_id_assets_get(manifestation_id, authorization)
|
135
136
|
|
137
|
+
# **get_manifestation**
|
138
|
+
> get_manifestation(authorization, manifestation_id)
|
136
139
|
|
140
|
+
Get a specific Manifestation from the dataset
|
137
141
|
|
138
142
|
### Example
|
139
143
|
```ruby
|
@@ -149,16 +153,16 @@ end
|
|
149
153
|
|
150
154
|
api_instance = MetatronClient::DefaultApi.new
|
151
155
|
|
152
|
-
|
156
|
+
authorization = "authorization_example" # String | Bearer token
|
153
157
|
|
154
|
-
|
158
|
+
manifestation_id = "manifestation_id_example" # String |
|
155
159
|
|
156
160
|
|
157
161
|
begin
|
158
|
-
|
159
|
-
|
162
|
+
#Get a specific Manifestation from the dataset
|
163
|
+
api_instance.get_manifestation(authorization, manifestation_id)
|
160
164
|
rescue MetatronClient::ApiError => e
|
161
|
-
puts "Exception when calling DefaultApi->
|
165
|
+
puts "Exception when calling DefaultApi->get_manifestation: #{e}"
|
162
166
|
end
|
163
167
|
```
|
164
168
|
|
@@ -166,12 +170,12 @@ end
|
|
166
170
|
|
167
171
|
Name | Type | Description | Notes
|
168
172
|
------------- | ------------- | ------------- | -------------
|
173
|
+
**authorization** | **String**| Bearer token |
|
169
174
|
**manifestation_id** | **String**| |
|
170
|
-
**authorization** | **String**| |
|
171
175
|
|
172
176
|
### Return type
|
173
177
|
|
174
|
-
|
178
|
+
nil (empty response body)
|
175
179
|
|
176
180
|
### Authorization
|
177
181
|
|
@@ -180,14 +184,14 @@ Name | Type | Description | Notes
|
|
180
184
|
### HTTP request headers
|
181
185
|
|
182
186
|
- **Content-Type**: application/json
|
183
|
-
- **Accept**: application/vnd.api+json
|
184
|
-
|
187
|
+
- **Accept**: application/vnd.api+json
|
185
188
|
|
186
189
|
|
187
|
-
# **2_manifestations_manifestation_id_assets_post**
|
188
|
-
> Asset 2_manifestations_manifestation_id_assets_post(manifestation_id, authorization, asset)
|
189
190
|
|
191
|
+
# **get_manifestation_assets**
|
192
|
+
> AssetResultSet get_manifestation_assets(authorization, manifestation_id)
|
190
193
|
|
194
|
+
Get a set of Assets that are associated with a specific Manifestation
|
191
195
|
|
192
196
|
### Example
|
193
197
|
```ruby
|
@@ -203,18 +207,17 @@ end
|
|
203
207
|
|
204
208
|
api_instance = MetatronClient::DefaultApi.new
|
205
209
|
|
206
|
-
|
207
|
-
|
208
|
-
authorization = "authorization_example" # String |
|
210
|
+
authorization = "authorization_example" # String | Bearer token
|
209
211
|
|
210
|
-
|
212
|
+
manifestation_id = "manifestation_id_example" # String |
|
211
213
|
|
212
214
|
|
213
215
|
begin
|
214
|
-
|
216
|
+
#Get a set of Assets that are associated with a specific Manifestation
|
217
|
+
result = api_instance.get_manifestation_assets(authorization, manifestation_id)
|
215
218
|
p result
|
216
219
|
rescue MetatronClient::ApiError => e
|
217
|
-
puts "Exception when calling DefaultApi->
|
220
|
+
puts "Exception when calling DefaultApi->get_manifestation_assets: #{e}"
|
218
221
|
end
|
219
222
|
```
|
220
223
|
|
@@ -222,13 +225,12 @@ end
|
|
222
225
|
|
223
226
|
Name | Type | Description | Notes
|
224
227
|
------------- | ------------- | ------------- | -------------
|
228
|
+
**authorization** | **String**| Bearer token |
|
225
229
|
**manifestation_id** | **String**| |
|
226
|
-
**authorization** | **String**| |
|
227
|
-
**asset** | [**Asset**](Asset.md)| |
|
228
230
|
|
229
231
|
### Return type
|
230
232
|
|
231
|
-
[**
|
233
|
+
[**AssetResultSet**](AssetResultSet.md)
|
232
234
|
|
233
235
|
### Authorization
|
234
236
|
|
@@ -236,15 +238,15 @@ Name | Type | Description | Notes
|
|
236
238
|
|
237
239
|
### HTTP request headers
|
238
240
|
|
239
|
-
- **Content-Type**: application/
|
240
|
-
- **Accept**: application/vnd.api+json
|
241
|
-
|
241
|
+
- **Content-Type**: application/json
|
242
|
+
- **Accept**: application/vnd.api+json
|
242
243
|
|
243
244
|
|
244
|
-
# **2_manifestations_manifestation_id_get**
|
245
|
-
> 2_manifestations_manifestation_id_get(manifestation_id, authorization)
|
246
245
|
|
246
|
+
# **get_manifestation_works**
|
247
|
+
> get_manifestation_works(authorization, manifestation_id)
|
247
248
|
|
249
|
+
Get a set of Works relating to a given Manifestation. Usually there will be one current work, but due to previous titles there might be more than one Work.
|
248
250
|
|
249
251
|
### Example
|
250
252
|
```ruby
|
@@ -260,15 +262,16 @@ end
|
|
260
262
|
|
261
263
|
api_instance = MetatronClient::DefaultApi.new
|
262
264
|
|
263
|
-
|
265
|
+
authorization = "authorization_example" # String | Bearer token
|
264
266
|
|
265
|
-
|
267
|
+
manifestation_id = "manifestation_id_example" # String |
|
266
268
|
|
267
269
|
|
268
270
|
begin
|
269
|
-
|
271
|
+
#Get a set of Works relating to a given Manifestation. Usually there will be one current work, but due to previous titles there might be more than one Work.
|
272
|
+
api_instance.get_manifestation_works(authorization, manifestation_id)
|
270
273
|
rescue MetatronClient::ApiError => e
|
271
|
-
puts "Exception when calling DefaultApi->
|
274
|
+
puts "Exception when calling DefaultApi->get_manifestation_works: #{e}"
|
272
275
|
end
|
273
276
|
```
|
274
277
|
|
@@ -276,8 +279,8 @@ end
|
|
276
279
|
|
277
280
|
Name | Type | Description | Notes
|
278
281
|
------------- | ------------- | ------------- | -------------
|
282
|
+
**authorization** | **String**| Bearer token |
|
279
283
|
**manifestation_id** | **String**| |
|
280
|
-
**authorization** | **String**| |
|
281
284
|
|
282
285
|
### Return type
|
283
286
|
|
@@ -294,10 +297,10 @@ nil (empty response body)
|
|
294
297
|
|
295
298
|
|
296
299
|
|
297
|
-
# **
|
298
|
-
>
|
299
|
-
|
300
|
+
# **get_work**
|
301
|
+
> WorkResultSet get_work(authorization, work_id)
|
300
302
|
|
303
|
+
Get a set of Works that are similar to a specific Work
|
301
304
|
|
302
305
|
### Example
|
303
306
|
```ruby
|
@@ -313,18 +316,17 @@ end
|
|
313
316
|
|
314
317
|
api_instance = MetatronClient::DefaultApi.new
|
315
318
|
|
316
|
-
|
317
|
-
|
318
|
-
authorization = "authorization_example" # String |
|
319
|
+
authorization = "authorization_example" # String | Bearer token
|
319
320
|
|
320
|
-
|
321
|
+
work_id = "work_id_example" # String |
|
321
322
|
|
322
323
|
|
323
324
|
begin
|
324
|
-
|
325
|
+
#Get a set of Works that are similar to a specific Work
|
326
|
+
result = api_instance.get_work(authorization, work_id)
|
325
327
|
p result
|
326
328
|
rescue MetatronClient::ApiError => e
|
327
|
-
puts "Exception when calling DefaultApi->
|
329
|
+
puts "Exception when calling DefaultApi->get_work: #{e}"
|
328
330
|
end
|
329
331
|
```
|
330
332
|
|
@@ -332,13 +334,12 @@ end
|
|
332
334
|
|
333
335
|
Name | Type | Description | Notes
|
334
336
|
------------- | ------------- | ------------- | -------------
|
335
|
-
**
|
336
|
-
**
|
337
|
-
**tenant_code** | **String**| |
|
337
|
+
**authorization** | **String**| Bearer token |
|
338
|
+
**work_id** | **String**| |
|
338
339
|
|
339
340
|
### Return type
|
340
341
|
|
341
|
-
[**
|
342
|
+
[**WorkResultSet**](WorkResultSet.md)
|
342
343
|
|
343
344
|
### Authorization
|
344
345
|
|
@@ -351,10 +352,10 @@ Name | Type | Description | Notes
|
|
351
352
|
|
352
353
|
|
353
354
|
|
354
|
-
# **
|
355
|
-
>
|
356
|
-
|
355
|
+
# **get_work_assets**
|
356
|
+
> AssetResultSet get_work_assets(authorization, work_id)
|
357
357
|
|
358
|
+
Get a set of Assets that are associated with a specific Work
|
358
359
|
|
359
360
|
### Example
|
360
361
|
```ruby
|
@@ -370,15 +371,17 @@ end
|
|
370
371
|
|
371
372
|
api_instance = MetatronClient::DefaultApi.new
|
372
373
|
|
373
|
-
|
374
|
+
authorization = "authorization_example" # String | Bearer token
|
374
375
|
|
375
|
-
|
376
|
+
work_id = "work_id_example" # String |
|
376
377
|
|
377
378
|
|
378
379
|
begin
|
379
|
-
|
380
|
+
#Get a set of Assets that are associated with a specific Work
|
381
|
+
result = api_instance.get_work_assets(authorization, work_id)
|
382
|
+
p result
|
380
383
|
rescue MetatronClient::ApiError => e
|
381
|
-
puts "Exception when calling DefaultApi->
|
384
|
+
puts "Exception when calling DefaultApi->get_work_assets: #{e}"
|
382
385
|
end
|
383
386
|
```
|
384
387
|
|
@@ -386,12 +389,12 @@ end
|
|
386
389
|
|
387
390
|
Name | Type | Description | Notes
|
388
391
|
------------- | ------------- | ------------- | -------------
|
389
|
-
**
|
390
|
-
**
|
392
|
+
**authorization** | **String**| Bearer token |
|
393
|
+
**work_id** | **String**| |
|
391
394
|
|
392
395
|
### Return type
|
393
396
|
|
394
|
-
|
397
|
+
[**AssetResultSet**](AssetResultSet.md)
|
395
398
|
|
396
399
|
### Authorization
|
397
400
|
|
@@ -404,10 +407,10 @@ nil (empty response body)
|
|
404
407
|
|
405
408
|
|
406
409
|
|
407
|
-
# **
|
408
|
-
>
|
409
|
-
|
410
|
+
# **get_work_manifestations**
|
411
|
+
> get_work_manifestations(authorization, work_id)
|
410
412
|
|
413
|
+
Get a set of Manifestations that encompass a specific Work
|
411
414
|
|
412
415
|
### Example
|
413
416
|
```ruby
|
@@ -423,23 +426,16 @@ end
|
|
423
426
|
|
424
427
|
api_instance = MetatronClient::DefaultApi.new
|
425
428
|
|
426
|
-
|
427
|
-
|
428
|
-
offset = "offset_example" # String |
|
429
|
-
|
430
|
-
q = "q_example" # String |
|
429
|
+
authorization = "authorization_example" # String | Bearer token
|
431
430
|
|
432
|
-
|
431
|
+
work_id = "work_id_example" # String |
|
433
432
|
|
434
|
-
opts = {
|
435
|
-
include: "include_example" # String |
|
436
|
-
}
|
437
433
|
|
438
434
|
begin
|
439
|
-
|
440
|
-
|
435
|
+
#Get a set of Manifestations that encompass a specific Work
|
436
|
+
api_instance.get_work_manifestations(authorization, work_id)
|
441
437
|
rescue MetatronClient::ApiError => e
|
442
|
-
puts "Exception when calling DefaultApi->
|
438
|
+
puts "Exception when calling DefaultApi->get_work_manifestations: #{e}"
|
443
439
|
end
|
444
440
|
```
|
445
441
|
|
@@ -447,15 +443,12 @@ end
|
|
447
443
|
|
448
444
|
Name | Type | Description | Notes
|
449
445
|
------------- | ------------- | ------------- | -------------
|
450
|
-
**
|
451
|
-
**
|
452
|
-
**q** | **String**| |
|
453
|
-
**authorization** | **String**| |
|
454
|
-
**include** | **String**| | [optional]
|
446
|
+
**authorization** | **String**| Bearer token |
|
447
|
+
**work_id** | **String**| |
|
455
448
|
|
456
449
|
### Return type
|
457
450
|
|
458
|
-
|
451
|
+
nil (empty response body)
|
459
452
|
|
460
453
|
### Authorization
|
461
454
|
|
@@ -464,14 +457,16 @@ Name | Type | Description | Notes
|
|
464
457
|
### HTTP request headers
|
465
458
|
|
466
459
|
- **Content-Type**: application/json
|
467
|
-
- **Accept**: application/vnd.api+json
|
460
|
+
- **Accept**: application/vnd.api+json
|
461
|
+
|
468
462
|
|
469
463
|
|
464
|
+
# **manifestation**
|
465
|
+
> ManifestationResultSet manifestation(authorization, , opts)
|
470
466
|
|
471
|
-
# **2_works_work_id_assets_get**
|
472
|
-
> AssetResultSet 2_works_work_id_assets_get(work_id, authorization)
|
473
467
|
|
474
468
|
|
469
|
+
Get the manifestation set best matching the given bibliographic data
|
475
470
|
|
476
471
|
### Example
|
477
472
|
```ruby
|
@@ -487,16 +482,18 @@ end
|
|
487
482
|
|
488
483
|
api_instance = MetatronClient::DefaultApi.new
|
489
484
|
|
490
|
-
|
491
|
-
|
492
|
-
authorization = "authorization_example" # String |
|
485
|
+
authorization = "authorization_example" # String | Bearer token
|
493
486
|
|
487
|
+
opts = {
|
488
|
+
isbn: "isbn_example", # String | The isbn
|
489
|
+
work_id: "work_id_example" # String | The ID of a work
|
490
|
+
}
|
494
491
|
|
495
492
|
begin
|
496
|
-
result = api_instance.
|
493
|
+
result = api_instance.manifestation(authorization, , opts)
|
497
494
|
p result
|
498
495
|
rescue MetatronClient::ApiError => e
|
499
|
-
puts "Exception when calling DefaultApi->
|
496
|
+
puts "Exception when calling DefaultApi->manifestation: #{e}"
|
500
497
|
end
|
501
498
|
```
|
502
499
|
|
@@ -504,12 +501,13 @@ end
|
|
504
501
|
|
505
502
|
Name | Type | Description | Notes
|
506
503
|
------------- | ------------- | ------------- | -------------
|
507
|
-
**
|
508
|
-
**
|
504
|
+
**authorization** | **String**| Bearer token |
|
505
|
+
**isbn** | **String**| The isbn | [optional]
|
506
|
+
**work_id** | **String**| The ID of a work | [optional]
|
509
507
|
|
510
508
|
### Return type
|
511
509
|
|
512
|
-
[**
|
510
|
+
[**ManifestationResultSet**](ManifestationResultSet.md)
|
513
511
|
|
514
512
|
### Authorization
|
515
513
|
|
@@ -518,14 +516,16 @@ Name | Type | Description | Notes
|
|
518
516
|
### HTTP request headers
|
519
517
|
|
520
518
|
- **Content-Type**: application/json
|
521
|
-
- **Accept**: application/vnd.api+json
|
519
|
+
- **Accept**: application/vnd.api+json
|
520
|
+
|
522
521
|
|
523
522
|
|
523
|
+
# **remove_asset**
|
524
|
+
> remove_asset(authorization, asset_id, asset_type)
|
524
525
|
|
525
|
-
# **2_works_work_id_manifestations_get**
|
526
|
-
> 2_works_work_id_manifestations_get(work_id, authorization)
|
527
526
|
|
528
527
|
|
528
|
+
Remove an asset
|
529
529
|
|
530
530
|
### Example
|
531
531
|
```ruby
|
@@ -541,15 +541,17 @@ end
|
|
541
541
|
|
542
542
|
api_instance = MetatronClient::DefaultApi.new
|
543
543
|
|
544
|
-
|
544
|
+
authorization = "authorization_example" # String | Bearer token
|
545
545
|
|
546
|
-
|
546
|
+
asset_id = "asset_id_example" # String |
|
547
|
+
|
548
|
+
asset_type = "asset_type_example" # String |
|
547
549
|
|
548
550
|
|
549
551
|
begin
|
550
|
-
api_instance.
|
552
|
+
api_instance.remove_asset(authorization, asset_id, asset_type)
|
551
553
|
rescue MetatronClient::ApiError => e
|
552
|
-
puts "Exception when calling DefaultApi->
|
554
|
+
puts "Exception when calling DefaultApi->remove_asset: #{e}"
|
553
555
|
end
|
554
556
|
```
|
555
557
|
|
@@ -557,8 +559,9 @@ end
|
|
557
559
|
|
558
560
|
Name | Type | Description | Notes
|
559
561
|
------------- | ------------- | ------------- | -------------
|
560
|
-
**
|
561
|
-
**
|
562
|
+
**authorization** | **String**| Bearer token |
|
563
|
+
**asset_id** | **String**| |
|
564
|
+
**asset_type** | **String**| |
|
562
565
|
|
563
566
|
### Return type
|
564
567
|
|
@@ -575,10 +578,10 @@ nil (empty response body)
|
|
575
578
|
|
576
579
|
|
577
580
|
|
578
|
-
# **
|
579
|
-
> WorkResultSet
|
580
|
-
|
581
|
+
# **work**
|
582
|
+
> WorkResultSet work(authorization, q, limit, offset, opts)
|
581
583
|
|
584
|
+
Get the work best matching the given bibliographic data
|
582
585
|
|
583
586
|
### Example
|
584
587
|
```ruby
|
@@ -594,16 +597,24 @@ end
|
|
594
597
|
|
595
598
|
api_instance = MetatronClient::DefaultApi.new
|
596
599
|
|
597
|
-
|
600
|
+
authorization = "authorization_example" # String | Bearer token
|
598
601
|
|
599
|
-
|
602
|
+
q = "q_example" # String | Search works for the supplied term
|
600
603
|
|
604
|
+
limit = "limit_example" # String | Limit the results to n results
|
605
|
+
|
606
|
+
offset = "offset_example" # String | Offset the results to position n
|
607
|
+
|
608
|
+
opts = {
|
609
|
+
include: ["include_example"] # Array<String> | Define which relationships to include, comma separated
|
610
|
+
}
|
601
611
|
|
602
612
|
begin
|
603
|
-
|
613
|
+
#Get the work best matching the given bibliographic data
|
614
|
+
result = api_instance.work(authorization, q, limit, offset, opts)
|
604
615
|
p result
|
605
616
|
rescue MetatronClient::ApiError => e
|
606
|
-
puts "Exception when calling DefaultApi->
|
617
|
+
puts "Exception when calling DefaultApi->work: #{e}"
|
607
618
|
end
|
608
619
|
```
|
609
620
|
|
@@ -611,8 +622,11 @@ end
|
|
611
622
|
|
612
623
|
Name | Type | Description | Notes
|
613
624
|
------------- | ------------- | ------------- | -------------
|
614
|
-
**
|
615
|
-
**
|
625
|
+
**authorization** | **String**| Bearer token |
|
626
|
+
**q** | **String**| Search works for the supplied term |
|
627
|
+
**limit** | **String**| Limit the results to n results |
|
628
|
+
**offset** | **String**| Offset the results to position n |
|
629
|
+
**include** | [**Array<String>**](String.md)| Define which relationships to include, comma separated | [optional]
|
616
630
|
|
617
631
|
### Return type
|
618
632
|
|