Class: Hubspot::Cms::SourceCode::ExtractApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExtractApi 



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

def api_client
  @api_client
end

Instance Method Details

#extract_by_path(path, opts = {}) ⇒ nil

Extracts a zip file Extracts a zip file in the file system. The zip file will be extracted in-place and not be deleted automatically.



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

def extract_by_path(path, opts = {})
  extract_by_path_with_http_info(path, opts)
  nil
end

#extract_by_path_with_http_info(path, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Extracts a zip file Extracts a zip file in the file system. The zip file will be extracted in-place and not be deleted automatically.



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

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

  # resource path
  local_var_path = '/cms/v3/source-code/extract/{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(['*/*'])

  # 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] || ['oauth2']

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