wallee-ruby-sdk 6.3.0 → 7.0.0

data/lib/wallee-ruby-sdk/service/invoice_reconciliation_record_invoice_links_service.rb

@@ -0,0 +1,453 @@
+=begin
+# Wallee AG Ruby SDK
+#
+# This library allows to interact with the Wallee AG payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://en.wallee.com
+# Developer email: ecosystem-team@wallee.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+=end
+
+require 'cgi'
+
+module WalleeRubySdk
+  class InvoiceReconciliationRecordInvoiceLinksService
+    attr_accessor :api_client
+
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List all invoice reconciliation record invoice links
+    # @param space [Integer] Specifies the ID of the space the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :after Set to an object's ID to retrieve the page of objects coming immediately after the named object.
+    # @option opts [Integer] :before Set to an object's ID to retrieve the page of objects coming immediately before the named object.
+    # @option opts [Array<String>] :expand 
+    # @option opts [Integer] :limit A limit on the number of objects to be returned, between 1 and 100. Default is 10.
+    # @option opts [SortingOrder] :order Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
+    # @return [InvoiceReconciliationRecordInvoiceLinkListResponse]
+    def get_payment_invoice_reconciliation_record_invoice_links(space, opts = {})
+      data, _status_code, _headers = get_payment_invoice_reconciliation_record_invoice_links_with_http_info(space, opts)
+      data
+    end
+
+    # List all invoice reconciliation record invoice links
+
+    # @param space [Integer] Specifies the ID of the space the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :after Set to an object&#39;s ID to retrieve the page of objects coming immediately after the named object.
+    # @option opts [Integer] :before Set to an object&#39;s ID to retrieve the page of objects coming immediately before the named object.
+    # @option opts [Array<String>] :expand 
+    # @option opts [Integer] :limit A limit on the number of objects to be returned, between 1 and 100. Default is 10.
+    # @option opts [SortingOrder] :order Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
+    # @return [Array<(InvoiceReconciliationRecordInvoiceLinkListResponse, Integer, Hash)>] InvoiceReconciliationRecordInvoiceLinkListResponse data, response status code and response headers
+    def get_payment_invoice_reconciliation_record_invoice_links_with_http_info(space, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links ...'
+      end
+      # verify the required parameter 'space' is set
+      if @api_client.config.client_side_validation && space.nil?
+        fail ArgumentError, "Missing the required parameter 'space' when calling InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links"
+      end
+      if @api_client.config.client_side_validation && !opts[:'after'].nil? && opts[:'after'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"after"]" when calling InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'before'].nil? && opts[:'before'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"before"]" when calling InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/payment/invoice-reconciliation-record-invoice-links'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'space'] = space
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # connection timeout
+      connection_timeout = @api_client.config.timeout
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvoiceReconciliationRecordInvoiceLinkListResponse'
+
+      new_options = opts.merge(
+        :operation => :"InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InvoiceReconciliationRecordInvoiceLinksService#get_payment_invoice_reconciliation_record_invoice_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Retrieve an invoice reconciliation record invoice link
+    # @param id [Integer] 
+    # @param space [Integer] Specifies the ID of the space the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand 
+    # @return [InvoiceReconciliationRecordInvoiceLink]
+    def get_payment_invoice_reconciliation_record_invoice_links_id(id, space, opts = {})
+      data, _status_code, _headers = get_payment_invoice_reconciliation_record_invoice_links_id_with_http_info(id, space, opts)
+      data
+    end
+
+    # Retrieve an invoice reconciliation record invoice link
+
+    # @param id [Integer] 
+    # @param space [Integer] Specifies the ID of the space the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand 
+    # @return [Array<(InvoiceReconciliationRecordInvoiceLink, Integer, Hash)>] InvoiceReconciliationRecordInvoiceLink data, response status code and response headers
+    def get_payment_invoice_reconciliation_record_invoice_links_id_with_http_info(id, space, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links_id ...'
+      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 InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links_id"
+      end
+      # verify the required parameter 'space' is set
+      if @api_client.config.client_side_validation && space.nil?
+        fail ArgumentError, "Missing the required parameter 'space' when calling InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links_id"
+      end
+      # resource path
+      local_var_path = '/payment/invoice-reconciliation-record-invoice-links/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'space'] = space
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # connection timeout
+      connection_timeout = @api_client.config.timeout
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvoiceReconciliationRecordInvoiceLink'
+
+      new_options = opts.merge(
+        :operation => :"InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InvoiceReconciliationRecordInvoiceLinksService#get_payment_invoice_reconciliation_record_invoice_links_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Search invoice reconciliation record invoice links
+    # @param space [Integer] Specifies the ID of the space the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand 
+    # @option opts [Integer] :limit A limit on the number of objects to be returned, between 1 and 100. Default is 10.
+    # @option opts [Integer] :offset A cursor for pagination, specifies the number of objects to skip.
+    # @option opts [String] :order The fields and order to sort the objects by.
+    # @option opts [String] :query The search query to filter the objects by.
+    # @return [InvoiceReconciliationRecordInvoiceLinkSearchResponse]
+    def get_payment_invoice_reconciliation_record_invoice_links_search(space, opts = {})
+      data, _status_code, _headers = get_payment_invoice_reconciliation_record_invoice_links_search_with_http_info(space, opts)
+      data
+    end
+
+    # Search invoice reconciliation record invoice links
+
+    # @param space [Integer] Specifies the ID of the space the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand 
+    # @option opts [Integer] :limit A limit on the number of objects to be returned, between 1 and 100. Default is 10.
+    # @option opts [Integer] :offset A cursor for pagination, specifies the number of objects to skip.
+    # @option opts [String] :order The fields and order to sort the objects by.
+    # @option opts [String] :query The search query to filter the objects by.
+    # @return [Array<(InvoiceReconciliationRecordInvoiceLinkSearchResponse, Integer, Hash)>] InvoiceReconciliationRecordInvoiceLinkSearchResponse data, response status code and response headers
+    def get_payment_invoice_reconciliation_record_invoice_links_search_with_http_info(space, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links_search ...'
+      end
+      # verify the required parameter 'space' is set
+      if @api_client.config.client_side_validation && space.nil?
+        fail ArgumentError, "Missing the required parameter 'space' when calling InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links_search"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links_search, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links_search, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 10000
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links_search, must be smaller than or equal to 10000.'
+      end
+
+      # resource path
+      local_var_path = '/payment/invoice-reconciliation-record-invoice-links/search'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+      query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'space'] = space
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # connection timeout
+      connection_timeout = @api_client.config.timeout
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvoiceReconciliationRecordInvoiceLinkSearchResponse'
+
+      new_options = opts.merge(
+        :operation => :"InvoiceReconciliationRecordInvoiceLinksService.get_payment_invoice_reconciliation_record_invoice_links_search",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InvoiceReconciliationRecordInvoiceLinksService#get_payment_invoice_reconciliation_record_invoice_links_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Link an invoice
+    # Links the invoice reconciliation record with the provided invoice completion.
+    # @param record_id [Integer] The ID of the invoice reconciliation record which should be linked.
+    # @param completion_id [Integer] The ID of the completion which should be linked.
+    # @param space [Integer] Specifies the ID of the space the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :amount The amount of the invoice reconciliation record linked completion. When omitted the amount is calculated.
+    # @option opts [Array<String>] :expand 
+    # @return [InvoiceReconciliationRecordInvoiceLink]
+    def post_payment_invoice_reconciliation_record_invoice_links(record_id, completion_id, space, opts = {})
+      data, _status_code, _headers = post_payment_invoice_reconciliation_record_invoice_links_with_http_info(record_id, completion_id, space, opts)
+      data
+    end
+
+    # Link an invoice
+    # Links the invoice reconciliation record with the provided invoice completion.
+
+    # @param record_id [Integer] The ID of the invoice reconciliation record which should be linked.
+    # @param completion_id [Integer] The ID of the completion which should be linked.
+    # @param space [Integer] Specifies the ID of the space the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :amount The amount of the invoice reconciliation record linked completion. When omitted the amount is calculated.
+    # @option opts [Array<String>] :expand 
+    # @return [Array<(InvoiceReconciliationRecordInvoiceLink, Integer, Hash)>] InvoiceReconciliationRecordInvoiceLink data, response status code and response headers
+    def post_payment_invoice_reconciliation_record_invoice_links_with_http_info(record_id, completion_id, space, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvoiceReconciliationRecordInvoiceLinksService.post_payment_invoice_reconciliation_record_invoice_links ...'
+      end
+      # verify the required parameter 'record_id' is set
+      if @api_client.config.client_side_validation && record_id.nil?
+        fail ArgumentError, "Missing the required parameter 'record_id' when calling InvoiceReconciliationRecordInvoiceLinksService.post_payment_invoice_reconciliation_record_invoice_links"
+      end
+      # verify the required parameter 'completion_id' is set
+      if @api_client.config.client_side_validation && completion_id.nil?
+        fail ArgumentError, "Missing the required parameter 'completion_id' when calling InvoiceReconciliationRecordInvoiceLinksService.post_payment_invoice_reconciliation_record_invoice_links"
+      end
+      # verify the required parameter 'space' is set
+      if @api_client.config.client_side_validation && space.nil?
+        fail ArgumentError, "Missing the required parameter 'space' when calling InvoiceReconciliationRecordInvoiceLinksService.post_payment_invoice_reconciliation_record_invoice_links"
+      end
+      # resource path
+      local_var_path = '/payment/invoice-reconciliation-record-invoice-links'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'recordId'] = record_id
+      query_params[:'completionId'] = completion_id
+      query_params[:'amount'] = opts[:'amount'] if !opts[:'amount'].nil?
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'space'] = space
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # connection timeout
+      connection_timeout = @api_client.config.timeout
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvoiceReconciliationRecordInvoiceLink'
+
+      new_options = opts.merge(
+        :operation => :"InvoiceReconciliationRecordInvoiceLinksService.post_payment_invoice_reconciliation_record_invoice_links",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InvoiceReconciliationRecordInvoiceLinksService#post_payment_invoice_reconciliation_record_invoice_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Unlink an invoice
+    # Unlinks the invoice reconciliation record from the provided invoice completion.
+    # @param record_id [Integer] The ID of the invoice reconciliation record which should be unlinked.
+    # @param completion_id [Integer] The ID of the completion which should be unlinked.
+    # @param space [Integer] Specifies the ID of the space the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def post_payment_invoice_reconciliation_record_invoice_links_unlink(record_id, completion_id, space, opts = {})
+      post_payment_invoice_reconciliation_record_invoice_links_unlink_with_http_info(record_id, completion_id, space, opts)
+      nil
+    end
+
+    # Unlink an invoice
+    # Unlinks the invoice reconciliation record from the provided invoice completion.
+
+    # @param record_id [Integer] The ID of the invoice reconciliation record which should be unlinked.
+    # @param completion_id [Integer] The ID of the completion which should be unlinked.
+    # @param space [Integer] Specifies the ID of the space the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_payment_invoice_reconciliation_record_invoice_links_unlink_with_http_info(record_id, completion_id, space, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvoiceReconciliationRecordInvoiceLinksService.post_payment_invoice_reconciliation_record_invoice_links_unlink ...'
+      end
+      # verify the required parameter 'record_id' is set
+      if @api_client.config.client_side_validation && record_id.nil?
+        fail ArgumentError, "Missing the required parameter 'record_id' when calling InvoiceReconciliationRecordInvoiceLinksService.post_payment_invoice_reconciliation_record_invoice_links_unlink"
+      end
+      # verify the required parameter 'completion_id' is set
+      if @api_client.config.client_side_validation && completion_id.nil?
+        fail ArgumentError, "Missing the required parameter 'completion_id' when calling InvoiceReconciliationRecordInvoiceLinksService.post_payment_invoice_reconciliation_record_invoice_links_unlink"
+      end
+      # verify the required parameter 'space' is set
+      if @api_client.config.client_side_validation && space.nil?
+        fail ArgumentError, "Missing the required parameter 'space' when calling InvoiceReconciliationRecordInvoiceLinksService.post_payment_invoice_reconciliation_record_invoice_links_unlink"
+      end
+      # resource path
+      local_var_path = '/payment/invoice-reconciliation-record-invoice-links/unlink'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'recordId'] = record_id
+      query_params[:'completionId'] = completion_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'space'] = space
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # connection timeout
+      connection_timeout = @api_client.config.timeout
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      new_options = opts.merge(
+        :operation => :"InvoiceReconciliationRecordInvoiceLinksService.post_payment_invoice_reconciliation_record_invoice_links_unlink",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InvoiceReconciliationRecordInvoiceLinksService#post_payment_invoice_reconciliation_record_invoice_links_unlink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+      end
+      return data, status_code, headers
+    end
+
+  end
+end