Class: TripletexApi::EventsubscriptionApi
- Inherits:
-
Object
- Object
- TripletexApi::EventsubscriptionApi
- Defined in:
- lib/tripletex_api/api/eventsubscription_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete(id, opts = {}) ⇒ nil
- BETA
-
Delete the given subscription.
-
#delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
- BETA
-
Delete the given subscription.
-
#get(id, opts = {}) ⇒ ResponseWrapperSubscription
- BETA
-
Get subscription by ID.
-
#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperSubscription, Fixnum, Hash)>
- BETA
-
Get subscription by ID.
-
#initialize(api_client = ApiClient.default) ⇒ EventsubscriptionApi
constructor
A new instance of EventsubscriptionApi.
-
#post(opts = {}) ⇒ ResponseWrapperSubscription
- BETA
-
Create a new subscription for current EmployeeToken.
-
#post_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperSubscription, Fixnum, Hash)>
- BETA
-
Create a new subscription for current EmployeeToken.
-
#put(id, opts = {}) ⇒ ResponseWrapperSubscription
- BETA
-
Change a current subscription, based on id.
-
#put_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperSubscription, Fixnum, Hash)>
- BETA
-
Change a current subscription, based on id.
-
#search(opts = {}) ⇒ ListResponseSubscription
- BETA
-
Find all ongoing subscriptions.
-
#search_with_http_info(opts = {}) ⇒ Array<(ListResponseSubscription, Fixnum, Hash)>
- BETA
-
Find all ongoing subscriptions.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ EventsubscriptionApi
Returns a new instance of EventsubscriptionApi.
19 20 21 |
# File 'lib/tripletex_api/api/eventsubscription_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/tripletex_api/api/eventsubscription_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#delete(id, opts = {}) ⇒ nil
- BETA
-
Delete the given subscription.
28 29 30 31 |
# File 'lib/tripletex_api/api/eventsubscription_api.rb', line 28 def delete(id, opts = {}) delete_with_http_info(id, opts) return nil end |
#delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
- BETA
-
Delete the given subscription.
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 |
# File 'lib/tripletex_api/api/eventsubscription_api.rb', line 38 def delete_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EventsubscriptionApi.delete ..." 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 EventsubscriptionApi.delete" end # resource path local_var_path = "/event/subscription/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['tokenAuthScheme'] 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: EventsubscriptionApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get(id, opts = {}) ⇒ ResponseWrapperSubscription
- BETA
-
Get subscription by ID.
79 80 81 82 |
# File 'lib/tripletex_api/api/eventsubscription_api.rb', line 79 def get(id, opts = {}) data, _status_code, _headers = get_with_http_info(id, opts) return data end |
#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperSubscription, Fixnum, Hash)>
- BETA
-
Get subscription by ID.
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 124 125 |
# File 'lib/tripletex_api/api/eventsubscription_api.rb', line 90 def get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EventsubscriptionApi.get ..." 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 EventsubscriptionApi.get" end # resource path local_var_path = "/event/subscription/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil? # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['tokenAuthScheme'] 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 => 'ResponseWrapperSubscription') if @api_client.config.debugging @api_client.config.logger.debug "API called: EventsubscriptionApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post(opts = {}) ⇒ ResponseWrapperSubscription
- BETA
-
Create a new subscription for current EmployeeToken.
132 133 134 135 |
# File 'lib/tripletex_api/api/eventsubscription_api.rb', line 132 def post(opts = {}) data, _status_code, _headers = post_with_http_info(opts) return data end |
#post_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperSubscription, Fixnum, Hash)>
- BETA
-
Create a new subscription for current EmployeeToken.
142 143 144 145 146 147 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 |
# File 'lib/tripletex_api/api/eventsubscription_api.rb', line 142 def post_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EventsubscriptionApi.post ..." end # resource path local_var_path = "/event/subscription" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['tokenAuthScheme'] 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 => 'ResponseWrapperSubscription') if @api_client.config.debugging @api_client.config.logger.debug "API called: EventsubscriptionApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#put(id, opts = {}) ⇒ ResponseWrapperSubscription
- BETA
-
Change a current subscription, based on id.
182 183 184 185 |
# File 'lib/tripletex_api/api/eventsubscription_api.rb', line 182 def put(id, opts = {}) data, _status_code, _headers = put_with_http_info(id, opts) return data end |
#put_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperSubscription, Fixnum, Hash)>
- BETA
-
Change a current subscription, based on id.
193 194 195 196 197 198 199 200 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 |
# File 'lib/tripletex_api/api/eventsubscription_api.rb', line 193 def put_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EventsubscriptionApi.put ..." 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 EventsubscriptionApi.put" end # resource path local_var_path = "/event/subscription/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['tokenAuthScheme'] 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 => 'ResponseWrapperSubscription') if @api_client.config.debugging @api_client.config.logger.debug "API called: EventsubscriptionApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search(opts = {}) ⇒ ListResponseSubscription
- BETA
-
Find all ongoing subscriptions.
237 238 239 240 |
# File 'lib/tripletex_api/api/eventsubscription_api.rb', line 237 def search(opts = {}) data, _status_code, _headers = search_with_http_info(opts) return data end |
#search_with_http_info(opts = {}) ⇒ Array<(ListResponseSubscription, Fixnum, Hash)>
- BETA
-
Find all ongoing subscriptions.
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'lib/tripletex_api/api/eventsubscription_api.rb', line 250 def search_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EventsubscriptionApi.search ..." end # resource path local_var_path = "/event/subscription" # query parameters query_params = {} query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil? query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil? query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil? query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil? # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['tokenAuthScheme'] 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 => 'ListResponseSubscription') if @api_client.config.debugging @api_client.config.logger.debug "API called: EventsubscriptionApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |