Class: WhiteLabelMachineName::ShopifySubscriptionService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ShopifySubscriptionService

Returns a new instance of ShopifySubscriptionService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_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/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#count(space_id, opts = {}) ⇒ Integer

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

  • (Integer) 


34
35
36
37
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 34

def count(space_id, opts = {})
  data, _status_code, _headers = count_with_http_info(space_id, opts)
  return data
end

#count_with_http_info(space_id, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

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

    Integer data, response status code and response headers



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 45

def count_with_http_info(space_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopifySubscriptionService.count ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionService.count" if space_id.nil?
  # resource path
  local_var_path = "/shopify-subscription/count".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'filter'])
  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 => 'Integer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopifySubscriptionService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(space_id, creation_request, opts = {}) ⇒ ShopifySubscriptionVersion

Create This operation allows to create a Shopify subscription.

Parameters:

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 94

def create(space_id, creation_request, opts = {})
  data, _status_code, _headers = create_with_http_info(space_id, creation_request, opts)
  return data
end

#create_with_http_info(space_id, creation_request, opts = {}) ⇒ Array<(ShopifySubscriptionVersion, Fixnum, Hash)>

Create This operation allows to create a Shopify subscription.

Parameters:

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

    the optional parameters

Returns:

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

    ShopifySubscriptionVersion data, response status code and response headers



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 105

def create_with_http_info(space_id, creation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopifySubscriptionService.create ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionService.create" if space_id.nil?
  # verify the required parameter 'creation_request' is set
  fail ArgumentError, "Missing the required parameter 'creation_request' when calling ShopifySubscriptionService.create" if creation_request.nil?
  # resource path
  local_var_path = "/shopify-subscription/create".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(creation_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 => 'ShopifySubscriptionVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopifySubscriptionService#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(space_id, id, opts = {}) ⇒ ShopifySubscription

Read Reads the entity with the given ‘id’ and returns it.

Parameters:

  • space_id
  • id —

    The id of the Shopify subscription which should be returned.

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 156

def read(space_id, id, opts = {})
  data, _status_code, _headers = read_with_http_info(space_id, id, opts)
  return data
end

#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(ShopifySubscription, Fixnum, Hash)>

Read Reads the entity with the given &#39;id&#39; and returns it.

Parameters:

  • space_id
  • id —

    The id of the Shopify subscription which should be returned.

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

    the optional parameters

Returns:

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

    ShopifySubscription data, response status code and response headers



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 167

def read_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopifySubscriptionService.read ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionService.read" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling ShopifySubscriptionService.read" if id.nil?
  # resource path
  local_var_path = "/shopify-subscription/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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 => 'ShopifySubscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopifySubscriptionService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(space_id, query, opts = {}) ⇒ Array<ShopifySubscription>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the Shopify subscriptions which are returned by the search.

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

    the optional parameters

Returns:



219
220
221
222
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 219

def search(space_id, query, opts = {})
  data, _status_code, _headers = search_with_http_info(space_id, query, opts)
  return data
end

#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<ShopifySubscription>, Fixnum, Hash)>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the Shopify subscriptions which are returned by the search.

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

    the optional parameters

Returns:

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

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



230
231
232
233
234
235
236
237
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 230

def search_with_http_info(space_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopifySubscriptionService.search ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionService.search" if space_id.nil?
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling ShopifySubscriptionService.search" if query.nil?
  # resource path
  local_var_path = "/shopify-subscription/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  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 => 'Array<ShopifySubscription>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopifySubscriptionService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#terminate(space_id, subscription_id, respect_termination_period, opts = {}) ⇒ nil

Terminate This operation allows to terminate a Shopify subscription.

Parameters:

  • space_id
  • subscription_id —

    The ID identifies the Shopify subscription which should be terminated.

  • respect_termination_period —

    The respect termination period controls whether the termination period configured on the product version should be respected or if the operation should take effect immediately.

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

    the optional parameters

Returns:

  • (nil) 


282
283
284
285
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 282

def terminate(space_id, subscription_id, respect_termination_period, opts = {})
  terminate_with_http_info(space_id, subscription_id, respect_termination_period, opts)
  return nil
end

#terminate_with_http_info(space_id, subscription_id, respect_termination_period, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Terminate This operation allows to terminate a Shopify subscription.

Parameters:

  • space_id
  • subscription_id —

    The ID identifies the Shopify subscription which should be terminated.

  • respect_termination_period —

    The respect termination period controls whether the termination period configured on the product version should be respected or if the operation should take effect immediately.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
339
340
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 294

def terminate_with_http_info(space_id, subscription_id, respect_termination_period, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopifySubscriptionService.terminate ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionService.terminate" if space_id.nil?
  # verify the required parameter 'subscription_id' is set
  fail ArgumentError, "Missing the required parameter 'subscription_id' when calling ShopifySubscriptionService.terminate" if subscription_id.nil?
  # verify the required parameter 'respect_termination_period' is set
  fail ArgumentError, "Missing the required parameter 'respect_termination_period' when calling ShopifySubscriptionService.terminate" if respect_termination_period.nil?
  # resource path
  local_var_path = "/shopify-subscription/terminate".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'subscriptionId'] = subscription_id
  query_params[:'respectTerminationPeriod'] = respect_termination_period

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#update(space_id, subscription, opts = {}) ⇒ ShopifySubscriptionVersion

Update This operation allows to update a Shopify subscription.

Parameters:

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

    the optional parameters

Returns:



348
349
350
351
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 348

def update(space_id, subscription, opts = {})
  data, _status_code, _headers = update_with_http_info(space_id, subscription, opts)
  return data
end

#update_addresses(space_id, update_request, opts = {}) ⇒ ShopifySubscriptionVersion

Update Addresses This operation allows to update a Shopify subscription addresses.

Parameters:

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

    the optional parameters

Returns:



410
411
412
413
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 410

def update_addresses(space_id, update_request, opts = {})
  data, _status_code, _headers = update_addresses_with_http_info(space_id, update_request, opts)
  return data
end

#update_addresses_with_http_info(space_id, update_request, opts = {}) ⇒ Array<(ShopifySubscriptionVersion, Fixnum, Hash)>

Update Addresses This operation allows to update a Shopify subscription addresses.

Parameters:

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

    the optional parameters

Returns:

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

    ShopifySubscriptionVersion data, response status code and response headers



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 421

def update_addresses_with_http_info(space_id, update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopifySubscriptionService.update_addresses ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionService.update_addresses" if space_id.nil?
  # verify the required parameter 'update_request' is set
  fail ArgumentError, "Missing the required parameter 'update_request' when calling ShopifySubscriptionService.update_addresses" if update_request.nil?
  # resource path
  local_var_path = "/shopify-subscription/update-addresses".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(update_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 => 'ShopifySubscriptionVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopifySubscriptionService#update_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_with_http_info(space_id, subscription, opts = {}) ⇒ Array<(ShopifySubscriptionVersion, Fixnum, Hash)>

Update This operation allows to update a Shopify subscription.

Parameters:

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

    the optional parameters

Returns:

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

    ShopifySubscriptionVersion data, response status code and response headers



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/shopify_subscription_service_api.rb', line 359

def update_with_http_info(space_id, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopifySubscriptionService.update ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionService.update" if space_id.nil?
  # verify the required parameter 'subscription' is set
  fail ArgumentError, "Missing the required parameter 'subscription' when calling ShopifySubscriptionService.update" if subscription.nil?
  # resource path
  local_var_path = "/shopify-subscription/update".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(subscription)
  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 => 'ShopifySubscriptionVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopifySubscriptionService#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end