papierkram_api_client 0.3.1 → 0.4.1

data/lib/papierkram_api/v1/endpoints/contact/companies.rb

@@ -134,11 +134,62 @@ module PapierkramApi
             http_post("#{@url_api_path}/contact/companies", body)
           end
 
-          def update_by(id:, attributes: {})
+          def update_by( # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/ParameterLists
+            id:,
+            name: nil,
+            contact_type: nil,
+            phone: nil,
+            fax: nil,
+            email: nil,
+            website: nil,
+            twitter: nil,
+            ust_idnr: nil,
+            delivery_method: nil,
+            postal_street: nil,
+            postal_zip: nil,
+            postal_city: nil,
+            postal_country: nil,
+            physical_street: nil,
+            physical_zip: nil,
+            physical_city: nil,
+            physical_country: nil,
+            bank_account_no: nil,
+            bank_blz: nil,
+            bank_institute: nil,
+            bank_bic: nil,
+            bank_iban: nil,
+            notes: nil,
+            color: nil
+          )
             raise ArgumentError, 'id must be an Integer' unless id.is_a?(Integer)
-            raise ArgumentError, 'attributes must be a Hash' unless attributes.is_a?(Hash)
 
-            http_put("#{@url_api_path}/contact/companies/#{id}", attributes)
+            body = {}
+            body[:name] = name if name
+            body[:contact_type] = contact_type if contact_type
+            body[:phone] = phone if phone
+            body[:fax] = fax if fax
+            body[:email] = email if email
+            body[:website] = website if website
+            body[:twitter] = twitter if twitter
+            body[:ust_idnr] = ust_idnr if ust_idnr
+            body[:delivery_method] = delivery_method if delivery_method
+            body[:postal_street] = postal_street if postal_street
+            body[:postal_zip] = postal_zip if postal_zip
+            body[:postal_city] = postal_city if postal_city
+            body[:postal_country] = postal_country if postal_country
+            body[:physical_street] = physical_street if physical_street
+            body[:physical_zip] = physical_zip if physical_zip
+            body[:physical_city] = physical_city if physical_city
+            body[:physical_country] = physical_country if physical_country
+            body[:bank_account_no] = bank_account_no if bank_account_no
+            body[:bank_blz] = bank_blz if bank_blz
+            body[:bank_institute] = bank_institute if bank_institute
+            body[:bank_bic] = bank_bic if bank_bic
+            body[:bank_iban] = bank_iban if bank_iban
+            body[:notes] = notes if notes
+            body[:color] = color if color
+
+            http_put("#{@url_api_path}/contact/companies/#{id}", body)
           end
 
           def delete_by(id:)

data/lib/papierkram_api/v1/endpoints/contact/companies_persons.rb

@@ -54,12 +54,44 @@ module PapierkramApi
             http_post("#{@url_api_path}/contact/companies/#{company_id}/persons", body)
           end
 
-          def update_by(company_id:, id:, attributes: {})
-            raise ArgumentError, 'attributes must be a Hash' unless attributes.is_a?(Hash)
+          def update_by( # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/ParameterLists, Metrics/MethodLength
+            id:,
+            company_id:,
+            title: nil,
+            salutation: nil,
+            first_name: nil,
+            last_name: nil,
+            position: nil,
+            department: nil,
+            phone: nil,
+            skype: nil,
+            fax: nil,
+            email: nil,
+            flagged: nil,
+            mobile: nil,
+            comment: nil,
+            default: nil
+          )
             raise ArgumentError, 'company_id must be an Integer' unless company_id.is_a?(Integer)
             raise ArgumentError, 'id must be an Integer' unless id.is_a?(Integer)
 
-            http_put("#{@url_api_path}/contact/companies/#{company_id}/persons/#{id}", attributes)
+            body = {}
+            body[:title] = title if title
+            body[:salutation] = salutation if salutation
+            body[:first_name] = first_name if first_name
+            body[:last_name] = last_name if last_name
+            body[:position] = position if position
+            body[:department] = department if department
+            body[:phone] = phone if phone
+            body[:skype] = skype if skype
+            body[:fax] = fax if fax
+            body[:email] = email if email
+            body[:flagged] = flagged if flagged
+            body[:mobile] = mobile if mobile
+            body[:comment] = comment if comment
+            body[:default] = default if default
+
+            http_put("#{@url_api_path}/contact/companies/#{company_id}/persons/#{id}", body)
           end
 
           def delete_by(company_id:, id:)

data/lib/papierkram_api/v1/endpoints/expense/vouchers.rb

@@ -6,6 +6,8 @@ module PapierkramApi
       module Expense
         # This class is responsible for all the API calls related to expense vouchers.
         class Vouchers < PapierkramApi::V1::Endpoints::Base
+          ALLOWED_DIFFERENCE_REASONS = %w[sonstige mahnung teilzahlung skonto sonstige schmaelerung].freeze
+
           def find_by(id:, pdf: false)
             if pdf == true
               return get("#{@url_api_path}/expense/vouchers/#{id}/pdf", nil,
@@ -38,6 +40,154 @@ module PapierkramApi
 
             http_get("#{@url_api_path}/expense/vouchers", query)
           end
+
+          def create( # rubocop:disable Metrics/ParameterLists,Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
+            name:,
+            provenance:,
+            line_items:,
+            due_date: nil,
+            document_date: nil,
+            description: nil,
+            entertainment_reason: nil,
+            entertainment_persons: nil,
+            flagged: nil,
+            creditor_id: nil
+          )
+            body = {}
+            body[:name] = name
+            body[:line_items] = line_items
+            body[:provenance] = provenance
+
+            body[:due_date] = due_date if due_date
+            body[:document_date] = document_date if document_date
+            body[:description] = description if description
+            body[:entertainment_reason] = entertainment_reason if entertainment_reason
+            body[:entertainment_persons] = entertainment_persons if entertainment_persons
+            body[:flagged] = flagged if flagged
+            body[:creditor] = { id: creditor_id } if creditor_id
+
+            if entertainment_persons
+              raise ArgumentError, 'entertainment_persons must be an array' unless entertainment_persons.is_a?(Array)
+
+              unless entertainment_persons.all?(String)
+                raise ArgumentError,
+                      'entertainment_persons must be an array of strings'
+              end
+            end
+
+            if line_items
+              raise ArgumentError, 'line_items must be an array' unless line_items.is_a?(Array)
+              raise ArgumentError, 'line_items must be an array of hashes' unless line_items.all?(Hash)
+            end
+
+            http_post("#{@url_api_path}/expense/vouchers", body)
+          end
+
+          def update_by( # rubocop:disable Metrics/ParameterLists,Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+            id:,
+            name: nil,
+            due_date: nil,
+            document_date: nil,
+            description: nil,
+            entertainment_reason: nil,
+            entertainment_persons: nil,
+            flagged: nil,
+            provenance: nil,
+            creditor_id: nil,
+            line_items: nil
+          )
+            body = {}
+            body[:name] = name if name
+            body[:due_date] = due_date if due_date
+            body[:document_date] = document_date if document_date
+            body[:description] = description if description
+            body[:entertainment_reason] = entertainment_reason if entertainment_reason
+            body[:entertainment_persons] = entertainment_persons if entertainment_persons
+            body[:flagged] = flagged if flagged
+            body[:provenance] = provenance if provenance
+            body[:creditor] = { id: creditor_id } if creditor_id
+            body[:line_items] = line_items if line_items
+
+            if line_items
+              raise ArgumentError, 'line_items must be an array' unless line_items.is_a?(Array)
+              raise ArgumentError, 'line_items must be an array of hashes' unless line_items.all?(Hash)
+            end
+
+            http_put("#{@url_api_path}/expense/vouchers/#{id}", body)
+          end
+
+          def add_document_by(id:, path_to_file:, file_type:)
+            doc = Faraday::Multipart::FilePart.new(path_to_file, file_type)
+
+            http_post("#{@url_api_path}/expense/vouchers/#{id}/documents", { file: doc })
+          end
+
+          def delete_document_by(id:, document_id:)
+            http_delete("#{@url_api_path}/expense/vouchers/#{id}/documents/#{document_id}")
+          end
+
+          def delete_by(id:)
+            http_delete("#{@url_api_path}/expense/vouchers/#{id}")
+          end
+
+          def archive_by(id:)
+            http_post("#{@url_api_path}/expense/vouchers/#{id}/archive")
+          end
+
+          def unarchive_by(id:)
+            http_post("#{@url_api_path}/expense/vouchers/#{id}/unarchive")
+          end
+
+          def cancel_by(id:)
+            http_post("#{@url_api_path}/expense/vouchers/#{id}/cancel")
+          end
+
+          def cancel_with_reverse_entry_by(id:)
+            http_post("#{@url_api_path}/expense/vouchers/#{id}/cancel_with_reverse_entry")
+          end
+
+          def mark_as_paid_by(
+            id:,
+            value: nil,
+            payment_date: nil,
+            banking_transaction_id: nil,
+            difference_reason: nil
+          )
+            unless value || banking_transaction_id
+              raise ArgumentError, 'either value or banking_transaction_id must be given'
+            end
+
+            body = {}
+
+            if value
+              validate_value!(value)
+              body[:value] = value
+            end
+
+            if difference_reason
+              validate_difference_reason!(difference_reason)
+              body[:difference_reason] = difference_reason
+            end
+
+            body[:payment_date] = payment_date if payment_date
+            body[:banking_transaction] = { id: banking_transaction_id } if banking_transaction_id
+
+            http_post("#{@url_api_path}/expense/vouchers/#{id}/pay", body)
+          end
+
+          private
+
+          def validate_value!(value)
+            raise ArgumentError, 'value must be a float' unless value.is_a?(Numeric)
+          end
+
+          def validate_difference_reason!(difference_reason)
+            raise ArgumentError, 'difference_reason must be a string' unless difference_reason.is_a?(String)
+
+            return if ALLOWED_DIFFERENCE_REASONS.include?(difference_reason)
+
+            raise ArgumentError, "difference_reason must be one of: #{ALLOWED_DIFFERENCE_REASONS.join(', ')}"
+          end
         end
       end
     end

data/lib/papierkram_api/v1/endpoints/income/invoices.rb

@@ -6,6 +6,8 @@ module PapierkramApi
       module Income
         # This class is responsible for all the API calls related to income invoices.
         class Invoices < PapierkramApi::V1::Endpoints::Base
+          ALLOWED_SEND_VIA = %i[email pdf].freeze
+
           def find_by(id:, pdf: false)
             if pdf == true
               return http_get(
@@ -18,14 +20,16 @@ module PapierkramApi
             http_get("#{@url_api_path}/income/invoices/#{id}")
           end
 
-          def all(page: 1, # rubocop:disable Metrics/CyclomaticComplexity
-                  page_size: 100,
-                  order_by: nil,
-                  order_direction: nil,
-                  creditor_id: nil,
-                  project_id: nil,
-                  document_date_range_start: nil,
-                  document_date_range_end: nil)
+          def all( # rubocop:disable Metrics/CyclomaticComplexity
+            page: 1,
+            page_size: 100,
+            order_by: nil,
+            order_direction: nil,
+            creditor_id: nil,
+            project_id: nil,
+            document_date_range_start: nil,
+            document_date_range_end: nil
+          )
             query = {
               page: page,
               page_size: page_size
@@ -42,6 +46,148 @@ module PapierkramApi
 
             http_get("#{@url_api_path}/income/invoices", query)
           end
+
+          def create( # rubocop:disable Metrics/ParameterLists,Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+            name:,
+            line_items:,
+            payment_term_id:,
+            description: nil,
+            flagged: nil,
+            document_date: nil,
+            supply_date: nil,
+            customer_id: nil,
+            contact_person_id: nil,
+            project_id: nil,
+            custom_template_id: nil,
+            billing_company: nil,
+            billing_department: nil,
+            billing_contact_person: nil,
+            billing_street: nil,
+            billing_zip: nil,
+            billing_city: nil,
+            billing_country: nil,
+            billing_ust_idnr: nil,
+            billing_email: nil
+          )
+            body = {}
+            body[:name] = name
+            body[:line_items] = line_items
+            body[:payment_term] = { id: payment_term_id }
+            body[:description] = description if description
+            body[:flagged] = flagged if flagged
+            body[:document_date] = document_date if document_date
+            body[:supply_date] = supply_date if supply_date
+            body[:customer] = { id: customer_id } if customer_id
+            body[:customer][:contact_person] = { id: contact_person_id } if contact_person_id
+            body[:customer][:project] = { id: project_id } if project_id
+            body[:custom_template] = { id: custom_template_id } if custom_template_id
+
+            body[:billing] = {}
+            body[:billing][:company] = billing_company if billing_company
+            body[:billing][:department] = billing_department if billing_department
+            body[:billing][:contact_person] = billing_contact_person if billing_contact_person
+            body[:billing][:street] = billing_street if billing_street
+            body[:billing][:zip] = billing_zip if billing_zip
+            body[:billing][:city] = billing_city if billing_city
+            body[:billing][:country] = billing_country if billing_country
+            body[:billing][:ust_idnr] = billing_ust_idnr if billing_ust_idnr
+            body[:billing][:email] = billing_email if billing_email
+
+            http_post("#{@url_api_path}/income/invoices", body)
+          end
+
+          def update_by( # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity,Metrics/ParameterLists
+            id:,
+            name: nil,
+            line_items: nil,
+            payment_term_id: nil,
+            description: nil,
+            flagged: nil,
+            document_date: nil,
+            supply_date: nil,
+            customer_id: nil,
+            contact_person_id: nil,
+            project_id: nil,
+            custom_template_id: nil,
+            billing_company: nil,
+            billing_department: nil,
+            billing_contact_person: nil,
+            billing_street: nil,
+            billing_zip: nil,
+            billing_city: nil,
+            billing_country: nil,
+            billing_ust_idnr: nil,
+            billing_email: nil
+          )
+            body = {}
+            body[:name] = name if name
+            body[:line_items] = line_items if line_items
+            body[:payment_term] = { id: payment_term_id } if payment_term_id
+            body[:description] = description if description
+            body[:flagged] = flagged if flagged
+            body[:document_date] = document_date if document_date
+            body[:supply_date] = supply_date if supply_date
+            body[:customer] = { id: customer_id } if customer_id
+            body[:customer][:contact_person] = { id: contact_person_id } if contact_person_id
+            body[:customer][:project] = { id: project_id } if project_id
+            body[:custom_template] = { id: custom_template_id } if custom_template_id
+
+            body[:billing] = {}
+            body[:billing][:company] = billing_company if billing_company
+            body[:billing][:department] = billing_department if billing_department
+            body[:billing][:contact_person] = billing_contact_person if billing_contact_person
+            body[:billing][:street] = billing_street if billing_street
+            body[:billing][:zip] = billing_zip if billing_zip
+            body[:billing][:city] = billing_city if billing_city
+            body[:billing][:country] = billing_country if billing_country
+            body[:billing][:ust_idnr] = billing_ust_idnr if billing_ust_idnr
+            body[:billing][:email] = billing_email if billing_email
+
+            http_put("#{@url_api_path}/income/invoices/#{id}", body)
+          end
+
+          def deliver_by( # rubocop:disable Metrics/AbcSize
+            id:,
+            email_recipient: nil,
+            email_subject: nil,
+            email_body: nil,
+            send_via: :pdf
+          )
+
+            raise ArgumentError, 'send_via must be :email or :pdf' unless ALLOWED_SEND_VIA.include?(send_via)
+
+            body = {}
+            body[:send_via] = send_via
+
+            if send_via == :email
+              if email_recipient.nil? || email_subject.nil? || email_body.nil?
+                raise ArgumentError, 'email_recipient, email_subject and email_body must be set'
+              end
+
+              body[:email] = {}
+              body[:email][:recipient] = email_recipient
+              body[:email][:subject] = email_subject
+              body[:email][:body] = email_body
+            end
+
+            http_post("#{@url_api_path}/income/invoices/#{id}/deliver", body)
+          end
+
+          def delete_by(id:)
+            http_delete("#{@url_api_path}/income/invoices/#{id}")
+          end
+
+          def archive_by(id:)
+            http_post("#{@url_api_path}/income/invoices/#{id}/archive")
+          end
+
+          def unarchive_by(id:)
+            http_post("#{@url_api_path}/income/invoices/#{id}/unarchive")
+          end
+
+          def cancel_by(id:)
+            http_post("#{@url_api_path}/income/invoices/#{id}/cancel")
+          end
         end
       end
     end

data/lib/papierkram_api/v1/endpoints/income/payment_terms.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module PapierkramApi
+  module V1
+    module Endpoints
+      module Income
+        # This class is responsible for all the API calls related to income propositions.
+        class PaymentTerms < PapierkramApi::V1::Endpoints::Base
+          def find_by(id:)
+            http_get("#{@url_api_path}/income/payment_terms/#{id}")
+          end
+
+          def all(page: 1,
+                  page_size: 100,
+                  order_by: nil,
+                  order_direction: nil)
+            query = {
+              page: page,
+              page_size: page_size
+            }
+            query[:order_by] = order_by if order_by
+            query[:order_direction] = order_direction if order_direction
+
+            http_get("#{@url_api_path}/income/payment_terms", query)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/papierkram_api/v1/endpoints/income/propositions.rb

@@ -27,21 +27,37 @@ module PapierkramApi
             body = {}
             body[:name] = name
             body[:article_no] = article_no
+
+            body[:proposition_type] = proposition_type if proposition_type
             body[:description] = description if description
             body[:time_unit] = time_unit if time_unit
-            body[:proposition_type] = proposition_type if proposition_type
-            body[:price] = price if price
             body[:vat_rate] = vat_rate if vat_rate
+            body[:price] = price if price
 
             http_post("#{@url_api_path}/income/propositions", body)
           end
 
-          def update_by(id:, attributes: {})
-            if attributes[:vat_rate] && (attributes[:vat_rate].empty? || !attributes[:vat_rate].include?('%'))
-              raise ArgumentError, 'vat_rate must be a percentage and include a % sign'
-            end
+          def update_by( # rubocop:disable Metrics/CyclomaticComplexity
+            id:,
+            name: nil,
+            description: nil,
+            article_no: nil,
+            price: nil,
+            proposition_type: nil,
+            time_unit: nil,
+            vat_rate: nil
+          )
+
+            body = {}
+            body[:name] = name if name
+            body[:description] = description if description
+            body[:article_no] = article_no if article_no
+            body[:price] = price if price
+            body[:proposition_type] = proposition_type if proposition_type
+            body[:time_unit] = time_unit if time_unit
+            body[:vat_rate] = vat_rate if vat_rate
 
-            http_put("#{@url_api_path}/income/propositions/#{id}", attributes)
+            http_put("#{@url_api_path}/income/propositions/#{id}", body)
           end
 
           def delete_by(id:)

data/lib/papierkram_api/v1/endpoints/projects.rb

@@ -55,10 +55,39 @@ module PapierkramApi
           http_post("#{@url_api_path}/projects", body)
         end
 
-        def update_by(id:, attributes: {})
-          raise ArgumentError, 'attributes must be a Hash' unless attributes.is_a?(Hash)
+        def update_by( # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/ParameterLists
+          id:,
+          name: nil,
+          customer_id: nil,
+          description: nil,
+          start_date: nil,
+          end_date: nil,
+          flagged: nil,
+          budget_type: nil,
+          budget_money: nil,
+          budget_time: nil,
+          budget_time_unit: nil,
+          color: nil,
+          default_proposition: nil,
+          team_members: nil
+        )
+
+          body = {}
+          body[:name] = name if name
+          body[:customer] = { id: customer_id } if customer_id
+          body[:description] = description if description
+          body[:start_date] = start_date if start_date
+          body[:end_date] = end_date if end_date
+          body[:flagged] = flagged if flagged
+          body[:budget_type] = budget_type if budget_type
+          body[:budget_money] = budget_money if budget_money
+          body[:budget_time] = budget_time if budget_time
+          body[:budget_time_unit] = budget_time_unit if budget_time_unit
+          body[:color] = color if color
+          body[:default_proposition] = default_proposition if default_proposition
+          body[:team_members] = team_members if team_members
 
-          http_put("#{@url_api_path}/projects/#{id}", attributes)
+          http_put("#{@url_api_path}/projects/#{id}", body)
         end
 
         def delete_by(id:)

data/lib/papierkram_api/v1/endpoints/tracker/tasks.rb

@@ -26,6 +26,69 @@ module PapierkramApi
             query[:proposition_id] = proposition_id if proposition_id
             http_get("#{@url_api_path}/tracker/tasks", query)
           end
+
+          def create(
+            name:,
+            project_id:,
+            proposition_id: nil,
+            deadline: nil,
+            relative_costs: nil,
+            complete: nil,
+            flagged: nil,
+            user_id: nil
+          )
+            body = {}
+            body[:name] = name
+            body[:project] = { id: project_id }
+            body[:proposition] = { id: proposition_id } if proposition_id
+            body[:deadline] = deadline if deadline
+            body[:relative_costs] = relative_costs if relative_costs
+            body[:complete] = complete if complete
+            body[:flagged] = flagged if flagged
+            body[:user] = { id: user_id } if user_id
+
+            http_post("#{@url_api_path}/tracker/tasks", body)
+          end
+
+          def update_by( # rubocop:disable Metrics/ParameterLists
+            id:,
+            name:,
+            project_id:,
+            proposition_id: nil,
+            deadline: nil,
+            relative_costs: nil,
+            complete: nil,
+            flagged: nil,
+            user_id: nil
+          )
+            body = {}
+            body[:name] = name
+            body[:project] = { id: project_id }
+            body[:proposition] = { id: proposition_id } if proposition_id
+            body[:deadline] = deadline if deadline
+            body[:relative_costs] = relative_costs if relative_costs
+            body[:complete] = complete if complete
+            body[:flagged] = flagged if flagged
+            body[:user] = { id: user_id } if user_id
+
+            http_put("#{@url_api_path}/tracker/tasks/#{id}", body)
+          end
+
+          def delete_by(id:)
+            http_delete("#{@url_api_path}/tracker/tasks/#{id}")
+          end
+
+          def archive_by(id:)
+            raise ArgumentError, 'id must be an Integer' unless id.is_a?(Integer)
+
+            http_post("#{@url_api_path}/tracker/tasks/#{id}/archive")
+          end
+
+          def unarchive_by(id:)
+            raise ArgumentError, 'id must be an Integer' unless id.is_a?(Integer)
+
+            http_post("#{@url_api_path}/tracker/tasks/#{id}/unarchive")
+          end
         end
       end
     end