Class: CloudsmithApi::FormatsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/api/formats_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FormatsApi 



19
20
21
 
# File 'lib/cloudsmith-api/api/formats_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/cloudsmith-api/api/formats_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#formats_list(opts = {}) ⇒ Array<Format>

Get a list of all supported package formats. Get a list of all supported package formats.



27
28
29
30
 
# File 'lib/cloudsmith-api/api/formats_api.rb', line 27

def formats_list(opts = {})
  data, _status_code, _headers = formats_list_with_http_info(opts)
  return data
end

#formats_list_with_http_info(opts = {}) ⇒ Array<(Array<Format>, Fixnum, Hash)>

Get a list of all supported package formats. Get a list of all supported package formats.



36
37
38
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
 
# File 'lib/cloudsmith-api/api/formats_api.rb', line 36

def formats_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormatsApi.formats_list ..."
  end
  # resource path
  local_var_path = "/formats/"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'csrf_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Format>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormatsApi#formats_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#formats_read(slug, opts = {}) ⇒ Format

Get a specific supported package format. Get a specific supported package format.



73
74
75
76
 
# File 'lib/cloudsmith-api/api/formats_api.rb', line 73

def formats_read(slug, opts = {})
  data, _status_code, _headers = formats_read_with_http_info(slug, opts)
  return data
end

#formats_read_with_http_info(slug, opts = {}) ⇒ Array<(Format, Fixnum, Hash)>

Get a specific supported package format. Get a specific supported package format.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cloudsmith-api/api/formats_api.rb', line 83

def formats_read_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormatsApi.formats_read ..."
  end
  # verify the required parameter 'slug' is set
  if @api_client.config.client_side_validation && slug.nil?
    fail ArgumentError, "Missing the required parameter 'slug' when calling FormatsApi.formats_read"
  end
  # resource path
  local_var_path = "/formats/{slug}/".sub('{' + 'slug' + '}', slug.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'csrf_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Format')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormatsApi#formats_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end