papierkram_api_client 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c711543eff8d01b4052e9de92dc9d3a4f436107c71c9944ab63d5943d28d73a9
-  data.tar.gz: 156999ce0d5031096ee95cf034849bc7f3b7bf29c3321daec47cd75f228391b7
+  metadata.gz: a1a03790a5079d46fc57b6efa84682046fbfd4f4e916e68fd9e4132863dc07c3
+  data.tar.gz: b6edd7e886bcaf9a9f761fec07494c2f6e292f77b946e0fc2f2ee33b8228d60e
 SHA512:
-  metadata.gz: 0104eda136279d4c82cf0671d1e5c64650f9eeda00a5b26813bd16f85756168747816b68a0a1c576f9a513a10d7e133b99055a9aab75240395ce0cfdc3867f2e
-  data.tar.gz: 377a731d8eaadc2016d264390963fcb995673815a35053c5ee9ee3c1bb83b783a77fda9568db2b15149df69f8c752636521bde07009ee773c46c301dd1fa6b50
+  metadata.gz: 299c6bcf0f35da94d1e1e6298f2aee5cc70b4eaddc3abe2e36fd051a3286290f9182f87331debc8c79f4ddca429f4fbb14aa4a95c0276fa857177165ab7ac36f
+  data.tar.gz: df625c5ce0e31b68b4ebcbd80e681d58674396843c43f5631544891b6e8eeeef1e788d19b38930e3cd4555755444b5e7430ebee7610df2550d22225d136df2b5

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+[0.2.3] - 2023-06-29
+
+### Added
+
+- [#47](https://github.com/simonneutert/papierkram_api_client/pull/47) Adds CRUD endpoint support for income propositions. [@simonneutert](https://github.com/simonneutert)
+- [#46](https://github.com/simonneutert/papierkram_api_client/pull/46) Adds CRUD endpoint support for projects. [@simonneutert](https://github.com/simonneutert)
+- [#45](https://github.com/simonneutert/papierkram_api_client/pull/45) Adds CRUD endpoint support for contact companies persons. [@simonneutert](https://github.com/simonneutert)
+
 ## [0.2.2] - 2023-06-28
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    papierkram_api_client (0.2.2)
+    papierkram_api_client (0.2.3)
       faraday (~> 2.7)
       httpx (>= 0.22.5, < 0.25.0)
 

data/README.md

@@ -77,6 +77,9 @@ Ziele:
   - [Contact::Company (Kontaktperson eines Unternehmens)](#contactcompany-kontaktperson-eines-unternehmens)
     - [alle Kontaktpersonen (eines Unternehmens)](#alle-kontaktpersonen-eines-unternehmens)
     - [eine Kontaktperson (eines Unternehmens)](#eine-kontaktperson-eines-unternehmens)
+    - [erstelle eine Kontaktperson (eines Unternehmens)](#erstelle-eine-kontaktperson-eines-unternehmens)
+    - [aktualisiere eine Kontaktperson (eines Unternehmens)](#aktualisiere-eine-kontaktperson-eines-unternehmens)
+    - [lösche eine Kontaktperson (eines Unternehmens)](#lösche-eine-kontaktperson-eines-unternehmens)
   - [Expense::Voucher (Ausgabe Beleg)](#expensevoucher-ausgabe-beleg)
     - [alle Ausgabe Belege](#alle-ausgabe-belege)
     - [einen Ausgabe Beleg](#einen-ausgabe-beleg)
@@ -92,10 +95,20 @@ Ziele:
   - [Income::Proposition (Waren / Dienstleistungen)](#incomeproposition-waren--dienstleistungen)
     - [alle Waren / Dienstleistungen](#alle-waren--dienstleistungen)
     - [eine Ware / Dienstleistung](#eine-ware--dienstleistung)
+    - [eine Ware / Dienstleistung erstellen](#eine-ware--dienstleistung-erstellen)
+    - [eine Ware / Dienstleistung aktualisieren](#eine-ware--dienstleistung-aktualisieren)
+    - [eine Ware / Dienstleistung löschen](#eine-ware--dienstleistung-löschen)
+    - [eine Ware / Dienstleistung archivieren](#eine-ware--dienstleistung-archivieren)
+    - [eine Ware / Dienstleistung unarchivieren](#eine-ware--dienstleistung-unarchivieren)
   - [Info](#info)
   - [Project::Project (Projekt)](#projectproject-projekt)
     - [alle Projekte](#alle-projekte)
     - [ein Projekt](#ein-projekt)
+    - [erstelle ein Projekt](#erstelle-ein-projekt)
+    - [aktualisiere ein Projekt](#aktualisiere-ein-projekt)
+    - [lösche ein Projekt](#lösche-ein-projekt)
+    - [archiviere ein Projekt](#archiviere-ein-projekt)
+    - [unarchiviere ein Projekt](#unarchiviere-ein-projekt)
   - [Tracker::Task (Aufgabe)](#trackertask-aufgabe)
     - [alle Aufgaben](#alle-aufgaben)
     - [eine Aufgabe](#eine-aufgabe)
@@ -347,6 +360,41 @@ puts company.headers
 puts company.body
 ```
 
+#### erstelle eine Kontaktperson (eines Unternehmens)
+
+```ruby
+company = client.contact_companies_persons.create(
+  company_id: 1, 
+  attributes: { 
+    first_name: 'Max',
+    last_name: 'Mustermann'
+  }
+)
+puts company.headers
+puts company.body
+```
+
+Siehe [CompaniesPersons#create](lib/papierkram_api/v1/endpoints/contact/companies_persons.rb) für mögliche Parameter.
+
+#### aktualisiere eine Kontaktperson (eines Unternehmens)
+
+```ruby
+company = client.contact_companies_persons
+                .update_by(company_id: 1, id: 1, attributes: { first_name: 'Moritz' })
+puts company.headers
+puts company.body
+```
+
+Siehe [CompaniesPersons#update_by](lib/papierkram_api/v1/endpoints/contact/companies_persons.rb) für mögliche Parameter.
+
+#### lösche eine Kontaktperson (eines Unternehmens)
+
+```ruby
+company = client.contact_companies_persons.delete_by(company_id: 1, id: 1)
+puts company.headers
+puts company.body
+```
+
 ### Expense::Voucher (Ausgabe Beleg)
 
 Der Endpunkt `/papierkram_api/v1/endpoints/expense/vouchers` liefert Informationen über die Ausgabe Belege. Die Informationen werden als `Faraday::Response` zurückgegeben.
@@ -459,6 +507,56 @@ puts proposition.headers
 puts proposition.body
 ```
 
+#### eine Ware / Dienstleistung erstellen
+
+```ruby
+proposition = client.income_propositions.create(
+  name: 'Software design',
+  article_no: '12345',
+  description: 'Here, we can describe what "Software design" actually entails.',
+  time_unit: 'hour',
+  proposition_type: 'service',
+  price: '150.0',
+  vat_rate: '19%'
+)
+puts proposition.headers
+puts proposition.body
+```
+
+Siehe [Propositions#create](lib/papierkram_api/v1/endpoints/income/propositions.rb) für mögliche Parameter.
+
+#### eine Ware / Dienstleistung aktualisieren
+
+```ruby
+client.income_propositions.update_by(
+  id: 1,
+  attributes: {
+    name: 'Software design',
+    vat_rate: '19%' # verpflichtend bei Änderung
+  }
+)
+```
+
+Siehe [Propositions#update_by](lib/papierkram_api/v1/endpoints/income/propositions.rb) für mögliche Parameter.
+
+#### eine Ware / Dienstleistung löschen
+
+```ruby
+client.income_propositions.delete_by(id: 1)
+```
+
+#### eine Ware / Dienstleistung archivieren
+
+```ruby
+client.income_propositions.archive_by(id: 1)
+```
+
+#### eine Ware / Dienstleistung unarchivieren
+
+```ruby
+client.income_propositions.unarchive_by(id: 1)
+```
+
 ### Info
 
 Der Endpunkt `lib/papierkram_api/v1/endpoints/info.rb` liefert Informationen über die API. Die Informationen werden als `Faraday::Response` zurückgegeben.
@@ -493,6 +591,50 @@ puts project.headers
 puts project.body
 ```
 
+#### erstelle ein Projekt
+
+```ruby
+project = client.projects.create(name: 'Projekt 1')
+puts project.headers
+puts project.body
+```
+
+Siehe [Projects](lib/papierkram_api/v1/endpoints/projects.rb) für mögliche Parameter.
+
+#### aktualisiere ein Projekt
+
+```ruby
+project = client.projects.update_by(id: 1, attributes: { name: 'Projekt 2' })
+puts project.headers
+puts project.body
+```
+
+Siehe [Projects](lib/papierkram_api/v1/endpoints/projects.rb) für mögliche Parameter.
+
+#### lösche ein Projekt
+
+```ruby
+project = client.projects.delete_by(id: 1)
+puts project.headers
+puts project.body
+```
+
+#### archiviere ein Projekt
+
+```ruby
+project = client.projects.archive_by(id: 1)
+puts project.headers
+puts project.body
+```
+
+#### unarchiviere ein Projekt
+
+```ruby
+project = client.projects.unarchive_by(id: 1)
+puts project.headers
+puts project.body
+```
+
 ### Tracker::Task (Aufgabe)
 
 Der Endpunkt `/papierkram_api/v1/tracker/tasks` liefert Informationen über die Aufgaben. Die Informationen werden als `Faraday::Response` zurückgegeben.

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

@@ -21,6 +21,54 @@ module PapierkramApi
 
             get("#{@url_api_path}/contact/companies/#{company_id}/persons", query)
           end
+
+          def create( # rubocop:disable Metrics/ParameterLists
+            company_id:,
+            first_name:,
+            last_name:,
+            title: nil,
+            salutation: nil,
+            position: nil,
+            department: nil,
+            email: nil,
+            phone: nil,
+            mobile: nil,
+            fax: nil,
+            skype: nil,
+            comment: nil
+          )
+            body = {
+              first_name: first_name,
+              last_name: last_name,
+              title: title,
+              salutation: salutation,
+              position: position,
+              department: department,
+              email: email,
+              phone: phone,
+              mobile: mobile,
+              fax: fax,
+              skype: skype,
+              comment: comment
+            }
+
+            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)
+            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)
+
+            put("#{@url_api_path}/contact/companies/#{company_id}/persons/#{id}", attributes)
+          end
+
+          def delete_by(company_id:, id:)
+            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)
+
+            delete("#{@url_api_path}/contact/companies/#{company_id}/persons/#{id}")
+          end
         end
       end
     end

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

@@ -13,6 +13,49 @@ module PapierkramApi
           def all
             get("#{@url_api_path}/income/propositions")
           end
+
+          def create(
+            name:,
+            article_no:,
+            description: nil,
+            time_unit: nil,
+            proposition_type: nil,
+            price: nil,
+            vat_rate: ''
+          )
+            body = {
+              name: name,
+              article_no: article_no,
+              description: description,
+              time_unit: time_unit,
+              proposition_type: proposition_type,
+              price: price,
+              vat_rate: vat_rate
+            }
+            post("#{@url_api_path}/income/propositions", body)
+          end
+
+          def update_by(id:, attributes: {})
+            attributes[:vat_rate] ||= attributes['vat_rate']
+            attributes[:vat_rate] ||= ''
+            if attributes[:vat_rate].empty? || !attributes[:vat_rate].include?('%')
+              raise ArgumentError, 'vat_rate must be a percentage and include a % sign'
+            end
+
+            put("#{@url_api_path}/income/propositions/#{id}", attributes)
+          end
+
+          def delete_by(id:)
+            delete("#{@url_api_path}/income/propositions/#{id}")
+          end
+
+          def archive_by(id:)
+            post("#{@url_api_path}/income/propositions/#{id}/archive")
+          end
+
+          def unarchive_by(id:)
+            post("#{@url_api_path}/income/propositions/#{id}/unarchive")
+          end
         end
       end
     end

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

@@ -20,6 +20,58 @@ module PapierkramApi
 
           get("#{@url_api_path}/projects", query)
         end
+
+        def create( # rubocop:disable Metrics/ParameterLists
+          name:,
+          customer_id:,
+          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: {},
+          team_members: []
+        )
+          body = {
+            name: name,
+            description: description,
+            start_date: start_date,
+            end_date: end_date,
+            flagged: flagged,
+            budget_type: budget_type,
+            budget_money: budget_money,
+            budget_time: budget_time,
+            budget_time_unit: budget_time_unit,
+            color: color,
+            customer: { id: customer_id },
+            default_proposition: default_proposition,
+            team_members: team_members
+          }
+
+          post("#{@url_api_path}/projects", body)
+        end
+
+        def update_by(id:, attributes: {})
+          raise ArgumentError, 'attributes must be a Hash' unless attributes.is_a?(Hash)
+
+          put("#{@url_api_path}/projects/#{id}", attributes)
+        end
+
+        def delete_by(id:)
+          delete("#{@url_api_path}/projects/#{id}")
+        end
+
+        def archive_by(id:)
+          post("#{@url_api_path}/projects/#{id}/archive")
+        end
+
+        def unarchive_by(id:)
+          post("#{@url_api_path}/projects/#{id}/unarchive")
+        end
       end
     end
   end

data/lib/papierkram_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PapierkramApiClient
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papierkram_api_client
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Simon Neutert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday