Class: Hubspot::Cms::SourceCode::ValidationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ValidationApi

Returns a new instance of ValidationApi.



21
22
23
 
# File 'lib/hubspot/codegen/cms/source_code/api/validation_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/validation_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#do_validate(path, opts = {}) ⇒ Error

Validate the contents of a file Validates the file contents passed to the endpoint given a specified path and environment. Accepts multipart/form-data content type.

Parameters:

  • path (String) —

    The file system location of the file.

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

    the optional parameters

Options Hash (opts):

  • :file (File) —

    The file to validate.

Returns:



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

def do_validate(path, opts = {})
  data, _status_code, _headers = do_validate_with_http_info(path, opts)
  data
end

#do_validate_with_http_info(path, opts = {}) ⇒ Array<(Error, Integer, Hash)>

Validate the contents of a file Validates the file contents passed to the endpoint given a specified path and environment. Accepts multipart/form-data content type.

Parameters:

  • path (String) —

    The file system location of the file.

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

    the optional parameters

Options Hash (opts):

  • :file (File) —

    The file to validate.

Returns:

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

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

def do_validate_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ValidationApi.do_validate ...'
  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 ValidationApi.do_validate"
  end
  pattern = Regexp.new(/.+/)
  if @api_client.config.client_side_validation && path !~ pattern
    fail ArgumentError, "invalid value for 'path' when calling ValidationApi.do_validate, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/cms/v3/source-code/{environment}/validate/{path}'.sub('{' + 'path' + '}', CGI.escape(path.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(['*/*'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?

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

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

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

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