Class: SubskribeDevClient::DiscountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_dev/api/discounts_api.rb,
lib/subskribe_dev2/api/discounts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DiscountsApi

Returns a new instance of DiscountsApi.



19
20
21
 
# File 'lib/subskribe_dev/api/discounts_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/subskribe_dev/api/discounts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_discount(opts = {}) ⇒ String

Create a discount Creates a discount with the specified details. On success, the ID of the new discount is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/subskribe_dev/api/discounts_api.rb', line 27

def add_discount(opts = {})
  data, _status_code, _headers = add_discount_with_http_info(opts)
  data
end

#add_discount_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Create a discount Creates a discount with the specified details. On success, the ID of the new discount is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    String data, response status code and response headers



37
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/subskribe_dev/api/discounts_api.rb', line 37

def add_discount_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.add_discount ...'
  end
  # resource path
  local_var_path = '/discounts'

  # 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 = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DiscountsApi#add_discount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_discount(id, opts = {}) ⇒ nil

Delete a discount Deletes a discount. Note that a discount may not be deleted if it is in use.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


77
78
79
80
 
# File 'lib/subskribe_dev/api/discounts_api.rb', line 77

def delete_discount(id, opts = {})
  delete_discount_with_http_info(id, opts)
  nil
end

#delete_discount_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a discount Deletes a discount. Note that a discount may not be deleted if it is in use.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



87
88
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
 
# File 'lib/subskribe_dev/api/discounts_api.rb', line 87

def delete_discount_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.delete_discount ...'
  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 DiscountsApi.delete_discount"
  end
  # resource path
  local_var_path = '/discounts/{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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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: DiscountsApi#delete_discount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_discount(id, opts = {}) ⇒ DiscountJson

Get discount Returns the details of the specified discount.

Parameters:

  • id —

    id of the discount

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

    the optional parameters

Returns:



128
129
130
131
 
# File 'lib/subskribe_dev/api/discounts_api.rb', line 128

def get_discount(id, opts = {})
  data, _status_code, _headers = get_discount_with_http_info(id, opts)
  data
end

#get_discount_with_http_info(id, opts = {}) ⇒ Array<(DiscountJson, Fixnum, Hash)>

Get discount Returns the details of the specified discount.

Parameters:

  • id —

    id of the discount

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

    the optional parameters

Returns:

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

    DiscountJson data, response status code and response headers



138
139
140
141
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/subskribe_dev/api/discounts_api.rb', line 138

def get_discount_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.get_discount ...'
  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 DiscountsApi.get_discount"
  end
  # resource path
  local_var_path = '/discounts/{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'])

  # form parameters
  form_params = {}

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

#get_discounts(opts = {}) ⇒ Array<DiscountJson>

Get discounts Returns all discounts that have been defined

Parameters:

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

    the optional parameters

Returns:



179
180
181
182
 
# File 'lib/subskribe_dev/api/discounts_api.rb', line 179

def get_discounts(opts = {})
  data, _status_code, _headers = get_discounts_with_http_info(opts)
  data
end

#get_discounts_with_http_info(opts = {}) ⇒ Array<(Array<DiscountJson>, Fixnum, Hash)>

Get discounts Returns all discounts that have been defined

Parameters:

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

    the optional parameters

Returns:

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

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



188
189
190
191
192
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
 
# File 'lib/subskribe_dev/api/discounts_api.rb', line 188

def get_discounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.get_discounts ...'
  end
  # resource path
  local_var_path = '/discounts'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_discount(id, opts = {}) ⇒ nil

Update discount details Updates the details of the specified discount. Note that a discount cannot be updated once it is in use by an order.

Parameters:

  • id —

    id of the discount

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


227
228
229
230
 
# File 'lib/subskribe_dev/api/discounts_api.rb', line 227

def update_discount(id, opts = {})
  update_discount_with_http_info(id, opts)
  nil
end

#update_discount_status(id, status, opts = {}) ⇒ nil

Update discount status Updates the status of a discount

Parameters:

  • id —

    id of the discount

  • status —

    new status to set

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

    the optional parameters

Returns:

  • (nil) 


282
283
284
285
 
# File 'lib/subskribe_dev/api/discounts_api.rb', line 282

def update_discount_status(id, status, opts = {})
  update_discount_status_with_http_info(id, status, opts)
  nil
end

#update_discount_status_with_http_info(id, status, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update discount status Updates the status of a discount

Parameters:

  • id —

    id of the discount

  • status —

    new status to set

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/subskribe_dev/api/discounts_api.rb', line 293

def update_discount_status_with_http_info(id, status, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.update_discount_status ...'
  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 DiscountsApi.update_discount_status"
  end
  # verify the required parameter 'status' is set
  if @api_client.config.client_side_validation && status.nil?
    fail ArgumentError, "Missing the required parameter 'status' when calling DiscountsApi.update_discount_status"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['ACTIVE', 'DEPRECATED'].include?(status)
    fail ArgumentError, "invalid value for 'status', must be one of ACTIVE, DEPRECATED"
  end
  # resource path
  local_var_path = '/discounts/{id}/status/{status}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'status' + '}', status.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 = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DiscountsApi#update_discount_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_discount_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update discount details Updates the details of the specified discount. Note that a discount cannot be updated once it is in use by an order.

Parameters:

  • id —

    id of the discount

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



238
239
240
241
242
243
244
245
246
247
248
249
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
 
# File 'lib/subskribe_dev/api/discounts_api.rb', line 238

def update_discount_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.update_discount ...'
  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 DiscountsApi.update_discount"
  end
  # resource path
  local_var_path = '/discounts/{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 = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DiscountsApi#update_discount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end