seeuletter 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 284252da8f82460f38f266680cfecf47656d62b85330ac4255cf27fccd42c6b9
-  data.tar.gz: 7ab5f0b7293860a22edc668f0e7e5156727473a48816dd5a6fd7db50c5b27781
+  metadata.gz: 4ae03460189501286ccadd04b8fed5ec5cbaf1fc457b550f0ca559fc655450f0
+  data.tar.gz: e8b36e0d48592e84e60456c9870956a84f85dabd618a8654e6de491925460f97
 SHA512:
-  metadata.gz: 9b81fccbcee63546ead51c7ef2c2f8216bdd4b669a2f6ac5d606e59820ae924a959b2ee0cbcb193195fbaa9e60ffc7f287f5b05f0a21b3071108e224d984c4b7
-  data.tar.gz: dd284c14229ad9ad70889f6eedfd59bbc72418398009cae49a0557cd444fd908675f658489ee02da1c76ba891911e5c1296d5944c756a2ceccb3c7451a3246cc
+  metadata.gz: 0ab2e688c5ca19522f28cc73a601d2772290f8be0ae9e1777a1fd833b45a65c0335ef94723324ee78db793a3f2de4e4b2503036a162372d6c28907127d99e535
+  data.tar.gz: 5b9c39c72c7cd3bdf39f30d445ecd6eb2a15fd898f5ca05bd838b0aed6b8f4ee1560f92d07b1170fb10488dccb84fed59a6f1f92e054241c99ad8facd9935eb0

data/README.md

@@ -15,6 +15,9 @@ Supports Ruby 2.0.0 and greater.
   - [Registration](#registration)
   - [Installation](#installation)
   - [Usage](#usage)
+  - [Letters](#letters)
+  - [Accounts](#accounts)
+  - [Invoices](#invoices)
 - [Examples](#examples)
 
 ## Getting Started
@@ -56,6 +59,8 @@ For optional parameters and other details, refer to the docs [here](https://docs
 seeuletter = Seeuletter::Client.new(api_key: "your-api-key")
 ```
 
+### Letters
+
 #### Create a new letter
 
 ```ruby
@@ -138,6 +143,64 @@ seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
 puts seeuletter.letter_price.get(color: 'bw', postage_type: 'prioritaire', postage_speed: 'D1', page_count: 1)
 ```
 
+### Accounts
+
+#### Create a new account for the company
+
+```ruby
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+puts seeuletter.accounts.create(
+  email: "msb.partner@example.com",
+  name: "Erlich Bachman",
+  phone: "+33104050607",
+  company_name: "MSB Partner from Ruby Wrapper",
+  address_line1: '30 rue de rivoli',
+  address_line2: '',
+  address_city: 'Paris',
+  address_country: 'France',
+  address_postalcode: '75004'
+)
+```
+
+### Update the account company email
+
+```ruby
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+seeuletter.accounts.updateEmail('ACCOUNT_COMPANY_ID', "msb.partner.new@example.com")
+```
+
+
+
+### Invoices
+
+#### List all invoices for a company
+
+```ruby
+require 'seeuletter'
+
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+puts seeuletter.invoices.list()
+```
+
+#### Get a specific invoice
+
+```ruby
+require 'seeuletter'
+
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+puts seeuletter.invoices.find('INVOICE_ID')
+```
+
 #### Caution: Pass zero-prefixed postal codes as strings
 
 When using postal codes with zero-prefixes, always quote them. For example when specifying `02125`, pass it as a string `"02125"`, instead of an integer.

data/examples/README.md

@@ -19,3 +19,13 @@ ruby letters.rb
 ```
 ruby letters_electronic.rb
 ```
+
+### Create and update account
+```
+ruby accounts.rb
+```
+
+### Get invoices
+```
+ruby invoices.rb
+```

data/examples/accounts.rb

@@ -0,0 +1,27 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
+
+begin
+    # create a new company account
+    create_response = seeuletter.accounts.create(
+      email: "msb.partner@example.com",
+      name: "Erlich Bachman",
+      phone: "+33104050607",
+      company_name: "MSB Partner from Ruby Wrapper",
+      address_line1: '30 rue de rivoli',
+      address_line2: '',
+      address_city: 'Paris',
+      address_country: 'France',
+      address_postalcode: '75004'
+    )
+    puts "The Seeuletter API Account responded : #{create_response}"
+
+    # update email of a company account
+    seeuletter.accounts.updateEmail(create_response['company']['_id'], "msb.partner.new@example.com")
+
+rescue Seeuletter::SeeuletterError => ex
+    puts "Error from API : #{ex}"
+end

data/examples/invoices.rb

@@ -0,0 +1,21 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
+
+begin
+    # get list of invoices
+    list_response = seeuletter.invoices.list(
+        status: "paid",
+        date_start: "2020-01-01"
+    )
+    puts "The Seeuletter API Invoices responded : #{list_response}"
+
+    # get single invoice by API
+    find_response = seeuletter.invoices.find(list_response['invoices'][0]['_id'])
+    puts "The Seeuletter API Invoice responded : #{find_response}"
+
+rescue Seeuletter::SeeuletterError => ex
+    puts "Error from API : #{ex}"
+end

data/lib/seeuletter/client.rb

@@ -1,6 +1,8 @@
 require "seeuletter/resources/letter"
 require 'seeuletter/resources/letter_price'
 require "seeuletter/resources/user"
+require "seeuletter/resources/account"
+require "seeuletter/resources/invoice"
 
 module Seeuletter
   class Client
@@ -26,5 +28,13 @@ module Seeuletter
     def users
       Seeuletter::Resources::User.new(config)
     end
+
+    def accounts
+      Seeuletter::Resources::Account.new(config)
+    end
+
+    def invoices
+      Seeuletter::Resources::Invoice.new(config)
+    end
   end
 end

data/lib/seeuletter/resources/account.rb

@@ -0,0 +1,30 @@
+require "seeuletter/resources/resource_base"
+
+module Seeuletter
+  module Resources
+    class Account < Seeuletter::Resources::ResourceBase
+
+      def initialize(config)
+        super(config)
+        @endpoint = "accounts"
+      end
+
+      def updateEmail(resource_id, email, headers={})
+          submit :put, resource_url(resource_id), {"email" => email}, headers
+      end
+
+      def list(options={})
+        raise SeeuletterError.new("Invalid REST operation : GET /accounts", "404", nil)
+      end
+
+      def find(resource_id)
+        raise SeeuletterError.new("Invalid REST operation : GET /accounts/:account_id", "404", nil)
+      end
+
+      def destroy(resource_id)
+        raise SeeuletterError.new("Invalid REST operation : DELETE /accounts/:account_id", "404", nil)
+      end
+
+    end
+  end
+end

data/lib/seeuletter/resources/invoice.rb

@@ -0,0 +1,22 @@
+require "seeuletter/resources/resource_base"
+
+module Seeuletter
+  module Resources
+    class Invoice < Seeuletter::Resources::ResourceBase
+
+      def initialize(config)
+        super(config)
+        @endpoint = "invoices"
+      end
+
+      def create(options={}, headers={})
+        raise SeeuletterError.new("Invalid REST operation : POST /invoices", "404", nil)
+      end
+
+      def destroy(resource_id)
+        raise SeeuletterError.new("Invalid REST operation : DELETE /accounts/:invoice_id", "404", nil)
+      end
+
+    end
+  end
+end

data/lib/seeuletter/version.rb

@@ -1,3 +1,3 @@
 module Seeuletter
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seeuletter
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Seeuletter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -71,6 +71,8 @@ files:
 - README.md
 - Rakefile
 - examples/README.md
+- examples/accounts.rb
+- examples/invoices.rb
 - examples/letter_price.rb
 - examples/letters.rb
 - examples/letters_electronic.rb
@@ -79,6 +81,8 @@ files:
 - lib/seeuletter/client.rb
 - lib/seeuletter/errors/invalid_request_error.rb
 - lib/seeuletter/errors/seeuletter_error.rb
+- lib/seeuletter/resources/account.rb
+- lib/seeuletter/resources/invoice.rb
 - lib/seeuletter/resources/letter.rb
 - lib/seeuletter/resources/letter_price.rb
 - lib/seeuletter/resources/resource_base.rb