Class: Hubspot::Cms::SourceCode::MetadataApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/cms/source_code/api/metadata_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MetadataApi

Returns a new instance of MetadataApi.



21
22
23
 
# File 'lib/hubspot/codegen/cms/source_code/api/metadata_api.rb', line 21

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



19
20
21
 
# File 'lib/hubspot/codegen/cms/source_code/api/metadata_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#get(environment, path, opts = {}) ⇒ AssetFileMetadata

Get the metadata for a file Gets the metadata object for the file at the specified path in the specified environment.

Parameters:

  • environment (String) —

    The environment of the file ("draft" or "published").

  • path (String) —

    The file system location of the file.

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

    the optional parameters

Options Hash (opts):

  • :properties (String)

Returns:



31
32
33
34
 
# File 'lib/hubspot/codegen/cms/source_code/api/metadata_api.rb', line 31

def get(environment, path, opts = {})
  data, _status_code, _headers = get_with_http_info(environment, path, opts)
  data
end

#get_with_http_info(environment, path, opts = {}) ⇒ Array<(AssetFileMetadata, Integer, Hash)>

Get the metadata for a file Gets the metadata object for the file at the specified path in the specified environment.

Parameters:

  • environment (String) —

    The environment of the file (&quot;draft&quot; or &quot;published&quot;).

  • path (String) —

    The file system location of the file.

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

    the optional parameters

Options Hash (opts):

  • :properties (String)

Returns:

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

    AssetFileMetadata data, response status code and response headers



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
 
# File 'lib/hubspot/codegen/cms/source_code/api/metadata_api.rb', line 43

def get_with_http_info(environment, path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataApi.get ...'
  end
  # verify the required parameter 'environment' is set
  if @api_client.config.client_side_validation && environment.nil?
    fail ArgumentError, "Missing the required parameter 'environment' when calling MetadataApi.get"
  end
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling MetadataApi.get"
  end
  pattern = Regexp.new(/.+/)
  if @api_client.config.client_side_validation && path !~ pattern
    fail ArgumentError, "invalid value for 'path' when calling MetadataApi.get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/cms/v3/source-code/{environment}/metadata/{path}'.sub('{' + 'environment' + '}', CGI.escape(environment.to_s)).sub('{' + 'path' + '}', CGI.escape(path.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'properties'] = opts[:'properties'] if !opts[:'properties'].nil?

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

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

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

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

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

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