Class: BlueprintClient::AssetTypeConfigsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/blueprint_ruby_client/api/asset_type_configs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssetTypeConfigsApi

Returns a new instance of AssetTypeConfigsApi.



19
20
21
 
# File 'lib/blueprint_ruby_client/api/asset_type_configs_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/blueprint_ruby_client/api/asset_type_configs_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get(namespace, asset_type, opts = {}) ⇒ TemplateBody

get a template for a given asset type

Parameters:

  • namespace —

    identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.

  • asset_type —

    subtype of Asset, e.g. 'textbooks', 'digitisations', etc.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/blueprint_ruby_client/api/asset_type_configs_api.rb', line 29

def get(namespace, asset_type, opts = {})
  data, _status_code, _headers = get_with_http_info(namespace, asset_type, opts)
  return data
end

#get_with_http_info(namespace, asset_type, opts = {}) ⇒ Array<(TemplateBody, Fixnum, Hash)>

get a template for a given asset type

Parameters:

  • namespace —

    identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.

  • asset_type —

    subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TemplateBody, Fixnum, Hash)>) —

    TemplateBody data, response status code and response headers



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/blueprint_ruby_client/api/asset_type_configs_api.rb', line 40

def get_with_http_info(namespace, asset_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AssetTypeConfigsApi.get ..."
  end
  
  
  # verify the required parameter 'namespace' is set
  fail ArgumentError, "Missing the required parameter 'namespace' when calling AssetTypeConfigsApi.get" if namespace.nil?
  
  
  
  
  
  
  # verify the required parameter 'asset_type' is set
  fail ArgumentError, "Missing the required parameter 'asset_type' when calling AssetTypeConfigsApi.get" if asset_type.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/{namespace}/assets/{assetType}/templates".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'assetType' + '}', asset_type.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TemplateBody')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetTypeConfigsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end