Class: XbimAim::ThumbnailsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/xbim_aim/api/thumbnails_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ThumbnailsApi

Returns a new instance of ThumbnailsApi.



19
20
21
 
# File 'lib/xbim_aim/api/thumbnails_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/xbim_aim/api/thumbnails_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#thumbnails_get_asset_thumbnail(asset_id, tenant_id, region, opts = {}) ⇒ File

Get Thumbnails asset thumbnail <span style=‘font-size: 17px;’>Summary:</span>Return Type: string<br/><br/>

Parameters:

  • asset_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

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

    the optional parameters

Returns:

  • (File) 


29
30
31
32
 
# File 'lib/xbim_aim/api/thumbnails_api.rb', line 29

def thumbnails_get_asset_thumbnail(asset_id, tenant_id, region, opts = {})
  data, _status_code, _headers = thumbnails_get_asset_thumbnail_with_http_info(asset_id, tenant_id, region, opts)
  data
end

#thumbnails_get_asset_thumbnail_with_http_info(asset_id, tenant_id, region, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get Thumbnails asset thumbnail &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;string&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
97
98
99
100
 
# File 'lib/xbim_aim/api/thumbnails_api.rb', line 41

def thumbnails_get_asset_thumbnail_with_http_info(asset_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ThumbnailsApi.thumbnails_get_asset_thumbnail ...'
  end
  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling ThumbnailsApi.thumbnails_get_asset_thumbnail"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ThumbnailsApi.thumbnails_get_asset_thumbnail"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ThumbnailsApi.thumbnails_get_asset_thumbnail"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/thumbnails/asset/{assetId}'.sub('{' + 'assetId' + '}', CGI.escape(asset_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ThumbnailsApi.thumbnails_get_asset_thumbnail",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ThumbnailsApi#thumbnails_get_asset_thumbnail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#thumbnails_post_asset_thumbnail(asset_id, tenant_id, region, opts = {}) ⇒ Object

Post Thumbnails asset thumbnail <span style=‘font-size: 17px;’>Summary:</span>Return Type: <br/><br/>

Parameters:

  • asset_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

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

    the optional parameters

Returns:

  • (Object) 


109
110
111
112
 
# File 'lib/xbim_aim/api/thumbnails_api.rb', line 109

def thumbnails_post_asset_thumbnail(asset_id, tenant_id, region, opts = {})
  data, _status_code, _headers = thumbnails_post_asset_thumbnail_with_http_info(asset_id, tenant_id, region, opts)
  data
end

#thumbnails_post_asset_thumbnail_with_http_info(asset_id, tenant_id, region, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Post Thumbnails asset thumbnail &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/xbim_aim/api/thumbnails_api.rb', line 121

def thumbnails_post_asset_thumbnail_with_http_info(asset_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ThumbnailsApi.thumbnails_post_asset_thumbnail ...'
  end
  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling ThumbnailsApi.thumbnails_post_asset_thumbnail"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ThumbnailsApi.thumbnails_post_asset_thumbnail"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ThumbnailsApi.thumbnails_post_asset_thumbnail"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/thumbnails/asset/{assetId}'.sub('{' + 'assetId' + '}', CGI.escape(asset_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ThumbnailsApi.thumbnails_post_asset_thumbnail",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ThumbnailsApi#thumbnails_post_asset_thumbnail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end