korona-cloud-client 1.0.3 → 1.0.7

data/lib/korona-cloud-client/api/promotions_api.rb

@@ -0,0 +1,520 @@
+=begin
+#KORONA.cloud API v3
+
+#Our api provides access to our cloud services
+
+The version of the OpenAPI document: 2.17.26
+Contact: support@combase.net
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1
+
+=end
+
+require 'cgi'
+
+module KoronaCloudClient
+  class PromotionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # adds a batch of new promotions
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param body [Array<Promotion>] array of new promotions
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :upsert when set to true, updates the object instead of generating a already-exists-error
+    # @return [Array<AddOrUpdateResult>]
+    def add_promotions(korona_account_id, body, opts = {})
+      data, _status_code, _headers = add_promotions_with_http_info(korona_account_id, body, opts)
+      data
+    end
+
+    # adds a batch of new promotions
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param body [Array<Promotion>] array of new promotions
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :upsert when set to true, updates the object instead of generating a already-exists-error
+    # @return [Array<(Array<AddOrUpdateResult>, Integer, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
+    def add_promotions_with_http_info(korona_account_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PromotionsApi.add_promotions ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PromotionsApi.add_promotions"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling PromotionsApi.add_promotions"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/promotions'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil?
+
+      # header parameters
+      header_params = opts[: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 = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PromotionsApi.add_promotions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PromotionsApi#add_promotions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # deletes the single promotion
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param promotion_id [String] id of the related object (important: id should match the uuid-format)
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_promotion(korona_account_id, promotion_id, opts = {})
+      delete_promotion_with_http_info(korona_account_id, promotion_id, opts)
+      nil
+    end
+
+    # deletes the single promotion
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param promotion_id [String] id of the related object (important: id should match the uuid-format)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_promotion_with_http_info(korona_account_id, promotion_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PromotionsApi.delete_promotion ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PromotionsApi.delete_promotion"
+      end
+      # verify the required parameter 'promotion_id' is set
+      if @api_client.config.client_side_validation && promotion_id.nil?
+        fail ArgumentError, "Missing the required parameter 'promotion_id' when calling PromotionsApi.delete_promotion"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/promotions/{promotionId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'promotionId' + '}', CGI.escape(promotion_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PromotionsApi.delete_promotion",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PromotionsApi#delete_promotion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # deletes a batch of promotions
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param body [Array<Promotion>] array of existing promotions (id or number  required)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<AddOrUpdateResult>]
+    def delete_promotions(korona_account_id, body, opts = {})
+      data, _status_code, _headers = delete_promotions_with_http_info(korona_account_id, body, opts)
+      data
+    end
+
+    # deletes a batch of promotions
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param body [Array<Promotion>] array of existing promotions (id or number  required)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<AddOrUpdateResult>, Integer, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
+    def delete_promotions_with_http_info(korona_account_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PromotionsApi.delete_promotions ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PromotionsApi.delete_promotions"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling PromotionsApi.delete_promotions"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/promotions'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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 = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PromotionsApi.delete_promotions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PromotionsApi#delete_promotions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # returns the single promotion
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param promotion_id [String] id of the related object (important: id should match the uuid-format)
+    # @param [Hash] opts the optional parameters
+    # @return [Promotion]
+    def get_promotion(korona_account_id, promotion_id, opts = {})
+      data, _status_code, _headers = get_promotion_with_http_info(korona_account_id, promotion_id, opts)
+      data
+    end
+
+    # returns the single promotion
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param promotion_id [String] id of the related object (important: id should match the uuid-format)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Promotion, Integer, Hash)>] Promotion data, response status code and response headers
+    def get_promotion_with_http_info(korona_account_id, promotion_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PromotionsApi.get_promotion ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PromotionsApi.get_promotion"
+      end
+      # verify the required parameter 'promotion_id' is set
+      if @api_client.config.client_side_validation && promotion_id.nil?
+        fail ArgumentError, "Missing the required parameter 'promotion_id' when calling PromotionsApi.get_promotion"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/promotions/{promotionId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'promotionId' + '}', CGI.escape(promotion_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Promotion'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PromotionsApi.get_promotion",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PromotionsApi#get_promotion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # lists all promotions
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page number of the page to fetch
+    # @option opts [Integer] :size amount of objects to return per page
+    # @option opts [String] :sort attribute to sort by (multiple separated by comma; max. 5)
+    # @option opts [Integer] :revision last revision number, objects with a greater revision than this will be returned
+    # @option opts [Boolean] :include_deleted indicates deleted objects should be loaded or not (default: false)
+    # @option opts [String] :number number of the related object
+    # @return [ResultListPromotion]
+    def get_promotions(korona_account_id, opts = {})
+      data, _status_code, _headers = get_promotions_with_http_info(korona_account_id, opts)
+      data
+    end
+
+    # lists all promotions
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page number of the page to fetch
+    # @option opts [Integer] :size amount of objects to return per page
+    # @option opts [String] :sort attribute to sort by (multiple separated by comma; max. 5)
+    # @option opts [Integer] :revision last revision number, objects with a greater revision than this will be returned
+    # @option opts [Boolean] :include_deleted indicates deleted objects should be loaded or not (default: false)
+    # @option opts [String] :number number of the related object
+    # @return [Array<(ResultListPromotion, Integer, Hash)>] ResultListPromotion data, response status code and response headers
+    def get_promotions_with_http_info(korona_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PromotionsApi.get_promotions ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PromotionsApi.get_promotions"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/promotions'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
+      query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
+      query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ResultListPromotion'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PromotionsApi.get_promotions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PromotionsApi#get_promotions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # updates the single promotion
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param promotion_id [String] id of the related object (important: id should match the uuid-format)
+    # @param body [Promotion] the properties to update of the promotion
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_promotion(korona_account_id, promotion_id, body, opts = {})
+      update_promotion_with_http_info(korona_account_id, promotion_id, body, opts)
+      nil
+    end
+
+    # updates the single promotion
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param promotion_id [String] id of the related object (important: id should match the uuid-format)
+    # @param body [Promotion] the properties to update of the promotion
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def update_promotion_with_http_info(korona_account_id, promotion_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PromotionsApi.update_promotion ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PromotionsApi.update_promotion"
+      end
+      # verify the required parameter 'promotion_id' is set
+      if @api_client.config.client_side_validation && promotion_id.nil?
+        fail ArgumentError, "Missing the required parameter 'promotion_id' when calling PromotionsApi.update_promotion"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling PromotionsApi.update_promotion"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/promotions/{promotionId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'promotionId' + '}', CGI.escape(promotion_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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 = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PromotionsApi.update_promotion",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PromotionsApi#update_promotion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # updates a batch of promotions
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param body [Array<Promotion>] array of existing promotions (id or number  required)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<AddOrUpdateResult>]
+    def update_promotions(korona_account_id, body, opts = {})
+      data, _status_code, _headers = update_promotions_with_http_info(korona_account_id, body, opts)
+      data
+    end
+
+    # updates a batch of promotions
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param body [Array<Promotion>] array of existing promotions (id or number  required)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<AddOrUpdateResult>, Integer, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
+    def update_promotions_with_http_info(korona_account_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PromotionsApi.update_promotions ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PromotionsApi.update_promotions"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling PromotionsApi.update_promotions"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/promotions'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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 = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PromotionsApi.update_promotions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PromotionsApi#update_promotions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end