panda_doc 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6098d0ac11d9e3595908a73510920481be2db76c1959c07a28a983f108012816
-  data.tar.gz: d27a946b564da03253e0e29311289dbcd2009c2bb7ec611994231581f9847c56
+  metadata.gz: 5112e058fffb7e215f11d5f45779140776f3a1fc8a71bdf3f8982786540684c2
+  data.tar.gz: 192bbe2e32c98464054b50c922f522366a7b000d17784cc1f7e55e5db299eff4
 SHA512:
-  metadata.gz: 38acdc34b214db549b967231570a25c46bcb0822461c81577a5ed362ecf63076d51d53e0ae28d9bd4d5e540297893479d6e33db5bef11e3370f8b4b993519524
-  data.tar.gz: 57f00adee771d52e0faec362b86a3ca40f25477a75ea1802dc7ec4aa9e03ff08aab050ef0052fffa59828984fb654864508a8b7c71e43d8bc043ded48e2d34be
+  metadata.gz: d93d73114d02127e6371da588265d0b97509a56abd7399d965ba0a4dd267c54f3f2706d2b4be4ea7f1213f34546698872bb8a0a6e01e94c2df5cbbc4f0655150
+  data.tar.gz: 7d6b8d7c177cf544378ae302e232fb32a1cc80a57e3e7b5d6dbd3273b0a9aec511dcc58e266028e2150d60afaeada1465d37b59536e04c26be0d2a4f689da75d

data/.ruby-version

@@ -1 +1 @@
-3.4.2
+3.4.3

data/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+## [0.13.0][] (2025-07-21)
+
+New:
+
+- Add Document Sections list and delete actions (by @lannon)
+
+
+## [0.12.0][] (2025-06-20)
+
+New:
+
+- Add Document Sections support (by @andrewvy)
 
 ## [0.11.0][] (2025-04-19)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    panda_doc (0.11.0)
+    panda_doc (0.13.0)
       dry-configurable
       dry-struct
       faraday (>= 2.0.1, < 3.0)
@@ -14,7 +14,7 @@ GEM
     bigdecimal (3.1.9)
     byebug (12.0.0)
     concurrent-ruby (1.3.5)
-    diff-lcs (1.6.1)
+    diff-lcs (1.6.2)
     docile (1.4.1)
     dry-configurable (1.3.0)
       dry-core (~> 1.1)
@@ -41,34 +41,34 @@ GEM
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
-    faraday (2.13.0)
+    faraday (2.13.2)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-multipart (1.1.0)
+    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.10.2)
+    json (2.12.2)
     logger (1.7.0)
     multipart-post (2.4.1)
     net-http (0.6.0)
       uri
-    rake (13.2.1)
-    rspec (3.13.0)
+    rake (13.3.0)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.4)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
+    rspec-support (3.13.4)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -90,4 +90,4 @@ DEPENDENCIES
   simplecov (~> 0.22.0)
 
 BUNDLED WITH
-   2.6.8
+   2.6.9

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+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),
+        type: :document_section
+      )
+    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)
+      failure(response)
+
+      SuccessResult.new(
+        ResponseFactory.build(type).new(response.body)
+      )
+    end
+
+    def stream(response)
+      failure(response)
+
+      SuccessResult.new(response)
+    end
+
+    def failure(response)
+      raise FailureResult.new(response) unless response.success?
+    end
+  end
+end

data/lib/panda_doc/objects/document_section.rb

@@ -0,0 +1,16 @@
+module PandaDoc
+  module Objects
+    class DocumentSection < Base
+      attribute :uuid, Types::String
+      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
+
+      alias_method :created_at, :date_created
+      alias_method :updated_at, :date_modified
+    end
+  end
+end

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.11.0"
+  VERSION = "0.13.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panda_doc
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Igor Pstyga
@@ -119,9 +119,12 @@ files:
 - lib/panda_doc/coercions.rb
 - lib/panda_doc/configuration.rb
 - lib/panda_doc/document.rb
+- lib/panda_doc/document_section.rb
 - lib/panda_doc/failure_result.rb
 - 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
@@ -153,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Ruby wrapper for PandaDoc.com API
 test_files: []