Class: XbimComms::SnapshotsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/xbim_comms/api/snapshots_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SnapshotsApi

Returns a new instance of SnapshotsApi.



19
20
21
 
# File 'lib/xbim_comms/api/snapshots_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_comms/api/snapshots_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#snapshots_get_snapshot(hash, file_id, region, opts = {}) ⇒ nil

Gets a File Blob from a Message <span style=‘font-size: 17px;’>Summary:</span>Gets a File Blob from a Message.<br/>Return Type: <br/><br/>

Parameters:

  • hash (String) —

    A hashId identifying the conversation and message

  • file_id (String) —

    The Id of the file to download

  • region (String) —

    The data center region the data resides in

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

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/xbim_comms/api/snapshots_api.rb', line 29

def snapshots_get_snapshot(hash, file_id, region, opts = {})
  snapshots_get_snapshot_with_http_info(hash, file_id, region, opts)
  nil
end

#snapshots_get_snapshot_with_http_info(hash, file_id, region, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Gets a File Blob from a Message &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets a File Blob from a Message.&lt;br/&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • hash (String) —

    A hashId identifying the conversation and message

  • file_id (String) —

    The Id of the file to download

  • region (String) —

    The data center region the data resides in

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/xbim_comms/api/snapshots_api.rb', line 41

def snapshots_get_snapshot_with_http_info(hash, file_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SnapshotsApi.snapshots_get_snapshot ...'
  end
  # verify the required parameter 'hash' is set
  if @api_client.config.client_side_validation && hash.nil?
    fail ArgumentError, "Missing the required parameter 'hash' when calling SnapshotsApi.snapshots_get_snapshot"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling SnapshotsApi.snapshots_get_snapshot"
  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 SnapshotsApi.snapshots_get_snapshot"
  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}/comms/2.0/Snapshots/{hash}/{fileId}'.sub('{' + 'hash' + '}', CGI.escape(hash.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"SnapshotsApi.snapshots_get_snapshot",
    :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: SnapshotsApi#snapshots_get_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end