panda_doc 0.12.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de6d8cc1931b7740e723e533b971ebb962c9b3914b6bdd0a259f91d9d9cf13e6
-  data.tar.gz: 66938632918f5cbdcaecc60d0e493e32466374211e12a63b323b185453e3c71c
+  metadata.gz: ea092eb81ffea5fd05fc07db1e23e5d1df5b67270a357936fa08f8f4d8cb7a36
+  data.tar.gz: 95dc6c4ba632984f35a73ed3f4bcb8e2f0d4ace085b067cbc3fba66f57b19d34
 SHA512:
-  metadata.gz: 7f610544867b299d098e3adbce4371a127af29b5f9117220ed16fad5ddd0c21f21237ea0d98c002d232dc13d8aa8941184de100354488aefdd48fa7c7722d15e
-  data.tar.gz: e49d4bbd18f4a554f9f3cb43c78e27a077a15f734eb966d30f8b5664c8d6f9db9abd498831d8b3721e529e2375a367eef824061fb81dc7fffe759faf4c636533
+  metadata.gz: 03d387404d1915da96e892f244bf3af54984cf2ca0817ddfb69983efae07521977f4012a4e41876efbc419b3c78fc08973f99ab6de95200e5fbb518d595b76a4
+  data.tar.gz: bdbaf844557b895f1b1966aeabd6821ac9c14d53bf729825e935ea3c7dd81068f4a55f4df58eb1ed3f15569ec6624f7f10326a891afb855e8ee167454a3a3432

data/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+## [0.13.1][]
+
+Fixes:
+
+- Fixes #62 - make Document Sections attribute optional (@lannon)
+
+## [0.13.0][]
+
+New:
+
+- Add Document Sections list and delete actions (by @lannon)
+
 
 ## [0.12.0][] (2025-06-20)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    panda_doc (0.12.0)
+    panda_doc (0.13.1)
       dry-configurable
       dry-struct
       faraday (>= 2.0.1, < 3.0)
@@ -41,16 +41,16 @@ GEM
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
-    faraday (2.13.1)
+    faraday (2.13.2)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
     faraday-multipart (1.1.1)
       multipart-post (~> 2.0)
-    faraday-net_http (3.4.0)
+    faraday-net_http (3.4.1)
       net-http (>= 0.5.0)
     ice_nine (0.11.2)
-    json (2.11.3)
+    json (2.12.2)
     logger (1.7.0)
     multipart-post (2.4.1)
     net-http (0.6.0)

data/README.md

@@ -174,6 +174,38 @@ file = File.open("document.pdf", "w") do |f|
 end
 ```
 
+#### Listing document sections ([API](https://developers.pandadoc.com/reference/document-sections-info))
+
+```ruby
+sections = PandaDoc::DocumentSection.list("document_uuid")
+
+sections.results.each do |section|
+  puts section.uuid
+  puts section.name
+  puts section.status
+end
+```
+
+#### Creating a document section ([API](https://developers.pandadoc.com/reference/create-document-section))
+
+```ruby
+section = PandaDoc::DocumentSection.create(
+  "document_uuid",
+  name: "Section Name",
+  file: file
+)
+
+section.uuid # => "section_uuid"
+section.name # => "Section Name"
+section.status # => "uploaded"
+```
+
+#### Deleting a document section ([API](https://developers.pandadoc.com/reference/delete-section))
+
+```ruby
+PandaDoc::DocumentSection.delete("document_uuid", "section_uuid")
+```
+
 #### Error handling
 
 If an error occurs during an API request it will be wrapped into a plain ruby

data/lib/panda_doc/api_client.rb

@@ -54,6 +54,10 @@ module PandaDoc
       connection.patch(normalized_path(path), **data)
     end
 
+    def delete(path, data = {})
+      connection.delete(normalized_path(path), **data)
+    end
+
     private
 
     def normalized_path(path)

data/lib/panda_doc/document_section.rb

@@ -4,6 +4,13 @@ module PandaDoc
   module DocumentSection
     extend self
 
+    def list(document_uuid, **options)
+      respond(
+        ApiClient.request(:get, "/documents/#{document_uuid}/sections", **options),
+        type: :document_sections_list
+      )
+    end
+
     def create(document_uuid, **data)
       respond(
         ApiClient.request(:post, "/documents/#{document_uuid}/sections/uploads", **data),
@@ -11,6 +18,13 @@ module PandaDoc
       )
     end
 
+    def delete(document_uuid, section_uuid)
+      respond(
+        ApiClient.request(:delete, "/documents/#{document_uuid}/sections/#{section_uuid}"),
+        type: :empty
+      )
+    end
+
     private
 
     def respond(response, type: :document)

data/lib/panda_doc/objects/document_section.rb

@@ -2,12 +2,12 @@ module PandaDoc
   module Objects
     class DocumentSection < Base
       attribute :uuid, Types::String
-      attribute :document_uuid, Types::String
-      attribute :status, Types::Custom::DocumentStatus
+      attribute? :document_uuid, Types::String
+      attribute? :status, Types::Custom::DocumentStatus
       attribute :name, Types::String
 
-      attribute :date_created, Types::Params::DateTime
-      attribute :date_modified, Types::Params::DateTime
+      attribute? :date_created, Types::Params::DateTime
+      attribute? :date_modified, Types::Params::DateTime
 
       alias_method :created_at, :date_created
       alias_method :updated_at, :date_modified

data/lib/panda_doc/objects/document_sections_list.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PandaDoc
+  module Objects
+    # Represents a list of document sections
+    class DocumentSectionsList < Base
+      attribute :results, Types::Array.of(Objects::DocumentSection).default([].freeze)
+
+      alias_method :document_sections, :results
+    end
+  end
+end

data/lib/panda_doc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PandaDoc
-  VERSION = "0.12.0"
+  VERSION = "0.13.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panda_doc
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Igor Pstyga
@@ -124,6 +124,7 @@ files:
 - lib/panda_doc/objects/base.rb
 - lib/panda_doc/objects/document.rb
 - lib/panda_doc/objects/document_section.rb
+- lib/panda_doc/objects/document_sections_list.rb
 - lib/panda_doc/objects/documents_list.rb
 - lib/panda_doc/objects/editing_session.rb
 - lib/panda_doc/objects/empty.rb
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Ruby wrapper for PandaDoc.com API
 test_files: []