Class: CloudsmithApi::NamespacesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NamespacesApi 



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

def api_client
  @api_client
end

Instance Method Details

#namespaces_list(opts = {}) ⇒ Array<Namespace>

Get a list of all namespaces the user belongs to. Get a list of all namespaces the user belongs to.

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.



28
29
30
31
 
# File 'lib/cloudsmith-api/api/namespaces_api.rb', line 28

def namespaces_list(opts = {})
  data, _status_code, _headers = namespaces_list_with_http_info(opts)
  data
end

#namespaces_list_with_http_info(opts = {}) ⇒ Array<(Array<Namespace>, Fixnum, Hash)>

Get a list of all namespaces the user belongs to. Get a list of all namespaces the user belongs to.

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.



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
 
# File 'lib/cloudsmith-api/api/namespaces_api.rb', line 39

def namespaces_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NamespacesApi.namespaces_list ...'
  end
  # resource path
  local_var_path = '/namespaces/'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey']
  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<Namespace>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NamespacesApi#namespaces_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#namespaces_read(slug, opts = {}) ⇒ Namespace

Views for working with namespaces. Views for working with namespaces.



81
82
83
84
 
# File 'lib/cloudsmith-api/api/namespaces_api.rb', line 81

def namespaces_read(slug, opts = {})
  data, _status_code, _headers = namespaces_read_with_http_info(slug, opts)
  data
end

#namespaces_read_with_http_info(slug, opts = {}) ⇒ Array<(Namespace, Fixnum, Hash)>

Views for working with namespaces. Views for working with namespaces.



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
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/cloudsmith-api/api/namespaces_api.rb', line 91

def namespaces_read_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NamespacesApi.namespaces_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 NamespacesApi.namespaces_read"
  end
  # resource path
  local_var_path = '/namespaces/{slug}/'.sub('{' + 'slug' + '}', slug.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey']
  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 => 'Namespace')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NamespacesApi#namespaces_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end