Class: BlueprintClient::AssetTypeTemplatesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssetTypeTemplatesApi

Returns a new instance of AssetTypeTemplatesApi.



19
20
21
 
# File 'lib/blueprint_ruby_client/api/asset_type_templates_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_templates_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

Configure a template for a given asset type

Parameters:

  • namespace —

    identifier namespacing the blueprint.

  • asset_type —

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

  • template_body —

    template body

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

    the optional parameters

Returns:



30
31
32
33
 
# File 'lib/blueprint_ruby_client/api/asset_type_templates_api.rb', line 30

def add(namespace, asset_type, template_body, opts = {})
  data, _status_code, _headers = add_with_http_info(namespace, asset_type, template_body, opts)
  return data
end

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

Configure a template for a given asset type

Parameters:

  • namespace —

    identifier namespacing the blueprint.

  • asset_type —

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

  • template_body —

    template body

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

    the optional parameters

Returns:

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

    TemplateBody data, response status code and response headers



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
 
# File 'lib/blueprint_ruby_client/api/asset_type_templates_api.rb', line 42

def add_with_http_info(namespace, asset_type, template_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AssetTypeTemplatesApi.add ..."
  end
  # verify the required parameter 'namespace' is set
  fail ArgumentError, "Missing the required parameter 'namespace' when calling AssetTypeTemplatesApi.add" if namespace.nil?
  # verify the required parameter 'asset_type' is set
  fail ArgumentError, "Missing the required parameter 'asset_type' when calling AssetTypeTemplatesApi.add" if asset_type.nil?
  # verify the required parameter 'template_body' is set
  fail ArgumentError, "Missing the required parameter 'template_body' when calling AssetTypeTemplatesApi.add" if template_body.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 = @api_client.object_to_http_body(template_body)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, 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: AssetTypeTemplatesApi#add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a template for a given asset type

Parameters:

  • namespace —

    identifier namespacing the blueprint.

  • asset_type —

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

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/blueprint_ruby_client/api/asset_type_templates_api.rb', line 94

def delete(namespace, asset_type, opts = {})
  data, _status_code, _headers = delete_with_http_info(namespace, asset_type, opts)
  return data
end

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

Delete a template for a given asset type

Parameters:

  • namespace —

    identifier namespacing the blueprint.

  • 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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/blueprint_ruby_client/api/asset_type_templates_api.rb', line 105

def delete_with_http_info(namespace, asset_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AssetTypeTemplatesApi.delete ..."
  end
  # verify the required parameter 'namespace' is set
  fail ArgumentError, "Missing the required parameter 'namespace' when calling AssetTypeTemplatesApi.delete" if namespace.nil?
  # verify the required parameter 'asset_type' is set
  fail ArgumentError, "Missing the required parameter 'asset_type' when calling AssetTypeTemplatesApi.delete" 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(:DELETE, 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: AssetTypeTemplatesApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

update a template for a given asset type

Parameters:

  • namespace —

    identifier namespacing the blueprint.

  • asset_type —

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

  • template_body —

    template body

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/blueprint_ruby_client/api/asset_type_templates_api.rb', line 156

def put(namespace, asset_type, template_body, opts = {})
  data, _status_code, _headers = put_with_http_info(namespace, asset_type, template_body, opts)
  return data
end

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

update a template for a given asset type

Parameters:

  • namespace —

    identifier namespacing the blueprint.

  • asset_type —

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

  • template_body —

    template body

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

    the optional parameters

Returns:

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

    TemplateBody data, response status code and response headers



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/blueprint_ruby_client/api/asset_type_templates_api.rb', line 168

def put_with_http_info(namespace, asset_type, template_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AssetTypeTemplatesApi.put ..."
  end
  # verify the required parameter 'namespace' is set
  fail ArgumentError, "Missing the required parameter 'namespace' when calling AssetTypeTemplatesApi.put" if namespace.nil?
  # verify the required parameter 'asset_type' is set
  fail ArgumentError, "Missing the required parameter 'asset_type' when calling AssetTypeTemplatesApi.put" if asset_type.nil?
  # verify the required parameter 'template_body' is set
  fail ArgumentError, "Missing the required parameter 'template_body' when calling AssetTypeTemplatesApi.put" if template_body.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 = @api_client.object_to_http_body(template_body)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, 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: AssetTypeTemplatesApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end