blueprint_ruby_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3ecc2e00660942c6cbcae756042cb7e190dd961
+  data.tar.gz: 0d914e081bd68253b72afab0496a8ff08ff1b338
+SHA512:
+  metadata.gz: c76c98f1c6743a584d04c07526400ed30cf1d8560199d1293b05aefcb4cf687fe24f3e9c37999c2cdca05f040af4566c11aa5f71e85034b7461d7d4fd4e4ad2f
+  data.tar.gz: 8ca12a1f09bda926520511e0f1b4f4cbeaacc2674fc3583e27423385a4b6ebd7ebc9cd7c2bfdad30577ad1d270bb81de21f7159e9cce9b77a373aeda29059471

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blueprint_ruby_client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    blueprint_ruby_client (0.1.0)
+      json (~> 1.8, >= 1.8.3)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.0)
+    addressable (2.4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.11)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    ethon (0.9.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.10)
+    hashdiff (0.3.0)
+    json (1.8.3)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.2)
+      ffi (>= 1.0.0)
+    typhoeus (1.0.2)
+      ethon (>= 0.9.0)
+    vcr (3.0.1)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.11)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  blueprint_ruby_client!
+  rspec (~> 3.4, >= 3.4.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,152 @@
+# blueprint_ruby_client
+
+BlueprintClient - the Ruby gem for the Talis Blueprint API
+
+This is the API documentation for [Blueprint](https://github.com/talis/blueprint-server), a primitive for institutional structure and time periods
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0
+- Package version: 0.1.0
+- Build date: 2016-05-03T09:58:50.059+01:00
+- Build package: class io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Generating the code
+
+To update the gem code to the latest API specification:
+
+```shell
+sh generate.sh
+```
+
+Customise the code generation by modifying the template files.
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build blueprint_ruby_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./blueprint_ruby_client-0.1.0.gem
+```
+(for development, run `gem install --dev ./blueprint_ruby_client-0.1.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'blueprint_ruby_client', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/talis/blueprint_rb, then add the following in the Gemfile:
+
+    gem 'blueprint_ruby_client', :git => 'https://github.com/talis/blueprint_rb.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'blueprint_ruby_client'
+
+# Setup authorization
+BlueprintClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BlueprintClient::AssetsApi.new
+
+namespace = "namespace_example" # String | identifier namespacing the blueprint.
+
+type = "type_example" # String | Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals
+
+id = "id_example" # String | id identifying a domain model
+
+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
+
+asset_id = "asset_id_example" # String | id of an asset
+
+
+begin
+  result = api_instance.add_asset_to_node(namespace, typeid, asset_type, asset_id)
+  p result
+rescue BlueprintClient::ApiError => e
+  puts "Exception when calling AssetsApi->add_asset_to_node: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost:10010/1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BlueprintClient::AssetsApi* | [**add_asset_to_node**](docs/AssetsApi.md#add_asset_to_node) | **PUT** /{namespace}/nodes/{type}/{id}/assets/{assetType}/{assetId} | 
+*BlueprintClient::AssetsApi* | [**delete_asset**](docs/AssetsApi.md#delete_asset) | **DELETE** /{namespace}/assets/{assetType}/{assetId} | 
+*BlueprintClient::AssetsApi* | [**get_asset**](docs/AssetsApi.md#get_asset) | **GET** /{namespace}/assets/{assetType}/{assetId} | 
+*BlueprintClient::AssetsApi* | [**get_assets_in_node**](docs/AssetsApi.md#get_assets_in_node) | **GET** /{namespace}/nodes/{type}/{id}/assets | 
+*BlueprintClient::AssetsApi* | [**remove_asset_from_node**](docs/AssetsApi.md#remove_asset_from_node) | **DELETE** /{namespace}/nodes/{type}/{id}/assets/{assetType}/{assetId} | 
+*BlueprintClient::AssetsApi* | [**replace_asset**](docs/AssetsApi.md#replace_asset) | **PUT** /{namespace}/assets/{assetType}/{assetId} | Replaces the Asset with the data sent in the body
+*BlueprintClient::HierarchyApi* | [**add_node**](docs/HierarchyApi.md#add_node) | **POST** /{namespaceIncGlobal}/nodes | 
+*BlueprintClient::HierarchyApi* | [**bulk_upload**](docs/HierarchyApi.md#bulk_upload) | **POST** /{namespace}/nodes.csv | 
+*BlueprintClient::HierarchyApi* | [**delete_node**](docs/HierarchyApi.md#delete_node) | **DELETE** /{namespace}/nodes/{type}/{id} | 
+*BlueprintClient::HierarchyApi* | [**export_hierarchy**](docs/HierarchyApi.md#export_hierarchy) | **GET** /{namespace}/nodes.csv | 
+*BlueprintClient::HierarchyApi* | [**get_ancestors**](docs/HierarchyApi.md#get_ancestors) | **GET** /{namespace}/nodes/{type}/{id}/ancestors | Get ancestor nodes
+*BlueprintClient::HierarchyApi* | [**get_children**](docs/HierarchyApi.md#get_children) | **GET** /{namespace}/nodes/{type}/{id}/children | Get child nodes
+*BlueprintClient::HierarchyApi* | [**get_descendants**](docs/HierarchyApi.md#get_descendants) | **GET** /{namespace}/nodes/{type}/{id}/descendants | Get descendant nodes
+*BlueprintClient::HierarchyApi* | [**get_node**](docs/HierarchyApi.md#get_node) | **GET** /{namespace}/nodes/{type}/{id} | 
+*BlueprintClient::HierarchyApi* | [**get_parents**](docs/HierarchyApi.md#get_parents) | **GET** /{namespace}/nodes/{type}/{id}/parents | Get parent nodes
+*BlueprintClient::HierarchyApi* | [**replace_node**](docs/HierarchyApi.md#replace_node) | **PUT** /{namespace}/nodes/{type}/{id} | 
+*BlueprintClient::HierarchyApi* | [**search_nodes**](docs/HierarchyApi.md#search_nodes) | **GET** /{namespaceIncGlobal}/nodes | Search nodes
+*BlueprintClient::HierarchyApi* | [**update_node**](docs/HierarchyApi.md#update_node) | **PATCH** /{namespace}/nodes/{type}/{id} | 
+
+
+## Documentation for Models
+
+ - [BlueprintClient::Asset](docs/Asset.md)
+ - [BlueprintClient::AssetBody](docs/AssetBody.md)
+ - [BlueprintClient::AssetResultSet](docs/AssetResultSet.md)
+ - [BlueprintClient::Error](docs/Error.md)
+ - [BlueprintClient::Errors](docs/Errors.md)
+ - [BlueprintClient::Links](docs/Links.md)
+ - [BlueprintClient::Meta](docs/Meta.md)
+ - [BlueprintClient::Namespace](docs/Namespace.md)
+ - [BlueprintClient::NamespaceRelationship](docs/NamespaceRelationship.md)
+ - [BlueprintClient::Node](docs/Node.md)
+ - [BlueprintClient::NodeAttributes](docs/NodeAttributes.md)
+ - [BlueprintClient::NodeBody](docs/NodeBody.md)
+ - [BlueprintClient::NodeRelationship](docs/NodeRelationship.md)
+ - [BlueprintClient::NodeRelationships](docs/NodeRelationships.md)
+ - [BlueprintClient::NodeResultSet](docs/NodeResultSet.md)
+
+
+## Documentation for Authorization
+
+
+### oauth2
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - su: Talis super user
+  - su@{namespace}: Super user for a specific blueprint
+

data/blueprint_ruby_client.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "blueprint_ruby_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "blueprint_ruby_client"
+  s.version     = BlueprintClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ben Paddock"]
+  s.email       = ["bp@talis.com"]
+  s.homepage    = "https://github.com/talis/blueprint_rb"
+  s.summary     = "A ruby API wrapper for Blueprint"
+  s.description = "A client to utilise the hierarchy modelling abilities of Blueprint"
+  s.license     = "Copyright Talis Education Ltd"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
+
+  s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
+
+  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/config.json

@@ -0,0 +1,13 @@
+{
+  "gemName": "blueprint_ruby_client",
+  "moduleName": "BlueprintClient",
+  "gemVersion": "0.1.0",
+  "gemLicense": "Copyright Talis Education Ltd",
+  "gemHomepage": "https://github.com/talis/blueprint_rb",
+  "gemSummary": "A ruby API wrapper for Blueprint",
+  "gemDescription": "A client to utilise the hierarchy modelling abilities of Blueprint",
+  "gemAuthor": "Ben Paddock",
+  "gemAuthorEmail": "bp@talis.com",
+  "gitUserId": "talis",
+  "gitRepoId": "blueprint_rb"
+}

data/docs/Asset.md

@@ -0,0 +1,9 @@
+# BlueprintClient::Asset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**type** | **String** |  | 
+
+

data/docs/AssetBody.md

@@ -0,0 +1,9 @@
+# BlueprintClient::AssetBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Meta**](Meta.md) |  | [optional] 
+**data** | [**Asset**](Asset.md) |  | 
+
+

data/docs/AssetResultSet.md

@@ -0,0 +1,9 @@
+# BlueprintClient::AssetResultSet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Meta**](Meta.md) |  | [optional] 
+**data** | [**Array<Asset>**](Asset.md) |  | [optional] 
+
+

data/docs/AssetsApi.md

@@ -0,0 +1,376 @@
+# BlueprintClient::AssetsApi
+
+All URIs are relative to *http://localhost:10010/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_asset_to_node**](AssetsApi.md#add_asset_to_node) | **PUT** /{namespace}/nodes/{type}/{id}/assets/{assetType}/{assetId} | 
+[**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /{namespace}/assets/{assetType}/{assetId} | 
+[**get_asset**](AssetsApi.md#get_asset) | **GET** /{namespace}/assets/{assetType}/{assetId} | 
+[**get_assets_in_node**](AssetsApi.md#get_assets_in_node) | **GET** /{namespace}/nodes/{type}/{id}/assets | 
+[**remove_asset_from_node**](AssetsApi.md#remove_asset_from_node) | **DELETE** /{namespace}/nodes/{type}/{id}/assets/{assetType}/{assetId} | 
+[**replace_asset**](AssetsApi.md#replace_asset) | **PUT** /{namespace}/assets/{assetType}/{assetId} | Replaces the Asset with the data sent in the body
+
+
+# **add_asset_to_node**
+> AssetBody add_asset_to_node(namespace, typeid, asset_type, asset_id)
+
+
+
+Add an asset to the node.  Body must be empty.  Will upsert the asset if it doesn't exist
+
+### Example
+```ruby
+# load the gem
+require 'blueprint_ruby_client'
+# setup authorization 
+BlueprintClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BlueprintClient::AssetsApi.new
+
+namespace = "namespace_example" # String | identifier namespacing the blueprint.
+
+type = "type_example" # String | Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals
+
+id = "id_example" # String | id identifying a domain model
+
+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
+
+asset_id = "asset_id_example" # String | id of an asset
+
+
+begin
+  result = api_instance.add_asset_to_node(namespace, typeid, asset_type, asset_id)
+  p result
+rescue BlueprintClient::ApiError => e
+  puts "Exception when calling AssetsApi->add_asset_to_node: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **namespace** | **String**| identifier namespacing the blueprint. | 
+ **type** | **String**| Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals | 
+ **id** | **String**| id identifying a domain model | 
+ **asset_type** | **String**| Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals | 
+ **asset_id** | **String**| id of an asset | 
+
+### Return type
+
+[**AssetBody**](AssetBody.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/vnd.api+json
+
+
+
+# **delete_asset**
+> delete_asset(namespace, asset_idasset_type, )
+
+
+
+Delete an Asset
+
+### Example
+```ruby
+# load the gem
+require 'blueprint_ruby_client'
+# setup authorization 
+BlueprintClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BlueprintClient::AssetsApi.new
+
+namespace = "namespace_example" # String | identifier namespacing the blueprint.
+
+asset_id = "asset_id_example" # String | id of an asset
+
+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
+
+
+begin
+  api_instance.delete_asset(namespace, asset_idasset_type, )
+rescue BlueprintClient::ApiError => e
+  puts "Exception when calling AssetsApi->delete_asset: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **namespace** | **String**| identifier namespacing the blueprint. | 
+ **asset_id** | **String**| id of an asset | 
+ **asset_type** | **String**| Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/vnd.api+json
+
+
+
+# **get_asset**
+> AssetBody get_asset(namespace, asset_type, asset_id)
+
+
+
+Get details of a given asset
+
+### Example
+```ruby
+# load the gem
+require 'blueprint_ruby_client'
+# setup authorization 
+BlueprintClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BlueprintClient::AssetsApi.new
+
+namespace = "namespace_example" # String | identifier namespacing the blueprint.
+
+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
+
+asset_id = "asset_id_example" # String | id of an asset
+
+
+begin
+  #
+  result = api_instance.get_asset(namespace, asset_type, asset_id)
+  p result
+rescue BlueprintClient::ApiError => e
+  puts "Exception when calling AssetsApi->get_asset: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **namespace** | **String**| identifier namespacing the blueprint. | 
+ **asset_type** | **String**| Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals | 
+ **asset_id** | **String**| id of an asset | 
+
+### Return type
+
+[**AssetBody**](AssetBody.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/vnd.api+json
+
+
+
+# **get_assets_in_node**
+> AssetResultSet get_assets_in_node(namespace, typeid, , opts)
+
+
+
+Get for assets in the relevant node
+
+### Example
+```ruby
+# load the gem
+require 'blueprint_ruby_client'
+# setup authorization 
+BlueprintClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BlueprintClient::AssetsApi.new
+
+namespace = "namespace_example" # String | identifier namespacing the blueprint.
+
+type = "type_example" # String | Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals
+
+id = "id_example" # String | id identifying a domain model
+
+opts = { 
+  filter_asset_type: "filter_asset_type_example", # String | type of asset to return
+  offset: 3.4, # Float | index to start result set from
+  limit: 3.4 # Float | number of records to return
+}
+
+begin
+  result = api_instance.get_assets_in_node(namespace, typeid, , opts)
+  p result
+rescue BlueprintClient::ApiError => e
+  puts "Exception when calling AssetsApi->get_assets_in_node: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **namespace** | **String**| identifier namespacing the blueprint. | 
+ **type** | **String**| Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals | 
+ **id** | **String**| id identifying a domain model | 
+ **filter_asset_type** | **String**| type of asset to return | [optional] 
+ **offset** | [**Float**](.md)| index to start result set from | [optional] 
+ **limit** | [**Float**](.md)| number of records to return | [optional] 
+
+### Return type
+
+[**AssetResultSet**](AssetResultSet.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/vnd.api+json
+
+
+
+# **remove_asset_from_node**
+> remove_asset_from_node(namespace, typeid, asset_type, asset_id)
+
+
+
+Remove an asset from the relevant node
+
+### Example
+```ruby
+# load the gem
+require 'blueprint_ruby_client'
+# setup authorization 
+BlueprintClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BlueprintClient::AssetsApi.new
+
+namespace = "namespace_example" # String | identifier namespacing the blueprint.
+
+type = "type_example" # String | Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals
+
+id = "id_example" # String | id identifying a domain model
+
+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
+
+asset_id = "asset_id_example" # String | id of an asset
+
+
+begin
+  api_instance.remove_asset_from_node(namespace, typeid, asset_type, asset_id)
+rescue BlueprintClient::ApiError => e
+  puts "Exception when calling AssetsApi->remove_asset_from_node: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **namespace** | **String**| identifier namespacing the blueprint. | 
+ **type** | **String**| Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals | 
+ **id** | **String**| id identifying a domain model | 
+ **asset_type** | **String**| Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals | 
+ **asset_id** | **String**| id of an asset | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/vnd.api+json
+
+
+
+# **replace_asset**
+> AssetBody replace_asset(namespace, asset_idasset_type, )
+
+Replaces the Asset with the data sent in the body
+
+Wholesale replacement of Asset data: if you were to PUT to:\n  /1/{namespace}/assets/sometype/someid\n\nwith a body of:\n  { type: \"someothertype\", id: \"someotherid\" }\n\nIt would change the Asset's path to:\n  /1/{namespace}/assets/someothertype/someotherid\n\nand\n  /1/{namespace}/assets/sometype/someid\nwould return a 404.\nIt would also update the assets associated with any node.\n
+
+### Example
+```ruby
+# load the gem
+require 'blueprint_ruby_client'
+# setup authorization 
+BlueprintClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BlueprintClient::AssetsApi.new
+
+namespace = "namespace_example" # String | identifier namespacing the blueprint.
+
+asset_id = "asset_id_example" # String | id of an asset
+
+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
+
+
+begin
+  #Replaces the Asset with the data sent in the body
+  result = api_instance.replace_asset(namespace, asset_idasset_type, )
+  p result
+rescue BlueprintClient::ApiError => e
+  puts "Exception when calling AssetsApi->replace_asset: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **namespace** | **String**| identifier namespacing the blueprint. | 
+ **asset_id** | **String**| id of an asset | 
+ **asset_type** | **String**| Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals | 
+
+### Return type
+
+[**AssetBody**](AssetBody.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/vnd.api+json
+
+
+