class Wallee::ShopifySubscriptionSuspensionService
Attributes
Public Class Methods
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_service_api.rb, line 24 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Count Counts the number of items in the database as restricted by the given filter. @param space_id @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Integer]
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_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 Counts the number of items in the database as restricted by the given filter. @param space_id @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Array<(Integer, Fixnum, Hash)>] Integer data, response status code and response headers
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_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: ShopifySubscriptionSuspensionService.count ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionSuspensionService.count" if space_id.nil? # resource path local_var_path = "/shopify-subscription-suspension/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: ShopifySubscriptionSuspensionService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Reactivate This operation allows to reactivate a suspended Shopify subscription. @param space_id @param subscription_id The ID identifies the suspended Shopify subscription which should be reactivated. @param [Hash] opts the optional parameters @return [nil]
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_service_api.rb, line 94 def reactivate(space_id, subscription_id, opts = {}) reactivate_with_http_info(space_id, subscription_id, opts) return nil end
Reactivate This operation allows to reactivate a suspended Shopify subscription. @param space_id @param subscription_id The ID identifies the suspended Shopify subscription which should be reactivated. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_service_api.rb, line 105 def reactivate_with_http_info(space_id, subscription_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ShopifySubscriptionSuspensionService.reactivate ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionSuspensionService.reactivate" if space_id.nil? # verify the required parameter 'subscription_id' is set fail ArgumentError, "Missing the required parameter 'subscription_id' when calling ShopifySubscriptionSuspensionService.reactivate" if subscription_id.nil? # resource path local_var_path = "/shopify-subscription-suspension/reactivate".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'subscriptionId'] = subscription_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(: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: ShopifySubscriptionSuspensionService#reactivate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Read Reads the entity with the given 'id' and returns it. @param space_id @param id The id of the Shopify subscription suspension which should be returned. @param [Hash] opts the optional parameters @return [ShopifySubscriptionSuspension]
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_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 Reads the entity with the given 'id' and returns it. @param space_id @param id The id of the Shopify subscription suspension which should be returned. @param [Hash] opts the optional parameters @return [Array<(ShopifySubscriptionSuspension
, Fixnum, Hash)>] ShopifySubscriptionSuspension
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_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: ShopifySubscriptionSuspensionService.read ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionSuspensionService.read" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling ShopifySubscriptionSuspensionService.read" if id.nil? # resource path local_var_path = "/shopify-subscription-suspension/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 => 'ShopifySubscriptionSuspension') if @api_client.config.debugging @api_client.config.logger.debug "API called: ShopifySubscriptionSuspensionService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search Searches for the entities as specified by the given query. @param space_id @param query The query restricts the Shopify subscription suspensions which are returned by the search. @param [Hash] opts the optional parameters @return [Array<ShopifySubscriptionSuspension>]
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_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 Searches for the entities as specified by the given query. @param space_id @param query The query restricts the Shopify subscription suspensions which are returned by the search. @param [Hash] opts the optional parameters @return [Array<(Array<ShopifySubscriptionSuspension>, Fixnum, Hash)>] Array<ShopifySubscriptionSuspension> data, response status code and response headers
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_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: ShopifySubscriptionSuspensionService.search ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionSuspensionService.search" if space_id.nil? # verify the required parameter 'query' is set fail ArgumentError, "Missing the required parameter 'query' when calling ShopifySubscriptionSuspensionService.search" if query.nil? # resource path local_var_path = "/shopify-subscription-suspension/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<ShopifySubscriptionSuspension>') if @api_client.config.debugging @api_client.config.logger.debug "API called: ShopifySubscriptionSuspensionService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Suspend This operation allows to suspend a Shopify subscription. @param space_id @param suspension @param [Hash] opts the optional parameters @return [ShopifySubscriptionSuspension]
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_service_api.rb, line 281 def suspend(space_id, suspension, opts = {}) data, _status_code, _headers = suspend_with_http_info(space_id, suspension, opts) return data end
Suspend This operation allows to suspend a Shopify subscription. @param space_id @param suspension @param [Hash] opts the optional parameters @return [Array<(ShopifySubscriptionSuspension
, Fixnum, Hash)>] ShopifySubscriptionSuspension
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/shopify_subscription_suspension_service_api.rb, line 292 def suspend_with_http_info(space_id, suspension, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ShopifySubscriptionSuspensionService.suspend ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ShopifySubscriptionSuspensionService.suspend" if space_id.nil? # verify the required parameter 'suspension' is set fail ArgumentError, "Missing the required parameter 'suspension' when calling ShopifySubscriptionSuspensionService.suspend" if suspension.nil? # resource path local_var_path = "/shopify-subscription-suspension/suspend".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(suspension) 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 => 'ShopifySubscriptionSuspension') if @api_client.config.debugging @api_client.config.logger.debug "API called: ShopifySubscriptionSuspensionService#suspend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end