panda_doc 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4dd2d6ef5bbab06ca01e6f77e93630d0aa88aa56f21a6568ee6039c44fb75aa
-  data.tar.gz: 3046fec26dd0ab07fa5831d5c43081b915bc3b5021a70765c1e05481692d4f95
+  metadata.gz: 9178f289db10d3bf60e5a5ae645ff003d03826d05a6f5fe70d015beb68e6ecc5
+  data.tar.gz: bac876ff0320cf75eac8fe8ec1c9c37992d9aa30961b257313d307fc5ab0314d
 SHA512:
-  metadata.gz: 5bcfa0020c545ac0ff332fb532cf27df6cea7b6e645fe67182a4209d89ebcd80a0ca49b3568d43a920657dd2a6ff9c77f808dbe4064349a4752c7b6367653a14
-  data.tar.gz: 72726843bb0d147c50bfb8ada65eba7c45d60f7a0d93790019bb1d2b3fcc18b616c191159caa74752bd6aaa2f98e92847702d5901a567e6d8bedafd449b3c326
+  metadata.gz: d024634cfcb55517bae71a144d8107d9a9d2cb03fa63d022b00c511d5a2f730b86592a0d14a6417db52b895ebea612ec57131e0327268c0167d024f76895a650
+  data.tar.gz: 04144545c90646efe63f32f4c7c02a15b6ed7e00736e5d19b91a01810e886fedffb8036897a2d89f16395c2f3364df38ccb515f306e8a5536594985a6e5ff221

data/CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [0.5.1][] (2021-01-08)
+
+New:
+
+- Add `fields` to the document details response:
+  ```ruby
+    document = PandaDoc::Document.details("uuid")
+    document.fields.first.name
+    => "Field Name"
+
+    docuemnt.fields.first.value
+    => "Field Value"
+  ```
+
 ## [0.5.0][] (2021-01-06)
 
 New:
@@ -149,7 +163,8 @@ Fixes:
 
 - Initial release
 
-[Unreleased]: https://github.com/opti/panda_doc/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/opti/panda_doc/compare/v0.5.1...HEAD
+[0.5.1]: https://github.com/opti/panda_doc/compare/v0.5.0...v0.5.1
 [0.5.0]: https://github.com/opti/panda_doc/compare/v0.4.3...v0.5.0
 [0.4.3]: https://github.com/opti/panda_doc/compare/v0.4.2...v0.4.3
 [0.4.2]: https://github.com/opti/panda_doc/compare/v0.4.1...v0.4.2

data/README.md

@@ -72,7 +72,7 @@ document.created_at # => #<DateTime: 2016-02-03T14:56:21-08:00>
 document.updated_at # => #<DateTime: 2016-02-03T14:56:21-08:00>
 ```
 
-#### Creating a document from attached file
+#### Creating a document from attached file ([API](https://developers.pandadoc.com/reference#create-document-from-pdf))
 
 ```ruby
 file = UploadIO.new("/path/to/file.pdf", "application/pdf")
@@ -97,7 +97,7 @@ document = PandaDoc::Document.create(
 )
 ```
 
-#### Creating a document from a template
+#### Creating a document from a template ([API](https://developers.pandadoc.com/reference#create-document-from-pandadoc-template))
 
 ```ruby
 document = PandaDoc::Document.create(
@@ -112,6 +112,10 @@ document = PandaDoc::Document.create(
       default: false
     }
   ],
+  tokens: [
+    { name: "Token.Name", value: "Token Value" },
+    { name: "Token.AnotherName", value: "2021" }
+  ],
   fields: {
     field_id: {
       value: "Field 1"
@@ -120,7 +124,7 @@ document = PandaDoc::Document.create(
 )
 ```
 
-#### Getting a document status
+#### Getting a document status ([API](https://developers.pandadoc.com/reference#document-status))
 
 ```ruby
 document = PandaDoc::Document.find("UUID")
@@ -129,7 +133,21 @@ document.status       # => "draft"
 document.updated_at   # => <DateTime: 2016-02-03T17:41:00-08:00>
 ```
 
-#### Sending a document
+#### Getting a document details ([API](https://developers.pandadoc.com/reference#document-details))
+
+```ruby
+document = PandaDoc::Document.details("UUID")
+
+document.tokens
+=> [#<PandaDoc::Objects::Token name="Token.Name" value="Token Value">,
+    #<PandaDoc::Objects::Token name="token.another_name" value="2021">]
+
+document.fields
+=> [#<PandaDoc::Objects::Field uuid="...>,
+    #<PandaDoc::Objects::Field uuid="...>]
+```
+
+#### Sending a document ([API](https://developers.pandadoc.com/reference#send-document))
 
 ```ruby
 PandaDoc::Document.send("UUID", message: "A message to include into the email")
@@ -147,6 +165,15 @@ session.id # => "adssdAvyDXBS"
 session.expires_at # => #<DateTime: 2016-02-03T14:56:21-08:00>
 ```
 
+#### Downloading a document ([API](https://developers.pandadoc.com/reference#download-document))
+
+```ruby
+response = PandaDoc::Document.download("uuid")
+file = File.open("document.pdf", "w") do |f|
+  response.body
+end
+```
+
 #### Error handling
 
 If an error occurs during an API request it will be wrapped into a plain ruby

data/lib/panda_doc.rb

@@ -19,6 +19,7 @@ require "panda_doc/response_factory"
 require "panda_doc/objects/base"
 require "panda_doc/objects/recipient"
 require "panda_doc/objects/token"
+require "panda_doc/objects/field"
 require "panda_doc/objects/document"
 require "panda_doc/objects/error"
 require "panda_doc/objects/session"

data/lib/panda_doc/objects/document.rb

@@ -14,6 +14,7 @@ module PandaDoc
       attribute :version, Types::String.optional
 
       attribute? :tokens, Types::Array.of(Objects::Token)
+      attribute? :fields, Types::Array.of(Objects::Field)
 
       alias_method :created_at, :date_created
       alias_method :updated_at, :date_modified

data/lib/panda_doc/objects/field.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PandaDoc
+  module Objects
+    class Field < Base
+      attribute :uuid, Types::Coercible::String
+      attribute :name, Types::Coercible::String.optional
+      attribute :title, Types::Coercible::String.optional
+      attribute :placeholder, Types::Coercible::String.optional
+      attribute :value, Types::Nil | Types::Hash | Types::Coercible::String
+      attribute? :assigned_to, PandaDoc::Objects::Recipient
+    end
+  end
+end

data/lib/panda_doc/objects/recipient.rb

@@ -3,11 +3,14 @@
 module PandaDoc
   module Objects
     class Recipient < Base
+      attribute? :id, Types::Coercible::String.optional
       attribute :email, Types::Coercible::String
       attribute :first_name, Types::Coercible::String.optional
       attribute :last_name, Types::Coercible::String.optional
       attribute :recipient_type, Types::Coercible::String
       attribute :has_completed, Types::Params::Bool
+      attribute? :role, Types::Coercible::String.optional
+      attribute? :type, Types::Coercible::String.optional
     end
   end
 end

data/lib/panda_doc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_doc
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Igor Pstyga
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -106,6 +106,7 @@ files:
 - lib/panda_doc/objects/base.rb
 - lib/panda_doc/objects/document.rb
 - lib/panda_doc/objects/error.rb
+- lib/panda_doc/objects/field.rb
 - lib/panda_doc/objects/recipient.rb
 - lib/panda_doc/objects/session.rb
 - lib/panda_doc/objects/token.rb