Class: Patch::ProjectsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/patch_ruby/api/projects_api.rb

Constant Summary collapse

OPERATIONS = 
[
  :retrieve_project,
  :retrieve_projects,
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProjectsApi

Returns a new instance of ProjectsApi.



24
25
26
 
# File 'lib/patch_ruby/api/projects_api.rb', line 24

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/patch_ruby/api/projects_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#retrieve_project(id, opts = {}) ⇒ ProjectResponse

Retrieves a project Retrieves a project available on Patch’s platform.

Parameters:

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

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/patch_ruby/api/projects_api.rb', line 32

def retrieve_project(id, opts = {})
  data, _status_code, _headers = retrieve_project_with_http_info(id, opts)
  data
end

#retrieve_project_with_http_info(id, opts = {}) ⇒ Array<(ProjectResponse, Integer, Hash)>

Retrieves a project Retrieves a project available on Patch&#39;s platform.

Parameters:

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

    the optional parameters

Returns:

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

    ProjectResponse data, response status code and response headers



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
 
# File 'lib/patch_ruby/api/projects_api.rb', line 42

def retrieve_project_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectsApi.retrieve_project ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProjectsApi.retrieve_project"
  end
  # resource path
  local_var_path = '/v1/projects/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

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

  # return_type
  return_type = opts[:return_type] || 'ProjectResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['bearer_auth']

  new_options = opts.merge(
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectsApi#retrieve_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_projects(opts = {}) ⇒ ProjectListResponse

Retrieves a list of projects Retrieves a list of projects available for purchase on Patch’s platform.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :country (String)
  • :type (String)
  • :minimum_available_mass (Integer)

Returns:



97
98
99
100
 
# File 'lib/patch_ruby/api/projects_api.rb', line 97

def retrieve_projects(opts = {})
  data, _status_code, _headers = retrieve_projects_with_http_info(opts)
  data
end

#retrieve_projects_with_http_info(opts = {}) ⇒ Array<(ProjectListResponse, Integer, Hash)>

Retrieves a list of projects Retrieves a list of projects available for purchase on Patch&#39;s platform.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :country (String)
  • :type (String)
  • :minimum_available_mass (Integer)

Returns:

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

    ProjectListResponse data, response status code and response headers



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/patch_ruby/api/projects_api.rb', line 110

def retrieve_projects_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectsApi.retrieve_projects ...'
  end
  # resource path
  local_var_path = '/v1/projects'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'minimum_available_mass'] = opts[:'minimum_available_mass'] if !opts[:'minimum_available_mass'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

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

  # return_type
  return_type = opts[:return_type] || 'ProjectListResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['bearer_auth']

  new_options = opts.merge(
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectsApi#retrieve_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end