Class: GroupDocsPlatformCloud::HerokuApi

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_platform_cloud/api/heroku_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ HerokuApi

Returns a new instance of HerokuApi.



19
20
21
 
# File 'lib/groupdocs_platform_cloud/api/heroku_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/groupdocs_platform_cloud/api/heroku_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#heroku_delete_resources(id, opts = {}) ⇒ File

Unsubscribe Heroku User (set payment plan to Free)

Parameters:

  • id —

    User Id

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/groupdocs_platform_cloud/api/heroku_api.rb', line 28

def heroku_delete_resources(id, opts = {})
  data, _status_code, _headers = heroku_delete_resources_with_http_info(id, opts)
  return data
end

#heroku_delete_resources_with_http_info(id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Unsubscribe Heroku User (set payment plan to Free)

Parameters:

  • id —

    User Id

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/groupdocs_platform_cloud/api/heroku_api.rb', line 38

def heroku_delete_resources_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HerokuApi.heroku_delete_resources ..."
  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 HerokuApi.heroku_delete_resources"
  end
  # resource path
  local_var_path = "/heroku/resources/{id}".sub('{' + 'id' + '}', id.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 = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HerokuApi#heroku_delete_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#heroku_get_resources(id, opts = {}) ⇒ File

Provision. Get Heroku User

Parameters:

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/groupdocs_platform_cloud/api/heroku_api.rb', line 83

def heroku_get_resources(id, opts = {})
  data, _status_code, _headers = heroku_get_resources_with_http_info(id, opts)
  return data
end

#heroku_get_resources_with_http_info(id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Provision. Get Heroku User

Parameters:

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
130
131
 
# File 'lib/groupdocs_platform_cloud/api/heroku_api.rb', line 93

def heroku_get_resources_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HerokuApi.heroku_get_resources ..."
  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 HerokuApi.heroku_get_resources"
  end
  # resource path
  local_var_path = "/heroku/resources/{id}".sub('{' + 'id' + '}', id.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 = []
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HerokuApi#heroku_get_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#heroku_post_resources(opts = {}) ⇒ File

Provision. Create Heroku User

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :heroku_request (HerokuRequest) —

    User data from Heroku Add-On

Returns:



138
139
140
141
 
# File 'lib/groupdocs_platform_cloud/api/heroku_api.rb', line 138

def heroku_post_resources(opts = {})
  data, _status_code, _headers = heroku_post_resources_with_http_info(opts)
  return data
end

#heroku_post_resources_with_http_info(opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Provision. Create Heroku User

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :heroku_request (HerokuRequest) —

    User data from Heroku Add-On

Returns:

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

    File data, response status code and response headers



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/groupdocs_platform_cloud/api/heroku_api.rb', line 148

def heroku_post_resources_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HerokuApi.heroku_post_resources ..."
  end
  # resource path
  local_var_path = "/heroku/resources"

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'heroku_request'])
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HerokuApi#heroku_post_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#heroku_put_resources(id, opts = {}) ⇒ File

Update Heroku User Payment Plan

Parameters:

  • id —

    User Id

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

    the optional parameters

Options Hash (opts):

  • :heroku_request (HerokuRequest) —

    User data from Heroku Add-On

Returns:



190
191
192
193
 
# File 'lib/groupdocs_platform_cloud/api/heroku_api.rb', line 190

def heroku_put_resources(id, opts = {})
  data, _status_code, _headers = heroku_put_resources_with_http_info(id, opts)
  return data
end

#heroku_put_resources_with_http_info(id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Update Heroku User Payment Plan

Parameters:

  • id —

    User Id

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

    the optional parameters

Options Hash (opts):

  • :heroku_request (HerokuRequest) —

    User data from Heroku Add-On

Returns:

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

    File data, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/groupdocs_platform_cloud/api/heroku_api.rb', line 201

def heroku_put_resources_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HerokuApi.heroku_put_resources ..."
  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 HerokuApi.heroku_put_resources"
  end
  # resource path
  local_var_path = "/heroku/resources/{id}".sub('{' + 'id' + '}', id.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(['multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'heroku_request'])
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HerokuApi#heroku_put_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end