Class: CloudsmithApi::OrgsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrgsApi

Returns a new instance of OrgsApi.



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

def api_client
  @api_client
end

Instance Method Details

#orgs_list(opts = {}) ⇒ Array<Organization>

Get a list of all the organizations you are associated with. Get a list of all the organizations you are associated with.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



29
30
31
32
 
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 29

def orgs_list(opts = {})
  data, _status_code, _headers = orgs_list_with_http_info(opts)
  return data
end

#orgs_list_with_http_info(opts = {}) ⇒ Array<(Array<Organization>, Fixnum, Hash)>

Get a list of all the organizations you are associated with. Get a list of all the organizations you are associated with.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:

  • (Array<(Array<Organization>, Fixnum, Hash)>) —

    Array<Organization> data, response status code and response headers



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

def orgs_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgsApi.orgs_list ..."
  end
  # resource path
  local_var_path = "/orgs/"

  # 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 = {}

  # form parameters
  form_params = {}

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

#orgs_read(slug, opts = {}) ⇒ Organization

Views for working with organizations. Views for working with organizations.

Parameters:

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

    the optional parameters

Returns:



79
80
81
82
 
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 79

def orgs_read(slug, opts = {})
  data, _status_code, _headers = orgs_read_with_http_info(slug, opts)
  return data
end

#orgs_read_with_http_info(slug, opts = {}) ⇒ Array<(Organization, Fixnum, Hash)>

Views for working with organizations. Views for working with organizations.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Organization, Fixnum, Hash)>) —

    Organization data, response status code and response headers



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
118
119
120
121
122
123
 
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 89

def orgs_read_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrgsApi.orgs_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 OrgsApi.orgs_read"
  end
  # resource path
  local_var_path = "/orgs/{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', '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 => 'Organization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end